Class: CMV4APIClient::GeneralClassificationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeneralClassificationsApi

Returns a new instance of GeneralClassificationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#classifications_controller_read_get(opts = {}) ⇒ Array<Classification>

Get All Classifications Gets all of the classifications within the system

Parameters:

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

    the optional parameters

Returns:



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

def classifications_controller_read_get(opts = {})
  data, _status_code, _headers = classifications_controller_read_get_with_http_info(opts)
  data
end

#classifications_controller_read_get_children(classification_id, request_body, opts = {}) ⇒ Array<ClassificationViewModel>

Get children within Projects Gets child classifications based on the passed id and the posted list of project ids

Parameters:

  • classification_id (Integer)
  • request_body (Array<Integer>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :deleted (Boolean) — default: default to false

Returns:



85
86
87
88
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 85

def classifications_controller_read_get_children(classification_id, request_body, opts = {})
  data, _status_code, _headers = classifications_controller_read_get_children_with_http_info(classification_id, request_body, opts)
  data
end

#classifications_controller_read_get_children_by_path_name(hierarchy_path_name, opts = {}) ⇒ Array<Classification>

Get Children By Path Gets all of the child classifications from a specific path

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 156

def classifications_controller_read_get_children_by_path_name(hierarchy_path_name, opts = {})
  data, _status_code, _headers = classifications_controller_read_get_children_by_path_name_with_http_info(hierarchy_path_name, opts)
  data
end

#classifications_controller_read_get_children_by_path_name_with_http_info(hierarchy_path_name, opts = {}) ⇒ Array<(Array<Classification>, Integer, Hash)>

Get Children By Path Gets all of the child classifications from a specific path

Parameters:

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 166

def classifications_controller_read_get_children_by_path_name_with_http_info(hierarchy_path_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_read_get_children_by_path_name ...'
  end
  # resource path
  local_var_path = '/classifications/byname/{hierarchyPathName}'.sub('{' + 'hierarchyPathName' + '}', CGI.escape(hierarchy_path_name.to_s)).gsub("+","%20")

  # 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] || 'Array<Classification>'

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

#classifications_controller_read_get_children_with_http_info(classification_id, request_body, opts = {}) ⇒ Array<(Array<ClassificationViewModel>, Integer, Hash)>

Get children within Projects Gets child classifications based on the passed id and the posted list of project ids

Parameters:

  • classification_id (Integer)
  • request_body (Array<Integer>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :deleted (Boolean)

Returns:

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

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 97

def classifications_controller_read_get_children_with_http_info(classification_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_read_get_children ...'
  end
  # verify the required parameter 'classification_id' is set
  if @api_client.config.client_side_validation && classification_id.nil?
    fail ArgumentError, "Missing the required parameter 'classification_id' when calling GeneralClassificationsApi.classifications_controller_read_get_children"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling GeneralClassificationsApi.classifications_controller_read_get_children"
  end
  # resource path
  local_var_path = '/classifications/{classificationId}/children'.sub('{' + 'classificationId' + '}', CGI.escape(classification_id.to_s))

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

  # 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(request_body)

  # return_type
  return_type = opts[:return_type] || 'Array<ClassificationViewModel>'

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

#classifications_controller_read_get_classification_by_id(classification_id, opts = {}) ⇒ Classification

Get Classification By Id Gets a specific classification

Parameters:

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

    the optional parameters

Returns:



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

def classifications_controller_read_get_classification_by_id(classification_id, opts = {})
  data, _status_code, _headers = classifications_controller_read_get_classification_by_id_with_http_info(classification_id, opts)
  data
end

#classifications_controller_read_get_classification_by_id_with_http_info(classification_id, opts = {}) ⇒ Array<(Classification, Integer, Hash)>

Get Classification By Id Gets a specific classification

Parameters:

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

    the optional parameters

Returns:

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

    Classification data, response status code and response headers



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 224

def classifications_controller_read_get_classification_by_id_with_http_info(classification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_read_get_classification_by_id ...'
  end
  # verify the required parameter 'classification_id' is set
  if @api_client.config.client_side_validation && classification_id.nil?
    fail ArgumentError, "Missing the required parameter 'classification_id' when calling GeneralClassificationsApi.classifications_controller_read_get_classification_by_id"
  end
  # resource path
  local_var_path = '/classifications/{classificationId}'.sub('{' + 'classificationId' + '}', CGI.escape(classification_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] || 'Classification'

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

#classifications_controller_read_get_flat_classification_tree(classification_id, request_body, opts = {}) ⇒ Array<ClassificationViewModel>

Get flat classifications within Projects Gets a flattened view of the classifications under a particular id within a list of project ids

Parameters:

  • classification_id (Integer)
  • request_body (Array<Integer>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :deleted (Boolean) — default: default to false

Returns:



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

def classifications_controller_read_get_flat_classification_tree(classification_id, request_body, opts = {})
  data, _status_code, _headers = classifications_controller_read_get_flat_classification_tree_with_http_info(classification_id, request_body, opts)
  data
end

#classifications_controller_read_get_flat_classification_tree_with_http_info(classification_id, request_body, opts = {}) ⇒ Array<(Array<ClassificationViewModel>, Integer, Hash)>

Get flat classifications within Projects Gets a flattened view of the classifications under a particular id within a list of project ids

Parameters:

  • classification_id (Integer)
  • request_body (Array<Integer>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :deleted (Boolean)

Returns:

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

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



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
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 290

def classifications_controller_read_get_flat_classification_tree_with_http_info(classification_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_read_get_flat_classification_tree ...'
  end
  # verify the required parameter 'classification_id' is set
  if @api_client.config.client_side_validation && classification_id.nil?
    fail ArgumentError, "Missing the required parameter 'classification_id' when calling GeneralClassificationsApi.classifications_controller_read_get_flat_classification_tree"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling GeneralClassificationsApi.classifications_controller_read_get_flat_classification_tree"
  end
  # resource path
  local_var_path = '/classifications/{classificationId}/flat'.sub('{' + 'classificationId' + '}', CGI.escape(classification_id.to_s))

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

  # 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(request_body)

  # return_type
  return_type = opts[:return_type] || 'Array<ClassificationViewModel>'

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

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

Get All Classifications Gets all of the classifications within the system

Parameters:

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

    the optional parameters

Returns:

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

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



35
36
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
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 35

def classifications_controller_read_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_read_get ...'
  end
  # resource path
  local_var_path = '/classifications'

  # 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] || 'Array<Classification>'

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

#classifications_controller_write_create(ensure_classification_command_data, opts = {}) ⇒ Classification

Create Classification Creates a new Classification.

Parameters:

Returns:



349
350
351
352
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 349

def classifications_controller_write_create(ensure_classification_command_data, opts = {})
  data, _status_code, _headers = classifications_controller_write_create_with_http_info(ensure_classification_command_data, opts)
  data
end

#classifications_controller_write_create_with_http_info(ensure_classification_command_data, opts = {}) ⇒ Array<(Classification, Integer, Hash)>

Create Classification Creates a new Classification.

Parameters:

Returns:

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

    Classification data, response status code and response headers



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 359

def classifications_controller_write_create_with_http_info(ensure_classification_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_write_create ...'
  end
  # verify the required parameter 'ensure_classification_command_data' is set
  if @api_client.config.client_side_validation && ensure_classification_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_classification_command_data' when calling GeneralClassificationsApi.classifications_controller_write_create"
  end
  # resource path
  local_var_path = '/classifications'

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

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

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

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

Delete a Classification Deletes an existing Classification.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


413
414
415
416
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 413

def classifications_controller_write_delete(id, opts = {})
  classifications_controller_write_delete_with_http_info(id, opts)
  nil
end

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

Delete a Classification Deletes an existing Classification.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


473
474
475
476
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 473

def classifications_controller_write_delete_using_post(id, opts = {})
  classifications_controller_write_delete_using_post_with_http_info(id, opts)
  nil
end

#classifications_controller_write_delete_using_post_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Classification Deletes an existing Classification.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
521
522
523
524
525
526
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 483

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type]

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

#classifications_controller_write_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Classification Deletes an existing Classification.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 423

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type]

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

#classifications_controller_write_modify(id, ensure_classification_command_data, opts = {}) ⇒ Classification

Modify Classification Modifies an existing Classification.

Parameters:

Returns:



534
535
536
537
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 534

def classifications_controller_write_modify(id, ensure_classification_command_data, opts = {})
  data, _status_code, _headers = classifications_controller_write_modify_with_http_info(id, ensure_classification_command_data, opts)
  data
end

#classifications_controller_write_modify_with_http_info(id, ensure_classification_command_data, opts = {}) ⇒ Array<(Classification, Integer, Hash)>

Modify Classification Modifies an existing Classification.

Parameters:

Returns:

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

    Classification data, response status code and response headers



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
591
592
593
594
595
596
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 545

def classifications_controller_write_modify_with_http_info(id, ensure_classification_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_write_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 GeneralClassificationsApi.classifications_controller_write_modify"
  end
  # verify the required parameter 'ensure_classification_command_data' is set
  if @api_client.config.client_side_validation && ensure_classification_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'ensure_classification_command_data' when calling GeneralClassificationsApi.classifications_controller_write_modify"
  end
  # resource path
  local_var_path = '/classifications/{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_classification_command_data)

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

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

#classifications_controller_write_reassign(id, reassign_classification_command_data, opts = {}) ⇒ Classification

Reassign a Classification Reassigns a Classification.

Parameters:

Returns:



604
605
606
607
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 604

def classifications_controller_write_reassign(id, reassign_classification_command_data, opts = {})
  data, _status_code, _headers = classifications_controller_write_reassign_with_http_info(id, reassign_classification_command_data, opts)
  data
end

#classifications_controller_write_reassign_with_http_info(id, reassign_classification_command_data, opts = {}) ⇒ Array<(Classification, Integer, Hash)>

Reassign a Classification Reassigns a Classification.

Parameters:

Returns:

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

    Classification data, response status code and response headers



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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 615

def classifications_controller_write_reassign_with_http_info(id, reassign_classification_command_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralClassificationsApi.classifications_controller_write_reassign ...'
  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 GeneralClassificationsApi.classifications_controller_write_reassign"
  end
  # verify the required parameter 'reassign_classification_command_data' is set
  if @api_client.config.client_side_validation && reassign_classification_command_data.nil?
    fail ArgumentError, "Missing the required parameter 'reassign_classification_command_data' when calling GeneralClassificationsApi.classifications_controller_write_reassign"
  end
  # resource path
  local_var_path = '/classifications/{id}/reassign'.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(reassign_classification_command_data)

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

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

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

Restore a Classification Restores a Classification.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


673
674
675
676
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 673

def classifications_controller_write_restore(id, opts = {})
  classifications_controller_write_restore_with_http_info(id, opts)
  nil
end

#classifications_controller_write_restore_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Restore a Classification Restores a Classification.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



683
684
685
686
687
688
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
 
# File 'lib/cmv4-openapi-client/api/general_classifications_api.rb', line 683

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type]

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