Class: TelestreamCloud::Qc::QcApi

Inherits:
Object
  • Object
show all
Defined in:
lib/telestream_cloud_qc/api/qc_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QcApi

Returns a new instance of QcApi.



19
20
21
 
# File 'lib/telestream_cloud_qc/api/qc_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/telestream_cloud_qc/api/qc_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_job(project_id, job_id, opts = {}) ⇒ nil

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 29

def cancel_job(project_id, job_id, opts = {})
  cancel_job_with_http_info(project_id, job_id, opts)
  return nil
end

#cancel_job_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 40

def cancel_job_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.cancel_job ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.cancel_job"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling QcApi.cancel_job"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs/{job_id}/cancel.json".sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'job_id' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

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

#create_job(project_id, data, opts = {}) ⇒ Job

Create a new job

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 89

def create_job(project_id, data, opts = {})
  data, _status_code, _headers = create_job_with_http_info(project_id, data, opts)
  return data
end

#create_job_with_http_info(project_id, data, opts = {}) ⇒ Array<(Job, Fixnum, Hash)>

Create a new job

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:

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

    Job 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
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 100

def create_job_with_http_info(project_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.create_job ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.create_job"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling QcApi.create_job"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(data)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#create_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_project(opts = {}) ⇒ Project

Create a new project

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



149
150
151
152
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 149

def create_project(opts = {})
  data, _status_code, _headers = create_project_with_http_info(opts)
  return data
end

#create_project_with_http_info(opts = {}) ⇒ Array<(Project, Fixnum, Hash)>

Create a new project

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Project data, response status code and response headers



159
160
161
162
163
164
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
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 159

def create_project_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.create_project ..."
  end
  # resource path
  local_var_path = "/projects.json"

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Project')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#create_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_job(project_id, job_id, opts = {}) ⇒ Job

Get QC job

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:



201
202
203
204
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 201

def get_job(project_id, job_id, opts = {})
  data, _status_code, _headers = get_job_with_http_info(project_id, job_id, opts)
  return data
end

#get_job_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(Job, Fixnum, Hash)>

Get QC job

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

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

    Job data, response status code and response headers



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
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
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 212

def get_job_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.get_job ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.get_job"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling QcApi.get_job"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs/{job_id}.json".sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'job_id' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#get_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_project(project_id, opts = {}) ⇒ Project

Get project by Id

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:



261
262
263
264
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 261

def get_project(project_id, opts = {})
  data, _status_code, _headers = get_project_with_http_info(project_id, opts)
  return data
end

#get_project_with_http_info(project_id, opts = {}) ⇒ Array<(Project, Fixnum, Hash)>

Get project by Id

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:

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

    Project data, response status code and response headers



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 271

def get_project_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.get_project ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.get_project"
  end
  # resource path
  local_var_path = "/projects/{project_id}.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Project')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#get_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_template(opts = {}) ⇒ Array<InlineResponse200>

Import Vidchecker template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :file (File)

Returns:



317
318
319
320
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 317

def import_template(opts = {})
  data, _status_code, _headers = import_template_with_http_info(opts)
  return data
end

#import_template_with_http_info(opts = {}) ⇒ Array<(Array<InlineResponse200>, Fixnum, Hash)>

Import Vidchecker template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :file (File)

Returns:

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

    Array<InlineResponse200> data, response status code and response headers



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 328

def import_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.import_template ..."
  end
  # resource path
  local_var_path = "/projects/import.json"

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  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(['text/xml'])

  # form parameters
  form_params = {}
  form_params["file"] = opts[:'file'] if !opts[:'file'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<InlineResponse200>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#import_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_jobs(project_id, opts = {}) ⇒ JobsCollection

Get jobs form projects

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    Expand details of job

  • :status (String) —

    Filter jobs by status

  • :per_page (Integer) —

    Limit number of listed jobs (default to 30)

  • :page (Integer) —

    Index of jobs page to be listed

Returns:



375
376
377
378
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 375

def list_jobs(project_id, opts = {})
  data, _status_code, _headers = list_jobs_with_http_info(project_id, opts)
  return data
end

#list_jobs_with_http_info(project_id, opts = {}) ⇒ Array<(JobsCollection, Fixnum, Hash)>

Get jobs form projects

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    Expand details of job

  • :status (String) —

    Filter jobs by status

  • :per_page (Integer) —

    Limit number of listed jobs

  • :page (Integer) —

    Index of jobs page to be listed

Returns:

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

    JobsCollection data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 389

def list_jobs_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.list_jobs ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.list_jobs"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'JobsCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#list_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_projects(opts = {}) ⇒ Array<Project>

List all projects for an account

Parameters:

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

    the optional parameters

Returns:



437
438
439
440
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 437

def list_projects(opts = {})
  data, _status_code, _headers = list_projects_with_http_info(opts)
  return data
end

#list_projects_with_http_info(opts = {}) ⇒ Array<(Array<Project>, Fixnum, Hash)>

List all projects for an account

Parameters:

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

    the optional parameters

Returns:

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

    Array<Project> data, response status code and response headers



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 446

def list_projects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.list_projects ..."
  end
  # resource path
  local_var_path = "/projects.json"

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Array<Project>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#list_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_project(project_id, opts = {}) ⇒ Project

Modify project

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



488
489
490
491
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 488

def modify_project(project_id, opts = {})
  data, _status_code, _headers = modify_project_with_http_info(project_id, opts)
  return data
end

#modify_project_with_http_info(project_id, opts = {}) ⇒ Array<(Project, Fixnum, Hash)>

Modify project

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Project data, response status code and response headers



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 499

def modify_project_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.modify_project ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.modify_project"
  end
  # resource path
  local_var_path = "/projects/{project_id}.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Project')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#modify_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#proxy(project_id, job_id, opts = {}) ⇒ Proxy

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:



545
546
547
548
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 545

def proxy(project_id, job_id, opts = {})
  data, _status_code, _headers = proxy_with_http_info(project_id, job_id, opts)
  return data
end

#proxy_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(Proxy, Fixnum, Hash)>

Returns Proxy data, response status code and response headers.

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

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

    Proxy data, response status code and response headers



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 556

def proxy_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.proxy ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.proxy"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling QcApi.proxy"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs/{job_id}/proxy.json".sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'job_id' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Proxy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#proxy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_job(project_id, job_id, opts = {}) ⇒ nil

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

  • (nil) 


606
607
608
609
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 606

def remove_job(project_id, job_id, opts = {})
  remove_job_with_http_info(project_id, job_id, opts)
  return nil
end

#remove_job_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 617

def remove_job_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.remove_job ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.remove_job"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling QcApi.remove_job"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs/{job_id}.json".sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'job_id' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

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

#remove_project(project_id, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


665
666
667
668
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 665

def remove_project(project_id, opts = {})
  remove_project_with_http_info(project_id, opts)
  return nil
end

#remove_project_with_http_info(project_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 675

def remove_project_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.remove_project ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.remove_project"
  end
  # resource path
  local_var_path = "/projects/{project_id}.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

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

#signed_urls(project_id, job_id, opts = {}) ⇒ Hash<String, String>

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

  • (Hash<String, String>) 


720
721
722
723
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 720

def signed_urls(project_id, job_id, opts = {})
  data, _status_code, _headers = signed_urls_with_http_info(project_id, job_id, opts)
  return data
end

#signed_urls_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(Hash<String, String>, Fixnum, Hash)>

Returns Hash<String, String> data, response status code and response headers.

Parameters:

  • project_id —

    A unique identifier of a Project.

  • job_id —

    A unique identifier of a Job.

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

    the optional parameters

Returns:

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

    Hash<String, String> data, response status code and response headers



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 731

def signed_urls_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.signed_urls ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.signed_urls"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling QcApi.signed_urls"
  end
  # resource path
  local_var_path = "/projects/{project_id}/jobs/{job_id}/signed-urls.json".sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'job_id' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Hash<String, String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#signed_urls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#templates(opts = {}) ⇒ Array<Template>

List all templates

Parameters:

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

    the optional parameters

Returns:



779
780
781
782
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 779

def templates(opts = {})
  data, _status_code, _headers = templates_with_http_info(opts)
  return data
end

#templates_with_http_info(opts = {}) ⇒ Array<(Array<Template>, Fixnum, Hash)>

List all templates

Parameters:

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

    the optional parameters

Returns:

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

    Array<Template> data, response status code and response headers



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 788

def templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.templates ..."
  end
  # resource path
  local_var_path = "/templates.json"

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Array<Template>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_video(project_id, video_upload_body, opts = {}) ⇒ UploadSession

Creates an upload session

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:



830
831
832
833
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 830

def upload_video(project_id, video_upload_body, opts = {})
  data, _status_code, _headers = upload_video_with_http_info(project_id, video_upload_body, opts)
  return data
end

#upload_video_with_http_info(project_id, video_upload_body, opts = {}) ⇒ Array<(UploadSession, Fixnum, Hash)>

Creates an upload session

Parameters:

  • project_id —

    A unique identifier of a Project.

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

    the optional parameters

Returns:

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

    UploadSession data, response status code and response headers



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/telestream_cloud_qc/api/qc_api.rb', line 841

def upload_video_with_http_info(project_id, video_upload_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QcApi.upload_video ..."
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling QcApi.upload_video"
  end
  # verify the required parameter 'video_upload_body' is set
  if @api_client.config.client_side_validation && video_upload_body.nil?
    fail ArgumentError, "Missing the required parameter 'video_upload_body' when calling QcApi.upload_video"
  end
  # resource path
  local_var_path = "/projects/{project_id}/upload.json".sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(video_upload_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UploadSession')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QcApi#upload_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end