mux_ruby 3.4.0 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1506fef11ec5ebfcc6b5ac3373c2ca2c91b6517d12b0e4c80355328d7c4ac592
-  data.tar.gz: 1905ea66101553811136c0586b96a31e435ad119e97fcb60bfb60f8b7ffa6697
+  metadata.gz: dd38dc911b0fd31d8689bbe417515a3bfc2558471109affd2351fe92acfd75e1
+  data.tar.gz: b758460cb7bb4dab0c867798d665acfa25600d2a97b89a38fc7ee04699b9c47a
 SHA512:
-  metadata.gz: 9604f459a5072ec8c4f8f30f3f0b14ce3a486d058c8382cb4d1414d511fdb24b9db6dd87ff1c5e51f0a0d4e1a1fdbf6772c9d6af9d4a18e99720b3e8da6d5a2a
-  data.tar.gz: f77009abe3119763098c430d9c2899abd4cc116eed392617bbcd56215f2568c93a2f77cdc27aa7059897367f63d0b8e0b2aa74522f2e783f0b164de56e8f1d34
+  metadata.gz: 22c5a221c34578f6ef0c01fb661e69d01f48f10033225f2489015f68cb5d004b94d847015d0f73de7f9b75e72221a28bb8c4919764762e10f463742b9f09ea96
+  data.tar.gz: 8bf7ea579f6ff5eeb608deb4e478e5813db49047b85740180c15c931141372aa88b2e6c593ddcbb28313cd2847e219fb436786a0d678c498be2bbf602fc8c894

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (3.4.0)
+    mux_ruby (3.5.2)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -1,8 +1,14 @@
 ![Mux Ruby Banner](github-ruby-sdk.png)
 
-![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
-
-MuxRuby - the Ruby gem for the Mux API
+<p align="center">
+  <a href="https://rubygems.org/gems/mux_ruby"><img src="https://img.shields.io/gem/v/mux_ruby" title="RubyGems" /></a>
+  <a href="https://github.com/muxinc/mux-ruby/workflows/ci.yaml"><img src="https://github.com/muxinc/mux-ruby/actions/workflows/ci.yaml/badge.svg" title="CI" /></a>
+</p>
+<p align="center">
+  <a href="https://rubygems.org/gems/mux_ruby">RubyGems</a> |
+  <a href="https://docs.mux.com">Mux Docs</a> |
+  <a href="https://docs.mux.com/api-reference">Mux API Reference </a>
+</p>
 
 # Mux Ruby
 
@@ -17,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 3.4.0
+- Package version: 3.5.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.mux.com](https://docs.mux.com)
 
@@ -34,16 +40,16 @@ gem build mux_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mux_ruby-3.4.0.gem
+gem install ./mux_ruby-3.5.2.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-3.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-3.5.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'mux_ruby', '~> 3.4.0'
+    gem 'mux_ruby', '~> 3.5.2'
 
 ### Install from Git
 

data/docs/Asset.md

@@ -16,7 +16,7 @@
 | **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] |
 | **per_title_encode** | **Boolean** |  | [optional] |
 | **upload_id** | **String** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional] |
-| **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] |
+| **is_live** | **Boolean** | Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. | [optional] |
 | **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
 | **live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] |
 | **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] |

data/docs/Broadcast.md

@@ -0,0 +1,30 @@
+# MuxRuby::Broadcast
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the broadcast. Max 255 characters. |  |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
+| **live_stream_id** | **String** | The ID of the live stream that the broadcast will be sent to. |  |
+| **status** | [**BroadcastStatus**](BroadcastStatus.md) |  |  |
+| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [default to 'gallery'] |
+| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
+| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) |  | [default to '1920x1080'] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Broadcast.new(
+  id: null,
+  passthrough: null,
+  live_stream_id: null,
+  status: null,
+  layout: null,
+  background: null,
+  resolution: null
+)
+```
+

data/docs/BroadcastLayout.md

@@ -0,0 +1,15 @@
+# MuxRuby::BroadcastLayout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::BroadcastLayout.new()
+```
+

data/docs/BroadcastResolution.md

@@ -0,0 +1,15 @@
+# MuxRuby::BroadcastResolution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::BroadcastResolution.new()
+```
+

data/docs/BroadcastResponse.md

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

data/docs/BroadcastStatus.md

@@ -0,0 +1,15 @@
+# MuxRuby::BroadcastStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::BroadcastStatus.new()
+```
+

data/docs/CreateBroadcastRequest.md

@@ -0,0 +1,26 @@
+# MuxRuby::CreateBroadcastRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
+| **live_stream_id** | **String** | The ID of the live stream that you want to broadcast to. |  |
+| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [optional][default to 'gallery'] |
+| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
+| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) |  | [optional][default to '1920x1080'] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateBroadcastRequest.new(
+  passthrough: null,
+  live_stream_id: null,
+  layout: null,
+  background: null,
+  resolution: null
+)
+```
+

data/docs/CreateSimulcastTargetRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
 | **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
-| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. |  |
+| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. |  |
 
 ## Example
 

data/docs/CreateSpaceRequest.md

@@ -0,0 +1,22 @@
+# MuxRuby::CreateSpaceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**SpaceType**](SpaceType.md) |  | [optional][default to 'server'] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
+| **broadcasts** | [**Array<CreateBroadcastRequest>**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateSpaceRequest.new(
+  type: null,
+  passthrough: null,
+  broadcasts: null
+)
+```
+

data/docs/ListSpacesResponse.md

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

data/docs/MetricsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
 
 Get metric timeseries data
 
-Returns timeseries data for a specific metric.  Each interval represented in the data array contains an array with the following values:   * the first element is the interval time   * the second element is the calculated metric value    * the third element is the number of views in the interval that have a valid metric value 
+Returns timeseries data for a specific metric.  Each interval represented in the data array contains an array with the following values:   * the first element is the interval time   * the second element is the calculated metric value   * the third element is the number of views in the interval that have a valid metric value 
 
 ### Examples
 
@@ -38,7 +38,7 @@ opts = {
   filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
   order_direction: 'asc', # String | Sort order.
-  group_by: 'ten_minutes' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. 
+  group_by: 'ten_minutes' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. 
 }
 
 begin
@@ -77,7 +77,7 @@ end
 | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
 | **order_direction** | **String** | Sort order. | [optional] |
-| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.  | [optional] |
+| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 hours inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 hours is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.  | [optional] |
 
 ### Return type
 

data/docs/RealTimeApi.md

@@ -35,7 +35,7 @@ api_instance = MuxRuby::RealTimeApi.new
 realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
 opts = {
   dimension: 'asn', # String | Dimension the specified value belongs to
-  timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+  timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
   filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   order_by: 'negative_impact', # String | Value to order the results by
   order_direction: 'asc' # String | Sort order.
@@ -74,7 +74,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **realtime_metric_id** | **String** | ID of the Realtime Metric |  |
 | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
-| **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
+| **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
 | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **order_by** | **String** | Value to order the results by | [optional] |
 | **order_direction** | **String** | Sort order. | [optional] |

data/docs/Space.md

@@ -0,0 +1,30 @@
+# MuxRuby::Space
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the space. Max 255 characters. |  |
+| **created_at** | **String** | Time the space was created, defined as a Unix timestamp (seconds since epoch). |  |
+| **type** | [**SpaceType**](SpaceType.md) |  | [default to 'server'] |
+| **status** | [**SpaceStatus**](SpaceStatus.md) |  |  |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
+| **broadcasts** | [**Array<Broadcast>**](Broadcast.md) | An array of broadcast destinations. | [optional] |
+| **active_session_id** | **String** | Unique identifier for the current lifecycle of the space. Only set when the space is `active` and is set to a new value each time the space transitions from `idle` to `active`. This value is useful for logging and debugging issues. Max 255 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Space.new(
+  id: null,
+  created_at: null,
+  type: null,
+  status: null,
+  passthrough: null,
+  broadcasts: null,
+  active_session_id: null
+)
+```
+

data/docs/SpaceResponse.md

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

data/docs/SpaceStatus.md

@@ -0,0 +1,15 @@
+# MuxRuby::SpaceStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::SpaceStatus.new()
+```
+

data/docs/SpaceType.md

@@ -0,0 +1,15 @@
+# MuxRuby::SpaceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::SpaceType.new()
+```
+