mux_ruby 1.0.0

data/docs/DirectUploadsApi.md

@@ -0,0 +1,214 @@
+# MuxRuby::DirectUploadsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_direct_upload**](DirectUploadsApi.md#cancel_direct_upload) | **PUT** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload
+[**create_direct_upload**](DirectUploadsApi.md#create_direct_upload) | **POST** /video/v1/uploads | Create a new direct upload URL
+[**get_direct_upload**](DirectUploadsApi.md#get_direct_upload) | **GET** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info
+[**list_direct_uploads**](DirectUploadsApi.md#list_direct_uploads) | **GET** /video/v1/uploads | List direct uploads
+
+
+# **cancel_direct_upload**
+> UploadResponse cancel_direct_upload(upload_id)
+
+Cancel a direct upload
+
+Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the `waiting` state. 
+
+### 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::DirectUploadsApi.new
+upload_id = 'abcd1234' # String | ID of the Upload
+
+begin
+  #Cancel a direct upload
+  result = api_instance.cancel_direct_upload(upload_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DirectUploadsApi->cancel_direct_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_id** | **String**| ID of the Upload | 
+
+### Return type
+
+[**UploadResponse**](UploadResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **create_direct_upload**
+> UploadResponse create_direct_upload(create_upload_request)
+
+Create a new direct upload URL
+
+### 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::DirectUploadsApi.new
+create_upload_request = MuxRuby::CreateUploadRequest.new # CreateUploadRequest | 
+
+begin
+  #Create a new direct upload URL
+  result = api_instance.create_direct_upload(create_upload_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DirectUploadsApi->create_direct_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_upload_request** | [**CreateUploadRequest**](CreateUploadRequest.md)|  | 
+
+### Return type
+
+[**UploadResponse**](UploadResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_direct_upload**
+> UploadResponse get_direct_upload(upload_id)
+
+Retrieve a single direct upload's info
+
+### 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::DirectUploadsApi.new
+upload_id = 'abcd1234' # String | ID of the Upload
+
+begin
+  #Retrieve a single direct upload's info
+  result = api_instance.get_direct_upload(upload_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DirectUploadsApi->get_direct_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_id** | **String**| ID of the Upload | 
+
+### Return type
+
+[**UploadResponse**](UploadResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_direct_uploads**
+> ListUploadsResponse list_direct_uploads(opts)
+
+List direct uploads
+
+### 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::DirectUploadsApi.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`
+}
+
+begin
+  #List direct uploads
+  result = api_instance.list_direct_uploads(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DirectUploadsApi->list_direct_uploads: #{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 `limit` | [optional] [default to 1]
+
+### Return type
+
+[**ListUploadsResponse**](ListUploadsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

@@ -0,0 +1,15 @@
+# MuxRuby::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**percentage** | **Float** |  | [optional] 
+**notes** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**last_seen** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**count** | **Integer** |  | [optional] 
+**code** | **Integer** |  | [optional] 
+
+

data/docs/ErrorsApi.md

@@ -0,0 +1,64 @@
+# MuxRuby::ErrorsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_errors**](ErrorsApi.md#list_errors) | **GET** /data/v1/errors | List Errors
+
+
+# **list_errors**
+> ListErrorsResponse list_errors(opts)
+
+List Errors
+
+Returns a list of errors 
+
+### 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::ErrorsApi.new
+opts = {
+  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
+  #List Errors
+  result = api_instance.list_errors(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling ErrorsApi->list_errors: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**ListErrorsResponse**](ListErrorsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ExportsApi.md

@@ -0,0 +1,56 @@
+# MuxRuby::ExportsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links
+
+
+# **list_exports**
+> ListExportsResponse list_exports
+
+List property video view export links
+
+Lists the available video view exports along with URLs to retrieve them 
+
+### 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::ExportsApi.new
+
+begin
+  #List property video view export links
+  result = api_instance.list_exports
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling ExportsApi->list_exports: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListExportsResponse**](ListExportsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/FilterValue.md

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

data/docs/FiltersApi.md

@@ -0,0 +1,118 @@
+# MuxRuby::FiltersApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_filter_values**](FiltersApi.md#list_filter_values) | **GET** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter
+[**list_filters**](FiltersApi.md#list_filters) | **GET** /data/v1/filters | List Filters
+
+
+# **list_filter_values**
+> ListFilterValuesResponse list_filter_values(filter_id, opts)
+
+Lists values for a specific filter
+
+Lists the values for a filter along with a total count of related views 
+
+### 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::FiltersApi.new
+filter_id = 'abcd1234' # String | ID of the Filter
+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 values for a specific filter
+  result = api_instance.list_filter_values(filter_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling FiltersApi->list_filter_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filter_id** | **String**| ID of the Filter | 
+ **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
+
+[**ListFilterValuesResponse**](ListFilterValuesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_filters**
+> ListFiltersResponse list_filters
+
+List Filters
+
+Lists all the filters broken out into basic and advanced 
+
+### 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::FiltersApi.new
+
+begin
+  #List Filters
+  result = api_instance.list_filters
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling FiltersApi->list_filters: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListFiltersResponse**](ListFiltersResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/GetAssetInputInfoResponse.md

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

data/docs/GetAssetPlaybackIDResponse.md

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

data/docs/GetMetricTimeseriesDataResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetMetricTimeseriesDataResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<Array<String>>** |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<String>** |  | [optional] 
+
+

data/docs/GetOverallValuesResponse.md

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

data/docs/InputFile.md

@@ -0,0 +1,9 @@
+# MuxRuby::InputFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**container_format** | **String** |  | [optional] 
+**tracks** | [**Array<InputTrack>**](InputTrack.md) |  | [optional] 
+
+

data/docs/InputInfo.md

@@ -0,0 +1,9 @@
+# MuxRuby::InputInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settings** | [**InputSettings**](InputSettings.md) |  | [optional] 
+**file** | [**InputFile**](InputFile.md) |  | [optional] 
+
+

data/docs/InputSettings.md

@@ -0,0 +1,10 @@
+# MuxRuby::InputSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | [optional] 
+**language** | **String** |  | [optional] 
+**overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] 
+
+

data/docs/InputSettingsOverlaySettings.md

@@ -0,0 +1,14 @@
+# 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] 
+
+

data/docs/InputTrack.md

@@ -0,0 +1,18 @@
+# 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] 
+**text_track_type** | **String** |  | [optional] 
+**language** | **String** |  | [optional] 
+
+

data/docs/Insight.md

@@ -0,0 +1,13 @@
+# MuxRuby::Insight
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_watch_time** | **Integer** |  | [optional] 
+**total_views** | **Integer** |  | [optional] 
+**negative_impact_score** | **Integer** |  | [optional] 
+**metric** | **Integer** |  | [optional] 
+**filter_value** | **String** |  | [optional] 
+**filter_column** | **String** |  | [optional] 
+
+

data/docs/ListAllMetricValuesResponse.md

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

data/docs/ListAssetsResponse.md

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

data/docs/ListBreakdownValuesResponse.md

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

data/docs/ListErrorsResponse.md

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

data/docs/ListExportsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListExportsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<String>** |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<String>** |  | [optional] 
+
+

data/docs/ListFilterValuesResponse.md

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

data/docs/ListFiltersResponse.md

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