Class: MuxRuby::DeliveryUsageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/delivery_usage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliveryUsageApi

Returns a new instance of DeliveryUsageApi.



19
20
21
 
# File 'lib/mux_ruby/api/delivery_usage_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/delivery_usage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_delivery_usage(opts = {}) ⇒ ListDeliveryUsageResponse

List Usage Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Offset by this many pages, of the size of `limit` (default to 1)

  • :limit (Integer) —

    Number of items to include in the response (default to 100)

  • :asset_id (String) —

    Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.

  • :live_stream_id (String) —

    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.

  • :timeframe (Array<String>) —

    Time window to get delivery usage information. timeframe indicates the start time, timeframe 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.

Returns:



31
32
33
34
 
# File 'lib/mux_ruby/api/delivery_usage_api.rb', line 31

def list_delivery_usage(opts = {})
  data, _status_code, _headers = list_delivery_usage_with_http_info(opts)
  data
end

#list_delivery_usage_with_http_info(opts = {}) ⇒ Array<(ListDeliveryUsageResponse, Integer, Hash)>

List Usage Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

  • :limit (Integer) —

    Number of items to include in the response

  • :asset_id (String) —

    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.

  • :live_stream_id (String) —

    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.

  • :timeframe (Array<String>) —

    Time window to get delivery usage information. timeframe indicates the start time, timeframe 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.

Returns:

  • (Array<(ListDeliveryUsageResponse, Integer, Hash)>) —

    ListDeliveryUsageResponse data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mux_ruby/api/delivery_usage_api.rb', line 45

def list_delivery_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryUsageApi.list_delivery_usage ...'
  end
  # resource path
  local_var_path = '/video/v1/delivery-usage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'asset_id'] = opts[:'asset_id'] if !opts[:'asset_id'].nil?
  query_params[:'live_stream_id'] = opts[:'live_stream_id'] if !opts[:'live_stream_id'].nil?
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListDeliveryUsageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"DeliveryUsageApi.list_delivery_usage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryUsageApi#list_delivery_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end