mux_ruby 1.5.0 → 1.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (162) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +4 -1
  4. data/docs/Asset.md +15 -12
  5. data/docs/AssetErrors.md +2 -2
  6. data/docs/AssetNonStandardInputReasons.md +16 -0
  7. data/docs/AssetRecordingTimes.md +9 -0
  8. data/docs/AssetStaticRenditions.md +1 -1
  9. data/docs/AssetsApi.md +4 -0
  10. data/docs/CreateAssetRequest.md +6 -6
  11. data/docs/CreateLiveStreamRequest.md +1 -0
  12. data/docs/CreateTrackRequest.md +4 -4
  13. data/docs/DimensionValue.md +9 -0
  14. data/docs/DimensionsApi.md +118 -0
  15. data/docs/DisableLiveStreamResponse.md +8 -0
  16. data/docs/EnableLiveStreamResponse.md +8 -0
  17. data/docs/FiltersApi.md +2 -2
  18. data/docs/GetAssetOrLiveStreamIdResponse.md +8 -0
  19. data/docs/GetAssetOrLiveStreamIdResponseData.md +10 -0
  20. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +9 -0
  21. data/docs/GetRealTimeBreakdownResponse.md +10 -0
  22. data/docs/GetRealTimeHistogramTimeseriesResponse.md +11 -0
  23. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +8 -0
  24. data/docs/GetRealTimeTimeseriesResponse.md +10 -0
  25. data/docs/Incident.md +28 -0
  26. data/docs/IncidentBreakdown.md +10 -0
  27. data/docs/IncidentNotification.md +10 -0
  28. data/docs/IncidentNotificationRule.md +12 -0
  29. data/docs/IncidentResponse.md +9 -0
  30. data/docs/IncidentsApi.md +186 -0
  31. data/docs/InputSettings.md +9 -7
  32. data/docs/InputSettingsOverlaySettings.md +7 -7
  33. data/docs/ListDimensionValuesResponse.md +10 -0
  34. data/docs/ListDimensionsResponse.md +10 -0
  35. data/docs/ListIncidentsResponse.md +10 -0
  36. data/docs/ListRealTimeDimensionsResponse.md +10 -0
  37. data/docs/ListRealTimeDimensionsResponseData.md +9 -0
  38. data/docs/ListRealTimeMetricsResponse.md +10 -0
  39. data/docs/ListRelatedIncidentsResponse.md +10 -0
  40. data/docs/LiveStream.md +1 -1
  41. data/docs/LiveStreamsApi.md +104 -0
  42. data/docs/NotificationRule.md +10 -0
  43. data/docs/PlaybackID.md +1 -1
  44. data/docs/PlaybackIDApi.md +60 -0
  45. data/docs/RealTimeApi.md +280 -0
  46. data/docs/RealTimeBreakdownValue.md +12 -0
  47. data/docs/RealTimeHistogramTimeseriesBucket.md +9 -0
  48. data/docs/RealTimeHistogramTimeseriesBucketValues.md +9 -0
  49. data/docs/RealTimeHistogramTimeseriesDatapoint.md +14 -0
  50. data/docs/RealTimeTimeseriesDatapoint.md +10 -0
  51. data/docs/Track.md +13 -13
  52. data/docs/VideoView.md +16 -14
  53. data/examples/data/exercise-dimensions.rb +29 -0
  54. data/examples/data/exercise-incidents.rb +29 -0
  55. data/examples/data/exercise-realtime.rb +60 -0
  56. data/examples/video/exercise-assets.rb +21 -0
  57. data/examples/video/exercise-live-streams.rb +30 -0
  58. data/lib/mux_ruby.rb +34 -0
  59. data/lib/mux_ruby/api/assets_api.rb +4 -0
  60. data/lib/mux_ruby/api/dimensions_api.rb +128 -0
  61. data/lib/mux_ruby/api/filters_api.rb +4 -4
  62. data/lib/mux_ruby/api/incidents_api.rb +217 -0
  63. data/lib/mux_ruby/api/live_streams_api.rb +106 -0
  64. data/lib/mux_ruby/api/playback_id_api.rb +69 -0
  65. data/lib/mux_ruby/api/real_time_api.rb +311 -0
  66. data/lib/mux_ruby/api_client.rb +13 -13
  67. data/lib/mux_ruby/configuration.rb +1 -4
  68. data/lib/mux_ruby/models/asset.rb +70 -3
  69. data/lib/mux_ruby/models/asset_errors.rb +2 -0
  70. data/lib/mux_ruby/models/asset_master.rb +35 -0
  71. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +335 -0
  72. data/lib/mux_ruby/models/asset_recording_times.rb +195 -0
  73. data/lib/mux_ruby/models/asset_static_renditions.rb +2 -2
  74. data/lib/mux_ruby/models/asset_static_renditions_files.rb +6 -6
  75. data/lib/mux_ruby/models/create_asset_request.rb +8 -2
  76. data/lib/mux_ruby/models/create_live_stream_request.rb +15 -4
  77. data/lib/mux_ruby/models/create_track_request.rb +6 -2
  78. data/lib/mux_ruby/models/dimension_value.rb +193 -0
  79. data/lib/mux_ruby/models/disable_live_stream_response.rb +184 -0
  80. data/lib/mux_ruby/models/enable_live_stream_response.rb +184 -0
  81. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +184 -0
  82. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +203 -0
  83. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +230 -0
  84. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +206 -0
  85. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +215 -0
  86. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +186 -0
  87. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +206 -0
  88. data/lib/mux_ruby/models/incident.rb +370 -0
  89. data/lib/mux_ruby/models/incident_breakdown.rb +202 -0
  90. data/lib/mux_ruby/models/incident_notification.rb +202 -0
  91. data/lib/mux_ruby/models/incident_notification_rule.rb +222 -0
  92. data/lib/mux_ruby/models/incident_response.rb +195 -0
  93. data/lib/mux_ruby/models/input_settings.rb +31 -4
  94. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +10 -2
  95. data/lib/mux_ruby/models/list_dimension_values_response.rb +206 -0
  96. data/lib/mux_ruby/models/list_dimensions_response.rb +204 -0
  97. data/lib/mux_ruby/models/list_incidents_response.rb +206 -0
  98. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +206 -0
  99. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +193 -0
  100. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +206 -0
  101. data/lib/mux_ruby/models/list_related_incidents_response.rb +206 -0
  102. data/lib/mux_ruby/models/live_stream.rb +1 -1
  103. data/lib/mux_ruby/models/notification_rule.rb +202 -0
  104. data/lib/mux_ruby/models/playback_id.rb +1 -0
  105. data/lib/mux_ruby/models/real_time_breakdown_value.rb +220 -0
  106. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +193 -0
  107. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +193 -0
  108. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +240 -0
  109. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +202 -0
  110. data/lib/mux_ruby/models/simulcast_target.rb +1 -1
  111. data/lib/mux_ruby/models/track.rb +27 -2
  112. data/lib/mux_ruby/models/update_asset_master_access_request.rb +1 -1
  113. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +1 -1
  114. data/lib/mux_ruby/models/upload.rb +1 -1
  115. data/lib/mux_ruby/models/video_view.rb +36 -18
  116. data/lib/mux_ruby/version.rb +1 -1
  117. data/mux_ruby.gemspec +2 -0
  118. data/spec/api/assets_api_spec.rb +2 -0
  119. data/spec/api/dimensions_api_spec.rb +55 -0
  120. data/spec/api/filters_api_spec.rb +2 -2
  121. data/spec/api/incidents_api_spec.rb +73 -0
  122. data/spec/api/live_streams_api_spec.rb +24 -0
  123. data/spec/api/playback_id_api_spec.rb +40 -0
  124. data/spec/api/real_time_api_spec.rb +93 -0
  125. data/spec/models/asset_master_spec.rb +4 -0
  126. data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
  127. data/spec/models/asset_recording_times_spec.rb +40 -0
  128. data/spec/models/asset_spec.rb +26 -0
  129. data/spec/models/asset_static_renditions_files_spec.rb +2 -2
  130. data/spec/models/create_live_stream_request_spec.rb +6 -0
  131. data/spec/models/dimension_value_spec.rb +40 -0
  132. data/spec/models/disable_live_stream_response_spec.rb +34 -0
  133. data/spec/models/enable_live_stream_response_spec.rb +34 -0
  134. data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
  135. data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
  136. data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
  137. data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
  138. data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
  139. data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
  140. data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
  141. data/spec/models/incident_breakdown_spec.rb +46 -0
  142. data/spec/models/incident_notification_rule_spec.rb +58 -0
  143. data/spec/models/incident_notification_spec.rb +46 -0
  144. data/spec/models/incident_response_spec.rb +40 -0
  145. data/spec/models/incident_spec.rb +154 -0
  146. data/spec/models/input_settings_spec.rb +12 -0
  147. data/spec/models/list_dimension_values_response_spec.rb +46 -0
  148. data/spec/models/list_dimensions_response_spec.rb +46 -0
  149. data/spec/models/list_incidents_response_spec.rb +46 -0
  150. data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
  151. data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
  152. data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
  153. data/spec/models/list_related_incidents_response_spec.rb +46 -0
  154. data/spec/models/notification_rule_spec.rb +46 -0
  155. data/spec/models/real_time_breakdown_value_spec.rb +58 -0
  156. data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
  157. data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
  158. data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
  159. data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
  160. data/spec/models/track_spec.rb +4 -0
  161. data/spec/models/video_view_spec.rb +12 -0
  162. metadata +200 -60
@@ -13,7 +13,7 @@ module MuxRuby
13
13
  @api_client = api_client
14
14
  end
15
15
  # Lists values for a specific filter
16
- # Lists the values for a filter along with a total count of related views
16
+ # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
17
17
  # @param filter_id ID of the Filter
18
18
  # @param [Hash] opts the optional parameters
19
19
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
@@ -27,7 +27,7 @@ module MuxRuby
27
27
  end
28
28
 
29
29
  # Lists values for a specific filter
30
- # Lists the values for a filter along with a total count of related views
30
+ # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
31
31
  # @param filter_id ID of the Filter
32
32
  # @param [Hash] opts the optional parameters
33
33
  # @option opts [Integer] :limit Number of items to include in the response
@@ -78,7 +78,7 @@ module MuxRuby
78
78
  end
79
79
 
80
80
  # List Filters
81
- # Lists all the filters broken out into basic and advanced
81
+ # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
82
82
  # @param [Hash] opts the optional parameters
83
83
  # @return [ListFiltersResponse]
84
84
  def list_filters(opts = {})
@@ -87,7 +87,7 @@ module MuxRuby
87
87
  end
88
88
 
89
89
  # List Filters
90
- # Lists all the filters broken out into basic and advanced
90
+ # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
91
91
  # @param [Hash] opts the optional parameters
92
92
  # @return [Array<(ListFiltersResponse, Fixnum, Hash)>] ListFiltersResponse data, response status code and response headers
93
93
  def list_filters_with_http_info(opts = {})
@@ -0,0 +1,217 @@
1
+ =begin
2
+ # Mux Ruby - Copyright 2019 Mux Inc.
3
+ # NOTE: This file is auto generated. Do not edit this file manually.
4
+ =end
5
+
6
+ require 'uri'
7
+
8
+ module MuxRuby
9
+ class IncidentsApi
10
+ attr_accessor :api_client
11
+
12
+ def initialize(api_client = ApiClient.default)
13
+ @api_client = api_client
14
+ end
15
+ # Get an Incident
16
+ # Returns the details of an incident
17
+ # @param incident_id ID of the Incident
18
+ # @param [Hash] opts the optional parameters
19
+ # @return [IncidentResponse]
20
+ def get_incident(incident_id, opts = {})
21
+ data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
22
+ data
23
+ end
24
+
25
+ # Get an Incident
26
+ # Returns the details of an incident
27
+ # @param incident_id ID of the Incident
28
+ # @param [Hash] opts the optional parameters
29
+ # @return [Array<(IncidentResponse, Fixnum, Hash)>] IncidentResponse data, response status code and response headers
30
+ def get_incident_with_http_info(incident_id, opts = {})
31
+ if @api_client.config.debugging
32
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.get_incident ...'
33
+ end
34
+ # verify the required parameter 'incident_id' is set
35
+ if @api_client.config.client_side_validation && incident_id.nil?
36
+ fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.get_incident"
37
+ end
38
+ # resource path
39
+ local_var_path = '/data/v1/incidents/{INCIDENT_ID}'.sub('{' + 'INCIDENT_ID' + '}', incident_id.to_s)
40
+
41
+ # query parameters
42
+ query_params = {}
43
+
44
+ # header parameters
45
+ header_params = {}
46
+ # HTTP header 'Accept' (if needed)
47
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
48
+
49
+ # form parameters
50
+ form_params = {}
51
+
52
+ # http body (model)
53
+ post_body = nil
54
+ auth_names = ['accessToken']
55
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
56
+ :header_params => header_params,
57
+ :query_params => query_params,
58
+ :form_params => form_params,
59
+ :body => post_body,
60
+ :auth_names => auth_names,
61
+ :return_type => 'IncidentResponse')
62
+ if @api_client.config.debugging
63
+ @api_client.config.logger.debug "API called: IncidentsApi#get_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
64
+ end
65
+ return data, status_code, headers
66
+ end
67
+
68
+ # List Incidents
69
+ # Returns a list of incidents
70
+ # @param [Hash] opts the optional parameters
71
+ # @option opts [Integer] :limit Number of items to include in the response (default to 25)
72
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
73
+ # @option opts [String] :order_by Value to order the results by
74
+ # @option opts [String] :order_direction Sort order.
75
+ # @option opts [String] :status Status to filter incidents by
76
+ # @option opts [String] :severity Severity to filter incidents by
77
+ # @return [ListIncidentsResponse]
78
+ def list_incidents(opts = {})
79
+ data, _status_code, _headers = list_incidents_with_http_info(opts)
80
+ data
81
+ end
82
+
83
+ # List Incidents
84
+ # Returns a list of incidents
85
+ # @param [Hash] opts the optional parameters
86
+ # @option opts [Integer] :limit Number of items to include in the response
87
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
88
+ # @option opts [String] :order_by Value to order the results by
89
+ # @option opts [String] :order_direction Sort order.
90
+ # @option opts [String] :status Status to filter incidents by
91
+ # @option opts [String] :severity Severity to filter incidents by
92
+ # @return [Array<(ListIncidentsResponse, Fixnum, Hash)>] ListIncidentsResponse data, response status code and response headers
93
+ def list_incidents_with_http_info(opts = {})
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.list_incidents ...'
96
+ end
97
+ if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
98
+ fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
99
+ end
100
+ if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
101
+ fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
102
+ end
103
+ if @api_client.config.client_side_validation && opts[:'status'] && !['open', 'closed', 'expired'].include?(opts[:'status'])
104
+ fail ArgumentError, 'invalid value for "status", must be one of open, closed, expired'
105
+ end
106
+ if @api_client.config.client_side_validation && opts[:'severity'] && !['warning', 'alert'].include?(opts[:'severity'])
107
+ fail ArgumentError, 'invalid value for "severity", must be one of warning, alert'
108
+ end
109
+ # resource path
110
+ local_var_path = '/data/v1/incidents'
111
+
112
+ # query parameters
113
+ query_params = {}
114
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
115
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
116
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
117
+ query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
118
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
119
+ query_params[:'severity'] = opts[:'severity'] if !opts[:'severity'].nil?
120
+
121
+ # header parameters
122
+ header_params = {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
125
+
126
+ # form parameters
127
+ form_params = {}
128
+
129
+ # http body (model)
130
+ post_body = nil
131
+ auth_names = ['accessToken']
132
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => 'ListIncidentsResponse')
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: IncidentsApi#list_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ # List Related Incidents
146
+ # Returns all the incidents that seem related to a specific incident
147
+ # @param incident_id ID of the Incident
148
+ # @param [Hash] opts the optional parameters
149
+ # @option opts [Integer] :limit Number of items to include in the response (default to 25)
150
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
151
+ # @option opts [String] :order_by Value to order the results by
152
+ # @option opts [String] :order_direction Sort order.
153
+ # @return [ListRelatedIncidentsResponse]
154
+ def list_related_incidents(incident_id, opts = {})
155
+ data, _status_code, _headers = list_related_incidents_with_http_info(incident_id, opts)
156
+ data
157
+ end
158
+
159
+ # List Related Incidents
160
+ # Returns all the incidents that seem related to a specific incident
161
+ # @param incident_id ID of the Incident
162
+ # @param [Hash] opts the optional parameters
163
+ # @option opts [Integer] :limit Number of items to include in the response
164
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
165
+ # @option opts [String] :order_by Value to order the results by
166
+ # @option opts [String] :order_direction Sort order.
167
+ # @return [Array<(ListRelatedIncidentsResponse, Fixnum, Hash)>] ListRelatedIncidentsResponse data, response status code and response headers
168
+ def list_related_incidents_with_http_info(incident_id, opts = {})
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.list_related_incidents ...'
171
+ end
172
+ # verify the required parameter 'incident_id' is set
173
+ if @api_client.config.client_side_validation && incident_id.nil?
174
+ fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.list_related_incidents"
175
+ end
176
+ if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
177
+ fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
178
+ end
179
+ if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
180
+ fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
181
+ end
182
+ # resource path
183
+ local_var_path = '/data/v1/incidents/{INCIDENT_ID}/related'.sub('{' + 'INCIDENT_ID' + '}', incident_id.to_s)
184
+
185
+ # query parameters
186
+ query_params = {}
187
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
188
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
189
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
190
+ query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
191
+
192
+ # header parameters
193
+ header_params = {}
194
+ # HTTP header 'Accept' (if needed)
195
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
196
+
197
+ # form parameters
198
+ form_params = {}
199
+
200
+ # http body (model)
201
+ post_body = nil
202
+ auth_names = ['accessToken']
203
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
204
+ :header_params => header_params,
205
+ :query_params => query_params,
206
+ :form_params => form_params,
207
+ :body => post_body,
208
+ :auth_names => auth_names,
209
+ :return_type => 'ListRelatedIncidentsResponse')
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "API called: IncidentsApi#list_related_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ end
213
+ return data, status_code, headers
214
+ end
215
+
216
+ end
217
+ end
@@ -343,6 +343,112 @@ module MuxRuby
343
343
  return data, status_code, headers
344
344
  end
345
345
 
346
+ # Disable a live stream
347
+ # Disables a live stream, making it reject incoming RTMP streams until re-enabled.
348
+ # @param live_stream_id The live stream ID
349
+ # @param [Hash] opts the optional parameters
350
+ # @return [DisableLiveStreamResponse]
351
+ def disable_live_stream(live_stream_id, opts = {})
352
+ data, _status_code, _headers = disable_live_stream_with_http_info(live_stream_id, opts)
353
+ data
354
+ end
355
+
356
+ # Disable a live stream
357
+ # Disables a live stream, making it reject incoming RTMP streams until re-enabled.
358
+ # @param live_stream_id The live stream ID
359
+ # @param [Hash] opts the optional parameters
360
+ # @return [Array<(DisableLiveStreamResponse, Fixnum, Hash)>] DisableLiveStreamResponse data, response status code and response headers
361
+ def disable_live_stream_with_http_info(live_stream_id, opts = {})
362
+ if @api_client.config.debugging
363
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.disable_live_stream ...'
364
+ end
365
+ # verify the required parameter 'live_stream_id' is set
366
+ if @api_client.config.client_side_validation && live_stream_id.nil?
367
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.disable_live_stream"
368
+ end
369
+ # resource path
370
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/disable'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
371
+
372
+ # query parameters
373
+ query_params = {}
374
+
375
+ # header parameters
376
+ header_params = {}
377
+ # HTTP header 'Accept' (if needed)
378
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
379
+
380
+ # form parameters
381
+ form_params = {}
382
+
383
+ # http body (model)
384
+ post_body = nil
385
+ auth_names = ['accessToken']
386
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
387
+ :header_params => header_params,
388
+ :query_params => query_params,
389
+ :form_params => form_params,
390
+ :body => post_body,
391
+ :auth_names => auth_names,
392
+ :return_type => 'DisableLiveStreamResponse')
393
+ if @api_client.config.debugging
394
+ @api_client.config.logger.debug "API called: LiveStreamsApi#disable_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
395
+ end
396
+ return data, status_code, headers
397
+ end
398
+
399
+ # Enable a live stream
400
+ # Enables a live stream, allowing it to accept an incoming RTMP stream.
401
+ # @param live_stream_id The live stream ID
402
+ # @param [Hash] opts the optional parameters
403
+ # @return [EnableLiveStreamResponse]
404
+ def enable_live_stream(live_stream_id, opts = {})
405
+ data, _status_code, _headers = enable_live_stream_with_http_info(live_stream_id, opts)
406
+ data
407
+ end
408
+
409
+ # Enable a live stream
410
+ # Enables a live stream, allowing it to accept an incoming RTMP stream.
411
+ # @param live_stream_id The live stream ID
412
+ # @param [Hash] opts the optional parameters
413
+ # @return [Array<(EnableLiveStreamResponse, Fixnum, Hash)>] EnableLiveStreamResponse data, response status code and response headers
414
+ def enable_live_stream_with_http_info(live_stream_id, opts = {})
415
+ if @api_client.config.debugging
416
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.enable_live_stream ...'
417
+ end
418
+ # verify the required parameter 'live_stream_id' is set
419
+ if @api_client.config.client_side_validation && live_stream_id.nil?
420
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.enable_live_stream"
421
+ end
422
+ # resource path
423
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/enable'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
424
+
425
+ # query parameters
426
+ query_params = {}
427
+
428
+ # header parameters
429
+ header_params = {}
430
+ # HTTP header 'Accept' (if needed)
431
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
432
+
433
+ # form parameters
434
+ form_params = {}
435
+
436
+ # http body (model)
437
+ post_body = nil
438
+ auth_names = ['accessToken']
439
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
440
+ :header_params => header_params,
441
+ :query_params => query_params,
442
+ :form_params => form_params,
443
+ :body => post_body,
444
+ :auth_names => auth_names,
445
+ :return_type => 'EnableLiveStreamResponse')
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug "API called: LiveStreamsApi#enable_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
+ end
449
+ return data, status_code, headers
450
+ end
451
+
346
452
  # Retrieve a live stream
347
453
  # Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
348
454
  # @param live_stream_id The live stream ID
@@ -0,0 +1,69 @@
1
+ =begin
2
+ # Mux Ruby - Copyright 2019 Mux Inc.
3
+ # NOTE: This file is auto generated. Do not edit this file manually.
4
+ =end
5
+
6
+ require 'uri'
7
+
8
+ module MuxRuby
9
+ class PlaybackIDApi
10
+ attr_accessor :api_client
11
+
12
+ def initialize(api_client = ApiClient.default)
13
+ @api_client = api_client
14
+ end
15
+ # Retrieve an Asset or Live Stream ID
16
+ # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
17
+ # @param playback_id The live stream&#39;s playback ID.
18
+ # @param [Hash] opts the optional parameters
19
+ # @return [GetAssetOrLiveStreamIdResponse]
20
+ def get_asset_or_livestream_id(playback_id, opts = {})
21
+ data, _status_code, _headers = get_asset_or_livestream_id_with_http_info(playback_id, opts)
22
+ data
23
+ end
24
+
25
+ # Retrieve an Asset or Live Stream ID
26
+ # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
27
+ # @param playback_id The live stream&#39;s playback ID.
28
+ # @param [Hash] opts the optional parameters
29
+ # @return [Array<(GetAssetOrLiveStreamIdResponse, Fixnum, Hash)>] GetAssetOrLiveStreamIdResponse data, response status code and response headers
30
+ def get_asset_or_livestream_id_with_http_info(playback_id, opts = {})
31
+ if @api_client.config.debugging
32
+ @api_client.config.logger.debug 'Calling API: PlaybackIDApi.get_asset_or_livestream_id ...'
33
+ end
34
+ # verify the required parameter 'playback_id' is set
35
+ if @api_client.config.client_side_validation && playback_id.nil?
36
+ fail ArgumentError, "Missing the required parameter 'playback_id' when calling PlaybackIDApi.get_asset_or_livestream_id"
37
+ end
38
+ # resource path
39
+ local_var_path = '/video/v1/playback-ids/{PLAYBACK_ID}'.sub('{' + 'PLAYBACK_ID' + '}', playback_id.to_s)
40
+
41
+ # query parameters
42
+ query_params = {}
43
+
44
+ # header parameters
45
+ header_params = {}
46
+ # HTTP header 'Accept' (if needed)
47
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
48
+
49
+ # form parameters
50
+ form_params = {}
51
+
52
+ # http body (model)
53
+ post_body = nil
54
+ auth_names = ['accessToken']
55
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
56
+ :header_params => header_params,
57
+ :query_params => query_params,
58
+ :form_params => form_params,
59
+ :body => post_body,
60
+ :auth_names => auth_names,
61
+ :return_type => 'GetAssetOrLiveStreamIdResponse')
62
+ if @api_client.config.debugging
63
+ @api_client.config.logger.debug "API called: PlaybackIDApi#get_asset_or_livestream_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
64
+ end
65
+ return data, status_code, headers
66
+ end
67
+
68
+ end
69
+ end
@@ -0,0 +1,311 @@
1
+ =begin
2
+ # Mux Ruby - Copyright 2019 Mux Inc.
3
+ # NOTE: This file is auto generated. Do not edit this file manually.
4
+ =end
5
+
6
+ require 'uri'
7
+
8
+ module MuxRuby
9
+ class RealTimeApi
10
+ attr_accessor :api_client
11
+
12
+ def initialize(api_client = ApiClient.default)
13
+ @api_client = api_client
14
+ end
15
+ # Get Real-Time Breakdown
16
+ # 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
18
+ # @param [Hash] opts the optional parameters
19
+ # @option opts [String] :dimension Dimension the specified value belongs to
20
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
22
+ # @option opts [String] :order_by Value to order the results by
23
+ # @option opts [String] :order_direction Sort order.
24
+ # @return [GetRealTimeBreakdownResponse]
25
+ def get_realtime_breakdown(realtime_metric_id, opts = {})
26
+ data, _status_code, _headers = get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
27
+ data
28
+ end
29
+
30
+ # Get Real-Time Breakdown
31
+ # 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
33
+ # @param [Hash] opts the optional parameters
34
+ # @option opts [String] :dimension Dimension the specified value belongs to
35
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
37
+ # @option opts [String] :order_by Value to order the results by
38
+ # @option opts [String] :order_direction Sort order.
39
+ # @return [Array<(GetRealTimeBreakdownResponse, Fixnum, Hash)>] GetRealTimeBreakdownResponse data, response status code and response headers
40
+ def get_realtime_breakdown_with_http_info(realtime_metric_id, opts = {})
41
+ if @api_client.config.debugging
42
+ @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_breakdown ...'
43
+ end
44
+ # verify the required parameter 'realtime_metric_id' is set
45
+ if @api_client.config.client_side_validation && realtime_metric_id.nil?
46
+ fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_breakdown"
47
+ end
48
+ # verify enum value
49
+ if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
50
+ fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
51
+ end
52
+ if @api_client.config.client_side_validation && opts[:'dimension'] && !['asn', 'cdn', 'country', 'operating_system', 'player_name', 'region', 'stream_type', 'sub_property_id', 'video_series', 'video_title'].include?(opts[:'dimension'])
53
+ fail ArgumentError, 'invalid value for "dimension", must be one of asn, cdn, country, operating_system, player_name, region, stream_type, sub_property_id, video_series, video_title'
54
+ end
55
+ if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
56
+ fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
57
+ end
58
+ if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
59
+ fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
60
+ end
61
+ # resource path
62
+ local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
63
+
64
+ # query parameters
65
+ query_params = {}
66
+ query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
67
+ query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
68
+ query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
69
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
70
+ query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
71
+
72
+ # header parameters
73
+ header_params = {}
74
+ # HTTP header 'Accept' (if needed)
75
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
76
+
77
+ # form parameters
78
+ form_params = {}
79
+
80
+ # http body (model)
81
+ post_body = nil
82
+ auth_names = ['accessToken']
83
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
84
+ :header_params => header_params,
85
+ :query_params => query_params,
86
+ :form_params => form_params,
87
+ :body => post_body,
88
+ :auth_names => auth_names,
89
+ :return_type => 'GetRealTimeBreakdownResponse')
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
+ end
93
+ return data, status_code, headers
94
+ end
95
+
96
+ # Get Real-Time Histogram Timeseries
97
+ # Gets histogram timeseries information for a specific metric.
98
+ # @param realtime_metric_id ID of the Realtime Metric
99
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
101
+ # @return [GetRealTimeHistogramTimeseriesResponse]
102
+ def get_realtime_histogram_timeseries(realtime_metric_id, opts = {})
103
+ data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_metric_id, opts)
104
+ data
105
+ end
106
+
107
+ # Get Real-Time Histogram Timeseries
108
+ # Gets histogram timeseries information for a specific metric.
109
+ # @param realtime_metric_id ID of the Realtime Metric
110
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
112
+ # @return [Array<(GetRealTimeHistogramTimeseriesResponse, Fixnum, Hash)>] GetRealTimeHistogramTimeseriesResponse data, response status code and response headers
113
+ def get_realtime_histogram_timeseries_with_http_info(realtime_metric_id, opts = {})
114
+ if @api_client.config.debugging
115
+ @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_histogram_timeseries ...'
116
+ end
117
+ # verify the required parameter 'realtime_metric_id' is set
118
+ if @api_client.config.client_side_validation && realtime_metric_id.nil?
119
+ fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_histogram_timeseries"
120
+ end
121
+ # verify enum value
122
+ if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
123
+ fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
124
+ end
125
+ # resource path
126
+ local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/histogram-timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
127
+
128
+ # query parameters
129
+ query_params = {}
130
+ query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
131
+
132
+ # header parameters
133
+ header_params = {}
134
+ # HTTP header 'Accept' (if needed)
135
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
136
+
137
+ # form parameters
138
+ form_params = {}
139
+
140
+ # http body (model)
141
+ post_body = nil
142
+ auth_names = ['accessToken']
143
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
144
+ :header_params => header_params,
145
+ :query_params => query_params,
146
+ :form_params => form_params,
147
+ :body => post_body,
148
+ :auth_names => auth_names,
149
+ :return_type => 'GetRealTimeHistogramTimeseriesResponse')
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_histogram_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Get Real-Time Timeseries
157
+ # 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
159
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
161
+ # @return [GetRealTimeTimeseriesResponse]
162
+ def get_realtime_timeseries(realtime_metric_id, opts = {})
163
+ data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
164
+ data
165
+ end
166
+
167
+ # Get Real-Time Timeseries
168
+ # 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
170
+ # @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[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.
172
+ # @return [Array<(GetRealTimeTimeseriesResponse, Fixnum, Hash)>] GetRealTimeTimeseriesResponse data, response status code and response headers
173
+ def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_timeseries ...'
176
+ end
177
+ # verify the required parameter 'realtime_metric_id' is set
178
+ if @api_client.config.client_side_validation && realtime_metric_id.nil?
179
+ fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_timeseries"
180
+ end
181
+ # verify enum value
182
+ if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
183
+ fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
184
+ end
185
+ # resource path
186
+ local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
187
+
188
+ # query parameters
189
+ query_params = {}
190
+ query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
191
+
192
+ # header parameters
193
+ header_params = {}
194
+ # HTTP header 'Accept' (if needed)
195
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
196
+
197
+ # form parameters
198
+ form_params = {}
199
+
200
+ # http body (model)
201
+ post_body = nil
202
+ auth_names = ['accessToken']
203
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
204
+ :header_params => header_params,
205
+ :query_params => query_params,
206
+ :form_params => form_params,
207
+ :body => post_body,
208
+ :auth_names => auth_names,
209
+ :return_type => 'GetRealTimeTimeseriesResponse')
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ end
213
+ return data, status_code, headers
214
+ end
215
+
216
+ # List Real-Time Dimensions
217
+ # Lists availiable real-time dimensions
218
+ # @param [Hash] opts the optional parameters
219
+ # @return [ListRealTimeDimensionsResponse]
220
+ def list_realtime_dimensions(opts = {})
221
+ data, _status_code, _headers = list_realtime_dimensions_with_http_info(opts)
222
+ data
223
+ end
224
+
225
+ # List Real-Time Dimensions
226
+ # Lists availiable real-time dimensions
227
+ # @param [Hash] opts the optional parameters
228
+ # @return [Array<(ListRealTimeDimensionsResponse, Fixnum, Hash)>] ListRealTimeDimensionsResponse data, response status code and response headers
229
+ def list_realtime_dimensions_with_http_info(opts = {})
230
+ if @api_client.config.debugging
231
+ @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_dimensions ...'
232
+ end
233
+ # resource path
234
+ local_var_path = '/data/v1/realtime/dimensions'
235
+
236
+ # query parameters
237
+ query_params = {}
238
+
239
+ # header parameters
240
+ header_params = {}
241
+ # HTTP header 'Accept' (if needed)
242
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
243
+
244
+ # form parameters
245
+ form_params = {}
246
+
247
+ # http body (model)
248
+ post_body = nil
249
+ auth_names = ['accessToken']
250
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
251
+ :header_params => header_params,
252
+ :query_params => query_params,
253
+ :form_params => form_params,
254
+ :body => post_body,
255
+ :auth_names => auth_names,
256
+ :return_type => 'ListRealTimeDimensionsResponse')
257
+ if @api_client.config.debugging
258
+ @api_client.config.logger.debug "API called: RealTimeApi#list_realtime_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
259
+ end
260
+ return data, status_code, headers
261
+ end
262
+
263
+ # List Real-Time Metrics
264
+ # Lists availiable real-time metrics.
265
+ # @param [Hash] opts the optional parameters
266
+ # @return [ListRealTimeMetricsResponse]
267
+ def list_realtime_metrics(opts = {})
268
+ data, _status_code, _headers = list_realtime_metrics_with_http_info(opts)
269
+ data
270
+ end
271
+
272
+ # List Real-Time Metrics
273
+ # Lists availiable real-time metrics.
274
+ # @param [Hash] opts the optional parameters
275
+ # @return [Array<(ListRealTimeMetricsResponse, Fixnum, Hash)>] ListRealTimeMetricsResponse data, response status code and response headers
276
+ def list_realtime_metrics_with_http_info(opts = {})
277
+ if @api_client.config.debugging
278
+ @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_metrics ...'
279
+ end
280
+ # resource path
281
+ local_var_path = '/data/v1/realtime/metrics'
282
+
283
+ # query parameters
284
+ query_params = {}
285
+
286
+ # header parameters
287
+ header_params = {}
288
+ # HTTP header 'Accept' (if needed)
289
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
290
+
291
+ # form parameters
292
+ form_params = {}
293
+
294
+ # http body (model)
295
+ post_body = nil
296
+ auth_names = ['accessToken']
297
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => 'ListRealTimeMetricsResponse')
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "API called: RealTimeApi#list_realtime_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ end
307
+ return data, status_code, headers
308
+ end
309
+
310
+ end
311
+ end