Class: WhiteLabelMachineName::DebtCollectionCaseService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DebtCollectionCaseService

Returns a new instance of DebtCollectionCaseService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#add_collected_amount(space_id, id, collected_amount, external_id, opts = {}) ⇒ DebtCollectionReceipt

Add Collected Amount Adds a new collected amount to the case, creating a new payment receipt.

Parameters:

  • space_id
  • id —

    The id of the debt collection case for which the amount should be added.

  • collected_amount —

    The amount that has been collected.

  • external_id —

    The unique external id of this payment receipt.

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

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 36

def add_collected_amount(space_id, id, collected_amount, external_id, opts = {})
  data, _status_code, _headers = add_collected_amount_with_http_info(space_id, id, collected_amount, external_id, opts)
  return data
end

#add_collected_amount_with_http_info(space_id, id, collected_amount, external_id, opts = {}) ⇒ Array<(DebtCollectionReceipt, Fixnum, Hash)>

Add Collected Amount Adds a new collected amount to the case, creating a new payment receipt.

Parameters:

  • space_id
  • id —

    The id of the debt collection case for which the amount should be added.

  • collected_amount —

    The amount that has been collected.

  • external_id —

    The unique external id of this payment receipt.

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

    the optional parameters

Returns:

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

    DebtCollectionReceipt data, response status code and response headers



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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 49

def add_collected_amount_with_http_info(space_id, id, collected_amount, external_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.add_collected_amount ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.add_collected_amount" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.add_collected_amount" if id.nil?
  # verify the required parameter 'collected_amount' is set
  fail ArgumentError, "Missing the required parameter 'collected_amount' when calling DebtCollectionCaseService.add_collected_amount" if collected_amount.nil?
  # verify the required parameter 'external_id' is set
  fail ArgumentError, "Missing the required parameter 'external_id' when calling DebtCollectionCaseService.add_collected_amount" if external_id.nil?
  # resource path
  local_var_path = "/debt-collection-case/addCollectedAmount".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id
  query_params[:'collectedAmount'] = collected_amount
  query_params[:'externalId'] = external_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#attach_document(space_id, id, file_name, content_base64, opts = {}) ⇒ DebtCollectionCaseDocument

Attach Document Attach an additional supporting document to the case.

Parameters:

  • space_id
  • id —

    The id of the debt collection case.

  • file_name —

    The file name of the document that is uploaded.

  • content_base64 —

    The BASE64 encoded contents of the document.

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

    the optional parameters

Returns:



109
110
111
112
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 109

def attach_document(space_id, id, file_name, content_base64, opts = {})
  data, _status_code, _headers = attach_document_with_http_info(space_id, id, file_name, content_base64, opts)
  return data
end

#attach_document_with_http_info(space_id, id, file_name, content_base64, opts = {}) ⇒ Array<(DebtCollectionCaseDocument, Fixnum, Hash)>

Attach Document Attach an additional supporting document to the case.

Parameters:

  • space_id
  • id —

    The id of the debt collection case.

  • file_name —

    The file name of the document that is uploaded.

  • content_base64 —

    The BASE64 encoded contents of the document.

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

    the optional parameters

Returns:

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

    DebtCollectionCaseDocument data, response status code and response headers



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 122

def attach_document_with_http_info(space_id, id, file_name, content_base64, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.attach_document ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.attach_document" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.attach_document" if id.nil?
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling DebtCollectionCaseService.attach_document" if file_name.nil?
  # verify the required parameter 'content_base64' is set
  fail ArgumentError, "Missing the required parameter 'content_base64' when calling DebtCollectionCaseService.attach_document" if content_base64.nil?
  # resource path
  local_var_path = "/debt-collection-case/attachDocument".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id
  query_params[:'fileName'] = file_name
  query_params[:'contentBase64'] = content_base64

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#close(space_id, id, opts = {}) ⇒ DebtCollectionCase

Close Closes the debt collection case, meaning no further money can be collected.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be closed.

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

    the optional parameters

Returns:



180
181
182
183
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 180

def close(space_id, id, opts = {})
  data, _status_code, _headers = close_with_http_info(space_id, id, opts)
  return data
end

#close_with_http_info(space_id, id, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Close Closes the debt collection case, meaning no further money can be collected.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be closed.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



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
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 191

def close_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.close ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.close" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.close" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/close".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


243
244
245
246
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 243

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 254

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.count" if space_id.nil?
  # resource path
  local_var_path = "/debt-collection-case/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#create(space_id, entity, opts = {}) ⇒ DebtCollectionCase

Create Creates the entity with the given properties.

Parameters:

  • space_id
  • entity —

    The debt collection case object with the properties which should be created.

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 303

def create(space_id, entity, opts = {})
  data, _status_code, _headers = create_with_http_info(space_id, entity, opts)
  return data
end

#create_with_http_info(space_id, entity, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Create Creates the entity with the given properties.

Parameters:

  • space_id
  • entity —

    The debt collection case object with the properties which should be created.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



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
349
350
351
352
353
354
355
356
357
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 314

def create_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.create ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.create" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling DebtCollectionCaseService.create" if entity.nil?
  # resource path
  local_var_path = "/debt-collection-case/create".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete(space_id, id, opts = {}) ⇒ nil

Delete Deletes the entity with the given id.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


365
366
367
368
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 365

def delete(space_id, id, opts = {})
  delete_with_http_info(space_id, id, opts)
  return nil
end

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

Delete Deletes the entity with the given id.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
411
412
413
414
415
416
417
418
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 376

def delete_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.delete ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.delete" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.delete" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/delete".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#documents(space_id, id, opts = {}) ⇒ Array<DebtCollectionCaseDocument>

Documents Returns all documents that are attached to a debt collection case.

Parameters:

  • space_id
  • id —

    The id of the debt collection case for which the attached documents are returned.

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

    the optional parameters

Returns:



426
427
428
429
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 426

def documents(space_id, id, opts = {})
  data, _status_code, _headers = documents_with_http_info(space_id, id, opts)
  return data
end

#documents_with_http_info(space_id, id, opts = {}) ⇒ Array<(Array<DebtCollectionCaseDocument>, Fixnum, Hash)>

Documents Returns all documents that are attached to a debt collection case.

Parameters:

  • space_id
  • id —

    The id of the debt collection case for which the attached documents are returned.

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

    the optional parameters

Returns:

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

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



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
475
476
477
478
479
480
481
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 437

def documents_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.documents ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.documents" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.documents" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/documents".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#mark_as_prepared(space_id, id, opts = {}) ⇒ DebtCollectionCase

Mark Case As Prepared This operation will mark a debt collection case as prepared and allow the collection process to proceed.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be marked as prepared.

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

    the optional parameters

Returns:



489
490
491
492
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 489

def mark_as_prepared(space_id, id, opts = {})
  data, _status_code, _headers = mark_as_prepared_with_http_info(space_id, id, opts)
  return data
end

#mark_as_prepared_with_http_info(space_id, id, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Mark Case As Prepared This operation will mark a debt collection case as prepared and allow the collection process to proceed.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be marked as prepared.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 500

def mark_as_prepared_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.mark_as_prepared ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.mark_as_prepared" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.mark_as_prepared" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/markAsPrepared".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#mark_as_reviewed(space_id, id, opts = {}) ⇒ DebtCollectionCase

Mark Case As Reviewed This operation will mark a debt collection case as reviewed and allow the collection process to proceed.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be reviewed.

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

    the optional parameters

Returns:



552
553
554
555
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 552

def mark_as_reviewed(space_id, id, opts = {})
  data, _status_code, _headers = mark_as_reviewed_with_http_info(space_id, id, opts)
  return data
end

#mark_as_reviewed_with_http_info(space_id, id, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Mark Case As Reviewed This operation will mark a debt collection case as reviewed and allow the collection process to proceed.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be reviewed.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



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
599
600
601
602
603
604
605
606
607
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 563

def mark_as_reviewed_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.mark_as_reviewed ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.mark_as_reviewed" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.mark_as_reviewed" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/markAsReviewed".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#read(space_id, id, opts = {}) ⇒ DebtCollectionCase

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be returned.

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

    the optional parameters

Returns:



615
616
617
618
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 615

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the debt collection case which should be returned.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



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
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 626

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DebtCollectionCaseService.read" if id.nil?
  # resource path
  local_var_path = "/debt-collection-case/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#search(space_id, query, opts = {}) ⇒ Array<DebtCollectionCase>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the cases which are returned by the search.

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

    the optional parameters

Returns:



678
679
680
681
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 678

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<DebtCollectionCase>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the cases which are returned by the search.

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

    the optional parameters

Returns:

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

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



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
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 689

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling DebtCollectionCaseService.search" if query.nil?
  # resource path
  local_var_path = "/debt-collection-case/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#update(space_id, entity, opts = {}) ⇒ DebtCollectionCase

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The ‘id’ and ‘version’ are required to identify the entity.

Parameters:

  • space_id
  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:



740
741
742
743
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 740

def update(space_id, entity, opts = {})
  data, _status_code, _headers = update_with_http_info(space_id, entity, opts)
  return data
end

#update_with_http_info(space_id, entity, opts = {}) ⇒ Array<(DebtCollectionCase, Fixnum, Hash)>

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The &#39;id&#39; and &#39;version&#39; are required to identify the entity.

Parameters:

  • space_id
  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:

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

    DebtCollectionCase data, response status code and response headers



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
791
792
793
794
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/debt_collection_case_service_api.rb', line 751

def update_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DebtCollectionCaseService.update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling DebtCollectionCaseService.update" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling DebtCollectionCaseService.update" if entity.nil?
  # resource path
  local_var_path = "/debt-collection-case/update".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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