Skip to content

Commit

Permalink
v3.16.0 (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsanford8 authored May 7, 2024
1 parent 7285191 commit ef762ab
Show file tree
Hide file tree
Showing 35 changed files with 1,458 additions and 32 deletions.
12 changes: 12 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,17 @@ docs/UpdateAssetMasterAccessRequest.md
docs/UpdateAssetRequest.md
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
docs/UpdateLiveStreamNewAssetSettings.md
docs/UpdateLiveStreamRequest.md
docs/UpdateReferrerDomainRestrictionRequest.md
docs/UpdateTranscriptionVocabularyRequest.md
docs/UpdateUserAgentRestrictionRequest.md
docs/UpdateWebInputUrlRequest.md
docs/Upload.md
docs/UploadError.md
docs/UploadResponse.md
docs/UserAgentRestrictionRequest.md
docs/UserAgentRestrictionSettings.md
docs/VideoView.md
docs/VideoViewEvent.md
docs/VideoViewResponse.md
Expand Down Expand Up @@ -349,13 +353,17 @@ 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_generated_subtitles_request.py
mux_python/models/update_live_stream_new_asset_settings.py
mux_python/models/update_live_stream_request.py
mux_python/models/update_referrer_domain_restriction_request.py
mux_python/models/update_transcription_vocabulary_request.py
mux_python/models/update_user_agent_restriction_request.py
mux_python/models/update_web_input_url_request.py
mux_python/models/upload.py
mux_python/models/upload_error.py
mux_python/models/upload_response.py
mux_python/models/user_agent_restriction_request.py
mux_python/models/user_agent_restriction_settings.py
mux_python/models/video_view.py
mux_python/models/video_view_event.py
mux_python/models/video_view_response.py
Expand All @@ -367,4 +375,8 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_update_live_stream_new_asset_settings.py
test/test_update_user_agent_restriction_request.py
test/test_user_agent_restriction_request.py
test/test_user_agent_restriction_settings.py
tox.ini
1 change: 1 addition & 0 deletions docs/AbridgedVideoView.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
**view_end** | **str** | | [optional]
**viewer_experience_score** | **float** | | [optional]
**watch_time** | **int** | | [optional]
**playback_failure** | **bool** | | [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)

Expand Down
1 change: 1 addition & 0 deletions docs/CreatePlaybackRestrictionRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
**user_agent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.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)

Expand Down
1 change: 1 addition & 0 deletions docs/DeliveryReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**asset_state** | **str** | The state of the asset. | [optional]
**asset_duration** | **float** | The duration of the asset in seconds. | [optional]
**asset_resolution_tier** | **str** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional]
**asset_encoding_tier** | **str** | The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional]
**delivered_seconds** | **float** | Total number of delivered seconds during this time window. | [optional]
**delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/GenerateTrackSubtitlesResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**Track**](Track.md) | | [optional]
**data** | [**list[Track]**](Track.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)

Expand Down
1 change: 1 addition & 0 deletions docs/PlaybackRestriction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**created_at** | **str** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional]
**updated_at** | **str** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional]
**referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
**user_agent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.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)

Expand Down
78 changes: 77 additions & 1 deletion docs/PlaybackRestrictionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Method | HTTP request | Description
[**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction
[**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions
[**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction
[**update_user_agent_restriction**](PlaybackRestrictionsApi.md#update_user_agent_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent | Update the User Agent Restriction


# **create_playback_restriction**
Expand Down Expand Up @@ -48,7 +49,7 @@ configuration = mux_python.Configuration(
with mux_python.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mux_python.PlaybackRestrictionsApi(api_client)
create_playback_restriction_request = {"referrer":{"allowed_domains":["*.example.com"],"allow_no_referrer":true}} # CreatePlaybackRestrictionRequest |
create_playback_restriction_request = {"referrer":{"allowed_domains":["*.example.com"],"allow_no_referrer":true},"user_agent":{"allow_no_user_agent":false,"allow_high_risk_user_agent":false}} # CreatePlaybackRestrictionRequest |

try:
# Create a Playback Restriction
Expand Down Expand Up @@ -379,3 +380,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_user_agent_restriction**
> PlaybackRestrictionResponse update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
Update the User Agent Restriction

Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.

### 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.PlaybackRestrictionsApi(api_client)
playback_restriction_id = 'playback_restriction_id_example' # str | ID of the Playback Restriction.
update_user_agent_restriction_request = {"allow_no_user_agent":false,"allow_high_risk_user_agent":false} # UpdateUserAgentRestrictionRequest |

try:
# Update the User Agent Restriction
api_response = api_instance.update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling PlaybackRestrictionsApi->update_user_agent_restriction: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**playback_restriction_id** | **str**| ID of the Playback Restriction. |
**update_user_agent_restriction_request** | [**UpdateUserAgentRestrictionRequest**](UpdateUserAgentRestrictionRequest.md)| |

### Return type

[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.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)

11 changes: 11 additions & 0 deletions docs/UpdateLiveStreamNewAssetSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UpdateLiveStreamNewAssetSettings

Updates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support` setting may be updated.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mp4_support** | **str** | Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). | [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)


1 change: 1 addition & 0 deletions docs/UpdateLiveStreamRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**use_slate_for_standard_latency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to False]
**reconnect_slate_url** | **str** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional]
**max_continuous_duration** | **int** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200]
**new_asset_settings** | [**UpdateLiveStreamNewAssetSettings**](UpdateLiveStreamNewAssetSettings.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)

Expand Down
11 changes: 11 additions & 0 deletions docs/UpdateUserAgentRestrictionRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UpdateUserAgentRestrictionRequest

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_no_user_agent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to True]
**allow_high_risk_user_agent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to True]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/UserAgentRestrictionRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# UserAgentRestrictionRequest

Rules that control what user agents are allowed to play your videos. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_no_user_agent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to True]
**allow_high_risk_user_agent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to True]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/UserAgentRestrictionSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# UserAgentRestrictionSettings

Rules that control what user agents are allowed to play your videos. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allow_no_user_agent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to True]
**allow_high_risk_user_agent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to True]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 6 additions & 0 deletions docs/VideoView.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,12 @@ Name | Type | Description | Notes
**playback_failure_error_type_id** | **int** | | [optional]
**playback_business_exception_error_type_id** | **int** | | [optional]
**video_startup_business_exception_error_type_id** | **int** | | [optional]
**playback_failure** | **bool** | | [optional]
**ad_playback_failure_error_type_id** | **int** | | [optional]
**view_content_startup_time** | **int** | | [optional]
**ad_preroll_startup_time** | **int** | | [optional]
**ad_watch_time** | **int** | | [optional]
**view_content_watch_time** | **int** | | [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)

Expand Down
2 changes: 1 addition & 1 deletion gen/generator-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"packageName": "mux_python",
"projectName": "mux_python",
"licenseInfo" : "MIT",
"packageVersion": "3.15.0"
"packageVersion": "3.16.0"
}
6 changes: 5 additions & 1 deletion mux_python/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from __future__ import absolute_import

__version__ = "3.15.0"
__version__ = "3.16.0"

# import apis into sdk package
from mux_python.api.assets_api import AssetsApi
Expand Down Expand Up @@ -194,13 +194,17 @@
from mux_python.models.update_asset_request import UpdateAssetRequest
from mux_python.models.update_live_stream_embedded_subtitles_request import UpdateLiveStreamEmbeddedSubtitlesRequest
from mux_python.models.update_live_stream_generated_subtitles_request import UpdateLiveStreamGeneratedSubtitlesRequest
from mux_python.models.update_live_stream_new_asset_settings import UpdateLiveStreamNewAssetSettings
from mux_python.models.update_live_stream_request import UpdateLiveStreamRequest
from mux_python.models.update_referrer_domain_restriction_request import UpdateReferrerDomainRestrictionRequest
from mux_python.models.update_transcription_vocabulary_request import UpdateTranscriptionVocabularyRequest
from mux_python.models.update_user_agent_restriction_request import UpdateUserAgentRestrictionRequest
from mux_python.models.update_web_input_url_request import UpdateWebInputUrlRequest
from mux_python.models.upload import Upload
from mux_python.models.upload_error import UploadError
from mux_python.models.upload_response import UploadResponse
from mux_python.models.user_agent_restriction_request import UserAgentRestrictionRequest
from mux_python.models.user_agent_restriction_settings import UserAgentRestrictionSettings
from mux_python.models.video_view import VideoView
from mux_python.models.video_view_event import VideoViewEvent
from mux_python.models.video_view_response import VideoViewResponse
Expand Down
Loading

0 comments on commit ef762ab

Please sign in to comment.