mux_ruby 3.4.0 → 3.5.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +13 -7
- data/docs/Asset.md +1 -1
- data/docs/Broadcast.md +30 -0
- data/docs/BroadcastLayout.md +15 -0
- data/docs/BroadcastResolution.md +15 -0
- data/docs/BroadcastResponse.md +18 -0
- data/docs/BroadcastStatus.md +15 -0
- data/docs/CreateBroadcastRequest.md +26 -0
- data/docs/CreateSimulcastTargetRequest.md +1 -1
- data/docs/CreateSpaceRequest.md +22 -0
- data/docs/ListSpacesResponse.md +18 -0
- data/docs/MetricsApi.md +3 -3
- data/docs/RealTimeApi.md +2 -2
- data/docs/Space.md +30 -0
- data/docs/SpaceResponse.md +18 -0
- data/docs/SpaceStatus.md +15 -0
- data/docs/SpaceType.md +15 -0
- data/docs/SpacesApi.md +658 -0
- data/docs/StartSpaceBroadcastResponse.md +18 -0
- data/docs/StopSpaceBroadcastResponse.md +18 -0
- data/gen/generator-config.json +1 -1
- data/gen/templates/README.mustache +9 -3
- data/lib/mux_ruby/api/metrics_api.rb +4 -4
- data/lib/mux_ruby/api/real_time_api.rb +2 -2
- data/lib/mux_ruby/api/spaces_api.rb +619 -0
- data/lib/mux_ruby/models/asset.rb +1 -1
- data/lib/mux_ruby/models/broadcast.rb +305 -0
- data/lib/mux_ruby/models/broadcast_layout.rb +37 -0
- data/lib/mux_ruby/models/broadcast_resolution.rb +41 -0
- data/lib/mux_ruby/models/broadcast_response.rb +223 -0
- data/lib/mux_ruby/models/broadcast_status.rb +37 -0
- data/lib/mux_ruby/models/create_broadcast_request.rb +266 -0
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
- data/lib/mux_ruby/models/create_space_request.rb +242 -0
- data/lib/mux_ruby/models/list_spaces_response.rb +225 -0
- data/lib/mux_ruby/models/space.rb +301 -0
- data/lib/mux_ruby/models/space_response.rb +223 -0
- data/lib/mux_ruby/models/space_status.rb +37 -0
- data/lib/mux_ruby/models/space_type.rb +36 -0
- data/lib/mux_ruby/models/start_space_broadcast_response.rb +218 -0
- data/lib/mux_ruby/models/stop_space_broadcast_response.rb +218 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +15 -0
- data/spec/api/spaces_api_spec.rb +149 -0
- data/spec/models/broadcast_layout_spec.rb +28 -0
- data/spec/models/broadcast_resolution_spec.rb +28 -0
- data/spec/models/broadcast_response_spec.rb +34 -0
- data/spec/models/broadcast_spec.rb +70 -0
- data/spec/models/broadcast_status_spec.rb +28 -0
- data/spec/models/create_broadcast_request_spec.rb +58 -0
- data/spec/models/create_space_request_spec.rb +46 -0
- data/spec/models/list_spaces_response_spec.rb +34 -0
- data/spec/models/space_response_spec.rb +34 -0
- data/spec/models/space_spec.rb +70 -0
- data/spec/models/space_status_spec.rb +28 -0
- data/spec/models/space_type_spec.rb +28 -0
- data/spec/models/start_space_broadcast_response_spec.rb +34 -0
- data/spec/models/stop_space_broadcast_response_spec.rb +34 -0
- metadata +163 -103
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dd38dc911b0fd31d8689bbe417515a3bfc2558471109affd2351fe92acfd75e1
|
4
|
+
data.tar.gz: b758460cb7bb4dab0c867798d665acfa25600d2a97b89a38fc7ee04699b9c47a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22c5a221c34578f6ef0c01fb661e69d01f48f10033225f2489015f68cb5d004b94d847015d0f73de7f9b75e72221a28bb8c4919764762e10f463742b9f09ea96
|
7
|
+
data.tar.gz: 8bf7ea579f6ff5eeb608deb4e478e5813db49047b85740180c15c931141372aa88b2e6c593ddcbb28313cd2847e219fb436786a0d678c498be2bbf602fc8c894
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,8 +1,14 @@
|
|
1
1
|
![Mux Ruby Banner](github-ruby-sdk.png)
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
3
|
+
<p align="center">
|
4
|
+
<a href="https://rubygems.org/gems/mux_ruby"><img src="https://img.shields.io/gem/v/mux_ruby" title="RubyGems" /></a>
|
5
|
+
<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>
|
6
|
+
</p>
|
7
|
+
<p align="center">
|
8
|
+
<a href="https://rubygems.org/gems/mux_ruby">RubyGems</a> |
|
9
|
+
<a href="https://docs.mux.com">Mux Docs</a> |
|
10
|
+
<a href="https://docs.mux.com/api-reference">Mux API Reference </a>
|
11
|
+
</p>
|
6
12
|
|
7
13
|
# Mux Ruby
|
8
14
|
|
@@ -17,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
|
|
17
23
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
24
|
|
19
25
|
- API version: v1
|
20
|
-
- Package version: 3.
|
26
|
+
- Package version: 3.5.2
|
21
27
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
28
|
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
|
23
29
|
|
@@ -34,16 +40,16 @@ gem build mux_ruby.gemspec
|
|
34
40
|
Then either install the gem locally:
|
35
41
|
|
36
42
|
```shell
|
37
|
-
gem install ./mux_ruby-3.
|
43
|
+
gem install ./mux_ruby-3.5.2.gem
|
38
44
|
```
|
39
45
|
|
40
|
-
(for development, run `gem install --dev ./mux_ruby-3.
|
46
|
+
(for development, run `gem install --dev ./mux_ruby-3.5.2.gem` to install the development dependencies)
|
41
47
|
|
42
48
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
43
49
|
|
44
50
|
Finally add this to the Gemfile:
|
45
51
|
|
46
|
-
gem 'mux_ruby', '~> 3.
|
52
|
+
gem 'mux_ruby', '~> 3.5.2'
|
47
53
|
|
48
54
|
### Install from Git
|
49
55
|
|
data/docs/Asset.md
CHANGED
@@ -16,7 +16,7 @@
|
|
16
16
|
| **errors** | [**AssetErrors**](AssetErrors.md) | | [optional] |
|
17
17
|
| **per_title_encode** | **Boolean** | | [optional] |
|
18
18
|
| **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] |
|
19
|
-
| **is_live** | **Boolean** |
|
19
|
+
| **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] |
|
20
20
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
|
21
21
|
| **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] |
|
22
22
|
| **master** | [**AssetMaster**](AssetMaster.md) | | [optional] |
|
data/docs/Broadcast.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# MuxRuby::Broadcast
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the broadcast. Max 255 characters. | |
|
8
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
|
9
|
+
| **live_stream_id** | **String** | The ID of the live stream that the broadcast will be sent to. | |
|
10
|
+
| **status** | [**BroadcastStatus**](BroadcastStatus.md) | | |
|
11
|
+
| **layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [default to 'gallery'] |
|
12
|
+
| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
|
13
|
+
| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [default to '1920x1080'] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'mux_ruby'
|
19
|
+
|
20
|
+
instance = MuxRuby::Broadcast.new(
|
21
|
+
id: null,
|
22
|
+
passthrough: null,
|
23
|
+
live_stream_id: null,
|
24
|
+
status: null,
|
25
|
+
layout: null,
|
26
|
+
background: null,
|
27
|
+
resolution: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::BroadcastResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Broadcast**](Broadcast.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::BroadcastResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MuxRuby::CreateBroadcastRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
|
8
|
+
| **live_stream_id** | **String** | The ID of the live stream that you want to broadcast to. | |
|
9
|
+
| **layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [optional][default to 'gallery'] |
|
10
|
+
| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
|
11
|
+
| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [optional][default to '1920x1080'] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'mux_ruby'
|
17
|
+
|
18
|
+
instance = MuxRuby::CreateBroadcastRequest.new(
|
19
|
+
passthrough: null,
|
20
|
+
live_stream_id: null,
|
21
|
+
layout: null,
|
22
|
+
background: null,
|
23
|
+
resolution: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
|
8
8
|
| **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
|
9
|
-
| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: &#
|
9
|
+
| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::CreateSpaceRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**SpaceType**](SpaceType.md) | | [optional][default to 'server'] |
|
8
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
|
9
|
+
| **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] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::CreateSpaceRequest.new(
|
17
|
+
type: null,
|
18
|
+
passthrough: null,
|
19
|
+
broadcasts: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::ListSpacesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Space>**](Space.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::ListSpacesResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/MetricsApi.md
CHANGED
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
|
|
17
17
|
|
18
18
|
Get metric timeseries data
|
19
19
|
|
20
|
-
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
|
20
|
+
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
|
21
21
|
|
22
22
|
### Examples
|
23
23
|
|
@@ -38,7 +38,7 @@ opts = {
|
|
38
38
|
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`
|
39
39
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
40
40
|
order_direction: 'asc', # String | Sort order.
|
41
|
-
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
|
41
|
+
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.
|
42
42
|
}
|
43
43
|
|
44
44
|
begin
|
@@ -77,7 +77,7 @@ end
|
|
77
77
|
| **filters** | [**Array<String>**](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 `!` 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` | [optional] |
|
78
78
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
79
79
|
| **order_direction** | **String** | Sort order. | [optional] |
|
80
|
-
| **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 `ten_minutes`. Between 6 hours and 15
|
80
|
+
| **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 `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. | [optional] |
|
81
81
|
|
82
82
|
### Return type
|
83
83
|
|
data/docs/RealTimeApi.md
CHANGED
@@ -35,7 +35,7 @@ api_instance = MuxRuby::RealTimeApi.new
|
|
35
35
|
realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
|
36
36
|
opts = {
|
37
37
|
dimension: 'asn', # String | Dimension the specified value belongs to
|
38
|
-
timestamp:
|
38
|
+
timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
39
39
|
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`
|
40
40
|
order_by: 'negative_impact', # String | Value to order the results by
|
41
41
|
order_direction: 'asc' # String | Sort order.
|
@@ -74,7 +74,7 @@ end
|
|
74
74
|
| ---- | ---- | ----------- | ----- |
|
75
75
|
| **realtime_metric_id** | **String** | ID of the Realtime Metric | |
|
76
76
|
| **dimension** | **String** | Dimension the specified value belongs to | [optional] |
|
77
|
-
| **timestamp** | **
|
77
|
+
| **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
|
78
78
|
| **filters** | [**Array<String>**](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 `!` 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` | [optional] |
|
79
79
|
| **order_by** | **String** | Value to order the results by | [optional] |
|
80
80
|
| **order_direction** | **String** | Sort order. | [optional] |
|
data/docs/Space.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# MuxRuby::Space
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the space. Max 255 characters. | |
|
8
|
+
| **created_at** | **String** | Time the space was created, defined as a Unix timestamp (seconds since epoch). | |
|
9
|
+
| **type** | [**SpaceType**](SpaceType.md) | | [default to 'server'] |
|
10
|
+
| **status** | [**SpaceStatus**](SpaceStatus.md) | | |
|
11
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
|
12
|
+
| **broadcasts** | [**Array<Broadcast>**](Broadcast.md) | An array of broadcast destinations. | [optional] |
|
13
|
+
| **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] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'mux_ruby'
|
19
|
+
|
20
|
+
instance = MuxRuby::Space.new(
|
21
|
+
id: null,
|
22
|
+
created_at: null,
|
23
|
+
type: null,
|
24
|
+
status: null,
|
25
|
+
passthrough: null,
|
26
|
+
broadcasts: null,
|
27
|
+
active_session_id: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::SpaceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Space**](Space.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::SpaceResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/SpaceStatus.md
ADDED
data/docs/SpaceType.md
ADDED