mux_ruby 2.0.0.pre.rc.2 → 2.0.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 +2 -2
- data/README.md +4 -4
- data/docs/ExportDate.md +20 -0
- data/docs/ExportFile.md +22 -0
- data/docs/ExportsApi.md +69 -1
- data/docs/ListVideoViewExportsResponse.md +22 -0
- data/docs/MetricsApi.md +8 -8
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby.rb +3 -0
- data/lib/mux_ruby/api/exports_api.rb +59 -2
- data/lib/mux_ruby/api/metrics_api.rb +16 -16
- 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/list_video_view_exports_response.rb +240 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/spec/models/export_date_spec.rb +40 -0
- data/spec/models/export_file_spec.rb +46 -0
- data/spec/models/list_video_view_exports_response_spec.rb +46 -0
- metadata +100 -88
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5ed2c3425506d9d2215a1b270685a1521fab33b7461b6df8ae7f2d1598f01be7
|
|
4
|
+
data.tar.gz: 51534c33cf08abb639b122d7ee2e0def4039da598f5165f63c8ab94ac4795993
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: abf234c5087e5bf38026f7593c2952b600cd54225cee8aa1d3d0de20ea0a2735b38c9d6bc95ff827a7d0cd45cee32346ba3e79efc0286ee3804e84d6a257e3db
|
|
7
|
+
data.tar.gz: d5297872e8d6a496756a197f0e9f4ed478ed68732a3ae8dfbfa3eb7287bdc2f1168718fb7a8282e3202294dd569f9052eb1fcdb0549ee0538faeed198b7e75ab
|
data/Gemfile.lock
CHANGED
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.0.0
|
|
20
|
+
- Package version: 2.0.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.0.0
|
|
37
|
+
gem install ./mux_ruby-2.0.0.gem
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
(for development, run `gem install --dev ./mux_ruby-2.0.0
|
|
40
|
+
(for development, run `gem install --dev ./mux_ruby-2.0.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.0.0
|
|
46
|
+
gem 'mux_ruby', '~> 2.0.0'
|
|
47
47
|
|
|
48
48
|
### Install from Git
|
|
49
49
|
|
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,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/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/gen/generator-config.json
CHANGED
data/lib/mux_ruby.rb
CHANGED
|
@@ -40,6 +40,8 @@ require 'mux_ruby/models/dimension_value'
|
|
|
40
40
|
require 'mux_ruby/models/disable_live_stream_response'
|
|
41
41
|
require 'mux_ruby/models/enable_live_stream_response'
|
|
42
42
|
require 'mux_ruby/models/error'
|
|
43
|
+
require 'mux_ruby/models/export_date'
|
|
44
|
+
require 'mux_ruby/models/export_file'
|
|
43
45
|
require 'mux_ruby/models/filter_value'
|
|
44
46
|
require 'mux_ruby/models/get_asset_input_info_response'
|
|
45
47
|
require 'mux_ruby/models/get_asset_or_live_stream_id_response'
|
|
@@ -83,6 +85,7 @@ require 'mux_ruby/models/list_real_time_metrics_response'
|
|
|
83
85
|
require 'mux_ruby/models/list_related_incidents_response'
|
|
84
86
|
require 'mux_ruby/models/list_signing_keys_response'
|
|
85
87
|
require 'mux_ruby/models/list_uploads_response'
|
|
88
|
+
require 'mux_ruby/models/list_video_view_exports_response'
|
|
86
89
|
require 'mux_ruby/models/list_video_views_response'
|
|
87
90
|
require 'mux_ruby/models/live_stream'
|
|
88
91
|
require 'mux_ruby/models/live_stream_response'
|
|
@@ -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
|
|
@@ -25,7 +25,7 @@ module MuxRuby
|
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [Array<String>] :timeframe 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.
|
|
27
27
|
# @option opts [Array<String>] :filters 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.
|
|
28
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
28
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
29
29
|
# @option opts [String] :order_direction Sort order.
|
|
30
30
|
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
|
|
31
31
|
# @return [GetMetricTimeseriesDataResponse]
|
|
@@ -40,7 +40,7 @@ module MuxRuby
|
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [Array<String>] :timeframe 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.
|
|
42
42
|
# @option opts [Array<String>] :filters 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.
|
|
43
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
43
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
44
44
|
# @option opts [String] :order_direction Sort order.
|
|
45
45
|
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
|
|
46
46
|
# @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
|
|
@@ -53,11 +53,11 @@ module MuxRuby
|
|
|
53
53
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
|
|
54
54
|
end
|
|
55
55
|
# verify enum value
|
|
56
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score"]
|
|
56
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
57
57
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
58
58
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
59
59
|
end
|
|
60
|
-
allowable_values = ["95th", "median", "avg"]
|
|
60
|
+
allowable_values = ["95th", "median", "avg", "count", "sum"]
|
|
61
61
|
if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
|
|
62
62
|
fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
|
|
63
63
|
end
|
|
@@ -120,7 +120,7 @@ module MuxRuby
|
|
|
120
120
|
# @param [Hash] opts the optional parameters
|
|
121
121
|
# @option opts [Array<String>] :timeframe 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.
|
|
122
122
|
# @option opts [Array<String>] :filters 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.
|
|
123
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
123
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
124
124
|
# @return [GetOverallValuesResponse]
|
|
125
125
|
def get_overall_values(metric_id, opts = {})
|
|
126
126
|
data, _status_code, _headers = get_overall_values_with_http_info(metric_id, opts)
|
|
@@ -133,7 +133,7 @@ module MuxRuby
|
|
|
133
133
|
# @param [Hash] opts the optional parameters
|
|
134
134
|
# @option opts [Array<String>] :timeframe 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.
|
|
135
135
|
# @option opts [Array<String>] :filters 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.
|
|
136
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
136
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
137
137
|
# @return [Array<(GetOverallValuesResponse, Integer, Hash)>] GetOverallValuesResponse data, response status code and response headers
|
|
138
138
|
def get_overall_values_with_http_info(metric_id, opts = {})
|
|
139
139
|
if @api_client.config.debugging
|
|
@@ -144,11 +144,11 @@ module MuxRuby
|
|
|
144
144
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
|
|
145
145
|
end
|
|
146
146
|
# verify enum value
|
|
147
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score"]
|
|
147
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
148
148
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
149
149
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
150
150
|
end
|
|
151
|
-
allowable_values = ["95th", "median", "avg"]
|
|
151
|
+
allowable_values = ["95th", "median", "avg", "count", "sum"]
|
|
152
152
|
if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
|
|
153
153
|
fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
|
|
154
154
|
end
|
|
@@ -273,7 +273,7 @@ module MuxRuby
|
|
|
273
273
|
# @param metric_id [String] ID of the Metric
|
|
274
274
|
# @param [Hash] opts the optional parameters
|
|
275
275
|
# @option opts [String] :group_by Breakdown value to group the results by
|
|
276
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
276
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
277
277
|
# @option opts [Array<String>] :filters 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
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
|
279
279
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
|
@@ -291,7 +291,7 @@ module MuxRuby
|
|
|
291
291
|
# @param metric_id [String] ID of the Metric
|
|
292
292
|
# @param [Hash] opts the optional parameters
|
|
293
293
|
# @option opts [String] :group_by Breakdown value to group the results by
|
|
294
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
294
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
295
295
|
# @option opts [Array<String>] :filters 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.
|
|
296
296
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
297
297
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
|
@@ -308,7 +308,7 @@ module MuxRuby
|
|
|
308
308
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
|
|
309
309
|
end
|
|
310
310
|
# verify enum value
|
|
311
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score"]
|
|
311
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
312
312
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
313
313
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
314
314
|
end
|
|
@@ -316,7 +316,7 @@ module MuxRuby
|
|
|
316
316
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
|
317
317
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
|
318
318
|
end
|
|
319
|
-
allowable_values = ["95th", "median", "avg"]
|
|
319
|
+
allowable_values = ["95th", "median", "avg", "count", "sum"]
|
|
320
320
|
if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
|
|
321
321
|
fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
|
|
322
322
|
end
|
|
@@ -380,7 +380,7 @@ module MuxRuby
|
|
|
380
380
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
|
381
381
|
# @param metric_id [String] ID of the Metric
|
|
382
382
|
# @param [Hash] opts the optional parameters
|
|
383
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
383
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
384
384
|
# @option opts [String] :order_direction Sort order.
|
|
385
385
|
# @option opts [Array<String>] :timeframe 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.
|
|
386
386
|
# @return [ListInsightsResponse]
|
|
@@ -393,7 +393,7 @@ module MuxRuby
|
|
|
393
393
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
|
394
394
|
# @param metric_id [String] ID of the Metric
|
|
395
395
|
# @param [Hash] opts the optional parameters
|
|
396
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the
|
|
396
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
397
397
|
# @option opts [String] :order_direction Sort order.
|
|
398
398
|
# @option opts [Array<String>] :timeframe 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.
|
|
399
399
|
# @return [Array<(ListInsightsResponse, Integer, Hash)>] ListInsightsResponse data, response status code and response headers
|
|
@@ -406,11 +406,11 @@ module MuxRuby
|
|
|
406
406
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
|
|
407
407
|
end
|
|
408
408
|
# verify enum value
|
|
409
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score"]
|
|
409
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
410
410
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
411
411
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
412
412
|
end
|
|
413
|
-
allowable_values = ["95th", "median", "avg"]
|
|
413
|
+
allowable_values = ["95th", "median", "avg", "count", "sum"]
|
|
414
414
|
if @api_client.config.client_side_validation && opts[:'measurement'] && !allowable_values.include?(opts[:'measurement'])
|
|
415
415
|
fail ArgumentError, "invalid value for \"measurement\", must be one of #{allowable_values}"
|
|
416
416
|
end
|