[release] 2.3.0

Author: eropple

.openapi-generator/FILES

@@ -81,6 +81,7 @@ docs/ListUploadsResponse.md
 docs/ListVideoViewExportsResponse.md
 docs/ListVideoViewsResponse.md
 docs/LiveStream.md
+docs/LiveStreamEmbeddedSubtitleSettings.md
 docs/LiveStreamResponse.md
 docs/LiveStreamsApi.md
 docs/Metric.md
@@ -106,6 +107,7 @@ docs/Track.md
 docs/URLSigningKeysApi.md
 docs/UpdateAssetMP4SupportRequest.md
 docs/UpdateAssetMasterAccessRequest.md
+docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
 docs/Upload.md
 docs/UploadError.md
 docs/UploadResponse.md
@@ -205,6 +207,7 @@ mux_python/models/list_uploads_response.py
 mux_python/models/list_video_view_exports_response.py
 mux_python/models/list_video_views_response.py
 mux_python/models/live_stream.py
+mux_python/models/live_stream_embedded_subtitle_settings.py
 mux_python/models/live_stream_response.py
 mux_python/models/metric.py
 mux_python/models/notification_rule.py
@@ -225,6 +228,7 @@ 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_live_stream_embedded_subtitles_request.py
 mux_python/models/upload.py
 mux_python/models/upload_error.py
 mux_python/models/upload_response.py
@@ -237,5 +241,6 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_get_live_stream_playback_id_response.py
+test/test_live_stream_embedded_subtitle_settings.py
+test/test_update_live_stream_embedded_subtitles_request.py
 tox.ini

docs/CreateLiveStreamRequest.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **reconnect_window** | **float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] 
 **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 subtitle 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] 
 **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] 

docs/ExportsApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 List property video view export links
 
-Deprecated: The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them. 
+The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them. 
 
 ### Example
 

docs/FiltersApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Lists values for a specific filter
 
-Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
+The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
 
 ### Example
 
@@ -94,7 +94,7 @@ Name | Type | Description  | Notes
 
 List Filters
 
-Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
+The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
 
 ### Example
 

docs/LiveStreamEmbeddedSubtitleSettings.md

@@ -0,0 +1,13 @@
+# LiveStreamEmbeddedSubtitleSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | A name for this live caption stream. | [optional] 
+**passthrough** | **str** | Arbitrary metadata set for the live stream caption track. Max 255 characters. | [optional] 
+**language_code** | **str** | The language of the caption stream. Value must be BCP 47 compliant. | [optional] [default to 'en']
+**language_channel** | **str** | CEA-608 caption channel to read data from. | [optional] [default to 'cc1']
+
+[[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/LiveStreamsApi.md

@@ -18,6 +18,7 @@ Method | HTTP request | Description
 [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
 [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key
 [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
+[**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles
 
 
 # **create_live_stream**
@@ -1043,3 +1044,78 @@ 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_live_stream_embedded_subtitles**
+> LiveStreamResponse update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
+
+Update a live stream's embedded subtitles
+
+Configures a live stream to receive embedded subtitles including captions and translations.
+
+### 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.LiveStreamsApi(api_client)
+    live_stream_id = 'live_stream_id_example' # str | The live stream ID
+update_live_stream_embedded_subtitles_request = {"embedded_subtitles":[{"passthrough":"Example"}]} # UpdateLiveStreamEmbeddedSubtitlesRequest | 
+
+    try:
+        # Update a live stream's embedded subtitles
+        api_response = api_instance.update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling LiveStreamsApi->update_live_stream_embedded_subtitles: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **str**| The live stream ID | 
+ **update_live_stream_embedded_subtitles_request** | [**UpdateLiveStreamEmbeddedSubtitlesRequest**](UpdateLiveStreamEmbeddedSubtitlesRequest.md)|  | 
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.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)
+

docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md

@@ -0,0 +1,10 @@
+# UpdateLiveStreamEmbeddedSubtitlesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**embedded_subtitles** | [**list[LiveStreamEmbeddedSubtitleSettings]**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded subtitle contents of the incoming live stream. | [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)
+
+

gen/generator-config.json

@@ -2,5 +2,5 @@
   "!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md",
   "packageName": "mux_python",
   "projectName": "mux_python",
-  "packageVersion": "2.2.0"
+  "packageVersion": "2.3.0"
 }

mux_python/__init__.py

@@ -15,7 +15,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 
 # import apis into sdk package
 from mux_python.api.assets_api import AssetsApi
@@ -115,6 +115,7 @@
 from mux_python.models.list_video_view_exports_response import ListVideoViewExportsResponse
 from mux_python.models.list_video_views_response import ListVideoViewsResponse
 from mux_python.models.live_stream import LiveStream
+from mux_python.models.live_stream_embedded_subtitle_settings import LiveStreamEmbeddedSubtitleSettings
 from mux_python.models.live_stream_response import LiveStreamResponse
 from mux_python.models.metric import Metric
 from mux_python.models.notification_rule import NotificationRule
@@ -135,6 +136,7 @@
 from mux_python.models.track import Track
 from mux_python.models.update_asset_mp4_support_request import UpdateAssetMP4SupportRequest
 from mux_python.models.update_asset_master_access_request import UpdateAssetMasterAccessRequest
+from mux_python.models.update_live_stream_embedded_subtitles_request import UpdateLiveStreamEmbeddedSubtitlesRequest
 from mux_python.models.upload import Upload
 from mux_python.models.upload_error import UploadError
 from mux_python.models.upload_response import UploadResponse

mux_python/api/exports_api.py

@@ -40,7 +40,7 @@ def __init__(self, api_client=None):
     def list_exports(self, **kwargs):  # noqa: E501
         """List property video view export links  # noqa: E501
 
-        Deprecated: The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them.   # noqa: E501
+        The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -68,7 +68,7 @@ def list_exports(self, **kwargs):  # noqa: E501
     def list_exports_with_http_info(self, **kwargs):  # noqa: E501
         """List property video view export links  # noqa: E501
 
-        Deprecated: The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them.   # noqa: E501
+        The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True