mux_ruby 2.1.1 → 3.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +4 -4
  4. data/docs/Asset.md +1 -1
  5. data/docs/AssetNonStandardInputReasons.md +2 -0
  6. data/docs/AssetsApi.md +73 -0
  7. data/docs/CreateAssetRequest.md +1 -1
  8. data/docs/CreateLiveStreamRequest.md +6 -2
  9. data/docs/CreatePlaybackRestrictionRequest.md +18 -0
  10. data/docs/CreateSimulcastTargetRequest.md +1 -1
  11. data/docs/CreateTrackRequest.md +1 -1
  12. data/docs/DeliveryUsageApi.md +4 -2
  13. data/docs/DimensionsApi.md +4 -4
  14. data/docs/ErrorsApi.md +4 -4
  15. data/docs/ExportsApi.md +1 -1
  16. data/docs/FiltersApi.md +6 -6
  17. data/docs/GetLiveStreamPlaybackIDResponse.md +18 -0
  18. data/docs/InputSettings.md +1 -1
  19. data/docs/LiveStream.md +7 -3
  20. data/docs/LiveStreamEmbeddedSubtitleSettings.md +24 -0
  21. data/docs/LiveStreamsApi.md +217 -0
  22. data/docs/MetricsApi.md +20 -20
  23. data/docs/PlaybackRestriction.md +24 -0
  24. data/docs/PlaybackRestrictionResponse.md +15 -0
  25. data/docs/PlaybackRestrictionsApi.md +367 -0
  26. data/docs/RealTimeApi.md +6 -6
  27. data/docs/ReferrerDomainRestriction.md +20 -0
  28. data/docs/SimulcastTarget.md +1 -1
  29. data/docs/Track.md +1 -1
  30. data/docs/UpdateAssetRequest.md +18 -0
  31. data/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md +18 -0
  32. data/docs/UpdateLiveStreamRequest.md +22 -0
  33. data/docs/UpdateReferrerDomainRestrictionRequest.md +15 -0
  34. data/docs/VideoViewsApi.md +4 -4
  35. data/examples/data/exercise-errors.rb +0 -2
  36. data/examples/video/exercise-assets.rb +1 -0
  37. data/gen/generator-config.json +1 -1
  38. data/lib/mux_ruby/api/assets_api.rb +71 -0
  39. data/lib/mux_ruby/api/delivery_usage_api.rb +5 -2
  40. data/lib/mux_ruby/api/dimensions_api.rb +4 -4
  41. data/lib/mux_ruby/api/errors_api.rb +4 -4
  42. data/lib/mux_ruby/api/exports_api.rb +2 -2
  43. data/lib/mux_ruby/api/filters_api.rb +8 -8
  44. data/lib/mux_ruby/api/live_streams_api.rb +209 -0
  45. data/lib/mux_ruby/api/metrics_api.rb +20 -20
  46. data/lib/mux_ruby/api/playback_restrictions_api.rb +345 -0
  47. data/lib/mux_ruby/api/real_time_api.rb +6 -6
  48. data/lib/mux_ruby/api/video_views_api.rb +4 -4
  49. data/lib/mux_ruby/models/asset.rb +1 -1
  50. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +23 -1
  51. data/lib/mux_ruby/models/create_asset_request.rb +1 -1
  52. data/lib/mux_ruby/models/create_live_stream_request.rb +59 -3
  53. data/lib/mux_ruby/models/create_playback_restriction_request.rb +218 -0
  54. data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
  55. data/lib/mux_ruby/models/create_track_request.rb +1 -1
  56. data/lib/mux_ruby/models/get_live_stream_playback_id_response.rb +218 -0
  57. data/lib/mux_ruby/models/input_settings.rb +1 -1
  58. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +1 -1
  59. data/lib/mux_ruby/models/live_stream.rb +38 -4
  60. data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +287 -0
  61. data/lib/mux_ruby/models/playback_restriction.rb +248 -0
  62. data/lib/mux_ruby/models/playback_restriction_response.rb +209 -0
  63. data/lib/mux_ruby/models/referrer_domain_restriction.rb +234 -0
  64. data/lib/mux_ruby/models/simulcast_target.rb +1 -1
  65. data/lib/mux_ruby/models/track.rb +1 -13
  66. data/lib/mux_ruby/models/update_asset_request.rb +219 -0
  67. data/lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb +221 -0
  68. data/lib/mux_ruby/models/update_live_stream_request.rb +297 -0
  69. data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +209 -0
  70. data/lib/mux_ruby/version.rb +1 -1
  71. data/lib/mux_ruby.rb +11 -0
  72. data/spec/api/playback_restrictions_api_spec.rb +97 -0
  73. data/spec/models/create_playback_restriction_request_spec.rb +34 -0
  74. data/spec/models/get_live_stream_playback_id_response_spec.rb +34 -0
  75. data/spec/models/live_stream_embedded_subtitle_settings_spec.rb +56 -0
  76. data/spec/models/playback_restriction_response_spec.rb +28 -0
  77. data/spec/models/playback_restriction_spec.rb +52 -0
  78. data/spec/models/referrer_domain_restriction_spec.rb +40 -0
  79. data/spec/models/update_asset_request_spec.rb +34 -0
  80. data/spec/models/update_live_stream_embedded_subtitles_request_spec.rb +34 -0
  81. data/spec/models/update_live_stream_request_spec.rb +50 -0
  82. data/spec/models/update_referrer_domain_restriction_request_spec.rb +28 -0
  83. metadata +137 -93
@@ -13,10 +13,13 @@ All URIs are relative to *https://api.mux.com*
13
13
  | [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
14
14
  | [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
15
15
  | [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
16
+ | [**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID |
16
17
  | [**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target |
17
18
  | [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
18
19
  | [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key |
19
20
  | [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished |
21
+ | [**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream |
22
+ | [**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles |
20
23
 
21
24
 
22
25
  ## create_live_stream
@@ -646,6 +649,76 @@ end
646
649
  - **Accept**: application/json
647
650
 
648
651
 
652
+ ## get_live_stream_playback_id
653
+
654
+ > <GetLiveStreamPlaybackIDResponse> get_live_stream_playback_id(live_stream_id, playback_id)
655
+
656
+ Retrieve a live stream playback ID
657
+
658
+ ### Examples
659
+
660
+ ```ruby
661
+ require 'time'
662
+ require 'mux_ruby'
663
+ # setup authorization
664
+ MuxRuby.configure do |config|
665
+ # Configure HTTP basic authorization: accessToken
666
+ config.username = 'YOUR USERNAME'
667
+ config.password = 'YOUR PASSWORD'
668
+ end
669
+
670
+ api_instance = MuxRuby::LiveStreamsApi.new
671
+ live_stream_id = 'live_stream_id_example' # String | The live stream ID
672
+ playback_id = 'playback_id_example' # String | The live stream's playback ID.
673
+
674
+ begin
675
+ # Retrieve a live stream playback ID
676
+ result = api_instance.get_live_stream_playback_id(live_stream_id, playback_id)
677
+ p result
678
+ rescue MuxRuby::ApiError => e
679
+ puts "Error when calling LiveStreamsApi->get_live_stream_playback_id: #{e}"
680
+ end
681
+ ```
682
+
683
+ #### Using the get_live_stream_playback_id_with_http_info variant
684
+
685
+ This returns an Array which contains the response data, status code and headers.
686
+
687
+ > <Array(<GetLiveStreamPlaybackIDResponse>, Integer, Hash)> get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
688
+
689
+ ```ruby
690
+ begin
691
+ # Retrieve a live stream playback ID
692
+ data, status_code, headers = api_instance.get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
693
+ p status_code # => 2xx
694
+ p headers # => { ... }
695
+ p data # => <GetLiveStreamPlaybackIDResponse>
696
+ rescue MuxRuby::ApiError => e
697
+ puts "Error when calling LiveStreamsApi->get_live_stream_playback_id_with_http_info: #{e}"
698
+ end
699
+ ```
700
+
701
+ ### Parameters
702
+
703
+ | Name | Type | Description | Notes |
704
+ | ---- | ---- | ----------- | ----- |
705
+ | **live_stream_id** | **String** | The live stream ID | |
706
+ | **playback_id** | **String** | The live stream&#39;s playback ID. | |
707
+
708
+ ### Return type
709
+
710
+ [**GetLiveStreamPlaybackIDResponse**](GetLiveStreamPlaybackIDResponse.md)
711
+
712
+ ### Authorization
713
+
714
+ [accessToken](../README.md#accessToken)
715
+
716
+ ### HTTP request headers
717
+
718
+ - **Content-Type**: Not defined
719
+ - **Accept**: application/json
720
+
721
+
649
722
  ## get_live_stream_simulcast_target
650
723
 
651
724
  > <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
@@ -931,3 +1004,147 @@ end
931
1004
  - **Content-Type**: Not defined
932
1005
  - **Accept**: application/json
933
1006
 
1007
+
1008
+ ## update_live_stream
1009
+
1010
+ > <LiveStreamResponse> update_live_stream(live_stream_id, update_live_stream_request)
1011
+
1012
+ Update a live stream
1013
+
1014
+ Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.
1015
+
1016
+ ### Examples
1017
+
1018
+ ```ruby
1019
+ require 'time'
1020
+ require 'mux_ruby'
1021
+ # setup authorization
1022
+ MuxRuby.configure do |config|
1023
+ # Configure HTTP basic authorization: accessToken
1024
+ config.username = 'YOUR USERNAME'
1025
+ config.password = 'YOUR PASSWORD'
1026
+ end
1027
+
1028
+ api_instance = MuxRuby::LiveStreamsApi.new
1029
+ live_stream_id = 'live_stream_id_example' # String | The live stream ID
1030
+ update_live_stream_request = MuxRuby::UpdateLiveStreamRequest.new # UpdateLiveStreamRequest |
1031
+
1032
+ begin
1033
+ # Update a live stream
1034
+ result = api_instance.update_live_stream(live_stream_id, update_live_stream_request)
1035
+ p result
1036
+ rescue MuxRuby::ApiError => e
1037
+ puts "Error when calling LiveStreamsApi->update_live_stream: #{e}"
1038
+ end
1039
+ ```
1040
+
1041
+ #### Using the update_live_stream_with_http_info variant
1042
+
1043
+ This returns an Array which contains the response data, status code and headers.
1044
+
1045
+ > <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
1046
+
1047
+ ```ruby
1048
+ begin
1049
+ # Update a live stream
1050
+ data, status_code, headers = api_instance.update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
1051
+ p status_code # => 2xx
1052
+ p headers # => { ... }
1053
+ p data # => <LiveStreamResponse>
1054
+ rescue MuxRuby::ApiError => e
1055
+ puts "Error when calling LiveStreamsApi->update_live_stream_with_http_info: #{e}"
1056
+ end
1057
+ ```
1058
+
1059
+ ### Parameters
1060
+
1061
+ | Name | Type | Description | Notes |
1062
+ | ---- | ---- | ----------- | ----- |
1063
+ | **live_stream_id** | **String** | The live stream ID | |
1064
+ | **update_live_stream_request** | [**UpdateLiveStreamRequest**](UpdateLiveStreamRequest.md) | | |
1065
+
1066
+ ### Return type
1067
+
1068
+ [**LiveStreamResponse**](LiveStreamResponse.md)
1069
+
1070
+ ### Authorization
1071
+
1072
+ [accessToken](../README.md#accessToken)
1073
+
1074
+ ### HTTP request headers
1075
+
1076
+ - **Content-Type**: application/json
1077
+ - **Accept**: application/json
1078
+
1079
+
1080
+ ## update_live_stream_embedded_subtitles
1081
+
1082
+ > <LiveStreamResponse> update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
1083
+
1084
+ Update a live stream's embedded subtitles
1085
+
1086
+ Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.
1087
+
1088
+ ### Examples
1089
+
1090
+ ```ruby
1091
+ require 'time'
1092
+ require 'mux_ruby'
1093
+ # setup authorization
1094
+ MuxRuby.configure do |config|
1095
+ # Configure HTTP basic authorization: accessToken
1096
+ config.username = 'YOUR USERNAME'
1097
+ config.password = 'YOUR PASSWORD'
1098
+ end
1099
+
1100
+ api_instance = MuxRuby::LiveStreamsApi.new
1101
+ live_stream_id = 'live_stream_id_example' # String | The live stream ID
1102
+ update_live_stream_embedded_subtitles_request = MuxRuby::UpdateLiveStreamEmbeddedSubtitlesRequest.new # UpdateLiveStreamEmbeddedSubtitlesRequest |
1103
+
1104
+ begin
1105
+ # Update a live stream's embedded subtitles
1106
+ result = api_instance.update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
1107
+ p result
1108
+ rescue MuxRuby::ApiError => e
1109
+ puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles: #{e}"
1110
+ end
1111
+ ```
1112
+
1113
+ #### Using the update_live_stream_embedded_subtitles_with_http_info variant
1114
+
1115
+ This returns an Array which contains the response data, status code and headers.
1116
+
1117
+ > <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
1118
+
1119
+ ```ruby
1120
+ begin
1121
+ # Update a live stream's embedded subtitles
1122
+ data, status_code, headers = api_instance.update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
1123
+ p status_code # => 2xx
1124
+ p headers # => { ... }
1125
+ p data # => <LiveStreamResponse>
1126
+ rescue MuxRuby::ApiError => e
1127
+ puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles_with_http_info: #{e}"
1128
+ end
1129
+ ```
1130
+
1131
+ ### Parameters
1132
+
1133
+ | Name | Type | Description | Notes |
1134
+ | ---- | ---- | ----------- | ----- |
1135
+ | **live_stream_id** | **String** | The live stream ID | |
1136
+ | **update_live_stream_embedded_subtitles_request** | [**UpdateLiveStreamEmbeddedSubtitlesRequest**](UpdateLiveStreamEmbeddedSubtitlesRequest.md) | | |
1137
+
1138
+ ### Return type
1139
+
1140
+ [**LiveStreamResponse**](LiveStreamResponse.md)
1141
+
1142
+ ### Authorization
1143
+
1144
+ [accessToken](../README.md#accessToken)
1145
+
1146
+ ### HTTP request headers
1147
+
1148
+ - **Content-Type**: application/json
1149
+ - **Accept**: application/json
1150
+
data/docs/MetricsApi.md CHANGED
@@ -34,11 +34,11 @@ end
34
34
  api_instance = MuxRuby::MetricsApi.new
35
35
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
36
36
  opts = {
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
- 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
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
39
39
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
40
40
  order_direction: 'asc', # String | Sort order.
41
- group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
41
+ group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
42
42
  }
43
43
 
44
44
  begin
@@ -73,11 +73,11 @@ end
73
73
  | Name | Type | Description | Notes |
74
74
  | ---- | ---- | ----------- | ----- |
75
75
  | **metric_id** | **String** | ID of the Metric | |
76
- | **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] |
77
- | **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] |
76
+ | **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
77
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
78
78
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
79
79
  | **order_direction** | **String** | Sort order. | [optional] |
80
- | **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] |
80
+ | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 hours inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 hours is &#x60;day&#x60;. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] |
81
81
 
82
82
  ### Return type
83
83
 
@@ -116,8 +116,8 @@ end
116
116
  api_instance = MuxRuby::MetricsApi.new
117
117
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
118
118
  opts = {
119
- 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.
120
- 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.
119
+ 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`
120
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
121
121
  measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
122
122
  }
123
123
 
@@ -153,8 +153,8 @@ end
153
153
  | Name | Type | Description | Notes |
154
154
  | ---- | ---- | ----------- | ----- |
155
155
  | **metric_id** | **String** | ID of the Metric | |
156
- | **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] |
157
- | **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] |
156
+ | **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
157
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
158
158
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
159
159
 
160
160
  ### Return type
@@ -193,8 +193,8 @@ end
193
193
 
194
194
  api_instance = MuxRuby::MetricsApi.new
195
195
  opts = {
196
- 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.
197
- 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.
196
+ 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`
197
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
198
198
  dimension: 'asn', # String | Dimension the specified value belongs to
199
199
  value: 'value_example' # String | Value to show all available metrics for
200
200
  }
@@ -230,8 +230,8 @@ end
230
230
 
231
231
  | Name | Type | Description | Notes |
232
232
  | ---- | ---- | ----------- | ----- |
233
- | **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] |
234
- | **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] |
233
+ | **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
234
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
235
235
  | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
236
236
  | **value** | **String** | Value to show all available metrics for | [optional] |
237
237
 
@@ -274,12 +274,12 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
274
274
  opts = {
275
275
  group_by: 'asn', # String | Breakdown value to group the results by
276
276
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
277
- 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.
277
+ filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
278
278
  limit: 56, # Integer | Number of items to include in the response
279
279
  page: 56, # Integer | Offset by this many pages, of the size of `limit`
280
280
  order_by: 'negative_impact', # String | Value to order the results by
281
281
  order_direction: 'asc', # String | Sort order.
282
- 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.
282
+ 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`
283
283
  }
284
284
 
285
285
  begin
@@ -316,12 +316,12 @@ end
316
316
  | **metric_id** | **String** | ID of the Metric | |
317
317
  | **group_by** | **String** | Breakdown value to group the results by | [optional] |
318
318
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
319
- | **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] |
319
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
320
320
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
321
321
  | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
322
322
  | **order_by** | **String** | Value to order the results by | [optional] |
323
323
  | **order_direction** | **String** | Sort order. | [optional] |
324
- | **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] |
324
+ | **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
325
325
 
326
326
  ### Return type
327
327
 
@@ -362,7 +362,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
362
362
  opts = {
363
363
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
364
364
  order_direction: 'asc', # String | Sort order.
365
- 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.
365
+ 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`
366
366
  }
367
367
 
368
368
  begin
@@ -399,7 +399,7 @@ end
399
399
  | **metric_id** | **String** | ID of the Metric | |
400
400
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
401
401
  | **order_direction** | **String** | Sort order. | [optional] |
402
- | **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] |
402
+ | **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
403
403
 
404
404
  ### Return type
405
405
 
@@ -0,0 +1,24 @@
1
+ # MuxRuby::PlaybackRestriction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Playback Restriction. Max 255 characters. | [optional] |
8
+ | **created_at** | **String** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
9
+ | **updated_at** | **String** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
10
+ | **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mux_ruby'
16
+
17
+ instance = MuxRuby::PlaybackRestriction.new(
18
+ id: null,
19
+ created_at: null,
20
+ updated_at: null,
21
+ referrer: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # MuxRuby::PlaybackRestrictionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::PlaybackRestrictionResponse.new()
14
+ ```
15
+