Class: KoronaClient::CustomersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/customers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomersApi

Returns a new instance of CustomersApi.



19
20
21
 
# File 'lib/korona_client/api/customers_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/korona_client/api/customers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_customers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new customers

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



29
30
31
32
 
# File 'lib/korona_client/api/customers_api.rb', line 29

def add_customers(, body, opts = {})
  data, _status_code, _headers = add_customers_with_http_info(, body, opts)
  data
end

#add_customers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new customers

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

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



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
84
 
# File 'lib/korona_client/api/customers_api.rb', line 41

def add_customers_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.add_customers ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.add_customers"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomersApi.add_customers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].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(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersApi#add_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_customer(korona_account_id, customer_id, opts = {}) ⇒ nil

deletes the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/korona_client/api/customers_api.rb', line 91

def delete_customer(, customer_id, opts = {})
  delete_customer_with_http_info(, customer_id, opts)
  nil
end

#delete_customer_with_http_info(korona_account_id, customer_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/korona_client/api/customers_api.rb', line 102

def delete_customer_with_http_info(, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.delete_customer ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.delete_customer"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.delete_customer"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'customerId' + '}', customer_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_customers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing customers (id or number required)

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/korona_client/api/customers_api.rb', line 150

def delete_customers(, body, opts = {})
  data, _status_code, _headers = delete_customers_with_http_info(, body, opts)
  data
end

#delete_customers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

deletes a batch of customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing customers (id or number required)

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

    the optional parameters

Returns:

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

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/korona_client/api/customers_api.rb', line 161

def delete_customers_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.delete_customers ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.delete_customers"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomersApi.delete_customers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', .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(body)
  auth_names = ['basicAuth']
  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 => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersApi#delete_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer(korona_account_id, customer_id, opts = {}) ⇒ Customer

returns the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/korona_client/api/customers_api.rb', line 210

def get_customer(, customer_id, opts = {})
  data, _status_code, _headers = get_customer_with_http_info(, customer_id, opts)
  data
end

#get_customer_with_http_info(korona_account_id, customer_id, opts = {}) ⇒ Array<(Customer, Fixnum, Hash)>

returns the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    Customer data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/korona_client/api/customers_api.rb', line 221

def get_customer_with_http_info(, customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.get_customer ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.get_customer"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.get_customer"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'customerId' + '}', customer_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_customers(korona_account_id, opts = {}) ⇒ ResultListCustomer

lists all customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



275
276
277
278
 
# File 'lib/korona_client/api/customers_api.rb', line 275

def get_customers(, opts = {})
  data, _status_code, _headers = get_customers_with_http_info(, opts)
  data
end

#get_customers_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCustomer, Fixnum, Hash)>

lists all customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:

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

    ResultListCustomer data, response status code and response headers



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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/korona_client/api/customers_api.rb', line 291

def get_customers_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.get_customers ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.get_customers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].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 = ['basicAuth']
  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 => 'ResultListCustomer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersApi#get_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customer(korona_account_id, customer_id, body, opts = {}) ⇒ nil

updates the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the customer

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

    the optional parameters

Returns:

  • (nil) 


343
344
345
346
 
# File 'lib/korona_client/api/customers_api.rb', line 343

def update_customer(, customer_id, body, opts = {})
  update_customer_with_http_info(, customer_id, body, opts)
  nil
end

#update_customer_with_http_info(korona_account_id, customer_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the single customer

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the customer

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
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
 
# File 'lib/korona_client/api/customers_api.rb', line 355

def update_customer_with_http_info(, customer_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.update_customer ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.update_customer"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomersApi.update_customer"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomersApi.update_customer"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers/{customerId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'customerId' + '}', customer_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(body)
  auth_names = ['basicAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing customers (id or number required)

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

    the optional parameters

Returns:



407
408
409
410
 
# File 'lib/korona_client/api/customers_api.rb', line 407

def update_customers(, body, opts = {})
  data, _status_code, _headers = update_customers_with_http_info(, body, opts)
  data
end

#update_customers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

updates a batch of customers

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing customers (id or number required)

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

    the optional parameters

Returns:

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

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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
 
# File 'lib/korona_client/api/customers_api.rb', line 418

def update_customers_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersApi.update_customers ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling CustomersApi.update_customers"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CustomersApi.update_customers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customers'.sub('{' + 'koronaAccountId' + '}', .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(body)
  auth_names = ['basicAuth']
  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 => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersApi#update_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end