Skip to content

Commit c340fde

Browse files
committed
[release] 4.0.0
1 parent 0640431 commit c340fde

15 files changed

+195
-133
lines changed

api_live_streams.go

+4
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,7 @@ type ListLiveStreamsParams struct {
820820
Limit int32
821821
Page int32
822822
StreamKey string
823+
Status LiveStreamStatus
823824
}
824825

825826
// ListLiveStreams optionally accepts the APIOption of WithParams(*ListLiveStreamsParams).
@@ -859,6 +860,9 @@ func (a *LiveStreamsApiService) ListLiveStreams(opts ...APIOption) (ListLiveStre
859860
if localVarOptionals != nil && isSet(localVarOptionals.StreamKey) {
860861
localVarQueryParams.Add("stream_key", parameterToString(localVarOptionals.StreamKey, ""))
861862
}
863+
if localVarOptionals != nil && isSet(localVarOptionals.Status) {
864+
localVarQueryParams.Add("status", parameterToString(localVarOptionals.Status, ""))
865+
}
862866
// to determine the Content-Type header
863867
localVarHttpContentTypes := []string{}
864868

api_playback_restrictions.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ import (
1212

1313
type PlaybackRestrictionsApiService service
1414

15-
func (a *PlaybackRestrictionsApiService) CreatePlaybackRestriction(createPlaybackRestrictionRequest CreatePlaybackRestrictionRequest, opts ...APIOption) (PlaybackRestriction, error) {
15+
func (a *PlaybackRestrictionsApiService) CreatePlaybackRestriction(createPlaybackRestrictionRequest CreatePlaybackRestrictionRequest, opts ...APIOption) (PlaybackRestrictionResponse, error) {
1616
var (
1717
localVarAPIOptions = new(APIOptions)
1818
localVarHttpMethod = strings.ToUpper("Post")
1919
localVarPostBody interface{}
2020
localVarFormFileName string
2121
localVarFileName string
2222
localVarFileBytes []byte
23-
localVarReturnValue PlaybackRestriction
23+
localVarReturnValue PlaybackRestrictionResponse
2424
)
2525

2626
for _, opt := range opts {
@@ -153,15 +153,15 @@ func (a *PlaybackRestrictionsApiService) DeletePlaybackRestriction(pLAYBACKRESTR
153153
return nil
154154
}
155155

156-
func (a *PlaybackRestrictionsApiService) GetPlaybackRestriction(pLAYBACKRESTRICTIONID string, opts ...APIOption) (PlaybackRestriction, error) {
156+
func (a *PlaybackRestrictionsApiService) GetPlaybackRestriction(pLAYBACKRESTRICTIONID string, opts ...APIOption) (PlaybackRestrictionResponse, error) {
157157
var (
158158
localVarAPIOptions = new(APIOptions)
159159
localVarHttpMethod = strings.ToUpper("Get")
160160
localVarPostBody interface{}
161161
localVarFormFileName string
162162
localVarFileName string
163163
localVarFileBytes []byte
164-
localVarReturnValue PlaybackRestriction
164+
localVarReturnValue PlaybackRestrictionResponse
165165
)
166166

167167
for _, opt := range opts {
@@ -234,15 +234,15 @@ type ListPlaybackRestrictionsParams struct {
234234
}
235235

236236
// ListPlaybackRestrictions optionally accepts the APIOption of WithParams(*ListPlaybackRestrictionsParams).
237-
func (a *PlaybackRestrictionsApiService) ListPlaybackRestrictions(opts ...APIOption) ([]PlaybackRestriction, error) {
237+
func (a *PlaybackRestrictionsApiService) ListPlaybackRestrictions(opts ...APIOption) (ListPlaybackRestrictionsResponse, error) {
238238
var (
239239
localVarAPIOptions = new(APIOptions)
240240
localVarHttpMethod = strings.ToUpper("Get")
241241
localVarPostBody interface{}
242242
localVarFormFileName string
243243
localVarFileName string
244244
localVarFileBytes []byte
245-
localVarReturnValue []PlaybackRestriction
245+
localVarReturnValue ListPlaybackRestrictionsResponse
246246
)
247247

248248
for _, opt := range opts {
@@ -319,15 +319,15 @@ func (a *PlaybackRestrictionsApiService) ListPlaybackRestrictions(opts ...APIOpt
319319
return localVarReturnValue, nil
320320
}
321321

322-
func (a *PlaybackRestrictionsApiService) UpdateReferrerDomainRestriction(pLAYBACKRESTRICTIONID string, body ReferrerDomainRestriction, opts ...APIOption) (PlaybackRestriction, error) {
322+
func (a *PlaybackRestrictionsApiService) UpdateReferrerDomainRestriction(pLAYBACKRESTRICTIONID string, body ReferrerDomainRestriction, opts ...APIOption) (PlaybackRestrictionResponse, error) {
323323
var (
324324
localVarAPIOptions = new(APIOptions)
325325
localVarHttpMethod = strings.ToUpper("Put")
326326
localVarPostBody interface{}
327327
localVarFormFileName string
328328
localVarFileName string
329329
localVarFileBytes []byte
330-
localVarReturnValue PlaybackRestriction
330+
localVarReturnValue PlaybackRestrictionResponse
331331
)
332332

333333
for _, opt := range opts {

configuration.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type ConfigurationOption func(*Configuration)
2222
func NewConfiguration(opts ...ConfigurationOption) *Configuration {
2323
cfg := &Configuration{
2424
basePath: "https://api.mux.com",
25-
userAgent: "Mux Go | 3.2.0",
25+
userAgent: "Mux Go | 4.0.0",
2626
}
2727
for _, opt := range opts {
2828
opt(cfg)
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ListPlaybackRestrictionsResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Data** | [**[]PlaybackRestriction**](PlaybackRestriction.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/LiveStream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**StreamKey** | **string** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional]
99
**ActiveAssetId** | **string** | The Asset that is currently being created if there is an active broadcast. | [optional]
1010
**RecentAssetIds** | **[]string** | An array of strings with the most recent Assets that were created from this live stream. | [optional]
11-
**Status** | **string** | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published. | [optional]
11+
**Status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional]
1212
**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional]
1313
**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
1414
**Passthrough** | **string** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional]

docs/LiveStreamStatus.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LiveStreamStatus
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

docs/LiveStreamsApi.md

+1
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,7 @@ Name | Type | Description | Notes
345345
**limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
346346
**page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
347347
**streamKey** | **optional.String**| Filter response to return live stream for this stream key only |
348+
**status** | [**optional.Interface of LiveStreamStatus**](.md)| Filter response to return live streams with the specified status only |
348349

349350
### Return type
350351

docs/MetricsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Method | HTTP request | Description
1515
> GetMetricTimeseriesDataResponse GetMetricTimeseriesData(ctx, mETRICID, optional)
1616
Get metric timeseries data
1717

18-
Returns timeseries data for a specific metric.
18+
Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
1919

2020
### Required Parameters
2121

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
3535
**filters** | [**optional.Interface of []string**](string.md)| Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` |
3636
**measurement** | **optional.String**| Measurement for the provided metric. If omitted, the default for the metric will be used. |
3737
**orderDirection** | **optional.String**| Sort order. |
38-
**groupBy** | **optional.String**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. |
38+
**groupBy** | **optional.String**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. |
3939

4040
### Return type
4141

docs/PlaybackRestrictionResponse.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# PlaybackRestrictionResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Data** | [**PlaybackRestriction**](.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/PlaybackRestrictionsApi.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **CreatePlaybackRestriction**
15-
> PlaybackRestriction CreatePlaybackRestriction(ctx, createPlaybackRestrictionRequest)
15+
> PlaybackRestrictionResponse CreatePlaybackRestriction(ctx, createPlaybackRestrictionRequest)
1616
Create a Playback Restriction
1717

1818
Create a new Playback Restriction.
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
2626

2727
### Return type
2828

29-
[**PlaybackRestriction**](PlaybackRestriction.md)
29+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
3030

3131
### Authorization
3232

@@ -68,7 +68,7 @@ Name | Type | Description | Notes
6868
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
6969

7070
# **GetPlaybackRestriction**
71-
> PlaybackRestriction GetPlaybackRestriction(ctx, pLAYBACKRESTRICTIONID)
71+
> PlaybackRestrictionResponse GetPlaybackRestriction(ctx, pLAYBACKRESTRICTIONID)
7272
Retrieve a Playback Restriction
7373

7474
Retrieves a Playback Restriction associated with the unique identifier.
@@ -82,7 +82,7 @@ Name | Type | Description | Notes
8282

8383
### Return type
8484

85-
[**PlaybackRestriction**](PlaybackRestriction.md)
85+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
8686

8787
### Authorization
8888

@@ -96,7 +96,7 @@ Name | Type | Description | Notes
9696
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
9797

9898
# **ListPlaybackRestrictions**
99-
> []PlaybackRestriction ListPlaybackRestrictions(ctx, optional)
99+
> ListPlaybackRestrictionsResponse ListPlaybackRestrictions(ctx, optional)
100100
List Playback Restrictions
101101

102102
Returns a list of all Playback Restrictions.
@@ -118,7 +118,7 @@ Name | Type | Description | Notes
118118

119119
### Return type
120120

121-
[**[]PlaybackRestriction**](PlaybackRestriction.md)
121+
[**ListPlaybackRestrictionsResponse**](ListPlaybackRestrictionsResponse.md)
122122

123123
### Authorization
124124

@@ -132,10 +132,10 @@ Name | Type | Description | Notes
132132
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
133133

134134
# **UpdateReferrerDomainRestriction**
135-
> PlaybackRestriction UpdateReferrerDomainRestriction(ctx, pLAYBACKRESTRICTIONID, body)
135+
> PlaybackRestrictionResponse UpdateReferrerDomainRestriction(ctx, pLAYBACKRESTRICTIONID, body)
136136
Update the Referrer Playback Restriction
137137

138-
Allows you to modify the list of domians or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
138+
Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
139139

140140
### Required Parameters
141141

@@ -147,7 +147,7 @@ Name | Type | Description | Notes
147147

148148
### Return type
149149

150-
[**PlaybackRestriction**](PlaybackRestriction.md)
150+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
151151

152152
### Authorization
153153

0 commit comments

Comments
 (0)