mux_ruby 1.9.0 → 2.0.0.pre.rc.1

data/docs/ListRealTimeDimensionsResponseData.md

@@ -1,9 +1,20 @@
 # MuxRuby::ListRealTimeDimensionsResponseData
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-**display_name** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListRealTimeDimensionsResponseData.new(
+  name: null,
+  display_name: null
+)
+```
 

data/docs/ListRealTimeMetricsResponse.md

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

data/docs/ListRelatedIncidentsResponse.md

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

data/docs/ListSigningKeysResponse.md

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

data/docs/ListUploadsResponse.md

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

data/docs/ListVideoViewsResponse.md

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

data/docs/LiveStream.md

@@ -1,20 +1,42 @@
 # 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** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] 
-**passthrough** | **String** |  | [optional] 
-**reconnect_window** | **Float** |  | [optional] 
-**reduced_latency** | **BOOLEAN** |  | [optional] 
-**simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) |  | [optional] 
-**test** | **BOOLEAN** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the Live Stream. Max 255 characters. | [optional] |
+| **created_at** | **String** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
+| **stream_key** | **String** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] |
+| **active_asset_id** | **String** | The Asset that is currently being created if there is an active broadcast. | [optional] |
+| **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Assets that were created from this live stream. | [optional] |
+| **status** | **String** | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published. | [optional] |
+| **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
+| **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] |
+| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
+| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
+| **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
+| **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
+| **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::LiveStream.new(
+  id: null,
+  created_at: null,
+  stream_key: null,
+  active_asset_id: null,
+  recent_asset_ids: null,
+  status: null,
+  playback_ids: null,
+  new_asset_settings: null,
+  passthrough: null,
+  reconnect_window: null,
+  reduced_latency: null,
+  simulcast_targets: null,
+  test: null
+)
+```
 

data/docs/LiveStreamResponse.md

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

data/docs/LiveStreamsApi.md

@@ -2,31 +2,33 @@
 
 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
-[**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
-[**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
-[**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
-[**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
-[**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
-[**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
-[**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
-[**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)
+| 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 |
+| [**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target |
+| [**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 |
+| [**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target |
+| [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
+| [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
+| [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
+| [**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target |
+| [**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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -39,19 +41,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
 create_live_stream_request = MuxRuby::CreateLiveStreamRequest.new # CreateLiveStreamRequest | 
 
 begin
-  #Create a live stream
+  # 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}"
+  puts "Error when calling LiveStreamsApi->create_live_stream: #{e}"
+end
+```
+
+#### Using the create_live_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> create_live_stream_with_http_info(create_live_stream_request)
+
+```ruby
+begin
+  # Create a live stream
+  data, status_code, headers = api_instance.create_live_stream_with_http_info(create_live_stream_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->create_live_stream_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_live_stream_request** | [**CreateLiveStreamRequest**](CreateLiveStreamRequest.md) |  |  |
 
 ### Return type
 
@@ -63,19 +83,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## create_live_stream_playback_id
 
-# **create_live_stream_playback_id**
-> CreatePlaybackIDResponse create_live_stream_playback_id(live_stream_id, create_playback_id_request)
+> <CreatePlaybackIDResponse> create_live_stream_playback_id(live_stream_id, create_playback_id_request)
 
 Create a live stream playback ID
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -89,20 +110,38 @@ 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
+  # 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}"
+  puts "Error when calling LiveStreamsApi->create_live_stream_playback_id: #{e}"
+end
+```
+
+#### Using the create_live_stream_playback_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatePlaybackIDResponse>, Integer, Hash)> create_live_stream_playback_id_with_http_info(live_stream_id, create_playback_id_request)
+
+```ruby
+begin
+  # Create a live stream playback ID
+  data, status_code, headers = api_instance.create_live_stream_playback_id_with_http_info(live_stream_id, create_playback_id_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatePlaybackIDResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->create_live_stream_playback_id_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
- **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md) |  |  |
 
 ### Return type
 
@@ -114,21 +153,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## create_live_stream_simulcast_target
 
-# **create_live_stream_simulcast_target**
-> SimulcastTargetResponse create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
+> <SimulcastTargetResponse> create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
 
 Create a live stream simulcast target
 
 Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -139,23 +179,41 @@ end
 
 api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
-create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest | 
+create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new({url: 'url_example'}) # CreateSimulcastTargetRequest | 
 
 begin
-  #Create a live stream simulcast target
+  # Create a live stream simulcast target
   result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
+  puts "Error when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
+end
+```
+
+#### Using the create_live_stream_simulcast_target_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimulcastTargetResponse>, Integer, Hash)> create_live_stream_simulcast_target_with_http_info(live_stream_id, create_simulcast_target_request)
+
+```ruby
+begin
+  # Create a live stream simulcast target
+  data, status_code, headers = api_instance.create_live_stream_simulcast_target_with_http_info(live_stream_id, create_simulcast_target_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimulcastTargetResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->create_live_stream_simulcast_target_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
- **create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md) |  |  |
 
 ### Return type
 
@@ -167,19 +225,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## delete_live_stream
 
-# **delete_live_stream**
 > delete_live_stream(live_stream_id)
 
 Delete a live stream
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -192,18 +251,36 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  #Delete a live stream
+  # 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}"
+  puts "Error when calling LiveStreamsApi->delete_live_stream: #{e}"
+end
+```
+
+#### Using the delete_live_stream_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_live_stream_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Delete a live stream
+  data, status_code, headers = api_instance.delete_live_stream_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->delete_live_stream_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -215,19 +292,20 @@ nil (empty response body)
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+- **Content-Type**: Not defined
+- **Accept**: Not defined
 
 
+## delete_live_stream_playback_id
 
-# **delete_live_stream_playback_id**
 > delete_live_stream_playback_id(live_stream_id, playback_id)
 
 Delete a live stream playback ID
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -241,19 +319,37 @@ 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
+  # 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}"
+  puts "Error when calling LiveStreamsApi->delete_live_stream_playback_id: #{e}"
+end
+```
+
+#### Using the delete_live_stream_playback_id_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
+
+```ruby
+begin
+  # Delete a live stream playback ID
+  data, status_code, headers = api_instance.delete_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->delete_live_stream_playback_id_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
- **playback_id** | **String**| The live stream&#39;s playback ID. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **playback_id** | **String** | The live stream&#39;s playback ID. |  |
 
 ### Return type
 
@@ -265,21 +361,22 @@ nil (empty response body)
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+- **Content-Type**: Not defined
+- **Accept**: Not defined
 
 
+## delete_live_stream_simulcast_target
 
-# **delete_live_stream_simulcast_target**
 > delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
 
 Delete a Live Stream Simulcast Target
 
 Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -293,19 +390,37 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
 simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
 
 begin
-  #Delete a Live Stream Simulcast Target
+  # Delete a Live Stream Simulcast Target
   api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
+  puts "Error when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
+end
+```
+
+#### Using the delete_live_stream_simulcast_target_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
+
+```ruby
+begin
+  # Delete a Live Stream Simulcast Target
+  data, status_code, headers = api_instance.delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->delete_live_stream_simulcast_target_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
- **simulcast_target_id** | **String**| The ID of the simulcast target. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **simulcast_target_id** | **String** | The ID of the simulcast target. |  |
 
 ### Return type
 
@@ -317,21 +432,22 @@ nil (empty response body)
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+- **Content-Type**: Not defined
+- **Accept**: Not defined
 
 
+## disable_live_stream
 
-# **disable_live_stream**
-> DisableLiveStreamResponse disable_live_stream(live_stream_id)
+> <DisableLiveStreamResponse> disable_live_stream(live_stream_id)
 
 Disable a live stream
 
-Disables a live stream, making it reject incoming RTMP streams until re-enabled.
+Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over.  Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled. 
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -344,19 +460,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  #Disable a live stream
+  # Disable a live stream
   result = api_instance.disable_live_stream(live_stream_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling LiveStreamsApi->disable_live_stream: #{e}"
+  puts "Error when calling LiveStreamsApi->disable_live_stream: #{e}"
+end
+```
+
+#### Using the disable_live_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DisableLiveStreamResponse>, Integer, Hash)> disable_live_stream_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Disable a live stream
+  data, status_code, headers = api_instance.disable_live_stream_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DisableLiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->disable_live_stream_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -368,21 +502,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## enable_live_stream
 
-# **enable_live_stream**
-> EnableLiveStreamResponse enable_live_stream(live_stream_id)
+> <EnableLiveStreamResponse> enable_live_stream(live_stream_id)
 
 Enable a live stream
 
 Enables a live stream, allowing it to accept an incoming RTMP stream.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -395,19 +530,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  #Enable a live stream
+  # Enable a live stream
   result = api_instance.enable_live_stream(live_stream_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling LiveStreamsApi->enable_live_stream: #{e}"
+  puts "Error when calling LiveStreamsApi->enable_live_stream: #{e}"
+end
+```
+
+#### Using the enable_live_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EnableLiveStreamResponse>, Integer, Hash)> enable_live_stream_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Enable a live stream
+  data, status_code, headers = api_instance.enable_live_stream_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EnableLiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->enable_live_stream_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -419,21 +572,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_live_stream
 
-# **get_live_stream**
-> LiveStreamResponse get_live_stream(live_stream_id)
+> <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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -446,19 +600,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  #Retrieve a live stream
+  # 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}"
+  puts "Error when calling LiveStreamsApi->get_live_stream: #{e}"
+end
+```
+
+#### Using the get_live_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> get_live_stream_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Retrieve a live stream
+  data, status_code, headers = api_instance.get_live_stream_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->get_live_stream_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -470,21 +642,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_live_stream_simulcast_target
 
-# **get_live_stream_simulcast_target**
-> SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
+> <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
 
 Retrieve a Live Stream Simulcast Target
 
 Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -498,20 +671,38 @@ live_stream_id = 'live_stream_id_example' # String | The live stream ID
 simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
 
 begin
-  #Retrieve a Live Stream Simulcast Target
+  # Retrieve a Live Stream Simulcast Target
   result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
+  puts "Error when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
+end
+```
+
+#### Using the get_live_stream_simulcast_target_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimulcastTargetResponse>, Integer, Hash)> get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
+
+```ruby
+begin
+  # Retrieve a Live Stream Simulcast Target
+  data, status_code, headers = api_instance.get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimulcastTargetResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->get_live_stream_simulcast_target_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
- **simulcast_target_id** | **String**| The ID of the simulcast target. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **simulcast_target_id** | **String** | The ID of the simulcast target. |  |
 
 ### Return type
 
@@ -523,19 +714,20 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_live_streams
 
-# **list_live_streams**
-> ListLiveStreamsResponse list_live_streams(opts)
+> <ListLiveStreamsResponse> list_live_streams(opts)
 
 List live streams
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -546,25 +738,45 @@ 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`
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  stream_key: 'stream_key_example' # String | Filter response to return live stream for this stream key only
 }
 
 begin
-  #List live streams
+  # 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}"
+  puts "Error when calling LiveStreamsApi->list_live_streams: #{e}"
+end
+```
+
+#### Using the list_live_streams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListLiveStreamsResponse>, Integer, Hash)> list_live_streams_with_http_info(opts)
+
+```ruby
+begin
+  # List live streams
+  data, status_code, headers = api_instance.list_live_streams_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListLiveStreamsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->list_live_streams_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] |
+| **stream_key** | **String** | Filter response to return live stream for this stream key only | [optional] |
 
 ### Return type
 
@@ -576,21 +788,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## reset_stream_key
 
-# **reset_stream_key**
-> LiveStreamResponse reset_stream_key(live_stream_id)
+> <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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -603,19 +816,37 @@ 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
+  # 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}"
+  puts "Error when calling LiveStreamsApi->reset_stream_key: #{e}"
+end
+```
+
+#### Using the reset_stream_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> reset_stream_key_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Reset a live stream’s stream key
+  data, status_code, headers = api_instance.reset_stream_key_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->reset_stream_key_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -627,21 +858,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## signal_live_stream_complete
 
-# **signal_live_stream_complete**
-> SignalLiveStreamCompleteResponse signal_live_stream_complete(live_stream_id)
+> <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.
+(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over.  Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end. 
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -654,19 +886,37 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  #Signal a live stream is finished
+  # 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}"
+  puts "Error when calling LiveStreamsApi->signal_live_stream_complete: #{e}"
+end
+```
+
+#### Using the signal_live_stream_complete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignalLiveStreamCompleteResponse>, Integer, Hash)> signal_live_stream_complete_with_http_info(live_stream_id)
+
+```ruby
+begin
+  # Signal a live stream is finished
+  data, status_code, headers = api_instance.signal_live_stream_complete_with_http_info(live_stream_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignalLiveStreamCompleteResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->signal_live_stream_complete_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **live_stream_id** | **String**| The live stream ID | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
 
 ### Return type
 
@@ -678,8 +928,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json