mux_ruby 2.0.0.pre.rc.1 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -6
- data/README.md +5 -4
- data/docs/Asset.md +4 -2
- data/docs/AssetsApi.md +10 -4
- data/docs/CreateLiveStreamRequest.md +4 -0
- data/docs/CreateTrackRequest.md +1 -1
- data/docs/DeliveryUsageApi.md +3 -3
- data/docs/ErrorsApi.md +1 -1
- data/docs/ExportDate.md +20 -0
- data/docs/ExportFile.md +22 -0
- data/docs/ExportsApi.md +69 -1
- data/docs/IncidentsApi.md +3 -3
- data/docs/ListVideoViewExportsResponse.md +22 -0
- data/docs/LiveStream.md +4 -0
- data/docs/MetricsApi.md +13 -13
- data/docs/PlaybackIDApi.md +1 -1
- data/docs/RealTimeApi.md +5 -5
- data/docs/RealTimeBreakdownValue.md +2 -2
- data/docs/RealTimeTimeseriesDatapoint.md +2 -2
- data/docs/URLSigningKeysApi.md +3 -3
- data/docs/VideoView.md +17 -1
- data/docs/VideoViewsApi.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 +16 -8
- data/lib/mux_ruby/api/delivery_usage_api.rb +6 -6
- data/lib/mux_ruby/api/dimensions_api.rb +2 -2
- data/lib/mux_ruby/api/direct_uploads_api.rb +2 -2
- data/lib/mux_ruby/api/errors_api.rb +4 -4
- data/lib/mux_ruby/api/exports_api.rb +61 -4
- data/lib/mux_ruby/api/filters_api.rb +2 -2
- data/lib/mux_ruby/api/incidents_api.rb +8 -8
- data/lib/mux_ruby/api/live_streams_api.rb +2 -2
- data/lib/mux_ruby/api/metrics_api.rb +28 -28
- data/lib/mux_ruby/api/playback_id_api.rb +4 -4
- data/lib/mux_ruby/api/real_time_api.rb +12 -12
- data/lib/mux_ruby/api/url_signing_keys_api.rb +8 -8
- data/lib/mux_ruby/api/video_views_api.rb +6 -6
- data/lib/mux_ruby/api_client.rb +2 -2
- data/lib/mux_ruby/api_error.rb +2 -2
- data/lib/mux_ruby/configuration.rb +2 -2
- data/lib/mux_ruby/models/abridged_video_view.rb +2 -2
- data/lib/mux_ruby/models/asset.rb +15 -5
- data/lib/mux_ruby/models/asset_errors.rb +2 -2
- data/lib/mux_ruby/models/asset_master.rb +2 -2
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +2 -2
- data/lib/mux_ruby/models/asset_recording_times.rb +2 -2
- data/lib/mux_ruby/models/asset_response.rb +2 -2
- data/lib/mux_ruby/models/asset_static_renditions.rb +2 -2
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +2 -2
- data/lib/mux_ruby/models/breakdown_value.rb +2 -2
- data/lib/mux_ruby/models/create_asset_request.rb +2 -2
- data/lib/mux_ruby/models/create_live_stream_request.rb +23 -3
- data/lib/mux_ruby/models/create_playback_id_request.rb +2 -2
- data/lib/mux_ruby/models/create_playback_id_response.rb +2 -2
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +2 -2
- data/lib/mux_ruby/models/create_track_request.rb +3 -3
- data/lib/mux_ruby/models/create_track_response.rb +2 -2
- data/lib/mux_ruby/models/create_upload_request.rb +2 -2
- data/lib/mux_ruby/models/delivery_report.rb +2 -2
- data/lib/mux_ruby/models/dimension_value.rb +2 -2
- data/lib/mux_ruby/models/disable_live_stream_response.rb +2 -2
- data/lib/mux_ruby/models/enable_live_stream_response.rb +2 -2
- data/lib/mux_ruby/models/error.rb +2 -2
- 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/filter_value.rb +2 -2
- data/lib/mux_ruby/models/get_asset_input_info_response.rb +2 -2
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +2 -2
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +2 -2
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +2 -2
- data/lib/mux_ruby/models/get_asset_playback_id_response.rb +2 -2
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +2 -2
- data/lib/mux_ruby/models/get_overall_values_response.rb +2 -2
- data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +2 -2
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +2 -2
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +2 -2
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +2 -2
- data/lib/mux_ruby/models/incident.rb +2 -2
- data/lib/mux_ruby/models/incident_breakdown.rb +2 -2
- data/lib/mux_ruby/models/incident_notification.rb +2 -2
- data/lib/mux_ruby/models/incident_notification_rule.rb +2 -2
- data/lib/mux_ruby/models/incident_response.rb +2 -2
- data/lib/mux_ruby/models/input_file.rb +2 -2
- data/lib/mux_ruby/models/input_info.rb +2 -2
- data/lib/mux_ruby/models/input_settings.rb +2 -2
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +2 -2
- data/lib/mux_ruby/models/input_track.rb +2 -2
- data/lib/mux_ruby/models/insight.rb +2 -2
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +2 -2
- data/lib/mux_ruby/models/list_assets_response.rb +2 -2
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +2 -2
- data/lib/mux_ruby/models/list_delivery_usage_response.rb +2 -2
- data/lib/mux_ruby/models/list_dimension_values_response.rb +2 -2
- data/lib/mux_ruby/models/list_dimensions_response.rb +2 -2
- data/lib/mux_ruby/models/list_errors_response.rb +2 -2
- data/lib/mux_ruby/models/list_exports_response.rb +2 -2
- data/lib/mux_ruby/models/list_filter_values_response.rb +2 -2
- data/lib/mux_ruby/models/list_filters_response.rb +2 -2
- data/lib/mux_ruby/models/list_filters_response_data.rb +2 -2
- data/lib/mux_ruby/models/list_incidents_response.rb +2 -2
- data/lib/mux_ruby/models/list_insights_response.rb +2 -2
- data/lib/mux_ruby/models/list_live_streams_response.rb +2 -2
- data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +2 -2
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +2 -2
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +2 -2
- data/lib/mux_ruby/models/list_related_incidents_response.rb +2 -2
- data/lib/mux_ruby/models/list_signing_keys_response.rb +2 -2
- data/lib/mux_ruby/models/list_uploads_response.rb +2 -2
- data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
- data/lib/mux_ruby/models/list_video_views_response.rb +2 -2
- data/lib/mux_ruby/models/live_stream.rb +23 -3
- data/lib/mux_ruby/models/live_stream_response.rb +2 -2
- data/lib/mux_ruby/models/metric.rb +2 -2
- data/lib/mux_ruby/models/notification_rule.rb +2 -2
- data/lib/mux_ruby/models/overall_values.rb +2 -2
- data/lib/mux_ruby/models/playback_id.rb +2 -2
- data/lib/mux_ruby/models/playback_policy.rb +2 -2
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +9 -9
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +2 -2
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +2 -2
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +2 -2
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +9 -9
- data/lib/mux_ruby/models/score.rb +2 -2
- data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +2 -2
- data/lib/mux_ruby/models/signing_key.rb +2 -2
- data/lib/mux_ruby/models/signing_key_response.rb +2 -2
- data/lib/mux_ruby/models/simulcast_target.rb +2 -2
- data/lib/mux_ruby/models/simulcast_target_response.rb +2 -2
- data/lib/mux_ruby/models/track.rb +2 -2
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +2 -2
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +2 -2
- data/lib/mux_ruby/models/upload.rb +2 -2
- data/lib/mux_ruby/models/upload_error.rb +2 -2
- data/lib/mux_ruby/models/upload_response.rb +2 -2
- data/lib/mux_ruby/models/video_view.rb +78 -6
- data/lib/mux_ruby/models/video_view_event.rb +2 -2
- data/lib/mux_ruby/models/video_view_response.rb +2 -2
- data/lib/mux_ruby/version.rb +3 -3
- data/lib/mux_ruby.rb +5 -2
- data/mux_ruby.gemspec +3 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- 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
- data/spec/spec_helper.rb +2 -2
- metadata +109 -96
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -20,7 +20,7 @@ module MuxRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get an Incident
|
|
23
|
-
# Returns the details of an incident
|
|
23
|
+
# Returns the details of an incident.
|
|
24
24
|
# @param incident_id [String] ID of the Incident
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [IncidentResponse]
|
|
@@ -30,7 +30,7 @@ module MuxRuby
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Get an Incident
|
|
33
|
-
# Returns the details of an incident
|
|
33
|
+
# Returns the details of an incident.
|
|
34
34
|
# @param incident_id [String] ID of the Incident
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(IncidentResponse, Integer, Hash)>] IncidentResponse data, response status code and response headers
|
|
@@ -83,7 +83,7 @@ module MuxRuby
|
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
# List Incidents
|
|
86
|
-
# Returns a list of incidents
|
|
86
|
+
# Returns a list of incidents.
|
|
87
87
|
# @param [Hash] opts the optional parameters
|
|
88
88
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
|
89
89
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
|
@@ -98,7 +98,7 @@ module MuxRuby
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
# List Incidents
|
|
101
|
-
# Returns a list of incidents
|
|
101
|
+
# Returns a list of incidents.
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
|
103
103
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
104
104
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
|
@@ -174,7 +174,7 @@ module MuxRuby
|
|
|
174
174
|
end
|
|
175
175
|
|
|
176
176
|
# List Related Incidents
|
|
177
|
-
# Returns all the incidents that seem related to a specific incident
|
|
177
|
+
# Returns all the incidents that seem related to a specific incident.
|
|
178
178
|
# @param incident_id [String] ID of the Incident
|
|
179
179
|
# @param [Hash] opts the optional parameters
|
|
180
180
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
|
@@ -188,7 +188,7 @@ module MuxRuby
|
|
|
188
188
|
end
|
|
189
189
|
|
|
190
190
|
# List Related Incidents
|
|
191
|
-
# Returns all the incidents that seem related to a specific incident
|
|
191
|
+
# Returns all the incidents that seem related to a specific incident.
|
|
192
192
|
# @param incident_id [String] ID of the Incident
|
|
193
193
|
# @param [Hash] opts the optional parameters
|
|
194
194
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -20,12 +20,12 @@ module MuxRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get metric timeseries data
|
|
23
|
-
# Returns timeseries data for a specific metric
|
|
23
|
+
# Returns timeseries data for a specific metric.
|
|
24
24
|
# @param metric_id [String] ID of the Metric
|
|
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]
|
|
@@ -35,12 +35,12 @@ module MuxRuby
|
|
|
35
35
|
end
|
|
36
36
|
|
|
37
37
|
# Get metric timeseries data
|
|
38
|
-
# Returns timeseries data for a specific metric
|
|
38
|
+
# Returns timeseries data for a specific metric.
|
|
39
39
|
# @param metric_id [String] ID of the Metric
|
|
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
|
|
@@ -115,12 +115,12 @@ module MuxRuby
|
|
|
115
115
|
end
|
|
116
116
|
|
|
117
117
|
# Get Overall values
|
|
118
|
-
# Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
|
|
118
|
+
# Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
|
|
119
119
|
# @param metric_id [String] ID of the Metric
|
|
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)
|
|
@@ -128,12 +128,12 @@ module MuxRuby
|
|
|
128
128
|
end
|
|
129
129
|
|
|
130
130
|
# Get Overall values
|
|
131
|
-
# Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
|
|
131
|
+
# Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
|
|
132
132
|
# @param metric_id [String] ID of the Metric
|
|
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
|
|
@@ -196,7 +196,7 @@ module MuxRuby
|
|
|
196
196
|
end
|
|
197
197
|
|
|
198
198
|
# List all metric values
|
|
199
|
-
# List all of the values across every breakdown for a specific metric
|
|
199
|
+
# List all of the values across every breakdown for a specific metric.
|
|
200
200
|
# @param [Hash] opts the optional parameters
|
|
201
201
|
# @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.
|
|
202
202
|
# @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.
|
|
@@ -209,7 +209,7 @@ module MuxRuby
|
|
|
209
209
|
end
|
|
210
210
|
|
|
211
211
|
# List all metric values
|
|
212
|
-
# List all of the values across every breakdown for a specific metric
|
|
212
|
+
# List all of the values across every breakdown for a specific metric.
|
|
213
213
|
# @param [Hash] opts the optional parameters
|
|
214
214
|
# @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.
|
|
215
215
|
# @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.
|
|
@@ -269,11 +269,11 @@ module MuxRuby
|
|
|
269
269
|
end
|
|
270
270
|
|
|
271
271
|
# List breakdown values
|
|
272
|
-
# List the breakdown values for a specific metric
|
|
272
|
+
# List the breakdown values for a specific metric.
|
|
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)
|
|
@@ -287,11 +287,11 @@ module MuxRuby
|
|
|
287
287
|
end
|
|
288
288
|
|
|
289
289
|
# List breakdown values
|
|
290
|
-
# List the breakdown values for a specific metric
|
|
290
|
+
# List the breakdown values for a specific metric.
|
|
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
|
|
@@ -377,10 +377,10 @@ module MuxRuby
|
|
|
377
377
|
end
|
|
378
378
|
|
|
379
379
|
# List Insights
|
|
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.
|
|
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]
|
|
@@ -390,10 +390,10 @@ module MuxRuby
|
|
|
390
390
|
end
|
|
391
391
|
|
|
392
392
|
# List Insights
|
|
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.
|
|
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
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -20,7 +20,7 @@ module MuxRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Retrieve an Asset or Live Stream ID
|
|
23
|
-
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
|
23
|
+
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
|
24
24
|
# @param playback_id [String] The live stream's playback ID.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [GetAssetOrLiveStreamIdResponse]
|
|
@@ -30,7 +30,7 @@ module MuxRuby
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Retrieve an Asset or Live Stream ID
|
|
33
|
-
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
|
33
|
+
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
|
34
34
|
# @param playback_id [String] The live stream's playback ID.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(GetAssetOrLiveStreamIdResponse, Integer, Hash)>] GetAssetOrLiveStreamIdResponse data, response status code and response headers
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -20,7 +20,7 @@ module MuxRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Get Real-Time Breakdown
|
|
23
|
-
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
|
23
|
+
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
|
24
24
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
@@ -35,7 +35,7 @@ module MuxRuby
|
|
|
35
35
|
end
|
|
36
36
|
|
|
37
37
|
# Get Real-Time Breakdown
|
|
38
|
-
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
|
38
|
+
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
|
39
39
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
@@ -115,7 +115,7 @@ module MuxRuby
|
|
|
115
115
|
end
|
|
116
116
|
|
|
117
117
|
# Get Real-Time Histogram Timeseries
|
|
118
|
-
# Gets histogram timeseries information for a specific metric.
|
|
118
|
+
# Gets histogram timeseries information for a specific metric.
|
|
119
119
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
|
120
120
|
# @param [Hash] opts the optional parameters
|
|
121
121
|
# @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.
|
|
@@ -126,7 +126,7 @@ module MuxRuby
|
|
|
126
126
|
end
|
|
127
127
|
|
|
128
128
|
# Get Real-Time Histogram Timeseries
|
|
129
|
-
# Gets histogram timeseries information for a specific metric.
|
|
129
|
+
# Gets histogram timeseries information for a specific metric.
|
|
130
130
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
|
131
131
|
# @param [Hash] opts the optional parameters
|
|
132
132
|
# @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.
|
|
@@ -186,7 +186,7 @@ module MuxRuby
|
|
|
186
186
|
end
|
|
187
187
|
|
|
188
188
|
# Get Real-Time Timeseries
|
|
189
|
-
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
189
|
+
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
190
190
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
191
191
|
# @param [Hash] opts the optional parameters
|
|
192
192
|
# @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.
|
|
@@ -197,7 +197,7 @@ module MuxRuby
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
# Get Real-Time Timeseries
|
|
200
|
-
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
200
|
+
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
201
201
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
202
202
|
# @param [Hash] opts the optional parameters
|
|
203
203
|
# @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.
|
|
@@ -257,7 +257,7 @@ module MuxRuby
|
|
|
257
257
|
end
|
|
258
258
|
|
|
259
259
|
# List Real-Time Dimensions
|
|
260
|
-
# Lists
|
|
260
|
+
# Lists available real-time dimensions.
|
|
261
261
|
# @param [Hash] opts the optional parameters
|
|
262
262
|
# @return [ListRealTimeDimensionsResponse]
|
|
263
263
|
def list_realtime_dimensions(opts = {})
|
|
@@ -266,7 +266,7 @@ module MuxRuby
|
|
|
266
266
|
end
|
|
267
267
|
|
|
268
268
|
# List Real-Time Dimensions
|
|
269
|
-
# Lists
|
|
269
|
+
# Lists available real-time dimensions.
|
|
270
270
|
# @param [Hash] opts the optional parameters
|
|
271
271
|
# @return [Array<(ListRealTimeDimensionsResponse, Integer, Hash)>] ListRealTimeDimensionsResponse data, response status code and response headers
|
|
272
272
|
def list_realtime_dimensions_with_http_info(opts = {})
|
|
@@ -314,7 +314,7 @@ module MuxRuby
|
|
|
314
314
|
end
|
|
315
315
|
|
|
316
316
|
# List Real-Time Metrics
|
|
317
|
-
# Lists
|
|
317
|
+
# Lists available real-time metrics.
|
|
318
318
|
# @param [Hash] opts the optional parameters
|
|
319
319
|
# @return [ListRealTimeMetricsResponse]
|
|
320
320
|
def list_realtime_metrics(opts = {})
|
|
@@ -323,7 +323,7 @@ module MuxRuby
|
|
|
323
323
|
end
|
|
324
324
|
|
|
325
325
|
# List Real-Time Metrics
|
|
326
|
-
# Lists
|
|
326
|
+
# Lists available real-time metrics.
|
|
327
327
|
# @param [Hash] opts the optional parameters
|
|
328
328
|
# @return [Array<(ListRealTimeMetricsResponse, Integer, Hash)>] ListRealTimeMetricsResponse data, response status code and response headers
|
|
329
329
|
def list_realtime_metrics_with_http_info(opts = {})
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Mux API
|
|
3
3
|
|
|
4
|
-
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v1
|
|
7
|
-
|
|
7
|
+
Contact: devex@mux.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 5.0.1
|
|
10
10
|
|
|
@@ -20,7 +20,7 @@ module MuxRuby
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create a URL signing key
|
|
23
|
-
# Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
|
23
|
+
# Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @return [SigningKeyResponse]
|
|
26
26
|
def create_url_signing_key(opts = {})
|
|
@@ -29,7 +29,7 @@ module MuxRuby
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
# Create a URL signing key
|
|
32
|
-
# Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
|
32
|
+
# Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(SigningKeyResponse, Integer, Hash)>] SigningKeyResponse data, response status code and response headers
|
|
35
35
|
def create_url_signing_key_with_http_info(opts = {})
|
|
@@ -77,7 +77,7 @@ module MuxRuby
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# Delete a URL signing key
|
|
80
|
-
# Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
|
80
|
+
# Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
|
81
81
|
# @param signing_key_id [String] The ID of the signing key.
|
|
82
82
|
# @param [Hash] opts the optional parameters
|
|
83
83
|
# @return [nil]
|
|
@@ -87,7 +87,7 @@ module MuxRuby
|
|
|
87
87
|
end
|
|
88
88
|
|
|
89
89
|
# Delete a URL signing key
|
|
90
|
-
# Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
|
90
|
+
# Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
|
91
91
|
# @param signing_key_id [String] The ID of the signing key.
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
93
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -201,7 +201,7 @@ module MuxRuby
|
|
|
201
201
|
end
|
|
202
202
|
|
|
203
203
|
# List URL signing keys
|
|
204
|
-
# Returns a list of URL signing keys.
|
|
204
|
+
# Returns a list of URL signing keys.
|
|
205
205
|
# @param [Hash] opts the optional parameters
|
|
206
206
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
|
207
207
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
|
@@ -212,7 +212,7 @@ module MuxRuby
|
|
|
212
212
|
end
|
|
213
213
|
|
|
214
214
|
# List URL signing keys
|
|
215
|
-
# Returns a list of URL signing keys.
|
|
215
|
+
# Returns a list of URL signing keys.
|
|
216
216
|
# @param [Hash] opts the optional parameters
|
|
217
217
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
218
218
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|