purecloudplatformclientv2 34.0.0 → 35.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (368) 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/AlertingApi.md +66 -0
  6. data/docs/AnalyticsApi.md +144 -0
  7. data/docs/ArchitectApi.md +492 -2
  8. data/docs/AssignedWrapupCode.md +17 -0
  9. data/docs/AttemptLimitsEntityListing.md +1 -1
  10. data/docs/AttributeEntityListing.md +1 -1
  11. data/docs/AttributesApi.md +36 -0
  12. data/docs/AuthorizationApi.md +102 -0
  13. data/docs/BillingApi.md +6 -0
  14. data/docs/CalibrationEntityListing.md +1 -1
  15. data/docs/CallConversationEntityListing.md +1 -1
  16. data/docs/CallHistoryConversationEntityListing.md +1 -1
  17. data/docs/CallableTimeSetEntityListing.md +1 -1
  18. data/docs/CallbackConversationEntityListing.md +1 -1
  19. data/docs/CampaignDivisionView.md +16 -0
  20. data/docs/CampaignDivisionViewListing.md +22 -0
  21. data/docs/CampaignEntityListing.md +1 -1
  22. data/docs/CampaignRuleEntityListing.md +1 -1
  23. data/docs/CampaignSequenceEntityListing.md +1 -1
  24. data/docs/CertificateAuthorityEntityListing.md +1 -1
  25. data/docs/ChatConversationEntityListing.md +1 -1
  26. data/docs/ClientAppEntityListing.md +1 -1
  27. data/docs/CobrowseConversationEntityListing.md +1 -1
  28. data/docs/CommandStatusEntityListing.md +1 -1
  29. data/docs/ConsumedResourcesEntityListing.md +1 -1
  30. data/docs/ConsumingResourcesEntityListing.md +1 -1
  31. data/docs/ContactListEntityListing.md +1 -1
  32. data/docs/ContactListFilterEntityListing.md +1 -1
  33. data/docs/ContactListing.md +1 -1
  34. data/docs/ContentManagementApi.md +228 -0
  35. data/docs/ConversationEntityListing.md +1 -1
  36. data/docs/ConversationsApi.md +590 -14
  37. data/docs/CredentialInfoListing.md +1 -1
  38. data/docs/CredentialTypeListing.md +1 -1
  39. data/docs/DIDEntityListing.md +1 -1
  40. data/docs/DIDPoolEntityListing.md +1 -1
  41. data/docs/DataTableRowEntityListing.md +1 -1
  42. data/docs/DataTablesDomainEntityListing.md +1 -1
  43. data/docs/DependencyObjectEntityListing.md +1 -1
  44. data/docs/DependencyTypeEntityListing.md +1 -1
  45. data/docs/DialerEventEntityListing.md +1 -1
  46. data/docs/DirectoryUserDevicesListing.md +1 -1
  47. data/docs/DncListEntityListing.md +1 -1
  48. data/docs/DocumentAuditEntityListing.md +1 -1
  49. data/docs/DocumentEntityListing.md +1 -1
  50. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  51. data/docs/DomainEntityListing.md +1 -1
  52. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  53. data/docs/DomainEntityListingQueryResult.md +1 -1
  54. data/docs/DomainEntityListingSurveyForm.md +1 -1
  55. data/docs/DomainOrganizationRole.md +1 -1
  56. data/docs/DomainOrganizationRoleCreate.md +1 -1
  57. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  58. data/docs/EdgeEntityListing.md +1 -1
  59. data/docs/EdgeGroupEntityListing.md +1 -1
  60. data/docs/EdgeLineEntityListing.md +1 -1
  61. data/docs/EmailConversationEntityListing.md +1 -1
  62. data/docs/EmailMessageListing.md +1 -1
  63. data/docs/EmergencyGroupListing.md +1 -1
  64. data/docs/EncryptionKeyEntityListing.md +1 -1
  65. data/docs/EndpointEntityListing.md +1 -1
  66. data/docs/EvaluationEntityListing.md +1 -1
  67. data/docs/EvaluationFormEntityListing.md +1 -1
  68. data/docs/EvaluatorActivityEntityListing.md +1 -1
  69. data/docs/ExtensionEntityListing.md +1 -1
  70. data/docs/ExtensionPoolEntityListing.md +1 -1
  71. data/docs/ExternalContactsApi.md +238 -69
  72. data/docs/ExternalOrganizationListing.md +1 -1
  73. data/docs/FaxApi.md +36 -0
  74. data/docs/FaxDocumentEntityListing.md +1 -1
  75. data/docs/Flow.md +1 -1
  76. data/docs/FlowDivisionViewEntityListing.md +1 -1
  77. data/docs/FlowEntityListing.md +1 -1
  78. data/docs/FlowVersionEntityListing.md +1 -1
  79. data/docs/GDPRRequestEntityListing.md +1 -1
  80. data/docs/GDPRSubjectEntityListing.md +1 -1
  81. data/docs/GeneralDataProtectionRegulationApi.md +24 -0
  82. data/docs/GeolocationApi.md +24 -0
  83. data/docs/GreetingListing.md +1 -1
  84. data/docs/GreetingsApi.md +96 -0
  85. data/docs/GroupEntityListing.md +1 -1
  86. data/docs/GroupProfileEntityListing.md +1 -1
  87. data/docs/GroupsApi.md +84 -0
  88. data/docs/IVREntityListing.md +1 -1
  89. data/docs/IdentityProviderApi.md +168 -0
  90. data/docs/InboundDomainEntityListing.md +1 -1
  91. data/docs/InboundRouteEntityListing.md +1 -1
  92. data/docs/IntegrationEntityListing.md +1 -1
  93. data/docs/IntegrationEventEntityListing.md +1 -1
  94. data/docs/IntegrationTypeEntityListing.md +1 -1
  95. data/docs/IntegrationsApi.md +246 -0
  96. data/docs/InteractionStatsAlertContainer.md +1 -1
  97. data/docs/InteractionStatsRuleContainer.md +1 -1
  98. data/docs/JsonNode.md +4 -4
  99. data/docs/KeywordSetEntityListing.md +1 -1
  100. data/docs/LanguageEntityListing.md +1 -1
  101. data/docs/LanguagesApi.md +60 -0
  102. data/docs/LibraryEntityListing.md +1 -1
  103. data/docs/LicenseApi.md +48 -0
  104. data/docs/LineBaseEntityListing.md +1 -1
  105. data/docs/LineEntityListing.md +1 -1
  106. data/docs/LocationEntityListing.md +1 -1
  107. data/docs/LocationsApi.md +24 -0
  108. data/docs/LogicalInterfaceEntityListing.md +1 -1
  109. data/docs/ManagementUnitListing.md +1 -1
  110. data/docs/MessageConversationEntityListing.md +1 -1
  111. data/docs/MobileDevicesApi.md +30 -0
  112. data/docs/NoteListing.md +1 -1
  113. data/docs/NotificationsApi.md +42 -0
  114. data/docs/OAuthApi.md +36 -0
  115. data/docs/OAuthClientEntityListing.md +1 -1
  116. data/docs/OAuthProviderEntityListing.md +1 -1
  117. data/docs/OrganizationApi.md +24 -0
  118. data/docs/OrganizationAuthorizationApi.md +138 -0
  119. data/docs/OrganizationPresenceEntityListing.md +1 -1
  120. data/docs/OrganizationRoleEntityListing.md +1 -1
  121. data/docs/OrphanRecordingListing.md +1 -1
  122. data/docs/OutboundApi.md +611 -0
  123. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  124. data/docs/OutboundRouteEntityListing.md +1 -1
  125. data/docs/PermissionCollectionEntityListing.md +1 -1
  126. data/docs/PhoneBaseEntityListing.md +1 -1
  127. data/docs/PhoneEntityListing.md +1 -1
  128. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  129. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  130. data/docs/PolicyEntityListing.md +1 -1
  131. data/docs/PresenceApi.md +48 -0
  132. data/docs/PromptAssetEntityListing.md +1 -1
  133. data/docs/PromptEntityListing.md +1 -1
  134. data/docs/QualityApi.md +300 -0
  135. data/docs/QualityAuditPage.md +1 -1
  136. data/docs/QueueEntityListing.md +1 -1
  137. data/docs/QueueMemberEntityListing.md +1 -1
  138. data/docs/RecipientListing.md +1 -1
  139. data/docs/RecordingApi.md +222 -0
  140. data/docs/RelationshipListing.md +1 -1
  141. data/docs/ReportMetaDataEntityListing.md +1 -1
  142. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  143. data/docs/ReportScheduleEntityListing.md +1 -1
  144. data/docs/ReportingExportJobListing.md +1 -1
  145. data/docs/ResponseEntityList.md +1 -1
  146. data/docs/ResponseEntityListing.md +1 -1
  147. data/docs/ResponseManagementApi.md +66 -0
  148. data/docs/ResponseSetEntityListing.md +1 -1
  149. data/docs/RoutingApi.md +351 -1
  150. data/docs/RuleSetEntityListing.md +1 -1
  151. data/docs/ScheduleEntityListing.md +1 -1
  152. data/docs/ScheduleGroupEntityListing.md +1 -1
  153. data/docs/SchemaCategoryEntityListing.md +1 -1
  154. data/docs/SchemaReferenceEntityListing.md +1 -1
  155. data/docs/ScreenRecordingSessionListing.md +1 -1
  156. data/docs/ScriptEntityListing.md +1 -1
  157. data/docs/ScriptsApi.md +66 -0
  158. data/docs/SearchApi.md +84 -0
  159. data/docs/SecurityProfileEntityListing.md +1 -1
  160. data/docs/ShareEntityListing.md +1 -1
  161. data/docs/SiteEntityListing.md +1 -1
  162. data/docs/SkillEntityListing.md +1 -1
  163. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  164. data/docs/StationEntityListing.md +1 -1
  165. data/docs/StationsApi.md +30 -0
  166. data/docs/SuggestApi.md +24 -0
  167. data/docs/SurveyFormEntityListing.md +1 -1
  168. data/docs/SystemPromptAssetEntityListing.md +1 -1
  169. data/docs/SystemPromptEntityListing.md +1 -1
  170. data/docs/TagValueEntityListing.md +1 -1
  171. data/docs/TelephonyProvidersEdgeApi.md +762 -0
  172. data/docs/TextMessageListing.md +1 -1
  173. data/docs/TimeZone.md +2 -2
  174. data/docs/TimeZoneEntityListing.md +1 -1
  175. data/docs/TokensApi.md +12 -0
  176. data/docs/TrunkBaseEntityListing.md +1 -1
  177. data/docs/TrunkEntityListing.md +1 -1
  178. data/docs/TrunkMetabaseEntityListing.md +1 -1
  179. data/docs/TrustEntityListing.md +1 -1
  180. data/docs/TrustUserEntityListing.md +1 -1
  181. data/docs/TrustorEntityListing.md +1 -1
  182. data/docs/UserActionCategoryEntityListing.md +1 -1
  183. data/docs/UserEntityListing.md +1 -1
  184. data/docs/UserLanguageEntityListing.md +1 -1
  185. data/docs/UserProfileEntityListing.md +1 -1
  186. data/docs/UserQueueEntityListing.md +1 -1
  187. data/docs/UserRecordingEntityListing.md +1 -1
  188. data/docs/UserRecordingsApi.md +36 -0
  189. data/docs/UserSkillEntityListing.md +1 -1
  190. data/docs/UsersApi.md +321 -3
  191. data/docs/UtilitiesApi.md +18 -0
  192. data/docs/VoicemailApi.md +144 -0
  193. data/docs/VoicemailMessageEntityListing.md +1 -1
  194. data/docs/WebChatApi.md +48 -0
  195. data/docs/WebChatConfig.md +13 -0
  196. data/docs/WebChatDeployment.md +2 -1
  197. data/docs/WorkforceManagementApi.md +74 -2
  198. data/docs/WorkspaceEntityListing.md +1 -1
  199. data/docs/WorkspaceMemberEntityListing.md +1 -1
  200. data/docs/WrapupCodeEntityListing.md +1 -1
  201. data/lib/purecloudplatformclientv2.rb +4 -1
  202. data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
  203. data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
  204. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
  205. data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
  206. data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
  207. data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
  208. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
  209. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  210. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
  211. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
  212. data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
  213. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
  214. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
  215. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
  216. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
  217. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
  218. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
  219. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
  220. data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
  221. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
  222. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
  223. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
  224. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
  225. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
  226. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
  227. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
  228. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
  229. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
  230. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
  231. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
  232. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
  233. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
  234. data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
  235. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
  236. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
  237. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
  238. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
  239. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
  240. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
  241. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
  242. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
  243. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
  244. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
  245. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
  246. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
  247. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
  248. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
  249. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
  250. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
  251. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
  252. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
  253. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
  254. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  256. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
  258. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
  259. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
  260. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
  261. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
  262. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
  263. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
  264. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
  265. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
  266. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
  267. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
  268. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
  269. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
  270. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
  271. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
  272. data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
  273. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
  274. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
  275. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
  276. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
  277. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
  278. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
  279. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
  280. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
  281. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
  282. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
  283. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
  284. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
  285. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
  286. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
  287. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
  288. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
  289. data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
  290. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
  291. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
  292. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
  293. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
  294. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
  295. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
  296. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
  297. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
  298. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
  299. data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
  300. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
  301. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
  302. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
  303. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
  304. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
  305. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
  306. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
  307. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
  308. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
  309. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
  310. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
  311. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
  312. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
  313. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
  314. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
  315. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
  316. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
  317. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
  318. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
  319. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
  320. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
  321. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
  322. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
  323. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
  324. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
  325. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
  326. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
  327. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
  328. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
  329. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
  330. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
  331. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
  332. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
  333. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
  334. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
  335. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
  336. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
  337. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
  338. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
  339. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
  340. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
  341. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
  342. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
  343. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
  344. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
  345. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  346. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
  347. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
  348. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
  349. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
  350. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
  351. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
  352. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
  353. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
  354. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
  355. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
  356. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
  357. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
  358. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
  359. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
  360. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
  361. data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
  362. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
  363. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
  364. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
  365. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
  366. data/lib/purecloudplatformclientv2/version.rb +1 -1
  367. metadata +10 -4
  368. data/docs/AuthzDivision.md +0 -18
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: AssignedWrapupCode
3
+ ---
4
+ ## PureCloud::AssignedWrapupCode
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **code** | **String** | The user configured wrap up code id. | [optional] |
11
+ | **notes** | **String** | Text entered by the agent to describe the call or disposition. | [optional] |
12
+ | **tags** | **Array<String>** | List of tags selected by the agent to describe the call or disposition. | [optional] |
13
+ | **duration_seconds** | **Integer** | The duration in seconds of the wrap-up segment. | [optional] |
14
+ | **end_time** | **DateTime** | The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -13,9 +13,9 @@ title: AttemptLimitsEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: AttributeEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -20,12 +20,18 @@ Method | Description
20
20
 
21
21
  ## - delete_attribute(attribute_id)
22
22
 
23
+
24
+
23
25
  Delete an existing Attribute.
24
26
 
25
27
  This will remove attribute.
26
28
 
27
29
  Wraps DELETE /api/v2/attributes/{attributeId}
28
30
 
31
+ Requires NO permissions:
32
+
33
+
34
+
29
35
 
30
36
  ### Example
31
37
  ~~~ruby
@@ -78,12 +84,18 @@ nil (empty response body)
78
84
 
79
85
  ## -[**Attribute**](Attribute.html) get_attribute(attribute_id)
80
86
 
87
+
88
+
81
89
  Get details about an existing attribute.
82
90
 
83
91
 
84
92
 
85
93
  Wraps GET /api/v2/attributes/{attributeId}
86
94
 
95
+ Requires NO permissions:
96
+
97
+
98
+
87
99
 
88
100
  ### Example
89
101
  ~~~ruby
@@ -137,12 +149,18 @@ Name | Type | Description | Notes
137
149
 
138
150
  ## -[**AttributeEntityListing**](AttributeEntityListing.html) get_attributes(opts)
139
151
 
152
+
153
+
140
154
  Gets a list of existing attributes.
141
155
 
142
156
 
143
157
 
144
158
  Wraps GET /api/v2/attributes
145
159
 
160
+ Requires NO permissions:
161
+
162
+
163
+
146
164
 
147
165
  ### Example
148
166
  ~~~ruby
@@ -199,12 +217,18 @@ Name | Type | Description | Notes
199
217
 
200
218
  ## -[**Attribute**](Attribute.html) post_attributes(body)
201
219
 
220
+
221
+
202
222
  Create an attribute.
203
223
 
204
224
 
205
225
 
206
226
  Wraps POST /api/v2/attributes
207
227
 
228
+ Requires NO permissions:
229
+
230
+
231
+
208
232
 
209
233
  ### Example
210
234
  ~~~ruby
@@ -258,12 +282,18 @@ Name | Type | Description | Notes
258
282
 
259
283
  ## -[**AttributeEntityListing**](AttributeEntityListing.html) post_attributes_query(body)
260
284
 
285
+
286
+
261
287
  Query attributes
262
288
 
263
289
 
264
290
 
265
291
  Wraps POST /api/v2/attributes/query
266
292
 
293
+ Requires NO permissions:
294
+
295
+
296
+
267
297
 
268
298
  ### Example
269
299
  ~~~ruby
@@ -317,12 +347,18 @@ Name | Type | Description | Notes
317
347
 
318
348
  ## -[**Attribute**](Attribute.html) put_attribute(attribute_id, body)
319
349
 
350
+
351
+
320
352
  Update an existing attribute.
321
353
 
322
354
  Fields that can be updated: name, description. The most recent version is required for updates.
323
355
 
324
356
  Wraps PUT /api/v2/attributes/{attributeId}
325
357
 
358
+ Requires NO permissions:
359
+
360
+
361
+
326
362
 
327
363
  ### Example
328
364
  ~~~ruby
@@ -31,12 +31,18 @@ Method | Description
31
31
 
32
32
  ## - delete_authorization_role(role_id)
33
33
 
34
+
35
+
34
36
  Delete an organization role.
35
37
 
36
38
 
37
39
 
38
40
  Wraps DELETE /api/v2/authorization/roles/{roleId}
39
41
 
42
+ Requires ANY permissions:
43
+
44
+ * admin* role_manager* authorization:role:delete
45
+
40
46
 
41
47
  ### Example
42
48
  ~~~ruby
@@ -89,12 +95,18 @@ nil (empty response body)
89
95
 
90
96
  ## - delete_user_roles(user_id)
91
97
 
98
+
99
+
92
100
  Removes all the roles from the user.
93
101
 
94
102
 
95
103
 
96
104
  Wraps DELETE /api/v2/users/{userId}/roles
97
105
 
106
+ Requires ANY permissions:
107
+
108
+ * admin* role_manager* authorization:grant:delete
109
+
98
110
 
99
111
  ### Example
100
112
  ~~~ruby
@@ -147,12 +159,18 @@ nil (empty response body)
147
159
 
148
160
  ## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
149
161
 
162
+
163
+
150
164
  Get all permissions.
151
165
 
152
166
  Retrieve a list of all permission defined in the system.
153
167
 
154
168
  Wraps GET /api/v2/authorization/permissions
155
169
 
170
+ Requires NO permissions:
171
+
172
+
173
+
156
174
 
157
175
  ### Example
158
176
  ~~~ruby
@@ -209,12 +227,18 @@ Name | Type | Description | Notes
209
227
 
210
228
  ## -[**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
211
229
 
230
+
231
+
212
232
  Get the list of enabled products
213
233
 
214
234
  Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
215
235
 
216
236
  Wraps GET /api/v2/authorization/products
217
237
 
238
+ Requires NO permissions:
239
+
240
+
241
+
218
242
 
219
243
  ### Example
220
244
  ~~~ruby
@@ -262,12 +286,18 @@ This endpoint does not need any parameter.
262
286
 
263
287
  ## -[**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
264
288
 
289
+
290
+
265
291
  Get a single organization role.
266
292
 
267
293
  Get the organization role specified by its ID.
268
294
 
269
295
  Wraps GET /api/v2/authorization/roles/{roleId}
270
296
 
297
+ Requires ANY permissions:
298
+
299
+ * authorization:role:view
300
+
271
301
 
272
302
  ### Example
273
303
  ~~~ruby
@@ -321,12 +351,18 @@ Name | Type | Description | Notes
321
351
 
322
352
  ## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
323
353
 
354
+
355
+
324
356
  Get an org role to default role comparison comparison
325
357
 
326
358
  Compares any organization role to a default role id and show differences
327
359
 
328
360
  Wraps GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
329
361
 
362
+ Requires ANY permissions:
363
+
364
+ * authorization:role:view
365
+
330
366
 
331
367
  ### Example
332
368
  ~~~ruby
@@ -383,12 +419,18 @@ Name | Type | Description | Notes
383
419
 
384
420
  ## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
385
421
 
422
+
423
+
386
424
  Retrieve a list of all roles defined for the organization
387
425
 
388
426
 
389
427
 
390
428
  Wraps GET /api/v2/authorization/roles
391
429
 
430
+ Requires ANY permissions:
431
+
432
+ * authorization:role:view
433
+
392
434
 
393
435
  ### Example
394
436
  ~~~ruby
@@ -463,12 +505,18 @@ Name | Type | Description | Notes
463
505
 
464
506
  ## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
465
507
 
508
+
509
+
466
510
  Returns a listing of roles and permissions for a user.
467
511
 
468
512
 
469
513
 
470
514
  Wraps GET /api/v2/users/{userId}/roles
471
515
 
516
+ Requires ANY permissions:
517
+
518
+ * authorization:grant:view
519
+
472
520
 
473
521
  ### Example
474
522
  ~~~ruby
@@ -522,12 +570,18 @@ Name | Type | Description | Notes
522
570
 
523
571
  ## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
524
572
 
573
+
574
+
525
575
  Patch Organization Role for needsUpdate Field
526
576
 
527
577
  Patch Organization Role for needsUpdate Field
528
578
 
529
579
  Wraps PATCH /api/v2/authorization/roles/{roleId}
530
580
 
581
+ Requires ANY permissions:
582
+
583
+ * admin* role_manager* authorization:role:edit
584
+
531
585
 
532
586
  ### Example
533
587
  ~~~ruby
@@ -584,12 +638,18 @@ Name | Type | Description | Notes
584
638
 
585
639
  ## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
586
640
 
641
+
642
+
587
643
  Get an unsaved org role to default role comparison
588
644
 
589
645
  Allows users to compare their existing roles in an unsaved state to its default role
590
646
 
591
647
  Wraps POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
592
648
 
649
+ Requires ANY permissions:
650
+
651
+ * authorization:role:view
652
+
593
653
 
594
654
  ### Example
595
655
  ~~~ruby
@@ -649,12 +709,18 @@ Name | Type | Description | Notes
649
709
 
650
710
  ## -[**DomainOrganizationRole**](DomainOrganizationRole.html) post_authorization_roles(body)
651
711
 
712
+
713
+
652
714
  Create an organization role.
653
715
 
654
716
 
655
717
 
656
718
  Wraps POST /api/v2/authorization/roles
657
719
 
720
+ Requires ANY permissions:
721
+
722
+ * authorization:role:add
723
+
658
724
 
659
725
  ### Example
660
726
  ~~~ruby
@@ -708,12 +774,18 @@ Name | Type | Description | Notes
708
774
 
709
775
  ## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) post_authorization_roles_default(opts)
710
776
 
777
+
778
+
711
779
  Restores all default roles
712
780
 
713
781
  This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
714
782
 
715
783
  Wraps POST /api/v2/authorization/roles/default
716
784
 
785
+ Requires ANY permissions:
786
+
787
+ * authorization:role:edit
788
+
717
789
 
718
790
  ### Example
719
791
  ~~~ruby
@@ -768,12 +840,18 @@ Name | Type | Description | Notes
768
840
 
769
841
  ## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
770
842
 
843
+
844
+
771
845
  Update an organization role.
772
846
 
773
847
  Update
774
848
 
775
849
  Wraps PUT /api/v2/authorization/roles/{roleId}
776
850
 
851
+ Requires ANY permissions:
852
+
853
+ * admin* role_manager* authorization:role:edit
854
+
777
855
 
778
856
  ### Example
779
857
  ~~~ruby
@@ -830,12 +908,18 @@ Name | Type | Description | Notes
830
908
 
831
909
  ## -Array<String>** put_authorization_role_users_add(role_id, body)
832
910
 
911
+
912
+
833
913
  Sets the users for the role
834
914
 
835
915
 
836
916
 
837
917
  Wraps PUT /api/v2/authorization/roles/{roleId}/users/add
838
918
 
919
+ Requires ANY permissions:
920
+
921
+ * authorization:grant:add
922
+
839
923
 
840
924
  ### Example
841
925
  ~~~ruby
@@ -892,12 +976,18 @@ Name | Type | Description | Notes
892
976
 
893
977
  ## -Array<String>** put_authorization_role_users_remove(role_id, body)
894
978
 
979
+
980
+
895
981
  Removes the users from the role
896
982
 
897
983
 
898
984
 
899
985
  Wraps PUT /api/v2/authorization/roles/{roleId}/users/remove
900
986
 
987
+ Requires ANY permissions:
988
+
989
+ * authorization:grant:delete
990
+
901
991
 
902
992
  ### Example
903
993
  ~~~ruby
@@ -954,12 +1044,18 @@ Name | Type | Description | Notes
954
1044
 
955
1045
  ## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_authorization_roles_default(body)
956
1046
 
1047
+
1048
+
957
1049
  Restore specified default roles
958
1050
 
959
1051
 
960
1052
 
961
1053
  Wraps PUT /api/v2/authorization/roles/default
962
1054
 
1055
+ Requires ANY permissions:
1056
+
1057
+ * authorization:role:edit
1058
+
963
1059
 
964
1060
  ### Example
965
1061
  ~~~ruby
@@ -1013,12 +1109,18 @@ Name | Type | Description | Notes
1013
1109
 
1014
1110
  ## -[**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
1015
1111
 
1112
+
1113
+
1016
1114
  Sets the user's roles
1017
1115
 
1018
1116
 
1019
1117
 
1020
1118
  Wraps PUT /api/v2/users/{userId}/roles
1021
1119
 
1120
+ Requires ANY permissions:
1121
+
1122
+ * admin* role_manager* authorization:grant:add
1123
+
1022
1124
 
1023
1125
  ### Example
1024
1126
  ~~~ruby