mux_ruby 1.5.1 → 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 +38 -12
- data/docs/AbridgedVideoView.md +33 -13
- data/docs/Asset.md +57 -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 +391 -160
- data/docs/BreakdownValue.md +21 -7
- data/docs/CreateAssetRequest.md +27 -10
- data/docs/CreateLiveStreamRequest.md +25 -8
- 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 +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 +37 -19
- data/docs/ExportsApi.md +32 -13
- 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 +37 -15
- data/docs/LiveStreamResponse.md +13 -3
- data/docs/LiveStreamsApi.md +497 -145
- data/docs/Metric.md +21 -7
- data/docs/MetricsApi.md +206 -112
- 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 +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 -112
- data/docs/VideoViewEvent.md +19 -6
- data/docs/VideoViewResponse.md +15 -4
- data/docs/VideoViewsApi.md +76 -39
- 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 +283 -150
- data/lib/mux_ruby/api/delivery_usage_api.rb +28 -12
- 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 +32 -16
- data/lib/mux_ruby/api/exports_api.rb +28 -12
- 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 +175 -104
- 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 +89 -42
- data/lib/mux_ruby/api/video_views_api.rb +56 -29
- 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 +147 -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 +70 -24
- 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 +111 -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 +200 -148
- 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/asset_static_renditions_files_spec.rb +2 -2
- data/spec/models/create_live_stream_request_spec.rb +6 -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/models/video_view_spec.rb +12 -0
- data/spec/spec_helper.rb +9 -2
- metadata +249 -212
@@ -0,0 +1,156 @@
|
|
1
|
+
# MuxRuby::DimensionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension |
|
8
|
+
| [**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions |
|
9
|
+
|
10
|
+
|
11
|
+
## list_dimension_values
|
12
|
+
|
13
|
+
> <ListDimensionValuesResponse> list_dimension_values(dimension_id, opts)
|
14
|
+
|
15
|
+
Lists the values for a specific dimension
|
16
|
+
|
17
|
+
Lists the values for a dimension along with a total count of related views. Note: This API replaces the list-filter-values API call.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'mux_ruby'
|
24
|
+
# setup authorization
|
25
|
+
MuxRuby.configure do |config|
|
26
|
+
# Configure HTTP basic authorization: accessToken
|
27
|
+
config.username = 'YOUR USERNAME'
|
28
|
+
config.password = 'YOUR PASSWORD'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MuxRuby::DimensionsApi.new
|
32
|
+
dimension_id = 'abcd1234' # String | ID of the Dimension
|
33
|
+
opts = {
|
34
|
+
limit: 56, # Integer | Number of items to include in the response
|
35
|
+
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
36
|
+
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.
|
37
|
+
timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
# Lists the values for a specific dimension
|
42
|
+
result = api_instance.list_dimension_values(dimension_id, opts)
|
43
|
+
p result
|
44
|
+
rescue MuxRuby::ApiError => e
|
45
|
+
puts "Error when calling DimensionsApi->list_dimension_values: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the list_dimension_values_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(<ListDimensionValuesResponse>, Integer, Hash)> list_dimension_values_with_http_info(dimension_id, opts)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# Lists the values for a specific dimension
|
58
|
+
data, status_code, headers = api_instance.list_dimension_values_with_http_info(dimension_id, opts)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <ListDimensionValuesResponse>
|
62
|
+
rescue MuxRuby::ApiError => e
|
63
|
+
puts "Error when calling DimensionsApi->list_dimension_values_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **dimension_id** | **String** | ID of the Dimension | |
|
72
|
+
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
73
|
+
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
74
|
+
| **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] |
|
75
|
+
| **timeframe** | [**Array<String>**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. | [optional] |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[accessToken](../README.md#accessToken)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: Not defined
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
91
|
+
## list_dimensions
|
92
|
+
|
93
|
+
> <ListDimensionsResponse> list_dimensions
|
94
|
+
|
95
|
+
List Dimensions
|
96
|
+
|
97
|
+
List all available dimensions. Note: This API replaces the list-filters API call.
|
98
|
+
|
99
|
+
### Examples
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
require 'time'
|
103
|
+
require 'mux_ruby'
|
104
|
+
# setup authorization
|
105
|
+
MuxRuby.configure do |config|
|
106
|
+
# Configure HTTP basic authorization: accessToken
|
107
|
+
config.username = 'YOUR USERNAME'
|
108
|
+
config.password = 'YOUR PASSWORD'
|
109
|
+
end
|
110
|
+
|
111
|
+
api_instance = MuxRuby::DimensionsApi.new
|
112
|
+
|
113
|
+
begin
|
114
|
+
# List Dimensions
|
115
|
+
result = api_instance.list_dimensions
|
116
|
+
p result
|
117
|
+
rescue MuxRuby::ApiError => e
|
118
|
+
puts "Error when calling DimensionsApi->list_dimensions: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
#### Using the list_dimensions_with_http_info variant
|
123
|
+
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
125
|
+
|
126
|
+
> <Array(<ListDimensionsResponse>, Integer, Hash)> list_dimensions_with_http_info
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
# List Dimensions
|
131
|
+
data, status_code, headers = api_instance.list_dimensions_with_http_info
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <ListDimensionsResponse>
|
135
|
+
rescue MuxRuby::ApiError => e
|
136
|
+
puts "Error when calling DimensionsApi->list_dimensions_with_http_info: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
This endpoint does not need any parameter.
|
143
|
+
|
144
|
+
### Return type
|
145
|
+
|
146
|
+
[**ListDimensionsResponse**](ListDimensionsResponse.md)
|
147
|
+
|
148
|
+
### Authorization
|
149
|
+
|
150
|
+
[accessToken](../README.md#accessToken)
|
151
|
+
|
152
|
+
### HTTP request headers
|
153
|
+
|
154
|
+
- **Content-Type**: Not defined
|
155
|
+
- **Accept**: application/json
|
156
|
+
|
data/docs/DirectUploadsApi.md
CHANGED
@@ -2,24 +2,26 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.mux.com*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**cancel_direct_upload**](DirectUploadsApi.md#cancel_direct_upload) | **PUT** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload
|
8
|
-
[**create_direct_upload**](DirectUploadsApi.md#create_direct_upload) | **POST** /video/v1/uploads | Create a new direct upload URL
|
9
|
-
[**get_direct_upload**](DirectUploadsApi.md#get_direct_upload) | **GET** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info
|
10
|
-
[**list_direct_uploads**](DirectUploadsApi.md#list_direct_uploads) | **GET** /video/v1/uploads | List direct uploads
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**cancel_direct_upload**](DirectUploadsApi.md#cancel_direct_upload) | **PUT** /video/v1/uploads/{UPLOAD_ID}/cancel | Cancel a direct upload |
|
8
|
+
| [**create_direct_upload**](DirectUploadsApi.md#create_direct_upload) | **POST** /video/v1/uploads | Create a new direct upload URL |
|
9
|
+
| [**get_direct_upload**](DirectUploadsApi.md#get_direct_upload) | **GET** /video/v1/uploads/{UPLOAD_ID} | Retrieve a single direct upload's info |
|
10
|
+
| [**list_direct_uploads**](DirectUploadsApi.md#list_direct_uploads) | **GET** /video/v1/uploads | List direct uploads |
|
11
11
|
|
12
12
|
|
13
|
-
|
14
|
-
|
13
|
+
## cancel_direct_upload
|
14
|
+
|
15
|
+
> <UploadResponse> cancel_direct_upload(upload_id)
|
15
16
|
|
16
17
|
Cancel a direct upload
|
17
18
|
|
18
19
|
Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the `waiting` state.
|
19
20
|
|
20
|
-
###
|
21
|
+
### Examples
|
22
|
+
|
21
23
|
```ruby
|
22
|
-
|
24
|
+
require 'time'
|
23
25
|
require 'mux_ruby'
|
24
26
|
# setup authorization
|
25
27
|
MuxRuby.configure do |config|
|
@@ -32,19 +34,37 @@ api_instance = MuxRuby::DirectUploadsApi.new
|
|
32
34
|
upload_id = 'abcd1234' # String | ID of the Upload
|
33
35
|
|
34
36
|
begin
|
35
|
-
#Cancel a direct upload
|
37
|
+
# Cancel a direct upload
|
36
38
|
result = api_instance.cancel_direct_upload(upload_id)
|
37
39
|
p result
|
38
40
|
rescue MuxRuby::ApiError => e
|
39
|
-
puts "
|
41
|
+
puts "Error when calling DirectUploadsApi->cancel_direct_upload: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the cancel_direct_upload_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<UploadResponse>, Integer, Hash)> cancel_direct_upload_with_http_info(upload_id)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# Cancel a direct upload
|
54
|
+
data, status_code, headers = api_instance.cancel_direct_upload_with_http_info(upload_id)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <UploadResponse>
|
58
|
+
rescue MuxRuby::ApiError => e
|
59
|
+
puts "Error when calling DirectUploadsApi->cancel_direct_upload_with_http_info: #{e}"
|
40
60
|
end
|
41
61
|
```
|
42
62
|
|
43
63
|
### Parameters
|
44
64
|
|
45
|
-
Name | Type | Description
|
46
|
-
|
47
|
-
**upload_id** | **String
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **upload_id** | **String** | ID of the Upload | |
|
48
68
|
|
49
69
|
### Return type
|
50
70
|
|
@@ -56,19 +76,20 @@ Name | Type | Description | Notes
|
|
56
76
|
|
57
77
|
### HTTP request headers
|
58
78
|
|
59
|
-
|
60
|
-
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
61
81
|
|
62
82
|
|
83
|
+
## create_direct_upload
|
63
84
|
|
64
|
-
|
65
|
-
> UploadResponse create_direct_upload(create_upload_request)
|
85
|
+
> <UploadResponse> create_direct_upload(create_upload_request)
|
66
86
|
|
67
87
|
Create a new direct upload URL
|
68
88
|
|
69
|
-
###
|
89
|
+
### Examples
|
90
|
+
|
70
91
|
```ruby
|
71
|
-
|
92
|
+
require 'time'
|
72
93
|
require 'mux_ruby'
|
73
94
|
# setup authorization
|
74
95
|
MuxRuby.configure do |config|
|
@@ -78,22 +99,40 @@ MuxRuby.configure do |config|
|
|
78
99
|
end
|
79
100
|
|
80
101
|
api_instance = MuxRuby::DirectUploadsApi.new
|
81
|
-
create_upload_request = MuxRuby::CreateUploadRequest.new # CreateUploadRequest |
|
102
|
+
create_upload_request = MuxRuby::CreateUploadRequest.new({new_asset_settings: MuxRuby::CreateAssetRequest.new}) # CreateUploadRequest |
|
82
103
|
|
83
104
|
begin
|
84
|
-
#Create a new direct upload URL
|
105
|
+
# Create a new direct upload URL
|
85
106
|
result = api_instance.create_direct_upload(create_upload_request)
|
86
107
|
p result
|
87
108
|
rescue MuxRuby::ApiError => e
|
88
|
-
puts "
|
109
|
+
puts "Error when calling DirectUploadsApi->create_direct_upload: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Using the create_direct_upload_with_http_info variant
|
114
|
+
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
116
|
+
|
117
|
+
> <Array(<UploadResponse>, Integer, Hash)> create_direct_upload_with_http_info(create_upload_request)
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
begin
|
121
|
+
# Create a new direct upload URL
|
122
|
+
data, status_code, headers = api_instance.create_direct_upload_with_http_info(create_upload_request)
|
123
|
+
p status_code # => 2xx
|
124
|
+
p headers # => { ... }
|
125
|
+
p data # => <UploadResponse>
|
126
|
+
rescue MuxRuby::ApiError => e
|
127
|
+
puts "Error when calling DirectUploadsApi->create_direct_upload_with_http_info: #{e}"
|
89
128
|
end
|
90
129
|
```
|
91
130
|
|
92
131
|
### Parameters
|
93
132
|
|
94
|
-
Name | Type | Description
|
95
|
-
|
96
|
-
**create_upload_request** | [**CreateUploadRequest**](CreateUploadRequest.md)| |
|
133
|
+
| Name | Type | Description | Notes |
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
135
|
+
| **create_upload_request** | [**CreateUploadRequest**](CreateUploadRequest.md) | | |
|
97
136
|
|
98
137
|
### Return type
|
99
138
|
|
@@ -105,19 +144,20 @@ Name | Type | Description | Notes
|
|
105
144
|
|
106
145
|
### HTTP request headers
|
107
146
|
|
108
|
-
|
109
|
-
|
147
|
+
- **Content-Type**: application/json
|
148
|
+
- **Accept**: application/json
|
110
149
|
|
111
150
|
|
151
|
+
## get_direct_upload
|
112
152
|
|
113
|
-
|
114
|
-
> UploadResponse get_direct_upload(upload_id)
|
153
|
+
> <UploadResponse> get_direct_upload(upload_id)
|
115
154
|
|
116
155
|
Retrieve a single direct upload's info
|
117
156
|
|
118
|
-
###
|
157
|
+
### Examples
|
158
|
+
|
119
159
|
```ruby
|
120
|
-
|
160
|
+
require 'time'
|
121
161
|
require 'mux_ruby'
|
122
162
|
# setup authorization
|
123
163
|
MuxRuby.configure do |config|
|
@@ -130,19 +170,37 @@ api_instance = MuxRuby::DirectUploadsApi.new
|
|
130
170
|
upload_id = 'abcd1234' # String | ID of the Upload
|
131
171
|
|
132
172
|
begin
|
133
|
-
#Retrieve a single direct upload's info
|
173
|
+
# Retrieve a single direct upload's info
|
134
174
|
result = api_instance.get_direct_upload(upload_id)
|
135
175
|
p result
|
136
176
|
rescue MuxRuby::ApiError => e
|
137
|
-
puts "
|
177
|
+
puts "Error when calling DirectUploadsApi->get_direct_upload: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
#### Using the get_direct_upload_with_http_info variant
|
182
|
+
|
183
|
+
This returns an Array which contains the response data, status code and headers.
|
184
|
+
|
185
|
+
> <Array(<UploadResponse>, Integer, Hash)> get_direct_upload_with_http_info(upload_id)
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
begin
|
189
|
+
# Retrieve a single direct upload's info
|
190
|
+
data, status_code, headers = api_instance.get_direct_upload_with_http_info(upload_id)
|
191
|
+
p status_code # => 2xx
|
192
|
+
p headers # => { ... }
|
193
|
+
p data # => <UploadResponse>
|
194
|
+
rescue MuxRuby::ApiError => e
|
195
|
+
puts "Error when calling DirectUploadsApi->get_direct_upload_with_http_info: #{e}"
|
138
196
|
end
|
139
197
|
```
|
140
198
|
|
141
199
|
### Parameters
|
142
200
|
|
143
|
-
Name | Type | Description
|
144
|
-
|
145
|
-
**upload_id** | **String
|
201
|
+
| Name | Type | Description | Notes |
|
202
|
+
| ---- | ---- | ----------- | ----- |
|
203
|
+
| **upload_id** | **String** | ID of the Upload | |
|
146
204
|
|
147
205
|
### Return type
|
148
206
|
|
@@ -154,19 +212,20 @@ Name | Type | Description | Notes
|
|
154
212
|
|
155
213
|
### HTTP request headers
|
156
214
|
|
157
|
-
|
158
|
-
|
215
|
+
- **Content-Type**: Not defined
|
216
|
+
- **Accept**: application/json
|
159
217
|
|
160
218
|
|
219
|
+
## list_direct_uploads
|
161
220
|
|
162
|
-
|
163
|
-
> ListUploadsResponse list_direct_uploads(opts)
|
221
|
+
> <ListUploadsResponse> list_direct_uploads(opts)
|
164
222
|
|
165
223
|
List direct uploads
|
166
224
|
|
167
|
-
###
|
225
|
+
### Examples
|
226
|
+
|
168
227
|
```ruby
|
169
|
-
|
228
|
+
require 'time'
|
170
229
|
require 'mux_ruby'
|
171
230
|
# setup authorization
|
172
231
|
MuxRuby.configure do |config|
|
@@ -177,25 +236,43 @@ end
|
|
177
236
|
|
178
237
|
api_instance = MuxRuby::DirectUploadsApi.new
|
179
238
|
opts = {
|
180
|
-
limit:
|
181
|
-
page:
|
239
|
+
limit: 56, # Integer | Number of items to include in the response
|
240
|
+
page: 56 # Integer | Offset by this many pages, of the size of `limit`
|
182
241
|
}
|
183
242
|
|
184
243
|
begin
|
185
|
-
#List direct uploads
|
244
|
+
# List direct uploads
|
186
245
|
result = api_instance.list_direct_uploads(opts)
|
187
246
|
p result
|
188
247
|
rescue MuxRuby::ApiError => e
|
189
|
-
puts "
|
248
|
+
puts "Error when calling DirectUploadsApi->list_direct_uploads: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
#### Using the list_direct_uploads_with_http_info variant
|
253
|
+
|
254
|
+
This returns an Array which contains the response data, status code and headers.
|
255
|
+
|
256
|
+
> <Array(<ListUploadsResponse>, Integer, Hash)> list_direct_uploads_with_http_info(opts)
|
257
|
+
|
258
|
+
```ruby
|
259
|
+
begin
|
260
|
+
# List direct uploads
|
261
|
+
data, status_code, headers = api_instance.list_direct_uploads_with_http_info(opts)
|
262
|
+
p status_code # => 2xx
|
263
|
+
p headers # => { ... }
|
264
|
+
p data # => <ListUploadsResponse>
|
265
|
+
rescue MuxRuby::ApiError => e
|
266
|
+
puts "Error when calling DirectUploadsApi->list_direct_uploads_with_http_info: #{e}"
|
190
267
|
end
|
191
268
|
```
|
192
269
|
|
193
270
|
### Parameters
|
194
271
|
|
195
|
-
Name | Type | Description
|
196
|
-
|
197
|
-
**limit** | **Integer
|
198
|
-
**page** | **Integer
|
272
|
+
| Name | Type | Description | Notes |
|
273
|
+
| ---- | ---- | ----------- | ----- |
|
274
|
+
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
275
|
+
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
199
276
|
|
200
277
|
### Return type
|
201
278
|
|
@@ -207,8 +284,6 @@ Name | Type | Description | Notes
|
|
207
284
|
|
208
285
|
### HTTP request headers
|
209
286
|
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
287
|
+
- **Content-Type**: Not defined
|
288
|
+
- **Accept**: application/json
|
214
289
|
|