[release] 3.2.0

.openapi-generator/FILES

@@ -16,6 +16,7 @@ docs/CreateAssetRequest.md
 docs/CreateLiveStreamRequest.md
 docs/CreatePlaybackIDRequest.md
 docs/CreatePlaybackIDResponse.md
+docs/CreatePlaybackRestrictionRequest.md
 docs/CreateSimulcastTargetRequest.md
 docs/CreateTrackRequest.md
 docs/CreateTrackResponse.md
@@ -91,12 +92,16 @@ docs/OverallValues.md
 docs/PlaybackID.md
 docs/PlaybackIDApi.md
 docs/PlaybackPolicy.md
+docs/PlaybackRestriction.md
+docs/PlaybackRestrictionResponse.md
+docs/PlaybackRestrictionsApi.md
 docs/RealTimeApi.md
 docs/RealTimeBreakdownValue.md
 docs/RealTimeHistogramTimeseriesBucket.md
 docs/RealTimeHistogramTimeseriesBucketValues.md
 docs/RealTimeHistogramTimeseriesDatapoint.md
 docs/RealTimeTimeseriesDatapoint.md
+docs/ReferrerDomainRestriction.md
 docs/Score.md
 docs/SignalLiveStreamCompleteResponse.md
 docs/SigningKey.md
@@ -107,7 +112,10 @@ docs/Track.md
 docs/URLSigningKeysApi.md
 docs/UpdateAssetMP4SupportRequest.md
 docs/UpdateAssetMasterAccessRequest.md
+docs/UpdateAssetRequest.md
 docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
+docs/UpdateLiveStreamRequest.md
+docs/UpdateReferrerDomainRestrictionRequest.md
 docs/Upload.md
 docs/UploadError.md
 docs/UploadResponse.md
@@ -128,6 +136,7 @@ mux_python/api/incidents_api.py
 mux_python/api/live_streams_api.py
 mux_python/api/metrics_api.py
 mux_python/api/playback_id_api.py
+mux_python/api/playback_restrictions_api.py
 mux_python/api/real_time_api.py
 mux_python/api/url_signing_keys_api.py
 mux_python/api/video_views_api.py
@@ -149,6 +158,7 @@ mux_python/models/create_asset_request.py
 mux_python/models/create_live_stream_request.py
 mux_python/models/create_playback_id_request.py
 mux_python/models/create_playback_id_response.py
+mux_python/models/create_playback_restriction_request.py
 mux_python/models/create_simulcast_target_request.py
 mux_python/models/create_track_request.py
 mux_python/models/create_track_response.py
@@ -214,11 +224,14 @@ mux_python/models/notification_rule.py
 mux_python/models/overall_values.py
 mux_python/models/playback_id.py
 mux_python/models/playback_policy.py
+mux_python/models/playback_restriction.py
+mux_python/models/playback_restriction_response.py
 mux_python/models/real_time_breakdown_value.py
 mux_python/models/real_time_histogram_timeseries_bucket.py
 mux_python/models/real_time_histogram_timeseries_bucket_values.py
 mux_python/models/real_time_histogram_timeseries_datapoint.py
 mux_python/models/real_time_timeseries_datapoint.py
+mux_python/models/referrer_domain_restriction.py
 mux_python/models/score.py
 mux_python/models/signal_live_stream_complete_response.py
 mux_python/models/signing_key.py
@@ -228,7 +241,10 @@ mux_python/models/simulcast_target_response.py
 mux_python/models/track.py
 mux_python/models/update_asset_master_access_request.py
 mux_python/models/update_asset_mp4_support_request.py
+mux_python/models/update_asset_request.py
 mux_python/models/update_live_stream_embedded_subtitles_request.py
+mux_python/models/update_live_stream_request.py
+mux_python/models/update_referrer_domain_restriction_request.py
 mux_python/models/upload.py
 mux_python/models/upload_error.py
 mux_python/models/upload_response.py
@@ -241,4 +257,12 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_create_playback_restriction_request.py
+test/test_playback_restriction.py
+test/test_playback_restriction_response.py
+test/test_playback_restrictions_api.py
+test/test_referrer_domain_restriction.py
+test/test_update_asset_request.py
+test/test_update_live_stream_request.py
+test/test_update_referrer_domain_restriction_request.py
 tox.ini

docs/Asset.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **per_title_encode** | **bool** |  | [optional] 
 **upload_id** | **str** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional] 
 **is_live** | **bool** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] 
-**passthrough** | **str** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] 
+**passthrough** | **str** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] 
 **live_stream_id** | **str** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] 
 **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] 
 **master_access** | **str** |  | [optional] [default to 'none']

docs/AssetsApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
 [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
 [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets
+[**update_asset**](AssetsApi.md#update_asset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an Asset
 [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
 [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
 
@@ -753,6 +754,81 @@ Name | Type | Description  | Notes
 
 [[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)
 
+# **update_asset**
+> AssetResponse update_asset(asset_id, update_asset_request)
+
+Update an Asset
+
+Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
+
+### Example
+
+* Basic Authentication (accessToken):
+```python
+from __future__ import print_function
+import time
+import mux_python
+from mux_python.rest import ApiException
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.mux.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = mux_python.Configuration(
+    host = "https://api.mux.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: accessToken
+configuration = mux_python.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with mux_python.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = mux_python.AssetsApi(api_client)
+    asset_id = 'asset_id_example' # str | The asset ID.
+update_asset_request = {"passthrough":"Example"} # UpdateAssetRequest | 
+
+    try:
+        # Update an Asset
+        api_response = api_instance.update_asset(asset_id, update_asset_request)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AssetsApi->update_asset: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **str**| The asset ID. | 
+ **update_asset_request** | [**UpdateAssetRequest**](UpdateAssetRequest.md)|  | 
+
+### Return type
+
+[**AssetResponse**](AssetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
 # **update_asset_master_access**
 > AssetResponse update_asset_master_access(asset_id, update_asset_master_access_request)
 

docs/CreateAssetRequest.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **input** | [**list[InputSettings]**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] 
 **playback_policy** | [**list[PlaybackPolicy]**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] 
 **per_title_encode** | **bool** |  | [optional] 
-**passthrough** | **str** | Arbitrary metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] 
+**passthrough** | **str** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] 
 **mp4_support** | **str** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] 
 **normalize_audio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to False]
 **master_access** | **str** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] 

docs/CreateLiveStreamRequest.md

@@ -9,8 +9,9 @@ Name | Type | Description | Notes
 **passthrough** | **str** |  | [optional] 
 **audio_only** | **bool** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] 
 **embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] 
-**reduced_latency** | **bool** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
-**low_latency** | **bool** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] 
+**reduced_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
+**low_latency** | **bool** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] 
+**latency_mode** | **str** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] 
 **test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] 
 **simulcast_targets** | [**list[CreateSimulcastTargetRequest]**](CreateSimulcastTargetRequest.md) |  | [optional] 
 

docs/CreatePlaybackRestrictionRequest.md

@@ -0,0 +1,10 @@
+# CreatePlaybackRestrictionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**referrer** | [**ReferrerDomainRestriction**](.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/CreateSimulcastTargetRequest.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**passthrough** | **str** | Arbitrary metadata set by you when creating a simulcast target. | [optional] 
+**passthrough** | **str** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] 
 **stream_key** | **str** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] 
 **url** | **str** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. | 
 

docs/CreateTrackRequest.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **language_code** | **str** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. | 
 **name** | **str** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] 
 **closed_captions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] 
-**passthrough** | **str** | Arbitrary metadata set for the track either when creating the asset or track. | [optional] 
+**passthrough** | **str** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/DeliveryUsageApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **list_delivery_usage**
-> ListDeliveryUsageResponse list_delivery_usage(page=page, limit=limit, asset_id=asset_id, timeframe=timeframe)
+> ListDeliveryUsageResponse list_delivery_usage(page=page, limit=limit, asset_id=asset_id, live_stream_id=live_stream_id, timeframe=timeframe)
 
 List Usage
 
@@ -46,12 +46,13 @@ with mux_python.ApiClient(configuration) as api_client:
     api_instance = mux_python.DeliveryUsageApi(api_client)
     page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1)
 limit = 100 # int | Number of items to include in the response (optional) (default to 100)
-asset_id = 'asset_id_example' # str | Filter response to return delivery usage for this asset only. (optional)
+asset_id = 'asset_id_example' # str | Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together. (optional)
+live_stream_id = 'live_stream_id_example' # str | Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together. (optional)
 timeframe = ['timeframe_example'] # list[str] | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. (optional)
 
     try:
         # List Usage
-        api_response = api_instance.list_delivery_usage(page=page, limit=limit, asset_id=asset_id, timeframe=timeframe)
+        api_response = api_instance.list_delivery_usage(page=page, limit=limit, asset_id=asset_id, live_stream_id=live_stream_id, timeframe=timeframe)
         pprint(api_response)
     except ApiException as e:
         print("Exception when calling DeliveryUsageApi->list_delivery_usage: %s\n" % e)
@@ -63,7 +64,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
  **limit** | **int**| Number of items to include in the response | [optional] [default to 100]
- **asset_id** | **str**| Filter response to return delivery usage for this asset only. | [optional] 
+ **asset_id** | **str**| Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together. | [optional] 
+ **live_stream_id** | **str**| Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together. | [optional] 
  **timeframe** | [**list[str]**](str.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional] 
 
 ### Return type