mux_ruby 1.5.1 → 2.0.0.pre.rc.1

data/docs/InputFile.md

@@ -1,9 +1,20 @@
 # MuxRuby::InputFile
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**container_format** | **String** |  | [optional] 
-**tracks** | [**Array<InputTrack>**](InputTrack.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_format** | **String** |  | [optional] |
+| **tracks** | [**Array<InputTrack>**](InputTrack.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::InputFile.new(
+  container_format: null,
+  tracks: null
+)
+```
 

data/docs/InputInfo.md

@@ -1,9 +1,20 @@
 # MuxRuby::InputInfo
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**settings** | [**InputSettings**](InputSettings.md) |  | [optional] 
-**file** | [**InputFile**](InputFile.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **settings** | [**InputSettings**](InputSettings.md) |  | [optional] |
+| **file** | [**InputFile**](InputFile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::InputInfo.new(
+  settings: null,
+  file: null
+)
+```
 

data/docs/InputSettings.md

@@ -1,15 +1,36 @@
 # MuxRuby::InputSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** |  | [optional] 
-**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] 
-**type** | **String** |  | [optional] 
-**text_type** | **String** |  | [optional] 
-**language_code** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**closed_captions** | **BOOLEAN** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The web address of the file that Mux should download and use. * For subtitles text tracks, the url is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the url is the location of the watermark image. * When creating clips from existing Mux assets, the url is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from.  | [optional] |
+| **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] |
+| **start_time** | **Float** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
+| **end_time** | **Float** | The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
+| **type** | **String** | This parameter is required for the `text` track type. | [optional] |
+| **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` track type. | [optional] |
+| **language_code** | **String** | The language code value must be a valid [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, en for English or en-US for the US version of English. This parameter is required for text type and subtitles text type track. | [optional] |
+| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type track. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
+| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
+| **passthrough** | **String** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::InputSettings.new(
+  url: null,
+  overlay_settings: null,
+  start_time: null,
+  end_time: null,
+  type: null,
+  text_type: null,
+  language_code: null,
+  name: null,
+  closed_captions: null,
+  passthrough: null
+)
+```
 

data/docs/InputSettingsOverlaySettings.md

@@ -1,14 +1,30 @@
 # MuxRuby::InputSettingsOverlaySettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**vertical_align** | **String** |  | [optional] 
-**vertical_margin** | **String** |  | [optional] 
-**horizontal_align** | **String** |  | [optional] 
-**horizontal_margin** | **String** |  | [optional] 
-**width** | **String** |  | [optional] 
-**height** | **String** |  | [optional] 
-**opacity** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vertical_align** | **String** | Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"` | [optional] |
+| **vertical_margin** | **String** | The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top. | [optional] |
+| **horizontal_align** | **String** | Where the horizontal positioning of the overlay/watermark should begin from. | [optional] |
+| **horizontal_margin** | **String** | The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left. | [optional] |
+| **width** | **String** | How wide the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height. | [optional] |
+| **height** | **String** | How tall the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width. | [optional] |
+| **opacity** | **String** | How opaque the overlay should appear, expressed as a percent. (Default 100%) | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::InputSettingsOverlaySettings.new(
+  vertical_align: null,
+  vertical_margin: null,
+  horizontal_align: null,
+  horizontal_margin: null,
+  width: null,
+  height: null,
+  opacity: null
+)
+```
 

data/docs/InputTrack.md

@@ -1,16 +1,34 @@
 # MuxRuby::InputTrack
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** |  | [optional] 
-**duration** | **Float** |  | [optional] 
-**encoding** | **String** |  | [optional] 
-**width** | **Integer** |  | [optional] 
-**height** | **Integer** |  | [optional] 
-**frame_rate** | **Float** |  | [optional] 
-**sample_rate** | **Integer** |  | [optional] 
-**sample_size** | **Integer** |  | [optional] 
-**channels** | **Integer** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **duration** | **Float** |  | [optional] |
+| **encoding** | **String** |  | [optional] |
+| **width** | **Integer** |  | [optional] |
+| **height** | **Integer** |  | [optional] |
+| **frame_rate** | **Float** |  | [optional] |
+| **sample_rate** | **Integer** |  | [optional] |
+| **sample_size** | **Integer** |  | [optional] |
+| **channels** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::InputTrack.new(
+  type: null,
+  duration: null,
+  encoding: null,
+  width: null,
+  height: null,
+  frame_rate: null,
+  sample_rate: null,
+  sample_size: null,
+  channels: null
+)
+```
 

data/docs/Insight.md

@@ -1,13 +1,28 @@
 # MuxRuby::Insight
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total_watch_time** | **Integer** |  | [optional] 
-**total_views** | **Integer** |  | [optional] 
-**negative_impact_score** | **Float** |  | [optional] 
-**metric** | **Float** |  | [optional] 
-**filter_value** | **String** |  | [optional] 
-**filter_column** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_watch_time** | **Integer** |  | [optional] |
+| **total_views** | **Integer** |  | [optional] |
+| **negative_impact_score** | **Float** |  | [optional] |
+| **metric** | **Float** |  | [optional] |
+| **filter_value** | **String** |  | [optional] |
+| **filter_column** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Insight.new(
+  total_watch_time: null,
+  total_views: null,
+  negative_impact_score: null,
+  metric: null,
+  filter_value: null,
+  filter_column: null
+)
+```
 

data/docs/ListAllMetricValuesResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::ListAllMetricValuesResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<Score>**](Score.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Score>**](Score.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListAllMetricValuesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/ListAssetsResponse.md

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

data/docs/ListBreakdownValuesResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::ListBreakdownValuesResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<BreakdownValue>**](BreakdownValue.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<BreakdownValue>**](BreakdownValue.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListBreakdownValuesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/ListDeliveryUsageResponse.md

@@ -1,11 +1,24 @@
 # MuxRuby::ListDeliveryUsageResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<DeliveryReport>**](DeliveryReport.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
-**limit** | **Integer** | Number of assets returned in this response. Default value is 100. | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<DeliveryReport>**](DeliveryReport.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+| **limit** | **Integer** | Number of assets returned in this response. Default value is 100. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListDeliveryUsageResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null,
+  limit: null
+)
+```
 

data/docs/ListDimensionValuesResponse.md

@@ -0,0 +1,22 @@
+# MuxRuby::ListDimensionValuesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<DimensionValue>**](DimensionValue.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListDimensionValuesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
+

data/docs/ListDimensionsResponse.md

@@ -0,0 +1,22 @@
+# MuxRuby::ListDimensionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListDimensionsResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
+

data/docs/ListErrorsResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::ListErrorsResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<Error>**](Error.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Error>**](Error.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListErrorsResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/ListExportsResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::ListExportsResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **Array<String>** |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Array<String>** |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListExportsResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/ListFilterValuesResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::ListFilterValuesResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<FilterValue>**](FilterValue.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<FilterValue>**](FilterValue.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListFilterValuesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```