mux_ruby 1.9.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (277) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +26 -37
  4. data/README.md +37 -13
  5. data/docs/AbridgedVideoView.md +33 -13
  6. data/docs/Asset.md +59 -26
  7. data/docs/AssetErrors.md +15 -4
  8. data/docs/AssetMaster.md +15 -4
  9. data/docs/AssetNonStandardInputReasons.md +29 -11
  10. data/docs/AssetRecordingTimes.md +15 -4
  11. data/docs/AssetResponse.md +13 -3
  12. data/docs/AssetStaticRenditions.md +15 -4
  13. data/docs/AssetStaticRenditionsFiles.md +23 -8
  14. data/docs/AssetsApi.md +396 -163
  15. data/docs/BreakdownValue.md +21 -7
  16. data/docs/CreateAssetRequest.md +27 -10
  17. data/docs/CreateLiveStreamRequest.md +29 -9
  18. data/docs/CreatePlaybackIDRequest.md +13 -3
  19. data/docs/CreatePlaybackIDResponse.md +13 -3
  20. data/docs/CreateSimulcastTargetRequest.md +17 -5
  21. data/docs/CreateTrackRequest.md +25 -9
  22. data/docs/CreateTrackResponse.md +13 -3
  23. data/docs/CreateUploadRequest.md +19 -6
  24. data/docs/DeliveryReport.md +27 -9
  25. data/docs/DeliveryUsageApi.md +41 -23
  26. data/docs/DimensionValue.md +15 -4
  27. data/docs/DimensionsApi.md +72 -34
  28. data/docs/DirectUploadsApi.md +131 -56
  29. data/docs/DisableLiveStreamResponse.md +13 -3
  30. data/docs/EnableLiveStreamResponse.md +13 -3
  31. data/docs/Error.md +27 -10
  32. data/docs/ErrorsApi.md +38 -20
  33. data/docs/ExportDate.md +20 -0
  34. data/docs/ExportFile.md +22 -0
  35. data/docs/ExportsApi.md +99 -12
  36. data/docs/FilterValue.md +15 -4
  37. data/docs/FiltersApi.md +71 -33
  38. data/docs/GetAssetInputInfoResponse.md +13 -3
  39. data/docs/GetAssetOrLiveStreamIdResponse.md +13 -3
  40. data/docs/GetAssetOrLiveStreamIdResponseData.md +17 -5
  41. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +15 -4
  42. data/docs/GetAssetPlaybackIDResponse.md +13 -3
  43. data/docs/GetMetricTimeseriesDataResponse.md +17 -5
  44. data/docs/GetOverallValuesResponse.md +17 -5
  45. data/docs/GetRealTimeBreakdownResponse.md +17 -5
  46. data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
  47. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
  48. data/docs/GetRealTimeTimeseriesResponse.md +17 -5
  49. data/docs/Incident.md +53 -23
  50. data/docs/IncidentBreakdown.md +17 -5
  51. data/docs/IncidentNotification.md +17 -5
  52. data/docs/IncidentNotificationRule.md +21 -7
  53. data/docs/IncidentResponse.md +15 -4
  54. data/docs/IncidentsApi.md +118 -62
  55. data/docs/InputFile.md +15 -4
  56. data/docs/InputInfo.md +15 -4
  57. data/docs/InputSettings.md +31 -12
  58. data/docs/InputSettingsOverlaySettings.md +25 -9
  59. data/docs/InputTrack.md +29 -11
  60. data/docs/Insight.md +23 -8
  61. data/docs/ListAllMetricValuesResponse.md +17 -5
  62. data/docs/ListAssetsResponse.md +13 -3
  63. data/docs/ListBreakdownValuesResponse.md +17 -5
  64. data/docs/ListDeliveryUsageResponse.md +19 -6
  65. data/docs/ListDimensionValuesResponse.md +17 -5
  66. data/docs/ListDimensionsResponse.md +17 -5
  67. data/docs/ListErrorsResponse.md +17 -5
  68. data/docs/ListExportsResponse.md +17 -5
  69. data/docs/ListFilterValuesResponse.md +17 -5
  70. data/docs/ListFiltersResponse.md +17 -5
  71. data/docs/ListFiltersResponseData.md +15 -4
  72. data/docs/ListIncidentsResponse.md +17 -5
  73. data/docs/ListInsightsResponse.md +17 -5
  74. data/docs/ListLiveStreamsResponse.md +13 -3
  75. data/docs/ListRealTimeDimensionsResponse.md +17 -5
  76. data/docs/ListRealTimeDimensionsResponseData.md +15 -4
  77. data/docs/ListRealTimeMetricsResponse.md +17 -5
  78. data/docs/ListRelatedIncidentsResponse.md +17 -5
  79. data/docs/ListSigningKeysResponse.md +13 -3
  80. data/docs/ListUploadsResponse.md +13 -3
  81. data/docs/ListVideoViewExportsResponse.md +22 -0
  82. data/docs/ListVideoViewsResponse.md +17 -5
  83. data/docs/LiveStream.md +41 -15
  84. data/docs/LiveStreamResponse.md +13 -3
  85. data/docs/LiveStreamsApi.md +418 -170
  86. data/docs/Metric.md +21 -7
  87. data/docs/MetricsApi.md +211 -117
  88. data/docs/NotificationRule.md +17 -5
  89. data/docs/OverallValues.md +19 -6
  90. data/docs/PlaybackID.md +15 -4
  91. data/docs/PlaybackIDApi.md +35 -17
  92. data/docs/PlaybackPolicy.md +10 -2
  93. data/docs/RealTimeApi.md +177 -81
  94. data/docs/RealTimeBreakdownValue.md +21 -7
  95. data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
  96. data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
  97. data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
  98. data/docs/RealTimeTimeseriesDatapoint.md +17 -5
  99. data/docs/Score.md +23 -8
  100. data/docs/SignalLiveStreamCompleteResponse.md +13 -3
  101. data/docs/SigningKey.md +17 -5
  102. data/docs/SigningKeyResponse.md +13 -3
  103. data/docs/SimulcastTarget.md +21 -7
  104. data/docs/SimulcastTargetResponse.md +13 -3
  105. data/docs/Track.md +37 -15
  106. data/docs/URLSigningKeysApi.md +130 -54
  107. data/docs/UpdateAssetMP4SupportRequest.md +13 -3
  108. data/docs/UpdateAssetMasterAccessRequest.md +13 -3
  109. data/docs/Upload.md +29 -11
  110. data/docs/UploadError.md +15 -4
  111. data/docs/UploadResponse.md +13 -3
  112. data/docs/VideoView.md +251 -114
  113. data/docs/VideoViewEvent.md +19 -6
  114. data/docs/VideoViewResponse.md +15 -4
  115. data/docs/VideoViewsApi.md +78 -41
  116. data/gen/.gitignore +7 -0
  117. data/gen/Makefile +31 -0
  118. data/gen/generator-config.json +11 -0
  119. data/gen/openapitools.json +7 -0
  120. data/gen/package.json +17 -0
  121. data/gen/templates/Gemfile.mustache +11 -0
  122. data/gen/templates/README.mustache +158 -0
  123. data/gen/templates/Rakefile.mustache +10 -0
  124. data/gen/templates/api.mustache +206 -0
  125. data/gen/templates/api_client.mustache +264 -0
  126. data/gen/templates/api_client_faraday_partial.mustache +138 -0
  127. data/gen/templates/api_client_spec.mustache +220 -0
  128. data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
  129. data/gen/templates/api_doc.mustache +118 -0
  130. data/gen/templates/api_error.mustache +67 -0
  131. data/gen/templates/api_info.mustache +12 -0
  132. data/gen/templates/api_test.mustache +47 -0
  133. data/gen/templates/base_object.mustache +120 -0
  134. data/gen/templates/configuration.mustache +349 -0
  135. data/gen/templates/configuration_spec.mustache +34 -0
  136. data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
  137. data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  138. data/gen/templates/gem.mustache +40 -0
  139. data/gen/templates/gemspec.mustache +35 -0
  140. data/gen/templates/gitignore.mustache +39 -0
  141. data/gen/templates/model.mustache +26 -0
  142. data/gen/templates/model_doc.mustache +12 -0
  143. data/gen/templates/model_test.mustache +77 -0
  144. data/gen/templates/partial_model_enum_class.mustache +20 -0
  145. data/gen/templates/partial_model_generic.mustache +371 -0
  146. data/gen/templates/partial_model_generic_doc.mustache +28 -0
  147. data/gen/templates/partial_oneof_module.mustache +137 -0
  148. data/gen/templates/partial_oneof_module_doc.mustache +92 -0
  149. data/gen/templates/rspec.mustache +2 -0
  150. data/gen/templates/rubocop.mustache +148 -0
  151. data/gen/templates/spec_helper.mustache +103 -0
  152. data/gen/templates/version.mustache +7 -0
  153. data/gen/yarn.lock +1878 -0
  154. data/lib/mux_ruby/api/assets_api.rb +293 -156
  155. data/lib/mux_ruby/api/delivery_usage_api.rb +32 -16
  156. data/lib/mux_ruby/api/dimensions_api.rb +55 -29
  157. data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
  158. data/lib/mux_ruby/api/errors_api.rb +34 -18
  159. data/lib/mux_ruby/api/exports_api.rb +86 -13
  160. data/lib/mux_ruby/api/filters_api.rb +53 -27
  161. data/lib/mux_ruby/api/incidents_api.rb +94 -52
  162. data/lib/mux_ruby/api/live_streams_api.rb +299 -157
  163. data/lib/mux_ruby/api/metrics_api.rb +193 -122
  164. data/lib/mux_ruby/api/playback_id_api.rb +33 -17
  165. data/lib/mux_ruby/api/real_time_api.rb +149 -87
  166. data/lib/mux_ruby/api/url_signing_keys_api.rb +95 -48
  167. data/lib/mux_ruby/api/video_views_api.rb +60 -33
  168. data/lib/mux_ruby/api_client.rb +94 -79
  169. data/lib/mux_ruby/api_error.rb +35 -7
  170. data/lib/mux_ruby/configuration.rb +50 -14
  171. data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
  172. data/lib/mux_ruby/models/asset.rb +100 -63
  173. data/lib/mux_ruby/models/asset_errors.rb +50 -15
  174. data/lib/mux_ruby/models/asset_master.rb +52 -17
  175. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +70 -35
  176. data/lib/mux_ruby/models/asset_recording_times.rb +50 -16
  177. data/lib/mux_ruby/models/asset_response.rb +48 -14
  178. data/lib/mux_ruby/models/asset_static_renditions.rb +53 -17
  179. data/lib/mux_ruby/models/asset_static_renditions_files.rb +58 -23
  180. data/lib/mux_ruby/models/breakdown_value.rb +52 -18
  181. data/lib/mux_ruby/models/create_asset_request.rb +64 -30
  182. data/lib/mux_ruby/models/create_live_stream_request.rb +78 -23
  183. data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
  184. data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
  185. data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
  186. data/lib/mux_ruby/models/create_track_request.rb +60 -26
  187. data/lib/mux_ruby/models/create_track_response.rb +48 -14
  188. data/lib/mux_ruby/models/create_upload_request.rb +52 -18
  189. data/lib/mux_ruby/models/delivery_report.rb +106 -21
  190. data/lib/mux_ruby/models/dimension_value.rb +49 -15
  191. data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
  192. data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
  193. data/lib/mux_ruby/models/error.rb +63 -21
  194. data/lib/mux_ruby/models/export_date.rb +229 -0
  195. data/lib/mux_ruby/models/export_file.rb +236 -0
  196. data/lib/mux_ruby/models/filter_value.rb +49 -15
  197. data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
  198. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +48 -14
  199. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +50 -16
  200. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +51 -17
  201. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
  202. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
  203. data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
  204. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
  205. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
  206. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
  207. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
  208. data/lib/mux_ruby/models/incident.rb +68 -34
  209. data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
  210. data/lib/mux_ruby/models/incident_notification.rb +50 -16
  211. data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
  212. data/lib/mux_ruby/models/incident_response.rb +49 -15
  213. data/lib/mux_ruby/models/input_file.rb +49 -15
  214. data/lib/mux_ruby/models/input_info.rb +49 -15
  215. data/lib/mux_ruby/models/input_settings.rb +64 -30
  216. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +58 -24
  217. data/lib/mux_ruby/models/input_track.rb +56 -22
  218. data/lib/mux_ruby/models/insight.rb +53 -19
  219. data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
  220. data/lib/mux_ruby/models/list_assets_response.rb +48 -14
  221. data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
  222. data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
  223. data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
  224. data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
  225. data/lib/mux_ruby/models/list_errors_response.rb +50 -16
  226. data/lib/mux_ruby/models/list_exports_response.rb +50 -16
  227. data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
  228. data/lib/mux_ruby/models/list_filters_response.rb +50 -16
  229. data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
  230. data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
  231. data/lib/mux_ruby/models/list_insights_response.rb +50 -16
  232. data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
  233. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
  234. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
  235. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
  236. data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
  237. data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
  238. data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
  239. data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
  240. data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
  241. data/lib/mux_ruby/models/live_stream.rb +131 -29
  242. data/lib/mux_ruby/models/live_stream_response.rb +48 -14
  243. data/lib/mux_ruby/models/metric.rb +52 -18
  244. data/lib/mux_ruby/models/notification_rule.rb +50 -16
  245. data/lib/mux_ruby/models/overall_values.rb +51 -17
  246. data/lib/mux_ruby/models/playback_id.rb +49 -15
  247. data/lib/mux_ruby/models/playback_policy.rb +12 -6
  248. data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
  249. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
  250. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
  251. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
  252. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
  253. data/lib/mux_ruby/models/score.rb +53 -19
  254. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
  255. data/lib/mux_ruby/models/signing_key.rb +53 -16
  256. data/lib/mux_ruby/models/signing_key_response.rb +48 -14
  257. data/lib/mux_ruby/models/simulcast_target.rb +54 -20
  258. data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
  259. data/lib/mux_ruby/models/track.rb +67 -33
  260. data/lib/mux_ruby/models/update_asset_master_access_request.rb +50 -16
  261. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +50 -16
  262. data/lib/mux_ruby/models/upload.rb +61 -25
  263. data/lib/mux_ruby/models/upload_error.rb +51 -15
  264. data/lib/mux_ruby/models/upload_response.rb +48 -14
  265. data/lib/mux_ruby/models/video_view.rb +242 -136
  266. data/lib/mux_ruby/models/video_view_event.rb +51 -17
  267. data/lib/mux_ruby/models/video_view_response.rb +49 -15
  268. data/lib/mux_ruby/version.rb +10 -3
  269. data/lib/mux_ruby.rb +12 -2
  270. data/mux_ruby.gemspec +15 -17
  271. data/spec/api_client_spec.rb +10 -3
  272. data/spec/configuration_spec.rb +9 -2
  273. data/spec/models/export_date_spec.rb +40 -0
  274. data/spec/models/export_file_spec.rb +46 -0
  275. data/spec/models/list_video_view_exports_response_spec.rb +46 -0
  276. data/spec/spec_helper.rb +9 -2
  277. metadata +149 -240
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::DisableLiveStreamResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Object**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::DisableLiveStreamResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::EnableLiveStreamResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Object**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::EnableLiveStreamResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
data/docs/Error.md CHANGED
@@ -1,15 +1,32 @@
1
1
  # MuxRuby::Error
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | | [optional]
7
- **percentage** | **Float** | | [optional]
8
- **notes** | **String** | | [optional]
9
- **message** | **String** | | [optional]
10
- **last_seen** | **String** | | [optional]
11
- **description** | **String** | | [optional]
12
- **count** | **Integer** | | [optional]
13
- **code** | **Integer** | | [optional]
14
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | A unique identifier for this error. | [optional] |
8
+ | **percentage** | **Float** | The percentage of views that experienced this error. | [optional] |
9
+ | **notes** | **String** | Notes that are attached to this error. | [optional] |
10
+ | **message** | **String** | The error message. | [optional] |
11
+ | **last_seen** | **String** | The last time this error was seen (ISO 8601 timestamp). | [optional] |
12
+ | **description** | **String** | Description of the error. | [optional] |
13
+ | **count** | **Integer** | The total number of views that experiend this error. | [optional] |
14
+ | **code** | **Integer** | The error code | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'mux_ruby'
20
+
21
+ instance = MuxRuby::Error.new(
22
+ id: null,
23
+ percentage: null,
24
+ notes: null,
25
+ message: null,
26
+ last_seen: null,
27
+ description: null,
28
+ count: null,
29
+ code: null
30
+ )
31
+ ```
15
32
 
data/docs/ErrorsApi.md CHANGED
@@ -2,21 +2,23 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**list_errors**](ErrorsApi.md#list_errors) | **GET** /data/v1/errors | List Errors
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**list_errors**](ErrorsApi.md#list_errors) | **GET** /data/v1/errors | List Errors |
8
8
 
9
9
 
10
- # **list_errors**
11
- > ListErrorsResponse list_errors(opts)
10
+ ## list_errors
11
+
12
+ > <ListErrorsResponse> list_errors(opts)
12
13
 
13
14
  List Errors
14
15
 
15
- Returns a list of errors
16
+ Returns a list of errors.
17
+
18
+ ### Examples
16
19
 
17
- ### Example
18
20
  ```ruby
19
- # load the gem
21
+ require 'time'
20
22
  require 'mux_ruby'
21
23
  # setup authorization
22
24
  MuxRuby.configure do |config|
@@ -27,25 +29,43 @@ end
27
29
 
28
30
  api_instance = MuxRuby::ErrorsApi.new
29
31
  opts = {
30
- 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.
31
- 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.
32
+ 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.
33
+ 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.
32
34
  }
33
35
 
34
36
  begin
35
- #List Errors
37
+ # List Errors
36
38
  result = api_instance.list_errors(opts)
37
39
  p result
38
40
  rescue MuxRuby::ApiError => e
39
- puts "Exception when calling ErrorsApi->list_errors: #{e}"
41
+ puts "Error when calling ErrorsApi->list_errors: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the list_errors_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<ListErrorsResponse>, Integer, Hash)> list_errors_with_http_info(opts)
50
+
51
+ ```ruby
52
+ begin
53
+ # List Errors
54
+ data, status_code, headers = api_instance.list_errors_with_http_info(opts)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <ListErrorsResponse>
58
+ rescue MuxRuby::ApiError => e
59
+ puts "Error when calling ErrorsApi->list_errors_with_http_info: #{e}"
40
60
  end
41
61
  ```
42
62
 
43
63
  ### Parameters
44
64
 
45
- Name | Type | Description | Notes
46
- ------------- | ------------- | ------------- | -------------
47
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
48
- **timeframe** | [**Array&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional]
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
68
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
49
69
 
50
70
  ### Return type
51
71
 
@@ -57,8 +77,6 @@ Name | Type | Description | Notes
57
77
 
58
78
  ### HTTP request headers
59
79
 
60
- - **Content-Type**: Not defined
61
- - **Accept**: application/json
62
-
63
-
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: application/json
64
82
 
@@ -0,0 +1,20 @@
1
+ # MuxRuby::ExportDate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **export_date** | **Date** | | [optional] |
8
+ | **files** | [**Array&lt;ExportFile&gt;**](ExportFile.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::ExportDate.new(
16
+ export_date: null,
17
+ files: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # MuxRuby::ExportFile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **Integer** | | [optional] |
8
+ | **type** | **String** | | [optional] |
9
+ | **path** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::ExportFile.new(
17
+ version: null,
18
+ type: null,
19
+ path: null
20
+ )
21
+ ```
22
+
data/docs/ExportsApi.md CHANGED
@@ -2,21 +2,24 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links |
8
+ | [**list_exports_views**](ExportsApi.md#list_exports_views) | **GET** /data/v1/exports/views | List available property view exports |
8
9
 
9
10
 
10
- # **list_exports**
11
- > ListExportsResponse list_exports
11
+ ## list_exports
12
+
13
+ > <ListExportsResponse> list_exports
12
14
 
13
15
  List property video view export links
14
16
 
15
- Lists the available video view exports along with URLs to retrieve them
17
+ Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
18
+
19
+ ### Examples
16
20
 
17
- ### Example
18
21
  ```ruby
19
- # load the gem
22
+ require 'time'
20
23
  require 'mux_ruby'
21
24
  # setup authorization
22
25
  MuxRuby.configure do |config|
@@ -28,15 +31,34 @@ end
28
31
  api_instance = MuxRuby::ExportsApi.new
29
32
 
30
33
  begin
31
- #List property video view export links
34
+ # List property video view export links
32
35
  result = api_instance.list_exports
33
36
  p result
34
37
  rescue MuxRuby::ApiError => e
35
- puts "Exception when calling ExportsApi->list_exports: #{e}"
38
+ puts "Error when calling ExportsApi->list_exports: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the list_exports_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<ListExportsResponse>, Integer, Hash)> list_exports_with_http_info
47
+
48
+ ```ruby
49
+ begin
50
+ # List property video view export links
51
+ data, status_code, headers = api_instance.list_exports_with_http_info
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <ListExportsResponse>
55
+ rescue MuxRuby::ApiError => e
56
+ puts "Error when calling ExportsApi->list_exports_with_http_info: #{e}"
36
57
  end
37
58
  ```
38
59
 
39
60
  ### Parameters
61
+
40
62
  This endpoint does not need any parameter.
41
63
 
42
64
  ### Return type
@@ -49,8 +71,73 @@ This endpoint does not need any parameter.
49
71
 
50
72
  ### HTTP request headers
51
73
 
52
- - **Content-Type**: Not defined
53
- - **Accept**: application/json
74
+ - **Content-Type**: Not defined
75
+ - **Accept**: application/json
76
+
77
+
78
+ ## list_exports_views
79
+
80
+ > <ListVideoViewExportsResponse> list_exports_views
81
+
82
+ List available property view exports
83
+
84
+ Lists the available video view exports along with URLs to retrieve them.
85
+
86
+ ### Examples
87
+
88
+ ```ruby
89
+ require 'time'
90
+ require 'mux_ruby'
91
+ # setup authorization
92
+ MuxRuby.configure do |config|
93
+ # Configure HTTP basic authorization: accessToken
94
+ config.username = 'YOUR USERNAME'
95
+ config.password = 'YOUR PASSWORD'
96
+ end
97
+
98
+ api_instance = MuxRuby::ExportsApi.new
99
+
100
+ begin
101
+ # List available property view exports
102
+ result = api_instance.list_exports_views
103
+ p result
104
+ rescue MuxRuby::ApiError => e
105
+ puts "Error when calling ExportsApi->list_exports_views: #{e}"
106
+ end
107
+ ```
108
+
109
+ #### Using the list_exports_views_with_http_info variant
110
+
111
+ This returns an Array which contains the response data, status code and headers.
112
+
113
+ > <Array(<ListVideoViewExportsResponse>, Integer, Hash)> list_exports_views_with_http_info
114
+
115
+ ```ruby
116
+ begin
117
+ # List available property view exports
118
+ data, status_code, headers = api_instance.list_exports_views_with_http_info
119
+ p status_code # => 2xx
120
+ p headers # => { ... }
121
+ p data # => <ListVideoViewExportsResponse>
122
+ rescue MuxRuby::ApiError => e
123
+ puts "Error when calling ExportsApi->list_exports_views_with_http_info: #{e}"
124
+ end
125
+ ```
126
+
127
+ ### Parameters
128
+
129
+ This endpoint does not need any parameter.
130
+
131
+ ### Return type
132
+
133
+ [**ListVideoViewExportsResponse**](ListVideoViewExportsResponse.md)
134
+
135
+ ### Authorization
54
136
 
137
+ [accessToken](../README.md#accessToken)
138
+
139
+ ### HTTP request headers
55
140
 
141
+ - **Content-Type**: Not defined
142
+ - **Accept**: application/json
56
143
 
data/docs/FilterValue.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::FilterValue
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **String** | | [optional]
7
- **total_count** | **Integer** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | [optional] |
8
+ | **total_count** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::FilterValue.new(
16
+ value: null,
17
+ total_count: null
18
+ )
19
+ ```
9
20
 
data/docs/FiltersApi.md CHANGED
@@ -2,22 +2,24 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**list_filter_values**](FiltersApi.md#list_filter_values) | **GET** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter
8
- [**list_filters**](FiltersApi.md#list_filters) | **GET** /data/v1/filters | List Filters
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**list_filter_values**](FiltersApi.md#list_filter_values) | **GET** /data/v1/filters/{FILTER_ID} | Lists values for a specific filter |
8
+ | [**list_filters**](FiltersApi.md#list_filters) | **GET** /data/v1/filters | List Filters |
9
9
 
10
10
 
11
- # **list_filter_values**
12
- > ListFilterValuesResponse list_filter_values(filter_id, opts)
11
+ ## list_filter_values
12
+
13
+ > <ListFilterValuesResponse> list_filter_values(filter_id, opts)
13
14
 
14
15
  Lists values for a specific filter
15
16
 
16
17
  Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
17
18
 
18
- ### Example
19
+ ### Examples
20
+
19
21
  ```ruby
20
- # load the gem
22
+ require 'time'
21
23
  require 'mux_ruby'
22
24
  # setup authorization
23
25
  MuxRuby.configure do |config|
@@ -29,30 +31,48 @@ end
29
31
  api_instance = MuxRuby::FiltersApi.new
30
32
  filter_id = 'abcd1234' # String | ID of the Filter
31
33
  opts = {
32
- limit: 25, # Integer | Number of items to include in the response
33
- page: 1, # Integer | Offset by this many pages, of the size of `limit`
34
- 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.
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.
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.
36
38
  }
37
39
 
38
40
  begin
39
- #Lists values for a specific filter
41
+ # Lists values for a specific filter
40
42
  result = api_instance.list_filter_values(filter_id, opts)
41
43
  p result
42
44
  rescue MuxRuby::ApiError => e
43
- puts "Exception when calling FiltersApi->list_filter_values: #{e}"
45
+ puts "Error when calling FiltersApi->list_filter_values: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the list_filter_values_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<ListFilterValuesResponse>, Integer, Hash)> list_filter_values_with_http_info(filter_id, opts)
54
+
55
+ ```ruby
56
+ begin
57
+ # Lists values for a specific filter
58
+ data, status_code, headers = api_instance.list_filter_values_with_http_info(filter_id, opts)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <ListFilterValuesResponse>
62
+ rescue MuxRuby::ApiError => e
63
+ puts "Error when calling FiltersApi->list_filter_values_with_http_info: #{e}"
44
64
  end
45
65
  ```
46
66
 
47
67
  ### Parameters
48
68
 
49
- Name | Type | Description | Notes
50
- ------------- | ------------- | ------------- | -------------
51
- **filter_id** | **String**| ID of the Filter |
52
- **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
53
- **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
54
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
55
- **timeframe** | [**Array&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional]
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **filter_id** | **String** | ID of the Filter | |
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 &#x60;limit&#x60; | [optional][default to 1] |
74
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
75
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
56
76
 
57
77
  ### Return type
58
78
 
@@ -64,21 +84,22 @@ Name | Type | Description | Notes
64
84
 
65
85
  ### HTTP request headers
66
86
 
67
- - **Content-Type**: Not defined
68
- - **Accept**: application/json
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
69
89
 
70
90
 
91
+ ## list_filters
71
92
 
72
- # **list_filters**
73
- > ListFiltersResponse list_filters
93
+ > <ListFiltersResponse> list_filters
74
94
 
75
95
  List Filters
76
96
 
77
97
  Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
78
98
 
79
- ### Example
99
+ ### Examples
100
+
80
101
  ```ruby
81
- # load the gem
102
+ require 'time'
82
103
  require 'mux_ruby'
83
104
  # setup authorization
84
105
  MuxRuby.configure do |config|
@@ -90,15 +111,34 @@ end
90
111
  api_instance = MuxRuby::FiltersApi.new
91
112
 
92
113
  begin
93
- #List Filters
114
+ # List Filters
94
115
  result = api_instance.list_filters
95
116
  p result
96
117
  rescue MuxRuby::ApiError => e
97
- puts "Exception when calling FiltersApi->list_filters: #{e}"
118
+ puts "Error when calling FiltersApi->list_filters: #{e}"
119
+ end
120
+ ```
121
+
122
+ #### Using the list_filters_with_http_info variant
123
+
124
+ This returns an Array which contains the response data, status code and headers.
125
+
126
+ > <Array(<ListFiltersResponse>, Integer, Hash)> list_filters_with_http_info
127
+
128
+ ```ruby
129
+ begin
130
+ # List Filters
131
+ data, status_code, headers = api_instance.list_filters_with_http_info
132
+ p status_code # => 2xx
133
+ p headers # => { ... }
134
+ p data # => <ListFiltersResponse>
135
+ rescue MuxRuby::ApiError => e
136
+ puts "Error when calling FiltersApi->list_filters_with_http_info: #{e}"
98
137
  end
99
138
  ```
100
139
 
101
140
  ### Parameters
141
+
102
142
  This endpoint does not need any parameter.
103
143
 
104
144
  ### Return type
@@ -111,8 +151,6 @@ This endpoint does not need any parameter.
111
151
 
112
152
  ### HTTP request headers
113
153
 
114
- - **Content-Type**: Not defined
115
- - **Accept**: application/json
116
-
117
-
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/json
118
156