mux_ruby 1.0.0

data/docs/ListFiltersResponseData.md

@@ -0,0 +1,9 @@
+# MuxRuby::ListFiltersResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**basic** | **Array<String>** |  | [optional] 
+**advanced** | **Array<String>** |  | [optional] 
+
+

data/docs/ListInsightsResponse.md

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

data/docs/ListLiveStreamsResponse.md

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

data/docs/ListSigningKeysResponse.md

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

data/docs/ListUploadsResponse.md

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

data/docs/ListVideoViewsResponse.md

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

data/docs/LiveStream.md

@@ -0,0 +1,17 @@
+# MuxRuby::LiveStream
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**stream_key** | **String** |  | [optional] 
+**active_asset_id** | **String** |  | [optional] 
+**recent_asset_ids** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+**playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
+**new_asset_settings** | [**Asset**](Asset.md) |  | [optional] 
+**passthrough** | **String** |  | [optional] 
+**reconnect_window** | **Float** |  | [optional] 
+
+

data/docs/LiveStreamResponse.md

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

data/docs/LiveStreamsApi.md

@@ -0,0 +1,420 @@
+# MuxRuby::LiveStreamsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_live_stream**](LiveStreamsApi.md#create_live_stream) | **POST** /video/v1/live-streams | Create a live stream
+[**create_live_stream_playback_id**](LiveStreamsApi.md#create_live_stream_playback_id) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID
+[**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
+[**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
+[**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
+[**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
+[**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key
+[**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
+
+
+# **create_live_stream**
+> LiveStreamResponse create_live_stream(create_live_stream_request)
+
+Create a live stream
+
+### 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::LiveStreamsApi.new
+create_live_stream_request = MuxRuby::CreateLiveStreamRequest.new # CreateLiveStreamRequest | 
+
+begin
+  #Create a live stream
+  result = api_instance.create_live_stream(create_live_stream_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->create_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md)|  | 
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_live_stream_playback_id**
+> CreatePlaybackIDResponse create_live_stream_playback_id(live_stream_id, create_playback_id_request)
+
+Create a live stream playback ID
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest | 
+
+begin
+  #Create a live stream playback ID
+  result = api_instance.create_live_stream_playback_id(live_stream_id, create_playback_id_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->create_live_stream_playback_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+ **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md)|  | 
+
+### Return type
+
+[**CreatePlaybackIDResponse**](CreatePlaybackIDResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_live_stream**
+> delete_live_stream(live_stream_id)
+
+Delete a live stream
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Delete a live stream
+  api_instance.delete_live_stream(live_stream_id)
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->delete_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **delete_live_stream_playback_id**
+> delete_live_stream_playback_id(live_stream_id, playback_id)
+
+Delete a live stream playback ID
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+playback_id = 'playback_id_example' # String | The live stream's playback ID.
+
+begin
+  #Delete a live stream playback ID
+  api_instance.delete_live_stream_playback_id(live_stream_id, playback_id)
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->delete_live_stream_playback_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+ **playback_id** | **String**| The live stream's playback ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **get_live_stream**
+> LiveStreamResponse get_live_stream(live_stream_id)
+
+Retrieve a live stream
+
+Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Retrieve a live stream
+  result = api_instance.get_live_stream(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->get_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_live_streams**
+> ListLiveStreamsResponse list_live_streams(opts)
+
+List live streams
+
+### 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::LiveStreamsApi.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 live streams
+  result = api_instance.list_live_streams(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->list_live_streams: #{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
+
+[**ListLiveStreamsResponse**](ListLiveStreamsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **reset_stream_key**
+> LiveStreamResponse reset_stream_key(live_stream_id)
+
+Reset a live stream’s stream key
+
+Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Reset a live stream’s stream key
+  result = api_instance.reset_stream_key(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->reset_stream_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **signal_live_stream_complete**
+> SignalLiveStreamCompleteResponse signal_live_stream_complete(live_stream_id)
+
+Signal a live stream is finished
+
+(Optional) Make the recorded asset available immediately instead of waiting for the reconnect_window.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Signal a live stream is finished
+  result = api_instance.signal_live_stream_complete(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->signal_live_stream_complete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**SignalLiveStreamCompleteResponse**](SignalLiveStreamCompleteResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Metric.md

@@ -0,0 +1,12 @@
+# MuxRuby::Metric
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | [optional] 
+**type** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**metric** | **String** |  | [optional] 
+**measurement** | **String** |  | [optional] 
+
+