Skip to content

Commit 24e7ee9

Browse files
eroppleeropple
committed
[release] 2.2.0
1 parent 9edcbda commit 24e7ee9

13 files changed

+423
-5
lines changed

‎.openapi-generator/FILES‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ docs/GetAssetOrLiveStreamIdResponse.md
3939
docs/GetAssetOrLiveStreamIdResponseData.md
4040
docs/GetAssetOrLiveStreamIdResponseDataObject.md
4141
docs/GetAssetPlaybackIDResponse.md
42+
docs/GetLiveStreamPlaybackIDResponse.md
4243
docs/GetMetricTimeseriesDataResponse.md
4344
docs/GetOverallValuesResponse.md
4445
docs/GetRealTimeBreakdownResponse.md
@@ -163,6 +164,7 @@ mux_python/models/get_asset_or_live_stream_id_response.py
163164
mux_python/models/get_asset_or_live_stream_id_response_data.py
164165
mux_python/models/get_asset_or_live_stream_id_response_data_object.py
165166
mux_python/models/get_asset_playback_id_response.py
167+
mux_python/models/get_live_stream_playback_id_response.py
166168
mux_python/models/get_metric_timeseries_data_response.py
167169
mux_python/models/get_overall_values_response.py
168170
mux_python/models/get_real_time_breakdown_response.py
@@ -235,4 +237,5 @@ setup.cfg
235237
setup.py
236238
test-requirements.txt
237239
test/__init__.py
240+
test/test_get_live_stream_playback_id_response.py
238241
tox.ini

‎.tool-versions‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
python 3.7.2
22
java zulu-16.32.15
3+
yarn 1.22.10
4+
nodejs 16.5.0

‎docs/GetLiveStreamPlaybackIDResponse.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GetLiveStreamPlaybackIDResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**PlaybackID**](.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/LiveStreamsApi.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Method | HTTP request | Description
1313
[**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
1414
[**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
1515
[**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
16+
[**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID
1617
[**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
1718
[**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
1819
[**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
@@ -673,6 +674,79 @@ Name | Type | Description | Notes
673674

674675
[[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)
675676

677+
# **get_live_stream_playback_id**
678+
> GetLiveStreamPlaybackIDResponse get_live_stream_playback_id(live_stream_id, playback_id)
679+
680+
Retrieve a live stream playback ID
681+
682+
### Example
683+
684+
* Basic Authentication (accessToken):
685+
```python
686+
from __future__ import print_function
687+
import time
688+
import mux_python
689+
from mux_python.rest import ApiException
690+
from pprint import pprint
691+
# Defining the host is optional and defaults to https://api.mux.com
692+
# See configuration.py for a list of all supported configuration parameters.
693+
configuration = mux_python.Configuration(
694+
host = "https://api.mux.com"
695+
)
696+
697+
# The client must configure the authentication and authorization parameters
698+
# in accordance with the API server security policy.
699+
# Examples for each auth method are provided below, use the example that
700+
# satisfies your auth use case.
701+
702+
# Configure HTTP basic authorization: accessToken
703+
configuration = mux_python.Configuration(
704+
username = 'YOUR_USERNAME',
705+
password = 'YOUR_PASSWORD'
706+
)
707+
708+
# Enter a context with an instance of the API client
709+
with mux_python.ApiClient(configuration) as api_client:
710+
# Create an instance of the API class
711+
api_instance = mux_python.LiveStreamsApi(api_client)
712+
live_stream_id = 'live_stream_id_example' # str | The live stream ID
713+
playback_id = 'playback_id_example' # str | The live stream's playback ID.
714+
715+
try:
716+
# Retrieve a live stream playback ID
717+
api_response = api_instance.get_live_stream_playback_id(live_stream_id, playback_id)
718+
pprint(api_response)
719+
except ApiException as e:
720+
print("Exception when calling LiveStreamsApi->get_live_stream_playback_id: %s\n" % e)
721+
```
722+
723+
### Parameters
724+
725+
Name | Type | Description | Notes
726+
------------- | ------------- | ------------- | -------------
727+
**live_stream_id** | **str**| The live stream ID |
728+
**playback_id** | **str**| The live stream's playback ID. |
729+
730+
### Return type
731+
732+
[**GetLiveStreamPlaybackIDResponse**](GetLiveStreamPlaybackIDResponse.md)
733+
734+
### Authorization
735+
736+
[accessToken](../README.md#accessToken)
737+
738+
### HTTP request headers
739+
740+
- **Content-Type**: Not defined
741+
- **Accept**: application/json
742+
743+
### HTTP response details
744+
| Status code | Description | Response headers |
745+
|-------------|-------------|------------------|
746+
**200** | OK | - |
747+
748+
[[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)
749+
676750
# **get_live_stream_simulcast_target**
677751
> SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
678752

‎gen/generator-config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md",
33
"packageName": "mux_python",
44
"projectName": "mux_python",
5-
"packageVersion": "2.1.1"
5+
"packageVersion": "2.2.0"
66
}

‎mux_python/__init__.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
from __future__ import absolute_import
1717

18-
__version__ = "2.1.1"
18+
__version__ = "2.2.0"
1919

2020
# import apis into sdk package
2121
from mux_python.api.assets_api import AssetsApi
@@ -74,6 +74,7 @@
7474
from mux_python.models.get_asset_or_live_stream_id_response_data import GetAssetOrLiveStreamIdResponseData
7575
from mux_python.models.get_asset_or_live_stream_id_response_data_object import GetAssetOrLiveStreamIdResponseDataObject
7676
from mux_python.models.get_asset_playback_id_response import GetAssetPlaybackIDResponse
77+
from mux_python.models.get_live_stream_playback_id_response import GetLiveStreamPlaybackIDResponse
7778
from mux_python.models.get_metric_timeseries_data_response import GetMetricTimeseriesDataResponse
7879
from mux_python.models.get_overall_values_response import GetOverallValuesResponse
7980
from mux_python.models.get_real_time_breakdown_response import GetRealTimeBreakdownResponse

‎mux_python/api/live_streams_api.py‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,6 +1282,150 @@ def get_live_stream_with_http_info(self, live_stream_id, **kwargs): # noqa: E50
12821282
collection_formats=collection_formats,
12831283
_request_auth=local_var_params.get('_request_auth'))
12841284

1285+
def get_live_stream_playback_id(self, live_stream_id, playback_id, **kwargs): # noqa: E501
1286+
"""Retrieve a live stream playback ID # noqa: E501
1287+
1288+
This method makes a synchronous HTTP request by default. To make an
1289+
asynchronous HTTP request, please pass async_req=True
1290+
1291+
>>> thread = api.get_live_stream_playback_id(live_stream_id, playback_id, async_req=True)
1292+
>>> result = thread.get()
1293+
1294+
:param live_stream_id: The live stream ID (required)
1295+
:type live_stream_id: str
1296+
:param playback_id: The live stream's playback ID. (required)
1297+
:type playback_id: str
1298+
:param async_req: Whether to execute the request asynchronously.
1299+
:type async_req: bool, optional
1300+
:param _preload_content: if False, the urllib3.HTTPResponse object will
1301+
be returned without reading/decoding response
1302+
data. Default is True.
1303+
:type _preload_content: bool, optional
1304+
:param _request_timeout: timeout setting for this request. If one
1305+
number provided, it will be total request
1306+
timeout. It can also be a pair (tuple) of
1307+
(connection, read) timeouts.
1308+
:return: Returns the result object.
1309+
If the method is called asynchronously,
1310+
returns the request thread.
1311+
:rtype: GetLiveStreamPlaybackIDResponse
1312+
"""
1313+
kwargs['_return_http_data_only'] = True
1314+
return self.get_live_stream_playback_id_with_http_info(live_stream_id, playback_id, **kwargs) # noqa: E501
1315+
1316+
def get_live_stream_playback_id_with_http_info(self, live_stream_id, playback_id, **kwargs): # noqa: E501
1317+
"""Retrieve a live stream playback ID # noqa: E501
1318+
1319+
This method makes a synchronous HTTP request by default. To make an
1320+
asynchronous HTTP request, please pass async_req=True
1321+
1322+
>>> thread = api.get_live_stream_playback_id_with_http_info(live_stream_id, playback_id, async_req=True)
1323+
>>> result = thread.get()
1324+
1325+
:param live_stream_id: The live stream ID (required)
1326+
:type live_stream_id: str
1327+
:param playback_id: The live stream's playback ID. (required)
1328+
:type playback_id: str
1329+
:param async_req: Whether to execute the request asynchronously.
1330+
:type async_req: bool, optional
1331+
:param _return_http_data_only: response data without head status code
1332+
and headers
1333+
:type _return_http_data_only: bool, optional
1334+
:param _preload_content: if False, the urllib3.HTTPResponse object will
1335+
be returned without reading/decoding response
1336+
data. Default is True.
1337+
:type _preload_content: bool, optional
1338+
:param _request_timeout: timeout setting for this request. If one
1339+
number provided, it will be total request
1340+
timeout. It can also be a pair (tuple) of
1341+
(connection, read) timeouts.
1342+
:param _request_auth: set to override the auth_settings for an a single
1343+
request; this effectively ignores the authentication
1344+
in the spec for a single request.
1345+
:type _request_auth: dict, optional
1346+
:return: Returns the result object.
1347+
If the method is called asynchronously,
1348+
returns the request thread.
1349+
:rtype: tuple(GetLiveStreamPlaybackIDResponse, status_code(int), headers(HTTPHeaderDict))
1350+
"""
1351+
1352+
local_var_params = locals()
1353+
1354+
all_params = [
1355+
'live_stream_id',
1356+
'playback_id'
1357+
]
1358+
all_params.extend(
1359+
[
1360+
'async_req',
1361+
'_return_http_data_only',
1362+
'_preload_content',
1363+
'_request_timeout',
1364+
'_request_auth'
1365+
]
1366+
)
1367+
1368+
for key, val in six.iteritems(local_var_params['kwargs']):
1369+
if key not in all_params:
1370+
raise ApiTypeError(
1371+
"Got an unexpected keyword argument '%s'"
1372+
" to method get_live_stream_playback_id" % key
1373+
)
1374+
local_var_params[key] = val
1375+
del local_var_params['kwargs']
1376+
# verify the required parameter 'live_stream_id' is set
1377+
if self.api_client.client_side_validation and ('live_stream_id' not in local_var_params or # noqa: E501
1378+
local_var_params['live_stream_id'] is None): # noqa: E501
1379+
raise ApiValueError("Missing the required parameter `live_stream_id` when calling `get_live_stream_playback_id`") # noqa: E501
1380+
# verify the required parameter 'playback_id' is set
1381+
if self.api_client.client_side_validation and ('playback_id' not in local_var_params or # noqa: E501
1382+
local_var_params['playback_id'] is None): # noqa: E501
1383+
raise ApiValueError("Missing the required parameter `playback_id` when calling `get_live_stream_playback_id`") # noqa: E501
1384+
1385+
collection_formats = {}
1386+
1387+
path_params = {}
1388+
if 'live_stream_id' in local_var_params:
1389+
path_params['LIVE_STREAM_ID'] = local_var_params['live_stream_id'] # noqa: E501
1390+
if 'playback_id' in local_var_params:
1391+
path_params['PLAYBACK_ID'] = local_var_params['playback_id'] # noqa: E501
1392+
1393+
query_params = []
1394+
1395+
header_params = {}
1396+
1397+
form_params = []
1398+
local_var_files = {}
1399+
1400+
body_params = None
1401+
# HTTP header `Accept`
1402+
header_params['Accept'] = self.api_client.select_header_accept(
1403+
['application/json']) # noqa: E501
1404+
1405+
# Authentication setting
1406+
auth_settings = ['accessToken'] # noqa: E501
1407+
1408+
response_types_map = {
1409+
200: "GetLiveStreamPlaybackIDResponse",
1410+
}
1411+
1412+
return self.api_client.call_api(
1413+
'/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}', 'GET',
1414+
path_params,
1415+
query_params,
1416+
header_params,
1417+
body=body_params,
1418+
post_params=form_params,
1419+
files=local_var_files,
1420+
response_types_map=response_types_map,
1421+
auth_settings=auth_settings,
1422+
async_req=local_var_params.get('async_req'),
1423+
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
1424+
_preload_content=local_var_params.get('_preload_content', True),
1425+
_request_timeout=local_var_params.get('_request_timeout'),
1426+
collection_formats=collection_formats,
1427+
_request_auth=local_var_params.get('_request_auth'))
1428+
12851429
def get_live_stream_simulcast_target(self, live_stream_id, simulcast_target_id, **kwargs): # noqa: E501
12861430
"""Retrieve a Live Stream Simulcast Target # noqa: E501
12871431

‎mux_python/api_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7979
self.default_headers[header_name] = header_value
8080
self.cookie = cookie
8181
# Set default User-Agent.
82-
self.user_agent = 'OpenAPI-Generator/2.1.1/python'
82+
self.user_agent = 'OpenAPI-Generator/2.2.0/python'
8383
self.client_side_validation = configuration.client_side_validation
8484

8585
def __enter__(self):

‎mux_python/configuration.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ def to_debug_report(self):
406406
"OS: {env}\n"\
407407
"Python Version: {pyversion}\n"\
408408
"Version of the API: v1\n"\
409-
"SDK Package Version: 2.1.1".\
409+
"SDK Package Version: 2.2.0".\
410410
format(env=sys.platform, pyversion=sys.version)
411411

412412
def get_host_settings(self):

‎mux_python/models/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
from mux_python.models.get_asset_or_live_stream_id_response_data import GetAssetOrLiveStreamIdResponseData
4747
from mux_python.models.get_asset_or_live_stream_id_response_data_object import GetAssetOrLiveStreamIdResponseDataObject
4848
from mux_python.models.get_asset_playback_id_response import GetAssetPlaybackIDResponse
49+
from mux_python.models.get_live_stream_playback_id_response import GetLiveStreamPlaybackIDResponse
4950
from mux_python.models.get_metric_timeseries_data_response import GetMetricTimeseriesDataResponse
5051
from mux_python.models.get_overall_values_response import GetOverallValuesResponse
5152
from mux_python.models.get_real_time_breakdown_response import GetRealTimeBreakdownResponse

0 commit comments

Comments
 (0)