mux_ruby 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +79 -0
- data/LICENSE +7 -0
- data/README.md +121 -0
- data/Rakefile +10 -0
- data/docs/AbridgedVideoView.md +18 -0
- data/docs/Asset.md +27 -0
- data/docs/AssetErrors.md +9 -0
- data/docs/AssetMaster.md +9 -0
- data/docs/AssetResponse.md +8 -0
- data/docs/AssetStaticRenditions.md +9 -0
- data/docs/AssetStaticRenditionsFiles.md +13 -0
- data/docs/AssetsApi.md +476 -0
- data/docs/BreakdownValue.md +12 -0
- data/docs/CreateAssetRequest.md +13 -0
- data/docs/CreateLiveStreamRequest.md +9 -0
- data/docs/CreatePlaybackIDRequest.md +8 -0
- data/docs/CreatePlaybackIDResponse.md +8 -0
- data/docs/CreateUploadRequest.md +10 -0
- data/docs/DirectUploadsApi.md +214 -0
- data/docs/Error.md +15 -0
- data/docs/ErrorsApi.md +64 -0
- data/docs/ExportsApi.md +56 -0
- data/docs/FilterValue.md +9 -0
- data/docs/FiltersApi.md +118 -0
- data/docs/GetAssetInputInfoResponse.md +8 -0
- data/docs/GetAssetPlaybackIDResponse.md +8 -0
- data/docs/GetMetricTimeseriesDataResponse.md +10 -0
- data/docs/GetOverallValuesResponse.md +10 -0
- data/docs/InputFile.md +9 -0
- data/docs/InputInfo.md +9 -0
- data/docs/InputSettings.md +10 -0
- data/docs/InputSettingsOverlaySettings.md +14 -0
- data/docs/InputTrack.md +18 -0
- data/docs/Insight.md +13 -0
- data/docs/ListAllMetricValuesResponse.md +10 -0
- data/docs/ListAssetsResponse.md +8 -0
- data/docs/ListBreakdownValuesResponse.md +10 -0
- data/docs/ListErrorsResponse.md +10 -0
- data/docs/ListExportsResponse.md +10 -0
- data/docs/ListFilterValuesResponse.md +10 -0
- data/docs/ListFiltersResponse.md +10 -0
- data/docs/ListFiltersResponseData.md +9 -0
- data/docs/ListInsightsResponse.md +10 -0
- data/docs/ListLiveStreamsResponse.md +8 -0
- data/docs/ListSigningKeysResponse.md +8 -0
- data/docs/ListUploadsResponse.md +8 -0
- data/docs/ListVideoViewsResponse.md +10 -0
- data/docs/LiveStream.md +17 -0
- data/docs/LiveStreamResponse.md +8 -0
- data/docs/LiveStreamsApi.md +420 -0
- data/docs/Metric.md +12 -0
- data/docs/MetricsApi.md +322 -0
- data/docs/OverallValues.md +11 -0
- data/docs/PlaybackID.md +9 -0
- data/docs/PlaybackPolicy.md +7 -0
- data/docs/Score.md +13 -0
- data/docs/SignalLiveStreamCompleteResponse.md +8 -0
- data/docs/SigningKey.md +10 -0
- data/docs/SigningKeyResponse.md +8 -0
- data/docs/Track.md +17 -0
- data/docs/URLSigningKeysApi.md +215 -0
- data/docs/UpdateAssetMP4SupportRequest.md +8 -0
- data/docs/Upload.md +15 -0
- data/docs/UploadError.md +9 -0
- data/docs/UploadResponse.md +8 -0
- data/docs/VideoView.md +117 -0
- data/docs/VideoViewEvent.md +11 -0
- data/docs/VideoViewResponse.md +9 -0
- data/docs/VideoViewsApi.md +126 -0
- data/examples/data/exercise-errors.rb +23 -0
- data/examples/data/exercise-exports.rb +22 -0
- data/examples/data/exercise-filters.rb +29 -0
- data/examples/data/exercise-metrics.rb +52 -0
- data/examples/data/exercise-video-views.rb +30 -0
- data/examples/video/create-live-stream.rb +25 -0
- data/examples/video/exercise-assets.rb +95 -0
- data/examples/video/exercise-live-streams.rb +89 -0
- data/examples/video/exercise-signing-keys.rb +46 -0
- data/examples/video/exercise-uploads.rb +49 -0
- data/examples/video/ingest.rb +37 -0
- data/examples/video/list-everything.rb +48 -0
- data/github-ruby-sdk.png +0 -0
- data/lib/mux_ruby/api/assets_api.rb +507 -0
- data/lib/mux_ruby/api/direct_uploads_api.rb +224 -0
- data/lib/mux_ruby/api/errors_api.rb +69 -0
- data/lib/mux_ruby/api/exports_api.rb +63 -0
- data/lib/mux_ruby/api/filters_api.rb +128 -0
- data/lib/mux_ruby/api/live_streams_api.rb +440 -0
- data/lib/mux_ruby/api/metrics_api.rb +393 -0
- data/lib/mux_ruby/api/url_signing_keys_api.rb +219 -0
- data/lib/mux_ruby/api/video_views_api.rb +140 -0
- data/lib/mux_ruby/api_client.rb +400 -0
- data/lib/mux_ruby/api_error.rb +44 -0
- data/lib/mux_ruby/configuration.rb +244 -0
- data/lib/mux_ruby/models/abridged_video_view.rb +274 -0
- data/lib/mux_ruby/models/asset.rb +409 -0
- data/lib/mux_ruby/models/asset_errors.rb +195 -0
- data/lib/mux_ruby/models/asset_master.rb +193 -0
- data/lib/mux_ruby/models/asset_response.rb +184 -0
- data/lib/mux_ruby/models/asset_static_renditions.rb +232 -0
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +279 -0
- data/lib/mux_ruby/models/breakdown_value.rb +220 -0
- data/lib/mux_ruby/models/create_asset_request.rb +267 -0
- data/lib/mux_ruby/models/create_live_stream_request.rb +195 -0
- data/lib/mux_ruby/models/create_playback_id_request.rb +184 -0
- data/lib/mux_ruby/models/create_playback_id_response.rb +184 -0
- data/lib/mux_ruby/models/create_upload_request.rb +235 -0
- data/lib/mux_ruby/models/error.rb +247 -0
- data/lib/mux_ruby/models/filter_value.rb +193 -0
- data/lib/mux_ruby/models/get_asset_input_info_response.rb +186 -0
- data/lib/mux_ruby/models/get_asset_playback_id_response.rb +184 -0
- data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +206 -0
- data/lib/mux_ruby/models/get_overall_values_response.rb +204 -0
- data/lib/mux_ruby/models/input_file.rb +195 -0
- data/lib/mux_ruby/models/input_info.rb +193 -0
- data/lib/mux_ruby/models/input_settings.rb +203 -0
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +238 -0
- data/lib/mux_ruby/models/input_track.rb +274 -0
- data/lib/mux_ruby/models/insight.rb +229 -0
- data/lib/mux_ruby/models/list_all_metric_values_response.rb +206 -0
- data/lib/mux_ruby/models/list_assets_response.rb +186 -0
- data/lib/mux_ruby/models/list_breakdown_values_response.rb +206 -0
- data/lib/mux_ruby/models/list_errors_response.rb +206 -0
- data/lib/mux_ruby/models/list_exports_response.rb +206 -0
- data/lib/mux_ruby/models/list_filter_values_response.rb +206 -0
- data/lib/mux_ruby/models/list_filters_response.rb +204 -0
- data/lib/mux_ruby/models/list_filters_response_data.rb +197 -0
- data/lib/mux_ruby/models/list_insights_response.rb +206 -0
- data/lib/mux_ruby/models/list_live_streams_response.rb +186 -0
- data/lib/mux_ruby/models/list_signing_keys_response.rb +186 -0
- data/lib/mux_ruby/models/list_uploads_response.rb +186 -0
- data/lib/mux_ruby/models/list_video_views_response.rb +206 -0
- data/lib/mux_ruby/models/live_stream.rb +269 -0
- data/lib/mux_ruby/models/live_stream_response.rb +184 -0
- data/lib/mux_ruby/models/metric.rb +220 -0
- data/lib/mux_ruby/models/overall_values.rb +211 -0
- data/lib/mux_ruby/models/playback_id.rb +193 -0
- data/lib/mux_ruby/models/playback_policy.rb +31 -0
- data/lib/mux_ruby/models/score.rb +231 -0
- data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +184 -0
- data/lib/mux_ruby/models/signing_key.rb +202 -0
- data/lib/mux_ruby/models/signing_key_response.rb +184 -0
- data/lib/mux_ruby/models/track.rb +265 -0
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +219 -0
- data/lib/mux_ruby/models/upload.rb +311 -0
- data/lib/mux_ruby/models/upload_error.rb +194 -0
- data/lib/mux_ruby/models/upload_response.rb +184 -0
- data/lib/mux_ruby/models/video_view.rb +1167 -0
- data/lib/mux_ruby/models/video_view_event.rb +211 -0
- data/lib/mux_ruby/models/video_view_response.rb +195 -0
- data/lib/mux_ruby/version.rb +8 -0
- data/lib/mux_ruby.rb +97 -0
- data/mux_ruby.gemspec +38 -0
- data/spec/api/assets_api_spec.rb +136 -0
- data/spec/api/direct_uploads_api_spec.rb +74 -0
- data/spec/api/errors_api_spec.rb +41 -0
- data/spec/api/exports_api_spec.rb +39 -0
- data/spec/api/filters_api_spec.rb +55 -0
- data/spec/api/live_streams_api_spec.rb +122 -0
- data/spec/api/metrics_api_spec.rb +110 -0
- data/spec/api/url_signing_keys_api_spec.rb +76 -0
- data/spec/api/video_views_api_spec.rb +58 -0
- data/spec/api_client_spec.rb +219 -0
- data/spec/configuration_spec.rb +35 -0
- data/spec/models/abridged_video_view_spec.rb +94 -0
- data/spec/models/asset_errors_spec.rb +40 -0
- data/spec/models/asset_master_spec.rb +40 -0
- data/spec/models/asset_response_spec.rb +34 -0
- data/spec/models/asset_spec.rb +156 -0
- data/spec/models/asset_static_renditions_files_spec.rb +72 -0
- data/spec/models/asset_static_renditions_spec.rb +44 -0
- data/spec/models/breakdown_value_spec.rb +58 -0
- data/spec/models/create_asset_request_spec.rb +68 -0
- data/spec/models/create_live_stream_request_spec.rb +40 -0
- data/spec/models/create_playback_id_request_spec.rb +34 -0
- data/spec/models/create_playback_id_response_spec.rb +34 -0
- data/spec/models/create_upload_request_spec.rb +46 -0
- data/spec/models/error_spec.rb +76 -0
- data/spec/models/filter_value_spec.rb +40 -0
- data/spec/models/get_asset_input_info_response_spec.rb +34 -0
- data/spec/models/get_asset_playback_id_response_spec.rb +34 -0
- data/spec/models/get_metric_timeseries_data_response_spec.rb +46 -0
- data/spec/models/get_overall_values_response_spec.rb +46 -0
- data/spec/models/input_file_spec.rb +40 -0
- data/spec/models/input_info_spec.rb +40 -0
- data/spec/models/input_settings_overlay_settings_spec.rb +70 -0
- data/spec/models/input_settings_spec.rb +46 -0
- data/spec/models/input_track_spec.rb +94 -0
- data/spec/models/insight_spec.rb +64 -0
- data/spec/models/list_all_metric_values_response_spec.rb +46 -0
- data/spec/models/list_assets_response_spec.rb +34 -0
- data/spec/models/list_breakdown_values_response_spec.rb +46 -0
- data/spec/models/list_errors_response_spec.rb +46 -0
- data/spec/models/list_exports_response_spec.rb +46 -0
- data/spec/models/list_filter_values_response_spec.rb +46 -0
- data/spec/models/list_filters_response_data_spec.rb +40 -0
- data/spec/models/list_filters_response_spec.rb +46 -0
- data/spec/models/list_insights_response_spec.rb +46 -0
- data/spec/models/list_live_streams_response_spec.rb +34 -0
- data/spec/models/list_signing_keys_response_spec.rb +34 -0
- data/spec/models/list_uploads_response_spec.rb +34 -0
- data/spec/models/list_video_views_response_spec.rb +46 -0
- data/spec/models/live_stream_response_spec.rb +34 -0
- data/spec/models/live_stream_spec.rb +88 -0
- data/spec/models/metric_spec.rb +58 -0
- data/spec/models/overall_values_spec.rb +52 -0
- data/spec/models/playback_id_spec.rb +40 -0
- data/spec/models/playback_policy_spec.rb +28 -0
- data/spec/models/score_spec.rb +64 -0
- data/spec/models/signal_live_stream_complete_response_spec.rb +34 -0
- data/spec/models/signing_key_response_spec.rb +34 -0
- data/spec/models/signing_key_spec.rb +46 -0
- data/spec/models/track_spec.rb +88 -0
- data/spec/models/update_asset_mp4_support_request_spec.rb +38 -0
- data/spec/models/upload_error_spec.rb +40 -0
- data/spec/models/upload_response_spec.rb +34 -0
- data/spec/models/upload_spec.rb +80 -0
- data/spec/models/video_view_event_spec.rb +52 -0
- data/spec/models/video_view_response_spec.rb +40 -0
- data/spec/models/video_view_spec.rb +688 -0
- data/spec/spec_helper.rb +104 -0
- metadata +514 -0
data/docs/MetricsApi.md
ADDED
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
# MuxRuby::MetricsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_metric_timeseries_data**](MetricsApi.md#get_metric_timeseries_data) | **GET** /data/v1/metrics/{METRIC_ID}/timeseries | Get metric timeseries data
|
|
8
|
+
[**get_overall_values**](MetricsApi.md#get_overall_values) | **GET** /data/v1/metrics/{METRIC_ID}/overall | Get Overall values
|
|
9
|
+
[**list_all_metric_values**](MetricsApi.md#list_all_metric_values) | **GET** /data/v1/metrics/comparison | List all metric values
|
|
10
|
+
[**list_breakdown_values**](MetricsApi.md#list_breakdown_values) | **GET** /data/v1/metrics/{METRIC_ID}/breakdown | List breakdown values
|
|
11
|
+
[**list_insights**](MetricsApi.md#list_insights) | **GET** /data/v1/metrics/{METRIC_ID}/insights | List Insights
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# **get_metric_timeseries_data**
|
|
15
|
+
> GetMetricTimeseriesDataResponse get_metric_timeseries_data(metric_id, opts)
|
|
16
|
+
|
|
17
|
+
Get metric timeseries data
|
|
18
|
+
|
|
19
|
+
Returns timeseries data for a specific metric
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'mux_ruby'
|
|
25
|
+
# setup authorization
|
|
26
|
+
MuxRuby.configure do |config|
|
|
27
|
+
# Configure HTTP basic authorization: accessToken
|
|
28
|
+
config.username = 'YOUR USERNAME'
|
|
29
|
+
config.password = 'YOUR PASSWORD'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = MuxRuby::MetricsApi.new
|
|
33
|
+
metric_id = 'video_startup_time' # String | ID of the Metric
|
|
34
|
+
opts = {
|
|
35
|
+
timeframe: ['timeframe_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.
|
|
36
|
+
filters: ['filters_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
|
+
measurement: 'measurement_example', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
|
|
38
|
+
order_direction: 'order_direction_example', # String | Sort order.
|
|
39
|
+
group_by: 'group_by_example' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
#Get metric timeseries data
|
|
44
|
+
result = api_instance.get_metric_timeseries_data(metric_id, opts)
|
|
45
|
+
p result
|
|
46
|
+
rescue MuxRuby::ApiError => e
|
|
47
|
+
puts "Exception when calling MetricsApi->get_metric_timeseries_data: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
Name | Type | Description | Notes
|
|
54
|
+
------------- | ------------- | ------------- | -------------
|
|
55
|
+
**metric_id** | **String**| ID of the Metric |
|
|
56
|
+
**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]
|
|
57
|
+
**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]
|
|
58
|
+
**measurement** | **String**| Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional]
|
|
59
|
+
**order_direction** | **String**| Sort order. | [optional]
|
|
60
|
+
**group_by** | **String**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional]
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
[**GetMetricTimeseriesDataResponse**](GetMetricTimeseriesDataResponse.md)
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
[accessToken](../README.md#accessToken)
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: Not defined
|
|
73
|
+
- **Accept**: application/json
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
# **get_overall_values**
|
|
78
|
+
> GetOverallValuesResponse get_overall_values(metric_id, opts)
|
|
79
|
+
|
|
80
|
+
Get Overall values
|
|
81
|
+
|
|
82
|
+
Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
```ruby
|
|
86
|
+
# load the gem
|
|
87
|
+
require 'mux_ruby'
|
|
88
|
+
# setup authorization
|
|
89
|
+
MuxRuby.configure do |config|
|
|
90
|
+
# Configure HTTP basic authorization: accessToken
|
|
91
|
+
config.username = 'YOUR USERNAME'
|
|
92
|
+
config.password = 'YOUR PASSWORD'
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
api_instance = MuxRuby::MetricsApi.new
|
|
96
|
+
metric_id = 'video_startup_time' # String | ID of the Metric
|
|
97
|
+
opts = {
|
|
98
|
+
timeframe: ['timeframe_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.
|
|
99
|
+
filters: ['filters_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.
|
|
100
|
+
measurement: 'measurement_example' # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
begin
|
|
104
|
+
#Get Overall values
|
|
105
|
+
result = api_instance.get_overall_values(metric_id, opts)
|
|
106
|
+
p result
|
|
107
|
+
rescue MuxRuby::ApiError => e
|
|
108
|
+
puts "Exception when calling MetricsApi->get_overall_values: #{e}"
|
|
109
|
+
end
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Parameters
|
|
113
|
+
|
|
114
|
+
Name | Type | Description | Notes
|
|
115
|
+
------------- | ------------- | ------------- | -------------
|
|
116
|
+
**metric_id** | **String**| ID of the Metric |
|
|
117
|
+
**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]
|
|
118
|
+
**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]
|
|
119
|
+
**measurement** | **String**| Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional]
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
[**GetOverallValuesResponse**](GetOverallValuesResponse.md)
|
|
124
|
+
|
|
125
|
+
### Authorization
|
|
126
|
+
|
|
127
|
+
[accessToken](../README.md#accessToken)
|
|
128
|
+
|
|
129
|
+
### HTTP request headers
|
|
130
|
+
|
|
131
|
+
- **Content-Type**: Not defined
|
|
132
|
+
- **Accept**: application/json
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
# **list_all_metric_values**
|
|
137
|
+
> ListAllMetricValuesResponse list_all_metric_values(opts)
|
|
138
|
+
|
|
139
|
+
List all metric values
|
|
140
|
+
|
|
141
|
+
List all of the values across every breakdown for a specific metric
|
|
142
|
+
|
|
143
|
+
### Example
|
|
144
|
+
```ruby
|
|
145
|
+
# load the gem
|
|
146
|
+
require 'mux_ruby'
|
|
147
|
+
# setup authorization
|
|
148
|
+
MuxRuby.configure do |config|
|
|
149
|
+
# Configure HTTP basic authorization: accessToken
|
|
150
|
+
config.username = 'YOUR USERNAME'
|
|
151
|
+
config.password = 'YOUR PASSWORD'
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
api_instance = MuxRuby::MetricsApi.new
|
|
155
|
+
opts = {
|
|
156
|
+
timeframe: ['timeframe_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.
|
|
157
|
+
filters: ['filters_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.
|
|
158
|
+
dimension: 'dimension_example', # String | Dimension the specified value belongs to
|
|
159
|
+
value: 'value_example' # String | Value to show all available metrics for
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
begin
|
|
163
|
+
#List all metric values
|
|
164
|
+
result = api_instance.list_all_metric_values(opts)
|
|
165
|
+
p result
|
|
166
|
+
rescue MuxRuby::ApiError => e
|
|
167
|
+
puts "Exception when calling MetricsApi->list_all_metric_values: #{e}"
|
|
168
|
+
end
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
Name | Type | Description | Notes
|
|
174
|
+
------------- | ------------- | ------------- | -------------
|
|
175
|
+
**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]
|
|
176
|
+
**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]
|
|
177
|
+
**dimension** | **String**| Dimension the specified value belongs to | [optional]
|
|
178
|
+
**value** | **String**| Value to show all available metrics for | [optional]
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
[**ListAllMetricValuesResponse**](ListAllMetricValuesResponse.md)
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
[accessToken](../README.md#accessToken)
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: Not defined
|
|
191
|
+
- **Accept**: application/json
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
# **list_breakdown_values**
|
|
196
|
+
> ListBreakdownValuesResponse list_breakdown_values(metric_id, opts)
|
|
197
|
+
|
|
198
|
+
List breakdown values
|
|
199
|
+
|
|
200
|
+
List the breakdown values for a specific metric
|
|
201
|
+
|
|
202
|
+
### Example
|
|
203
|
+
```ruby
|
|
204
|
+
# load the gem
|
|
205
|
+
require 'mux_ruby'
|
|
206
|
+
# setup authorization
|
|
207
|
+
MuxRuby.configure do |config|
|
|
208
|
+
# Configure HTTP basic authorization: accessToken
|
|
209
|
+
config.username = 'YOUR USERNAME'
|
|
210
|
+
config.password = 'YOUR PASSWORD'
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
api_instance = MuxRuby::MetricsApi.new
|
|
214
|
+
metric_id = 'video_startup_time' # String | ID of the Metric
|
|
215
|
+
opts = {
|
|
216
|
+
group_by: 'group_by_example', # String | Breakdown value to group the results by
|
|
217
|
+
measurement: 'measurement_example', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
|
|
218
|
+
filters: ['filters_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.
|
|
219
|
+
limit: 25, # Integer | Number of items to include in the response
|
|
220
|
+
page: 1, # Integer | Offset by this many pages, of the size of `limit`
|
|
221
|
+
order_by: 'order_by_example', # String | Value to order the results by
|
|
222
|
+
order_direction: 'order_direction_example', # String | Sort order.
|
|
223
|
+
timeframe: ['timeframe_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.
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
begin
|
|
227
|
+
#List breakdown values
|
|
228
|
+
result = api_instance.list_breakdown_values(metric_id, opts)
|
|
229
|
+
p result
|
|
230
|
+
rescue MuxRuby::ApiError => e
|
|
231
|
+
puts "Exception when calling MetricsApi->list_breakdown_values: #{e}"
|
|
232
|
+
end
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### Parameters
|
|
236
|
+
|
|
237
|
+
Name | Type | Description | Notes
|
|
238
|
+
------------- | ------------- | ------------- | -------------
|
|
239
|
+
**metric_id** | **String**| ID of the Metric |
|
|
240
|
+
**group_by** | **String**| Breakdown value to group the results by | [optional]
|
|
241
|
+
**measurement** | **String**| Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional]
|
|
242
|
+
**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]
|
|
243
|
+
**limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
|
|
244
|
+
**page** | **Integer**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
|
|
245
|
+
**order_by** | **String**| Value to order the results by | [optional]
|
|
246
|
+
**order_direction** | **String**| Sort order. | [optional]
|
|
247
|
+
**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]
|
|
248
|
+
|
|
249
|
+
### Return type
|
|
250
|
+
|
|
251
|
+
[**ListBreakdownValuesResponse**](ListBreakdownValuesResponse.md)
|
|
252
|
+
|
|
253
|
+
### Authorization
|
|
254
|
+
|
|
255
|
+
[accessToken](../README.md#accessToken)
|
|
256
|
+
|
|
257
|
+
### HTTP request headers
|
|
258
|
+
|
|
259
|
+
- **Content-Type**: Not defined
|
|
260
|
+
- **Accept**: application/json
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
# **list_insights**
|
|
265
|
+
> ListInsightsResponse list_insights(metric_id, opts)
|
|
266
|
+
|
|
267
|
+
List Insights
|
|
268
|
+
|
|
269
|
+
Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
|
270
|
+
|
|
271
|
+
### Example
|
|
272
|
+
```ruby
|
|
273
|
+
# load the gem
|
|
274
|
+
require 'mux_ruby'
|
|
275
|
+
# setup authorization
|
|
276
|
+
MuxRuby.configure do |config|
|
|
277
|
+
# Configure HTTP basic authorization: accessToken
|
|
278
|
+
config.username = 'YOUR USERNAME'
|
|
279
|
+
config.password = 'YOUR PASSWORD'
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
api_instance = MuxRuby::MetricsApi.new
|
|
283
|
+
metric_id = 'video_startup_time' # String | ID of the Metric
|
|
284
|
+
opts = {
|
|
285
|
+
measurement: 'measurement_example', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
|
|
286
|
+
order_direction: 'order_direction_example', # String | Sort order.
|
|
287
|
+
timeframe: ['timeframe_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.
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
begin
|
|
291
|
+
#List Insights
|
|
292
|
+
result = api_instance.list_insights(metric_id, opts)
|
|
293
|
+
p result
|
|
294
|
+
rescue MuxRuby::ApiError => e
|
|
295
|
+
puts "Exception when calling MetricsApi->list_insights: #{e}"
|
|
296
|
+
end
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
Name | Type | Description | Notes
|
|
302
|
+
------------- | ------------- | ------------- | -------------
|
|
303
|
+
**metric_id** | **String**| ID of the Metric |
|
|
304
|
+
**measurement** | **String**| Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional]
|
|
305
|
+
**order_direction** | **String**| Sort order. | [optional]
|
|
306
|
+
**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]
|
|
307
|
+
|
|
308
|
+
### Return type
|
|
309
|
+
|
|
310
|
+
[**ListInsightsResponse**](ListInsightsResponse.md)
|
|
311
|
+
|
|
312
|
+
### Authorization
|
|
313
|
+
|
|
314
|
+
[accessToken](../README.md#accessToken)
|
|
315
|
+
|
|
316
|
+
### HTTP request headers
|
|
317
|
+
|
|
318
|
+
- **Content-Type**: Not defined
|
|
319
|
+
- **Accept**: application/json
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# MuxRuby::OverallValues
|
|
2
|
+
|
|
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
|
+
|
|
11
|
+
|
data/docs/PlaybackID.md
ADDED
data/docs/Score.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# MuxRuby::Score
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**watch_time** | **Integer** | | [optional]
|
|
7
|
+
**view_count** | **Integer** | | [optional]
|
|
8
|
+
**name** | **String** | | [optional]
|
|
9
|
+
**value** | **Float** | | [optional]
|
|
10
|
+
**metric** | **String** | | [optional]
|
|
11
|
+
**items** | [**Array<Metric>**](Metric.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/SigningKey.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# MuxRuby::SigningKey
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**created_at** | **String** | | [optional]
|
|
8
|
+
**private_key** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/Track.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# MuxRuby::Track
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**type** | **String** | | [optional]
|
|
8
|
+
**duration** | **Float** | | [optional]
|
|
9
|
+
**max_width** | **Integer** | | [optional]
|
|
10
|
+
**max_height** | **Integer** | | [optional]
|
|
11
|
+
**max_frame_rate** | **Float** | | [optional]
|
|
12
|
+
**max_channels** | **Integer** | | [optional]
|
|
13
|
+
**max_channel_layout** | **String** | | [optional]
|
|
14
|
+
**text_track_type** | **String** | | [optional]
|
|
15
|
+
**language** | **String** | | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
# MuxRuby::URLSigningKeysApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_url_signing_key**](URLSigningKeysApi.md#create_url_signing_key) | **POST** /video/v1/signing-keys | Create a URL signing key
|
|
8
|
+
[**delete_url_signing_key**](URLSigningKeysApi.md#delete_url_signing_key) | **DELETE** /video/v1/signing-keys/{SIGNING_KEY_ID} | Delete a URL signing key
|
|
9
|
+
[**get_url_signing_key**](URLSigningKeysApi.md#get_url_signing_key) | **GET** /video/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a URL signing key
|
|
10
|
+
[**list_url_signing_keys**](URLSigningKeysApi.md#list_url_signing_keys) | **GET** /video/v1/signing-keys | List URL signing keys
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **create_url_signing_key**
|
|
14
|
+
> SigningKeyResponse create_url_signing_key
|
|
15
|
+
|
|
16
|
+
Create a URL signing key
|
|
17
|
+
|
|
18
|
+
Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
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::URLSigningKeysApi.new
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
#Create a URL signing key
|
|
35
|
+
result = api_instance.create_url_signing_key
|
|
36
|
+
p result
|
|
37
|
+
rescue MuxRuby::ApiError => e
|
|
38
|
+
puts "Exception when calling URLSigningKeysApi->create_url_signing_key: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
This endpoint does not need any parameter.
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
[**SigningKeyResponse**](SigningKeyResponse.md)
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[accessToken](../README.md#accessToken)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
# **delete_url_signing_key**
|
|
61
|
+
> delete_url_signing_key(signing_key_id)
|
|
62
|
+
|
|
63
|
+
Delete a URL signing key
|
|
64
|
+
|
|
65
|
+
Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
```ruby
|
|
69
|
+
# load the gem
|
|
70
|
+
require 'mux_ruby'
|
|
71
|
+
# setup authorization
|
|
72
|
+
MuxRuby.configure do |config|
|
|
73
|
+
# Configure HTTP basic authorization: accessToken
|
|
74
|
+
config.username = 'YOUR USERNAME'
|
|
75
|
+
config.password = 'YOUR PASSWORD'
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
api_instance = MuxRuby::URLSigningKeysApi.new
|
|
79
|
+
signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
|
|
80
|
+
|
|
81
|
+
begin
|
|
82
|
+
#Delete a URL signing key
|
|
83
|
+
api_instance.delete_url_signing_key(signing_key_id)
|
|
84
|
+
rescue MuxRuby::ApiError => e
|
|
85
|
+
puts "Exception when calling URLSigningKeysApi->delete_url_signing_key: #{e}"
|
|
86
|
+
end
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
Name | Type | Description | Notes
|
|
92
|
+
------------- | ------------- | ------------- | -------------
|
|
93
|
+
**signing_key_id** | **String**| The ID of the signing key. |
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
nil (empty response body)
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
[accessToken](../README.md#accessToken)
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: Not defined
|
|
106
|
+
- **Accept**: Not defined
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
# **get_url_signing_key**
|
|
111
|
+
> SigningKeyResponse get_url_signing_key(signing_key_id)
|
|
112
|
+
|
|
113
|
+
Retrieve a URL signing key
|
|
114
|
+
|
|
115
|
+
Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**
|
|
116
|
+
|
|
117
|
+
### Example
|
|
118
|
+
```ruby
|
|
119
|
+
# load the gem
|
|
120
|
+
require 'mux_ruby'
|
|
121
|
+
# setup authorization
|
|
122
|
+
MuxRuby.configure do |config|
|
|
123
|
+
# Configure HTTP basic authorization: accessToken
|
|
124
|
+
config.username = 'YOUR USERNAME'
|
|
125
|
+
config.password = 'YOUR PASSWORD'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
api_instance = MuxRuby::URLSigningKeysApi.new
|
|
129
|
+
signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
|
|
130
|
+
|
|
131
|
+
begin
|
|
132
|
+
#Retrieve a URL signing key
|
|
133
|
+
result = api_instance.get_url_signing_key(signing_key_id)
|
|
134
|
+
p result
|
|
135
|
+
rescue MuxRuby::ApiError => e
|
|
136
|
+
puts "Exception when calling URLSigningKeysApi->get_url_signing_key: #{e}"
|
|
137
|
+
end
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
Name | Type | Description | Notes
|
|
143
|
+
------------- | ------------- | ------------- | -------------
|
|
144
|
+
**signing_key_id** | **String**| The ID of the signing key. |
|
|
145
|
+
|
|
146
|
+
### Return type
|
|
147
|
+
|
|
148
|
+
[**SigningKeyResponse**](SigningKeyResponse.md)
|
|
149
|
+
|
|
150
|
+
### Authorization
|
|
151
|
+
|
|
152
|
+
[accessToken](../README.md#accessToken)
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: Not defined
|
|
157
|
+
- **Accept**: application/json
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
# **list_url_signing_keys**
|
|
162
|
+
> ListSigningKeysResponse list_url_signing_keys(opts)
|
|
163
|
+
|
|
164
|
+
List URL signing keys
|
|
165
|
+
|
|
166
|
+
Returns a list of URL signing keys.
|
|
167
|
+
|
|
168
|
+
### Example
|
|
169
|
+
```ruby
|
|
170
|
+
# load the gem
|
|
171
|
+
require 'mux_ruby'
|
|
172
|
+
# setup authorization
|
|
173
|
+
MuxRuby.configure do |config|
|
|
174
|
+
# Configure HTTP basic authorization: accessToken
|
|
175
|
+
config.username = 'YOUR USERNAME'
|
|
176
|
+
config.password = 'YOUR PASSWORD'
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
api_instance = MuxRuby::URLSigningKeysApi.new
|
|
180
|
+
opts = {
|
|
181
|
+
limit: 25, # Integer | Number of items to include in the response
|
|
182
|
+
page: 1 # Integer | Offset by this many pages, of the size of `limit`
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
begin
|
|
186
|
+
#List URL signing keys
|
|
187
|
+
result = api_instance.list_url_signing_keys(opts)
|
|
188
|
+
p result
|
|
189
|
+
rescue MuxRuby::ApiError => e
|
|
190
|
+
puts "Exception when calling URLSigningKeysApi->list_url_signing_keys: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
Name | Type | Description | Notes
|
|
197
|
+
------------- | ------------- | ------------- | -------------
|
|
198
|
+
**limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
|
|
199
|
+
**page** | **Integer**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
[**ListSigningKeysResponse**](ListSigningKeysResponse.md)
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
[accessToken](../README.md#accessToken)
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: Not defined
|
|
212
|
+
- **Accept**: application/json
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
data/docs/Upload.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MuxRuby::Upload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600]
|
|
8
|
+
**status** | **String** | | [optional]
|
|
9
|
+
**new_asset_settings** | [**Asset**](Asset.md) | | [optional]
|
|
10
|
+
**asset_id** | **String** | Only set once the upload is in the `asset_created` state. | [optional]
|
|
11
|
+
**error** | [**UploadError**](UploadError.md) | | [optional]
|
|
12
|
+
**cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional]
|
|
13
|
+
**url** | **String** | The URL to upload the associated source media to. | [optional]
|
|
14
|
+
|
|
15
|
+
|
data/docs/UploadError.md
ADDED