Class: TelestreamCloud::Flip::FlipApi

Inherits:
Object
  • Object
show all
Defined in:
lib/telestream_cloud_flip/api/flip_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FlipApi

Returns a new instance of FlipApi.



19
20
21
 
# File 'lib/telestream_cloud_flip/api/flip_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_flip/api/flip_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_encoding(id, factory_id, opts = {}) ⇒ CanceledResponse

Cancels an Encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 29

def cancel_encoding(id, factory_id, opts = {})
  data, _status_code, _headers = cancel_encoding_with_http_info(id, factory_id, opts)
  return data
end

#cancel_encoding_with_http_info(id, factory_id, opts = {}) ⇒ Array<(CanceledResponse, Fixnum, Hash)>

Cancels an Encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    CanceledResponse data, 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
82
83
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 40

def cancel_encoding_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.cancel_encoding ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.cancel_encoding"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.cancel_encoding"
  end
  # resource path
  local_var_path = "/encodings/{id}/cancel.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(: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 => 'CanceledResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#cancel_encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_profile(id, factory_id, copy_profile_body, opts = {}) ⇒ Profile

Copies a given Profile

Parameters:

  • id —

    Id of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:



93
94
95
96
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 93

def copy_profile(id, factory_id, copy_profile_body, opts = {})
  data, _status_code, _headers = copy_profile_with_http_info(id, factory_id, copy_profile_body, opts)
  return data
end

#copy_profile_with_http_info(id, factory_id, copy_profile_body, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Copies a given Profile

Parameters:

  • id —

    Id of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:

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

    Profile data, response status code and response headers



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
149
150
151
152
153
154
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 106

def copy_profile_with_http_info(id, factory_id, copy_profile_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.copy_profile ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.copy_profile"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.copy_profile"
  end
  # verify the required parameter 'copy_profile_body' is set
  if @api_client.config.client_side_validation && copy_profile_body.nil?
    fail ArgumentError, "Missing the required parameter 'copy_profile_body' when calling FlipApi.copy_profile"
  end
  # resource path
  local_var_path = "/profiles/{id}/copy.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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 = @api_client.object_to_http_body(copy_profile_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 => 'Profile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#copy_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_encoding(factory_id, create_encoding_body, opts = {}) ⇒ Encoding

Creates an Encoding

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



164
165
166
167
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 164

def create_encoding(factory_id, create_encoding_body, opts = {})
  data, _status_code, _headers = create_encoding_with_http_info(factory_id, create_encoding_body, opts)
  return data
end

#create_encoding_with_http_info(factory_id, create_encoding_body, opts = {}) ⇒ Array<(Encoding, Fixnum, Hash)>

Creates an Encoding

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:

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

    Encoding data, response status code and response headers



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
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 177

def create_encoding_with_http_info(factory_id, create_encoding_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.create_encoding ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.create_encoding"
  end
  # verify the required parameter 'create_encoding_body' is set
  if @api_client.config.client_side_validation && create_encoding_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_encoding_body' when calling FlipApi.create_encoding"
  end
  # resource path
  local_var_path = "/encodings.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'screenshots'] = opts[:'screenshots'] if !opts[:'screenshots'].nil?
  query_params[:'precise_status'] = opts[:'precise_status'] if !opts[:'precise_status'].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 = @api_client.object_to_http_body(create_encoding_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 => 'Encoding')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#create_encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_factory(create_factory_body, opts = {}) ⇒ Factory

Creates a new factory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:



230
231
232
233
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 230

def create_factory(create_factory_body, opts = {})
  data, _status_code, _headers = create_factory_with_http_info(create_factory_body, opts)
  return data
end

#create_factory_with_http_info(create_factory_body, opts = {}) ⇒ Array<(Factory, Fixnum, Hash)>

Creates a new factory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:

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

    Factory data, response status code and response headers



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
275
276
277
278
279
280
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 241

def create_factory_with_http_info(create_factory_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.create_factory ..."
  end
  # verify the required parameter 'create_factory_body' is set
  if @api_client.config.client_side_validation && create_factory_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_factory_body' when calling FlipApi.create_factory"
  end
  # resource path
  local_var_path = "/factories.json"

  # query parameters
  query_params = {}
  query_params[:'with_storage_provider'] = opts[:'with_storage_provider'] if !opts[:'with_storage_provider'].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 = @api_client.object_to_http_body(create_factory_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 => 'Factory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#create_factory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_profile(factory_id, create_profile_body, opts = {}) ⇒ Profile

Creates a Profile

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN)
  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default it is not set.

Returns:



290
291
292
293
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 290

def create_profile(factory_id, create_profile_body, opts = {})
  data, _status_code, _headers = create_profile_with_http_info(factory_id, create_profile_body, opts)
  return data
end

#create_profile_with_http_info(factory_id, create_profile_body, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Creates a Profile

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN)
  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default it is not set.

Returns:

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

    Profile data, response status code and response headers



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 303

def create_profile_with_http_info(factory_id, create_profile_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.create_profile ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.create_profile"
  end
  # verify the required parameter 'create_profile_body' is set
  if @api_client.config.client_side_validation && create_profile_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_profile_body' when calling FlipApi.create_profile"
  end
  # resource path
  local_var_path = "/profiles.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'exclude_advanced_services'] = opts[:'exclude_advanced_services'] if !opts[:'exclude_advanced_services'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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 = @api_client.object_to_http_body(create_profile_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 => 'Profile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#create_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_video(factory_id, create_video_body, opts = {}) ⇒ Video

Creates a Video from a provided source_url.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



356
357
358
359
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 356

def create_video(factory_id, create_video_body, opts = {})
  data, _status_code, _headers = create_video_with_http_info(factory_id, create_video_body, opts)
  return data
end

#create_video_with_http_info(factory_id, create_video_body, opts = {}) ⇒ Array<(Video, Fixnum, Hash)>

Creates a Video from a provided source_url.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    Video data, response status code and response headers



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 367

def create_video_with_http_info(factory_id, create_video_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.create_video ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.create_video"
  end
  # verify the required parameter 'create_video_body' is set
  if @api_client.config.client_side_validation && create_video_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_video_body' when calling FlipApi.create_video"
  end
  # resource path
  local_var_path = "/videos.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(create_video_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 => 'Video')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#create_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_workorder(factory_id, opts = {}) ⇒ nil

Creates a Workorder.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    Id of a Profile.

  • :file (File) —

    Input file.

  • :source_url (String) —

    URL pointing to an input file.

Returns:

  • (nil) 


420
421
422
423
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 420

def create_workorder(factory_id, opts = {})
  create_workorder_with_http_info(factory_id, opts)
  return nil
end

#create_workorder_with_http_info(factory_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Creates a Workorder.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    Id of a Profile.

  • :file (File) —

    Input file.

  • :source_url (String) —

    URL pointing to an input file.

Returns:

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

    nil, response status code and response headers



433
434
435
436
437
438
439
440
441
442
443
444
445
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
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 433

def create_workorder_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.create_workorder ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.create_workorder"
  end
  # resource path
  local_var_path = "/workorders.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["profile_id"] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
  form_params["source_url"] = opts[:'source_url'] if !opts[:'source_url'].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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#create_workorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_encoding(id, factory_id, opts = {}) ⇒ DeletedResponse

Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



482
483
484
485
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 482

def delete_encoding(id, factory_id, opts = {})
  data, _status_code, _headers = delete_encoding_with_http_info(id, factory_id, opts)
  return data
end

#delete_encoding_with_http_info(id, factory_id, opts = {}) ⇒ Array<(DeletedResponse, Fixnum, Hash)>

Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    DeletedResponse data, response status code and response headers



493
494
495
496
497
498
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
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 493

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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,
    :return_type => 'DeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#delete_encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_profile(id, factory_id, opts = {}) ⇒ DeletedResponse

Deletes a given Profile

Parameters:

  • id —

    Id of a Profile

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



544
545
546
547
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 544

def delete_profile(id, factory_id, opts = {})
  data, _status_code, _headers = delete_profile_with_http_info(id, factory_id, opts)
  return data
end

#delete_profile_with_http_info(id, factory_id, opts = {}) ⇒ Array<(DeletedResponse, Fixnum, Hash)>

Deletes a given Profile

Parameters:

  • id —

    Id of a Profile

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    DeletedResponse data, response status code and response headers



555
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_flip/api/flip_api.rb', line 555

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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,
    :return_type => 'DeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#delete_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_video(id, factory_id, opts = {}) ⇒ DeletedResponse

Deletes a Video object.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



606
607
608
609
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 606

def delete_video(id, factory_id, opts = {})
  data, _status_code, _headers = delete_video_with_http_info(id, factory_id, opts)
  return data
end

#delete_video_source(id, factory_id, opts = {}) ⇒ DeletedResponse

Delete a video’s source file.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



668
669
670
671
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 668

def delete_video_source(id, factory_id, opts = {})
  data, _status_code, _headers = delete_video_source_with_http_info(id, factory_id, opts)
  return data
end

#delete_video_source_with_http_info(id, factory_id, opts = {}) ⇒ Array<(DeletedResponse, Fixnum, Hash)>

Delete a video&#39;s source file.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    DeletedResponse data, response status code and response headers



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
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 679

def delete_video_source_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.delete_video_source ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.delete_video_source"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.delete_video_source"
  end
  # resource path
  local_var_path = "/videos/{id}/source.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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,
    :return_type => 'DeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#delete_video_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_video_with_http_info(id, factory_id, opts = {}) ⇒ Array<(DeletedResponse, Fixnum, Hash)>

Deletes a Video object.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    DeletedResponse data, 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
659
660
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 617

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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,
    :return_type => 'DeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#delete_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#encoding(id, factory_id, opts = {}) ⇒ Encoding

Returns an Encoding object.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



732
733
734
735
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 732

def encoding(id, factory_id, opts = {})
  data, _status_code, _headers = encoding_with_http_info(id, factory_id, opts)
  return data
end

#encoding_with_http_info(id, factory_id, opts = {}) ⇒ Array<(Encoding, Fixnum, Hash)>

Returns an Encoding object.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:

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

    Encoding data, response status code and response headers



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
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 745

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'screenshots'] = opts[:'screenshots'] if !opts[:'screenshots'].nil?
  query_params[:'precise_status'] = opts[:'precise_status'] if !opts[:'precise_status'].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 => 'Encoding')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#encodings(factory_id, opts = {}) ⇒ PaginatedEncodingsCollection

Returns a list of Encoding objects

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :video_id (String) —

    Id of a Video. When specified, the resulting list will contain videos that belong to the Video.

  • :status (String) —

    One of &#x60;success&#x60;, &#x60;fail&#x60;, &#x60;processing&#x60;. When specified, the resulting list will contain ecodings filtered by status.

  • :profile_id (String) —

    Filter by profile_id.

  • :profile_name (String) —

    Filter by profile_name.

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



805
806
807
808
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 805

def encodings(factory_id, opts = {})
  data, _status_code, _headers = encodings_with_http_info(factory_id, opts)
  return data
end

#encodings_count(factory_id, opts = {}) ⇒ CountResponse

Returns a number of Encoding objects created using a given factory.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



877
878
879
880
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 877

def encodings_count(factory_id, opts = {})
  data, _status_code, _headers = encodings_count_with_http_info(factory_id, opts)
  return data
end

#encodings_count_with_http_info(factory_id, opts = {}) ⇒ Array<(CountResponse, Fixnum, Hash)>

Returns a number of Encoding objects created using a given factory.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    CountResponse data, response status code and response headers



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 887

def encodings_count_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.encodings_count ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.encodings_count"
  end
  # resource path
  local_var_path = "/encodings/count.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'CountResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#encodings_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#encodings_with_http_info(factory_id, opts = {}) ⇒ Array<(PaginatedEncodingsCollection, Fixnum, Hash)>

Returns a list of Encoding objects

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :video_id (String) —

    Id of a Video. When specified, the resulting list will contain videos that belong to the Video.

  • :status (String) —

    One of &#x60;success&#x60;, &#x60;fail&#x60;, &#x60;processing&#x60;. When specified, the resulting list will contain ecodings filtered by status.

  • :profile_id (String) —

    Filter by profile_id.

  • :profile_name (String) —

    Filter by profile_name.

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
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
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 823

def encodings_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.encodings ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.encodings"
  end
  # resource path
  local_var_path = "/encodings.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'video_id'] = opts[:'video_id'] if !opts[:'video_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'profile_id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'profile_name'] = opts[:'profile_name'] if !opts[:'profile_name'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'screenshots'] = opts[:'screenshots'] if !opts[:'screenshots'].nil?
  query_params[:'precise_status'] = opts[:'precise_status'] if !opts[:'precise_status'].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 => 'PaginatedEncodingsCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#encodings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#factories(opts = {}) ⇒ PaginatedFactoryCollection

Returns a collection of Factory objects. Returns a collection of Factory objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:



935
936
937
938
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 935

def factories(opts = {})
  data, _status_code, _headers = factories_with_http_info(opts)
  return data
end

#factories_with_http_info(opts = {}) ⇒ Array<(PaginatedFactoryCollection, Fixnum, Hash)>

Returns a collection of Factory objects. Returns a collection of Factory objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:

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

    PaginatedFactoryCollection data, response status code and response headers



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 947

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

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'with_storage_provider'] = opts[:'with_storage_provider'] if !opts[:'with_storage_provider'].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 => 'PaginatedFactoryCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#factories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#factory(id, opts = {}) ⇒ Factory

Returns a Factory object. Returns a Factory object.

Parameters:

  • id —

    id of a factory

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:



992
993
994
995
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 992

def factory(id, opts = {})
  data, _status_code, _headers = factory_with_http_info(id, opts)
  return data
end

#factory_with_http_info(id, opts = {}) ⇒ Array<(Factory, Fixnum, Hash)>

Returns a Factory object. Returns a Factory object.

Parameters:

  • id —

    id of a factory

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:

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

    Factory data, response status code and response headers



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1003

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

  # query parameters
  query_params = {}
  query_params[:'with_storage_provider'] = opts[:'with_storage_provider'] if !opts[:'with_storage_provider'].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 => 'Factory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#factory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#notifications(factory_id, opts = {}) ⇒ CloudNotificationSettings

Returns a Factory’s notification settings.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1049
1050
1051
1052
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1049

def notifications(factory_id, opts = {})
  data, _status_code, _headers = notifications_with_http_info(factory_id, opts)
  return data
end

#notifications_with_http_info(factory_id, opts = {}) ⇒ Array<(CloudNotificationSettings, Fixnum, Hash)>

Returns a Factory&#39;s notification settings.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    CloudNotificationSettings data, response status code and response headers



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1059

def notifications_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.notifications ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.notifications"
  end
  # resource path
  local_var_path = "/notifications.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'CloudNotificationSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#profile(id_or_name, factory_id, opts = {}) ⇒ Profile

Returns a Profile object.

Parameters:

  • id_or_name —

    A name or an id of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:



1107
1108
1109
1110
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1107

def profile(id_or_name, factory_id, opts = {})
  data, _status_code, _headers = profile_with_http_info(id_or_name, factory_id, opts)
  return data
end

#profile_encodings(id_or_name, factory_id, opts = {}) ⇒ PaginatedEncodingsCollection

Returns a list of Encodings that belong to a Profile.

Parameters:

  • id_or_name —

    Id or name of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1171
1172
1173
1174
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1171

def profile_encodings(id_or_name, factory_id, opts = {})
  data, _status_code, _headers = profile_encodings_with_http_info(id_or_name, factory_id, opts)
  return data
end

#profile_encodings_with_http_info(id_or_name, factory_id, opts = {}) ⇒ Array<(PaginatedEncodingsCollection, Fixnum, Hash)>

Returns a list of Encodings that belong to a Profile.

Parameters:

  • id_or_name —

    Id or name of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1182

def profile_encodings_with_http_info(id_or_name, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.profile_encodings ..."
  end
  # verify the required parameter 'id_or_name' is set
  if @api_client.config.client_side_validation && id_or_name.nil?
    fail ArgumentError, "Missing the required parameter 'id_or_name' when calling FlipApi.profile_encodings"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.profile_encodings"
  end
  # resource path
  local_var_path = "/profiles/{id_or_name}/encodings.json".sub('{' + 'id_or_name' + '}', id_or_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'PaginatedEncodingsCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#profile_encodings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#profile_with_http_info(id_or_name, factory_id, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Returns a Profile object.

Parameters:

  • id_or_name —

    A name or an id of a Profile.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:

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

    Profile data, response status code and response headers



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1119

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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 => 'Profile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#profiles(factory_id, opts = {}) ⇒ PaginatedProfilesCollection

Returns a collection of Profile objects.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN) —

    Determine whether exclude Advanced Services profiles from the results. By default this is not set.

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



1236
1237
1238
1239
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1236

def profiles(factory_id, opts = {})
  data, _status_code, _headers = profiles_with_http_info(factory_id, opts)
  return data
end

#profiles_with_http_info(factory_id, opts = {}) ⇒ Array<(PaginatedProfilesCollection, Fixnum, Hash)>

Returns a collection of Profile objects.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN) —

    Determine whether exclude Advanced Services profiles from the results. By default this is not set.

  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1250

def profiles_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.profiles ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.profiles"
  end
  # resource path
  local_var_path = "/profiles.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'exclude_advanced_services'] = opts[:'exclude_advanced_services'] if !opts[:'exclude_advanced_services'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_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 => 'PaginatedProfilesCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#queued_videos(factory_id, opts = {}) ⇒ PaginatedVideoCollection

Returns a collection of Video objects queued for encoding.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



1302
1303
1304
1305
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1302

def queued_videos(factory_id, opts = {})
  data, _status_code, _headers = queued_videos_with_http_info(factory_id, opts)
  return data
end

#queued_videos_with_http_info(factory_id, opts = {}) ⇒ Array<(PaginatedVideoCollection, Fixnum, Hash)>

Returns a collection of Video objects queued for encoding.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:

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

    PaginatedVideoCollection data, response status code and response headers



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1314

def queued_videos_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.queued_videos ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.queued_videos"
  end
  # resource path
  local_var_path = "/videos/queued.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_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 => 'PaginatedVideoCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#queued_videos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#resubmit_video(factory_id, resubmit_video_body, opts = {}) ⇒ nil

Resubmits a video to encode. Resubmits the video to encode. Please note that this option will work only for videos in ‘success` status.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

  • (nil) 


1363
1364
1365
1366
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1363

def resubmit_video(factory_id, resubmit_video_body, opts = {})
  resubmit_video_with_http_info(factory_id, resubmit_video_body, opts)
  return nil
end

#resubmit_video_with_http_info(factory_id, resubmit_video_body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Resubmits a video to encode. Resubmits the video to encode. Please note that this option will work only for videos in &#x60;success&#x60; status.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1374

def resubmit_video_with_http_info(factory_id, resubmit_video_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.resubmit_video ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.resubmit_video"
  end
  # verify the required parameter 'resubmit_video_body' is set
  if @api_client.config.client_side_validation && resubmit_video_body.nil?
    fail ArgumentError, "Missing the required parameter 'resubmit_video_body' when calling FlipApi.resubmit_video"
  end
  # resource path
  local_var_path = "/videos/resubmit.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(resubmit_video_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#resubmit_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retry_encoding(id, factory_id, opts = {}) ⇒ RetriedResponse

Retries a failed encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1424
1425
1426
1427
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1424

def retry_encoding(id, factory_id, opts = {})
  data, _status_code, _headers = retry_encoding_with_http_info(id, factory_id, opts)
  return data
end

#retry_encoding_with_http_info(id, factory_id, opts = {}) ⇒ Array<(RetriedResponse, Fixnum, Hash)>

Retries a failed encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    RetriedResponse data, response status code and response headers



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1435

def retry_encoding_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.retry_encoding ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.retry_encoding"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.retry_encoding"
  end
  # resource path
  local_var_path = "/encodings/{id}/retry.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(: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 => 'RetriedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#retry_encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signed_encoding_url(id, factory_id, opts = {}) ⇒ EncodingSignedUrl

Returns a signed url pointing to an Encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1486
1487
1488
1489
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1486

def signed_encoding_url(id, factory_id, opts = {})
  data, _status_code, _headers = signed_encoding_url_with_http_info(id, factory_id, opts)
  return data
end

#signed_encoding_url_with_http_info(id, factory_id, opts = {}) ⇒ Array<(EncodingSignedUrl, Fixnum, Hash)>

Returns a signed url pointing to an Encoding.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    EncodingSignedUrl data, response status code and response headers



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1497

def signed_encoding_url_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.signed_encoding_url ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.signed_encoding_url"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.signed_encoding_url"
  end
  # resource path
  local_var_path = "/encodings/{id}/signed-url.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'EncodingSignedUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#signed_encoding_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signed_encoding_urls(id, factory_id, opts = {}) ⇒ EncodingSignedUrls

Returns a list of signed urls pointing to an Encoding’s outputs.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1548
1549
1550
1551
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1548

def signed_encoding_urls(id, factory_id, opts = {})
  data, _status_code, _headers = signed_encoding_urls_with_http_info(id, factory_id, opts)
  return data
end

#signed_encoding_urls_with_http_info(id, factory_id, opts = {}) ⇒ Array<(EncodingSignedUrls, Fixnum, Hash)>

Returns a list of signed urls pointing to an Encoding&#39;s outputs.

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    EncodingSignedUrls data, response status code and response headers



1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1559

def signed_encoding_urls_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.signed_encoding_urls ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.signed_encoding_urls"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.signed_encoding_urls"
  end
  # resource path
  local_var_path = "/encodings/{id}/signed-urls.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'EncodingSignedUrls')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#signed_encoding_urls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signed_video_url(id, factory_id, opts = {}) ⇒ SignedVideoUrl

Returns a signed url pointing to a Video.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1610
1611
1612
1613
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1610

def signed_video_url(id, factory_id, opts = {})
  data, _status_code, _headers = signed_video_url_with_http_info(id, factory_id, opts)
  return data
end

#signed_video_url_with_http_info(id, factory_id, opts = {}) ⇒ Array<(SignedVideoUrl, Fixnum, Hash)>

Returns a signed url pointing to a Video.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    SignedVideoUrl data, response status code and response headers



1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1621

def signed_video_url_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.signed_video_url ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.signed_video_url"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.signed_video_url"
  end
  # resource path
  local_var_path = "/videos/{id}/signed-url.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'SignedVideoUrl')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#signed_video_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#toggle_factory_sync(id, factory_sync_body, opts = {}) ⇒ FactorySync

Toggles synchronisation settings.

Parameters:

  • id —

    id of the factory

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

    the optional parameters

Returns:



1672
1673
1674
1675
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1672

def toggle_factory_sync(id, factory_sync_body, opts = {})
  data, _status_code, _headers = toggle_factory_sync_with_http_info(id, factory_sync_body, opts)
  return data
end

#toggle_factory_sync_with_http_info(id, factory_sync_body, opts = {}) ⇒ Array<(FactorySync, Fixnum, Hash)>

Toggles synchronisation settings.

Parameters:

  • id —

    id of the factory

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

    the optional parameters

Returns:

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

    FactorySync data, response status code and response headers



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1683

def toggle_factory_sync_with_http_info(id, factory_sync_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.toggle_factory_sync ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.toggle_factory_sync"
  end
  # verify the required parameter 'factory_sync_body' is set
  if @api_client.config.client_side_validation && factory_sync_body.nil?
    fail ArgumentError, "Missing the required parameter 'factory_sync_body' when calling FlipApi.toggle_factory_sync"
  end
  # resource path
  local_var_path = "/factories/{id}/sync.json".sub('{' + 'id' + '}', 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(factory_sync_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 => 'FactorySync')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#toggle_factory_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_encoding(id, factory_id, update_encoding_body, opts = {}) ⇒ Encoding

Updates an Encoding

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



1736
1737
1738
1739
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1736

def update_encoding(id, factory_id, update_encoding_body, opts = {})
  data, _status_code, _headers = update_encoding_with_http_info(id, factory_id, update_encoding_body, opts)
  return data
end

#update_encoding_with_http_info(id, factory_id, update_encoding_body, opts = {}) ⇒ Array<(Encoding, Fixnum, Hash)>

Updates an Encoding

Parameters:

  • id —

    Id of an Encoding.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:

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

    Encoding data, response status code and response headers



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1750

def update_encoding_with_http_info(id, factory_id, update_encoding_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.update_encoding ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.update_encoding"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.update_encoding"
  end
  # verify the required parameter 'update_encoding_body' is set
  if @api_client.config.client_side_validation && update_encoding_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_encoding_body' when calling FlipApi.update_encoding"
  end
  # resource path
  local_var_path = "/encodings/{id}.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'screenshots'] = opts[:'screenshots'] if !opts[:'screenshots'].nil?
  query_params[:'precise_status'] = opts[:'precise_status'] if !opts[:'precise_status'].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 = @api_client.object_to_http_body(update_encoding_body)
  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 => 'Encoding')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#update_encoding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_factory(id, update_factory_body, opts = {}) ⇒ Factory

Updates a Factory’s settings. Returns a Factory object.

Parameters:

  • id —

    id of the factory

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:



1808
1809
1810
1811
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1808

def update_factory(id, update_factory_body, opts = {})
  data, _status_code, _headers = update_factory_with_http_info(id, update_factory_body, opts)
  return data
end

#update_factory_with_http_info(id, update_factory_body, opts = {}) ⇒ Array<(Factory, Fixnum, Hash)>

Updates a Factory&#39;s settings. Returns a Factory object.

Parameters:

  • id —

    id of the factory

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

    the optional parameters

Options Hash (opts):

  • :with_storage_provider (BOOLEAN) —

    if set to &#x60;true&#x60;, results will include a storage provider&#39;s id

Returns:

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

    Factory data, response status code and response headers



1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1820

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

  # query parameters
  query_params = {}
  query_params[:'with_storage_provider'] = opts[:'with_storage_provider'] if !opts[:'with_storage_provider'].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 = @api_client.object_to_http_body(update_factory_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Factory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#update_factory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notifications(factory_id, cloud_notification_settings_body, opts = {}) ⇒ CloudNotificationSettings

Updates a Factory’s notification settings.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



1871
1872
1873
1874
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1871

def update_notifications(factory_id, cloud_notification_settings_body, opts = {})
  data, _status_code, _headers = update_notifications_with_http_info(factory_id, cloud_notification_settings_body, opts)
  return data
end

#update_notifications_with_http_info(factory_id, cloud_notification_settings_body, opts = {}) ⇒ Array<(CloudNotificationSettings, Fixnum, Hash)>

Updates a Factory&#39;s notification settings.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    CloudNotificationSettings data, response status code and response headers



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1882

def update_notifications_with_http_info(factory_id, cloud_notification_settings_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.update_notifications ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.update_notifications"
  end
  # verify the required parameter 'cloud_notification_settings_body' is set
  if @api_client.config.client_side_validation && cloud_notification_settings_body.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_notification_settings_body' when calling FlipApi.update_notifications"
  end
  # resource path
  local_var_path = "/notifications.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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(cloud_notification_settings_body)
  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 => 'CloudNotificationSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#update_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_profile(id, factory_id, update_profile_body, opts = {}) ⇒ Profile

Updates a given Profile

Parameters:

  • id
  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN)
  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:



1936
1937
1938
1939
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1936

def update_profile(id, factory_id, update_profile_body, opts = {})
  data, _status_code, _headers = update_profile_with_http_info(id, factory_id, update_profile_body, opts)
  return data
end

#update_profile_with_http_info(id, factory_id, update_profile_body, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Updates a given Profile

Parameters:

  • id
  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :exclude_advanced_services (BOOLEAN)
  • :expand (BOOLEAN) —

    If expand option is set Profile objects will contain all command parameters, even if their value is default. By default this is not set.

Returns:

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

    Profile data, response status code and response headers



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 1950

def update_profile_with_http_info(id, factory_id, update_profile_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.update_profile ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.update_profile"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.update_profile"
  end
  # verify the required parameter 'update_profile_body' is set
  if @api_client.config.client_side_validation && update_profile_body.nil?
    fail ArgumentError, "Missing the required parameter 'update_profile_body' when calling FlipApi.update_profile"
  end
  # resource path
  local_var_path = "/profiles/{id}.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'exclude_advanced_services'] = opts[:'exclude_advanced_services'] if !opts[:'exclude_advanced_services'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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 = @api_client.object_to_http_body(update_profile_body)
  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 => 'Profile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Creates an upload session.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



2007
2008
2009
2010
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2007

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

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

Creates an upload session.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    UploadSession data, response status code and response headers



2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2018

def upload_video_with_http_info(factory_id, video_upload_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.upload_video ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.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 FlipApi.upload_video"
  end
  # resource path
  local_var_path = "/videos/upload.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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: FlipApi#upload_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#video(id, factory_id, opts = {}) ⇒ Video

Returns a Video object.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



2069
2070
2071
2072
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2069

def video(id, factory_id, opts = {})
  data, _status_code, _headers = video_with_http_info(id, factory_id, opts)
  return data
end

#video_encodings(id, factory_id, opts = {}) ⇒ PaginatedEncodingsCollection

Returns a list of Encodings that belong to a Video.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



2135
2136
2137
2138
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2135

def video_encodings(id, factory_id, opts = {})
  data, _status_code, _headers = video_encodings_with_http_info(id, factory_id, opts)
  return data
end

#video_encodings_with_http_info(id, factory_id, opts = {}) ⇒ Array<(PaginatedEncodingsCollection, Fixnum, Hash)>

Returns a list of Encodings that belong to a Video.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

  • :screenshots (BOOLEAN) —

    Determines whether the response will include screenshots. By default this is not set.

  • :precise_status (BOOLEAN) —

    Determines whether the response will include a precise status. By default this is not set.

Returns:



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2150

def video_encodings_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.video_encodings ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.video_encodings"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.video_encodings"
  end
  # resource path
  local_var_path = "/videos/{id}/encodings.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'screenshots'] = opts[:'screenshots'] if !opts[:'screenshots'].nil?
  query_params[:'precise_status'] = opts[:'precise_status'] if !opts[:'precise_status'].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 => 'PaginatedEncodingsCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#video_encodings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#video_metadata(id, factory_id, opts = {}) ⇒ VideoMetadata

Returns a Video’s metadata

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:



2205
2206
2207
2208
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2205

def video_metadata(id, factory_id, opts = {})
  data, _status_code, _headers = video_metadata_with_http_info(id, factory_id, opts)
  return data
end

#video_metadata_with_http_info(id, factory_id, opts = {}) ⇒ Array<(VideoMetadata, Fixnum, Hash)>

Returns a Video&#39;s metadata

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    VideoMetadata data, response status code and response headers



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2216

def video_metadata_with_http_info(id, factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.video_metadata ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FlipApi.video_metadata"
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.video_metadata"
  end
  # resource path
  local_var_path = "/videos/{id}/metadata.json".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'VideoMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#video_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#video_with_http_info(id, factory_id, opts = {}) ⇒ Array<(Video, Fixnum, Hash)>

Returns a Video object.

Parameters:

  • id —

    Id of a Video.

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Returns:

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

    Video data, response status code and response headers



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2080

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

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id

  # 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 => 'Video')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#videos(factory_id, opts = {}) ⇒ PaginatedVideoCollection

Returns a collection of Video objects.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



2268
2269
2270
2271
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2268

def videos(factory_id, opts = {})
  data, _status_code, _headers = videos_with_http_info(factory_id, opts)
  return data
end

#videos_with_http_info(factory_id, opts = {}) ⇒ Array<(PaginatedVideoCollection, Fixnum, Hash)>

Returns a collection of Video objects.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:

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

    PaginatedVideoCollection data, response status code and response headers



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2280

def videos_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.videos ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.videos"
  end
  # resource path
  local_var_path = "/videos.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_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 => 'PaginatedVideoCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#videos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflows(factory_id, opts = {}) ⇒ PaginatedWorkflowsCollection

Returns a collection of Workflows that belong to a Factory.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



2330
2331
2332
2333
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2330

def workflows(factory_id, opts = {})
  data, _status_code, _headers = workflows_with_http_info(factory_id, opts)
  return data
end

#workflows_with_http_info(factory_id, opts = {}) ⇒ Array<(PaginatedWorkflowsCollection, Fixnum, Hash)>

Returns a collection of Workflows that belong to a Factory.

Parameters:

  • factory_id —

    Id of a Factory.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page to be fetched. Default is &#x60;1&#x60;.

  • :per_page (Integer) —

    A number of results per page. Default is &#x60;100&#x60;.

Returns:



2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/telestream_cloud_flip/api/flip_api.rb', line 2342

def workflows_with_http_info(factory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FlipApi.workflows ..."
  end
  # verify the required parameter 'factory_id' is set
  if @api_client.config.client_side_validation && factory_id.nil?
    fail ArgumentError, "Missing the required parameter 'factory_id' when calling FlipApi.workflows"
  end
  # resource path
  local_var_path = "/workflows.json"

  # query parameters
  query_params = {}
  query_params[:'factory_id'] = factory_id
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_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 => 'PaginatedWorkflowsCollection')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FlipApi#workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end