mux_ruby 1.9.0 → 2.0.0.pre.rc.1

data/docs/BreakdownValue.md

@@ -1,12 +1,26 @@
 # MuxRuby::BreakdownValue
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**views** | **Integer** |  | [optional] 
-**value** | **Float** |  | [optional] 
-**total_watch_time** | **Integer** |  | [optional] 
-**negative_impact** | **Integer** |  | [optional] 
-**field** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **views** | **Integer** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **total_watch_time** | **Integer** |  | [optional] |
+| **negative_impact** | **Integer** |  | [optional] |
+| **field** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::BreakdownValue.new(
+  views: null,
+  value: null,
+  total_watch_time: null,
+  negative_impact: null,
+  field: null
+)
+```
 

data/docs/CreateAssetRequest.md

@@ -1,15 +1,32 @@
 # MuxRuby::CreateAssetRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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** | 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** | 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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | 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 videos 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** | 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 videos 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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateAssetRequest.new(
+  input: null,
+  playback_policy: null,
+  per_title_encode: null,
+  passthrough: null,
+  mp4_support: null,
+  normalize_audio: null,
+  master_access: null,
+  test: null
+)
+```
 

data/docs/CreateLiveStreamRequest.md

@@ -1,14 +1,30 @@
 # MuxRuby::CreateLiveStreamRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] 
-**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] 
-**reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] 
-**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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] |
+| **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] |
+| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] |
+| **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** | 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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateLiveStreamRequest.new(
+  playback_policy: null,
+  new_asset_settings: null,
+  reconnect_window: null,
+  passthrough: null,
+  reduced_latency: null,
+  test: null,
+  simulcast_targets: null
+)
+```
 

data/docs/CreatePlaybackIDRequest.md

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

data/docs/CreatePlaybackIDResponse.md

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

data/docs/CreateSimulcastTargetRequest.md

@@ -1,10 +1,22 @@
 # MuxRuby::CreateSimulcastTargetRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional] 
-**stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] 
-**url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. | 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional] |
+| **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
+| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. |  |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateSimulcastTargetRequest.new(
+  passthrough: null,
+  stream_key: null,
+  url: null
+)
+```
 

data/docs/CreateTrackRequest.md

@@ -1,14 +1,30 @@
 # MuxRuby::CreateTrackRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** |  | 
-**type** | **String** |  | 
-**text_type** | **String** |  | 
-**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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  |  |
+| **type** | **String** |  |  |
+| **text_type** | **String** |  |  |
+| **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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateTrackRequest.new(
+  url: null,
+  type: null,
+  text_type: null,
+  language_code: null,
+  name: null,
+  closed_captions: null,
+  passthrough: null
+)
+```
 

data/docs/CreateTrackResponse.md

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

data/docs/CreateUploadRequest.md

@@ -1,11 +1,24 @@
 # MuxRuby::CreateUploadRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600]
-**cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] 
-**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | 
-**test** | **BOOLEAN** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional][default to 3600] |
+| **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] |
+| **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  |  |
+| **test** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateUploadRequest.new(
+  timeout: null,
+  cors_origin: null,
+  new_asset_settings: null,
+  test: null
+)
+```
 

data/docs/DeliveryReport.md

@@ -1,14 +1,32 @@
 # MuxRuby::DeliveryReport
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**live_stream_id** | **String** |  | [optional] 
-**asset_id** | **String** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
-**created_at** | **String** |  | [optional] 
-**asset_state** | **String** |  | [optional] 
-**asset_duration** | **Float** |  | [optional] 
-**delivered_seconds** | **Float** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | Unique identifier for the live stream that created the asset. | [optional] |
+| **asset_id** | **String** | Unique identifier for the asset. | [optional] |
+| **passthrough** | **String** | The `passthrough` value for the asset. | [optional] |
+| **created_at** | **String** | Time at which the asset was created. Measured in seconds since the Unix epoch. | [optional] |
+| **deleted_at** | **String** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional] |
+| **asset_state** | **String** | The state of the asset. | [optional] |
+| **asset_duration** | **Float** | The duration of the asset in seconds. | [optional] |
+| **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::DeliveryReport.new(
+  live_stream_id: null,
+  asset_id: null,
+  passthrough: null,
+  created_at: null,
+  deleted_at: null,
+  asset_state: null,
+  asset_duration: null,
+  delivered_seconds: null
+)
+```
 

data/docs/DeliveryUsageApi.md

@@ -2,21 +2,23 @@
 
 All URIs are relative to *https://api.mux.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list_delivery_usage**](DeliveryUsageApi.md#list_delivery_usage) | **GET** /video/v1/delivery-usage | List Usage
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_delivery_usage**](DeliveryUsageApi.md#list_delivery_usage) | **GET** /video/v1/delivery-usage | List Usage |
 
 
-# **list_delivery_usage**
-> ListDeliveryUsageResponse list_delivery_usage(opts)
+## list_delivery_usage
+
+> <ListDeliveryUsageResponse> list_delivery_usage(opts)
 
 List Usage
 
 Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs. 
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -27,29 +29,47 @@ end
 
 api_instance = MuxRuby::DeliveryUsageApi.new
 opts = {
-  page: 1, # Integer | Offset by this many pages, of the size of `limit`
-  limit: 100, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  limit: 56, # Integer | Number of items to include in the response
   asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
-  timeframe: ['timeframe_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. 
+  timeframe: ['inner_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. 
 }
 
 begin
-  #List Usage
+  # List Usage
   result = api_instance.list_delivery_usage(opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling DeliveryUsageApi->list_delivery_usage: #{e}"
+  puts "Error when calling DeliveryUsageApi->list_delivery_usage: #{e}"
+end
+```
+
+#### Using the list_delivery_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDeliveryUsageResponse>, Integer, Hash)> list_delivery_usage_with_http_info(opts)
+
+```ruby
+begin
+  # List Usage
+  data, status_code, headers = api_instance.list_delivery_usage_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDeliveryUsageResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DeliveryUsageApi->list_delivery_usage_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
- **limit** | **Integer**| Number of items to include in the response | [optional] [default to 100]
- **asset_id** | **String**| Filter response to return delivery usage for this asset only. | [optional] 
- **timeframe** | [**Array&lt;String&gt;**](String.md)| Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
+| **limit** | **Integer** | Number of items to include in the response | [optional][default to 100] |
+| **asset_id** | **String** | Filter response to return delivery usage for this asset only. | [optional] |
+| **timeframe** | [**Array&lt;String&gt;**](String.md) | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.  | [optional] |
 
 ### Return type
 
@@ -61,8 +81,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/DimensionValue.md

@@ -1,9 +1,20 @@
 # MuxRuby::DimensionValue
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **String** |  | [optional] 
-**total_count** | **Integer** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  | [optional] |
+| **total_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::DimensionValue.new(
+  value: null,
+  total_count: null
+)
+```