mux_ruby 1.9.0 → 2.1.0

data/docs/IncidentResponse.md

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

data/docs/IncidentsApi.md

@@ -2,23 +2,25 @@
 
 All URIs are relative to *https://api.mux.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_incident**](IncidentsApi.md#get_incident) | **GET** /data/v1/incidents/{INCIDENT_ID} | Get an Incident
-[**list_incidents**](IncidentsApi.md#list_incidents) | **GET** /data/v1/incidents | List Incidents
-[**list_related_incidents**](IncidentsApi.md#list_related_incidents) | **GET** /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_incident**](IncidentsApi.md#get_incident) | **GET** /data/v1/incidents/{INCIDENT_ID} | Get an Incident |
+| [**list_incidents**](IncidentsApi.md#list_incidents) | **GET** /data/v1/incidents | List Incidents |
+| [**list_related_incidents**](IncidentsApi.md#list_related_incidents) | **GET** /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents |
 
 
-# **get_incident**
-> IncidentResponse get_incident(incident_id)
+## get_incident
+
+> <IncidentResponse> get_incident(incident_id)
 
 Get an Incident
 
-Returns the details of an incident 
+Returns the details of an incident.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -31,19 +33,37 @@ api_instance = MuxRuby::IncidentsApi.new
 incident_id = 'abcd1234' # String | ID of the Incident
 
 begin
-  #Get an Incident
+  # Get an Incident
   result = api_instance.get_incident(incident_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling IncidentsApi->get_incident: #{e}"
+  puts "Error when calling IncidentsApi->get_incident: #{e}"
+end
+```
+
+#### Using the get_incident_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IncidentResponse>, Integer, Hash)> get_incident_with_http_info(incident_id)
+
+```ruby
+begin
+  # Get an Incident
+  data, status_code, headers = api_instance.get_incident_with_http_info(incident_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IncidentResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->get_incident_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **incident_id** | **String**| ID of the Incident | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **incident_id** | **String** | ID of the Incident |  |
 
 ### Return type
 
@@ -55,21 +75,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_incidents
 
-# **list_incidents**
-> ListIncidentsResponse list_incidents(opts)
+> <ListIncidentsResponse> list_incidents(opts)
 
 List Incidents
 
-Returns a list of incidents 
+Returns a list of incidents.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -80,33 +101,51 @@ end
 
 api_instance = MuxRuby::IncidentsApi.new
 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`
-  order_by: 'order_by_example', # String | Value to order the results by
-  order_direction: 'order_direction_example', # String | Sort order.
-  status: 'status_example', # String | Status to filter incidents by
-  severity: 'severity_example' # String | Severity to filter incidents by
+  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_by: 'negative_impact', # String | Value to order the results by
+  order_direction: 'asc', # String | Sort order.
+  status: 'open', # String | Status to filter incidents by
+  severity: 'warning' # String | Severity to filter incidents by
 }
 
 begin
-  #List Incidents
+  # List Incidents
   result = api_instance.list_incidents(opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling IncidentsApi->list_incidents: #{e}"
+  puts "Error when calling IncidentsApi->list_incidents: #{e}"
+end
+```
+
+#### Using the list_incidents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListIncidentsResponse>, Integer, Hash)> list_incidents_with_http_info(opts)
+
+```ruby
+begin
+  # List Incidents
+  data, status_code, headers = api_instance.list_incidents_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListIncidentsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_incidents_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_by** | **String**| Value to order the results by | [optional] 
- **order_direction** | **String**| Sort order. | [optional] 
- **status** | **String**| Status to filter incidents by | [optional] 
- **severity** | **String**| Severity to filter incidents by | [optional] 
+| 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_by** | **String** | Value to order the results by | [optional] |
+| **order_direction** | **String** | Sort order. | [optional] |
+| **status** | **String** | Status to filter incidents by | [optional] |
+| **severity** | **String** | Severity to filter incidents by | [optional] |
 
 ### Return type
 
@@ -118,21 +157,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_related_incidents
 
-# **list_related_incidents**
-> ListRelatedIncidentsResponse list_related_incidents(incident_id, opts)
+> <ListRelatedIncidentsResponse> list_related_incidents(incident_id, opts)
 
 List Related Incidents
 
-Returns all the incidents that seem related to a specific incident 
+Returns all the incidents that seem related to a specific incident.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -144,30 +184,48 @@ end
 api_instance = MuxRuby::IncidentsApi.new
 incident_id = 'abcd1234' # String | ID of the Incident
 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`
-  order_by: 'order_by_example', # String | Value to order the results by
-  order_direction: 'order_direction_example' # String | Sort order.
+  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_by: 'negative_impact', # String | Value to order the results by
+  order_direction: 'asc' # String | Sort order.
 }
 
 begin
-  #List Related Incidents
+  # List Related Incidents
   result = api_instance.list_related_incidents(incident_id, opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling IncidentsApi->list_related_incidents: #{e}"
+  puts "Error when calling IncidentsApi->list_related_incidents: #{e}"
+end
+```
+
+#### Using the list_related_incidents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRelatedIncidentsResponse>, Integer, Hash)> list_related_incidents_with_http_info(incident_id, opts)
+
+```ruby
+begin
+  # List Related Incidents
+  data, status_code, headers = api_instance.list_related_incidents_with_http_info(incident_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRelatedIncidentsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_related_incidents_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **incident_id** | **String**| ID of the Incident | 
- **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_by** | **String**| Value to order the results by | [optional] 
- **order_direction** | **String**| Sort order. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **incident_id** | **String** | ID of the Incident |  |
+| **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_by** | **String** | Value to order the results by | [optional] |
+| **order_direction** | **String** | Sort order. | [optional] |
 
 ### Return type
 
@@ -179,8 +237,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

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,17 +1,36 @@
 # MuxRuby::InputSettings
 
 ## Properties
-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. | [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. | [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] 
 
+| 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** | 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] 
 
+| 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
+)
+```