mux_ruby 1.6.0 → 2.0.0.pre.rc.2
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 +37 -13
- data/docs/AbridgedVideoView.md +33 -13
- data/docs/Asset.md +59 -23
- data/docs/AssetErrors.md +15 -4
- data/docs/AssetMaster.md +15 -4
- data/docs/AssetNonStandardInputReasons.md +34 -0
- data/docs/AssetRecordingTimes.md +20 -0
- data/docs/AssetResponse.md +13 -3
- data/docs/AssetStaticRenditions.md +15 -4
- data/docs/AssetStaticRenditionsFiles.md +23 -8
- data/docs/AssetsApi.md +396 -161
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +27 -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 +41 -23
- data/docs/DimensionValue.md +20 -0
- data/docs/DimensionsApi.md +156 -0
- data/docs/DirectUploadsApi.md +131 -56
- data/docs/DisableLiveStreamResponse.md +18 -0
- data/docs/EnableLiveStreamResponse.md +18 -0
- data/docs/Error.md +27 -10
- data/docs/ErrorsApi.md +38 -20
- data/docs/ExportsApi.md +33 -14
- data/docs/FilterValue.md +15 -4
- data/docs/FiltersApi.md +73 -35
- data/docs/GetAssetInputInfoResponse.md +13 -3
- data/docs/GetAssetOrLiveStreamIdResponse.md +18 -0
- data/docs/GetAssetOrLiveStreamIdResponseData.md +22 -0
- data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +20 -0
- data/docs/GetAssetPlaybackIDResponse.md +13 -3
- data/docs/GetMetricTimeseriesDataResponse.md +17 -5
- data/docs/GetOverallValuesResponse.md +17 -5
- data/docs/GetRealTimeBreakdownResponse.md +22 -0
- data/docs/GetRealTimeHistogramTimeseriesResponse.md +24 -0
- data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +18 -0
- data/docs/GetRealTimeTimeseriesResponse.md +22 -0
- data/docs/Incident.md +58 -0
- data/docs/IncidentBreakdown.md +22 -0
- data/docs/IncidentNotification.md +22 -0
- data/docs/IncidentNotificationRule.md +26 -0
- data/docs/IncidentResponse.md +20 -0
- data/docs/IncidentsApi.md +242 -0
- data/docs/InputFile.md +15 -4
- data/docs/InputInfo.md +15 -4
- data/docs/InputSettings.md +31 -10
- 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 +22 -0
- data/docs/ListDimensionsResponse.md +22 -0
- 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 +22 -0
- data/docs/ListInsightsResponse.md +17 -5
- data/docs/ListLiveStreamsResponse.md +13 -3
- data/docs/ListRealTimeDimensionsResponse.md +22 -0
- data/docs/ListRealTimeDimensionsResponseData.md +20 -0
- data/docs/ListRealTimeMetricsResponse.md +22 -0
- data/docs/ListRelatedIncidentsResponse.md +22 -0
- data/docs/ListSigningKeysResponse.md +13 -3
- data/docs/ListUploadsResponse.md +13 -3
- data/docs/ListVideoViewsResponse.md +17 -5
- data/docs/LiveStream.md +39 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +497 -145
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +211 -117
- data/docs/NotificationRule.md +22 -0
- data/docs/OverallValues.md +19 -6
- data/docs/PlaybackID.md +15 -4
- data/docs/PlaybackIDApi.md +78 -0
- data/docs/PlaybackPolicy.md +10 -2
- data/docs/RealTimeApi.md +376 -0
- data/docs/RealTimeBreakdownValue.md +26 -0
- data/docs/RealTimeHistogramTimeseriesBucket.md +20 -0
- data/docs/RealTimeHistogramTimeseriesBucketValues.md +20 -0
- data/docs/RealTimeHistogramTimeseriesDatapoint.md +30 -0
- data/docs/RealTimeTimeseriesDatapoint.md +22 -0
- 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 +130 -54
- 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 +251 -114
- data/docs/VideoViewEvent.md +19 -6
- data/docs/VideoViewResponse.md +15 -4
- data/docs/VideoViewsApi.md +78 -41
- data/examples/data/exercise-dimensions.rb +29 -0
- data/examples/data/exercise-incidents.rb +29 -0
- data/examples/data/exercise-realtime.rb +60 -0
- data/examples/video/exercise-assets.rb +21 -0
- data/examples/video/exercise-live-streams.rb +30 -0
- 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 +43 -2
- data/lib/mux_ruby/api/assets_api.rb +291 -152
- data/lib/mux_ruby/api/delivery_usage_api.rb +32 -16
- data/lib/mux_ruby/api/dimensions_api.rb +154 -0
- data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
- data/lib/mux_ruby/api/errors_api.rb +34 -18
- data/lib/mux_ruby/api/exports_api.rb +30 -14
- data/lib/mux_ruby/api/filters_api.rb +57 -31
- data/lib/mux_ruby/api/incidents_api.rb +259 -0
- data/lib/mux_ruby/api/live_streams_api.rb +381 -133
- data/lib/mux_ruby/api/metrics_api.rb +185 -114
- data/lib/mux_ruby/api/playback_id_api.rb +85 -0
- data/lib/mux_ruby/api/real_time_api.rb +373 -0
- data/lib/mux_ruby/api/url_signing_keys_api.rb +95 -48
- data/lib/mux_ruby/api/video_views_api.rb +60 -33
- data/lib/mux_ruby/api_client.rb +106 -91
- 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 +157 -53
- data/lib/mux_ruby/models/asset_errors.rb +52 -15
- data/lib/mux_ruby/models/asset_master.rb +85 -15
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +370 -0
- data/lib/mux_ruby/models/asset_recording_times.rb +229 -0
- data/lib/mux_ruby/models/asset_response.rb +48 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +55 -19
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +60 -25
- data/lib/mux_ruby/models/breakdown_value.rb +52 -18
- data/lib/mux_ruby/models/create_asset_request.rb +70 -30
- data/lib/mux_ruby/models/create_live_stream_request.rb +68 -23
- 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 +65 -27
- 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 +227 -0
- data/lib/mux_ruby/models/disable_live_stream_response.rb +218 -0
- data/lib/mux_ruby/models/enable_live_stream_response.rb +218 -0
- 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 +218 -0
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +237 -0
- data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +264 -0
- 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 +240 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +249 -0
- data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +220 -0
- data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +240 -0
- data/lib/mux_ruby/models/incident.rb +404 -0
- data/lib/mux_ruby/models/incident_breakdown.rb +236 -0
- data/lib/mux_ruby/models/incident_notification.rb +236 -0
- data/lib/mux_ruby/models/incident_notification_rule.rb +256 -0
- data/lib/mux_ruby/models/incident_response.rb +229 -0
- 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 +91 -30
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +68 -26
- 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 +240 -0
- data/lib/mux_ruby/models/list_dimensions_response.rb +238 -0
- 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 +240 -0
- 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 +240 -0
- data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +227 -0
- data/lib/mux_ruby/models/list_real_time_metrics_response.rb +240 -0
- data/lib/mux_ruby/models/list_related_incidents_response.rb +240 -0
- 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 +121 -29
- 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 +236 -0
- data/lib/mux_ruby/models/overall_values.rb +51 -17
- data/lib/mux_ruby/models/playback_id.rb +50 -15
- data/lib/mux_ruby/models/playback_policy.rb +12 -6
- data/lib/mux_ruby/models/real_time_breakdown_value.rb +254 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +227 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +227 -0
- data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +274 -0
- data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +236 -0
- 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 +55 -21
- data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
- data/lib/mux_ruby/models/track.rb +92 -33
- data/lib/mux_ruby/models/update_asset_master_access_request.rb +51 -17
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +51 -17
- data/lib/mux_ruby/models/upload.rb +62 -26
- 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 +242 -136
- 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 -15
- data/spec/api/assets_api_spec.rb +2 -0
- data/spec/api/dimensions_api_spec.rb +55 -0
- data/spec/api/filters_api_spec.rb +2 -2
- data/spec/api/incidents_api_spec.rb +73 -0
- data/spec/api/live_streams_api_spec.rb +24 -0
- data/spec/api/playback_id_api_spec.rb +40 -0
- data/spec/api/real_time_api_spec.rb +93 -0
- data/spec/api_client_spec.rb +10 -3
- data/spec/configuration_spec.rb +9 -2
- data/spec/models/asset_master_spec.rb +4 -0
- data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
- data/spec/models/asset_recording_times_spec.rb +40 -0
- data/spec/models/asset_spec.rb +26 -0
- data/spec/models/dimension_value_spec.rb +40 -0
- data/spec/models/disable_live_stream_response_spec.rb +34 -0
- data/spec/models/enable_live_stream_response_spec.rb +34 -0
- data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
- data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
- data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
- data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
- data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
- data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
- data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
- data/spec/models/incident_breakdown_spec.rb +46 -0
- data/spec/models/incident_notification_rule_spec.rb +58 -0
- data/spec/models/incident_notification_spec.rb +46 -0
- data/spec/models/incident_response_spec.rb +40 -0
- data/spec/models/incident_spec.rb +154 -0
- data/spec/models/input_settings_spec.rb +12 -0
- data/spec/models/list_dimension_values_response_spec.rb +46 -0
- data/spec/models/list_dimensions_response_spec.rb +46 -0
- data/spec/models/list_incidents_response_spec.rb +46 -0
- data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
- data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
- data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
- data/spec/models/list_related_incidents_response_spec.rb +46 -0
- data/spec/models/notification_rule_spec.rb +46 -0
- data/spec/models/real_time_breakdown_value_spec.rb +58 -0
- data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
- data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
- data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
- data/spec/models/track_spec.rb +4 -0
- data/spec/spec_helper.rb +9 -2
- metadata +246 -209
@@ -0,0 +1,22 @@
|
|
1
|
+
# MuxRuby::NotificationRule
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **value** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **id** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'mux_ruby'
|
15
|
+
|
16
|
+
instance = MuxRuby::NotificationRule.new(
|
17
|
+
value: null,
|
18
|
+
name: null,
|
19
|
+
id: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/OverallValues.md
CHANGED
@@ -1,11 +1,24 @@
|
|
1
1
|
# MuxRuby::OverallValues
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Float** | | [optional]
|
7
|
-
**total_watch_time** | **Integer** | | [optional]
|
8
|
-
**total_views** | **Integer** | | [optional]
|
9
|
-
**global_value** | **Float** | | [optional]
|
10
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **value** | **Float** | | [optional] |
|
8
|
+
| **total_watch_time** | **Integer** | | [optional] |
|
9
|
+
| **total_views** | **Integer** | | [optional] |
|
10
|
+
| **global_value** | **Float** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'mux_ruby'
|
16
|
+
|
17
|
+
instance = MuxRuby::OverallValues.new(
|
18
|
+
value: null,
|
19
|
+
total_watch_time: null,
|
20
|
+
total_views: null,
|
21
|
+
global_value: null
|
22
|
+
)
|
23
|
+
```
|
11
24
|
|
data/docs/PlaybackID.md
CHANGED
@@ -1,9 +1,20 @@
|
|
1
1
|
# MuxRuby::PlaybackID
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **String** | | [optional]
|
7
|
-
**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional]
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the PlaybackID | [optional] |
|
8
|
+
| **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::PlaybackID.new(
|
16
|
+
id: null,
|
17
|
+
policy: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# MuxRuby::PlaybackIDApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an Asset or Live Stream ID |
|
8
|
+
|
9
|
+
|
10
|
+
## get_asset_or_livestream_id
|
11
|
+
|
12
|
+
> <GetAssetOrLiveStreamIdResponse> get_asset_or_livestream_id(playback_id)
|
13
|
+
|
14
|
+
Retrieve an Asset or Live Stream ID
|
15
|
+
|
16
|
+
Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'mux_ruby'
|
23
|
+
# setup authorization
|
24
|
+
MuxRuby.configure do |config|
|
25
|
+
# Configure HTTP basic authorization: accessToken
|
26
|
+
config.username = 'YOUR USERNAME'
|
27
|
+
config.password = 'YOUR PASSWORD'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = MuxRuby::PlaybackIDApi.new
|
31
|
+
playback_id = 'playback_id_example' # String | The live stream's playback ID.
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Retrieve an Asset or Live Stream ID
|
35
|
+
result = api_instance.get_asset_or_livestream_id(playback_id)
|
36
|
+
p result
|
37
|
+
rescue MuxRuby::ApiError => e
|
38
|
+
puts "Error when calling PlaybackIDApi->get_asset_or_livestream_id: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the get_asset_or_livestream_id_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<GetAssetOrLiveStreamIdResponse>, Integer, Hash)> get_asset_or_livestream_id_with_http_info(playback_id)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Retrieve an Asset or Live Stream ID
|
51
|
+
data, status_code, headers = api_instance.get_asset_or_livestream_id_with_http_info(playback_id)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <GetAssetOrLiveStreamIdResponse>
|
55
|
+
rescue MuxRuby::ApiError => e
|
56
|
+
puts "Error when calling PlaybackIDApi->get_asset_or_livestream_id_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **playback_id** | **String** | The live stream's playback ID. | |
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
[**GetAssetOrLiveStreamIdResponse**](GetAssetOrLiveStreamIdResponse.md)
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
[accessToken](../README.md#accessToken)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: Not defined
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
data/docs/PlaybackPolicy.md
CHANGED
@@ -1,7 +1,15 @@
|
|
1
1
|
# MuxRuby::PlaybackPolicy
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'mux_ruby'
|
12
|
+
|
13
|
+
instance = MuxRuby::PlaybackPolicy.new()
|
14
|
+
```
|
7
15
|
|
data/docs/RealTimeApi.md
ADDED
@@ -0,0 +1,376 @@
|
|
1
|
+
# MuxRuby::RealTimeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_realtime_breakdown**](RealTimeApi.md#get_realtime_breakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown |
|
8
|
+
| [**get_realtime_histogram_timeseries**](RealTimeApi.md#get_realtime_histogram_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries |
|
9
|
+
| [**get_realtime_timeseries**](RealTimeApi.md#get_realtime_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries |
|
10
|
+
| [**list_realtime_dimensions**](RealTimeApi.md#list_realtime_dimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions |
|
11
|
+
| [**list_realtime_metrics**](RealTimeApi.md#list_realtime_metrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics |
|
12
|
+
|
13
|
+
|
14
|
+
## get_realtime_breakdown
|
15
|
+
|
16
|
+
> <GetRealTimeBreakdownResponse> get_realtime_breakdown(realtime_metric_id, opts)
|
17
|
+
|
18
|
+
Get Real-Time Breakdown
|
19
|
+
|
20
|
+
Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'mux_ruby'
|
27
|
+
# setup authorization
|
28
|
+
MuxRuby.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: accessToken
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MuxRuby::RealTimeApi.new
|
35
|
+
realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
|
36
|
+
opts = {
|
37
|
+
dimension: 'asn', # String | Dimension the specified value belongs to
|
38
|
+
timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
39
|
+
filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
40
|
+
order_by: 'negative_impact', # String | Value to order the results by
|
41
|
+
order_direction: 'asc' # String | Sort order.
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
# Get Real-Time Breakdown
|
46
|
+
result = api_instance.get_realtime_breakdown(realtime_metric_id, opts)
|
47
|
+
p result
|
48
|
+
rescue MuxRuby::ApiError => e
|
49
|
+
puts "Error when calling RealTimeApi->get_realtime_breakdown: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
#### Using the get_realtime_breakdown_with_http_info variant
|
54
|
+
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
56
|
+
|
57
|
+
> <Array(<GetRealTimeBreakdownResponse>, Integer, Hash)> get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
begin
|
61
|
+
# Get Real-Time Breakdown
|
62
|
+
data, status_code, headers = api_instance.get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
|
63
|
+
p status_code # => 2xx
|
64
|
+
p headers # => { ... }
|
65
|
+
p data # => <GetRealTimeBreakdownResponse>
|
66
|
+
rescue MuxRuby::ApiError => e
|
67
|
+
puts "Error when calling RealTimeApi->get_realtime_breakdown_with_http_info: #{e}"
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
| Name | Type | Description | Notes |
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
75
|
+
| **realtime_metric_id** | **String** | ID of the Realtime Metric | |
|
76
|
+
| **dimension** | **String** | Dimension the specified value belongs to | [optional] |
|
77
|
+
| **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
|
78
|
+
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
79
|
+
| **order_by** | **String** | Value to order the results by | [optional] |
|
80
|
+
| **order_direction** | **String** | Sort order. | [optional] |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**GetRealTimeBreakdownResponse**](GetRealTimeBreakdownResponse.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[accessToken](../README.md#accessToken)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
96
|
+
## get_realtime_histogram_timeseries
|
97
|
+
|
98
|
+
> <GetRealTimeHistogramTimeseriesResponse> get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts)
|
99
|
+
|
100
|
+
Get Real-Time Histogram Timeseries
|
101
|
+
|
102
|
+
Gets histogram timeseries information for a specific metric.
|
103
|
+
|
104
|
+
### Examples
|
105
|
+
|
106
|
+
```ruby
|
107
|
+
require 'time'
|
108
|
+
require 'mux_ruby'
|
109
|
+
# setup authorization
|
110
|
+
MuxRuby.configure do |config|
|
111
|
+
# Configure HTTP basic authorization: accessToken
|
112
|
+
config.username = 'YOUR USERNAME'
|
113
|
+
config.password = 'YOUR PASSWORD'
|
114
|
+
end
|
115
|
+
|
116
|
+
api_instance = MuxRuby::RealTimeApi.new
|
117
|
+
realtime_histogram_metric_id = 'video-startup-time' # String | ID of the Realtime Histogram Metric
|
118
|
+
opts = {
|
119
|
+
filters: ['inner_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
120
|
+
}
|
121
|
+
|
122
|
+
begin
|
123
|
+
# Get Real-Time Histogram Timeseries
|
124
|
+
result = api_instance.get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts)
|
125
|
+
p result
|
126
|
+
rescue MuxRuby::ApiError => e
|
127
|
+
puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
#### Using the get_realtime_histogram_timeseries_with_http_info variant
|
132
|
+
|
133
|
+
This returns an Array which contains the response data, status code and headers.
|
134
|
+
|
135
|
+
> <Array(<GetRealTimeHistogramTimeseriesResponse>, Integer, Hash)> get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
|
136
|
+
|
137
|
+
```ruby
|
138
|
+
begin
|
139
|
+
# Get Real-Time Histogram Timeseries
|
140
|
+
data, status_code, headers = api_instance.get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
|
141
|
+
p status_code # => 2xx
|
142
|
+
p headers # => { ... }
|
143
|
+
p data # => <GetRealTimeHistogramTimeseriesResponse>
|
144
|
+
rescue MuxRuby::ApiError => e
|
145
|
+
puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries_with_http_info: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
### Parameters
|
150
|
+
|
151
|
+
| Name | Type | Description | Notes |
|
152
|
+
| ---- | ---- | ----------- | ----- |
|
153
|
+
| **realtime_histogram_metric_id** | **String** | ID of the Realtime Histogram Metric | |
|
154
|
+
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
155
|
+
|
156
|
+
### Return type
|
157
|
+
|
158
|
+
[**GetRealTimeHistogramTimeseriesResponse**](GetRealTimeHistogramTimeseriesResponse.md)
|
159
|
+
|
160
|
+
### Authorization
|
161
|
+
|
162
|
+
[accessToken](../README.md#accessToken)
|
163
|
+
|
164
|
+
### HTTP request headers
|
165
|
+
|
166
|
+
- **Content-Type**: Not defined
|
167
|
+
- **Accept**: application/json
|
168
|
+
|
169
|
+
|
170
|
+
## get_realtime_timeseries
|
171
|
+
|
172
|
+
> <GetRealTimeTimeseriesResponse> get_realtime_timeseries(realtime_metric_id, opts)
|
173
|
+
|
174
|
+
Get Real-Time Timeseries
|
175
|
+
|
176
|
+
Gets Time series information for a specific metric along with the number of concurrent viewers.
|
177
|
+
|
178
|
+
### Examples
|
179
|
+
|
180
|
+
```ruby
|
181
|
+
require 'time'
|
182
|
+
require 'mux_ruby'
|
183
|
+
# setup authorization
|
184
|
+
MuxRuby.configure do |config|
|
185
|
+
# Configure HTTP basic authorization: accessToken
|
186
|
+
config.username = 'YOUR USERNAME'
|
187
|
+
config.password = 'YOUR PASSWORD'
|
188
|
+
end
|
189
|
+
|
190
|
+
api_instance = MuxRuby::RealTimeApi.new
|
191
|
+
realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
|
192
|
+
opts = {
|
193
|
+
filters: ['inner_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
|
194
|
+
}
|
195
|
+
|
196
|
+
begin
|
197
|
+
# Get Real-Time Timeseries
|
198
|
+
result = api_instance.get_realtime_timeseries(realtime_metric_id, opts)
|
199
|
+
p result
|
200
|
+
rescue MuxRuby::ApiError => e
|
201
|
+
puts "Error when calling RealTimeApi->get_realtime_timeseries: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
#### Using the get_realtime_timeseries_with_http_info variant
|
206
|
+
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
208
|
+
|
209
|
+
> <Array(<GetRealTimeTimeseriesResponse>, Integer, Hash)> get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
|
210
|
+
|
211
|
+
```ruby
|
212
|
+
begin
|
213
|
+
# Get Real-Time Timeseries
|
214
|
+
data, status_code, headers = api_instance.get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
|
215
|
+
p status_code # => 2xx
|
216
|
+
p headers # => { ... }
|
217
|
+
p data # => <GetRealTimeTimeseriesResponse>
|
218
|
+
rescue MuxRuby::ApiError => e
|
219
|
+
puts "Error when calling RealTimeApi->get_realtime_timeseries_with_http_info: #{e}"
|
220
|
+
end
|
221
|
+
```
|
222
|
+
|
223
|
+
### Parameters
|
224
|
+
|
225
|
+
| Name | Type | Description | Notes |
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
227
|
+
| **realtime_metric_id** | **String** | ID of the Realtime Metric | |
|
228
|
+
| **filters** | [**Array<String>**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
|
229
|
+
|
230
|
+
### Return type
|
231
|
+
|
232
|
+
[**GetRealTimeTimeseriesResponse**](GetRealTimeTimeseriesResponse.md)
|
233
|
+
|
234
|
+
### Authorization
|
235
|
+
|
236
|
+
[accessToken](../README.md#accessToken)
|
237
|
+
|
238
|
+
### HTTP request headers
|
239
|
+
|
240
|
+
- **Content-Type**: Not defined
|
241
|
+
- **Accept**: application/json
|
242
|
+
|
243
|
+
|
244
|
+
## list_realtime_dimensions
|
245
|
+
|
246
|
+
> <ListRealTimeDimensionsResponse> list_realtime_dimensions
|
247
|
+
|
248
|
+
List Real-Time Dimensions
|
249
|
+
|
250
|
+
Lists availiable real-time dimensions.
|
251
|
+
|
252
|
+
### Examples
|
253
|
+
|
254
|
+
```ruby
|
255
|
+
require 'time'
|
256
|
+
require 'mux_ruby'
|
257
|
+
# setup authorization
|
258
|
+
MuxRuby.configure do |config|
|
259
|
+
# Configure HTTP basic authorization: accessToken
|
260
|
+
config.username = 'YOUR USERNAME'
|
261
|
+
config.password = 'YOUR PASSWORD'
|
262
|
+
end
|
263
|
+
|
264
|
+
api_instance = MuxRuby::RealTimeApi.new
|
265
|
+
|
266
|
+
begin
|
267
|
+
# List Real-Time Dimensions
|
268
|
+
result = api_instance.list_realtime_dimensions
|
269
|
+
p result
|
270
|
+
rescue MuxRuby::ApiError => e
|
271
|
+
puts "Error when calling RealTimeApi->list_realtime_dimensions: #{e}"
|
272
|
+
end
|
273
|
+
```
|
274
|
+
|
275
|
+
#### Using the list_realtime_dimensions_with_http_info variant
|
276
|
+
|
277
|
+
This returns an Array which contains the response data, status code and headers.
|
278
|
+
|
279
|
+
> <Array(<ListRealTimeDimensionsResponse>, Integer, Hash)> list_realtime_dimensions_with_http_info
|
280
|
+
|
281
|
+
```ruby
|
282
|
+
begin
|
283
|
+
# List Real-Time Dimensions
|
284
|
+
data, status_code, headers = api_instance.list_realtime_dimensions_with_http_info
|
285
|
+
p status_code # => 2xx
|
286
|
+
p headers # => { ... }
|
287
|
+
p data # => <ListRealTimeDimensionsResponse>
|
288
|
+
rescue MuxRuby::ApiError => e
|
289
|
+
puts "Error when calling RealTimeApi->list_realtime_dimensions_with_http_info: #{e}"
|
290
|
+
end
|
291
|
+
```
|
292
|
+
|
293
|
+
### Parameters
|
294
|
+
|
295
|
+
This endpoint does not need any parameter.
|
296
|
+
|
297
|
+
### Return type
|
298
|
+
|
299
|
+
[**ListRealTimeDimensionsResponse**](ListRealTimeDimensionsResponse.md)
|
300
|
+
|
301
|
+
### Authorization
|
302
|
+
|
303
|
+
[accessToken](../README.md#accessToken)
|
304
|
+
|
305
|
+
### HTTP request headers
|
306
|
+
|
307
|
+
- **Content-Type**: Not defined
|
308
|
+
- **Accept**: application/json
|
309
|
+
|
310
|
+
|
311
|
+
## list_realtime_metrics
|
312
|
+
|
313
|
+
> <ListRealTimeMetricsResponse> list_realtime_metrics
|
314
|
+
|
315
|
+
List Real-Time Metrics
|
316
|
+
|
317
|
+
Lists availiable real-time metrics.
|
318
|
+
|
319
|
+
### Examples
|
320
|
+
|
321
|
+
```ruby
|
322
|
+
require 'time'
|
323
|
+
require 'mux_ruby'
|
324
|
+
# setup authorization
|
325
|
+
MuxRuby.configure do |config|
|
326
|
+
# Configure HTTP basic authorization: accessToken
|
327
|
+
config.username = 'YOUR USERNAME'
|
328
|
+
config.password = 'YOUR PASSWORD'
|
329
|
+
end
|
330
|
+
|
331
|
+
api_instance = MuxRuby::RealTimeApi.new
|
332
|
+
|
333
|
+
begin
|
334
|
+
# List Real-Time Metrics
|
335
|
+
result = api_instance.list_realtime_metrics
|
336
|
+
p result
|
337
|
+
rescue MuxRuby::ApiError => e
|
338
|
+
puts "Error when calling RealTimeApi->list_realtime_metrics: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
#### Using the list_realtime_metrics_with_http_info variant
|
343
|
+
|
344
|
+
This returns an Array which contains the response data, status code and headers.
|
345
|
+
|
346
|
+
> <Array(<ListRealTimeMetricsResponse>, Integer, Hash)> list_realtime_metrics_with_http_info
|
347
|
+
|
348
|
+
```ruby
|
349
|
+
begin
|
350
|
+
# List Real-Time Metrics
|
351
|
+
data, status_code, headers = api_instance.list_realtime_metrics_with_http_info
|
352
|
+
p status_code # => 2xx
|
353
|
+
p headers # => { ... }
|
354
|
+
p data # => <ListRealTimeMetricsResponse>
|
355
|
+
rescue MuxRuby::ApiError => e
|
356
|
+
puts "Error when calling RealTimeApi->list_realtime_metrics_with_http_info: #{e}"
|
357
|
+
end
|
358
|
+
```
|
359
|
+
|
360
|
+
### Parameters
|
361
|
+
|
362
|
+
This endpoint does not need any parameter.
|
363
|
+
|
364
|
+
### Return type
|
365
|
+
|
366
|
+
[**ListRealTimeMetricsResponse**](ListRealTimeMetricsResponse.md)
|
367
|
+
|
368
|
+
### Authorization
|
369
|
+
|
370
|
+
[accessToken](../README.md#accessToken)
|
371
|
+
|
372
|
+
### HTTP request headers
|
373
|
+
|
374
|
+
- **Content-Type**: Not defined
|
375
|
+
- **Accept**: application/json
|
376
|
+
|