mux_ruby 1.9.0 → 2.0.0.pre.rc.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +26 -37
- data/README.md +36 -13
- data/docs/AbridgedVideoView.md +33 -13
- data/docs/Asset.md +57 -26
- data/docs/AssetErrors.md +15 -4
- data/docs/AssetMaster.md +15 -4
- data/docs/AssetNonStandardInputReasons.md +29 -11
- data/docs/AssetRecordingTimes.md +15 -4
- data/docs/AssetResponse.md +13 -3
- data/docs/AssetStaticRenditions.md +15 -4
- data/docs/AssetStaticRenditionsFiles.md +23 -8
- data/docs/AssetsApi.md +387 -160
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +25 -9
- data/docs/CreatePlaybackIDRequest.md +13 -3
- data/docs/CreatePlaybackIDResponse.md +13 -3
- data/docs/CreateSimulcastTargetRequest.md +17 -5
- data/docs/CreateTrackRequest.md +25 -9
- data/docs/CreateTrackResponse.md +13 -3
- data/docs/CreateUploadRequest.md +19 -6
- data/docs/DeliveryReport.md +27 -9
- data/docs/DeliveryUsageApi.md +40 -22
- data/docs/DimensionValue.md +15 -4
- data/docs/DimensionsApi.md +72 -34
- data/docs/DirectUploadsApi.md +131 -56
- data/docs/DisableLiveStreamResponse.md +13 -3
- data/docs/EnableLiveStreamResponse.md +13 -3
- data/docs/Error.md +27 -10
- data/docs/ErrorsApi.md +37 -19
- data/docs/ExportsApi.md +32 -13
- data/docs/FilterValue.md +15 -4
- data/docs/FiltersApi.md +71 -33
- data/docs/GetAssetInputInfoResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponseData.md +17 -5
- data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +15 -4
- data/docs/GetAssetPlaybackIDResponse.md +13 -3
- data/docs/GetMetricTimeseriesDataResponse.md +17 -5
- data/docs/GetOverallValuesResponse.md +17 -5
- data/docs/GetRealTimeBreakdownResponse.md +17 -5
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
- data/docs/GetRealTimeTimeseriesResponse.md +17 -5
- data/docs/Incident.md +53 -23
- data/docs/IncidentBreakdown.md +17 -5
- data/docs/IncidentNotification.md +17 -5
- data/docs/IncidentNotificationRule.md +21 -7
- data/docs/IncidentResponse.md +15 -4
- data/docs/IncidentsApi.md +115 -59
- data/docs/InputFile.md +15 -4
- data/docs/InputInfo.md +15 -4
- data/docs/InputSettings.md +31 -12
- data/docs/InputSettingsOverlaySettings.md +25 -9
- data/docs/InputTrack.md +29 -11
- data/docs/Insight.md +23 -8
- data/docs/ListAllMetricValuesResponse.md +17 -5
- data/docs/ListAssetsResponse.md +13 -3
- data/docs/ListBreakdownValuesResponse.md +17 -5
- data/docs/ListDeliveryUsageResponse.md +19 -6
- data/docs/ListDimensionValuesResponse.md +17 -5
- data/docs/ListDimensionsResponse.md +17 -5
- data/docs/ListErrorsResponse.md +17 -5
- data/docs/ListExportsResponse.md +17 -5
- data/docs/ListFilterValuesResponse.md +17 -5
- data/docs/ListFiltersResponse.md +17 -5
- data/docs/ListFiltersResponseData.md +15 -4
- data/docs/ListIncidentsResponse.md +17 -5
- data/docs/ListInsightsResponse.md +17 -5
- data/docs/ListLiveStreamsResponse.md +13 -3
- data/docs/ListRealTimeDimensionsResponse.md +17 -5
- data/docs/ListRealTimeDimensionsResponseData.md +15 -4
- data/docs/ListRealTimeMetricsResponse.md +17 -5
- data/docs/ListRelatedIncidentsResponse.md +17 -5
- data/docs/ListSigningKeysResponse.md +13 -3
- data/docs/ListUploadsResponse.md +13 -3
- data/docs/ListVideoViewsResponse.md +17 -5
- data/docs/LiveStream.md +37 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +418 -170
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +206 -112
- data/docs/NotificationRule.md +17 -5
- data/docs/OverallValues.md +19 -6
- data/docs/PlaybackID.md +15 -4
- data/docs/PlaybackIDApi.md +34 -16
- data/docs/PlaybackPolicy.md +10 -2
- data/docs/RealTimeApi.md +172 -76
- data/docs/RealTimeBreakdownValue.md +21 -7
- data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
- data/docs/RealTimeTimeseriesDatapoint.md +17 -5
- data/docs/Score.md +23 -8
- data/docs/SignalLiveStreamCompleteResponse.md +13 -3
- data/docs/SigningKey.md +17 -5
- data/docs/SigningKeyResponse.md +13 -3
- data/docs/SimulcastTarget.md +21 -7
- data/docs/SimulcastTargetResponse.md +13 -3
- data/docs/Track.md +37 -15
- data/docs/URLSigningKeysApi.md +127 -51
- data/docs/UpdateAssetMP4SupportRequest.md +13 -3
- data/docs/UpdateAssetMasterAccessRequest.md +13 -3
- data/docs/Upload.md +29 -11
- data/docs/UploadError.md +15 -4
- data/docs/UploadResponse.md +13 -3
- data/docs/VideoView.md +235 -114
- data/docs/VideoViewEvent.md +19 -6
- data/docs/VideoViewResponse.md +15 -4
- data/docs/VideoViewsApi.md +76 -39
- data/gen/.gitignore +7 -0
- data/gen/Makefile +31 -0
- data/gen/generator-config.json +11 -0
- data/gen/openapitools.json +7 -0
- data/gen/package.json +17 -0
- data/gen/templates/Gemfile.mustache +11 -0
- data/gen/templates/README.mustache +158 -0
- data/gen/templates/Rakefile.mustache +10 -0
- data/gen/templates/api.mustache +206 -0
- data/gen/templates/api_client.mustache +264 -0
- data/gen/templates/api_client_faraday_partial.mustache +138 -0
- data/gen/templates/api_client_spec.mustache +220 -0
- data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
- data/gen/templates/api_doc.mustache +118 -0
- data/gen/templates/api_error.mustache +67 -0
- data/gen/templates/api_info.mustache +12 -0
- data/gen/templates/api_test.mustache +47 -0
- data/gen/templates/base_object.mustache +120 -0
- data/gen/templates/configuration.mustache +349 -0
- data/gen/templates/configuration_spec.mustache +34 -0
- data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/gen/templates/gem.mustache +40 -0
- data/gen/templates/gemspec.mustache +35 -0
- data/gen/templates/gitignore.mustache +39 -0
- data/gen/templates/model.mustache +26 -0
- data/gen/templates/model_doc.mustache +12 -0
- data/gen/templates/model_test.mustache +77 -0
- data/gen/templates/partial_model_enum_class.mustache +20 -0
- data/gen/templates/partial_model_generic.mustache +371 -0
- data/gen/templates/partial_model_generic_doc.mustache +28 -0
- data/gen/templates/partial_oneof_module.mustache +137 -0
- data/gen/templates/partial_oneof_module_doc.mustache +92 -0
- data/gen/templates/rspec.mustache +2 -0
- data/gen/templates/rubocop.mustache +148 -0
- data/gen/templates/spec_helper.mustache +103 -0
- data/gen/templates/version.mustache +7 -0
- data/gen/yarn.lock +1878 -0
- data/lib/mux_ruby.rb +9 -2
- data/lib/mux_ruby/api/assets_api.rb +279 -150
- data/lib/mux_ruby/api/delivery_usage_api.rb +28 -12
- data/lib/mux_ruby/api/dimensions_api.rb +55 -29
- data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
- data/lib/mux_ruby/api/errors_api.rb +32 -16
- data/lib/mux_ruby/api/exports_api.rb +28 -12
- data/lib/mux_ruby/api/filters_api.rb +53 -27
- data/lib/mux_ruby/api/incidents_api.rb +88 -46
- data/lib/mux_ruby/api/live_streams_api.rb +299 -157
- data/lib/mux_ruby/api/metrics_api.rb +175 -104
- data/lib/mux_ruby/api/playback_id_api.rb +31 -15
- data/lib/mux_ruby/api/real_time_api.rb +139 -77
- data/lib/mux_ruby/api/url_signing_keys_api.rb +89 -42
- data/lib/mux_ruby/api/video_views_api.rb +56 -29
- data/lib/mux_ruby/api_client.rb +94 -79
- data/lib/mux_ruby/api_error.rb +35 -7
- data/lib/mux_ruby/configuration.rb +50 -14
- data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
- data/lib/mux_ruby/models/asset.rb +88 -61
- data/lib/mux_ruby/models/asset_errors.rb +50 -15
- data/lib/mux_ruby/models/asset_master.rb +52 -17
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +70 -35
- data/lib/mux_ruby/models/asset_recording_times.rb +50 -16
- data/lib/mux_ruby/models/asset_response.rb +48 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +53 -17
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +58 -23
- data/lib/mux_ruby/models/breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/create_asset_request.rb +64 -30
- data/lib/mux_ruby/models/create_live_stream_request.rb +57 -22
- data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
- data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
- data/lib/mux_ruby/models/create_track_request.rb +59 -25
- data/lib/mux_ruby/models/create_track_response.rb +48 -14
- data/lib/mux_ruby/models/create_upload_request.rb +52 -18
- data/lib/mux_ruby/models/delivery_report.rb +106 -21
- data/lib/mux_ruby/models/dimension_value.rb +49 -15
- data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/error.rb +63 -21
- data/lib/mux_ruby/models/filter_value.rb +49 -15
- data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +50 -16
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +51 -17
- data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
- data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
- data/lib/mux_ruby/models/incident.rb +68 -34
- data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
- data/lib/mux_ruby/models/incident_notification.rb +50 -16
- data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
- data/lib/mux_ruby/models/incident_response.rb +49 -15
- data/lib/mux_ruby/models/input_file.rb +49 -15
- data/lib/mux_ruby/models/input_info.rb +49 -15
- data/lib/mux_ruby/models/input_settings.rb +64 -30
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +58 -24
- data/lib/mux_ruby/models/input_track.rb +56 -22
- data/lib/mux_ruby/models/insight.rb +53 -19
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_assets_response.rb +48 -14
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
- data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_errors_response.rb +50 -16
- data/lib/mux_ruby/models/list_exports_response.rb +50 -16
- data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response.rb +50 -16
- data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_insights_response.rb +50 -16
- data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
- data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
- data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
- data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
- data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
- data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
- data/lib/mux_ruby/models/live_stream.rb +110 -28
- data/lib/mux_ruby/models/live_stream_response.rb +48 -14
- data/lib/mux_ruby/models/metric.rb +52 -18
- data/lib/mux_ruby/models/notification_rule.rb +50 -16
- data/lib/mux_ruby/models/overall_values.rb +51 -17
- data/lib/mux_ruby/models/playback_id.rb +49 -15
- data/lib/mux_ruby/models/playback_policy.rb +12 -6
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
- data/lib/mux_ruby/models/score.rb +53 -19
- data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
- data/lib/mux_ruby/models/signing_key.rb +53 -16
- data/lib/mux_ruby/models/signing_key_response.rb +48 -14
- data/lib/mux_ruby/models/simulcast_target.rb +54 -20
- data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
- data/lib/mux_ruby/models/track.rb +67 -33
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +50 -16
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +50 -16
- data/lib/mux_ruby/models/upload.rb +61 -25
- data/lib/mux_ruby/models/upload_error.rb +51 -15
- data/lib/mux_ruby/models/upload_response.rb +48 -14
- data/lib/mux_ruby/models/video_view.rb +166 -132
- data/lib/mux_ruby/models/video_view_event.rb +51 -17
- data/lib/mux_ruby/models/video_view_response.rb +49 -15
- data/lib/mux_ruby/version.rb +10 -3
- data/mux_ruby.gemspec +15 -17
- data/spec/api_client_spec.rb +10 -3
- data/spec/configuration_spec.rb +9 -2
- data/spec/spec_helper.rb +9 -2
- metadata +139 -242
@@ -1,9 +1,16 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
3
|
-
|
2
|
+
#Mux API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.1
|
10
|
+
|
4
11
|
=end
|
5
12
|
|
6
|
-
require '
|
13
|
+
require 'cgi'
|
7
14
|
|
8
15
|
module MuxRuby
|
9
16
|
class PlaybackIDApi
|
@@ -14,7 +21,7 @@ module MuxRuby
|
|
14
21
|
end
|
15
22
|
# Retrieve an Asset or Live Stream ID
|
16
23
|
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
17
|
-
# @param playback_id The live stream's playback ID.
|
24
|
+
# @param playback_id [String] The live stream's playback ID.
|
18
25
|
# @param [Hash] opts the optional parameters
|
19
26
|
# @return [GetAssetOrLiveStreamIdResponse]
|
20
27
|
def get_asset_or_livestream_id(playback_id, opts = {})
|
@@ -24,9 +31,9 @@ module MuxRuby
|
|
24
31
|
|
25
32
|
# Retrieve an Asset or Live Stream ID
|
26
33
|
# Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
27
|
-
# @param playback_id The live stream's playback ID.
|
34
|
+
# @param playback_id [String] The live stream's playback ID.
|
28
35
|
# @param [Hash] opts the optional parameters
|
29
|
-
# @return [Array<(GetAssetOrLiveStreamIdResponse,
|
36
|
+
# @return [Array<(GetAssetOrLiveStreamIdResponse, Integer, Hash)>] GetAssetOrLiveStreamIdResponse data, response status code and response headers
|
30
37
|
def get_asset_or_livestream_id_with_http_info(playback_id, opts = {})
|
31
38
|
if @api_client.config.debugging
|
32
39
|
@api_client.config.logger.debug 'Calling API: PlaybackIDApi.get_asset_or_livestream_id ...'
|
@@ -36,34 +43,43 @@ module MuxRuby
|
|
36
43
|
fail ArgumentError, "Missing the required parameter 'playback_id' when calling PlaybackIDApi.get_asset_or_livestream_id"
|
37
44
|
end
|
38
45
|
# resource path
|
39
|
-
local_var_path = '/video/v1/playback-ids/{PLAYBACK_ID}'.sub('{' + 'PLAYBACK_ID' + '}', playback_id.to_s)
|
46
|
+
local_var_path = '/video/v1/playback-ids/{PLAYBACK_ID}'.sub('{' + 'PLAYBACK_ID' + '}', CGI.escape(playback_id.to_s))
|
40
47
|
|
41
48
|
# query parameters
|
42
|
-
query_params = {}
|
49
|
+
query_params = opts[:query_params] || {}
|
43
50
|
|
44
51
|
# header parameters
|
45
|
-
header_params = {}
|
52
|
+
header_params = opts[:header_params] || {}
|
46
53
|
# HTTP header 'Accept' (if needed)
|
47
54
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
48
55
|
|
49
56
|
# form parameters
|
50
|
-
form_params = {}
|
57
|
+
form_params = opts[:form_params] || {}
|
51
58
|
|
52
59
|
# http body (model)
|
53
|
-
post_body =
|
54
|
-
|
55
|
-
|
60
|
+
post_body = opts[:debug_body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type] || 'GetAssetOrLiveStreamIdResponse'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"PlaybackIDApi.get_asset_or_livestream_id",
|
56
70
|
:header_params => header_params,
|
57
71
|
:query_params => query_params,
|
58
72
|
:form_params => form_params,
|
59
73
|
:body => post_body,
|
60
74
|
:auth_names => auth_names,
|
61
|
-
:return_type =>
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
62
79
|
if @api_client.config.debugging
|
63
80
|
@api_client.config.logger.debug "API called: PlaybackIDApi#get_asset_or_livestream_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
64
81
|
end
|
65
82
|
return data, status_code, headers
|
66
83
|
end
|
67
|
-
|
68
84
|
end
|
69
85
|
end
|
@@ -1,9 +1,16 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
3
|
-
|
2
|
+
#Mux API
|
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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.1
|
10
|
+
|
4
11
|
=end
|
5
12
|
|
6
|
-
require '
|
13
|
+
require 'cgi'
|
7
14
|
|
8
15
|
module MuxRuby
|
9
16
|
class RealTimeApi
|
@@ -14,11 +21,11 @@ module MuxRuby
|
|
14
21
|
end
|
15
22
|
# Get Real-Time Breakdown
|
16
23
|
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
17
|
-
# @param realtime_metric_id ID of the Realtime Metric
|
24
|
+
# @param realtime_metric_id [String] ID of the Realtime Metric
|
18
25
|
# @param [Hash] opts the optional parameters
|
19
26
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
20
27
|
# @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
21
|
-
# @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).
|
28
|
+
# @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.
|
22
29
|
# @option opts [String] :order_by Value to order the results by
|
23
30
|
# @option opts [String] :order_direction Sort order.
|
24
31
|
# @return [GetRealTimeBreakdownResponse]
|
@@ -29,14 +36,14 @@ module MuxRuby
|
|
29
36
|
|
30
37
|
# Get Real-Time Breakdown
|
31
38
|
# Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
32
|
-
# @param realtime_metric_id ID of the Realtime Metric
|
39
|
+
# @param realtime_metric_id [String] ID of the Realtime Metric
|
33
40
|
# @param [Hash] opts the optional parameters
|
34
41
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
35
42
|
# @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
36
|
-
# @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).
|
43
|
+
# @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.
|
37
44
|
# @option opts [String] :order_by Value to order the results by
|
38
45
|
# @option opts [String] :order_direction Sort order.
|
39
|
-
# @return [Array<(GetRealTimeBreakdownResponse,
|
46
|
+
# @return [Array<(GetRealTimeBreakdownResponse, Integer, Hash)>] GetRealTimeBreakdownResponse data, response status code and response headers
|
40
47
|
def get_realtime_breakdown_with_http_info(realtime_metric_id, opts = {})
|
41
48
|
if @api_client.config.debugging
|
42
49
|
@api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_breakdown ...'
|
@@ -46,23 +53,27 @@ module MuxRuby
|
|
46
53
|
fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_breakdown"
|
47
54
|
end
|
48
55
|
# verify enum value
|
49
|
-
|
50
|
-
|
56
|
+
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
|
57
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(realtime_metric_id)
|
58
|
+
fail ArgumentError, "invalid value for \"realtime_metric_id\", must be one of #{allowable_values}"
|
51
59
|
end
|
52
|
-
|
53
|
-
|
60
|
+
allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title"]
|
61
|
+
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
62
|
+
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
54
63
|
end
|
55
|
-
|
56
|
-
|
64
|
+
allowable_values = ["negative_impact", "value", "views", "field"]
|
65
|
+
if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
|
66
|
+
fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
|
57
67
|
end
|
58
|
-
|
59
|
-
|
68
|
+
allowable_values = ["asc", "desc"]
|
69
|
+
if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
|
70
|
+
fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
|
60
71
|
end
|
61
72
|
# resource path
|
62
|
-
local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
|
73
|
+
local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'.sub('{' + 'REALTIME_METRIC_ID' + '}', CGI.escape(realtime_metric_id.to_s))
|
63
74
|
|
64
75
|
# query parameters
|
65
|
-
query_params = {}
|
76
|
+
query_params = opts[:query_params] || {}
|
66
77
|
query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
|
67
78
|
query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
|
68
79
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
@@ -70,23 +81,33 @@ module MuxRuby
|
|
70
81
|
query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
|
71
82
|
|
72
83
|
# header parameters
|
73
|
-
header_params = {}
|
84
|
+
header_params = opts[:header_params] || {}
|
74
85
|
# HTTP header 'Accept' (if needed)
|
75
86
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
76
87
|
|
77
88
|
# form parameters
|
78
|
-
form_params = {}
|
89
|
+
form_params = opts[:form_params] || {}
|
79
90
|
|
80
91
|
# http body (model)
|
81
|
-
post_body =
|
82
|
-
|
83
|
-
|
92
|
+
post_body = opts[:debug_body]
|
93
|
+
|
94
|
+
# return_type
|
95
|
+
return_type = opts[:debug_return_type] || 'GetRealTimeBreakdownResponse'
|
96
|
+
|
97
|
+
# auth_names
|
98
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
99
|
+
|
100
|
+
new_options = opts.merge(
|
101
|
+
:operation => :"RealTimeApi.get_realtime_breakdown",
|
84
102
|
:header_params => header_params,
|
85
103
|
:query_params => query_params,
|
86
104
|
:form_params => form_params,
|
87
105
|
:body => post_body,
|
88
106
|
:auth_names => auth_names,
|
89
|
-
:return_type =>
|
107
|
+
:return_type => return_type
|
108
|
+
)
|
109
|
+
|
110
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
90
111
|
if @api_client.config.debugging
|
91
112
|
@api_client.config.logger.debug "API called: RealTimeApi#get_realtime_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
92
113
|
end
|
@@ -95,58 +116,69 @@ module MuxRuby
|
|
95
116
|
|
96
117
|
# Get Real-Time Histogram Timeseries
|
97
118
|
# Gets histogram timeseries information for a specific metric.
|
98
|
-
# @param
|
119
|
+
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
99
120
|
# @param [Hash] opts the optional parameters
|
100
|
-
# @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).
|
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.
|
101
122
|
# @return [GetRealTimeHistogramTimeseriesResponse]
|
102
|
-
def get_realtime_histogram_timeseries(
|
103
|
-
data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(
|
123
|
+
def get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts = {})
|
124
|
+
data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
|
104
125
|
data
|
105
126
|
end
|
106
127
|
|
107
128
|
# Get Real-Time Histogram Timeseries
|
108
129
|
# Gets histogram timeseries information for a specific metric.
|
109
|
-
# @param
|
130
|
+
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
110
131
|
# @param [Hash] opts the optional parameters
|
111
|
-
# @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).
|
112
|
-
# @return [Array<(GetRealTimeHistogramTimeseriesResponse,
|
113
|
-
def get_realtime_histogram_timeseries_with_http_info(
|
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.
|
133
|
+
# @return [Array<(GetRealTimeHistogramTimeseriesResponse, Integer, Hash)>] GetRealTimeHistogramTimeseriesResponse data, response status code and response headers
|
134
|
+
def get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts = {})
|
114
135
|
if @api_client.config.debugging
|
115
136
|
@api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_histogram_timeseries ...'
|
116
137
|
end
|
117
|
-
# verify the required parameter '
|
118
|
-
if @api_client.config.client_side_validation &&
|
119
|
-
fail ArgumentError, "Missing the required parameter '
|
138
|
+
# verify the required parameter 'realtime_histogram_metric_id' is set
|
139
|
+
if @api_client.config.client_side_validation && realtime_histogram_metric_id.nil?
|
140
|
+
fail ArgumentError, "Missing the required parameter 'realtime_histogram_metric_id' when calling RealTimeApi.get_realtime_histogram_timeseries"
|
120
141
|
end
|
121
142
|
# verify enum value
|
122
|
-
|
123
|
-
|
143
|
+
allowable_values = ["video-startup-time"]
|
144
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(realtime_histogram_metric_id)
|
145
|
+
fail ArgumentError, "invalid value for \"realtime_histogram_metric_id\", must be one of #{allowable_values}"
|
124
146
|
end
|
125
147
|
# resource path
|
126
|
-
local_var_path = '/data/v1/realtime/metrics/{
|
148
|
+
local_var_path = '/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries'.sub('{' + 'REALTIME_HISTOGRAM_METRIC_ID' + '}', CGI.escape(realtime_histogram_metric_id.to_s))
|
127
149
|
|
128
150
|
# query parameters
|
129
|
-
query_params = {}
|
151
|
+
query_params = opts[:query_params] || {}
|
130
152
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
131
153
|
|
132
154
|
# header parameters
|
133
|
-
header_params = {}
|
155
|
+
header_params = opts[:header_params] || {}
|
134
156
|
# HTTP header 'Accept' (if needed)
|
135
157
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
136
158
|
|
137
159
|
# form parameters
|
138
|
-
form_params = {}
|
160
|
+
form_params = opts[:form_params] || {}
|
139
161
|
|
140
162
|
# http body (model)
|
141
|
-
post_body =
|
142
|
-
|
143
|
-
|
163
|
+
post_body = opts[:debug_body]
|
164
|
+
|
165
|
+
# return_type
|
166
|
+
return_type = opts[:debug_return_type] || 'GetRealTimeHistogramTimeseriesResponse'
|
167
|
+
|
168
|
+
# auth_names
|
169
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
170
|
+
|
171
|
+
new_options = opts.merge(
|
172
|
+
:operation => :"RealTimeApi.get_realtime_histogram_timeseries",
|
144
173
|
:header_params => header_params,
|
145
174
|
:query_params => query_params,
|
146
175
|
:form_params => form_params,
|
147
176
|
:body => post_body,
|
148
177
|
:auth_names => auth_names,
|
149
|
-
:return_type =>
|
178
|
+
:return_type => return_type
|
179
|
+
)
|
180
|
+
|
181
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
150
182
|
if @api_client.config.debugging
|
151
183
|
@api_client.config.logger.debug "API called: RealTimeApi#get_realtime_histogram_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
152
184
|
end
|
@@ -155,9 +187,9 @@ module MuxRuby
|
|
155
187
|
|
156
188
|
# Get Real-Time Timeseries
|
157
189
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
158
|
-
# @param realtime_metric_id ID of the Realtime Metric
|
190
|
+
# @param realtime_metric_id [String] ID of the Realtime Metric
|
159
191
|
# @param [Hash] opts the optional parameters
|
160
|
-
# @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).
|
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.
|
161
193
|
# @return [GetRealTimeTimeseriesResponse]
|
162
194
|
def get_realtime_timeseries(realtime_metric_id, opts = {})
|
163
195
|
data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
|
@@ -166,10 +198,10 @@ module MuxRuby
|
|
166
198
|
|
167
199
|
# Get Real-Time Timeseries
|
168
200
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
169
|
-
# @param realtime_metric_id ID of the Realtime Metric
|
201
|
+
# @param realtime_metric_id [String] ID of the Realtime Metric
|
170
202
|
# @param [Hash] opts the optional parameters
|
171
|
-
# @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).
|
172
|
-
# @return [Array<(GetRealTimeTimeseriesResponse,
|
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.
|
204
|
+
# @return [Array<(GetRealTimeTimeseriesResponse, Integer, Hash)>] GetRealTimeTimeseriesResponse data, response status code and response headers
|
173
205
|
def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
|
174
206
|
if @api_client.config.debugging
|
175
207
|
@api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_timeseries ...'
|
@@ -179,34 +211,45 @@ module MuxRuby
|
|
179
211
|
fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_timeseries"
|
180
212
|
end
|
181
213
|
# verify enum value
|
182
|
-
|
183
|
-
|
214
|
+
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
|
215
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(realtime_metric_id)
|
216
|
+
fail ArgumentError, "invalid value for \"realtime_metric_id\", must be one of #{allowable_values}"
|
184
217
|
end
|
185
218
|
# resource path
|
186
|
-
local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
|
219
|
+
local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', CGI.escape(realtime_metric_id.to_s))
|
187
220
|
|
188
221
|
# query parameters
|
189
|
-
query_params = {}
|
222
|
+
query_params = opts[:query_params] || {}
|
190
223
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
191
224
|
|
192
225
|
# header parameters
|
193
|
-
header_params = {}
|
226
|
+
header_params = opts[:header_params] || {}
|
194
227
|
# HTTP header 'Accept' (if needed)
|
195
228
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
196
229
|
|
197
230
|
# form parameters
|
198
|
-
form_params = {}
|
231
|
+
form_params = opts[:form_params] || {}
|
199
232
|
|
200
233
|
# http body (model)
|
201
|
-
post_body =
|
202
|
-
|
203
|
-
|
234
|
+
post_body = opts[:debug_body]
|
235
|
+
|
236
|
+
# return_type
|
237
|
+
return_type = opts[:debug_return_type] || 'GetRealTimeTimeseriesResponse'
|
238
|
+
|
239
|
+
# auth_names
|
240
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
241
|
+
|
242
|
+
new_options = opts.merge(
|
243
|
+
:operation => :"RealTimeApi.get_realtime_timeseries",
|
204
244
|
:header_params => header_params,
|
205
245
|
:query_params => query_params,
|
206
246
|
:form_params => form_params,
|
207
247
|
:body => post_body,
|
208
248
|
:auth_names => auth_names,
|
209
|
-
:return_type =>
|
249
|
+
:return_type => return_type
|
250
|
+
)
|
251
|
+
|
252
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
210
253
|
if @api_client.config.debugging
|
211
254
|
@api_client.config.logger.debug "API called: RealTimeApi#get_realtime_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
212
255
|
end
|
@@ -225,7 +268,7 @@ module MuxRuby
|
|
225
268
|
# List Real-Time Dimensions
|
226
269
|
# Lists availiable real-time dimensions
|
227
270
|
# @param [Hash] opts the optional parameters
|
228
|
-
# @return [Array<(ListRealTimeDimensionsResponse,
|
271
|
+
# @return [Array<(ListRealTimeDimensionsResponse, Integer, Hash)>] ListRealTimeDimensionsResponse data, response status code and response headers
|
229
272
|
def list_realtime_dimensions_with_http_info(opts = {})
|
230
273
|
if @api_client.config.debugging
|
231
274
|
@api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_dimensions ...'
|
@@ -234,26 +277,36 @@ module MuxRuby
|
|
234
277
|
local_var_path = '/data/v1/realtime/dimensions'
|
235
278
|
|
236
279
|
# query parameters
|
237
|
-
query_params = {}
|
280
|
+
query_params = opts[:query_params] || {}
|
238
281
|
|
239
282
|
# header parameters
|
240
|
-
header_params = {}
|
283
|
+
header_params = opts[:header_params] || {}
|
241
284
|
# HTTP header 'Accept' (if needed)
|
242
285
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
243
286
|
|
244
287
|
# form parameters
|
245
|
-
form_params = {}
|
288
|
+
form_params = opts[:form_params] || {}
|
246
289
|
|
247
290
|
# http body (model)
|
248
|
-
post_body =
|
249
|
-
|
250
|
-
|
291
|
+
post_body = opts[:debug_body]
|
292
|
+
|
293
|
+
# return_type
|
294
|
+
return_type = opts[:debug_return_type] || 'ListRealTimeDimensionsResponse'
|
295
|
+
|
296
|
+
# auth_names
|
297
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
298
|
+
|
299
|
+
new_options = opts.merge(
|
300
|
+
:operation => :"RealTimeApi.list_realtime_dimensions",
|
251
301
|
:header_params => header_params,
|
252
302
|
:query_params => query_params,
|
253
303
|
:form_params => form_params,
|
254
304
|
:body => post_body,
|
255
305
|
:auth_names => auth_names,
|
256
|
-
:return_type =>
|
306
|
+
:return_type => return_type
|
307
|
+
)
|
308
|
+
|
309
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
257
310
|
if @api_client.config.debugging
|
258
311
|
@api_client.config.logger.debug "API called: RealTimeApi#list_realtime_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
259
312
|
end
|
@@ -272,7 +325,7 @@ module MuxRuby
|
|
272
325
|
# List Real-Time Metrics
|
273
326
|
# Lists availiable real-time metrics.
|
274
327
|
# @param [Hash] opts the optional parameters
|
275
|
-
# @return [Array<(ListRealTimeMetricsResponse,
|
328
|
+
# @return [Array<(ListRealTimeMetricsResponse, Integer, Hash)>] ListRealTimeMetricsResponse data, response status code and response headers
|
276
329
|
def list_realtime_metrics_with_http_info(opts = {})
|
277
330
|
if @api_client.config.debugging
|
278
331
|
@api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_metrics ...'
|
@@ -281,31 +334,40 @@ module MuxRuby
|
|
281
334
|
local_var_path = '/data/v1/realtime/metrics'
|
282
335
|
|
283
336
|
# query parameters
|
284
|
-
query_params = {}
|
337
|
+
query_params = opts[:query_params] || {}
|
285
338
|
|
286
339
|
# header parameters
|
287
|
-
header_params = {}
|
340
|
+
header_params = opts[:header_params] || {}
|
288
341
|
# HTTP header 'Accept' (if needed)
|
289
342
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
290
343
|
|
291
344
|
# form parameters
|
292
|
-
form_params = {}
|
345
|
+
form_params = opts[:form_params] || {}
|
293
346
|
|
294
347
|
# http body (model)
|
295
|
-
post_body =
|
296
|
-
|
297
|
-
|
348
|
+
post_body = opts[:debug_body]
|
349
|
+
|
350
|
+
# return_type
|
351
|
+
return_type = opts[:debug_return_type] || 'ListRealTimeMetricsResponse'
|
352
|
+
|
353
|
+
# auth_names
|
354
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
355
|
+
|
356
|
+
new_options = opts.merge(
|
357
|
+
:operation => :"RealTimeApi.list_realtime_metrics",
|
298
358
|
:header_params => header_params,
|
299
359
|
:query_params => query_params,
|
300
360
|
:form_params => form_params,
|
301
361
|
:body => post_body,
|
302
362
|
:auth_names => auth_names,
|
303
|
-
:return_type =>
|
363
|
+
:return_type => return_type
|
364
|
+
)
|
365
|
+
|
366
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
304
367
|
if @api_client.config.debugging
|
305
368
|
@api_client.config.logger.debug "API called: RealTimeApi#list_realtime_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
306
369
|
end
|
307
370
|
return data, status_code, headers
|
308
371
|
end
|
309
|
-
|
310
372
|
end
|
311
373
|
end
|