diff --git a/bandwidth.yml b/bandwidth.yml index 4b88b456..53949fed 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -8237,8 +8237,8 @@ components: in: path name: mediaId required: true - description: Media ID to retrieve. - example: 14762070468292kw2fuqty55yp2b2/0/bw.png + description: The ID of the media file. + example: bw.png schema: type: string contentType: diff --git a/bandwidth/api/media_api.py b/bandwidth/api/media_api.py index 71d4ed5e..1bb8b389 100644 --- a/bandwidth/api/media_api.py +++ b/bandwidth/api/media_api.py @@ -44,7 +44,7 @@ def __init__(self, api_client=None) -> None: def delete_media( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -64,7 +64,7 @@ def delete_media( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -123,7 +123,7 @@ def delete_media( def delete_media_with_http_info( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -143,7 +143,7 @@ def delete_media_with_http_info( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -202,7 +202,7 @@ def delete_media_with_http_info( def delete_media_without_preload_content( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -222,7 +222,7 @@ def delete_media_without_preload_content( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -348,7 +348,7 @@ def _delete_media_serialize( def get_media( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -368,7 +368,7 @@ def get_media( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -427,7 +427,7 @@ def get_media( def get_media_with_http_info( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -447,7 +447,7 @@ def get_media_with_http_info( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -506,7 +506,7 @@ def get_media_with_http_info( def get_media_without_preload_content( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -526,7 +526,7 @@ def get_media_without_preload_content( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -957,7 +957,7 @@ def _list_media_serialize( def upload_media( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], content_type: Annotated[Optional[StrictStr], Field(description="The media type of the entity-body.")] = None, cache_control: Annotated[Optional[StrictStr], Field(description="General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.")] = None, @@ -980,7 +980,7 @@ def upload_media( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param body: (required) :type body: bytearray @@ -1048,7 +1048,7 @@ def upload_media( def upload_media_with_http_info( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], content_type: Annotated[Optional[StrictStr], Field(description="The media type of the entity-body.")] = None, cache_control: Annotated[Optional[StrictStr], Field(description="General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.")] = None, @@ -1071,7 +1071,7 @@ def upload_media_with_http_info( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param body: (required) :type body: bytearray @@ -1139,7 +1139,7 @@ def upload_media_with_http_info( def upload_media_without_preload_content( self, account_id: Annotated[StrictStr, Field(description="This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** ")], - media_id: Annotated[StrictStr, Field(description="Media ID to retrieve.")], + media_id: Annotated[StrictStr, Field(description="The ID of the media file.")], body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], content_type: Annotated[Optional[StrictStr], Field(description="The media type of the entity-body.")] = None, cache_control: Annotated[Optional[StrictStr], Field(description="General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.")] = None, @@ -1162,7 +1162,7 @@ def upload_media_without_preload_content( :param account_id: This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required) :type account_id: str - :param media_id: Media ID to retrieve. (required) + :param media_id: The ID of the media file. (required) :type media_id: str :param body: (required) :type body: bytearray diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 851f5d49..723f225c 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -59,7 +59,7 @@ with bandwidth.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = bandwidth.MediaApi(api_client) account_id = '9900000' # str | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** - media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # str | Media ID to retrieve. + media_id = 'bw.png' # str | The ID of the media file. try: # Delete Media @@ -76,7 +76,7 @@ with bandwidth.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | - **media_id** | **str**| Media ID to retrieve. | + **media_id** | **str**| The ID of the media file. | ### Return type @@ -152,7 +152,7 @@ with bandwidth.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = bandwidth.MediaApi(api_client) account_id = '9900000' # str | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** - media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # str | Media ID to retrieve. + media_id = 'bw.png' # str | The ID of the media file. try: # Get Media @@ -171,7 +171,7 @@ with bandwidth.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | - **media_id** | **str**| Media ID to retrieve. | + **media_id** | **str**| The ID of the media file. | ### Return type @@ -347,7 +347,7 @@ with bandwidth.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = bandwidth.MediaApi(api_client) account_id = '9900000' # str | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** - media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # str | Media ID to retrieve. + media_id = 'bw.png' # str | The ID of the media file. body = None # bytearray | content_type = 'audio/wav' # str | The media type of the entity-body. (optional) cache_control = 'no-cache' # str | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) @@ -367,7 +367,7 @@ with bandwidth.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | - **media_id** | **str**| Media ID to retrieve. | + **media_id** | **str**| The ID of the media file. | **body** | **bytearray**| | **content_type** | **str**| The media type of the entity-body. | [optional] **cache_control** | **str**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional]