mux_ruby 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e7024709cfa02ba67b2cbd7d8881dbb0bda598fc59fdcaaa9257fd7d17ee1ed
-  data.tar.gz: 98de35b68e8cfe8ba22aefe0c81cc1cccc456268c615adb92ea2c630ffea9f0d
+  metadata.gz: ad6865c8e30e17e7faebab8ea4f6affcc4bb61dbe85232d90e5c983c8c7c749c
+  data.tar.gz: aa9ef1a3f601e6ea701f6671973e38f3b837205bea03b57e9ed3298e887a7243
 SHA512:
-  metadata.gz: dba3402d7e188c7929fd23cc2f94ac04ea1a9896eef02d7a84525fe1f9bcc0c00faf7453928bce427f4cd7160a4f975c25ddb80108366ace454bb0b9fe5b067a
-  data.tar.gz: 45f794d5d94b2c827e35cf217589d2c60a07868fd80bd82b7673af11feb3448da0c8752f248945c4143da6dbdf25a72501d86370de1233530e7af7f7c8b452d7
+  metadata.gz: 30b529f653b3384080dbcef15ec44124b3751fed3e8c6fe46c4ecf21bc6cfdb3dc8964b7e353faf2ea373752573b4fb363a76456e1d5d809513047a26511f6d6
+  data.tar.gz: f1992545ce8f2037574028a672f7cd6fd0a90c1fb934306d21836fd719ca6a4cf845ea6efa52d22ab62c00704ed7831128f53e9935de4bdffb90afcc01133ec8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (5.0.1)
+    mux_ruby (5.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 5.0.1
+- Package version: 5.1.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.mux.com](https://docs.mux.com)
 
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mux_ruby-5.0.1.gem
+gem install ./mux_ruby-5.1.0.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-5.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-5.1.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'mux_ruby', '~> 5.0.1'
+    gem 'mux_ruby', '~> 5.1.0'
 
 ### Install from Git
 

data/docs/Annotation.md

@@ -0,0 +1,24 @@
+# MuxRuby::Annotation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the annotation | [optional] |
+| **note** | **String** | The annotation note content | [optional] |
+| **date** | **Time** | Datetime when the annotation applies | [optional] |
+| **sub_property_id** | **String** | Customer-defined sub-property identifier | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Annotation.new(
+  id: null,
+  note: null,
+  date: null,
+  sub_property_id: null
+)
+```
+

data/docs/AnnotationInput.md

@@ -0,0 +1,22 @@
+# MuxRuby::AnnotationInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **note** | **String** | The annotation note content | [optional] |
+| **date** | **Integer** | Datetime when the annotation applies (Unix timestamp) | [optional] |
+| **sub_property_id** | **String** | Customer-defined sub-property identifier | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AnnotationInput.new(
+  note: null,
+  date: null,
+  sub_property_id: null
+)
+```
+

data/docs/AnnotationResponse.md

@@ -0,0 +1,18 @@
+# MuxRuby::AnnotationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Annotation**](Annotation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AnnotationResponse.new(
+  data: null
+)
+```
+

data/docs/AnnotationsApi.md

@@ -0,0 +1,371 @@
+# MuxRuby::AnnotationsApi
+
+All URIs are relative to *https://api.mux.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_annotation**](AnnotationsApi.md#create_annotation) | **POST** /data/v1/annotations | Create Annotation |
+| [**delete_annotation**](AnnotationsApi.md#delete_annotation) | **DELETE** /data/v1/annotations/{ANNOTATION_ID} | Delete Annotation |
+| [**get_annotation**](AnnotationsApi.md#get_annotation) | **GET** /data/v1/annotations/{ANNOTATION_ID} | Get Annotation |
+| [**list_annotations**](AnnotationsApi.md#list_annotations) | **GET** /data/v1/annotations | List Annotations |
+| [**update_annotation**](AnnotationsApi.md#update_annotation) | **PATCH** /data/v1/annotations/{ANNOTATION_ID} | Update Annotation |
+
+
+## create_annotation
+
+> <AnnotationResponse> create_annotation(annotation_input)
+
+Create Annotation
+
+Creates a new annotation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AnnotationsApi.new
+annotation_input = MuxRuby::AnnotationInput.new # AnnotationInput | 
+
+begin
+  # Create Annotation
+  result = api_instance.create_annotation(annotation_input)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->create_annotation: #{e}"
+end
+```
+
+#### Using the create_annotation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AnnotationResponse>, Integer, Hash)> create_annotation_with_http_info(annotation_input)
+
+```ruby
+begin
+  # Create Annotation
+  data, status_code, headers = api_instance.create_annotation_with_http_info(annotation_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AnnotationResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->create_annotation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **annotation_input** | [**AnnotationInput**](AnnotationInput.md) |  |  |
+
+### Return type
+
+[**AnnotationResponse**](AnnotationResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_annotation
+
+> delete_annotation(annotation_id)
+
+Delete Annotation
+
+Deletes an annotation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AnnotationsApi.new
+annotation_id = TODO # String | The annotation ID
+
+begin
+  # Delete Annotation
+  api_instance.delete_annotation(annotation_id)
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->delete_annotation: #{e}"
+end
+```
+
+#### Using the delete_annotation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_annotation_with_http_info(annotation_id)
+
+```ruby
+begin
+  # Delete Annotation
+  data, status_code, headers = api_instance.delete_annotation_with_http_info(annotation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->delete_annotation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **annotation_id** | [**String**](.md) | The annotation ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_annotation
+
+> <AnnotationResponse> get_annotation(annotation_id)
+
+Get Annotation
+
+Returns the details of a specific annotation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AnnotationsApi.new
+annotation_id = TODO # String | The annotation ID
+
+begin
+  # Get Annotation
+  result = api_instance.get_annotation(annotation_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->get_annotation: #{e}"
+end
+```
+
+#### Using the get_annotation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AnnotationResponse>, Integer, Hash)> get_annotation_with_http_info(annotation_id)
+
+```ruby
+begin
+  # Get Annotation
+  data, status_code, headers = api_instance.get_annotation_with_http_info(annotation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AnnotationResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->get_annotation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **annotation_id** | [**String**](.md) | The annotation ID |  |
+
+### Return type
+
+[**AnnotationResponse**](AnnotationResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_annotations
+
+> <ListAnnotationsResponse> list_annotations(opts)
+
+List Annotations
+
+Returns a list of annotations.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AnnotationsApi.new
+opts = {
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  order_direction: 'asc', # String | Sort order.
+  timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days` 
+}
+
+begin
+  # List Annotations
+  result = api_instance.list_annotations(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->list_annotations: #{e}"
+end
+```
+
+#### Using the list_annotations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAnnotationsResponse>, Integer, Hash)> list_annotations_with_http_info(opts)
+
+```ruby
+begin
+  # List Annotations
+  data, status_code, headers = api_instance.list_annotations_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAnnotationsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->list_annotations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
+| **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
+| **order_direction** | **String** | Sort order. | [optional] |
+| **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;).  Accepted formats are...    * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
+
+### Return type
+
+[**ListAnnotationsResponse**](ListAnnotationsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_annotation
+
+> <AnnotationResponse> update_annotation(annotation_id, annotation_input)
+
+Update Annotation
+
+Updates an existing annotation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AnnotationsApi.new
+annotation_id = TODO # String | The annotation ID
+annotation_input = MuxRuby::AnnotationInput.new # AnnotationInput | 
+
+begin
+  # Update Annotation
+  result = api_instance.update_annotation(annotation_id, annotation_input)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->update_annotation: #{e}"
+end
+```
+
+#### Using the update_annotation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AnnotationResponse>, Integer, Hash)> update_annotation_with_http_info(annotation_id, annotation_input)
+
+```ruby
+begin
+  # Update Annotation
+  data, status_code, headers = api_instance.update_annotation_with_http_info(annotation_id, annotation_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AnnotationResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AnnotationsApi->update_annotation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **annotation_id** | [**String**](.md) | The annotation ID |  |
+| **annotation_input** | [**AnnotationInput**](AnnotationInput.md) |  |  |
+
+### Return type
+
+[**AnnotationResponse**](AnnotationResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Asset.md

@@ -34,6 +34,7 @@
 | **test** | **Boolean** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] |
 | **ingest_type** | **String** | The type of ingest used to create the asset. | [optional] |
 | **meta** | [**AssetMetadata**](AssetMetadata.md) |  | [optional] |
+| **progress** | [**AssetProgress**](AssetProgress.md) |  | [optional] |
 
 ## Example
 
@@ -70,7 +71,8 @@ instance = MuxRuby::Asset.new(
   non_standard_input_reasons: null,
   test: null,
   ingest_type: null,
-  meta: null
+  meta: null,
+  progress: null
 )
 ```
 

data/docs/AssetProgress.md

@@ -0,0 +1,20 @@
+# MuxRuby::AssetProgress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** | The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).  - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1.  | [optional] |
+| **progress** | **Float** | Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AssetProgress.new(
+  state: null,
+  progress: null
+)
+```
+

data/docs/AssetsApi.md

@@ -525,7 +525,7 @@ nil (empty response body)
 
 Delete an asset track
 
-Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
+Removes a text or additional audio track from an asset. Neither video nor the primary audio track can be removed.
 
 ### Examples
 
@@ -900,6 +900,7 @@ api_instance = MuxRuby::AssetsApi.new
 opts = {
   limit: 56, # Integer | Number of items to include in the response
   page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  cursor: 'cursor_example', # String | This parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses.
   live_stream_id: 'live_stream_id_example', # String | Filter response to return all the assets for this live stream only
   upload_id: 'upload_id_example' # String | Filter response to return an asset created from this direct upload only
 }
@@ -937,6 +938,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
 | **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
+| **cursor** | **String** | This parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses. | [optional] |
 | **live_stream_id** | **String** | Filter response to return all the assets for this live stream only | [optional] |
 | **upload_id** | **String** | Filter response to return an asset created from this direct upload only | [optional] |
 

data/docs/CreateAssetRequest.md

@@ -20,6 +20,7 @@
 | **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional] |
 | **static_renditions** | [**Array<CreateStaticRenditionRequest>**](CreateStaticRenditionRequest.md) | An array of static renditions to create for this asset. You may not enable both `static_renditions` and `mp4_support (the latter being deprecated)` | [optional] |
 | **meta** | [**AssetMetadata**](AssetMetadata.md) |  | [optional] |
+| **copy_overlays** | **Boolean** | If the created asset is a clip, this controls whether overlays are copied from the source asset. | [optional][default to true] |
 
 ## Example
 
@@ -42,7 +43,8 @@ instance = MuxRuby::CreateAssetRequest.new(
   encoding_tier: null,
   video_quality: null,
   static_renditions: null,
-  meta: null
+  meta: null,
+  copy_overlays: null
 )
 ```
 

data/docs/CreateLiveStreamRequest.md

@@ -21,6 +21,7 @@
 | **test** | **Boolean** | 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** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) |  | [optional] |
 | **max_continuous_duration** | **Integer** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional][default to 43200] |
+| **meta** | [**LiveStreamMetadata**](LiveStreamMetadata.md) |  | [optional] |
 
 ## Example
 
@@ -44,7 +45,8 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
   latency_mode: null,
   test: null,
   simulcast_targets: null,
-  max_continuous_duration: null
+  max_continuous_duration: null,
+  meta: null
 )
 ```