mux_ruby 1.6.0 → 2.0.0.pre.rc.2

data/docs/DimensionsApi.md

@@ -0,0 +1,156 @@
+# MuxRuby::DimensionsApi
+
+All URIs are relative to *https://api.mux.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension |
+| [**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions |
+
+
+## list_dimension_values
+
+> <ListDimensionValuesResponse> list_dimension_values(dimension_id, opts)
+
+Lists the values for a specific dimension
+
+Lists the values for a dimension along with a total count of related views.  Note: This API replaces the list-filter-values API call. 
+
+### 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::DimensionsApi.new
+dimension_id = 'abcd1234' # String | ID of the Dimension
+opts = {
+  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 the values for a specific dimension
+  result = api_instance.list_dimension_values(dimension_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DimensionsApi->list_dimension_values: #{e}"
+end
+```
+
+#### Using the list_dimension_values_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDimensionValuesResponse>, Integer, Hash)> list_dimension_values_with_http_info(dimension_id, opts)
+
+```ruby
+begin
+  # Lists the values for a specific dimension
+  data, status_code, headers = api_instance.list_dimension_values_with_http_info(dimension_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDimensionValuesResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DimensionsApi->list_dimension_values_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dimension_id** | **String** | ID of the Dimension |  |
+| **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
+
+[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_dimensions
+
+> <ListDimensionsResponse> list_dimensions
+
+List Dimensions
+
+List all available dimensions.  Note: This API replaces the list-filters API call. 
+
+### 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::DimensionsApi.new
+
+begin
+  # List Dimensions
+  result = api_instance.list_dimensions
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DimensionsApi->list_dimensions: #{e}"
+end
+```
+
+#### Using the list_dimensions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDimensionsResponse>, Integer, Hash)> list_dimensions_with_http_info
+
+```ruby
+begin
+  # List Dimensions
+  data, status_code, headers = api_instance.list_dimensions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDimensionsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DimensionsApi->list_dimensions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDimensionsResponse**](ListDimensionsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DirectUploadsApi.md

@@ -2,24 +2,26 @@
 
 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
+| 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_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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -32,19 +34,37 @@ api_instance = MuxRuby::DirectUploadsApi.new
 upload_id = 'abcd1234' # String | ID of the Upload
 
 begin
-  #Cancel a direct upload
+  # 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}"
+  puts "Error when calling DirectUploadsApi->cancel_direct_upload: #{e}"
+end
+```
+
+#### Using the cancel_direct_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadResponse>, Integer, Hash)> cancel_direct_upload_with_http_info(upload_id)
+
+```ruby
+begin
+  # Cancel a direct upload
+  data, status_code, headers = api_instance.cancel_direct_upload_with_http_info(upload_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DirectUploadsApi->cancel_direct_upload_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upload_id** | **String**| ID of the Upload | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upload_id** | **String** | ID of the Upload |  |
 
 ### Return type
 
@@ -56,19 +76,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## create_direct_upload
 
-# **create_direct_upload**
-> UploadResponse create_direct_upload(create_upload_request)
+> <UploadResponse> create_direct_upload(create_upload_request)
 
 Create a new direct upload URL
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -78,22 +99,40 @@ MuxRuby.configure do |config|
 end
 
 api_instance = MuxRuby::DirectUploadsApi.new
-create_upload_request = MuxRuby::CreateUploadRequest.new # CreateUploadRequest | 
+create_upload_request = MuxRuby::CreateUploadRequest.new({new_asset_settings: MuxRuby::CreateAssetRequest.new}) # CreateUploadRequest | 
 
 begin
-  #Create a new direct upload URL
+  # 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}"
+  puts "Error when calling DirectUploadsApi->create_direct_upload: #{e}"
+end
+```
+
+#### Using the create_direct_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadResponse>, Integer, Hash)> create_direct_upload_with_http_info(create_upload_request)
+
+```ruby
+begin
+  # Create a new direct upload URL
+  data, status_code, headers = api_instance.create_direct_upload_with_http_info(create_upload_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DirectUploadsApi->create_direct_upload_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **create_upload_request** | [**CreateUploadRequest**](CreateUploadRequest.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_upload_request** | [**CreateUploadRequest**](CreateUploadRequest.md) |  |  |
 
 ### Return type
 
@@ -105,19 +144,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## get_direct_upload
 
-# **get_direct_upload**
-> UploadResponse get_direct_upload(upload_id)
+> <UploadResponse> get_direct_upload(upload_id)
 
 Retrieve a single direct upload's info
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -130,19 +170,37 @@ api_instance = MuxRuby::DirectUploadsApi.new
 upload_id = 'abcd1234' # String | ID of the Upload
 
 begin
-  #Retrieve a single direct upload's info
+  # 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}"
+  puts "Error when calling DirectUploadsApi->get_direct_upload: #{e}"
+end
+```
+
+#### Using the get_direct_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadResponse>, Integer, Hash)> get_direct_upload_with_http_info(upload_id)
+
+```ruby
+begin
+  # Retrieve a single direct upload's info
+  data, status_code, headers = api_instance.get_direct_upload_with_http_info(upload_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DirectUploadsApi->get_direct_upload_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upload_id** | **String**| ID of the Upload | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upload_id** | **String** | ID of the Upload |  |
 
 ### Return type
 
@@ -154,19 +212,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_direct_uploads
 
-# **list_direct_uploads**
-> ListUploadsResponse list_direct_uploads(opts)
+> <ListUploadsResponse> list_direct_uploads(opts)
 
 List direct uploads
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -177,25 +236,43 @@ 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`
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56 # Integer | Offset by this many pages, of the size of `limit`
 }
 
 begin
-  #List direct uploads
+  # 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}"
+  puts "Error when calling DirectUploadsApi->list_direct_uploads: #{e}"
+end
+```
+
+#### Using the list_direct_uploads_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListUploadsResponse>, Integer, Hash)> list_direct_uploads_with_http_info(opts)
+
+```ruby
+begin
+  # List direct uploads
+  data, status_code, headers = api_instance.list_direct_uploads_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListUploadsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling DirectUploadsApi->list_direct_uploads_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]
+| 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] |
 
 ### Return type
 
@@ -207,8 +284,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json