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.



19
20
21
 
# File 'lib/mux_ruby/api/exports_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/exports_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_exports(opts = {}) ⇒ ListExportsResponse

List property video view export links The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/mux_ruby/api/exports_api.rb', line 26

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

#list_exports_views(opts = {}) ⇒ ListVideoViewExportsResponse

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

Parameters:

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/mux_ruby/api/exports_api.rb', line 83

def list_exports_views(opts = {})
  data, _status_code, _headers = list_exports_views_with_http_info(opts)
  data
end

#list_exports_views_with_http_info(opts = {}) ⇒ Array<(ListVideoViewExportsResponse, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/mux_ruby/api/exports_api.rb', line 92

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

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'ListVideoViewExportsResponse'

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

  new_options = opts.merge(
    :operation => :"ExportsApi.list_exports_views",
    :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: ExportsApi#list_exports_views\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List property video view export links The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.

Parameters:

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

    the optional parameters

Returns:

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

    ListExportsResponse data, response status code and response headers



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mux_ruby/api/exports_api.rb', line 35

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 = opts[:query_params] || {}

  # 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] || 'ListExportsResponse'

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

  new_options = opts.merge(
    :operation => :"ExportsApi.list_exports",
    :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: ExportsApi#list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end