mux_ruby 1.5.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deda4a3da46421f0c7e44873ed3d5bb828c0f324895adeb80df3dc70e1f5f35e
-  data.tar.gz: 147c244aa891da785e99fb398aa0879655cb3b4869a9ced998f17ba302495de4
+  metadata.gz: 57380e4202d460cfdb8bde993e835818799ea3c1df4f52f3f513eec8d10552cc
+  data.tar.gz: 1acb2eeb73ab3c670ca81f6cf3095cc8b4681b20d458e235d969f5f103ef072e
 SHA512:
-  metadata.gz: 1b34f4e599ad296362367fc1635064c6e6b1716db194c3106347f57c403d9bf0adf3150057756db1c914c717bc425307f0cdc1d54b2205ae77ba64fe485f8754
-  data.tar.gz: 260c7782a1ee06f800094fb5eda723e728f6dc95501b5f264e457ecb0230f096887cca7bd569bfe31adffa623bf8d466b43659ace6030e976859b55ddfc514ee
+  metadata.gz: 01bc513413c7663ef490a4e193755479e7b0e6739f9f1b7ddd621e8f1146a8ec9a219be4d8b78f2b7f259105b26f203b1da04d7835bc34b718fdef3e759988c2
+  data.tar.gz: 20adae366398998ae7861471860cb36579d2e6594620ebd6c8073d3872e326b070d33859e2244c2a0420cf5c71c8483358895cf0daf6013dcd5bf76c3c9df809

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.5.0)
+    mux_ruby (1.9.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -78,4 +78,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.17.2
+   2.2.13

data/README.md

@@ -21,8 +21,11 @@ Use `bundle install` to install dependencies if you're developing locally.
 ## Installation
 
 ### Adding to your Gemfile
+
+This gem can be sourced from [RubyGems](https://rubygems.org/gems/mux_ruby)
+
 ```
-gem 'mux_ruby', :git => 'git://github.com/muxinc/mux-ruby.git'
+gem 'mux_ruby'
 ```
 
 ### Clone and install locally

data/docs/Asset.md

@@ -3,26 +3,29 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**created_at** | **String** |  | [optional] 
+**id** | **String** | Unique identifier for the Asset. | [optional] 
+**created_at** | **String** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional] 
 **deleted_at** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
-**duration** | **Float** |  | [optional] 
-**max_stored_resolution** | **String** |  | [optional] 
-**max_stored_frame_rate** | **Float** |  | [optional] 
-**aspect_ratio** | **String** |  | [optional] 
+**status** | **String** | The status of the asset. | [optional] 
+**duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional] 
+**max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] 
+**max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.  | [optional] 
+**aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] 
 **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
 **tracks** | [**Array<Track>**](Track.md) |  | [optional] 
 **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
-**is_live** | **BOOLEAN** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
-**live_stream_id** | **String** |  | [optional] 
+**is_live** | **BOOLEAN** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] 
+**passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] 
+**live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] 
 **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] 
 **master_access** | **String** |  | [optional] [default to 'none']
 **mp4_support** | **String** |  | [optional] [default to 'none']
-**normalize_audio** | **BOOLEAN** |  | [optional] [default to false]
+**source_asset_id** | **String** | Asset Identifier of the video used as the source for creating the clip. | [optional] 
+**normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
 **static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) |  | [optional] 
-**test** | **BOOLEAN** |  | [optional] 
+**recording_times** | [**Array<AssetRecordingTimes>**](AssetRecordingTimes.md) | An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream | [optional] 
+**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) |  | [optional] 
+**test** | **BOOLEAN** | Indicates this asset is a test asset if the value is `true`. 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] 
 
 

data/docs/AssetErrors.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** |  | [optional] 
-**messages** | **Array<String>** |  | [optional] 
+**type** | **String** | The type of error that occurred for this asset. | [optional] 
+**messages** | **Array<String>** | Error messages with more details. | [optional] 
 
 

data/docs/AssetNonStandardInputReasons.md

@@ -0,0 +1,16 @@
+# MuxRuby::AssetNonStandardInputReasons
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**video_codec** | **String** | The video codec used on the input file. | [optional] 
+**audio_codec** | **String** | The audio codec used on the input file. | [optional] 
+**video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file. | [optional] 
+**video_frame_rate** | **String** | The video frame rate of the input file. | [optional] 
+**video_resolution** | **String** | The video resolution of the input file. | [optional] 
+**pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file. | [optional] 
+**video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] 
+**audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] 
+**unexpected_media_file_parameters** | **String** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional] 
+
+

data/docs/AssetRecordingTimes.md

@@ -0,0 +1,9 @@
+# MuxRuby::AssetRecordingTimes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**started_at** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format. | [optional] 
+**duration** | **Float** | The duration of the live stream recorded. The time value is in seconds. | [optional] 
+
+

data/docs/AssetStaticRenditions.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | **String** | * `ready`: All MP4s are downloadable * `preparing`: We are preparing the MP4s * `disabled`: MP4 support was not requested or has been removed * `errored`: There was a Mux internal error that prevented the MP4s from being created  | [optional] [default to 'disabled']
+**status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional] [default to 'disabled']
 **files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) |  | [optional] 
 
 

data/docs/AssetsApi.md

@@ -176,6 +176,8 @@ Name | Type | Description  | Notes
 
 Delete an asset
 
+Deletes a video asset and all its data 
+
 ### Example
 ```ruby
 # load the gem
@@ -477,6 +479,8 @@ Name | Type | Description  | Notes
 
 List assets
 
+List all Mux assets. 
+
 ### Example
 ```ruby
 # load the gem

data/docs/CreateAssetRequest.md

@@ -3,13 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**input** | [**Array<InputSettings>**](InputSettings.md) |  | [optional] 
-**playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] 
+**input** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] 
+**playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
-**mp4_support** | **String** |  | [optional] 
+**passthrough** | **String** | Arbitrary metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] 
+**mp4_support** | **String** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your vidoes guide](/guides/video/download-your-videos) for more information. | [optional] 
 **normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
-**master_access** | **String** |  | [optional] 
-**test** | **BOOLEAN** |  | [optional] 
+**master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your vidoes guide](/guides/video/download-your-videos) for more information. | [optional] 
+**test** | **BOOLEAN** | Marks the asset as a test asset when the value is set to true. 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 asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional] 
 
 

data/docs/CreateLiveStreamRequest.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **passthrough** | **String** |  | [optional] 
 **reduced_latency** | **BOOLEAN** | 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] 
 **test** | **BOOLEAN** |  | [optional] 
+**simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) |  | [optional] 
 
 

data/docs/CreateTrackRequest.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 **url** | **String** |  | 
 **type** | **String** |  | 
 **text_type** | **String** |  | 
-**language_code** | **String** |  | 
-**name** | **String** |  | [optional] 
-**closed_captions** | **BOOLEAN** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
+**language_code** | **String** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. | 
+**name** | **String** | The name of the track containing a human-readable description. This value must be unqiue across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] 
+**closed_captions** | **BOOLEAN** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] 
+**passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. | [optional] 
 
 

data/docs/DimensionValue.md

@@ -0,0 +1,9 @@
+# MuxRuby::DimensionValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**total_count** | **Integer** |  | [optional] 
+
+

data/docs/DimensionsApi.md

@@ -0,0 +1,118 @@
+# MuxRuby::DimensionsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
+[**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions
+
+
+# **list_dimension_values**
+> ListDimensionValuesResponse list_dimension_values(dimension_id, opts)
+
+Lists the values for a specific dimension
+
+Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+
+### Example
+```ruby
+# load the gem
+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::DimensionsApi.new
+dimension_id = 'abcd1234' # String | ID of the Dimension
+opts = {
+  limit: 25, # Integer | Number of items to include in the response
+  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+  timeframe: ['timeframe_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
+  #Lists the values for a specific dimension
+  result = api_instance.list_dimension_values(dimension_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimension_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dimension_id** | **String**| ID of the Dimension | 
+ **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]
+ **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint.  | [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. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600    * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.  | [optional] 
+
+### Return type
+
+[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_dimensions**
+> ListDimensionsResponse list_dimensions
+
+List Dimensions
+
+List all available dimensions.  Note: This API replaces the list-filters API call. 
+
+### Example
+```ruby
+# load the gem
+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::DimensionsApi.new
+
+begin
+  #List Dimensions
+  result = api_instance.list_dimensions
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimensions: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDimensionsResponse**](ListDimensionsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/DisableLiveStreamResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::DisableLiveStreamResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) |  | [optional] 
+
+

data/docs/EnableLiveStreamResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::EnableLiveStreamResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) |  | [optional] 
+
+

data/docs/FiltersApi.md

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

data/docs/GetAssetOrLiveStreamIdResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) |  | [optional] 
+
+

data/docs/GetAssetOrLiveStreamIdResponseData.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional] 
+**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) |  | [optional] 
+**object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) |  | [optional] 
+
+

data/docs/GetAssetOrLiveStreamIdResponseDataObject.md

@@ -0,0 +1,9 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponseDataObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identifier of the object. | [optional] 
+**type** | **String** | Identifies the object type associated with the playback ID. | [optional] 
+
+

data/docs/GetRealTimeBreakdownResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetRealTimeBreakdownResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/GetRealTimeHistogramTimeseriesResponse.md

@@ -0,0 +1,11 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) |  | [optional] 
+**data** | [**Array<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md

@@ -0,0 +1,8 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) |  | [optional] 
+
+

data/docs/GetRealTimeTimeseriesResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetRealTimeTimeseriesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+