purecloudplatformclientv2 66.0.0 → 71.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 (573) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AgentActivityEntityListing.md +1 -1
  5. data/docs/AnalyticsSession.md +1 -0
  6. data/docs/ArchitectApi.md +21 -17
  7. data/docs/AttemptLimitsEntityListing.md +1 -1
  8. data/docs/AuthorizationApi.md +140 -0
  9. data/docs/AuthzDivisionEntityListing.md +1 -1
  10. data/docs/BuSearchAgentSchedulesRequest.md +15 -0
  11. data/docs/CalibrationEntityListing.md +1 -1
  12. data/docs/CallConversationEntityListing.md +1 -1
  13. data/docs/CallHistoryConversationEntityListing.md +1 -1
  14. data/docs/CallMediaParticipant.md +2 -0
  15. data/docs/CallableTimeSetEntityListing.md +1 -1
  16. data/docs/CallbackConversationEntityListing.md +1 -1
  17. data/docs/CallbackMediaParticipant.md +2 -0
  18. data/docs/CampaignDivisionViewListing.md +1 -1
  19. data/docs/CampaignEntityListing.md +1 -1
  20. data/docs/CampaignRuleEntityListing.md +1 -1
  21. data/docs/CampaignSequenceEntityListing.md +1 -1
  22. data/docs/CertificateAuthorityEntityListing.md +1 -1
  23. data/docs/ChatConversationEntityListing.md +1 -1
  24. data/docs/ChatMediaParticipant.md +2 -0
  25. data/docs/ClientAppEntityListing.md +1 -1
  26. data/docs/CobrowseConversationEntityListing.md +1 -1
  27. data/docs/CobrowseMediaParticipant.md +2 -0
  28. data/docs/CommandStatusEntityListing.md +1 -1
  29. data/docs/ConsumedResourcesEntityListing.md +1 -1
  30. data/docs/ConsumingResourcesEntityListing.md +1 -1
  31. data/docs/ContactCenterSettings.md +13 -0
  32. data/docs/ContactListDivisionViewListing.md +1 -1
  33. data/docs/ContactListEntityListing.md +1 -1
  34. data/docs/ContactListFilterEntityListing.md +1 -1
  35. data/docs/ContactListing.md +1 -1
  36. data/docs/ConversationAggregationQuery.md +1 -0
  37. data/docs/ConversationCallEventTopicCallConversation.md +1 -0
  38. data/docs/ConversationCallEventTopicCallMediaParticipant.md +2 -0
  39. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
  40. data/docs/ConversationChatEventTopicChatMediaParticipant.md +2 -0
  41. data/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
  42. data/docs/ConversationDeletionProtectionQuery.md +13 -0
  43. data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +2 -0
  44. data/docs/ConversationEntityListing.md +1 -1
  45. data/docs/ConversationEventTopicParticipant.md +2 -0
  46. data/docs/ConversationMessageEventTopicMessageMediaParticipant.md +2 -0
  47. data/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
  48. data/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +2 -0
  49. data/docs/ConversationVideoEventTopicVideoMediaParticipant.md +2 -0
  50. data/docs/ConversationsApi.md +198 -0
  51. data/docs/CreateManagementUnitApiRequest.md +1 -1
  52. data/docs/{CreateManagementUnitSettings.md → CreateManagementUnitSettingsRequest.md} +3 -3
  53. data/docs/CreateWorkPlan.md +1 -0
  54. data/docs/CreateWorkPlanShift.md +1 -0
  55. data/docs/CredentialInfoListing.md +1 -1
  56. data/docs/CredentialTypeListing.md +1 -1
  57. data/docs/DIDEntityListing.md +1 -1
  58. data/docs/DIDPoolEntityListing.md +1 -1
  59. data/docs/DataTableRowEntityListing.md +1 -1
  60. data/docs/DataTablesDomainEntityListing.md +1 -1
  61. data/docs/DependencyObjectEntityListing.md +1 -1
  62. data/docs/DependencyTypeEntityListing.md +1 -1
  63. data/docs/DialerEventEntityListing.md +1 -1
  64. data/docs/DialerResponsesetConfigChangeResponseSet.md +1 -0
  65. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  66. data/docs/DirectoryUserDevicesListing.md +1 -1
  67. data/docs/DncListDivisionViewListing.md +1 -1
  68. data/docs/DncListEntityListing.md +1 -1
  69. data/docs/DocumentAuditEntityListing.md +1 -1
  70. data/docs/DocumentEntityListing.md +1 -1
  71. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  72. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  73. data/docs/DomainEntityListing.md +1 -1
  74. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  75. data/docs/DomainEntityListingQueryResult.md +1 -1
  76. data/docs/DomainEntityListingSurveyForm.md +1 -1
  77. data/docs/DomainLogicalInterface.md +4 -0
  78. data/docs/EdgeEntityListing.md +1 -1
  79. data/docs/EdgeGroupEntityListing.md +1 -1
  80. data/docs/EdgeLineEntityListing.md +1 -1
  81. data/docs/EmailConversationEntityListing.md +1 -1
  82. data/docs/EmailMediaParticipant.md +2 -0
  83. data/docs/EmailMessageListing.md +1 -1
  84. data/docs/EmergencyGroupListing.md +1 -1
  85. data/docs/EncryptionKeyEntityListing.md +1 -1
  86. data/docs/EvaluationEntityListing.md +1 -1
  87. data/docs/EvaluationFormEntityListing.md +1 -1
  88. data/docs/EvaluatorActivityEntityListing.md +1 -1
  89. data/docs/ExtensionEntityListing.md +1 -1
  90. data/docs/ExtensionPoolEntityListing.md +1 -1
  91. data/docs/ExternalOrganizationListing.md +1 -1
  92. data/docs/FacebookIntegrationEntityListing.md +1 -1
  93. data/docs/FaxDocumentEntityListing.md +1 -1
  94. data/docs/FlowAggregationQuery.md +1 -0
  95. data/docs/FlowDivisionView.md +2 -0
  96. data/docs/FlowDivisionViewEntityListing.md +1 -1
  97. data/docs/FlowEntityListing.md +1 -1
  98. data/docs/FlowOutcomeListing.md +1 -1
  99. data/docs/FlowVersionEntityListing.md +1 -1
  100. data/docs/GDPRRequestEntityListing.md +1 -1
  101. data/docs/GDPRSubjectEntityListing.md +1 -1
  102. data/docs/GreetingListing.md +1 -1
  103. data/docs/GroupEntityListing.md +1 -1
  104. data/docs/GroupProfileEntityListing.md +1 -1
  105. data/docs/IVREntityListing.md +1 -1
  106. data/docs/InboundDomainEntityListing.md +1 -1
  107. data/docs/InboundRouteEntityListing.md +1 -1
  108. data/docs/IntegrationEntityListing.md +1 -1
  109. data/docs/IntegrationEventEntityListing.md +1 -1
  110. data/docs/IntegrationType.md +1 -0
  111. data/docs/IntegrationTypeEntityListing.md +1 -1
  112. data/docs/InteractionStatsAlertContainer.md +1 -1
  113. data/docs/InteractionStatsRuleContainer.md +1 -1
  114. data/docs/KeywordSetEntityListing.md +1 -1
  115. data/docs/LanguageEntityListing.md +1 -1
  116. data/docs/LexBotAliasEntityListing.md +1 -1
  117. data/docs/LexBotEntityListing.md +1 -1
  118. data/docs/LibraryEntityListing.md +1 -1
  119. data/docs/LineBaseEntityListing.md +1 -1
  120. data/docs/LineEntityListing.md +1 -1
  121. data/docs/LineIntegrationEntityListing.md +1 -1
  122. data/docs/LocationAddressVerificationDetails.md +16 -0
  123. data/docs/LocationCreateDefinition.md +20 -0
  124. data/docs/LocationDefinition.md +12 -9
  125. data/docs/LocationEntityListing.md +1 -1
  126. data/docs/LocationUpdateDefinition.md +20 -0
  127. data/docs/LocationsApi.md +6 -6
  128. data/docs/LogicalInterfaceEntityListing.md +1 -1
  129. data/docs/ManagementUnit.md +1 -1
  130. data/docs/ManagementUnitListing.md +1 -1
  131. data/docs/{UserExternalIdentifier.md → ManagementUnitReference.md} +3 -4
  132. data/docs/{ManagementUnitSettings.md → ManagementUnitSettingsRequest.md} +3 -3
  133. data/docs/ManagementUnitSettingsResponse.md +18 -0
  134. data/docs/MessageConversationEntityListing.md +1 -1
  135. data/docs/MessageEvaluation.md +16 -0
  136. data/docs/MessageMediaParticipant.md +2 -0
  137. data/docs/MessagingIntegrationEntityListing.md +1 -1
  138. data/docs/MessagingStickerEntityListing.md +1 -1
  139. data/docs/NoteListing.md +1 -1
  140. data/docs/NotificationsApi.md +1 -1
  141. data/docs/OAuthClientEntityListing.md +1 -1
  142. data/docs/OAuthProviderEntityListing.md +1 -1
  143. data/docs/OrganizationPresenceEntityListing.md +1 -1
  144. data/docs/OrganizationRoleEntityListing.md +1 -1
  145. data/docs/OrphanRecordingListing.md +1 -1
  146. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  147. data/docs/OutboundRouteEntityListing.md +1 -1
  148. data/docs/Participant.md +2 -0
  149. data/docs/ParticipantBasic.md +2 -0
  150. data/docs/PermissionCollectionEntityListing.md +1 -1
  151. data/docs/PhoneBaseEntityListing.md +1 -1
  152. data/docs/PhoneEntityListing.md +1 -1
  153. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  154. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  155. data/docs/PlanningPeriodSettings.md +14 -0
  156. data/docs/PolicyEntityListing.md +1 -1
  157. data/docs/PromptAssetEntityListing.md +1 -1
  158. data/docs/PromptEntityListing.md +1 -1
  159. data/docs/QualityApi.md +51 -23
  160. data/docs/QualityAuditPage.md +1 -1
  161. data/docs/QueueConversationCallEventTopicCallConversation.md +1 -0
  162. data/docs/QueueConversationCallEventTopicCallMediaParticipant.md +2 -0
  163. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
  164. data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +2 -0
  165. data/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
  166. data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +2 -0
  167. data/docs/QueueConversationEventTopicParticipant.md +2 -0
  168. data/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +2 -0
  169. data/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
  170. data/docs/QueueConversationSocialExpressionEventTopicParticipant.md +2 -0
  171. data/docs/QueueConversationVideoEventTopicParticipant.md +2 -0
  172. data/docs/QueueEntityListing.md +1 -1
  173. data/docs/QueueMemberEntityListing.md +1 -1
  174. data/docs/QueueUserEventTopicQueueMember.md +4 -4
  175. data/docs/QueueUserEventTopicUserReference.md +13 -0
  176. data/docs/RecipientListing.md +1 -1
  177. data/docs/Recording.md +1 -0
  178. data/docs/RecordingApi.md +164 -14
  179. data/docs/RecordingJobEntityListing.md +1 -1
  180. data/docs/RecordingJobsQuery.md +1 -1
  181. data/docs/RecordingMetadata.md +1 -0
  182. data/docs/RelationshipListing.md +1 -1
  183. data/docs/ReportMetaDataEntityListing.md +1 -1
  184. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  185. data/docs/ReportScheduleEntityListing.md +1 -1
  186. data/docs/ReportingExportJobListing.md +1 -1
  187. data/docs/ReportingExportJobRequest.md +2 -0
  188. data/docs/ReportingExportJobResponse.md +2 -0
  189. data/docs/ResponseEntityList.md +1 -1
  190. data/docs/ResponseEntityListing.md +1 -1
  191. data/docs/ResponseSetEntityListing.md +1 -1
  192. data/docs/RoleDivisionGrants.md +13 -0
  193. data/docs/RoleDivisionPair.md +14 -0
  194. data/docs/RoutingApi.md +250 -2
  195. data/docs/RuleSetEntityListing.md +1 -1
  196. data/docs/SCIMApi.md +302 -26
  197. data/docs/ScheduleEntityListing.md +1 -1
  198. data/docs/ScheduleGroupEntityListing.md +1 -1
  199. data/docs/{SchedulingSettings.md → SchedulingSettingsRequest.md} +2 -2
  200. data/docs/SchedulingSettingsResponse.md +15 -0
  201. data/docs/SchemaCategoryEntityListing.md +1 -1
  202. data/docs/SchemaReferenceEntityListing.md +1 -1
  203. data/docs/ScimConfigResourceType.md +1 -1
  204. data/docs/ScimConfigResourceTypeSchemaExtension.md +1 -1
  205. data/docs/ScimError.md +4 -4
  206. data/docs/ScimServiceProviderConfig.md +7 -7
  207. data/docs/ScimServiceProviderConfigAuthenticationScheme.md +1 -1
  208. data/docs/ScimV2CreateUser.md +1 -1
  209. data/docs/ScimV2Group.md +3 -2
  210. data/docs/ScimV2User.md +2 -2
  211. data/docs/ScreenRecordingSessionListing.md +1 -1
  212. data/docs/ScriptEntityListing.md +1 -1
  213. data/docs/SearchApi.md +3 -3
  214. data/docs/SecurityProfileEntityListing.md +1 -1
  215. data/docs/SelectedColumns.md +14 -0
  216. data/docs/SendAgentlessOutboundMessageRequest.md +16 -0
  217. data/docs/SendAgentlessOutboundMessageResponse.md +21 -0
  218. data/docs/ShareEntityListing.md +1 -1
  219. data/docs/ShiftTradeSettings.md +1 -0
  220. data/docs/SiteEntityListing.md +1 -1
  221. data/docs/SkillEntityListing.md +1 -1
  222. data/docs/SmsAddressEntityListing.md +1 -1
  223. data/docs/SmsPhoneNumber.md +1 -0
  224. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  225. data/docs/StationEntityListing.md +1 -1
  226. data/docs/StationsApi.md +1 -2
  227. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  228. data/docs/SubscriptionOverviewUsage.md +2 -0
  229. data/docs/SuggestApi.md +2 -2
  230. data/docs/SurveyAggregationQuery.md +1 -0
  231. data/docs/SurveyFormEntityListing.md +1 -1
  232. data/docs/SystemPromptAssetEntityListing.md +1 -1
  233. data/docs/SystemPromptEntityListing.md +1 -1
  234. data/docs/TagValueEntityListing.md +1 -1
  235. data/docs/TextMessageListing.md +1 -1
  236. data/docs/TimeOffRequestLookup.md +13 -0
  237. data/docs/TimeZoneEntityListing.md +1 -1
  238. data/docs/TranscriptionSettings.md +14 -0
  239. data/docs/TrunkBaseEntityListing.md +1 -1
  240. data/docs/TrunkEntityListing.md +1 -1
  241. data/docs/TrunkMetabaseEntityListing.md +1 -1
  242. data/docs/TrustEntityListing.md +1 -1
  243. data/docs/TrustUserEntityListing.md +1 -1
  244. data/docs/TrustorEntityListing.md +1 -1
  245. data/docs/TtsEngineEntityListing.md +1 -1
  246. data/docs/TtsVoiceEntityListing.md +1 -1
  247. data/docs/TwitterIntegrationEntityListing.md +1 -1
  248. data/docs/UpdateManagementUnitRequest.md +1 -1
  249. data/docs/UserActionCategoryEntityListing.md +1 -1
  250. data/docs/UserAggregationQuery.md +1 -0
  251. data/docs/UserDetailsQuery.md +1 -1
  252. data/docs/UserEntityListing.md +1 -1
  253. data/docs/UserLanguageEntityListing.md +1 -1
  254. data/docs/UserProfileEntityListing.md +1 -1
  255. data/docs/UserQueueEntityListing.md +1 -1
  256. data/docs/UserRecordingEntityListing.md +1 -1
  257. data/docs/UserSkillEntityListing.md +1 -1
  258. data/docs/UsersApi.md +101 -306
  259. data/docs/ValueWrapperPlanningPeriodSettings.md +13 -0
  260. data/docs/VoicemailMessageEntityListing.md +1 -1
  261. data/docs/WebChatMemberInfoEntityList.md +1 -1
  262. data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
  263. data/docs/WhatsAppIntegrationEntityListing.md +1 -1
  264. data/docs/WhatsAppIntegrationRequest.md +17 -0
  265. data/docs/WorkPlan.md +1 -0
  266. data/docs/WorkPlanListItemResponse.md +1 -0
  267. data/docs/WorkPlanReference.md +3 -1
  268. data/docs/WorkPlanShift.md +1 -0
  269. data/docs/WorkforceManagementApi.md +80 -9
  270. data/docs/WorkspaceEntityListing.md +1 -1
  271. data/docs/WorkspaceMemberEntityListing.md +1 -1
  272. data/docs/WrapupCodeEntityListing.md +1 -1
  273. data/lib/purecloudplatformclientv2.rb +23 -5
  274. data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
  275. data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
  276. data/lib/purecloudplatformclientv2/api/conversations_api.rb +195 -0
  277. data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
  278. data/lib/purecloudplatformclientv2/api/quality_api.rb +4 -4
  279. data/lib/purecloudplatformclientv2/api/recording_api.rb +138 -2
  280. data/lib/purecloudplatformclientv2/api/routing_api.rb +239 -9
  281. data/lib/purecloudplatformclientv2/api/scim_api.rb +364 -20
  282. data/lib/purecloudplatformclientv2/api/users_api.rb +127 -353
  283. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +81 -8
  284. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  285. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  286. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  287. data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
  288. data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
  289. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  290. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  291. data/lib/purecloudplatformclientv2/models/bu_search_agent_schedules_request.rb +266 -0
  292. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  293. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  294. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  295. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +53 -1
  296. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  297. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  298. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +53 -1
  299. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  300. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  301. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  302. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  303. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  304. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  305. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +53 -1
  306. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  307. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  308. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +53 -1
  309. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  310. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  312. data/lib/purecloudplatformclientv2/models/contact_center_settings.rb +202 -0
  313. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  314. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  315. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  316. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  317. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  318. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +44 -4
  319. data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +2 -2
  320. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -4
  321. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_media_participant.rb +51 -1
  322. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +51 -1
  323. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +51 -1
  324. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
  325. data/lib/purecloudplatformclientv2/models/conversation_deletion_protection_query.rb +209 -0
  326. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +51 -1
  327. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  328. data/lib/purecloudplatformclientv2/models/conversation_event_topic_participant.rb +51 -1
  329. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +51 -1
  330. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
  331. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_media_participant.rb +51 -1
  332. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_media_participant.rb +51 -1
  333. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
  334. data/lib/purecloudplatformclientv2/models/{create_management_unit_settings.rb → create_management_unit_settings_request.rb} +2 -2
  335. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +27 -1
  336. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +27 -1
  337. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  338. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  339. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  340. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  341. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  342. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  343. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  344. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  345. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  346. data/lib/purecloudplatformclientv2/models/dialer_responseset_config_change_response_set.rb +26 -1
  347. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
  348. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  349. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  350. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  351. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  352. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  353. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  354. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  355. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  356. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  357. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  358. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  359. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  360. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  361. data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +105 -1
  362. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  363. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  364. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  365. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  366. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +53 -1
  367. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  368. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  369. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  370. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +2 -2
  371. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  372. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  373. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
  375. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  376. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  377. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  378. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  379. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  380. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  381. data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
  382. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  383. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +44 -4
  384. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +55 -3
  385. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  386. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  387. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
  388. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  390. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  391. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  392. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  394. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  395. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  396. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  397. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  398. data/lib/purecloudplatformclientv2/models/integration_type.rb +29 -1
  399. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  400. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  402. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  403. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  404. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  405. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
  406. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
  407. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  408. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  409. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/location_address_verification_details.rb +294 -0
  412. data/lib/purecloudplatformclientv2/models/location_create_definition.rb +405 -0
  413. data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
  414. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +48 -63
  416. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  417. data/lib/purecloudplatformclientv2/models/management_unit.rb +1 -1
  418. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → management_unit_reference.rb} +10 -46
  420. data/lib/purecloudplatformclientv2/models/{management_unit_settings.rb → management_unit_settings_request.rb} +2 -2
  421. data/lib/purecloudplatformclientv2/models/management_unit_settings_response.rb +337 -0
  422. data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
  423. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  424. data/lib/purecloudplatformclientv2/models/message_evaluation.rb +277 -0
  425. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +53 -1
  426. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
  427. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  428. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  429. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  430. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  431. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  432. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  433. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  435. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/participant.rb +56 -4
  437. data/lib/purecloudplatformclientv2/models/participant_basic.rb +56 -4
  438. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  440. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  441. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  442. data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
  443. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  444. data/lib/purecloudplatformclientv2/models/planning_period_settings.rb +238 -0
  445. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  446. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  447. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  448. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  449. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_conversation.rb +29 -4
  450. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_media_participant.rb +51 -1
  451. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +51 -1
  452. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +51 -1
  453. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
  454. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +51 -1
  455. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_participant.rb +51 -1
  456. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +51 -1
  457. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
  458. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_participant.rb +51 -1
  459. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_participant.rb +51 -1
  460. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  461. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  462. data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +31 -31
  463. data/lib/purecloudplatformclientv2/models/queue_user_event_topic_user_reference.rb +201 -0
  464. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  465. data/lib/purecloudplatformclientv2/models/recording.rb +27 -1
  466. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
  467. data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
  468. data/lib/purecloudplatformclientv2/models/recording_metadata.rb +27 -1
  469. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  470. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  471. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  472. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  473. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +2 -2
  474. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  475. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +58 -4
  476. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +55 -1
  477. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  480. data/lib/purecloudplatformclientv2/models/role_division_grants.rb +209 -0
  481. data/lib/purecloudplatformclientv2/models/role_division_pair.rb +238 -0
  482. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  483. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  484. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  485. data/lib/purecloudplatformclientv2/models/{scheduling_settings.rb → scheduling_settings_request.rb} +1 -1
  486. data/lib/purecloudplatformclientv2/models/scheduling_settings_response.rb +255 -0
  487. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  488. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  489. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
  490. data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +2 -2
  491. data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +1 -1
  492. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  493. data/lib/purecloudplatformclientv2/models/scim_error.rb +5 -5
  494. data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +1 -1
  495. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +1 -1
  496. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
  497. data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +8 -8
  498. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +2 -2
  499. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +1 -1
  500. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +1 -1
  501. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +1 -1
  502. data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +1 -1
  503. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +2 -1
  504. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  505. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +34 -3
  506. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +1 -1
  507. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +1 -1
  508. data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +1 -1
  509. data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
  510. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +3 -2
  511. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  512. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  513. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  514. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  515. data/lib/purecloudplatformclientv2/models/selected_columns.rb +228 -0
  516. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +314 -0
  517. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +424 -0
  518. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  519. data/lib/purecloudplatformclientv2/models/shift_trade_settings.rb +27 -1
  520. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  521. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  522. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
  523. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +29 -1
  524. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  525. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  526. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  527. data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +56 -4
  528. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +44 -4
  529. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  530. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  531. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  532. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  533. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  534. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +357 -1
  535. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  536. data/lib/purecloudplatformclientv2/models/transcription_settings.rb +252 -0
  537. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  538. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  539. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  540. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  541. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  542. data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +2 -2
  543. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  544. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
  545. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
  546. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  547. data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +1 -1
  548. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  549. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +44 -4
  550. data/lib/purecloudplatformclientv2/models/user_details_query.rb +32 -31
  551. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  552. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  553. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  554. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  555. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  556. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  557. data/lib/purecloudplatformclientv2/models/value_wrapper_planning_period_settings.rb +203 -0
  558. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  559. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  560. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +1 -1
  561. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agent_data.rb +2 -2
  562. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
  563. data/lib/purecloudplatformclientv2/models/whats_app_integration_request.rb +321 -0
  564. data/lib/purecloudplatformclientv2/models/work_plan.rb +27 -1
  565. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +27 -1
  566. data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +57 -9
  567. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +27 -1
  568. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  569. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  570. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  571. data/lib/purecloudplatformclientv2/version.rb +1 -1
  572. metadata +48 -12
  573. data/docs/LocationCreateUpdateDefinition.md +0 -21
@@ -1842,7 +1842,6 @@ module PureCloud
1842
1842
  # @option opts [Integer] :page_number Page number (default to 1)
1843
1843
  # @option opts [String] :sort_by Sort by (default to name)
1844
1844
  # @option opts [String] :name Name
1845
- # @option opts [BOOLEAN] :active Active
1846
1845
  # @option opts [Array<String>] :id ID(s)
1847
1846
  # @option opts [Array<String>] :division_id Division ID(s)
1848
1847
  # @return [QueueEntityListing]
@@ -1858,7 +1857,6 @@ module PureCloud
1858
1857
  # @option opts [Integer] :page_number Page number
1859
1858
  # @option opts [String] :sort_by Sort by
1860
1859
  # @option opts [String] :name Name
1861
- # @option opts [BOOLEAN] :active Active
1862
1860
  # @option opts [Array<String>] :id ID(s)
1863
1861
  # @option opts [Array<String>] :division_id Division ID(s)
1864
1862
  # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers
@@ -1896,12 +1894,6 @@ module PureCloud
1896
1894
 
1897
1895
 
1898
1896
 
1899
-
1900
-
1901
-
1902
-
1903
-
1904
-
1905
1897
 
1906
1898
 
1907
1899
 
@@ -1918,7 +1910,6 @@ module PureCloud
1918
1910
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1919
1911
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1920
1912
  query_params[:'name'] = opts[:'name'] if opts[:'name']
1921
- query_params[:'active'] = opts[:'active'] if opts[:'active']
1922
1913
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1923
1914
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
1924
1915
 
@@ -2278,6 +2269,116 @@ module PureCloud
2278
2269
  return data, status_code, headers
2279
2270
  end
2280
2271
 
2272
+ # Get Contact Center Settings
2273
+ #
2274
+ # @param [Hash] opts the optional parameters
2275
+ # @return [ContactCenterSettings]
2276
+ def get_routing_settings_contactcenter(opts = {})
2277
+ data, _status_code, _headers = get_routing_settings_contactcenter_with_http_info(opts)
2278
+ return data
2279
+ end
2280
+
2281
+ # Get Contact Center Settings
2282
+ #
2283
+ # @param [Hash] opts the optional parameters
2284
+ # @return [Array<(ContactCenterSettings, Fixnum, Hash)>] ContactCenterSettings data, response status code and response headers
2285
+ def get_routing_settings_contactcenter_with_http_info(opts = {})
2286
+ if @api_client.config.debugging
2287
+ @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings_contactcenter ..."
2288
+ end
2289
+
2290
+ # resource path
2291
+ local_var_path = "/api/v2/routing/settings/contactcenter".sub('{format}','json')
2292
+
2293
+ # query parameters
2294
+ query_params = {}
2295
+
2296
+ # header parameters
2297
+ header_params = {}
2298
+
2299
+ # HTTP header 'Accept' (if needed)
2300
+ local_header_accept = ['application/json']
2301
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2302
+
2303
+ # HTTP header 'Content-Type'
2304
+ local_header_content_type = ['application/json']
2305
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2306
+
2307
+ # form parameters
2308
+ form_params = {}
2309
+
2310
+ # http body (model)
2311
+ post_body = nil
2312
+
2313
+ auth_names = ['PureCloud OAuth']
2314
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2315
+ :header_params => header_params,
2316
+ :query_params => query_params,
2317
+ :form_params => form_params,
2318
+ :body => post_body,
2319
+ :auth_names => auth_names,
2320
+ :return_type => 'ContactCenterSettings')
2321
+ if @api_client.config.debugging
2322
+ @api_client.config.logger.debug "API called: RoutingApi#get_routing_settings_contactcenter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2323
+ end
2324
+ return data, status_code, headers
2325
+ end
2326
+
2327
+ # Get Transcription Settings
2328
+ #
2329
+ # @param [Hash] opts the optional parameters
2330
+ # @return [TranscriptionSettings]
2331
+ def get_routing_settings_transcription(opts = {})
2332
+ data, _status_code, _headers = get_routing_settings_transcription_with_http_info(opts)
2333
+ return data
2334
+ end
2335
+
2336
+ # Get Transcription Settings
2337
+ #
2338
+ # @param [Hash] opts the optional parameters
2339
+ # @return [Array<(TranscriptionSettings, Fixnum, Hash)>] TranscriptionSettings data, response status code and response headers
2340
+ def get_routing_settings_transcription_with_http_info(opts = {})
2341
+ if @api_client.config.debugging
2342
+ @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings_transcription ..."
2343
+ end
2344
+
2345
+ # resource path
2346
+ local_var_path = "/api/v2/routing/settings/transcription".sub('{format}','json')
2347
+
2348
+ # query parameters
2349
+ query_params = {}
2350
+
2351
+ # header parameters
2352
+ header_params = {}
2353
+
2354
+ # HTTP header 'Accept' (if needed)
2355
+ local_header_accept = ['application/json']
2356
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2357
+
2358
+ # HTTP header 'Content-Type'
2359
+ local_header_content_type = ['application/json']
2360
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2361
+
2362
+ # form parameters
2363
+ form_params = {}
2364
+
2365
+ # http body (model)
2366
+ post_body = nil
2367
+
2368
+ auth_names = ['PureCloud OAuth']
2369
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2370
+ :header_params => header_params,
2371
+ :query_params => query_params,
2372
+ :form_params => form_params,
2373
+ :body => post_body,
2374
+ :auth_names => auth_names,
2375
+ :return_type => 'TranscriptionSettings')
2376
+ if @api_client.config.debugging
2377
+ @api_client.config.logger.debug "API called: RoutingApi#get_routing_settings_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2378
+ end
2379
+ return data, status_code, headers
2380
+ end
2381
+
2281
2382
  # Get Routing Skill
2282
2383
  #
2283
2384
  # @param skill_id Skill ID
@@ -3443,6 +3544,70 @@ module PureCloud
3443
3544
  return data, status_code, headers
3444
3545
  end
3445
3546
 
3547
+ # Update Contact Center Settings
3548
+ #
3549
+ # @param body Contact Center Settings
3550
+ # @param [Hash] opts the optional parameters
3551
+ # @return [nil]
3552
+ def patch_routing_settings_contactcenter(body, opts = {})
3553
+ patch_routing_settings_contactcenter_with_http_info(body, opts)
3554
+ return nil
3555
+ end
3556
+
3557
+ # Update Contact Center Settings
3558
+ #
3559
+ # @param body Contact Center Settings
3560
+ # @param [Hash] opts the optional parameters
3561
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3562
+ def patch_routing_settings_contactcenter_with_http_info(body, opts = {})
3563
+ if @api_client.config.debugging
3564
+ @api_client.config.logger.debug "Calling API: RoutingApi.patch_routing_settings_contactcenter ..."
3565
+ end
3566
+
3567
+
3568
+ # verify the required parameter 'body' is set
3569
+ fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_routing_settings_contactcenter" if body.nil?
3570
+
3571
+
3572
+
3573
+
3574
+
3575
+ # resource path
3576
+ local_var_path = "/api/v2/routing/settings/contactcenter".sub('{format}','json')
3577
+
3578
+ # query parameters
3579
+ query_params = {}
3580
+
3581
+ # header parameters
3582
+ header_params = {}
3583
+
3584
+ # HTTP header 'Accept' (if needed)
3585
+ local_header_accept = ['application/json']
3586
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3587
+
3588
+ # HTTP header 'Content-Type'
3589
+ local_header_content_type = ['application/json']
3590
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3591
+
3592
+ # form parameters
3593
+ form_params = {}
3594
+
3595
+ # http body (model)
3596
+ post_body = @api_client.object_to_http_body(body)
3597
+
3598
+ auth_names = ['PureCloud OAuth']
3599
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
3600
+ :header_params => header_params,
3601
+ :query_params => query_params,
3602
+ :form_params => form_params,
3603
+ :body => post_body,
3604
+ :auth_names => auth_names)
3605
+ if @api_client.config.debugging
3606
+ @api_client.config.logger.debug "API called: RoutingApi#patch_routing_settings_contactcenter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3607
+ end
3608
+ return data, status_code, headers
3609
+ end
3610
+
3446
3611
  # Update routing language proficiency or state.
3447
3612
  #
3448
3613
  # @param user_id User ID
@@ -4817,6 +4982,71 @@ module PureCloud
4817
4982
  return data, status_code, headers
4818
4983
  end
4819
4984
 
4985
+ # Update Transcription Settings
4986
+ #
4987
+ # @param body Organization Settings
4988
+ # @param [Hash] opts the optional parameters
4989
+ # @return [TranscriptionSettings]
4990
+ def put_routing_settings_transcription(body, opts = {})
4991
+ data, _status_code, _headers = put_routing_settings_transcription_with_http_info(body, opts)
4992
+ return data
4993
+ end
4994
+
4995
+ # Update Transcription Settings
4996
+ #
4997
+ # @param body Organization Settings
4998
+ # @param [Hash] opts the optional parameters
4999
+ # @return [Array<(TranscriptionSettings, Fixnum, Hash)>] TranscriptionSettings data, response status code and response headers
5000
+ def put_routing_settings_transcription_with_http_info(body, opts = {})
5001
+ if @api_client.config.debugging
5002
+ @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_settings_transcription ..."
5003
+ end
5004
+
5005
+
5006
+ # verify the required parameter 'body' is set
5007
+ fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_settings_transcription" if body.nil?
5008
+
5009
+
5010
+
5011
+
5012
+
5013
+ # resource path
5014
+ local_var_path = "/api/v2/routing/settings/transcription".sub('{format}','json')
5015
+
5016
+ # query parameters
5017
+ query_params = {}
5018
+
5019
+ # header parameters
5020
+ header_params = {}
5021
+
5022
+ # HTTP header 'Accept' (if needed)
5023
+ local_header_accept = ['application/json']
5024
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
5025
+
5026
+ # HTTP header 'Content-Type'
5027
+ local_header_content_type = ['application/json']
5028
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
5029
+
5030
+ # form parameters
5031
+ form_params = {}
5032
+
5033
+ # http body (model)
5034
+ post_body = @api_client.object_to_http_body(body)
5035
+
5036
+ auth_names = ['PureCloud OAuth']
5037
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
5038
+ :header_params => header_params,
5039
+ :query_params => query_params,
5040
+ :form_params => form_params,
5041
+ :body => post_body,
5042
+ :auth_names => auth_names,
5043
+ :return_type => 'TranscriptionSettings')
5044
+ if @api_client.config.debugging
5045
+ @api_client.config.logger.debug "API called: RoutingApi#put_routing_settings_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5046
+ end
5047
+ return data, status_code, headers
5048
+ end
5049
+
4820
5050
  # Update a phone number provisioned for SMS.
4821
5051
  #
4822
5052
  # @param address_id Address ID
@@ -24,6 +24,79 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Delete a group.
28
+ #
29
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
30
+ # @param [Hash] opts the optional parameters
31
+ # @option opts [String] :if_match The 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 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
32
+ # @return [nil]
33
+ def delete_scim_group(group_id, opts = {})
34
+ delete_scim_group_with_http_info(group_id, opts)
35
+ return nil
36
+ end
37
+
38
+ # Delete a group.
39
+ #
40
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [String] :if_match The 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 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
43
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
44
+ def delete_scim_group_with_http_info(group_id, opts = {})
45
+ if @api_client.config.debugging
46
+ @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_group ..."
47
+ end
48
+
49
+
50
+ # verify the required parameter 'group_id' is set
51
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.delete_scim_group" if group_id.nil?
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+ # resource path
64
+ local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
65
+
66
+ # query parameters
67
+ query_params = {}
68
+
69
+ # header parameters
70
+ header_params = {}
71
+
72
+ # HTTP header 'Accept' (if needed)
73
+ local_header_accept = ['application/json', 'application/scim+json']
74
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
75
+
76
+ # HTTP header 'Content-Type'
77
+ local_header_content_type = ['application/json', 'application/scim+json']
78
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
79
+ header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
80
+
81
+ # form parameters
82
+ form_params = {}
83
+
84
+ # http body (model)
85
+ post_body = nil
86
+
87
+ auth_names = ['PureCloud OAuth']
88
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names)
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug "API called: SCIMApi#delete_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
96
+ end
97
+ return data, status_code, headers
98
+ end
99
+
27
100
  # Delete a user
28
101
  #
29
102
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
@@ -98,6 +171,79 @@ module PureCloud
98
171
  return data, status_code, headers
99
172
  end
100
173
 
174
+ # Delete a group.
175
+ #
176
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
177
+ # @param [Hash] opts the optional parameters
178
+ # @option opts [String] :if_match The 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 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
179
+ # @return [nil]
180
+ def delete_scim_v2_group(group_id, opts = {})
181
+ delete_scim_v2_group_with_http_info(group_id, opts)
182
+ return nil
183
+ end
184
+
185
+ # Delete a group.
186
+ #
187
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
188
+ # @param [Hash] opts the optional parameters
189
+ # @option opts [String] :if_match The 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 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
190
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
191
+ def delete_scim_v2_group_with_http_info(group_id, opts = {})
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_v2_group ..."
194
+ end
195
+
196
+
197
+ # verify the required parameter 'group_id' is set
198
+ fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.delete_scim_v2_group" if group_id.nil?
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ # resource path
211
+ local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
212
+
213
+ # query parameters
214
+ query_params = {}
215
+
216
+ # header parameters
217
+ header_params = {}
218
+
219
+ # HTTP header 'Accept' (if needed)
220
+ local_header_accept = ['application/json', 'application/scim+json']
221
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
222
+
223
+ # HTTP header 'Content-Type'
224
+ local_header_content_type = ['application/json', 'application/scim+json']
225
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
226
+ header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
227
+
228
+ # form parameters
229
+ form_params = {}
230
+
231
+ # http body (model)
232
+ post_body = nil
233
+
234
+ auth_names = ['PureCloud OAuth']
235
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
236
+ :header_params => header_params,
237
+ :query_params => query_params,
238
+ :form_params => form_params,
239
+ :body => post_body,
240
+ :auth_names => auth_names)
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "API called: SCIMApi#delete_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
243
+ end
244
+ return data, status_code, headers
245
+ end
246
+
101
247
  # Delete a user
102
248
  #
103
249
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
@@ -521,6 +667,8 @@ module PureCloud
521
667
  #
522
668
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
523
669
  # @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.
524
672
  # @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.
525
673
  # @return [ScimV2User]
526
674
  def get_scim_user(user_id, opts = {})
@@ -532,6 +680,8 @@ module PureCloud
532
680
  #
533
681
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
534
682
  # @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.
535
685
  # @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.
536
686
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
537
687
  def get_scim_user_with_http_info(user_id, opts = {})
@@ -550,6 +700,18 @@ module PureCloud
550
700
 
551
701
 
552
702
 
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
553
715
 
554
716
 
555
717
 
@@ -558,6 +720,8 @@ module PureCloud
558
720
 
559
721
  # query parameters
560
722
  query_params = {}
723
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
724
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
561
725
 
562
726
  # header parameters
563
727
  header_params = {}
@@ -592,32 +756,46 @@ module PureCloud
592
756
  end
593
757
 
594
758
  # Get a list of users
595
- #
596
- # @param filter Filters results.
759
+ # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
597
760
  # @param [Hash] opts the optional parameters
598
761
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
599
762
  # @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.
765
+ # @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;.
600
766
  # @return [ScimUserListResponse]
601
- def get_scim_users(filter, opts = {})
602
- data, _status_code, _headers = get_scim_users_with_http_info(filter, opts)
767
+ def get_scim_users(opts = {})
768
+ data, _status_code, _headers = get_scim_users_with_http_info(opts)
603
769
  return data
604
770
  end
605
771
 
606
772
  # Get a list of users
607
- #
608
- # @param filter Filters results.
773
+ # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
609
774
  # @param [Hash] opts the optional parameters
610
775
  # @option opts [Integer] :start_index The 1-based index of the first query result.
611
776
  # @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.
779
+ # @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;.
612
780
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
613
- def get_scim_users_with_http_info(filter, opts = {})
781
+ def get_scim_users_with_http_info(opts = {})
614
782
  if @api_client.config.debugging
615
783
  @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_users ..."
616
784
  end
617
785
 
618
786
 
619
- # verify the required parameter 'filter' is set
620
- fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_users" if filter.nil?
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
621
799
 
622
800
 
623
801
 
@@ -640,9 +818,11 @@ module PureCloud
640
818
 
641
819
  # query parameters
642
820
  query_params = {}
643
- query_params[:'filter'] = filter
644
821
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
645
822
  query_params[:'count'] = opts[:'count'] if opts[:'count']
823
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
824
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
825
+ query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
646
826
 
647
827
  # header parameters
648
828
  header_params = {}
@@ -1026,6 +1206,8 @@ module PureCloud
1026
1206
  #
1027
1207
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1028
1208
  # @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.
1029
1211
  # @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.
1030
1212
  # @return [ScimV2User]
1031
1213
  def get_scim_v2_user(user_id, opts = {})
@@ -1037,6 +1219,8 @@ module PureCloud
1037
1219
  #
1038
1220
  # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1039
1221
  # @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.
1040
1224
  # @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.
1041
1225
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
1042
1226
  def get_scim_v2_user_with_http_info(user_id, opts = {})
@@ -1055,6 +1239,18 @@ module PureCloud
1055
1239
 
1056
1240
 
1057
1241
 
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1058
1254
 
1059
1255
 
1060
1256
 
@@ -1063,6 +1259,8 @@ module PureCloud
1063
1259
 
1064
1260
  # query parameters
1065
1261
  query_params = {}
1262
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
1263
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
1066
1264
 
1067
1265
  # header parameters
1068
1266
  header_params = {}
@@ -1097,32 +1295,46 @@ module PureCloud
1097
1295
  end
1098
1296
 
1099
1297
  # Get a list of users
1100
- #
1101
- # @param filter Filters results.
1298
+ # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
1102
1299
  # @param [Hash] opts the optional parameters
1103
1300
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1104
1301
  # @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.
1304
+ # @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;.
1105
1305
  # @return [ScimUserListResponse]
1106
- def get_scim_v2_users(filter, opts = {})
1107
- data, _status_code, _headers = get_scim_v2_users_with_http_info(filter, opts)
1306
+ def get_scim_v2_users(opts = {})
1307
+ data, _status_code, _headers = get_scim_v2_users_with_http_info(opts)
1108
1308
  return data
1109
1309
  end
1110
1310
 
1111
1311
  # Get a list of users
1112
- #
1113
- # @param filter Filters results.
1312
+ # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
1114
1313
  # @param [Hash] opts the optional parameters
1115
1314
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1116
1315
  # @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.
1318
+ # @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;.
1117
1319
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
1118
- def get_scim_v2_users_with_http_info(filter, opts = {})
1320
+ def get_scim_v2_users_with_http_info(opts = {})
1119
1321
  if @api_client.config.debugging
1120
1322
  @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_users ..."
1121
1323
  end
1122
1324
 
1123
1325
 
1124
- # verify the required parameter 'filter' is set
1125
- fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_v2_users" if filter.nil?
1326
+
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1126
1338
 
1127
1339
 
1128
1340
 
@@ -1145,9 +1357,11 @@ module PureCloud
1145
1357
 
1146
1358
  # query parameters
1147
1359
  query_params = {}
1148
- query_params[:'filter'] = filter
1149
1360
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
1150
1361
  query_params[:'count'] = opts[:'count'] if opts[:'count']
1362
+ query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
1363
+ query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
1364
+ query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
1151
1365
 
1152
1366
  # header parameters
1153
1367
  header_params = {}
@@ -1516,6 +1730,71 @@ module PureCloud
1516
1730
  return data, status_code, headers
1517
1731
  end
1518
1732
 
1733
+ # The information used to create a group.
1734
+ # PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
1735
+ # @param body The information used to create a group.
1736
+ # @param [Hash] opts the optional parameters
1737
+ # @return [ScimV2Group]
1738
+ def post_scim_groups(body, opts = {})
1739
+ data, _status_code, _headers = post_scim_groups_with_http_info(body, opts)
1740
+ return data
1741
+ end
1742
+
1743
+ # The information used to create a group.
1744
+ # PureCloud group will be created as \&quot;Official\&quot; group with visibility set \&quot;Public\&quot;, and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
1745
+ # @param body The information used to create a group.
1746
+ # @param [Hash] opts the optional parameters
1747
+ # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1748
+ def post_scim_groups_with_http_info(body, opts = {})
1749
+ if @api_client.config.debugging
1750
+ @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_groups ..."
1751
+ end
1752
+
1753
+
1754
+ # verify the required parameter 'body' is set
1755
+ fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_groups" if body.nil?
1756
+
1757
+
1758
+
1759
+
1760
+
1761
+ # resource path
1762
+ local_var_path = "/api/v2/scim/groups".sub('{format}','json')
1763
+
1764
+ # query parameters
1765
+ query_params = {}
1766
+
1767
+ # header parameters
1768
+ header_params = {}
1769
+
1770
+ # HTTP header 'Accept' (if needed)
1771
+ local_header_accept = ['application/json', 'application/scim+json']
1772
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1773
+
1774
+ # HTTP header 'Content-Type'
1775
+ local_header_content_type = ['application/json', 'application/scim+json']
1776
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1777
+
1778
+ # form parameters
1779
+ form_params = {}
1780
+
1781
+ # http body (model)
1782
+ post_body = @api_client.object_to_http_body(body)
1783
+
1784
+ auth_names = ['PureCloud OAuth']
1785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1786
+ :header_params => header_params,
1787
+ :query_params => query_params,
1788
+ :form_params => form_params,
1789
+ :body => post_body,
1790
+ :auth_names => auth_names,
1791
+ :return_type => 'ScimV2Group')
1792
+ if @api_client.config.debugging
1793
+ @api_client.config.logger.debug "API called: SCIMApi#post_scim_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1794
+ end
1795
+ return data, status_code, headers
1796
+ end
1797
+
1519
1798
  # Create a user
1520
1799
  #
1521
1800
  # @param body The information used to create a user.
@@ -1581,6 +1860,71 @@ module PureCloud
1581
1860
  return data, status_code, headers
1582
1861
  end
1583
1862
 
1863
+ # The information used to create a group.
1864
+ # PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
1865
+ # @param body The information used to create a group.
1866
+ # @param [Hash] opts the optional parameters
1867
+ # @return [ScimV2Group]
1868
+ def post_scim_v2_groups(body, opts = {})
1869
+ data, _status_code, _headers = post_scim_v2_groups_with_http_info(body, opts)
1870
+ return data
1871
+ end
1872
+
1873
+ # The information used to create a group.
1874
+ # PureCloud group will be created as \&quot;Official\&quot; group with visibility set \&quot;Public\&quot;, and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
1875
+ # @param body The information used to create a group.
1876
+ # @param [Hash] opts the optional parameters
1877
+ # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1878
+ def post_scim_v2_groups_with_http_info(body, opts = {})
1879
+ if @api_client.config.debugging
1880
+ @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_v2_groups ..."
1881
+ end
1882
+
1883
+
1884
+ # verify the required parameter 'body' is set
1885
+ fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_v2_groups" if body.nil?
1886
+
1887
+
1888
+
1889
+
1890
+
1891
+ # resource path
1892
+ local_var_path = "/api/v2/scim/v2/groups".sub('{format}','json')
1893
+
1894
+ # query parameters
1895
+ query_params = {}
1896
+
1897
+ # header parameters
1898
+ header_params = {}
1899
+
1900
+ # HTTP header 'Accept' (if needed)
1901
+ local_header_accept = ['application/json', 'application/scim+json']
1902
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1903
+
1904
+ # HTTP header 'Content-Type'
1905
+ local_header_content_type = ['application/json', 'application/scim+json']
1906
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1907
+
1908
+ # form parameters
1909
+ form_params = {}
1910
+
1911
+ # http body (model)
1912
+ post_body = @api_client.object_to_http_body(body)
1913
+
1914
+ auth_names = ['PureCloud OAuth']
1915
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1916
+ :header_params => header_params,
1917
+ :query_params => query_params,
1918
+ :form_params => form_params,
1919
+ :body => post_body,
1920
+ :auth_names => auth_names,
1921
+ :return_type => 'ScimV2Group')
1922
+ if @api_client.config.debugging
1923
+ @api_client.config.logger.debug "API called: SCIMApi#post_scim_v2_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1924
+ end
1925
+ return data, status_code, headers
1926
+ end
1927
+
1584
1928
  # Create a user
1585
1929
  #
1586
1930
  # @param body The information used to create a user.