purecloudplatformclientv2 75.1.0 → 79.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActivityCode.md +1 -1
  4. data/docs/AnalyticsApi.md +66 -2
  5. data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
  6. data/docs/AnalyticsConversationQueryResponse.md +1 -1
  7. data/docs/AnalyticsParticipant.md +1 -0
  8. data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
  9. data/docs/ArchitectApi.md +345 -0
  10. data/docs/AuditApi.md +3 -1
  11. data/docs/AuditLogMessage.md +1 -1
  12. data/docs/AuthorizationApi.md +154 -9
  13. data/docs/AvailableTopic.md +3 -1
  14. data/docs/BuAgentScheduleActivity.md +18 -0
  15. data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
  16. data/docs/BuAgentScheduleSearchResponse.md +15 -0
  17. data/docs/BuAgentScheduleShift.md +18 -0
  18. data/docs/BuAgentSchedulesSearchResponse.md +15 -0
  19. data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
  20. data/docs/BuFullDayTimeOffMarker.md +18 -0
  21. data/docs/BuScheduleReference.md +15 -0
  22. data/docs/Call.md +1 -1
  23. data/docs/CallBasic.md +1 -1
  24. data/docs/CallMediaParticipant.md +1 -1
  25. data/docs/CallbackMediaParticipant.md +1 -1
  26. data/docs/CampaignProgress.md +2 -1
  27. data/docs/ChatMediaParticipant.md +1 -1
  28. data/docs/CobrowseMediaParticipant.md +1 -1
  29. data/docs/ConversationsApi.md +71 -1
  30. data/docs/CopyAttachmentsRequest.md +14 -0
  31. data/docs/CreateManagementUnitApiRequest.md +3 -2
  32. data/docs/CreateManagementUnitSettingsRequest.md +1 -1
  33. data/docs/CreateWorkPlanShift.md +1 -1
  34. data/docs/DataTableExportJob.md +22 -0
  35. data/docs/DataTableImportJob.md +25 -0
  36. data/docs/DivsPermittedEntityListing.md +23 -0
  37. data/docs/EmailMediaParticipant.md +1 -1
  38. data/docs/EntityListing.md +17 -0
  39. data/docs/ErrorBody.md +2 -2
  40. data/docs/ErrorInfo.md +14 -0
  41. data/docs/Evaluation.md +1 -0
  42. data/docs/EvaluationQuestionGroupScore.md +4 -0
  43. data/docs/EvaluationScoringSet.md +1 -0
  44. data/docs/FacebookIntegrationRequest.md +2 -2
  45. data/docs/GDPRJourneyCustomer.md +2 -2
  46. data/docs/InboundDomain.md +2 -0
  47. data/docs/Library.md +4 -3
  48. data/docs/LicenseApi.md +66 -0
  49. data/docs/MailFromResult.md +15 -0
  50. data/docs/ManagementUnit.md +2 -2
  51. data/docs/ManagementUnitSettingsRequest.md +1 -1
  52. data/docs/MessageMediaParticipant.md +1 -1
  53. data/docs/MessagingApi.md +0 -936
  54. data/docs/MessagingTemplate.md +15 -0
  55. data/docs/Organization.md +1 -0
  56. data/docs/QualityApi.md +5 -6
  57. data/docs/Record.md +15 -0
  58. data/docs/ReportingExportMetadataJobListing.md +22 -0
  59. data/docs/ReportingExportMetadataJobResponse.md +22 -0
  60. data/docs/Response.md +2 -0
  61. data/docs/RoutingApi.md +385 -0
  62. data/docs/RoutingSettings.md +13 -0
  63. data/docs/SCIMApi.md +397 -23
  64. data/docs/ScimUserExtensions.md +14 -0
  65. data/docs/ScimUserRole.md +13 -0
  66. data/docs/ScimUserRoutingLanguage.md +14 -0
  67. data/docs/ScimUserRoutingSkill.md +14 -0
  68. data/docs/ScimV2CreateUser.md +2 -1
  69. data/docs/ScimV2SchemaAttribute.md +24 -0
  70. data/docs/ScimV2SchemaDefinition.md +17 -0
  71. data/docs/ScimV2SchemaListResponse.md +17 -0
  72. data/docs/ScimV2User.md +2 -1
  73. data/docs/ShortTermForecast.md +2 -2
  74. data/docs/ShortTermForecastListItemResponse.md +2 -2
  75. data/docs/ShortTermForecastReference.md +2 -2
  76. data/docs/TimeOffRequestLookup.md +3 -3
  77. data/docs/TimeOffRequestResponse.md +3 -3
  78. data/docs/UserScheduleAdherence.md +1 -1
  79. data/docs/UsersApi.md +358 -10
  80. data/docs/ViewFilter.md +4 -10
  81. data/docs/WeekSchedule.md +1 -1
  82. data/docs/WeekScheduleListItemResponse.md +1 -1
  83. data/docs/WeekScheduleReference.md +1 -1
  84. data/docs/WorkPlanShift.md +1 -1
  85. data/docs/WorkforceManagementApi.md +40 -41
  86. data/lib/purecloudplatformclientv2.rb +27 -0
  87. data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
  88. data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
  89. data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
  90. data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
  91. data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
  92. data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
  93. data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
  94. data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
  95. data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
  96. data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
  101. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
  102. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
  103. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
  104. data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
  106. data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
  107. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
  108. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
  110. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
  111. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
  112. data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
  113. data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
  114. data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
  115. data/lib/purecloudplatformclientv2/models/call.rb +1 -1
  116. data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
  117. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
  118. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
  119. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
  120. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
  121. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
  122. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  123. data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
  124. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
  125. data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
  126. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
  127. data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
  128. data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
  129. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
  130. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
  131. data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
  132. data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
  133. data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
  134. data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
  135. data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
  136. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
  137. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
  138. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  139. data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
  140. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
  141. data/lib/purecloudplatformclientv2/models/library.rb +44 -2
  142. data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
  143. data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
  144. data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
  145. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
  146. data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
  147. data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
  148. data/lib/purecloudplatformclientv2/models/record.rb +269 -0
  149. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  150. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
  151. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
  152. data/lib/purecloudplatformclientv2/models/response.rb +67 -1
  153. data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
  154. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  155. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
  156. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
  157. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
  158. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
  159. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
  160. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
  161. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
  162. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
  163. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
  164. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
  165. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
  166. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  167. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
  168. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
  169. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
  170. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
  171. data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
  172. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
  173. data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
  174. data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
  175. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
  176. data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
  177. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +56 -2
@@ -322,6 +322,8 @@ module PureCloud
322
322
  #
323
323
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
324
324
  # @param [Hash] opts the optional parameters
325
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
326
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
325
327
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
326
328
  # @return [ScimV2Group]
327
329
  def get_scim_group(group_id, opts = {})
@@ -333,6 +335,8 @@ module PureCloud
333
335
  #
334
336
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
335
337
  # @param [Hash] opts the optional parameters
338
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
339
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
336
340
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
337
341
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
338
342
  def get_scim_group_with_http_info(group_id, opts = {})
@@ -351,6 +355,18 @@ module PureCloud
351
355
 
352
356
 
353
357
 
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
354
370
 
355
371
 
356
372
 
@@ -359,6 +375,8 @@ module PureCloud
359
375
 
360
376
  # query parameters
361
377
  query_params = {}
378
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
379
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
362
380
 
363
381
  # header parameters
364
382
  header_params = {}
@@ -397,6 +415,8 @@ module PureCloud
397
415
  # @param [Hash] opts the optional parameters
398
416
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
399
417
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
418
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
419
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
400
420
  # @option opts [String] :filter Filters results.
401
421
  # @return [ScimGroupListResponse]
402
422
  def get_scim_groups(opts = {})
@@ -409,6 +429,8 @@ module PureCloud
409
429
  # @param [Hash] opts the optional parameters
410
430
  # @option opts [Integer] :start_index The 1-based index of the first query result.
411
431
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
432
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
433
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
412
434
  # @option opts [String] :filter Filters results.
413
435
  # @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
414
436
  def get_scim_groups_with_http_info(opts = {})
@@ -425,6 +447,18 @@ module PureCloud
425
447
 
426
448
 
427
449
 
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
428
462
 
429
463
 
430
464
 
@@ -441,6 +475,8 @@ module PureCloud
441
475
  query_params = {}
442
476
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
443
477
  query_params[:'count'] = opts[:'count'] if opts[:'count']
478
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
479
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
444
480
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
445
481
 
446
482
  # header parameters
@@ -499,8 +535,8 @@ module PureCloud
499
535
  fail ArgumentError, "Missing the required parameter 'resource_type' when calling SCIMApi.get_scim_resourcetype" if resource_type.nil?
500
536
 
501
537
  # verify enum value
502
- unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType'].include?(resource_type)
503
- fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType"
538
+ unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType', 'Schema'].include?(resource_type)
539
+ fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType, Schema"
504
540
  end
505
541
 
506
542
 
@@ -530,7 +566,7 @@ module PureCloud
530
566
  # http body (model)
531
567
  post_body = nil
532
568
 
533
- auth_names = []
569
+ auth_names = ['PureCloud OAuth']
534
570
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
535
571
  :header_params => header_params,
536
572
  :query_params => query_params,
@@ -585,7 +621,7 @@ module PureCloud
585
621
  # http body (model)
586
622
  post_body = nil
587
623
 
588
- auth_names = []
624
+ auth_names = ['PureCloud OAuth']
589
625
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
590
626
  :header_params => header_params,
591
627
  :query_params => query_params,
@@ -599,6 +635,140 @@ module PureCloud
599
635
  return data, status_code, headers
600
636
  end
601
637
 
638
+ # Get the SCIM schema by id
639
+ #
640
+ # @param schema_id The ID of a schema.
641
+ # @param [Hash] opts the optional parameters
642
+ # @return [ScimConfigResourceType]
643
+ def get_scim_schema(schema_id, opts = {})
644
+ data, _status_code, _headers = get_scim_schema_with_http_info(schema_id, opts)
645
+ return data
646
+ end
647
+
648
+ # Get the SCIM schema by id
649
+ #
650
+ # @param schema_id The ID of a schema.
651
+ # @param [Hash] opts the optional parameters
652
+ # @return [Array<(ScimConfigResourceType, Fixnum, Hash)>] ScimConfigResourceType data, response status code and response headers
653
+ def get_scim_schema_with_http_info(schema_id, opts = {})
654
+ if @api_client.config.debugging
655
+ @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schema ..."
656
+ end
657
+
658
+
659
+ # verify the required parameter 'schema_id' is set
660
+ fail ArgumentError, "Missing the required parameter 'schema_id' when calling SCIMApi.get_scim_schema" if schema_id.nil?
661
+
662
+ # verify enum value
663
+ unless ['urn:ietf:params:scim:schemas:core:2.0:User', 'urn:ietf:params:scim:schemas:core:2.0:Group', 'urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig', 'urn:ietf:params:scim:schemas:core:2.0:ResourceType', 'urn:ietf:params:scim:schemas:core:2.0:Schema', 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User', 'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'].include?(schema_id)
664
+ fail ArgumentError, "invalid value for 'schema_id', must be one of urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"
665
+ end
666
+
667
+
668
+
669
+
670
+
671
+ # resource path
672
+ local_var_path = "/api/v2/scim/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)
673
+
674
+ # query parameters
675
+ query_params = {}
676
+
677
+ # header parameters
678
+ header_params = {}
679
+
680
+ # HTTP header 'Accept' (if needed)
681
+ local_header_accept = ['application/json', 'application/scim+json']
682
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
683
+
684
+ # HTTP header 'Content-Type'
685
+ local_header_content_type = ['application/json', 'application/scim+json']
686
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
687
+
688
+ # form parameters
689
+ form_params = {}
690
+
691
+ # http body (model)
692
+ post_body = nil
693
+
694
+ auth_names = ['PureCloud OAuth']
695
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
696
+ :header_params => header_params,
697
+ :query_params => query_params,
698
+ :form_params => form_params,
699
+ :body => post_body,
700
+ :auth_names => auth_names,
701
+ :return_type => 'ScimConfigResourceType')
702
+ if @api_client.config.debugging
703
+ @api_client.config.logger.debug "API called: SCIMApi#get_scim_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
704
+ end
705
+ return data, status_code, headers
706
+ end
707
+
708
+ # Get the SCIM schemas
709
+ #
710
+ # @param [Hash] opts the optional parameters
711
+ # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
712
+ # @return [ScimConfigResourceTypesListResponse]
713
+ def get_scim_schemas(opts = {})
714
+ data, _status_code, _headers = get_scim_schemas_with_http_info(opts)
715
+ return data
716
+ end
717
+
718
+ # Get the SCIM schemas
719
+ #
720
+ # @param [Hash] opts the optional parameters
721
+ # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
722
+ # @return [Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>] ScimConfigResourceTypesListResponse data, response status code and response headers
723
+ def get_scim_schemas_with_http_info(opts = {})
724
+ if @api_client.config.debugging
725
+ @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schemas ..."
726
+ end
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+ # resource path
735
+ local_var_path = "/api/v2/scim/schemas".sub('{format}','json')
736
+
737
+ # query parameters
738
+ query_params = {}
739
+ query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
740
+
741
+ # header parameters
742
+ header_params = {}
743
+
744
+ # HTTP header 'Accept' (if needed)
745
+ local_header_accept = ['application/json', 'application/scim+json']
746
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
747
+
748
+ # HTTP header 'Content-Type'
749
+ local_header_content_type = ['application/json', 'application/scim+json']
750
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
751
+
752
+ # form parameters
753
+ form_params = {}
754
+
755
+ # http body (model)
756
+ post_body = nil
757
+
758
+ auth_names = ['PureCloud OAuth']
759
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
760
+ :header_params => header_params,
761
+ :query_params => query_params,
762
+ :form_params => form_params,
763
+ :body => post_body,
764
+ :auth_names => auth_names,
765
+ :return_type => 'ScimConfigResourceTypesListResponse')
766
+ if @api_client.config.debugging
767
+ @api_client.config.logger.debug "API called: SCIMApi#get_scim_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
768
+ end
769
+ return data, status_code, headers
770
+ end
771
+
602
772
  # Get a service provider's configuration
603
773
  #
604
774
  # @param [Hash] opts the optional parameters
@@ -649,7 +819,7 @@ module PureCloud
649
819
  # http body (model)
650
820
  post_body = nil
651
821
 
652
- auth_names = []
822
+ auth_names = ['PureCloud OAuth']
653
823
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
654
824
  :header_params => header_params,
655
825
  :query_params => query_params,
@@ -667,8 +837,8 @@ module PureCloud
667
837
  #
668
838
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
669
839
  # @param [Hash] opts the optional parameters
670
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
671
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
840
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
841
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
672
842
  # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
673
843
  # @return [ScimV2User]
674
844
  def get_scim_user(user_id, opts = {})
@@ -680,8 +850,8 @@ module PureCloud
680
850
  #
681
851
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
682
852
  # @param [Hash] opts the optional parameters
683
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
684
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
853
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
854
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
685
855
  # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
686
856
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
687
857
  def get_scim_user_with_http_info(user_id, opts = {})
@@ -760,8 +930,8 @@ module PureCloud
760
930
  # @param [Hash] opts the optional parameters
761
931
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
762
932
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
763
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
764
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
933
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
934
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
765
935
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
766
936
  # @return [ScimUserListResponse]
767
937
  def get_scim_users(opts = {})
@@ -774,8 +944,8 @@ module PureCloud
774
944
  # @param [Hash] opts the optional parameters
775
945
  # @option opts [Integer] :start_index The 1-based index of the first query result.
776
946
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
777
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
778
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
947
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
948
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
779
949
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
780
950
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
781
951
  def get_scim_users_with_http_info(opts = {})
@@ -859,6 +1029,8 @@ module PureCloud
859
1029
  #
860
1030
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
861
1031
  # @param [Hash] opts the optional parameters
1032
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1033
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
862
1034
  # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
863
1035
  # @return [ScimV2Group]
864
1036
  def get_scim_v2_group(group_id, opts = {})
@@ -870,6 +1042,8 @@ module PureCloud
870
1042
  #
871
1043
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
872
1044
  # @param [Hash] opts the optional parameters
1045
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1046
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
873
1047
  # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
874
1048
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
875
1049
  def get_scim_v2_group_with_http_info(group_id, opts = {})
@@ -888,6 +1062,18 @@ module PureCloud
888
1062
 
889
1063
 
890
1064
 
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
891
1077
 
892
1078
 
893
1079
 
@@ -896,6 +1082,8 @@ module PureCloud
896
1082
 
897
1083
  # query parameters
898
1084
  query_params = {}
1085
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
1086
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
899
1087
 
900
1088
  # header parameters
901
1089
  header_params = {}
@@ -935,6 +1123,8 @@ module PureCloud
935
1123
  # @param [Hash] opts the optional parameters
936
1124
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
937
1125
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1126
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1127
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
938
1128
  # @return [ScimGroupListResponse]
939
1129
  def get_scim_v2_groups(filter, opts = {})
940
1130
  data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
@@ -947,6 +1137,8 @@ module PureCloud
947
1137
  # @param [Hash] opts the optional parameters
948
1138
  # @option opts [Integer] :start_index The 1-based index of the first query result.
949
1139
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1140
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1141
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
950
1142
  # @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
951
1143
  def get_scim_v2_groups_with_http_info(filter, opts = {})
952
1144
  if @api_client.config.debugging
@@ -964,6 +1156,18 @@ module PureCloud
964
1156
 
965
1157
 
966
1158
 
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
967
1171
 
968
1172
 
969
1173
 
@@ -981,6 +1185,8 @@ module PureCloud
981
1185
  query_params[:'filter'] = filter
982
1186
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
983
1187
  query_params[:'count'] = opts[:'count'] if opts[:'count']
1188
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
1189
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
984
1190
 
985
1191
  # header parameters
986
1192
  header_params = {}
@@ -1038,8 +1244,8 @@ module PureCloud
1038
1244
  fail ArgumentError, "Missing the required parameter 'resource_type' when calling SCIMApi.get_scim_v2_resourcetype" if resource_type.nil?
1039
1245
 
1040
1246
  # verify enum value
1041
- unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType'].include?(resource_type)
1042
- fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType"
1247
+ unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType', 'Schema'].include?(resource_type)
1248
+ fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType, Schema"
1043
1249
  end
1044
1250
 
1045
1251
 
@@ -1069,7 +1275,7 @@ module PureCloud
1069
1275
  # http body (model)
1070
1276
  post_body = nil
1071
1277
 
1072
- auth_names = []
1278
+ auth_names = ['PureCloud OAuth']
1073
1279
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1074
1280
  :header_params => header_params,
1075
1281
  :query_params => query_params,
@@ -1124,7 +1330,7 @@ module PureCloud
1124
1330
  # http body (model)
1125
1331
  post_body = nil
1126
1332
 
1127
- auth_names = []
1333
+ auth_names = ['PureCloud OAuth']
1128
1334
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1129
1335
  :header_params => header_params,
1130
1336
  :query_params => query_params,
@@ -1138,6 +1344,140 @@ module PureCloud
1138
1344
  return data, status_code, headers
1139
1345
  end
1140
1346
 
1347
+ # Get the SCIM schema by id
1348
+ #
1349
+ # @param schema_id The ID of a schema.
1350
+ # @param [Hash] opts the optional parameters
1351
+ # @return [ScimV2SchemaDefinition]
1352
+ def get_scim_v2_schema(schema_id, opts = {})
1353
+ data, _status_code, _headers = get_scim_v2_schema_with_http_info(schema_id, opts)
1354
+ return data
1355
+ end
1356
+
1357
+ # Get the SCIM schema by id
1358
+ #
1359
+ # @param schema_id The ID of a schema.
1360
+ # @param [Hash] opts the optional parameters
1361
+ # @return [Array<(ScimV2SchemaDefinition, Fixnum, Hash)>] ScimV2SchemaDefinition data, response status code and response headers
1362
+ def get_scim_v2_schema_with_http_info(schema_id, opts = {})
1363
+ if @api_client.config.debugging
1364
+ @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_schema ..."
1365
+ end
1366
+
1367
+
1368
+ # verify the required parameter 'schema_id' is set
1369
+ fail ArgumentError, "Missing the required parameter 'schema_id' when calling SCIMApi.get_scim_v2_schema" if schema_id.nil?
1370
+
1371
+ # verify enum value
1372
+ unless ['urn:ietf:params:scim:schemas:core:2.0:User', 'urn:ietf:params:scim:schemas:core:2.0:Group', 'urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig', 'urn:ietf:params:scim:schemas:core:2.0:ResourceType', 'urn:ietf:params:scim:schemas:core:2.0:Schema', 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User', 'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'].include?(schema_id)
1373
+ fail ArgumentError, "invalid value for 'schema_id', must be one of urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"
1374
+ end
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+ # resource path
1381
+ local_var_path = "/api/v2/scim/v2/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)
1382
+
1383
+ # query parameters
1384
+ query_params = {}
1385
+
1386
+ # header parameters
1387
+ header_params = {}
1388
+
1389
+ # HTTP header 'Accept' (if needed)
1390
+ local_header_accept = ['application/json', 'application/scim+json']
1391
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1392
+
1393
+ # HTTP header 'Content-Type'
1394
+ local_header_content_type = ['application/json', 'application/scim+json']
1395
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1396
+
1397
+ # form parameters
1398
+ form_params = {}
1399
+
1400
+ # http body (model)
1401
+ post_body = nil
1402
+
1403
+ auth_names = ['PureCloud OAuth']
1404
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1405
+ :header_params => header_params,
1406
+ :query_params => query_params,
1407
+ :form_params => form_params,
1408
+ :body => post_body,
1409
+ :auth_names => auth_names,
1410
+ :return_type => 'ScimV2SchemaDefinition')
1411
+ if @api_client.config.debugging
1412
+ @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1413
+ end
1414
+ return data, status_code, headers
1415
+ end
1416
+
1417
+ # Get the SCIM schemas
1418
+ #
1419
+ # @param [Hash] opts the optional parameters
1420
+ # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
1421
+ # @return [ScimV2SchemaListResponse]
1422
+ def get_scim_v2_schemas(opts = {})
1423
+ data, _status_code, _headers = get_scim_v2_schemas_with_http_info(opts)
1424
+ return data
1425
+ end
1426
+
1427
+ # Get the SCIM schemas
1428
+ #
1429
+ # @param [Hash] opts the optional parameters
1430
+ # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
1431
+ # @return [Array<(ScimV2SchemaListResponse, Fixnum, Hash)>] ScimV2SchemaListResponse data, response status code and response headers
1432
+ def get_scim_v2_schemas_with_http_info(opts = {})
1433
+ if @api_client.config.debugging
1434
+ @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_schemas ..."
1435
+ end
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ # resource path
1444
+ local_var_path = "/api/v2/scim/v2/schemas".sub('{format}','json')
1445
+
1446
+ # query parameters
1447
+ query_params = {}
1448
+ query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
1449
+
1450
+ # header parameters
1451
+ header_params = {}
1452
+
1453
+ # HTTP header 'Accept' (if needed)
1454
+ local_header_accept = ['application/json', 'application/scim+json']
1455
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1456
+
1457
+ # HTTP header 'Content-Type'
1458
+ local_header_content_type = ['application/json', 'application/scim+json']
1459
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1460
+
1461
+ # form parameters
1462
+ form_params = {}
1463
+
1464
+ # http body (model)
1465
+ post_body = nil
1466
+
1467
+ auth_names = ['PureCloud OAuth']
1468
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1469
+ :header_params => header_params,
1470
+ :query_params => query_params,
1471
+ :form_params => form_params,
1472
+ :body => post_body,
1473
+ :auth_names => auth_names,
1474
+ :return_type => 'ScimV2SchemaListResponse')
1475
+ if @api_client.config.debugging
1476
+ @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1477
+ end
1478
+ return data, status_code, headers
1479
+ end
1480
+
1141
1481
  # Get a service provider's configuration
1142
1482
  #
1143
1483
  # @param [Hash] opts the optional parameters
@@ -1188,7 +1528,7 @@ module PureCloud
1188
1528
  # http body (model)
1189
1529
  post_body = nil
1190
1530
 
1191
- auth_names = []
1531
+ auth_names = ['PureCloud OAuth']
1192
1532
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1193
1533
  :header_params => header_params,
1194
1534
  :query_params => query_params,
@@ -1206,8 +1546,8 @@ module PureCloud
1206
1546
  #
1207
1547
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1208
1548
  # @param [Hash] opts the optional parameters
1209
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1210
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
1549
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1550
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1211
1551
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1212
1552
  # @return [ScimV2User]
1213
1553
  def get_scim_v2_user(user_id, opts = {})
@@ -1219,8 +1559,8 @@ module PureCloud
1219
1559
  #
1220
1560
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1221
1561
  # @param [Hash] opts the optional parameters
1222
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1223
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
1562
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1563
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1224
1564
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1225
1565
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
1226
1566
  def get_scim_v2_user_with_http_info(user_id, opts = {})
@@ -1299,8 +1639,8 @@ module PureCloud
1299
1639
  # @param [Hash] opts the optional parameters
1300
1640
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1301
1641
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1302
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1303
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
1642
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1643
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1304
1644
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
1305
1645
  # @return [ScimUserListResponse]
1306
1646
  def get_scim_v2_users(opts = {})
@@ -1313,8 +1653,8 @@ module PureCloud
1313
1653
  # @param [Hash] opts the optional parameters
1314
1654
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1315
1655
  # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1316
- # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1317
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
1656
+ # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1657
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1318
1658
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
1319
1659
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
1320
1660
  def get_scim_v2_users_with_http_info(opts = {})