Class: CMV4APIClient::RelationshipUsersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RelationshipUsersApi

Returns a new instance of RelationshipUsersApi.



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

def api_client
  @api_client
end

Instance Method Details

#users_create2(ensure_relationship_instance_command_data, opts = {}) ⇒ Users

Create a new CorrespondenceToUser relationship Creates a new CorrespondenceToUser relationship

Parameters:

Returns:



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

def users_create2(ensure_relationship_instance_command_data, opts = {})
  data, _status_code, _headers = users_create2_with_http_info(ensure_relationship_instance_command_data, opts)
  data
end

#users_create2_with_http_info(ensure_relationship_instance_command_data, opts = {}) ⇒ Array<(Users, Integer, Hash)>

Create a new CorrespondenceToUser relationship Creates a new CorrespondenceToUser relationship

Parameters:

Returns:

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

    Users 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
83
84
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 37

def users_create2_with_http_info(ensure_relationship_instance_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_create2 ...'
  end
  # verify the required parameter 'ensure_relationship_instance_command_data' is set
  if @api_client.config.client_side_validation && ensure_relationship_instance_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_relationship_instance_command_data' when calling RelationshipUsersApi.users_create2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser'

  # 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_relationship_instance_command_data)

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

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

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

Delete a CorrespondenceToUser Deletes an existing CorrespondenceToUser.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


91
92
93
94
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 91

def users_delete2(id, opts = {})
  data, _status_code, _headers = users_delete2_with_http_info(id, opts)
  data
end

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

Delete a CorrespondenceToUser Deletes an existing CorrespondenceToUser.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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/relationship_users_api.rb', line 101

def users_delete2_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_delete2 ...'
  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 RelationshipUsersApi.users_delete2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/{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: RelationshipUsersApi#users_delete2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a CorrespondenceToUser Deletes an existing CorrespondenceToUser.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


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

def users_delete_using_post2(id, opts = {})
  data, _status_code, _headers = users_delete_using_post2_with_http_info(id, opts)
  data
end

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

Delete a CorrespondenceToUser Deletes an existing CorrespondenceToUser.

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/relationship_users_api.rb', line 163

def users_delete_using_post2_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_delete_using_post2 ...'
  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 RelationshipUsersApi.users_delete_using_post2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/{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: RelationshipUsersApi#users_delete_using_post2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_get_all2(opts = {}) ⇒ Users

Gets All Users Data Gets all the data for the users relationship

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



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

def users_get_all2(opts = {})
  data, _status_code, _headers = users_get_all2_with_http_info(opts)
  data
end

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

Gets All Users Data Gets all the data for the users relationship

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    Users data, response status code and response headers



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/relationship_users_api.rb', line 227

def users_get_all2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_get_all2 ...'
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser?{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] || 'Users'

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

#users_get_by_id2(id, opts = {}) ⇒ Users

Get CorrespondenceToUser By Id Gets a single CorrespondenceToUser by its Id

Parameters:

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

    the optional parameters

Returns:



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

def users_get_by_id2(id, opts = {})
  data, _status_code, _headers = users_get_by_id2_with_http_info(id, opts)
  data
end

#users_get_by_id2_with_http_info(id, opts = {}) ⇒ Array<(Users, Integer, Hash)>

Get CorrespondenceToUser By Id Gets a single CorrespondenceToUser by its Id

Parameters:

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

    the optional parameters

Returns:

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

    Users data, response status code and response headers



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 287

def users_get_by_id2_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_get_by_id2 ...'
  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 RelationshipUsersApi.users_get_by_id2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/{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] || 'Users'

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

#users_get_count2(opts = {}) ⇒ Integer

Get Users Count Gets the count of all Users

Parameters:

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

    the optional parameters

Returns:

  • (Integer) 


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

def users_get_count2(opts = {})
  data, _status_code, _headers = users_get_count2_with_http_info(opts)
  data
end

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

Get Users Count Gets the count of all Users

Parameters:

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

    the optional parameters

Returns:

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

    Integer data, response status code and response headers



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 347

def users_get_count2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_get_count2 ...'
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/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: RelationshipUsersApi#users_get_count2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_modify2(id, ensure_relationship_instance_command_data, opts = {}) ⇒ Users

Modify a CorrespondenceToUser Modify an existing CorrespondenceToUser.

Parameters:

Returns:



396
397
398
399
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 396

def users_modify2(id, ensure_relationship_instance_command_data, opts = {})
  data, _status_code, _headers = users_modify2_with_http_info(id, ensure_relationship_instance_command_data, opts)
  data
end

#users_modify2_with_http_info(id, ensure_relationship_instance_command_data, opts = {}) ⇒ Array<(Users, Integer, Hash)>

Modify a CorrespondenceToUser Modify an existing CorrespondenceToUser.

Parameters:

Returns:

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

    Users data, response status code and response headers



407
408
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
451
452
453
454
455
456
457
458
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 407

def users_modify2_with_http_info(id, ensure_relationship_instance_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_modify2 ...'
  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 RelationshipUsersApi.users_modify2"
  end
  # verify the required parameter 'ensure_relationship_instance_command_data' is set
  if @api_client.config.client_side_validation && ensure_relationship_instance_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_relationship_instance_command_data' when calling RelationshipUsersApi.users_modify2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/{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_relationship_instance_command_data)

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

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

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

Restore a CorrespondenceToUser Restores a CorrespondenceToUser.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


465
466
467
468
 
# File 'lib/cmv4-openapi-client/api/relationship_users_api.rb', line 465

def users_restore2(id, opts = {})
  data, _status_code, _headers = users_restore2_with_http_info(id, opts)
  data
end

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

Restore a CorrespondenceToUser Restores a CorrespondenceToUser.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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/relationship_users_api.rb', line 475

def users_restore2_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipUsersApi.users_restore2 ...'
  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 RelationshipUsersApi.users_restore2"
  end
  # resource path
  local_var_path = '/relationships/CorrespondenceToUser/{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: RelationshipUsersApi#users_restore2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end