mux_ruby 2.0.0.pre.rc.2 → 2.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +4 -4
- data/docs/AssetsApi.md +2 -0
- data/docs/CreateLiveStreamRequest.md +2 -0
- data/docs/ExportDate.md +20 -0
- data/docs/ExportFile.md +22 -0
- data/docs/ExportsApi.md +69 -1
- data/docs/GetLiveStreamPlaybackIDResponse.md +18 -0
- data/docs/ListVideoViewExportsResponse.md +22 -0
- data/docs/LiveStream.md +2 -0
- data/docs/LiveStreamsApi.md +71 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/RealTimeApi.md +2 -2
- data/docs/RealTimeBreakdownValue.md +2 -2
- data/docs/RealTimeTimeseriesDatapoint.md +2 -2
- data/gen/generator-config.json +2 -1
- data/gen/templates/gemspec.mustache +1 -0
- data/lib/mux_ruby/api/assets_api.rb +2 -0
- data/lib/mux_ruby/api/exports_api.rb +59 -2
- data/lib/mux_ruby/api/live_streams_api.rb +67 -0
- data/lib/mux_ruby/api/metrics_api.rb +16 -16
- data/lib/mux_ruby/api/real_time_api.rb +4 -4
- data/lib/mux_ruby/models/create_live_stream_request.rb +11 -1
- data/lib/mux_ruby/models/export_date.rb +229 -0
- data/lib/mux_ruby/models/export_file.rb +236 -0
- data/lib/mux_ruby/models/get_live_stream_playback_id_response.rb +218 -0
- data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
- data/lib/mux_ruby/models/live_stream.rb +11 -1
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +7 -7
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +7 -7
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +4 -0
- data/mux_ruby.gemspec +1 -0
- data/spec/models/export_date_spec.rb +40 -0
- data/spec/models/export_file_spec.rb +46 -0
- data/spec/models/get_live_stream_playback_id_response_spec.rb +34 -0
- data/spec/models/list_video_view_exports_response_spec.rb +46 -0
- metadata +107 -90
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3929ab7260fa4902b6d6945ab9db42e563acbefda1474d9fd84314385829abec
|
4
|
+
data.tar.gz: 80f4ce3b25a48b587dc7a4b00370cb0605cce64585247f4f956ccc682c774926
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 006b7d0ca2d770c553e57deab63cd81b40d335fa3fd9d90c68f8cfd692880661be006c5bc2c76022c6d71975bf6a19749c16334073c8651df482547e5732ef5c
|
7
|
+
data.tar.gz: bcfbd4514af2a43ad0f5cde18e29a4b0a4b48e4d3ff62072386806b5080ad86857b039a7e3dc3ea755e830a7013fa1885567cadce67ad5f3f0c94973edf426eb
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
mux_ruby (2.
|
4
|
+
mux_ruby (2.2.0)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -13,7 +13,7 @@ GEM
|
|
13
13
|
diff-lcs (1.3)
|
14
14
|
ethon (0.14.0)
|
15
15
|
ffi (>= 1.15.0)
|
16
|
-
ffi (1.15.
|
16
|
+
ffi (1.15.4)
|
17
17
|
jaro_winkler (1.5.4)
|
18
18
|
method_source (1.0.0)
|
19
19
|
parallel (1.20.1)
|
@@ -67,4 +67,4 @@ DEPENDENCIES
|
|
67
67
|
solid_assert
|
68
68
|
|
69
69
|
BUNDLED WITH
|
70
|
-
2.2.
|
70
|
+
2.2.27
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
|
|
17
17
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
18
18
|
|
19
19
|
- API version: v1
|
20
|
-
- Package version: 2.
|
20
|
+
- Package version: 2.2.0
|
21
21
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
22
22
|
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
|
23
23
|
|
@@ -34,16 +34,16 @@ gem build mux_ruby.gemspec
|
|
34
34
|
Then either install the gem locally:
|
35
35
|
|
36
36
|
```shell
|
37
|
-
gem install ./mux_ruby-2.
|
37
|
+
gem install ./mux_ruby-2.2.0.gem
|
38
38
|
```
|
39
39
|
|
40
|
-
(for development, run `gem install --dev ./mux_ruby-2.
|
40
|
+
(for development, run `gem install --dev ./mux_ruby-2.2.0.gem` to install the development dependencies)
|
41
41
|
|
42
42
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
43
43
|
|
44
44
|
Finally add this to the Gemfile:
|
45
45
|
|
46
|
-
gem 'mux_ruby', '~> 2.
|
46
|
+
gem 'mux_ruby', '~> 2.2.0'
|
47
47
|
|
48
48
|
### Install from Git
|
49
49
|
|
data/docs/AssetsApi.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **passthrough** | **String** | | [optional] |
|
11
11
|
| **audio_only** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] |
|
12
12
|
| **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. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
|
13
|
+
| **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
|
13
14
|
| **test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams 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] |
|
14
15
|
| **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
|
15
16
|
|
@@ -25,6 +26,7 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
|
|
25
26
|
passthrough: null,
|
26
27
|
audio_only: null,
|
27
28
|
reduced_latency: null,
|
29
|
+
low_latency: null,
|
28
30
|
test: null,
|
29
31
|
simulcast_targets: null
|
30
32
|
)
|
data/docs/ExportDate.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# MuxRuby::ExportDate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **export_date** | **Date** | | [optional] |
|
8
|
+
| **files** | [**Array<ExportFile>**](ExportFile.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::ExportDate.new(
|
16
|
+
export_date: null,
|
17
|
+
files: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ExportFile.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ExportFile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **version** | **Integer** | | [optional] |
|
8
|
+
| **type** | **String** | | [optional] |
|
9
|
+
| **path** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ExportFile.new(
|
17
|
+
version: null,
|
18
|
+
type: null,
|
19
|
+
path: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/ExportsApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.mux.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links |
|
8
|
+
| [**list_exports_views**](ExportsApi.md#list_exports_views) | **GET** /data/v1/exports/views | List available property view exports |
|
8
9
|
|
9
10
|
|
10
11
|
## list_exports
|
@@ -13,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
|
|
13
14
|
|
14
15
|
List property video view export links
|
15
16
|
|
16
|
-
Lists the available video view exports along with URLs to retrieve them.
|
17
|
+
Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
|
17
18
|
|
18
19
|
### Examples
|
19
20
|
|
@@ -73,3 +74,70 @@ This endpoint does not need any parameter.
|
|
73
74
|
- **Content-Type**: Not defined
|
74
75
|
- **Accept**: application/json
|
75
76
|
|
77
|
+
|
78
|
+
## list_exports_views
|
79
|
+
|
80
|
+
> <ListVideoViewExportsResponse> list_exports_views
|
81
|
+
|
82
|
+
List available property view exports
|
83
|
+
|
84
|
+
Lists the available video view exports along with URLs to retrieve them.
|
85
|
+
|
86
|
+
### Examples
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
require 'time'
|
90
|
+
require 'mux_ruby'
|
91
|
+
# setup authorization
|
92
|
+
MuxRuby.configure do |config|
|
93
|
+
# Configure HTTP basic authorization: accessToken
|
94
|
+
config.username = 'YOUR USERNAME'
|
95
|
+
config.password = 'YOUR PASSWORD'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = MuxRuby::ExportsApi.new
|
99
|
+
|
100
|
+
begin
|
101
|
+
# List available property view exports
|
102
|
+
result = api_instance.list_exports_views
|
103
|
+
p result
|
104
|
+
rescue MuxRuby::ApiError => e
|
105
|
+
puts "Error when calling ExportsApi->list_exports_views: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
#### Using the list_exports_views_with_http_info variant
|
110
|
+
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
112
|
+
|
113
|
+
> <Array(<ListVideoViewExportsResponse>, Integer, Hash)> list_exports_views_with_http_info
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
begin
|
117
|
+
# List available property view exports
|
118
|
+
data, status_code, headers = api_instance.list_exports_views_with_http_info
|
119
|
+
p status_code # => 2xx
|
120
|
+
p headers # => { ... }
|
121
|
+
p data # => <ListVideoViewExportsResponse>
|
122
|
+
rescue MuxRuby::ApiError => e
|
123
|
+
puts "Error when calling ExportsApi->list_exports_views_with_http_info: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
This endpoint does not need any parameter.
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
[**ListVideoViewExportsResponse**](ListVideoViewExportsResponse.md)
|
134
|
+
|
135
|
+
### Authorization
|
136
|
+
|
137
|
+
[accessToken](../README.md#accessToken)
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: Not defined
|
142
|
+
- **Accept**: application/json
|
143
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::GetLiveStreamPlaybackIDResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**PlaybackID**](.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::GetLiveStreamPlaybackIDResponse.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::ListVideoViewExportsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<ExportDate>**](ExportDate.md) | | [optional] |
|
8
|
+
| **total_row_count** | **Integer** | | [optional] |
|
9
|
+
| **timeframe** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::ListVideoViewExportsResponse.new(
|
17
|
+
data: null,
|
18
|
+
total_row_count: null,
|
19
|
+
timeframe: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/LiveStream.md
CHANGED
@@ -16,6 +16,7 @@
|
|
16
16
|
| **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
|
17
17
|
| **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] |
|
18
18
|
| **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] |
|
19
|
+
| **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
|
19
20
|
| **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] |
|
20
21
|
| **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] |
|
21
22
|
|
@@ -37,6 +38,7 @@ instance = MuxRuby::LiveStream.new(
|
|
37
38
|
audio_only: null,
|
38
39
|
reconnect_window: null,
|
39
40
|
reduced_latency: null,
|
41
|
+
low_latency: null,
|
40
42
|
simulcast_targets: null,
|
41
43
|
test: null
|
42
44
|
)
|
data/docs/LiveStreamsApi.md
CHANGED
@@ -13,6 +13,7 @@ All URIs are relative to *https://api.mux.com*
|
|
13
13
|
| [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
|
14
14
|
| [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
|
15
15
|
| [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
|
16
|
+
| [**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID |
|
16
17
|
| [**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 |
|
17
18
|
| [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
|
18
19
|
| [**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 |
|
@@ -646,6 +647,76 @@ end
|
|
646
647
|
- **Accept**: application/json
|
647
648
|
|
648
649
|
|
650
|
+
## get_live_stream_playback_id
|
651
|
+
|
652
|
+
> <GetLiveStreamPlaybackIDResponse> get_live_stream_playback_id(live_stream_id, playback_id)
|
653
|
+
|
654
|
+
Retrieve a live stream playback ID
|
655
|
+
|
656
|
+
### Examples
|
657
|
+
|
658
|
+
```ruby
|
659
|
+
require 'time'
|
660
|
+
require 'mux_ruby'
|
661
|
+
# setup authorization
|
662
|
+
MuxRuby.configure do |config|
|
663
|
+
# Configure HTTP basic authorization: accessToken
|
664
|
+
config.username = 'YOUR USERNAME'
|
665
|
+
config.password = 'YOUR PASSWORD'
|
666
|
+
end
|
667
|
+
|
668
|
+
api_instance = MuxRuby::LiveStreamsApi.new
|
669
|
+
live_stream_id = 'live_stream_id_example' # String | The live stream ID
|
670
|
+
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
671
|
+
|
672
|
+
begin
|
673
|
+
# Retrieve a live stream playback ID
|
674
|
+
result = api_instance.get_live_stream_playback_id(live_stream_id, playback_id)
|
675
|
+
p result
|
676
|
+
rescue MuxRuby::ApiError => e
|
677
|
+
puts "Error when calling LiveStreamsApi->get_live_stream_playback_id: #{e}"
|
678
|
+
end
|
679
|
+
```
|
680
|
+
|
681
|
+
#### Using the get_live_stream_playback_id_with_http_info variant
|
682
|
+
|
683
|
+
This returns an Array which contains the response data, status code and headers.
|
684
|
+
|
685
|
+
> <Array(<GetLiveStreamPlaybackIDResponse>, Integer, Hash)> get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
|
686
|
+
|
687
|
+
```ruby
|
688
|
+
begin
|
689
|
+
# Retrieve a live stream playback ID
|
690
|
+
data, status_code, headers = api_instance.get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
|
691
|
+
p status_code # => 2xx
|
692
|
+
p headers # => { ... }
|
693
|
+
p data # => <GetLiveStreamPlaybackIDResponse>
|
694
|
+
rescue MuxRuby::ApiError => e
|
695
|
+
puts "Error when calling LiveStreamsApi->get_live_stream_playback_id_with_http_info: #{e}"
|
696
|
+
end
|
697
|
+
```
|
698
|
+
|
699
|
+
### Parameters
|
700
|
+
|
701
|
+
| Name | Type | Description | Notes |
|
702
|
+
| ---- | ---- | ----------- | ----- |
|
703
|
+
| **live_stream_id** | **String** | The live stream ID | |
|
704
|
+
| **playback_id** | **String** | The live stream's playback ID. | |
|
705
|
+
|
706
|
+
### Return type
|
707
|
+
|
708
|
+
[**GetLiveStreamPlaybackIDResponse**](GetLiveStreamPlaybackIDResponse.md)
|
709
|
+
|
710
|
+
### Authorization
|
711
|
+
|
712
|
+
[accessToken](../README.md#accessToken)
|
713
|
+
|
714
|
+
### HTTP request headers
|
715
|
+
|
716
|
+
- **Content-Type**: Not defined
|
717
|
+
- **Accept**: application/json
|
718
|
+
|
719
|
+
|
649
720
|
## get_live_stream_simulcast_target
|
650
721
|
|
651
722
|
> <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
|
data/docs/MetricsApi.md
CHANGED
@@ -36,7 +36,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
36
36
|
opts = {
|
37
37
|
timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
|
38
38
|
filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
39
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the
|
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
41
|
group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
|
42
42
|
}
|
@@ -75,7 +75,7 @@ end
|
|
75
75
|
| **metric_id** | **String** | ID of the Metric | |
|
76
76
|
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. | [optional] |
|
77
77
|
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
78
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the
|
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
80
|
| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional] |
|
81
81
|
|
@@ -118,7 +118,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
118
118
|
opts = {
|
119
119
|
timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
|
120
120
|
filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
121
|
-
measurement: '95th' # String | Measurement for the provided metric. If omitted, the
|
121
|
+
measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
122
122
|
}
|
123
123
|
|
124
124
|
begin
|
@@ -155,7 +155,7 @@ end
|
|
155
155
|
| **metric_id** | **String** | ID of the Metric | |
|
156
156
|
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. | [optional] |
|
157
157
|
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
158
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the
|
158
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
159
159
|
|
160
160
|
### Return type
|
161
161
|
|
@@ -273,7 +273,7 @@ api_instance = MuxRuby::MetricsApi.new
|
|
273
273
|
metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
274
274
|
opts = {
|
275
275
|
group_by: 'asn', # String | Breakdown value to group the results by
|
276
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the
|
276
|
+
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
277
277
|
filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
278
278
|
limit: 56, # Integer | Number of items to include in the response
|
279
279
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
@@ -315,7 +315,7 @@ end
|
|
315
315
|
| ---- | ---- | ----------- | ----- |
|
316
316
|
| **metric_id** | **String** | ID of the Metric | |
|
317
317
|
| **group_by** | **String** | Breakdown value to group the results by | [optional] |
|
318
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the
|
318
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
319
319
|
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
320
320
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
321
321
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
@@ -360,7 +360,7 @@ end
|
|
360
360
|
api_instance = MuxRuby::MetricsApi.new
|
361
361
|
metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
362
362
|
opts = {
|
363
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the
|
363
|
+
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
364
364
|
order_direction: 'asc', # String | Sort order.
|
365
365
|
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
|
366
366
|
}
|
@@ -397,7 +397,7 @@ end
|
|
397
397
|
| Name | Type | Description | Notes |
|
398
398
|
| ---- | ---- | ----------- | ----- |
|
399
399
|
| **metric_id** | **String** | ID of the Metric | |
|
400
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the
|
400
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
401
401
|
| **order_direction** | **String** | Sort order. | [optional] |
|
402
402
|
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. | [optional] |
|
403
403
|
|
data/docs/RealTimeApi.md
CHANGED
@@ -247,7 +247,7 @@ end
|
|
247
247
|
|
248
248
|
List Real-Time Dimensions
|
249
249
|
|
250
|
-
Lists
|
250
|
+
Lists available real-time dimensions.
|
251
251
|
|
252
252
|
### Examples
|
253
253
|
|
@@ -314,7 +314,7 @@ This endpoint does not need any parameter.
|
|
314
314
|
|
315
315
|
List Real-Time Metrics
|
316
316
|
|
317
|
-
Lists
|
317
|
+
Lists available real-time metrics.
|
318
318
|
|
319
319
|
### Examples
|
320
320
|
|
@@ -8,7 +8,7 @@
|
|
8
8
|
| **negative_impact** | **Integer** | | [optional] |
|
9
9
|
| **metric_value** | **Float** | | [optional] |
|
10
10
|
| **display_value** | **String** | | [optional] |
|
11
|
-
| **
|
11
|
+
| **concurrent_viewers** | **Integer** | | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
@@ -20,7 +20,7 @@ instance = MuxRuby::RealTimeBreakdownValue.new(
|
|
20
20
|
negative_impact: null,
|
21
21
|
metric_value: null,
|
22
22
|
display_value: null,
|
23
|
-
|
23
|
+
concurrent_viewers: null
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **Float** | | [optional] |
|
8
8
|
| **date** | **String** | | [optional] |
|
9
|
-
| **
|
9
|
+
| **concurrent_viewers** | **Integer** | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -16,7 +16,7 @@ require 'mux_ruby'
|
|
16
16
|
instance = MuxRuby::RealTimeTimeseriesDatapoint.new(
|
17
17
|
value: null,
|
18
18
|
date: null,
|
19
|
-
|
19
|
+
concurrent_viewers: null
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
data/gen/generator-config.json
CHANGED
@@ -5,7 +5,8 @@
|
|
5
5
|
"gemAuthorEmail": "devex@mux.com",
|
6
6
|
"gemDescription": "The Ruby client for Mux Data and Mux Video.",
|
7
7
|
"gemHomepage": "https://docs.mux.com",
|
8
|
+
"gemSourceLocation": "https://github.com/muxinc/mux-ruby",
|
8
9
|
"gemLicense": "MIT",
|
9
10
|
"moduleName": "MuxRuby",
|
10
|
-
"gemVersion": "2.
|
11
|
+
"gemVersion": "2.2.0"
|
11
12
|
}
|
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
|
|
16
16
|
s.homepage = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}"
|
17
17
|
s.summary = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
|
18
18
|
s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
|
19
|
+
s.metadata = { "source_code_uri" => "{{gemSourceLocation}}" }
|
19
20
|
s.license = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
|
20
21
|
s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.4{{/gemRequiredRubyVersion}}"
|
21
22
|
|
@@ -349,6 +349,7 @@ module MuxRuby
|
|
349
349
|
end
|
350
350
|
|
351
351
|
# Delete an asset track
|
352
|
+
# Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
|
352
353
|
# @param asset_id [String] The asset ID.
|
353
354
|
# @param track_id [String] The track ID.
|
354
355
|
# @param [Hash] opts the optional parameters
|
@@ -359,6 +360,7 @@ module MuxRuby
|
|
359
360
|
end
|
360
361
|
|
361
362
|
# Delete an asset track
|
363
|
+
# Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
|
362
364
|
# @param asset_id [String] The asset ID.
|
363
365
|
# @param track_id [String] The track ID.
|
364
366
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module MuxRuby
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# List property video view export links
|
23
|
-
# Lists the available video view exports along with URLs to retrieve them.
|
23
|
+
# Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [ListExportsResponse]
|
26
26
|
def list_exports(opts = {})
|
@@ -29,7 +29,7 @@ module MuxRuby
|
|
29
29
|
end
|
30
30
|
|
31
31
|
# List property video view export links
|
32
|
-
# Lists the available video view exports along with URLs to retrieve them.
|
32
|
+
# Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(ListExportsResponse, Integer, Hash)>] ListExportsResponse data, response status code and response headers
|
35
35
|
def list_exports_with_http_info(opts = {})
|
@@ -75,5 +75,62 @@ module MuxRuby
|
|
75
75
|
end
|
76
76
|
return data, status_code, headers
|
77
77
|
end
|
78
|
+
|
79
|
+
# List available property view exports
|
80
|
+
# Lists the available video view exports along with URLs to retrieve them.
|
81
|
+
# @param [Hash] opts the optional parameters
|
82
|
+
# @return [ListVideoViewExportsResponse]
|
83
|
+
def list_exports_views(opts = {})
|
84
|
+
data, _status_code, _headers = list_exports_views_with_http_info(opts)
|
85
|
+
data
|
86
|
+
end
|
87
|
+
|
88
|
+
# List available property view exports
|
89
|
+
# Lists the available video view exports along with URLs to retrieve them.
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [Array<(ListVideoViewExportsResponse, Integer, Hash)>] ListVideoViewExportsResponse data, response status code and response headers
|
92
|
+
def list_exports_views_with_http_info(opts = {})
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug 'Calling API: ExportsApi.list_exports_views ...'
|
95
|
+
end
|
96
|
+
# resource path
|
97
|
+
local_var_path = '/data/v1/exports/views'
|
98
|
+
|
99
|
+
# query parameters
|
100
|
+
query_params = opts[:query_params] || {}
|
101
|
+
|
102
|
+
# header parameters
|
103
|
+
header_params = opts[:header_params] || {}
|
104
|
+
# HTTP header 'Accept' (if needed)
|
105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
106
|
+
|
107
|
+
# form parameters
|
108
|
+
form_params = opts[:form_params] || {}
|
109
|
+
|
110
|
+
# http body (model)
|
111
|
+
post_body = opts[:debug_body]
|
112
|
+
|
113
|
+
# return_type
|
114
|
+
return_type = opts[:debug_return_type] || 'ListVideoViewExportsResponse'
|
115
|
+
|
116
|
+
# auth_names
|
117
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
118
|
+
|
119
|
+
new_options = opts.merge(
|
120
|
+
:operation => :"ExportsApi.list_exports_views",
|
121
|
+
:header_params => header_params,
|
122
|
+
:query_params => query_params,
|
123
|
+
:form_params => form_params,
|
124
|
+
:body => post_body,
|
125
|
+
:auth_names => auth_names,
|
126
|
+
:return_type => return_type
|
127
|
+
)
|
128
|
+
|
129
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
130
|
+
if @api_client.config.debugging
|
131
|
+
@api_client.config.logger.debug "API called: ExportsApi#list_exports_views\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
132
|
+
end
|
133
|
+
return data, status_code, headers
|
134
|
+
end
|
78
135
|
end
|
79
136
|
end
|