purecloudplatformclientv2 58.0.1 → 59.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 (450) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/{Skill.md → AddressableEntityRef.md} +2 -2
  5. data/docs/Agent.md +1 -2
  6. data/docs/AgentActivityEntityListing.md +1 -1
  7. data/docs/ArchitectApi.md +298 -14
  8. data/docs/AsyncConversationQuery.md +21 -0
  9. data/docs/AttemptLimitsEntityListing.md +1 -1
  10. data/docs/AuthzDivisionEntityListing.md +1 -1
  11. data/docs/CalibrationEntityListing.md +1 -1
  12. data/docs/CallConversationEntityListing.md +1 -1
  13. data/docs/CallHistoryConversation.md +1 -0
  14. data/docs/CallHistoryConversationEntityListing.md +1 -1
  15. data/docs/CallHistoryParticipant.md +1 -0
  16. data/docs/CallableTimeSetEntityListing.md +1 -1
  17. data/docs/CallbackConversationEntityListing.md +1 -1
  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/ClientAppEntityListing.md +1 -1
  25. data/docs/CobrowseConversationEntityListing.md +1 -1
  26. data/docs/CommandStatusEntityListing.md +1 -1
  27. data/docs/ConsumedResourcesEntityListing.md +1 -1
  28. data/docs/ConsumingResourcesEntityListing.md +1 -1
  29. data/docs/ContactListDivisionViewListing.md +1 -1
  30. data/docs/ContactListEntityListing.md +1 -1
  31. data/docs/ContactListFilterEntityListing.md +1 -1
  32. data/docs/ContactListing.md +1 -1
  33. data/docs/Conversation.md +1 -0
  34. data/docs/ConversationBasic.md +1 -0
  35. data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
  36. data/docs/ConversationEntityListing.md +1 -1
  37. data/docs/ConversationEventTopicChat.md +1 -0
  38. data/docs/ConversationProperties.md +1 -0
  39. data/docs/ConversationRoutingData.md +3 -3
  40. data/docs/CreateManagementUnitApiRequest.md +1 -1
  41. data/docs/CreateUser.md +1 -1
  42. data/docs/CredentialInfoListing.md +1 -1
  43. data/docs/CredentialTypeListing.md +1 -1
  44. data/docs/DIDEntityListing.md +1 -1
  45. data/docs/DIDPoolEntityListing.md +1 -1
  46. data/docs/DataSchema.md +4 -5
  47. data/docs/DataTableRowEntityListing.md +1 -1
  48. data/docs/DataTablesDomainEntityListing.md +1 -1
  49. data/docs/DependencyObjectEntityListing.md +1 -1
  50. data/docs/DependencyTypeEntityListing.md +1 -1
  51. data/docs/DialerEventEntityListing.md +1 -1
  52. data/docs/DialogflowAgent.md +18 -0
  53. data/docs/DialogflowAgentSummary.md +17 -0
  54. data/docs/DialogflowAgentSummaryEntityListing.md +22 -0
  55. data/docs/DialogflowIntent.md +14 -0
  56. data/docs/DialogflowParameter.md +14 -0
  57. data/docs/DialogflowProject.md +14 -0
  58. data/docs/DirectoryUserDevicesListing.md +1 -1
  59. data/docs/DncListDivisionViewListing.md +1 -1
  60. data/docs/DncListEntityListing.md +1 -1
  61. data/docs/DocumentAuditEntityListing.md +1 -1
  62. data/docs/DocumentEntityListing.md +1 -1
  63. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  64. data/docs/DomainEntityListing.md +1 -1
  65. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  66. data/docs/DomainEntityListingQueryResult.md +1 -1
  67. data/docs/DomainEntityListingSurveyForm.md +1 -1
  68. data/docs/EdgeEntityListing.md +1 -1
  69. data/docs/EdgeGroupEntityListing.md +1 -1
  70. data/docs/EdgeLineEntityListing.md +1 -1
  71. data/docs/EmailConversationEntityListing.md +1 -1
  72. data/docs/EmailMediaParticipant.md +1 -0
  73. data/docs/EmailMessage.md +1 -0
  74. data/docs/EmailMessageListing.md +1 -1
  75. data/docs/EmergencyGroupListing.md +1 -1
  76. data/docs/EncryptionKeyEntityListing.md +1 -1
  77. data/docs/EvaluationEntityListing.md +1 -1
  78. data/docs/EvaluationFormEntityListing.md +1 -1
  79. data/docs/EvaluatorActivityEntityListing.md +1 -1
  80. data/docs/ExecuteRecordingJobsQuery.md +13 -0
  81. data/docs/ExtensionEntityListing.md +1 -1
  82. data/docs/ExtensionPoolEntityListing.md +1 -1
  83. data/docs/ExternalOrganizationListing.md +1 -1
  84. data/docs/FacebookIntegrationEntityListing.md +1 -1
  85. data/docs/FaxDocumentEntityListing.md +1 -1
  86. data/docs/FlowDivisionViewEntityListing.md +1 -1
  87. data/docs/FlowEntityListing.md +1 -1
  88. data/docs/FlowOutcome.md +17 -0
  89. data/docs/FlowOutcomeListing.md +22 -0
  90. data/docs/FlowVersionEntityListing.md +1 -1
  91. data/docs/GDPRRequestEntityListing.md +1 -1
  92. data/docs/GDPRSubjectEntityListing.md +1 -1
  93. data/docs/GreetingListing.md +1 -1
  94. data/docs/GroupEntityListing.md +1 -1
  95. data/docs/GroupProfileEntityListing.md +1 -1
  96. data/docs/IVREntityListing.md +1 -1
  97. data/docs/InboundDomainEntityListing.md +1 -1
  98. data/docs/InboundRouteEntityListing.md +1 -1
  99. data/docs/IntegrationEntityListing.md +1 -1
  100. data/docs/IntegrationEventEntityListing.md +1 -1
  101. data/docs/IntegrationTypeEntityListing.md +1 -1
  102. data/docs/IntegrationsApi.md +762 -0
  103. data/docs/InteractionStatsAlertContainer.md +1 -1
  104. data/docs/InteractionStatsRuleContainer.md +1 -1
  105. data/docs/KeywordSetEntityListing.md +1 -1
  106. data/docs/LanguageEntityListing.md +1 -1
  107. data/docs/LanguageOverride.md +15 -0
  108. data/docs/LexBot.md +16 -0
  109. data/docs/LexBotAlias.md +21 -0
  110. data/docs/LexBotAliasEntityListing.md +22 -0
  111. data/docs/LexBotEntityListing.md +22 -0
  112. data/docs/LexIntent.md +16 -0
  113. data/docs/LexSlot.md +16 -0
  114. data/docs/LibraryEntityListing.md +1 -1
  115. data/docs/LineBaseEntityListing.md +1 -1
  116. data/docs/LineEntityListing.md +1 -1
  117. data/docs/LineIntegrationEntityListing.md +1 -1
  118. data/docs/LocationDefinition.md +2 -0
  119. data/docs/LocationEntityListing.md +1 -1
  120. data/docs/LocationImage.md +14 -0
  121. data/docs/LocationsApi.md +6 -2
  122. data/docs/LogicalInterfaceEntityListing.md +1 -1
  123. data/docs/ManagementUnit.md +5 -6
  124. data/docs/ManagementUnitListing.md +1 -1
  125. data/docs/MessageConversationEntityListing.md +1 -1
  126. data/docs/MessagingApi.md +1211 -134
  127. data/docs/MessagingIntegration.md +23 -0
  128. data/docs/MessagingIntegrationEntityListing.md +22 -0
  129. data/docs/MessagingStickerEntityListing.md +1 -1
  130. data/docs/MoveManagementUnitRequest.md +13 -0
  131. data/docs/MoveManagementUnitResponse.md +14 -0
  132. data/docs/NoteListing.md +1 -1
  133. data/docs/OAuthClientEntityListing.md +1 -1
  134. data/docs/OAuthProviderEntityListing.md +1 -1
  135. data/docs/OrganizationPresenceEntityListing.md +1 -1
  136. data/docs/OrganizationRoleEntityListing.md +1 -1
  137. data/docs/OrphanRecordingListing.md +1 -1
  138. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  139. data/docs/OutboundRouteEntityListing.md +1 -1
  140. data/docs/PermissionCollectionEntityListing.md +1 -1
  141. data/docs/PhoneBaseEntityListing.md +1 -1
  142. data/docs/PhoneEntityListing.md +1 -1
  143. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  144. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  145. data/docs/PolicyEntityListing.md +1 -1
  146. data/docs/PromptAssetEntityListing.md +1 -1
  147. data/docs/PromptEntityListing.md +1 -1
  148. data/docs/QualityAudit.md +1 -0
  149. data/docs/QualityAuditPage.md +1 -1
  150. data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
  151. data/docs/QueueConversationEventTopicChat.md +1 -0
  152. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  153. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  154. data/docs/QueueEntityListing.md +1 -1
  155. data/docs/QueueMemberEntityListing.md +1 -1
  156. data/docs/RecipientListing.md +1 -1
  157. data/docs/RecordingApi.md +335 -0
  158. data/docs/RecordingJob.md +23 -0
  159. data/docs/RecordingJobEntityListing.md +22 -0
  160. data/docs/RecordingJobsQuery.md +15 -0
  161. data/docs/RelationshipListing.md +1 -1
  162. data/docs/ReportMetaDataEntityListing.md +1 -1
  163. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  164. data/docs/ReportScheduleEntityListing.md +1 -1
  165. data/docs/ReportingExportJobListing.md +1 -1
  166. data/docs/ResponseEntityList.md +1 -1
  167. data/docs/ResponseEntityListing.md +1 -1
  168. data/docs/ResponseSetEntityListing.md +1 -1
  169. data/docs/RoutingApi.md +1 -1
  170. data/docs/RuleSetEntityListing.md +1 -1
  171. data/docs/SCIMApi.md +145 -145
  172. data/docs/ScheduleEntityListing.md +1 -1
  173. data/docs/ScheduleGroupEntityListing.md +1 -1
  174. data/docs/SchemaCategoryEntityListing.md +1 -1
  175. data/docs/SchemaReferenceEntityListing.md +1 -1
  176. data/docs/ScoredAgent.md +1 -1
  177. data/docs/ScreenRecordingSessionListing.md +1 -1
  178. data/docs/ScriptEntityListing.md +1 -1
  179. data/docs/SecurityProfileEntityListing.md +1 -1
  180. data/docs/ShareEntityListing.md +1 -1
  181. data/docs/SiteEntityListing.md +1 -1
  182. data/docs/SkillEntityListing.md +1 -1
  183. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  184. data/docs/StationEntityListing.md +1 -1
  185. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  186. data/docs/SubscriptionOverviewUsage.md +1 -0
  187. data/docs/SurveyFormEntityListing.md +1 -1
  188. data/docs/SystemPromptAssetEntityListing.md +1 -1
  189. data/docs/SystemPromptEntityListing.md +1 -1
  190. data/docs/TagValueEntityListing.md +1 -1
  191. data/docs/TextMessageListing.md +1 -1
  192. data/docs/TimeZoneEntityListing.md +1 -1
  193. data/docs/TrunkBaseEntityListing.md +1 -1
  194. data/docs/TrunkEntityListing.md +1 -1
  195. data/docs/TrunkMetabaseEntityListing.md +1 -1
  196. data/docs/TrustEntityListing.md +1 -1
  197. data/docs/TrustUserEntityListing.md +1 -1
  198. data/docs/TrustorEntityListing.md +1 -1
  199. data/docs/TtsEngineEntity.md +20 -0
  200. data/docs/TtsEngineEntityListing.md +22 -0
  201. data/docs/TtsSettings.md +14 -0
  202. data/docs/TtsVoiceEntity.md +19 -0
  203. data/docs/TtsVoiceEntityListing.md +22 -0
  204. data/docs/TwitterIntegrationEntityListing.md +1 -1
  205. data/docs/UpdateManagementUnitRequest.md +15 -0
  206. data/docs/UserActionCategoryEntityListing.md +1 -1
  207. data/docs/UserEntityListing.md +1 -1
  208. data/docs/UserLanguageEntityListing.md +1 -1
  209. data/docs/UserProfileEntityListing.md +1 -1
  210. data/docs/UserQueueEntityListing.md +1 -1
  211. data/docs/UserRecordingEntityListing.md +1 -1
  212. data/docs/UserSkillEntityListing.md +1 -1
  213. data/docs/VoicemailMessageEntityListing.md +1 -1
  214. data/docs/WebChatMemberInfoEntityList.md +1 -1
  215. data/docs/WfmMoveManagementUnitTopicBusinessUnit.md +13 -0
  216. data/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +14 -0
  217. data/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +18 -0
  218. data/docs/WfmUserNotificationTopicWfmUserNotification.md +1 -0
  219. data/docs/WorkforceManagementApi.md +158 -18
  220. data/docs/WorkspaceEntityListing.md +1 -1
  221. data/docs/WorkspaceMemberEntityListing.md +1 -1
  222. data/docs/WrapupCodeEntityListing.md +1 -1
  223. data/lib/purecloudplatformclientv2.rb +35 -1
  224. data/lib/purecloudplatformclientv2/api/architect_api.rb +334 -6
  225. data/lib/purecloudplatformclientv2/api/integrations_api.rb +851 -0
  226. data/lib/purecloudplatformclientv2/api/locations_api.rb +9 -0
  227. data/lib/purecloudplatformclientv2/api/messaging_api.rb +1111 -6
  228. data/lib/purecloudplatformclientv2/api/recording_api.rb +342 -0
  229. data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
  230. data/lib/purecloudplatformclientv2/api/scim_api.rb +124 -124
  231. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +163 -21
  232. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  233. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  234. data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb} +1 -1
  235. data/lib/purecloudplatformclientv2/models/agent.rb +8 -32
  236. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  237. data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +448 -0
  238. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  239. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  240. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  241. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  242. data/lib/purecloudplatformclientv2/models/call_history_conversation.rb +27 -1
  243. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  244. data/lib/purecloudplatformclientv2/models/call_history_participant.rb +30 -4
  245. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  246. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  247. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  248. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  249. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  250. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  251. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  252. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  253. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  254. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  256. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  258. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  259. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  260. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  261. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  262. data/lib/purecloudplatformclientv2/models/conversation.rb +29 -1
  263. data/lib/purecloudplatformclientv2/models/conversation_basic.rb +29 -1
  264. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
  265. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  266. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  267. data/lib/purecloudplatformclientv2/models/conversation_properties.rb +27 -1
  268. data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +3 -3
  269. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
  270. data/lib/purecloudplatformclientv2/models/create_user.rb +5 -0
  271. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  272. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  273. data/lib/purecloudplatformclientv2/models/data_schema.rb +5 -31
  274. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  275. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  276. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  277. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  278. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  279. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  280. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  281. data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +335 -0
  282. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary.rb +305 -0
  283. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +428 -0
  284. data/lib/purecloudplatformclientv2/models/dialogflow_intent.rb +240 -0
  285. data/lib/purecloudplatformclientv2/models/dialogflow_parameter.rb +238 -0
  286. data/lib/purecloudplatformclientv2/models/dialogflow_project.rb +226 -0
  287. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  288. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  289. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  290. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  291. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  292. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  293. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  294. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  295. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  296. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  297. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  298. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  299. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  300. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  301. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  302. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  303. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +30 -4
  304. data/lib/purecloudplatformclientv2/models/email_message.rb +27 -1
  305. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  306. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  307. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  308. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  309. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  310. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/execute_recording_jobs_query.rb +221 -0
  312. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  313. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  314. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  315. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  316. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  317. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  318. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  319. data/lib/purecloudplatformclientv2/models/flow_outcome.rb +309 -0
  320. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +428 -0
  321. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  322. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  323. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  324. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  325. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  326. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  327. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  328. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  329. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  330. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  331. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  332. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  333. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  334. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  335. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  336. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  337. data/lib/purecloudplatformclientv2/models/language_override.rb +269 -0
  338. data/lib/purecloudplatformclientv2/models/lex_bot.rb +279 -0
  339. data/lib/purecloudplatformclientv2/models/lex_bot_alias.rb +444 -0
  340. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +428 -0
  341. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +428 -0
  342. data/lib/purecloudplatformclientv2/models/lex_intent.rb +297 -0
  343. data/lib/purecloudplatformclientv2/models/lex_slot.rb +290 -0
  344. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  345. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  346. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  347. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  348. data/lib/purecloudplatformclientv2/models/location_definition.rb +56 -1
  349. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  350. data/lib/purecloudplatformclientv2/models/location_image.rb +227 -0
  351. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  352. data/lib/purecloudplatformclientv2/models/management_unit.rb +21 -57
  353. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  354. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  355. data/lib/purecloudplatformclientv2/models/messaging_integration.rb +510 -0
  356. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +428 -0
  357. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  358. data/lib/purecloudplatformclientv2/models/move_management_unit_request.rb +207 -0
  359. data/lib/purecloudplatformclientv2/models/move_management_unit_response.rb +242 -0
  360. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  361. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  362. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  363. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  364. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  365. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  366. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  367. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  368. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  369. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  370. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  371. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  372. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  373. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  375. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  376. data/lib/purecloudplatformclientv2/models/quality_audit.rb +26 -1
  377. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  378. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
  379. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  380. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  381. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  382. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  383. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  384. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  385. data/lib/purecloudplatformclientv2/models/recording_job.rb +480 -0
  386. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +428 -0
  387. data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +283 -0
  388. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  390. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  391. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  392. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
  394. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  395. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  396. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  397. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  398. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  399. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  400. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  402. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  403. data/lib/purecloudplatformclientv2/models/scored_agent.rb +1 -1
  404. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  405. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  406. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  407. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  408. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  409. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  412. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  413. data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +30 -4
  414. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  416. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  417. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  420. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  421. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  424. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/tts_engine_entity.rb +399 -0
  427. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +428 -0
  428. data/lib/purecloudplatformclientv2/models/tts_settings.rb +240 -0
  429. data/lib/purecloudplatformclientv2/models/tts_voice_entity.rb +372 -0
  430. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +428 -0
  431. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  432. data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +254 -0
  433. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  435. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  440. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  441. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  442. data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit.rb +201 -0
  443. data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification.rb +240 -0
  444. data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_request_notification.rb +344 -0
  445. data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +28 -3
  446. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  447. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  448. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  449. data/lib/purecloudplatformclientv2/version.rb +1 -1
  450. metadata +72 -4
@@ -173,6 +173,70 @@ module PureCloud
173
173
  return data, status_code, headers
174
174
  end
175
175
 
176
+ # Delete the recording bulk job
177
+ #
178
+ # @param job_id jobId
179
+ # @param [Hash] opts the optional parameters
180
+ # @return [nil]
181
+ def delete_recording_job(job_id, opts = {})
182
+ delete_recording_job_with_http_info(job_id, opts)
183
+ return nil
184
+ end
185
+
186
+ # Delete the recording bulk job
187
+ #
188
+ # @param job_id jobId
189
+ # @param [Hash] opts the optional parameters
190
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
191
+ def delete_recording_job_with_http_info(job_id, opts = {})
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug "Calling API: RecordingApi.delete_recording_job ..."
194
+ end
195
+
196
+
197
+ # verify the required parameter 'job_id' is set
198
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling RecordingApi.delete_recording_job" if job_id.nil?
199
+
200
+
201
+
202
+
203
+
204
+ # resource path
205
+ local_var_path = "/api/v2/recording/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
206
+
207
+ # query parameters
208
+ query_params = {}
209
+
210
+ # header parameters
211
+ header_params = {}
212
+
213
+ # HTTP header 'Accept' (if needed)
214
+ local_header_accept = ['application/json']
215
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
216
+
217
+ # HTTP header 'Content-Type'
218
+ local_header_content_type = ['application/json']
219
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
220
+
221
+ # form parameters
222
+ form_params = {}
223
+
224
+ # http body (model)
225
+ post_body = nil
226
+
227
+ auth_names = ['PureCloud OAuth']
228
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names)
234
+ if @api_client.config.debugging
235
+ @api_client.config.logger.debug "API called: RecordingApi#delete_recording_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
236
+ end
237
+ return data, status_code, headers
238
+ end
239
+
176
240
  # Delete media retention policies
177
241
  # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
178
242
  # @param ids
@@ -1152,6 +1216,144 @@ module PureCloud
1152
1216
  return data, status_code, headers
1153
1217
  end
1154
1218
 
1219
+ # Get the status of the job associated with the job id.
1220
+ #
1221
+ # @param job_id jobId
1222
+ # @param [Hash] opts the optional parameters
1223
+ # @return [RecordingJob]
1224
+ def get_recording_job(job_id, opts = {})
1225
+ data, _status_code, _headers = get_recording_job_with_http_info(job_id, opts)
1226
+ return data
1227
+ end
1228
+
1229
+ # Get the status of the job associated with the job id.
1230
+ #
1231
+ # @param job_id jobId
1232
+ # @param [Hash] opts the optional parameters
1233
+ # @return [Array<(RecordingJob, Fixnum, Hash)>] RecordingJob data, response status code and response headers
1234
+ def get_recording_job_with_http_info(job_id, opts = {})
1235
+ if @api_client.config.debugging
1236
+ @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_job ..."
1237
+ end
1238
+
1239
+
1240
+ # verify the required parameter 'job_id' is set
1241
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling RecordingApi.get_recording_job" if job_id.nil?
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+ # resource path
1248
+ local_var_path = "/api/v2/recording/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
1249
+
1250
+ # query parameters
1251
+ query_params = {}
1252
+
1253
+ # header parameters
1254
+ header_params = {}
1255
+
1256
+ # HTTP header 'Accept' (if needed)
1257
+ local_header_accept = ['application/json']
1258
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1259
+
1260
+ # HTTP header 'Content-Type'
1261
+ local_header_content_type = ['application/json']
1262
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1263
+
1264
+ # form parameters
1265
+ form_params = {}
1266
+
1267
+ # http body (model)
1268
+ post_body = nil
1269
+
1270
+ auth_names = ['PureCloud OAuth']
1271
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1272
+ :header_params => header_params,
1273
+ :query_params => query_params,
1274
+ :form_params => form_params,
1275
+ :body => post_body,
1276
+ :auth_names => auth_names,
1277
+ :return_type => 'RecordingJob')
1278
+ if @api_client.config.debugging
1279
+ @api_client.config.logger.debug "API called: RecordingApi#get_recording_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1280
+ end
1281
+ return data, status_code, headers
1282
+ end
1283
+
1284
+ # Get the status of all jobs within the user's organization
1285
+ #
1286
+ # @param [Hash] opts the optional parameters
1287
+ # @option opts [Integer] :page_size Page size (default to 25)
1288
+ # @option opts [Integer] :page_number Page number (default to 1)
1289
+ # @return [RecordingJobEntityListing]
1290
+ def get_recording_jobs(opts = {})
1291
+ data, _status_code, _headers = get_recording_jobs_with_http_info(opts)
1292
+ return data
1293
+ end
1294
+
1295
+ # Get the status of all jobs within the user&#39;s organization
1296
+ #
1297
+ # @param [Hash] opts the optional parameters
1298
+ # @option opts [Integer] :page_size Page size
1299
+ # @option opts [Integer] :page_number Page number
1300
+ # @return [Array<(RecordingJobEntityListing, Fixnum, Hash)>] RecordingJobEntityListing data, response status code and response headers
1301
+ def get_recording_jobs_with_http_info(opts = {})
1302
+ if @api_client.config.debugging
1303
+ @api_client.config.logger.debug "Calling API: RecordingApi.get_recording_jobs ..."
1304
+ end
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+ # resource path
1319
+ local_var_path = "/api/v2/recording/jobs".sub('{format}','json')
1320
+
1321
+ # query parameters
1322
+ query_params = {}
1323
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1324
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1325
+
1326
+ # header parameters
1327
+ header_params = {}
1328
+
1329
+ # HTTP header 'Accept' (if needed)
1330
+ local_header_accept = ['application/json']
1331
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1332
+
1333
+ # HTTP header 'Content-Type'
1334
+ local_header_content_type = ['application/json']
1335
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1336
+
1337
+ # form parameters
1338
+ form_params = {}
1339
+
1340
+ # http body (model)
1341
+ post_body = nil
1342
+
1343
+ auth_names = ['PureCloud OAuth']
1344
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1345
+ :header_params => header_params,
1346
+ :query_params => query_params,
1347
+ :form_params => form_params,
1348
+ :body => post_body,
1349
+ :auth_names => auth_names,
1350
+ :return_type => 'RecordingJobEntityListing')
1351
+ if @api_client.config.debugging
1352
+ @api_client.config.logger.debug "API called: RecordingApi#get_recording_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1353
+ end
1354
+ return data, status_code, headers
1355
+ end
1356
+
1155
1357
  # Get the local encryption settings
1156
1358
  #
1157
1359
  # @param settings_id Settings Id
@@ -2044,6 +2246,71 @@ module PureCloud
2044
2246
  return data, status_code, headers
2045
2247
  end
2046
2248
 
2249
+ # Create a recording bulk job
2250
+ #
2251
+ # @param body query
2252
+ # @param [Hash] opts the optional parameters
2253
+ # @return [RecordingJob]
2254
+ def post_recording_jobs(body, opts = {})
2255
+ data, _status_code, _headers = post_recording_jobs_with_http_info(body, opts)
2256
+ return data
2257
+ end
2258
+
2259
+ # Create a recording bulk job
2260
+ #
2261
+ # @param body query
2262
+ # @param [Hash] opts the optional parameters
2263
+ # @return [Array<(RecordingJob, Fixnum, Hash)>] RecordingJob data, response status code and response headers
2264
+ def post_recording_jobs_with_http_info(body, opts = {})
2265
+ if @api_client.config.debugging
2266
+ @api_client.config.logger.debug "Calling API: RecordingApi.post_recording_jobs ..."
2267
+ end
2268
+
2269
+
2270
+ # verify the required parameter 'body' is set
2271
+ fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recording_jobs" if body.nil?
2272
+
2273
+
2274
+
2275
+
2276
+
2277
+ # resource path
2278
+ local_var_path = "/api/v2/recording/jobs".sub('{format}','json')
2279
+
2280
+ # query parameters
2281
+ query_params = {}
2282
+
2283
+ # header parameters
2284
+ header_params = {}
2285
+
2286
+ # HTTP header 'Accept' (if needed)
2287
+ local_header_accept = ['application/json']
2288
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2289
+
2290
+ # HTTP header 'Content-Type'
2291
+ local_header_content_type = ['application/json']
2292
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2293
+
2294
+ # form parameters
2295
+ form_params = {}
2296
+
2297
+ # http body (model)
2298
+ post_body = @api_client.object_to_http_body(body)
2299
+
2300
+ auth_names = ['PureCloud OAuth']
2301
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2302
+ :header_params => header_params,
2303
+ :query_params => query_params,
2304
+ :form_params => form_params,
2305
+ :body => post_body,
2306
+ :auth_names => auth_names,
2307
+ :return_type => 'RecordingJob')
2308
+ if @api_client.config.debugging
2309
+ @api_client.config.logger.debug "API called: RecordingApi#post_recording_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2310
+ end
2311
+ return data, status_code, headers
2312
+ end
2313
+
2047
2314
  # create a local recording key
2048
2315
  #
2049
2316
  # @param body Local Encryption body
@@ -2547,6 +2814,81 @@ module PureCloud
2547
2814
  return data, status_code, headers
2548
2815
  end
2549
2816
 
2817
+ # Execute the recording bulk job
2818
+ #
2819
+ # @param job_id jobId
2820
+ # @param body query
2821
+ # @param [Hash] opts the optional parameters
2822
+ # @return [RecordingJob]
2823
+ def put_recording_job(job_id, body, opts = {})
2824
+ data, _status_code, _headers = put_recording_job_with_http_info(job_id, body, opts)
2825
+ return data
2826
+ end
2827
+
2828
+ # Execute the recording bulk job
2829
+ #
2830
+ # @param job_id jobId
2831
+ # @param body query
2832
+ # @param [Hash] opts the optional parameters
2833
+ # @return [Array<(RecordingJob, Fixnum, Hash)>] RecordingJob data, response status code and response headers
2834
+ def put_recording_job_with_http_info(job_id, body, opts = {})
2835
+ if @api_client.config.debugging
2836
+ @api_client.config.logger.debug "Calling API: RecordingApi.put_recording_job ..."
2837
+ end
2838
+
2839
+
2840
+ # verify the required parameter 'job_id' is set
2841
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling RecordingApi.put_recording_job" if job_id.nil?
2842
+
2843
+
2844
+
2845
+
2846
+
2847
+
2848
+ # verify the required parameter 'body' is set
2849
+ fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.put_recording_job" if body.nil?
2850
+
2851
+
2852
+
2853
+
2854
+
2855
+ # resource path
2856
+ local_var_path = "/api/v2/recording/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
2857
+
2858
+ # query parameters
2859
+ query_params = {}
2860
+
2861
+ # header parameters
2862
+ header_params = {}
2863
+
2864
+ # HTTP header 'Accept' (if needed)
2865
+ local_header_accept = ['application/json']
2866
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2867
+
2868
+ # HTTP header 'Content-Type'
2869
+ local_header_content_type = ['application/json']
2870
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2871
+
2872
+ # form parameters
2873
+ form_params = {}
2874
+
2875
+ # http body (model)
2876
+ post_body = @api_client.object_to_http_body(body)
2877
+
2878
+ auth_names = ['PureCloud OAuth']
2879
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2880
+ :header_params => header_params,
2881
+ :query_params => query_params,
2882
+ :form_params => form_params,
2883
+ :body => post_body,
2884
+ :auth_names => auth_names,
2885
+ :return_type => 'RecordingJob')
2886
+ if @api_client.config.debugging
2887
+ @api_client.config.logger.debug "API called: RecordingApi#put_recording_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2888
+ end
2889
+ return data, status_code, headers
2890
+ end
2891
+
2550
2892
  # Update the local encryption settings
2551
2893
  #
2552
2894
  # @param settings_id Settings Id
@@ -2658,8 +2658,8 @@ module PureCloud
2658
2658
 
2659
2659
 
2660
2660
 
2661
- if opts[:'phone_number_type'] && !['local', 'mobile', 'tollfree'].include?(opts[:'phone_number_type'])
2662
- fail ArgumentError, 'invalid value for "phone_number_type", must be one of local, mobile, tollfree'
2661
+ if opts[:'phone_number_type'] && !['local', 'mobile', 'tollfree', 'shortcode'].include?(opts[:'phone_number_type'])
2662
+ fail ArgumentError, 'invalid value for "phone_number_type", must be one of local, mobile, tollfree, shortcode'
2663
2663
  end
2664
2664
 
2665
2665
 
@@ -24,22 +24,22 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
- # Soft delete user with specified ID
27
+ # Delete a user
28
28
  #
29
- # @param user_id
29
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
30
30
  # @param [Hash] opts the optional parameters
31
- # @option opts [String] :if_match If-Match for ETag version checking
31
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
32
32
  # @return [Empty]
33
33
  def delete_scim_user(user_id, opts = {})
34
34
  data, _status_code, _headers = delete_scim_user_with_http_info(user_id, opts)
35
35
  return data
36
36
  end
37
37
 
38
- # Soft delete user with specified ID
38
+ # Delete a user
39
39
  #
40
- # @param user_id
40
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
41
41
  # @param [Hash] opts the optional parameters
42
- # @option opts [String] :if_match If-Match for ETag version checking
42
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
43
43
  # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
44
44
  def delete_scim_user_with_http_info(user_id, opts = {})
45
45
  if @api_client.config.debugging
@@ -98,22 +98,22 @@ module PureCloud
98
98
  return data, status_code, headers
99
99
  end
100
100
 
101
- # Soft delete user with specified ID
101
+ # Delete a user
102
102
  #
103
- # @param user_id
103
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
104
104
  # @param [Hash] opts the optional parameters
105
- # @option opts [String] :if_match If-Match for ETag version checking
105
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
106
106
  # @return [Empty]
107
107
  def delete_scim_v2_user(user_id, opts = {})
108
108
  data, _status_code, _headers = delete_scim_v2_user_with_http_info(user_id, opts)
109
109
  return data
110
110
  end
111
111
 
112
- # Soft delete user with specified ID
112
+ # Delete a user
113
113
  #
114
- # @param user_id
114
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
115
115
  # @param [Hash] opts the optional parameters
116
- # @option opts [String] :if_match If-Match for ETag version checking
116
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
117
117
  # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
118
118
  def delete_scim_v2_user_with_http_info(user_id, opts = {})
119
119
  if @api_client.config.debugging
@@ -172,22 +172,22 @@ module PureCloud
172
172
  return data, status_code, headers
173
173
  end
174
174
 
175
- # Return Group with specified ID
175
+ # Get a group
176
176
  #
177
- # @param group_id
177
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
178
178
  # @param [Hash] opts the optional parameters
179
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
179
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
180
180
  # @return [ScimV2Group]
181
181
  def get_scim_group(group_id, opts = {})
182
182
  data, _status_code, _headers = get_scim_group_with_http_info(group_id, opts)
183
183
  return data
184
184
  end
185
185
 
186
- # Return Group with specified ID
186
+ # Get a group
187
187
  #
188
- # @param group_id
188
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
189
189
  # @param [Hash] opts the optional parameters
190
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
190
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
191
191
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
192
192
  def get_scim_group_with_http_info(group_id, opts = {})
193
193
  if @api_client.config.debugging
@@ -246,24 +246,24 @@ module PureCloud
246
246
  return data, status_code, headers
247
247
  end
248
248
 
249
- # Query Groups
249
+ # Get a list of groups
250
250
  #
251
251
  # @param [Hash] opts the optional parameters
252
- # @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
253
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
254
- # @option opts [String] :filter filter parameter e.g. displayName eq groupName
252
+ # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
253
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults. (default to 25)
254
+ # @option opts [String] :filter Filters results.
255
255
  # @return [ScimListResponse]
256
256
  def get_scim_groups(opts = {})
257
257
  data, _status_code, _headers = get_scim_groups_with_http_info(opts)
258
258
  return data
259
259
  end
260
260
 
261
- # Query Groups
261
+ # Get a list of groups
262
262
  #
263
263
  # @param [Hash] opts the optional parameters
264
- # @option opts [Integer] :start_index Starting item of request. 1-based
265
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
266
- # @option opts [String] :filter filter parameter e.g. displayName eq groupName
264
+ # @option opts [Integer] :start_index The 1-based index of the first query result.
265
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults.
266
+ # @option opts [String] :filter Filters results.
267
267
  # @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
268
268
  def get_scim_groups_with_http_info(opts = {})
269
269
  if @api_client.config.debugging
@@ -328,22 +328,22 @@ module PureCloud
328
328
  return data, status_code, headers
329
329
  end
330
330
 
331
- # Return user with specified ID (default version)
331
+ # Get a user
332
332
  #
333
- # @param user_id
333
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
334
334
  # @param [Hash] opts the optional parameters
335
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
335
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
336
336
  # @return [ScimV2User]
337
337
  def get_scim_user(user_id, opts = {})
338
338
  data, _status_code, _headers = get_scim_user_with_http_info(user_id, opts)
339
339
  return data
340
340
  end
341
341
 
342
- # Return user with specified ID (default version)
342
+ # Get a user
343
343
  #
344
- # @param user_id
344
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
345
345
  # @param [Hash] opts the optional parameters
346
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
346
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
347
347
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
348
348
  def get_scim_user_with_http_info(user_id, opts = {})
349
349
  if @api_client.config.debugging
@@ -402,24 +402,24 @@ module PureCloud
402
402
  return data, status_code, headers
403
403
  end
404
404
 
405
- # Query Users
405
+ # Get a list of users
406
406
  #
407
- # @param filter filter parameter e.g. userName eq search@sample.org
407
+ # @param filter Filters results.
408
408
  # @param [Hash] opts the optional parameters
409
- # @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
410
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
409
+ # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
410
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults. (default to 25)
411
411
  # @return [ScimListResponse]
412
412
  def get_scim_users(filter, opts = {})
413
413
  data, _status_code, _headers = get_scim_users_with_http_info(filter, opts)
414
414
  return data
415
415
  end
416
416
 
417
- # Query Users
417
+ # Get a list of users
418
418
  #
419
- # @param filter filter parameter e.g. userName eq search@sample.org
419
+ # @param filter Filters results.
420
420
  # @param [Hash] opts the optional parameters
421
- # @option opts [Integer] :start_index Starting item of request. 1-based
422
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
421
+ # @option opts [Integer] :start_index The 1-based index of the first query result.
422
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults.
423
423
  # @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
424
424
  def get_scim_users_with_http_info(filter, opts = {})
425
425
  if @api_client.config.debugging
@@ -486,22 +486,22 @@ module PureCloud
486
486
  return data, status_code, headers
487
487
  end
488
488
 
489
- # Return Group with specified ID
489
+ # Get a group
490
490
  #
491
- # @param group_id
491
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
492
492
  # @param [Hash] opts the optional parameters
493
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
493
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
494
494
  # @return [ScimV2Group]
495
495
  def get_scim_v2_group(group_id, opts = {})
496
496
  data, _status_code, _headers = get_scim_v2_group_with_http_info(group_id, opts)
497
497
  return data
498
498
  end
499
499
 
500
- # Return Group with specified ID
500
+ # Get a group
501
501
  #
502
- # @param group_id
502
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
503
503
  # @param [Hash] opts the optional parameters
504
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
504
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
505
505
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
506
506
  def get_scim_v2_group_with_http_info(group_id, opts = {})
507
507
  if @api_client.config.debugging
@@ -560,24 +560,24 @@ module PureCloud
560
560
  return data, status_code, headers
561
561
  end
562
562
 
563
- # Query Groups
563
+ # Get a list of groups
564
564
  #
565
- # @param filter filter parameter e.g. displayName eq groupName
565
+ # @param filter Filters results.
566
566
  # @param [Hash] opts the optional parameters
567
- # @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
568
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
567
+ # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
568
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults. (default to 25)
569
569
  # @return [ScimListResponse]
570
570
  def get_scim_v2_groups(filter, opts = {})
571
571
  data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
572
572
  return data
573
573
  end
574
574
 
575
- # Query Groups
575
+ # Get a list of groups
576
576
  #
577
- # @param filter filter parameter e.g. displayName eq groupName
577
+ # @param filter Filters results.
578
578
  # @param [Hash] opts the optional parameters
579
- # @option opts [Integer] :start_index Starting item of request. 1-based
580
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
579
+ # @option opts [Integer] :start_index The 1-based index of the first query result.
580
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults.
581
581
  # @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
582
582
  def get_scim_v2_groups_with_http_info(filter, opts = {})
583
583
  if @api_client.config.debugging
@@ -644,20 +644,20 @@ module PureCloud
644
644
  return data, status_code, headers
645
645
  end
646
646
 
647
- # Get SCIM Configuration
647
+ # Get the SCIM configuration
648
648
  #
649
649
  # @param [Hash] opts the optional parameters
650
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
650
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
651
651
  # @return [ScimServiceProviderConfig]
652
652
  def get_scim_v2_serviceproviderconfig(opts = {})
653
653
  data, _status_code, _headers = get_scim_v2_serviceproviderconfig_with_http_info(opts)
654
654
  return data
655
655
  end
656
656
 
657
- # Get SCIM Configuration
657
+ # Get the SCIM configuration
658
658
  #
659
659
  # @param [Hash] opts the optional parameters
660
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
660
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
661
661
  # @return [Array<(ScimServiceProviderConfig, Fixnum, Hash)>] ScimServiceProviderConfig data, response status code and response headers
662
662
  def get_scim_v2_serviceproviderconfig_with_http_info(opts = {})
663
663
  if @api_client.config.debugging
@@ -708,22 +708,22 @@ module PureCloud
708
708
  return data, status_code, headers
709
709
  end
710
710
 
711
- # Return User with specified ID
711
+ # Get a user
712
712
  #
713
- # @param user_id
713
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
714
714
  # @param [Hash] opts the optional parameters
715
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
715
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
716
716
  # @return [ScimV2User]
717
717
  def get_scim_v2_user(user_id, opts = {})
718
718
  data, _status_code, _headers = get_scim_v2_user_with_http_info(user_id, opts)
719
719
  return data
720
720
  end
721
721
 
722
- # Return User with specified ID
722
+ # Get a user
723
723
  #
724
- # @param user_id
724
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
725
725
  # @param [Hash] opts the optional parameters
726
- # @option opts [String] :if_none_match If-None-Match for ETag version checking
726
+ # @option opts [String] :if_none_match The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
727
727
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
728
728
  def get_scim_v2_user_with_http_info(user_id, opts = {})
729
729
  if @api_client.config.debugging
@@ -782,24 +782,24 @@ module PureCloud
782
782
  return data, status_code, headers
783
783
  end
784
784
 
785
- # Query Users
785
+ # Get a list of users
786
786
  #
787
- # @param filter filter parameter e.g. userName eq search@sample.org
787
+ # @param filter Filters results.
788
788
  # @param [Hash] opts the optional parameters
789
- # @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
790
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
789
+ # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
790
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults. (default to 25)
791
791
  # @return [ScimListResponse]
792
792
  def get_scim_v2_users(filter, opts = {})
793
793
  data, _status_code, _headers = get_scim_v2_users_with_http_info(filter, opts)
794
794
  return data
795
795
  end
796
796
 
797
- # Query Users
797
+ # Get a list of users
798
798
  #
799
- # @param filter filter parameter e.g. userName eq search@sample.org
799
+ # @param filter Filters results.
800
800
  # @param [Hash] opts the optional parameters
801
- # @option opts [Integer] :start_index Starting item of request. 1-based
802
- # @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
801
+ # @option opts [Integer] :start_index The 1-based index of the first query result.
802
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults.
803
803
  # @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
804
804
  def get_scim_v2_users_with_http_info(filter, opts = {})
805
805
  if @api_client.config.debugging
@@ -866,24 +866,24 @@ module PureCloud
866
866
  return data, status_code, headers
867
867
  end
868
868
 
869
- # Update Group with specified ID
869
+ # Modify a group
870
870
  #
871
- # @param group_id
871
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
872
872
  # @param body Group
873
873
  # @param [Hash] opts the optional parameters
874
- # @option opts [String] :if_match If-Match for ETag version checking
874
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
875
875
  # @return [ScimV2Group]
876
876
  def patch_scim_group(group_id, body, opts = {})
877
877
  data, _status_code, _headers = patch_scim_group_with_http_info(group_id, body, opts)
878
878
  return data
879
879
  end
880
880
 
881
- # Update Group with specified ID
881
+ # Modify a group
882
882
  #
883
- # @param group_id
883
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
884
884
  # @param body Group
885
885
  # @param [Hash] opts the optional parameters
886
- # @option opts [String] :if_match If-Match for ETag version checking
886
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
887
887
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
888
888
  def patch_scim_group_with_http_info(group_id, body, opts = {})
889
889
  if @api_client.config.debugging
@@ -950,24 +950,24 @@ module PureCloud
950
950
  return data, status_code, headers
951
951
  end
952
952
 
953
- # Patch user with specified ID
953
+ # Modify a user
954
954
  #
955
- # @param user_id
955
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
956
956
  # @param body SCIM Patch Request
957
957
  # @param [Hash] opts the optional parameters
958
- # @option opts [String] :if_match If-Match for ETag version checking
958
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
959
959
  # @return [ScimV2User]
960
960
  def patch_scim_user(user_id, body, opts = {})
961
961
  data, _status_code, _headers = patch_scim_user_with_http_info(user_id, body, opts)
962
962
  return data
963
963
  end
964
964
 
965
- # Patch user with specified ID
965
+ # Modify a user
966
966
  #
967
- # @param user_id
967
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
968
968
  # @param body SCIM Patch Request
969
969
  # @param [Hash] opts the optional parameters
970
- # @option opts [String] :if_match If-Match for ETag version checking
970
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
971
971
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
972
972
  def patch_scim_user_with_http_info(user_id, body, opts = {})
973
973
  if @api_client.config.debugging
@@ -1034,24 +1034,24 @@ module PureCloud
1034
1034
  return data, status_code, headers
1035
1035
  end
1036
1036
 
1037
- # Update Group with specified ID
1037
+ # Modify a group
1038
1038
  #
1039
- # @param group_id
1039
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1040
1040
  # @param body Group
1041
1041
  # @param [Hash] opts the optional parameters
1042
- # @option opts [String] :if_match If-Match for ETag version checking
1042
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1043
1043
  # @return [ScimV2Group]
1044
1044
  def patch_scim_v2_group(group_id, body, opts = {})
1045
1045
  data, _status_code, _headers = patch_scim_v2_group_with_http_info(group_id, body, opts)
1046
1046
  return data
1047
1047
  end
1048
1048
 
1049
- # Update Group with specified ID
1049
+ # Modify a group
1050
1050
  #
1051
- # @param group_id
1051
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1052
1052
  # @param body Group
1053
1053
  # @param [Hash] opts the optional parameters
1054
- # @option opts [String] :if_match If-Match for ETag version checking
1054
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1055
1055
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1056
1056
  def patch_scim_v2_group_with_http_info(group_id, body, opts = {})
1057
1057
  if @api_client.config.debugging
@@ -1118,24 +1118,24 @@ module PureCloud
1118
1118
  return data, status_code, headers
1119
1119
  end
1120
1120
 
1121
- # Update user with specified ID
1121
+ # Modify a user
1122
1122
  #
1123
- # @param user_id User Id
1123
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1124
1124
  # @param body SCIM Patch Request
1125
1125
  # @param [Hash] opts the optional parameters
1126
- # @option opts [String] :if_match If-Match for ETag version checking
1126
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1127
1127
  # @return [ScimV2User]
1128
1128
  def patch_scim_v2_user(user_id, body, opts = {})
1129
1129
  data, _status_code, _headers = patch_scim_v2_user_with_http_info(user_id, body, opts)
1130
1130
  return data
1131
1131
  end
1132
1132
 
1133
- # Update user with specified ID
1133
+ # Modify a user
1134
1134
  #
1135
- # @param user_id User Id
1135
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1136
1136
  # @param body SCIM Patch Request
1137
1137
  # @param [Hash] opts the optional parameters
1138
- # @option opts [String] :if_match If-Match for ETag version checking
1138
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1139
1139
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
1140
1140
  def patch_scim_v2_user_with_http_info(user_id, body, opts = {})
1141
1141
  if @api_client.config.debugging
@@ -1202,7 +1202,7 @@ module PureCloud
1202
1202
  return data, status_code, headers
1203
1203
  end
1204
1204
 
1205
- # Create user
1205
+ # Create a user
1206
1206
  #
1207
1207
  # @param body SCIM Create User
1208
1208
  # @param [Hash] opts the optional parameters
@@ -1212,7 +1212,7 @@ module PureCloud
1212
1212
  return data
1213
1213
  end
1214
1214
 
1215
- # Create user
1215
+ # Create a user
1216
1216
  #
1217
1217
  # @param body SCIM Create User
1218
1218
  # @param [Hash] opts the optional parameters
@@ -1267,7 +1267,7 @@ module PureCloud
1267
1267
  return data, status_code, headers
1268
1268
  end
1269
1269
 
1270
- # Create user
1270
+ # Create a user
1271
1271
  #
1272
1272
  # @param body SCIM Create User
1273
1273
  # @param [Hash] opts the optional parameters
@@ -1277,7 +1277,7 @@ module PureCloud
1277
1277
  return data
1278
1278
  end
1279
1279
 
1280
- # Create user
1280
+ # Create a user
1281
1281
  #
1282
1282
  # @param body SCIM Create User
1283
1283
  # @param [Hash] opts the optional parameters
@@ -1332,24 +1332,24 @@ module PureCloud
1332
1332
  return data, status_code, headers
1333
1333
  end
1334
1334
 
1335
- # Update Group with specified ID
1335
+ # Replace a group
1336
1336
  #
1337
- # @param group_id
1337
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
1338
1338
  # @param body Group
1339
1339
  # @param [Hash] opts the optional parameters
1340
- # @option opts [String] :if_match If-Match for ETag version checking
1340
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1341
1341
  # @return [ScimV2Group]
1342
1342
  def put_scim_group(group_id, body, opts = {})
1343
1343
  data, _status_code, _headers = put_scim_group_with_http_info(group_id, body, opts)
1344
1344
  return data
1345
1345
  end
1346
1346
 
1347
- # Update Group with specified ID
1347
+ # Replace a group
1348
1348
  #
1349
- # @param group_id
1349
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
1350
1350
  # @param body Group
1351
1351
  # @param [Hash] opts the optional parameters
1352
- # @option opts [String] :if_match If-Match for ETag version checking
1352
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1353
1353
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1354
1354
  def put_scim_group_with_http_info(group_id, body, opts = {})
1355
1355
  if @api_client.config.debugging
@@ -1416,24 +1416,24 @@ module PureCloud
1416
1416
  return data, status_code, headers
1417
1417
  end
1418
1418
 
1419
- # Update user with specified ID
1419
+ # Replace a user
1420
1420
  #
1421
- # @param user_id
1421
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
1422
1422
  # @param body User
1423
1423
  # @param [Hash] opts the optional parameters
1424
- # @option opts [String] :if_match If-Match for ETag version checking
1424
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1425
1425
  # @return [ScimV2User]
1426
1426
  def put_scim_user(user_id, body, opts = {})
1427
1427
  data, _status_code, _headers = put_scim_user_with_http_info(user_id, body, opts)
1428
1428
  return data
1429
1429
  end
1430
1430
 
1431
- # Update user with specified ID
1431
+ # Replace a user
1432
1432
  #
1433
- # @param user_id
1433
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
1434
1434
  # @param body User
1435
1435
  # @param [Hash] opts the optional parameters
1436
- # @option opts [String] :if_match If-Match for ETag version checking
1436
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1437
1437
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
1438
1438
  def put_scim_user_with_http_info(user_id, body, opts = {})
1439
1439
  if @api_client.config.debugging
@@ -1500,24 +1500,24 @@ module PureCloud
1500
1500
  return data, status_code, headers
1501
1501
  end
1502
1502
 
1503
- # Update Group with specified ID
1503
+ # Replace a group
1504
1504
  #
1505
- # @param group_id
1505
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1506
1506
  # @param body Group
1507
1507
  # @param [Hash] opts the optional parameters
1508
- # @option opts [String] :if_match If-Match for ETag version checking
1508
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1509
1509
  # @return [ScimV2Group]
1510
1510
  def put_scim_v2_group(group_id, body, opts = {})
1511
1511
  data, _status_code, _headers = put_scim_v2_group_with_http_info(group_id, body, opts)
1512
1512
  return data
1513
1513
  end
1514
1514
 
1515
- # Update Group with specified ID
1515
+ # Replace a group
1516
1516
  #
1517
- # @param group_id
1517
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1518
1518
  # @param body Group
1519
1519
  # @param [Hash] opts the optional parameters
1520
- # @option opts [String] :if_match If-Match for ETag version checking
1520
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1521
1521
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1522
1522
  def put_scim_v2_group_with_http_info(group_id, body, opts = {})
1523
1523
  if @api_client.config.debugging
@@ -1584,24 +1584,24 @@ module PureCloud
1584
1584
  return data, status_code, headers
1585
1585
  end
1586
1586
 
1587
- # Update user with specified ID
1587
+ # Replace a user
1588
1588
  #
1589
- # @param user_id User Id
1589
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1590
1590
  # @param body User
1591
1591
  # @param [Hash] opts the optional parameters
1592
- # @option opts [String] :if_match If-Match for ETag version checking
1592
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1593
1593
  # @return [ScimV2User]
1594
1594
  def put_scim_v2_user(user_id, body, opts = {})
1595
1595
  data, _status_code, _headers = put_scim_v2_user_with_http_info(user_id, body, opts)
1596
1596
  return data
1597
1597
  end
1598
1598
 
1599
- # Update user with specified ID
1599
+ # Replace a user
1600
1600
  #
1601
- # @param user_id User Id
1601
+ # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
1602
1602
  # @param body User
1603
1603
  # @param [Hash] opts the optional parameters
1604
- # @option opts [String] :if_match If-Match for ETag version checking
1604
+ # @option opts [String] :if_match The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
1605
1605
  # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
1606
1606
  def put_scim_v2_user_with_http_info(user_id, body, opts = {})
1607
1607
  if @api_client.config.debugging