mux_ruby 2.2.0 → 3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +4 -4
- data/docs/Asset.md +1 -1
- data/docs/AssetNonStandardInputReasons.md +2 -0
- data/docs/AssetsApi.md +73 -0
- data/docs/CreateAssetRequest.md +1 -1
- data/docs/CreateLiveStreamRequest.md +6 -2
- data/docs/CreatePlaybackRestrictionRequest.md +18 -0
- data/docs/CreateSimulcastTargetRequest.md +1 -1
- data/docs/CreateTrackRequest.md +1 -1
- data/docs/DeliveryUsageApi.md +4 -2
- data/docs/DimensionsApi.md +4 -4
- data/docs/ErrorsApi.md +4 -4
- data/docs/ExportsApi.md +1 -1
- data/docs/FiltersApi.md +6 -6
- data/docs/InputSettings.md +1 -1
- data/docs/LiveStream.md +8 -4
- data/docs/LiveStreamEmbeddedSubtitleSettings.md +24 -0
- data/docs/LiveStreamStatus.md +15 -0
- data/docs/LiveStreamsApi.md +149 -1
- data/docs/MetricsApi.md +20 -20
- data/docs/PlaybackRestriction.md +24 -0
- data/docs/PlaybackRestrictionResponse.md +15 -0
- data/docs/PlaybackRestrictionsApi.md +367 -0
- data/docs/RealTimeApi.md +6 -6
- data/docs/ReferrerDomainRestriction.md +20 -0
- data/docs/SimulcastTarget.md +1 -1
- data/docs/Track.md +1 -1
- data/docs/UpdateAssetRequest.md +18 -0
- data/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md +18 -0
- data/docs/UpdateLiveStreamRequest.md +22 -0
- data/docs/UpdateReferrerDomainRestrictionRequest.md +15 -0
- data/docs/VideoViewsApi.md +4 -4
- data/examples/data/exercise-errors.rb +0 -2
- data/examples/video/exercise-assets.rb +1 -0
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +71 -0
- data/lib/mux_ruby/api/delivery_usage_api.rb +5 -2
- data/lib/mux_ruby/api/dimensions_api.rb +4 -4
- data/lib/mux_ruby/api/errors_api.rb +4 -4
- data/lib/mux_ruby/api/exports_api.rb +2 -2
- data/lib/mux_ruby/api/filters_api.rb +8 -8
- data/lib/mux_ruby/api/live_streams_api.rb +145 -0
- data/lib/mux_ruby/api/metrics_api.rb +20 -20
- data/lib/mux_ruby/api/playback_restrictions_api.rb +345 -0
- data/lib/mux_ruby/api/real_time_api.rb +6 -6
- data/lib/mux_ruby/api/video_views_api.rb +4 -4
- data/lib/mux_ruby/models/asset.rb +1 -1
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +23 -1
- data/lib/mux_ruby/models/create_asset_request.rb +1 -1
- data/lib/mux_ruby/models/create_live_stream_request.rb +59 -3
- data/lib/mux_ruby/models/create_playback_restriction_request.rb +218 -0
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
- data/lib/mux_ruby/models/create_track_request.rb +1 -1
- data/lib/mux_ruby/models/input_settings.rb +1 -1
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +1 -1
- data/lib/mux_ruby/models/live_stream.rb +35 -14
- data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +287 -0
- data/lib/mux_ruby/models/live_stream_status.rb +38 -0
- data/lib/mux_ruby/models/playback_restriction.rb +248 -0
- data/lib/mux_ruby/models/playback_restriction_response.rb +209 -0
- data/lib/mux_ruby/models/referrer_domain_restriction.rb +234 -0
- data/lib/mux_ruby/models/simulcast_target.rb +1 -1
- data/lib/mux_ruby/models/track.rb +1 -13
- data/lib/mux_ruby/models/update_asset_request.rb +219 -0
- data/lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb +221 -0
- data/lib/mux_ruby/models/update_live_stream_request.rb +297 -0
- data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +209 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +11 -0
- data/spec/api/playback_restrictions_api_spec.rb +97 -0
- data/spec/models/create_playback_restriction_request_spec.rb +34 -0
- data/spec/models/live_stream_embedded_subtitle_settings_spec.rb +56 -0
- data/spec/models/live_stream_status_spec.rb +28 -0
- data/spec/models/playback_restriction_response_spec.rb +28 -0
- data/spec/models/playback_restriction_spec.rb +52 -0
- data/spec/models/referrer_domain_restriction_spec.rb +40 -0
- data/spec/models/update_asset_request_spec.rb +34 -0
- data/spec/models/update_live_stream_embedded_subtitles_request_spec.rb +34 -0
- data/spec/models/update_live_stream_request_spec.rb +50 -0
- data/spec/models/update_referrer_domain_restriction_request_spec.rb +28 -0
- metadata +138 -94
@@ -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 `limit` (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 `asset_id` and `live_stream_id` 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 `asset_id` and `live_stream_id` 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 `limit`
|
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 `asset_id` and `live_stream_id` 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 `asset_id` and `live_stream_id` 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 `limit` (default to 1)
|
28
|
-
# @option opts [Array<String>] :filters
|
29
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
29
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `limit`
|
42
|
-
# @option opts [Array<String>] :filters
|
43
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
43
|
+
# @option opts [Array<String>] :timeframe 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`
|
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
|
26
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
26
|
+
# @option opts [Array<String>] :timeframe 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`
|
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
|
37
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
37
|
+
# @option opts [Array<String>] :timeframe 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
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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 `limit` (default to 1)
|
28
|
-
# @option opts [Array<String>] :filters
|
29
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
29
|
+
# @option opts [Array<String>] :timeframe 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`
|
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
|
-
#
|
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 `limit`
|
42
|
-
# @option opts [Array<String>] :filters
|
43
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
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 `!` 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`
|
43
|
+
# @option opts [Array<String>] :timeframe 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`
|
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
|
-
#
|
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
|
-
#
|
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 = {})
|
@@ -743,6 +743,7 @@ module MuxRuby
|
|
743
743
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
744
744
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
745
745
|
# @option opts [String] :stream_key Filter response to return live stream for this stream key only
|
746
|
+
# @option opts [LiveStreamStatus] :status Filter response to return live streams with the specified status only
|
746
747
|
# @return [ListLiveStreamsResponse]
|
747
748
|
def list_live_streams(opts = {})
|
748
749
|
data, _status_code, _headers = list_live_streams_with_http_info(opts)
|
@@ -754,6 +755,7 @@ module MuxRuby
|
|
754
755
|
# @option opts [Integer] :limit Number of items to include in the response
|
755
756
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
756
757
|
# @option opts [String] :stream_key Filter response to return live stream for this stream key only
|
758
|
+
# @option opts [LiveStreamStatus] :status Filter response to return live streams with the specified status only
|
757
759
|
# @return [Array<(ListLiveStreamsResponse, Integer, Hash)>] ListLiveStreamsResponse data, response status code and response headers
|
758
760
|
def list_live_streams_with_http_info(opts = {})
|
759
761
|
if @api_client.config.debugging
|
@@ -767,6 +769,7 @@ module MuxRuby
|
|
767
769
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
768
770
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
769
771
|
query_params[:'stream_key'] = opts[:'stream_key'] if !opts[:'stream_key'].nil?
|
772
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
770
773
|
|
771
774
|
# header parameters
|
772
775
|
header_params = opts[:header_params] || {}
|
@@ -927,5 +930,147 @@ module MuxRuby
|
|
927
930
|
end
|
928
931
|
return data, status_code, headers
|
929
932
|
end
|
933
|
+
|
934
|
+
# Update a live stream
|
935
|
+
# 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.
|
936
|
+
# @param live_stream_id [String] The live stream ID
|
937
|
+
# @param update_live_stream_request [UpdateLiveStreamRequest]
|
938
|
+
# @param [Hash] opts the optional parameters
|
939
|
+
# @return [LiveStreamResponse]
|
940
|
+
def update_live_stream(live_stream_id, update_live_stream_request, opts = {})
|
941
|
+
data, _status_code, _headers = update_live_stream_with_http_info(live_stream_id, update_live_stream_request, opts)
|
942
|
+
data
|
943
|
+
end
|
944
|
+
|
945
|
+
# Update a live stream
|
946
|
+
# 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.
|
947
|
+
# @param live_stream_id [String] The live stream ID
|
948
|
+
# @param update_live_stream_request [UpdateLiveStreamRequest]
|
949
|
+
# @param [Hash] opts the optional parameters
|
950
|
+
# @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
|
951
|
+
def update_live_stream_with_http_info(live_stream_id, update_live_stream_request, opts = {})
|
952
|
+
if @api_client.config.debugging
|
953
|
+
@api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream ...'
|
954
|
+
end
|
955
|
+
# verify the required parameter 'live_stream_id' is set
|
956
|
+
if @api_client.config.client_side_validation && live_stream_id.nil?
|
957
|
+
fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream"
|
958
|
+
end
|
959
|
+
# verify the required parameter 'update_live_stream_request' is set
|
960
|
+
if @api_client.config.client_side_validation && update_live_stream_request.nil?
|
961
|
+
fail ArgumentError, "Missing the required parameter 'update_live_stream_request' when calling LiveStreamsApi.update_live_stream"
|
962
|
+
end
|
963
|
+
# resource path
|
964
|
+
local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
|
965
|
+
|
966
|
+
# query parameters
|
967
|
+
query_params = opts[:query_params] || {}
|
968
|
+
|
969
|
+
# header parameters
|
970
|
+
header_params = opts[:header_params] || {}
|
971
|
+
# HTTP header 'Accept' (if needed)
|
972
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
973
|
+
# HTTP header 'Content-Type'
|
974
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
975
|
+
|
976
|
+
# form parameters
|
977
|
+
form_params = opts[:form_params] || {}
|
978
|
+
|
979
|
+
# http body (model)
|
980
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_request)
|
981
|
+
|
982
|
+
# return_type
|
983
|
+
return_type = opts[:debug_return_type] || 'LiveStreamResponse'
|
984
|
+
|
985
|
+
# auth_names
|
986
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
987
|
+
|
988
|
+
new_options = opts.merge(
|
989
|
+
:operation => :"LiveStreamsApi.update_live_stream",
|
990
|
+
:header_params => header_params,
|
991
|
+
:query_params => query_params,
|
992
|
+
:form_params => form_params,
|
993
|
+
:body => post_body,
|
994
|
+
:auth_names => auth_names,
|
995
|
+
:return_type => return_type
|
996
|
+
)
|
997
|
+
|
998
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
999
|
+
if @api_client.config.debugging
|
1000
|
+
@api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1001
|
+
end
|
1002
|
+
return data, status_code, headers
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# Update a live stream's embedded subtitles
|
1006
|
+
# Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.
|
1007
|
+
# @param live_stream_id [String] The live stream ID
|
1008
|
+
# @param update_live_stream_embedded_subtitles_request [UpdateLiveStreamEmbeddedSubtitlesRequest]
|
1009
|
+
# @param [Hash] opts the optional parameters
|
1010
|
+
# @return [LiveStreamResponse]
|
1011
|
+
def update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request, opts = {})
|
1012
|
+
data, _status_code, _headers = update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request, opts)
|
1013
|
+
data
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# Update a live stream's embedded subtitles
|
1017
|
+
# Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.
|
1018
|
+
# @param live_stream_id [String] The live stream ID
|
1019
|
+
# @param update_live_stream_embedded_subtitles_request [UpdateLiveStreamEmbeddedSubtitlesRequest]
|
1020
|
+
# @param [Hash] opts the optional parameters
|
1021
|
+
# @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
|
1022
|
+
def update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request, opts = {})
|
1023
|
+
if @api_client.config.debugging
|
1024
|
+
@api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream_embedded_subtitles ...'
|
1025
|
+
end
|
1026
|
+
# verify the required parameter 'live_stream_id' is set
|
1027
|
+
if @api_client.config.client_side_validation && live_stream_id.nil?
|
1028
|
+
fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream_embedded_subtitles"
|
1029
|
+
end
|
1030
|
+
# verify the required parameter 'update_live_stream_embedded_subtitles_request' is set
|
1031
|
+
if @api_client.config.client_side_validation && update_live_stream_embedded_subtitles_request.nil?
|
1032
|
+
fail ArgumentError, "Missing the required parameter 'update_live_stream_embedded_subtitles_request' when calling LiveStreamsApi.update_live_stream_embedded_subtitles"
|
1033
|
+
end
|
1034
|
+
# resource path
|
1035
|
+
local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
|
1036
|
+
|
1037
|
+
# query parameters
|
1038
|
+
query_params = opts[:query_params] || {}
|
1039
|
+
|
1040
|
+
# header parameters
|
1041
|
+
header_params = opts[:header_params] || {}
|
1042
|
+
# HTTP header 'Accept' (if needed)
|
1043
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1044
|
+
# HTTP header 'Content-Type'
|
1045
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1046
|
+
|
1047
|
+
# form parameters
|
1048
|
+
form_params = opts[:form_params] || {}
|
1049
|
+
|
1050
|
+
# http body (model)
|
1051
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_embedded_subtitles_request)
|
1052
|
+
|
1053
|
+
# return_type
|
1054
|
+
return_type = opts[:debug_return_type] || 'LiveStreamResponse'
|
1055
|
+
|
1056
|
+
# auth_names
|
1057
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
1058
|
+
|
1059
|
+
new_options = opts.merge(
|
1060
|
+
:operation => :"LiveStreamsApi.update_live_stream_embedded_subtitles",
|
1061
|
+
:header_params => header_params,
|
1062
|
+
:query_params => query_params,
|
1063
|
+
:form_params => form_params,
|
1064
|
+
:body => post_body,
|
1065
|
+
:auth_names => auth_names,
|
1066
|
+
:return_type => return_type
|
1067
|
+
)
|
1068
|
+
|
1069
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1070
|
+
if @api_client.config.debugging
|
1071
|
+
@api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream_embedded_subtitles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1072
|
+
end
|
1073
|
+
return data, status_code, headers
|
1074
|
+
end
|
930
1075
|
end
|
931
1076
|
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[]=).
|
27
|
-
# @option opts [Array<String>] :filters
|
26
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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
|
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 `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.
|
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[]=).
|
42
|
-
# @option opts [Array<String>] :filters
|
41
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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
|
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 `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.
|
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[]=).
|
122
|
-
# @option opts [Array<String>] :filters
|
121
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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[]=).
|
135
|
-
# @option opts [Array<String>] :filters
|
134
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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[]=).
|
202
|
-
# @option opts [Array<String>] :filters
|
201
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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[]=).
|
215
|
-
# @option opts [Array<String>] :filters
|
214
|
+
# @option opts [Array<String>] :timeframe 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`
|
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 `!` 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`
|
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
|
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 `!` 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
|
# @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 `limit` (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[]=).
|
282
|
+
# @option opts [Array<String>] :timeframe 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
|
# @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
|
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 `!` 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`
|
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 `limit`
|
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[]=).
|
300
|
+
# @option opts [Array<String>] :timeframe 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`
|
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[]=).
|
385
|
+
# @option opts [Array<String>] :timeframe 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`
|
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[]=).
|
398
|
+
# @option opts [Array<String>] :timeframe 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`
|
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
|