Class: CMV4APIClient::EntityCorrespondenceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/api/entity_correspondence_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EntityCorrespondenceApi

Returns a new instance of EntityCorrespondenceApi.



19
20
21
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_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/cmv4-openapi-client/api/entity_correspondence_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#correspondence_clone(id, opts = {}) ⇒ Correspondence

Clone an existing correspondence Clones an existing correspondence.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 27

def correspondence_clone(id, opts = {})
  data, _status_code, _headers = correspondence_clone_with_http_info(id, opts)
  data
end

#correspondence_clone_with_http_info(id, opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Clone an existing correspondence Clones an existing correspondence.

Parameters:

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

    the optional parameters

Returns:

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

    Correspondence data, response status code and response headers



37
38
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
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 37

def correspondence_clone_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_clone ...'
  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 EntityCorrespondenceApi.correspondence_clone"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}/clone'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_create(ensure_entity_instance_command_data, opts = {}) ⇒ Correspondence

Create a new correspondence Creates a new correspondence.

Parameters:

Returns:



89
90
91
92
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 89

def correspondence_create(ensure_entity_instance_command_data, opts = {})
  data, _status_code, _headers = correspondence_create_with_http_info(ensure_entity_instance_command_data, opts)
  data
end

#correspondence_create_with_http_info(ensure_entity_instance_command_data, opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Create a new correspondence Creates a new correspondence.

Parameters:

Returns:

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

    Correspondence data, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 99

def correspondence_create_with_http_info(ensure_entity_instance_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_create ...'
  end
  # verify the required parameter 'ensure_entity_instance_command_data' is set
  if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityCorrespondenceApi.correspondence_create"
  end
  # resource path
  local_var_path = '/entities/correspondence'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(ensure_entity_instance_command_data)

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_delete(id, opts = {}) ⇒ Object

Delete a correspondence Deletes an existing correspondence.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


153
154
155
156
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 153

def correspondence_delete(id, opts = {})
  data, _status_code, _headers = correspondence_delete_with_http_info(id, opts)
  data
end

#correspondence_delete_using_post(id, opts = {}) ⇒ Object

Delete a correspondence Deletes an existing correspondence.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


215
216
217
218
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 215

def correspondence_delete_using_post(id, opts = {})
  data, _status_code, _headers = correspondence_delete_using_post_with_http_info(id, opts)
  data
end

#correspondence_delete_using_post_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a correspondence Deletes an existing correspondence.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
264
265
266
267
268
269
270
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 225

def correspondence_delete_using_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_delete_using_post ...'
  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 EntityCorrespondenceApi.correspondence_delete_using_post"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}/delete'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Object'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_delete_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_delete_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a correspondence Deletes an existing correspondence.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
204
205
206
207
208
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 163

def correspondence_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_delete ...'
  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 EntityCorrespondenceApi.correspondence_delete"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Object'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_get_all(opts = {}) ⇒ Correspondence

Get All Correspondence Gets all correspondence and allows for the results to be paged.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



278
279
280
281
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 278

def correspondence_get_all(opts = {})
  data, _status_code, _headers = correspondence_get_all_with_http_info(opts)
  data
end

#correspondence_get_all_with_http_info(opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Get All Correspondence Gets all correspondence and allows for the results to be paged.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

    Correspondence data, response status code and response headers



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
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 289

def correspondence_get_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_get_all ...'
  end
  # resource path
  local_var_path = '/entities/correspondence?{page}&{pageSize}'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_get_by_id(id, opts = {}) ⇒ Correspondence

Get Correspondence By Id Gets a single correspondence by its Id

Parameters:

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

    the optional parameters

Returns:



339
340
341
342
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 339

def correspondence_get_by_id(id, opts = {})
  data, _status_code, _headers = correspondence_get_by_id_with_http_info(id, opts)
  data
end

#correspondence_get_by_id_with_http_info(id, opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Get Correspondence By Id Gets a single correspondence by its Id

Parameters:

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

    the optional parameters

Returns:

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

    Correspondence data, response status code and response headers



349
350
351
352
353
354
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
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 349

def correspondence_get_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_get_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 EntityCorrespondenceApi.correspondence_get_by_id"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_get_count(opts = {}) ⇒ Integer

Get Correspondence Count Gets the count of all correspondence

Parameters:

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

    the optional parameters

Returns:

  • (Integer) 


400
401
402
403
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 400

def correspondence_get_count(opts = {})
  data, _status_code, _headers = correspondence_get_count_with_http_info(opts)
  data
end

#correspondence_get_count_with_http_info(opts = {}) ⇒ Array<(Integer, Integer, Hash)>

Get Correspondence Count Gets the count of all correspondence

Parameters:

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

    the optional parameters

Returns:

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

    Integer data, response status code and response headers



409
410
411
412
413
414
415
416
417
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
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 409

def correspondence_get_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_get_count ...'
  end
  # resource path
  local_var_path = '/entities/correspondence/count'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Integer'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_get_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_merge(id, merge_entity_instances_command_data, opts = {}) ⇒ Correspondence

Merge Correspondence Merge existing correspondence.

Parameters:

Returns:



458
459
460
461
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 458

def correspondence_merge(id, merge_entity_instances_command_data, opts = {})
  data, _status_code, _headers = correspondence_merge_with_http_info(id, merge_entity_instances_command_data, opts)
  data
end

#correspondence_merge_with_http_info(id, merge_entity_instances_command_data, opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Merge Correspondence Merge existing correspondence.

Parameters:

Returns:

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

    Correspondence data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
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
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 469

def correspondence_merge_with_http_info(id, merge_entity_instances_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_merge ...'
  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 EntityCorrespondenceApi.correspondence_merge"
  end
  # verify the required parameter 'merge_entity_instances_command_data' is set
  if @api_client.config.client_side_validation && merge_entity_instances_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'merge_entity_instances_command_data' when calling EntityCorrespondenceApi.correspondence_merge"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}/merge'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(merge_entity_instances_command_data)

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_modify(id, ensure_entity_instance_command_data, opts = {}) ⇒ Correspondence

Modify a correspondence Modify an existing correspondence.

Parameters:

Returns:



528
529
530
531
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 528

def correspondence_modify(id, ensure_entity_instance_command_data, opts = {})
  data, _status_code, _headers = correspondence_modify_with_http_info(id, ensure_entity_instance_command_data, opts)
  data
end

#correspondence_modify_with_http_info(id, ensure_entity_instance_command_data, opts = {}) ⇒ Array<(Correspondence, Integer, Hash)>

Modify a correspondence Modify an existing correspondence.

Parameters:

Returns:

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

    Correspondence data, response status code and response headers



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
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
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 539

def correspondence_modify_with_http_info(id, ensure_entity_instance_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_modify ...'
  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 EntityCorrespondenceApi.correspondence_modify"
  end
  # verify the required parameter 'ensure_entity_instance_command_data' is set
  if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityCorrespondenceApi.correspondence_modify"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(ensure_entity_instance_command_data)

  # return_type
  return_type = opts[:return_type] || 'Correspondence'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_modify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#correspondence_restore(id, opts = {}) ⇒ Object

Restore a correspondence Restores a correspondence.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


597
598
599
600
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 597

def correspondence_restore(id, opts = {})
  data, _status_code, _headers = correspondence_restore_with_http_info(id, opts)
  data
end

#correspondence_restore_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Restore a correspondence Restores a correspondence.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



607
608
609
610
611
612
613
614
615
616
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
 
# File 'lib/cmv4-openapi-client/api/entity_correspondence_api.rb', line 607

def correspondence_restore_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntityCorrespondenceApi.correspondence_restore ...'
  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 EntityCorrespondenceApi.correspondence_restore"
  end
  # resource path
  local_var_path = '/entities/correspondence/{id}/restore'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  # return_type
  return_type = opts[:return_type] || 'Object'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntityCorrespondenceApi#correspondence_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end