Class: PureCloud::ConfigurationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/configuration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



7
8
9
 
# File 'lib/purecloud/api/configuration_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/configuration_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#delete_retentionpolicies(ids, opts = {}) ⇒ String

Delete policies Bulk delete of Rules from specified rule set, this will only delete the rules that match the ids specified in the query param.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


392
393
394
395
 
# File 'lib/purecloud/api/configuration_api.rb', line 392

def delete_retentionpolicies(ids, opts = {})
  data, status_code, headers = delete_retentionpolicies_with_http_info(ids, opts)
  return data
end

#delete_retentionpolicies_policy_id(policy_id, opts = {}) ⇒ String

Delete policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

  • (String) 


578
579
580
581
 
# File 'lib/purecloud/api/configuration_api.rb', line 578

def delete_retentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = delete_retentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#delete_retentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 588

def delete_retentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#delete_retentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling delete_retentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#delete_retentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_retentionpolicies_with_http_info(ids, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete policies Bulk delete of Rules from specified rule set, this will only delete the rules that match the ids specified in the query param.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



402
403
404
405
406
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 402

def delete_retentionpolicies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#delete_retentionpolicies ..."
  end
  
  # verify the required parameter 'ids' is set
  fail "Missing the required parameter 'ids' when calling delete_retentionpolicies" if ids.nil?
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'ids'] = ids

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#delete_retentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recordingkeys(opts = {}) ⇒ EncryptionKeyEntityListing

Get encryption key list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



17
18
19
20
 
# File 'lib/purecloud/api/configuration_api.rb', line 17

def get_recordingkeys(opts = {})
  data, status_code, headers = get_recordingkeys_with_http_info(opts)
  return data
end

#get_recordingkeys_rotationschedule(opts = {}) ⇒ KeyRotationSchedule

Get key rotation schedule

Parameters:

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/purecloud/api/configuration_api.rb', line 133

def get_recordingkeys_rotationschedule(opts = {})
  data, status_code, headers = get_recordingkeys_rotationschedule_with_http_info(opts)
  return data
end

#get_recordingkeys_rotationschedule_with_http_info(opts = {}) ⇒ Array<(KeyRotationSchedule, Fixnum, Hash)>

Get key rotation schedule

Parameters:

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

    the optional parameters

Returns:

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

    KeyRotationSchedule data, response status code and response headers



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
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloud/api/configuration_api.rb', line 142

def get_recordingkeys_rotationschedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_recordingkeys_rotationschedule ..."
  end
  
  # resource path
  path = "/api/v2/configuration/recordingkeys/rotationschedule".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KeyRotationSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recordingkeys_with_http_info(opts = {}) ⇒ Array<(EncryptionKeyEntityListing, Fixnum, Hash)>

Get encryption key list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    EncryptionKeyEntityListing data, response status code and response headers



28
29
30
31
32
33
34
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 28

def get_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_recordingkeys ..."
  end
  
  # resource path
  path = "/api/v2/configuration/recordingkeys".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EncryptionKeyEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_retentionpolicies(opts = {}) ⇒ PolicyEntityListing

Gets retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :name (String) —

    the policy name - used for filtering results in searches.

  • :enabled (BOOLEAN) —

    checks to see if policy is enabled - use enabled = true or enabled = false

  • :summary (BOOLEAN) —

    provides a less verbose response of policy lists.

  • :has_errors (BOOLEAN) —

    provides a way to fetch all policies with errors or policies that do not have errors

Returns:



257
258
259
260
 
# File 'lib/purecloud/api/configuration_api.rb', line 257

def get_retentionpolicies(opts = {})
  data, status_code, headers = get_retentionpolicies_with_http_info(opts)
  return data
end

#get_retentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Get policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:



454
455
456
457
 
# File 'lib/purecloud/api/configuration_api.rb', line 454

def get_retentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = get_retentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#get_retentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Get policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Returns:

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

    Policy data, response status code and response headers



464
465
466
467
468
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 464

def get_retentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_retentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling get_retentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_retentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_retentionpolicies_with_http_info(opts = {}) ⇒ Array<(PolicyEntityListing, Fixnum, Hash)>

Gets retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :name (String) —

    the policy name - used for filtering results in searches.

  • :enabled (BOOLEAN) —

    checks to see if policy is enabled - use enabled = true or enabled = false

  • :summary (BOOLEAN) —

    provides a less verbose response of policy lists.

  • :has_errors (BOOLEAN) —

    provides a way to fetch all policies with errors or policies that do not have errors

Returns:

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

    PolicyEntityListing data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 276

def get_retentionpolicies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_retentionpolicies ..."
  end
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled']
  query_params[:'summary'] = opts[:'summary'] if opts[:'summary']
  query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolicyEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_retentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext(opts = {}) ⇒ SchemaCategoryEntityListing

Lists available schema categories

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



703
704
705
706
 
# File 'lib/purecloud/api/configuration_api.rb', line 703

def get_schemas_edges_vnext(opts = {})
  data, status_code, headers = get_schemas_edges_vnext_with_http_info(opts)
  return data
end

#get_schemas_edges_vnext_schemacategory(schema_category, opts = {}) ⇒ SchemaReferenceEntityListing

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



766
767
768
769
 
# File 'lib/purecloud/api/configuration_api.rb', line 766

def get_schemas_edges_vnext_schemacategory(schema_category, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts = {}) ⇒ SchemaReferenceEntityListing

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



834
835
836
837
 
# File 'lib/purecloud/api/configuration_api.rb', line 834

def get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id, opts = {}) ⇒ Organization

Get a json schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



905
906
907
908
 
# File 'lib/purecloud/api/configuration_api.rb', line 905

def get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts = {}) ⇒ Organization

Get metadata for a schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • extension —

    extension

  • metadata_id —

    Metadata ID

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type

Returns:



979
980
981
982
 
# File 'lib/purecloud/api/configuration_api.rb', line 979

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get metadata for a schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • extension —

    extension

  • metadata_id —

    Metadata ID

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type

Returns:

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

    Organization data, response status code and response headers



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/purecloud/api/configuration_api.rb', line 994

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_type.nil?
  
  # verify the required parameter 'schema_id' is set
  fail "Missing the required parameter 'schema_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_id.nil?
  
  # verify the required parameter 'extension' is set
  fail "Missing the required parameter 'extension' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if extension.nil?
  
  # verify the required parameter 'metadata_id' is set
  fail "Missing the required parameter 'metadata_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if metadata_id.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extension}/{metadataId}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s).sub('{' + 'schemaId' + '}', schema_id.to_s).sub('{' + 'extension' + '}', extension.to_s).sub('{' + 'metadataId' + '}', metadata_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if opts[:'type']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Organization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get a json schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    Organization data, response status code and response headers



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/purecloud/api/configuration_api.rb', line 917

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_type.nil?
  
  # verify the required parameter 'schema_id' is set
  fail "Missing the required parameter 'schema_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_id.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s).sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Organization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/purecloud/api/configuration_api.rb', line 847

def get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype" if schema_type.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaReferenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_schemas_edges_vnext_schemacategory_schematype\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/purecloud/api/configuration_api.rb', line 778

def get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_schemas_edges_vnext_schemacategory ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory" if schema_category.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaReferenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_schemas_edges_vnext_schemacategory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_with_http_info(opts = {}) ⇒ Array<(SchemaCategoryEntityListing, Fixnum, Hash)>

Lists available schema categories

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/purecloud/api/configuration_api.rb', line 714

def get_schemas_edges_vnext_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#get_schemas_edges_vnext ..."
  end
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaCategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get_schemas_edges_vnext\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_retentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Patch a retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:



640
641
642
643
 
# File 'lib/purecloud/api/configuration_api.rb', line 640

def patch_retentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = patch_retentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#patch_retentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Patch a retention policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Policy data, response status code and response headers



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/purecloud/api/configuration_api.rb', line 651

def patch_retentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#patch_retentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling patch_retentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#patch_retentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_recordingkeys(opts = {}) ⇒ EncryptionKey

Create encryption key

Parameters:

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/purecloud/api/configuration_api.rb', line 77

def post_recordingkeys(opts = {})
  data, status_code, headers = post_recordingkeys_with_http_info(opts)
  return data
end

#post_recordingkeys_with_http_info(opts = {}) ⇒ Array<(EncryptionKey, Fixnum, Hash)>

Create encryption key

Parameters:

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

    the optional parameters

Returns:

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

    EncryptionKey data, response status code and response headers



86
87
88
89
90
91
92
93
94
95
96
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 86

def post_recordingkeys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#post_recordingkeys ..."
  end
  
  # resource path
  path = "/api/v2/configuration/recordingkeys".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EncryptionKey')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#post_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_retentionpolicies(opts = {}) ⇒ Policy

Create retention policy

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



334
335
336
337
 
# File 'lib/purecloud/api/configuration_api.rb', line 334

def post_retentionpolicies(opts = {})
  data, status_code, headers = post_retentionpolicies_with_http_info(opts)
  return data
end

#post_retentionpolicies_with_http_info(opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Create retention policy

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Policy data, response status code and response headers



344
345
346
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 344

def post_retentionpolicies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#post_retentionpolicies ..."
  end
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#post_retentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_recordingkeys_rotationschedule(opts = {}) ⇒ KeyRotationSchedule

Update key rotation schedule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



190
191
192
193
 
# File 'lib/purecloud/api/configuration_api.rb', line 190

def put_recordingkeys_rotationschedule(opts = {})
  data, status_code, headers = put_recordingkeys_rotationschedule_with_http_info(opts)
  return data
end

#put_recordingkeys_rotationschedule_with_http_info(opts = {}) ⇒ Array<(KeyRotationSchedule, Fixnum, Hash)>

Update key rotation schedule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    KeyRotationSchedule data, response status code and response headers



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
236
237
238
239
240
241
 
# File 'lib/purecloud/api/configuration_api.rb', line 200

def put_recordingkeys_rotationschedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#put_recordingkeys_rotationschedule ..."
  end
  
  # resource path
  path = "/api/v2/configuration/recordingkeys/rotationschedule".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'KeyRotationSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#put_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_retentionpolicies_policy_id(policy_id, opts = {}) ⇒ Policy

Update policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:



516
517
518
519
 
# File 'lib/purecloud/api/configuration_api.rb', line 516

def put_retentionpolicies_policy_id(policy_id, opts = {})
  data, status_code, headers = put_retentionpolicies_policy_id_with_http_info(policy_id, opts)
  return data
end

#put_retentionpolicies_policy_id_with_http_info(policy_id, opts = {}) ⇒ Array<(Policy, Fixnum, Hash)>

Update policy

Parameters:

  • policy_id —

    Policy ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Policy data, response status code and response headers



527
528
529
530
531
532
533
534
535
536
537
538
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
 
# File 'lib/purecloud/api/configuration_api.rb', line 527

def put_retentionpolicies_policy_id_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConfigurationApi#put_retentionpolicies_policy_id ..."
  end
  
  # verify the required parameter 'policy_id' is set
  fail "Missing the required parameter 'policy_id' when calling put_retentionpolicies_policy_id" if policy_id.nil?
  
  # resource path
  path = "/api/v2/configuration/retentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Policy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#put_retentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end