mux_ruby 1.8.1 → 2.0.0

data/docs/DisableLiveStreamResponse.md

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

data/docs/EnableLiveStreamResponse.md

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

data/docs/Error.md

@@ -1,15 +1,32 @@
 # 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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | A unique identifier for this error. | [optional] |
+| **percentage** | **Float** | The percentage of views that experienced this error. | [optional] |
+| **notes** | **String** | Notes that are attached to this error. | [optional] |
+| **message** | **String** | The error message. | [optional] |
+| **last_seen** | **String** | The last time this error was seen (ISO 8601 timestamp). | [optional] |
+| **description** | **String** | Description of the error. | [optional] |
+| **count** | **Integer** | The total number of views that experiend this error. | [optional] |
+| **code** | **Integer** | The error code | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Error.new(
+  id: null,
+  percentage: null,
+  notes: null,
+  message: null,
+  last_seen: null,
+  description: null,
+  count: null,
+  code: null
+)
+```
 

data/docs/ErrorsApi.md

@@ -2,21 +2,23 @@
 
 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
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_errors**](ErrorsApi.md#list_errors) | **GET** /data/v1/errors | List Errors |
 
 
-# **list_errors**
-> ListErrorsResponse list_errors(opts)
+## list_errors
+
+> <ListErrorsResponse> list_errors(opts)
 
 List Errors
 
-Returns a list of errors 
+Returns a list of errors.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -27,25 +29,43 @@ 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. 
+  filters: ['inner_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: ['inner_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
+  # List Errors
   result = api_instance.list_errors(opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling ErrorsApi->list_errors: #{e}"
+  puts "Error when calling ErrorsApi->list_errors: #{e}"
+end
+```
+
+#### Using the list_errors_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListErrorsResponse>, Integer, Hash)> list_errors_with_http_info(opts)
+
+```ruby
+begin
+  # List Errors
+  data, status_code, headers = api_instance.list_errors_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListErrorsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling ErrorsApi->list_errors_with_http_info: #{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] 
+| 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
 
@@ -57,8 +77,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/ExportDate.md

@@ -0,0 +1,20 @@
+# MuxRuby::ExportDate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **export_date** | **Date** |  | [optional] |
+| **files** | [**Array<ExportFile>**](ExportFile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ExportDate.new(
+  export_date: null,
+  files: null
+)
+```
+

data/docs/ExportFile.md

@@ -0,0 +1,22 @@
+# MuxRuby::ExportFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **Integer** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **path** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ExportFile.new(
+  version: null,
+  type: null,
+  path: null
+)
+```
+

data/docs/ExportsApi.md

@@ -2,21 +2,24 @@
 
 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
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links |
+| [**list_exports_views**](ExportsApi.md#list_exports_views) | **GET** /data/v1/exports/views | List available property view exports |
 
 
-# **list_exports**
-> ListExportsResponse list_exports
+## list_exports
+
+> <ListExportsResponse> list_exports
 
 List property video view export links
 
-Lists the available video view exports along with URLs to retrieve them 
+Deprecated: The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them. 
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -28,15 +31,34 @@ end
 api_instance = MuxRuby::ExportsApi.new
 
 begin
-  #List property video view export links
+  # 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}"
+  puts "Error when calling ExportsApi->list_exports: #{e}"
+end
+```
+
+#### Using the list_exports_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListExportsResponse>, Integer, Hash)> list_exports_with_http_info
+
+```ruby
+begin
+  # List property video view export links
+  data, status_code, headers = api_instance.list_exports_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListExportsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling ExportsApi->list_exports_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -49,8 +71,73 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_exports_views
+
+> <ListVideoViewExportsResponse> list_exports_views
+
+List available property view exports
+
+Lists the available video view exports along with URLs to retrieve them.
+
+### Examples
+
+```ruby
+require 'time'
+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 available property view exports
+  result = api_instance.list_exports_views
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling ExportsApi->list_exports_views: #{e}"
+end
+```
+
+#### Using the list_exports_views_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListVideoViewExportsResponse>, Integer, Hash)> list_exports_views_with_http_info
+
+```ruby
+begin
+  # List available property view exports
+  data, status_code, headers = api_instance.list_exports_views_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListVideoViewExportsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling ExportsApi->list_exports_views_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListVideoViewExportsResponse**](ListVideoViewExportsResponse.md)
+
+### Authorization
 
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
 
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/FilterValue.md

@@ -1,9 +1,20 @@
 # MuxRuby::FilterValue
 
 ## 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::FilterValue.new(
+  value: null,
+  total_count: null
+)
+```
 

data/docs/FiltersApi.md

@@ -2,22 +2,24 @@
 
 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
+| 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)
+## list_filter_values
+
+> <ListFilterValuesResponse> list_filter_values(filter_id, opts)
 
 Lists values for a specific filter
 
 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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -29,30 +31,48 @@ 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. 
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  filters: ['inner_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: ['inner_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
+  # 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}"
+  puts "Error when calling FiltersApi->list_filter_values: #{e}"
+end
+```
+
+#### Using the list_filter_values_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListFilterValuesResponse>, Integer, Hash)> list_filter_values_with_http_info(filter_id, opts)
+
+```ruby
+begin
+  # Lists values for a specific filter
+  data, status_code, headers = api_instance.list_filter_values_with_http_info(filter_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListFilterValuesResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling FiltersApi->list_filter_values_with_http_info: #{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] 
+| 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
 
@@ -64,21 +84,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_filters
 
-# **list_filters**
-> ListFiltersResponse list_filters
+> <ListFiltersResponse> list_filters
 
 List Filters
 
 Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -90,15 +111,34 @@ end
 api_instance = MuxRuby::FiltersApi.new
 
 begin
-  #List Filters
+  # List Filters
   result = api_instance.list_filters
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling FiltersApi->list_filters: #{e}"
+  puts "Error when calling FiltersApi->list_filters: #{e}"
+end
+```
+
+#### Using the list_filters_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListFiltersResponse>, Integer, Hash)> list_filters_with_http_info
+
+```ruby
+begin
+  # List Filters
+  data, status_code, headers = api_instance.list_filters_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListFiltersResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling FiltersApi->list_filters_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -111,8 +151,6 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json