Class: MuxRuby::ExportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExportsApi

Returns a new instance of ExportsApi.



12
13
14
 
# File 'lib/mux_ruby/api/exports_api.rb', line 12

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



10
11
12
 
# File 'lib/mux_ruby/api/exports_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#list_exports(opts = {}) ⇒ ListExportsResponse

List property video view export links Lists the available video view exports along with URLs to retrieve them

Parameters:

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

    the optional parameters

Returns:



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

def list_exports(opts = {})
  data, _status_code, _headers = list_exports_with_http_info(opts)
  data
end

#list_exports_with_http_info(opts = {}) ⇒ Array<(ListExportsResponse, Fixnum, Hash)>

List property video view export links Lists the available video view exports along with URLs to retrieve them

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ListExportsResponse, Fixnum, Hash)>) —

    ListExportsResponse data, response status code and response headers



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mux_ruby/api/exports_api.rb', line 28

def list_exports_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExportsApi.list_exports ...'
  end
  # resource path
  local_var_path = '/data/v1/exports'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['accessToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListExportsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExportsApi#list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end