Class: SubskribeSandboxClient::EntitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/entities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EntitiesApi

Returns a new instance of EntitiesApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/entities_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/subskribe_sandbox/api/entities_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#account_entity_migration(opts = {}) ⇒ nil

Move account to a target entity Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :account_id (String)

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 28

def (opts = {})
  (opts)
  nil
end

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

Move account to a target entity Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :account_id (String)

Returns:

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

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 39

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.account_entity_migration ...'
  end
  # resource path
  local_var_path = '/entities/migrate/account'

  # query parameters
  query_params = {}
  query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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: EntitiesApi#account_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#composite_order_entity_migration(opts = {}) ⇒ nil

Move composite order to a target entity Move composite order along with its subscriptions, orders and other associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :composite_order_id (String)

Returns:

  • (nil) 


79
80
81
82
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 79

def composite_order_entity_migration(opts = {})
  composite_order_entity_migration_with_http_info(opts)
  nil
end

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

Move composite order to a target entity Move composite order along with its subscriptions, orders and other associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :composite_order_id (String)

Returns:

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

    nil, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 90

def composite_order_entity_migration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.composite_order_entity_migration ...'
  end
  # resource path
  local_var_path = '/entities/migrate/compositeOrder'

  # query parameters
  query_params = {}
  query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
  query_params[:'compositeOrderId'] = opts[:'composite_order_id'] if !opts[:'composite_order_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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: EntitiesApi#composite_order_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(opts = {}) ⇒ nil

Create an entity Create an entity. On success return the created entity.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


129
130
131
132
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 129

def create(opts = {})
  create_with_http_info(opts)
  nil
end

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

Create an entity Create an entity. On success return the created entity.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 139

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.create ...'
  end
  # resource path
  local_var_path = '/entities'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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: EntitiesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_entity(id, opts = {}) ⇒ nil

Delete entity Delete the entity if there is no data associated with it.

Parameters:

  • id —

    entity id

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

    the optional parameters

Returns:

  • (nil) 


178
179
180
181
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 178

def delete_entity(id, opts = {})
  delete_entity_with_http_info(id, opts)
  nil
end

#delete_entity_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete entity Delete the entity if there is no data associated with it.

Parameters:

  • id —

    entity id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
223
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 188

def delete_entity_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.delete_entity ...'
  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 EntitiesApi.delete_entity"
  end
  # resource path
  local_var_path = '/entities/{id}'.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'])

  # form parameters
  form_params = {}

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

#get_entities(opts = {}) ⇒ Array<EntityJson>

Gets entities Gets all entities

Parameters:

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

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 228

def get_entities(opts = {})
  data, _status_code, _headers = get_entities_with_http_info(opts)
  data
end

#get_entities_with_http_info(opts = {}) ⇒ Array<(Array<EntityJson>, Fixnum, Hash)>

Gets entities Gets all entities

Parameters:

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

    the optional parameters

Returns:

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

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 237

def get_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.get_entities ...'
  end
  # resource path
  local_var_path = '/entities'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_entity_by_id(id, opts = {}) ⇒ Entity

Gets entity details Gets the entity details of the specified entity id

Parameters:

  • id —

    entity id

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 275

def get_entity_by_id(id, opts = {})
  data, _status_code, _headers = get_entity_by_id_with_http_info(id, opts)
  data
end

#get_entity_by_id_with_http_info(id, opts = {}) ⇒ Array<(Entity, Fixnum, Hash)>

Gets entity details Gets the entity details of the specified entity id

Parameters:

  • id —

    entity id

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

    the optional parameters

Returns:

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

    Entity data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 285

def get_entity_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.get_entity_by_id ...'
  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 EntitiesApi.get_entity_by_id"
  end
  # resource path
  local_var_path = '/entities/{id}'.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'])

  # form parameters
  form_params = {}

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

#get_logo(entity_id, opts = {}) ⇒ nil

Get entity logo Get the current logo stored for the given entity

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


327
328
329
330
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 327

def (entity_id, opts = {})
  get_logo_with_http_info(entity_id, opts)
  nil
end

#get_logo_with_http_info(entity_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get entity logo Get the current logo stored for the given entity

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 337

def get_logo_with_http_info(entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.get_logo ...'
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.get_logo"
  end
  # resource path
  local_var_path = '/entities/logo/{entityId}'.sub('{' + 'entityId' + '}', entity_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#order_entity_migration(opts = {}) ⇒ nil

Update order entity Move order to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :order_id (String)

Returns:

  • (nil) 


379
380
381
382
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 379

def order_entity_migration(opts = {})
  order_entity_migration_with_http_info(opts)
  nil
end

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

Update order entity Move order to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :order_id (String)

Returns:

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

    nil, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 390

def order_entity_migration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.order_entity_migration ...'
  end
  # resource path
  local_var_path = '/entities/migrate/order'

  # query parameters
  query_params = {}
  query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
  query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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: EntitiesApi#order_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subscription_entity_migration(opts = {}) ⇒ nil

Move subscription to a target entity Move subscription and associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :subscription_id (String)

Returns:

  • (nil) 


430
431
432
433
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 430

def subscription_entity_migration(opts = {})
  subscription_entity_migration_with_http_info(opts)
  nil
end

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

Move subscription to a target entity Move subscription and associated transactions to a target entity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_entity_id (String)
  • :subscription_id (String)

Returns:

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

    nil, response status code and response headers



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/subskribe_sandbox/api/entities_api.rb', line 441

def subscription_entity_migration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.subscription_entity_migration ...'
  end
  # resource path
  local_var_path = '/entities/migrate/subscription'

  # query parameters
  query_params = {}
  query_params[:'targetEntityId'] = opts[:'target_entity_id'] if !opts[:'target_entity_id'].nil?
  query_params[:'subscriptionId'] = opts[:'subscription_id'] if !opts[:'subscription_id'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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: EntitiesApi#subscription_entity_migration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_logo(entity_id, opts = {}) ⇒ nil

Update entity logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

  • (nil) 


481
482
483
484
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 481

def (entity_id, opts = {})
  upload_logo_with_http_info(entity_id, opts)
  nil
end

#upload_logo_with_http_info(entity_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update entity logo Updates the logo used in external facing communication such as order forms and invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:

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

    nil, response status code and response headers



492
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
 
# File 'lib/subskribe_sandbox/api/entities_api.rb', line 492

def upload_logo_with_http_info(entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitiesApi.upload_logo ...'
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling EntitiesApi.upload_logo"
  end
  # resource path
  local_var_path = '/entities/logo/{entityId}'.sub('{' + 'entityId' + '}', entity_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(['multipart/form-data'])

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

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