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
@@ -677,6 +677,77 @@ module MuxRuby
677
677
  return data, status_code, headers
678
678
  end
679
679
 
680
+ # Update an Asset
681
+ # Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
682
+ # @param asset_id [String] The asset ID.
683
+ # @param update_asset_request [UpdateAssetRequest]
684
+ # @param [Hash] opts the optional parameters
685
+ # @return [AssetResponse]
686
+ def update_asset(asset_id, update_asset_request, opts = {})
687
+ data, _status_code, _headers = update_asset_with_http_info(asset_id, update_asset_request, opts)
688
+ data
689
+ end
690
+
691
+ # Update an Asset
692
+ # Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
693
+ # @param asset_id [String] The asset ID.
694
+ # @param update_asset_request [UpdateAssetRequest]
695
+ # @param [Hash] opts the optional parameters
696
+ # @return [Array<(AssetResponse, Integer, Hash)>] AssetResponse data, response status code and response headers
697
+ def update_asset_with_http_info(asset_id, update_asset_request, opts = {})
698
+ if @api_client.config.debugging
699
+ @api_client.config.logger.debug 'Calling API: AssetsApi.update_asset ...'
700
+ end
701
+ # verify the required parameter 'asset_id' is set
702
+ if @api_client.config.client_side_validation && asset_id.nil?
703
+ fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.update_asset"
704
+ end
705
+ # verify the required parameter 'update_asset_request' is set
706
+ if @api_client.config.client_side_validation && update_asset_request.nil?
707
+ fail ArgumentError, "Missing the required parameter 'update_asset_request' when calling AssetsApi.update_asset"
708
+ end
709
+ # resource path
710
+ local_var_path = '/video/v1/assets/{ASSET_ID}'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s))
711
+
712
+ # query parameters
713
+ query_params = opts[:query_params] || {}
714
+
715
+ # header parameters
716
+ header_params = opts[:header_params] || {}
717
+ # HTTP header 'Accept' (if needed)
718
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
719
+ # HTTP header 'Content-Type'
720
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
721
+
722
+ # form parameters
723
+ form_params = opts[:form_params] || {}
724
+
725
+ # http body (model)
726
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_asset_request)
727
+
728
+ # return_type
729
+ return_type = opts[:debug_return_type] || 'AssetResponse'
730
+
731
+ # auth_names
732
+ auth_names = opts[:debug_auth_names] || ['accessToken']
733
+
734
+ new_options = opts.merge(
735
+ :operation => :"AssetsApi.update_asset",
736
+ :header_params => header_params,
737
+ :query_params => query_params,
738
+ :form_params => form_params,
739
+ :body => post_body,
740
+ :auth_names => auth_names,
741
+ :return_type => return_type
742
+ )
743
+
744
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug "API called: AssetsApi#update_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
747
+ end
748
+ return data, status_code, headers
749
+ end
750
+
680
751
  # Update master access
681
752
  # Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
682
753
  # @param asset_id [String] The asset ID.
@@ -24,7 +24,8 @@ module MuxRuby
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
26
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 100)
27
- # @option opts [String] :asset_id Filter response to return delivery usage for this asset only.
27
+ # @option opts [String] :asset_id Filter response to return delivery usage for this asset only. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together.
28
+ # @option opts [String] :live_stream_id Filter response to return delivery usage for assets for this live stream. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together.
28
29
  # @option opts [Array<String>] :timeframe Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
29
30
  # @return [ListDeliveryUsageResponse]
30
31
  def list_delivery_usage(opts = {})
@@ -37,7 +38,8 @@ module MuxRuby
37
38
  # @param [Hash] opts the optional parameters
38
39
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
39
40
  # @option opts [Integer] :limit Number of items to include in the response
40
- # @option opts [String] :asset_id Filter response to return delivery usage for this asset only.
41
+ # @option opts [String] :asset_id Filter response to return delivery usage for this asset only. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together.
42
+ # @option opts [String] :live_stream_id Filter response to return delivery usage for assets for this live stream. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together.
41
43
  # @option opts [Array<String>] :timeframe Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
42
44
  # @return [Array<(ListDeliveryUsageResponse, Integer, Hash)>] ListDeliveryUsageResponse data, response status code and response headers
43
45
  def list_delivery_usage_with_http_info(opts = {})
@@ -52,6 +54,7 @@ module MuxRuby
52
54
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
53
55
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
54
56
  query_params[:'asset_id'] = opts[:'asset_id'] if !opts[:'asset_id'].nil?
57
+ query_params[:'live_stream_id'] = opts[:'live_stream_id'] if !opts[:'live_stream_id'].nil?
55
58
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
56
59
 
57
60
  # header parameters
@@ -25,8 +25,8 @@ module MuxRuby
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
27
27
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
28
- # @option opts [Array<String>] :filters 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.
29
- # @option opts [Array<String>] :timeframe 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.
28
+ # @option opts [Array<String>] :filters 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;
29
+ # @option opts [Array<String>] :timeframe 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;
30
30
  # @return [ListDimensionValuesResponse]
31
31
  def list_dimension_values(dimension_id, opts = {})
32
32
  data, _status_code, _headers = list_dimension_values_with_http_info(dimension_id, opts)
@@ -39,8 +39,8 @@ module MuxRuby
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @option opts [Integer] :limit Number of items to include in the response
41
41
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
42
- # @option opts [Array<String>] :filters 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.
43
- # @option opts [Array<String>] :timeframe 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.
42
+ # @option opts [Array<String>] :filters 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;
43
+ # @option opts [Array<String>] :timeframe 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;
44
44
  # @return [Array<(ListDimensionValuesResponse, Integer, Hash)>] ListDimensionValuesResponse data, response status code and response headers
45
45
  def list_dimension_values_with_http_info(dimension_id, opts = {})
46
46
  if @api_client.config.debugging
@@ -22,8 +22,8 @@ module MuxRuby
22
22
  # List Errors
23
23
  # Returns a list of errors.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Array<String>] :filters 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.
26
- # @option opts [Array<String>] :timeframe 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.
25
+ # @option opts [Array<String>] :filters 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;
26
+ # @option opts [Array<String>] :timeframe 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;
27
27
  # @return [ListErrorsResponse]
28
28
  def list_errors(opts = {})
29
29
  data, _status_code, _headers = list_errors_with_http_info(opts)
@@ -33,8 +33,8 @@ module MuxRuby
33
33
  # List Errors
34
34
  # Returns a list of errors.
35
35
  # @param [Hash] opts the optional parameters
36
- # @option opts [Array<String>] :filters 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.
37
- # @option opts [Array<String>] :timeframe 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.
36
+ # @option opts [Array<String>] :filters 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;
37
+ # @option opts [Array<String>] :timeframe 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;
38
38
  # @return [Array<(ListErrorsResponse, Integer, Hash)>] ListErrorsResponse data, response status code and response headers
39
39
  def list_errors_with_http_info(opts = {})
40
40
  if @api_client.config.debugging
@@ -20,7 +20,7 @@ module MuxRuby
20
20
  @api_client = api_client
21
21
  end
22
22
  # List property video view export links
23
- # 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.
23
+ # The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [ListExportsResponse]
26
26
  def list_exports(opts = {})
@@ -29,7 +29,7 @@ module MuxRuby
29
29
  end
30
30
 
31
31
  # List property video view export links
32
- # 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.
32
+ # The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(ListExportsResponse, Integer, Hash)>] ListExportsResponse data, response status code and response headers
35
35
  def list_exports_with_http_info(opts = {})
@@ -20,13 +20,13 @@ module MuxRuby
20
20
  @api_client = api_client
21
21
  end
22
22
  # Lists values for a specific filter
23
- # 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.
23
+ # 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.
24
24
  # @param filter_id [String] ID of the Filter
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
27
27
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
28
- # @option opts [Array<String>] :filters 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.
29
- # @option opts [Array<String>] :timeframe 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.
28
+ # @option opts [Array<String>] :filters 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;
29
+ # @option opts [Array<String>] :timeframe 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;
30
30
  # @return [ListFilterValuesResponse]
31
31
  def list_filter_values(filter_id, opts = {})
32
32
  data, _status_code, _headers = list_filter_values_with_http_info(filter_id, opts)
@@ -34,13 +34,13 @@ module MuxRuby
34
34
  end
35
35
 
36
36
  # Lists values for a specific filter
37
- # 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.
37
+ # 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.
38
38
  # @param filter_id [String] ID of the Filter
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @option opts [Integer] :limit Number of items to include in the response
41
41
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
42
- # @option opts [Array<String>] :filters 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.
43
- # @option opts [Array<String>] :timeframe 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.
42
+ # @option opts [Array<String>] :filters 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;
43
+ # @option opts [Array<String>] :timeframe 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;
44
44
  # @return [Array<(ListFilterValuesResponse, Integer, Hash)>] ListFilterValuesResponse data, response status code and response headers
45
45
  def list_filter_values_with_http_info(filter_id, opts = {})
46
46
  if @api_client.config.debugging
@@ -95,7 +95,7 @@ module MuxRuby
95
95
  end
96
96
 
97
97
  # List Filters
98
- # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
98
+ # The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [ListFiltersResponse]
101
101
  def list_filters(opts = {})
@@ -104,7 +104,7 @@ module MuxRuby
104
104
  end
105
105
 
106
106
  # List Filters
107
- # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
107
+ # The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
108
108
  # @param [Hash] opts the optional parameters
109
109
  # @return [Array<(ListFiltersResponse, Integer, Hash)>] ListFiltersResponse data, response status code and response headers
110
110
  def list_filters_with_http_info(opts = {})
@@ -602,6 +602,73 @@ module MuxRuby
602
602
  return data, status_code, headers
603
603
  end
604
604
 
605
+ # Retrieve a live stream playback ID
606
+ # @param live_stream_id [String] The live stream ID
607
+ # @param playback_id [String] The live stream&#39;s playback ID.
608
+ # @param [Hash] opts the optional parameters
609
+ # @return [GetLiveStreamPlaybackIDResponse]
610
+ def get_live_stream_playback_id(live_stream_id, playback_id, opts = {})
611
+ data, _status_code, _headers = get_live_stream_playback_id_with_http_info(live_stream_id, playback_id, opts)
612
+ data
613
+ end
614
+
615
+ # Retrieve a live stream playback ID
616
+ # @param live_stream_id [String] The live stream ID
617
+ # @param playback_id [String] The live stream&#39;s playback ID.
618
+ # @param [Hash] opts the optional parameters
619
+ # @return [Array<(GetLiveStreamPlaybackIDResponse, Integer, Hash)>] GetLiveStreamPlaybackIDResponse data, response status code and response headers
620
+ def get_live_stream_playback_id_with_http_info(live_stream_id, playback_id, opts = {})
621
+ if @api_client.config.debugging
622
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.get_live_stream_playback_id ...'
623
+ end
624
+ # verify the required parameter 'live_stream_id' is set
625
+ if @api_client.config.client_side_validation && live_stream_id.nil?
626
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.get_live_stream_playback_id"
627
+ end
628
+ # verify the required parameter 'playback_id' is set
629
+ if @api_client.config.client_side_validation && playback_id.nil?
630
+ fail ArgumentError, "Missing the required parameter 'playback_id' when calling LiveStreamsApi.get_live_stream_playback_id"
631
+ end
632
+ # resource path
633
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s)).sub('{' + 'PLAYBACK_ID' + '}', CGI.escape(playback_id.to_s))
634
+
635
+ # query parameters
636
+ query_params = opts[:query_params] || {}
637
+
638
+ # header parameters
639
+ header_params = opts[:header_params] || {}
640
+ # HTTP header 'Accept' (if needed)
641
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
642
+
643
+ # form parameters
644
+ form_params = opts[:form_params] || {}
645
+
646
+ # http body (model)
647
+ post_body = opts[:debug_body]
648
+
649
+ # return_type
650
+ return_type = opts[:debug_return_type] || 'GetLiveStreamPlaybackIDResponse'
651
+
652
+ # auth_names
653
+ auth_names = opts[:debug_auth_names] || ['accessToken']
654
+
655
+ new_options = opts.merge(
656
+ :operation => :"LiveStreamsApi.get_live_stream_playback_id",
657
+ :header_params => header_params,
658
+ :query_params => query_params,
659
+ :form_params => form_params,
660
+ :body => post_body,
661
+ :auth_names => auth_names,
662
+ :return_type => return_type
663
+ )
664
+
665
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
666
+ if @api_client.config.debugging
667
+ @api_client.config.logger.debug "API called: LiveStreamsApi#get_live_stream_playback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
668
+ end
669
+ return data, status_code, headers
670
+ end
671
+
605
672
  # Retrieve a Live Stream Simulcast Target
606
673
  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
607
674
  # @param live_stream_id [String] The live stream ID
@@ -860,5 +927,147 @@ module MuxRuby
860
927
  end
861
928
  return data, status_code, headers
862
929
  end
930
+
931
+ # Update a live stream
932
+ # 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.
933
+ # @param live_stream_id [String] The live stream ID
934
+ # @param update_live_stream_request [UpdateLiveStreamRequest]
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [LiveStreamResponse]
937
+ def update_live_stream(live_stream_id, update_live_stream_request, opts = {})
938
+ data, _status_code, _headers = update_live_stream_with_http_info(live_stream_id, update_live_stream_request, opts)
939
+ data
940
+ end
941
+
942
+ # Update a live stream
943
+ # 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.
944
+ # @param live_stream_id [String] The live stream ID
945
+ # @param update_live_stream_request [UpdateLiveStreamRequest]
946
+ # @param [Hash] opts the optional parameters
947
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
948
+ def update_live_stream_with_http_info(live_stream_id, update_live_stream_request, opts = {})
949
+ if @api_client.config.debugging
950
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream ...'
951
+ end
952
+ # verify the required parameter 'live_stream_id' is set
953
+ if @api_client.config.client_side_validation && live_stream_id.nil?
954
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream"
955
+ end
956
+ # verify the required parameter 'update_live_stream_request' is set
957
+ if @api_client.config.client_side_validation && update_live_stream_request.nil?
958
+ fail ArgumentError, "Missing the required parameter 'update_live_stream_request' when calling LiveStreamsApi.update_live_stream"
959
+ end
960
+ # resource path
961
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
962
+
963
+ # query parameters
964
+ query_params = opts[:query_params] || {}
965
+
966
+ # header parameters
967
+ header_params = opts[:header_params] || {}
968
+ # HTTP header 'Accept' (if needed)
969
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
970
+ # HTTP header 'Content-Type'
971
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
972
+
973
+ # form parameters
974
+ form_params = opts[:form_params] || {}
975
+
976
+ # http body (model)
977
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_request)
978
+
979
+ # return_type
980
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
981
+
982
+ # auth_names
983
+ auth_names = opts[:debug_auth_names] || ['accessToken']
984
+
985
+ new_options = opts.merge(
986
+ :operation => :"LiveStreamsApi.update_live_stream",
987
+ :header_params => header_params,
988
+ :query_params => query_params,
989
+ :form_params => form_params,
990
+ :body => post_body,
991
+ :auth_names => auth_names,
992
+ :return_type => return_type
993
+ )
994
+
995
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
996
+ if @api_client.config.debugging
997
+ @api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
998
+ end
999
+ return data, status_code, headers
1000
+ end
1001
+
1002
+ # Update a live stream's embedded subtitles
1003
+ # Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.
1004
+ # @param live_stream_id [String] The live stream ID
1005
+ # @param update_live_stream_embedded_subtitles_request [UpdateLiveStreamEmbeddedSubtitlesRequest]
1006
+ # @param [Hash] opts the optional parameters
1007
+ # @return [LiveStreamResponse]
1008
+ def update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request, opts = {})
1009
+ data, _status_code, _headers = update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request, opts)
1010
+ data
1011
+ end
1012
+
1013
+ # Update a live stream&#39;s embedded subtitles
1014
+ # Configures a live stream to receive embedded closed captions. The resulting Asset&#39;s subtitle text track will have &#x60;closed_captions: true&#x60; set.
1015
+ # @param live_stream_id [String] The live stream ID
1016
+ # @param update_live_stream_embedded_subtitles_request [UpdateLiveStreamEmbeddedSubtitlesRequest]
1017
+ # @param [Hash] opts the optional parameters
1018
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
1019
+ def update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request, opts = {})
1020
+ if @api_client.config.debugging
1021
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream_embedded_subtitles ...'
1022
+ end
1023
+ # verify the required parameter 'live_stream_id' is set
1024
+ if @api_client.config.client_side_validation && live_stream_id.nil?
1025
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream_embedded_subtitles"
1026
+ end
1027
+ # verify the required parameter 'update_live_stream_embedded_subtitles_request' is set
1028
+ if @api_client.config.client_side_validation && update_live_stream_embedded_subtitles_request.nil?
1029
+ fail ArgumentError, "Missing the required parameter 'update_live_stream_embedded_subtitles_request' when calling LiveStreamsApi.update_live_stream_embedded_subtitles"
1030
+ end
1031
+ # resource path
1032
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
1033
+
1034
+ # query parameters
1035
+ query_params = opts[:query_params] || {}
1036
+
1037
+ # header parameters
1038
+ header_params = opts[:header_params] || {}
1039
+ # HTTP header 'Accept' (if needed)
1040
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1041
+ # HTTP header 'Content-Type'
1042
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1043
+
1044
+ # form parameters
1045
+ form_params = opts[:form_params] || {}
1046
+
1047
+ # http body (model)
1048
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_embedded_subtitles_request)
1049
+
1050
+ # return_type
1051
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
1052
+
1053
+ # auth_names
1054
+ auth_names = opts[:debug_auth_names] || ['accessToken']
1055
+
1056
+ new_options = opts.merge(
1057
+ :operation => :"LiveStreamsApi.update_live_stream_embedded_subtitles",
1058
+ :header_params => header_params,
1059
+ :query_params => query_params,
1060
+ :form_params => form_params,
1061
+ :body => post_body,
1062
+ :auth_names => auth_names,
1063
+ :return_type => return_type
1064
+ )
1065
+
1066
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1067
+ if @api_client.config.debugging
1068
+ @api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream_embedded_subtitles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1069
+ end
1070
+ return data, status_code, headers
1071
+ end
863
1072
  end
864
1073
  end
@@ -23,11 +23,11 @@ module MuxRuby
23
23
  # Returns timeseries data for a specific metric.
24
24
  # @param metric_id [String] ID of the Metric
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :timeframe 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.
27
- # @option opts [Array<String>] :filters 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.
26
+ # @option opts [Array<String>] :timeframe 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;
27
+ # @option opts [Array<String>] :filters 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;
28
28
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
29
29
  # @option opts [String] :order_direction Sort order.
30
- # @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
30
+ # @option opts [String] :group_by 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.
31
31
  # @return [GetMetricTimeseriesDataResponse]
32
32
  def get_metric_timeseries_data(metric_id, opts = {})
33
33
  data, _status_code, _headers = get_metric_timeseries_data_with_http_info(metric_id, opts)
@@ -38,11 +38,11 @@ module MuxRuby
38
38
  # Returns timeseries data for a specific metric.
39
39
  # @param metric_id [String] ID of the Metric
40
40
  # @param [Hash] opts the optional parameters
41
- # @option opts [Array<String>] :timeframe 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.
42
- # @option opts [Array<String>] :filters 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.
41
+ # @option opts [Array<String>] :timeframe 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;
42
+ # @option opts [Array<String>] :filters 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;
43
43
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
44
44
  # @option opts [String] :order_direction Sort order.
45
- # @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
45
+ # @option opts [String] :group_by 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.
46
46
  # @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
47
47
  def get_metric_timeseries_data_with_http_info(metric_id, opts = {})
48
48
  if @api_client.config.debugging
@@ -118,8 +118,8 @@ module MuxRuby
118
118
  # 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.
119
119
  # @param metric_id [String] ID of the Metric
120
120
  # @param [Hash] opts the optional parameters
121
- # @option opts [Array<String>] :timeframe 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.
122
- # @option opts [Array<String>] :filters 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.
121
+ # @option opts [Array<String>] :timeframe 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;
122
+ # @option opts [Array<String>] :filters 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;
123
123
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
124
124
  # @return [GetOverallValuesResponse]
125
125
  def get_overall_values(metric_id, opts = {})
@@ -131,8 +131,8 @@ module MuxRuby
131
131
  # 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.
132
132
  # @param metric_id [String] ID of the Metric
133
133
  # @param [Hash] opts the optional parameters
134
- # @option opts [Array<String>] :timeframe 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.
135
- # @option opts [Array<String>] :filters 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.
134
+ # @option opts [Array<String>] :timeframe 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;
135
+ # @option opts [Array<String>] :filters 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;
136
136
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
137
137
  # @return [Array<(GetOverallValuesResponse, Integer, Hash)>] GetOverallValuesResponse data, response status code and response headers
138
138
  def get_overall_values_with_http_info(metric_id, opts = {})
@@ -198,8 +198,8 @@ module MuxRuby
198
198
  # List all metric values
199
199
  # List all of the values across every breakdown for a specific metric.
200
200
  # @param [Hash] opts the optional parameters
201
- # @option opts [Array<String>] :timeframe 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.
202
- # @option opts [Array<String>] :filters 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.
201
+ # @option opts [Array<String>] :timeframe 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;
202
+ # @option opts [Array<String>] :filters 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;
203
203
  # @option opts [String] :dimension Dimension the specified value belongs to
204
204
  # @option opts [String] :value Value to show all available metrics for
205
205
  # @return [ListAllMetricValuesResponse]
@@ -211,8 +211,8 @@ module MuxRuby
211
211
  # List all metric values
212
212
  # List all of the values across every breakdown for a specific metric.
213
213
  # @param [Hash] opts the optional parameters
214
- # @option opts [Array<String>] :timeframe 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.
215
- # @option opts [Array<String>] :filters 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.
214
+ # @option opts [Array<String>] :timeframe 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;
215
+ # @option opts [Array<String>] :filters 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;
216
216
  # @option opts [String] :dimension Dimension the specified value belongs to
217
217
  # @option opts [String] :value Value to show all available metrics for
218
218
  # @return [Array<(ListAllMetricValuesResponse, Integer, Hash)>] ListAllMetricValuesResponse data, response status code and response headers
@@ -274,12 +274,12 @@ module MuxRuby
274
274
  # @param [Hash] opts the optional parameters
275
275
  # @option opts [String] :group_by Breakdown value to group the results by
276
276
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
277
- # @option opts [Array<String>] :filters 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.
277
+ # @option opts [Array<String>] :filters 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;
278
278
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
279
279
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
280
280
  # @option opts [String] :order_by Value to order the results by
281
281
  # @option opts [String] :order_direction Sort order.
282
- # @option opts [Array<String>] :timeframe 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.
282
+ # @option opts [Array<String>] :timeframe 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;
283
283
  # @return [ListBreakdownValuesResponse]
284
284
  def list_breakdown_values(metric_id, opts = {})
285
285
  data, _status_code, _headers = list_breakdown_values_with_http_info(metric_id, opts)
@@ -292,12 +292,12 @@ module MuxRuby
292
292
  # @param [Hash] opts the optional parameters
293
293
  # @option opts [String] :group_by Breakdown value to group the results by
294
294
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
295
- # @option opts [Array<String>] :filters 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.
295
+ # @option opts [Array<String>] :filters 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;
296
296
  # @option opts [Integer] :limit Number of items to include in the response
297
297
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
298
298
  # @option opts [String] :order_by Value to order the results by
299
299
  # @option opts [String] :order_direction Sort order.
300
- # @option opts [Array<String>] :timeframe 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.
300
+ # @option opts [Array<String>] :timeframe 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;
301
301
  # @return [Array<(ListBreakdownValuesResponse, Integer, Hash)>] ListBreakdownValuesResponse data, response status code and response headers
302
302
  def list_breakdown_values_with_http_info(metric_id, opts = {})
303
303
  if @api_client.config.debugging
@@ -382,7 +382,7 @@ module MuxRuby
382
382
  # @param [Hash] opts the optional parameters
383
383
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
384
384
  # @option opts [String] :order_direction Sort order.
385
- # @option opts [Array<String>] :timeframe 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.
385
+ # @option opts [Array<String>] :timeframe 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;
386
386
  # @return [ListInsightsResponse]
387
387
  def list_insights(metric_id, opts = {})
388
388
  data, _status_code, _headers = list_insights_with_http_info(metric_id, opts)
@@ -395,7 +395,7 @@ module MuxRuby
395
395
  # @param [Hash] opts the optional parameters
396
396
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
397
397
  # @option opts [String] :order_direction Sort order.
398
- # @option opts [Array<String>] :timeframe 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.
398
+ # @option opts [Array<String>] :timeframe 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;
399
399
  # @return [Array<(ListInsightsResponse, Integer, Hash)>] ListInsightsResponse data, response status code and response headers
400
400
  def list_insights_with_http_info(metric_id, opts = {})
401
401
  if @api_client.config.debugging