Class: MuxRuby::DirectUploadsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DirectUploadsApi

Returns a new instance of DirectUploadsApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_direct_upload(upload_id, opts = {}) ⇒ UploadResponse

Cancel a direct upload Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the ‘waiting` state.

Parameters:

  • upload_id (String) —

    ID of the Upload

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 27

def cancel_direct_upload(upload_id, opts = {})
  data, _status_code, _headers = cancel_direct_upload_with_http_info(upload_id, opts)
  data
end

#cancel_direct_upload_with_http_info(upload_id, opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

Cancel a direct upload Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the &#x60;waiting&#x60; state.

Parameters:

  • upload_id (String) —

    ID of the Upload

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

    the optional parameters

Returns:

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

    UploadResponse data, response status code and response headers



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
78
79
80
81
82
83
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 37

def cancel_direct_upload_with_http_info(upload_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectUploadsApi.cancel_direct_upload ...'
  end
  # verify the required parameter 'upload_id' is set
  if @api_client.config.client_side_validation && upload_id.nil?
    fail ArgumentError, "Missing the required parameter 'upload_id' when calling DirectUploadsApi.cancel_direct_upload"
  end
  # resource path
  local_var_path = '/video/v1/uploads/{UPLOAD_ID}/cancel'.sub('{' + 'UPLOAD_ID' + '}', CGI.escape(upload_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :"DirectUploadsApi.cancel_direct_upload",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectUploadsApi#cancel_direct_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_direct_upload(create_upload_request, opts = {}) ⇒ UploadResponse

Create a new direct upload URL Creates a new direct upload, through which video content can be uploaded for ingest to Mux.

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 90

def create_direct_upload(create_upload_request, opts = {})
  data, _status_code, _headers = create_direct_upload_with_http_info(create_upload_request, opts)
  data
end

#create_direct_upload_with_http_info(create_upload_request, opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

Create a new direct upload URL Creates a new direct upload, through which video content can be uploaded for ingest to Mux.

Parameters:

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

    the optional parameters

Returns:

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

    UploadResponse data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 100

def create_direct_upload_with_http_info(create_upload_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectUploadsApi.create_direct_upload ...'
  end
  # verify the required parameter 'create_upload_request' is set
  if @api_client.config.client_side_validation && create_upload_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_upload_request' when calling DirectUploadsApi.create_direct_upload"
  end
  # resource path
  local_var_path = '/video/v1/uploads'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_upload_request)

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

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

  new_options = opts.merge(
    :operation => :"DirectUploadsApi.create_direct_upload",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectUploadsApi#create_direct_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_direct_upload(upload_id, opts = {}) ⇒ UploadResponse

Retrieve a single direct upload’s info Fetches information about a single direct upload in the current environment.

Parameters:

  • upload_id (String) —

    ID of the Upload

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 155

def get_direct_upload(upload_id, opts = {})
  data, _status_code, _headers = get_direct_upload_with_http_info(upload_id, opts)
  data
end

#get_direct_upload_with_http_info(upload_id, opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

Retrieve a single direct upload&#39;s info Fetches information about a single direct upload in the current environment.

Parameters:

  • upload_id (String) —

    ID of the Upload

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

    the optional parameters

Returns:

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

    UploadResponse data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 165

def get_direct_upload_with_http_info(upload_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectUploadsApi.get_direct_upload ...'
  end
  # verify the required parameter 'upload_id' is set
  if @api_client.config.client_side_validation && upload_id.nil?
    fail ArgumentError, "Missing the required parameter 'upload_id' when calling DirectUploadsApi.get_direct_upload"
  end
  # resource path
  local_var_path = '/video/v1/uploads/{UPLOAD_ID}'.sub('{' + 'UPLOAD_ID' + '}', CGI.escape(upload_id.to_s))

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

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

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

#list_direct_uploads(opts = {}) ⇒ ListUploadsResponse

List direct uploads Lists direct uploads in the current environment.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

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

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

Returns:



219
220
221
222
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 219

def list_direct_uploads(opts = {})
  data, _status_code, _headers = list_direct_uploads_with_http_info(opts)
  data
end

#list_direct_uploads_with_http_info(opts = {}) ⇒ Array<(ListUploadsResponse, Integer, Hash)>

List direct uploads Lists direct uploads in the current environment.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

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

Returns:

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

    ListUploadsResponse data, response status code and response headers



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/mux_ruby/api/direct_uploads_api.rb', line 230

def list_direct_uploads_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectUploadsApi.list_direct_uploads ...'
  end
  # resource path
  local_var_path = '/video/v1/uploads'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'ListUploadsResponse'

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

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