purecloudplatformclientv2 34.0.0 → 35.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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
data/docs/LocationsApi.md
CHANGED
@@ -18,12 +18,18 @@ Method | Description
|
|
18
18
|
|
19
19
|
## -[**LocationDefinition**](LocationDefinition.html) get_location(location_id)
|
20
20
|
|
21
|
+
|
22
|
+
|
21
23
|
Get Location by ID.
|
22
24
|
|
23
25
|
|
24
26
|
|
25
27
|
Wraps GET /api/v2/locations/{locationId}
|
26
28
|
|
29
|
+
Requires ANY permissions:
|
30
|
+
|
31
|
+
* telephony:plugin:all
|
32
|
+
|
27
33
|
|
28
34
|
### Example
|
29
35
|
~~~ruby
|
@@ -77,12 +83,18 @@ Name | Type | Description | Notes
|
|
77
83
|
|
78
84
|
## -[**LocationEntityListing**](LocationEntityListing.html) get_locations(opts)
|
79
85
|
|
86
|
+
|
87
|
+
|
80
88
|
Get a list of all locations.
|
81
89
|
|
82
90
|
|
83
91
|
|
84
92
|
Wraps GET /api/v2/locations
|
85
93
|
|
94
|
+
Requires NO permissions:
|
95
|
+
|
96
|
+
|
97
|
+
|
86
98
|
|
87
99
|
### Example
|
88
100
|
~~~ruby
|
@@ -141,12 +153,18 @@ Name | Type | Description | Notes
|
|
141
153
|
|
142
154
|
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_locations_search(q64, opts)
|
143
155
|
|
156
|
+
|
157
|
+
|
144
158
|
Search locations using the q64 value returned from a previous search
|
145
159
|
|
146
160
|
|
147
161
|
|
148
162
|
Wraps GET /api/v2/locations/search
|
149
163
|
|
164
|
+
Requires NO permissions:
|
165
|
+
|
166
|
+
|
167
|
+
|
150
168
|
|
151
169
|
### Example
|
152
170
|
~~~ruby
|
@@ -204,12 +222,18 @@ Name | Type | Description | Notes
|
|
204
222
|
|
205
223
|
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)
|
206
224
|
|
225
|
+
|
226
|
+
|
207
227
|
Search locations
|
208
228
|
|
209
229
|
|
210
230
|
|
211
231
|
Wraps POST /api/v2/locations/search
|
212
232
|
|
233
|
+
Requires NO permissions:
|
234
|
+
|
235
|
+
|
236
|
+
|
213
237
|
|
214
238
|
### Example
|
215
239
|
~~~ruby
|
@@ -13,9 +13,9 @@ title: LogicalInterfaceEntityListing
|
|
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: ManagementUnitListing
|
|
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: MessageConversationEntityListing
|
|
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
|
|
data/docs/MobileDevicesApi.md
CHANGED
@@ -19,12 +19,18 @@ Method | Description
|
|
19
19
|
|
20
20
|
## - delete_mobiledevice(device_id)
|
21
21
|
|
22
|
+
|
23
|
+
|
22
24
|
Delete device
|
23
25
|
|
24
26
|
|
25
27
|
|
26
28
|
Wraps DELETE /api/v2/mobiledevices/{deviceId}
|
27
29
|
|
30
|
+
Requires NO permissions:
|
31
|
+
|
32
|
+
|
33
|
+
|
28
34
|
|
29
35
|
### Example
|
30
36
|
~~~ruby
|
@@ -77,12 +83,18 @@ nil (empty response body)
|
|
77
83
|
|
78
84
|
## -[**UserDevice**](UserDevice.html) get_mobiledevice(device_id)
|
79
85
|
|
86
|
+
|
87
|
+
|
80
88
|
Get device
|
81
89
|
|
82
90
|
|
83
91
|
|
84
92
|
Wraps GET /api/v2/mobiledevices/{deviceId}
|
85
93
|
|
94
|
+
Requires NO permissions:
|
95
|
+
|
96
|
+
|
97
|
+
|
86
98
|
|
87
99
|
### Example
|
88
100
|
~~~ruby
|
@@ -136,12 +148,18 @@ Name | Type | Description | Notes
|
|
136
148
|
|
137
149
|
## -[**DirectoryUserDevicesListing**](DirectoryUserDevicesListing.html) get_mobiledevices(opts)
|
138
150
|
|
151
|
+
|
152
|
+
|
139
153
|
Get a list of all devices.
|
140
154
|
|
141
155
|
|
142
156
|
|
143
157
|
Wraps GET /api/v2/mobiledevices
|
144
158
|
|
159
|
+
Requires NO permissions:
|
160
|
+
|
161
|
+
|
162
|
+
|
145
163
|
|
146
164
|
### Example
|
147
165
|
~~~ruby
|
@@ -200,12 +218,18 @@ Name | Type | Description | Notes
|
|
200
218
|
|
201
219
|
## -[**UserDevice**](UserDevice.html) post_mobiledevices(body)
|
202
220
|
|
221
|
+
|
222
|
+
|
203
223
|
Create User device
|
204
224
|
|
205
225
|
|
206
226
|
|
207
227
|
Wraps POST /api/v2/mobiledevices
|
208
228
|
|
229
|
+
Requires NO permissions:
|
230
|
+
|
231
|
+
|
232
|
+
|
209
233
|
|
210
234
|
### Example
|
211
235
|
~~~ruby
|
@@ -259,12 +283,18 @@ Name | Type | Description | Notes
|
|
259
283
|
|
260
284
|
## -[**UserDevice**](UserDevice.html) put_mobiledevice(device_id, opts)
|
261
285
|
|
286
|
+
|
287
|
+
|
262
288
|
Update device
|
263
289
|
|
264
290
|
|
265
291
|
|
266
292
|
Wraps PUT /api/v2/mobiledevices/{deviceId}
|
267
293
|
|
294
|
+
Requires NO permissions:
|
295
|
+
|
296
|
+
|
297
|
+
|
268
298
|
|
269
299
|
### Example
|
270
300
|
~~~ruby
|
data/docs/NoteListing.md
CHANGED
@@ -13,9 +13,9 @@ title: NoteListing
|
|
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
|
|
data/docs/NotificationsApi.md
CHANGED
@@ -21,12 +21,18 @@ Method | Description
|
|
21
21
|
|
22
22
|
## - delete_notifications_channel_subscriptions(channel_id)
|
23
23
|
|
24
|
+
|
25
|
+
|
24
26
|
Remove all subscriptions
|
25
27
|
|
26
28
|
|
27
29
|
|
28
30
|
Wraps DELETE /api/v2/notifications/channels/{channelId}/subscriptions
|
29
31
|
|
32
|
+
Requires NO permissions:
|
33
|
+
|
34
|
+
|
35
|
+
|
30
36
|
|
31
37
|
### Example
|
32
38
|
~~~ruby
|
@@ -79,12 +85,18 @@ nil (empty response body)
|
|
79
85
|
|
80
86
|
## -[**AvailableTopicEntityListing**](AvailableTopicEntityListing.html) get_notifications_availabletopics(opts)
|
81
87
|
|
88
|
+
|
89
|
+
|
82
90
|
Get available notification topics.
|
83
91
|
|
84
92
|
|
85
93
|
|
86
94
|
Wraps GET /api/v2/notifications/availabletopics
|
87
95
|
|
96
|
+
Requires NO permissions:
|
97
|
+
|
98
|
+
|
99
|
+
|
88
100
|
|
89
101
|
### Example
|
90
102
|
~~~ruby
|
@@ -139,12 +151,18 @@ Name | Type | Description | Notes
|
|
139
151
|
|
140
152
|
## -[**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) get_notifications_channel_subscriptions(channel_id)
|
141
153
|
|
154
|
+
|
155
|
+
|
142
156
|
The list of all subscriptions for this channel
|
143
157
|
|
144
158
|
|
145
159
|
|
146
160
|
Wraps GET /api/v2/notifications/channels/{channelId}/subscriptions
|
147
161
|
|
162
|
+
Requires NO permissions:
|
163
|
+
|
164
|
+
|
165
|
+
|
148
166
|
|
149
167
|
### Example
|
150
168
|
~~~ruby
|
@@ -198,12 +216,18 @@ Name | Type | Description | Notes
|
|
198
216
|
|
199
217
|
## -[**ChannelEntityListing**](ChannelEntityListing.html) get_notifications_channels(opts)
|
200
218
|
|
219
|
+
|
220
|
+
|
201
221
|
The list of existing channels
|
202
222
|
|
203
223
|
|
204
224
|
|
205
225
|
Wraps GET /api/v2/notifications/channels
|
206
226
|
|
227
|
+
Requires NO permissions:
|
228
|
+
|
229
|
+
|
230
|
+
|
207
231
|
|
208
232
|
### Example
|
209
233
|
~~~ruby
|
@@ -258,12 +282,18 @@ Name | Type | Description | Notes
|
|
258
282
|
|
259
283
|
## -[**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) post_notifications_channel_subscriptions(channel_id, body)
|
260
284
|
|
285
|
+
|
286
|
+
|
261
287
|
Add a list of subscriptions to the existing list of subscriptions
|
262
288
|
|
263
289
|
|
264
290
|
|
265
291
|
Wraps POST /api/v2/notifications/channels/{channelId}/subscriptions
|
266
292
|
|
293
|
+
Requires NO permissions:
|
294
|
+
|
295
|
+
|
296
|
+
|
267
297
|
|
268
298
|
### Example
|
269
299
|
~~~ruby
|
@@ -320,12 +350,18 @@ Name | Type | Description | Notes
|
|
320
350
|
|
321
351
|
## -[**Channel**](Channel.html) post_notifications_channels
|
322
352
|
|
353
|
+
|
354
|
+
|
323
355
|
Create a new channel
|
324
356
|
|
325
357
|
There is a limit of 5 channels per user/app combination. Creating a 6th channel will remove the channel with oldest last used date.
|
326
358
|
|
327
359
|
Wraps POST /api/v2/notifications/channels
|
328
360
|
|
361
|
+
Requires NO permissions:
|
362
|
+
|
363
|
+
|
364
|
+
|
329
365
|
|
330
366
|
### Example
|
331
367
|
~~~ruby
|
@@ -373,12 +409,18 @@ This endpoint does not need any parameter.
|
|
373
409
|
|
374
410
|
## -[**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) put_notifications_channel_subscriptions(channel_id, body)
|
375
411
|
|
412
|
+
|
413
|
+
|
376
414
|
Replace the current list of subscriptions with a new list.
|
377
415
|
|
378
416
|
|
379
417
|
|
380
418
|
Wraps PUT /api/v2/notifications/channels/{channelId}/subscriptions
|
381
419
|
|
420
|
+
Requires NO permissions:
|
421
|
+
|
422
|
+
|
423
|
+
|
382
424
|
|
383
425
|
### Example
|
384
426
|
~~~ruby
|
data/docs/OAuthApi.md
CHANGED
@@ -20,12 +20,18 @@ Method | Description
|
|
20
20
|
|
21
21
|
## - delete_oauth_client(client_id)
|
22
22
|
|
23
|
+
|
24
|
+
|
23
25
|
Delete OAuth Client
|
24
26
|
|
25
27
|
|
26
28
|
|
27
29
|
Wraps DELETE /api/v2/oauth/clients/{clientId}
|
28
30
|
|
31
|
+
Requires ANY permissions:
|
32
|
+
|
33
|
+
* oauth:client:delete
|
34
|
+
|
29
35
|
|
30
36
|
### Example
|
31
37
|
~~~ruby
|
@@ -78,12 +84,18 @@ nil (empty response body)
|
|
78
84
|
|
79
85
|
## -[**OAuthClient**](OAuthClient.html) get_oauth_client(client_id)
|
80
86
|
|
87
|
+
|
88
|
+
|
81
89
|
Get OAuth Client
|
82
90
|
|
83
91
|
|
84
92
|
|
85
93
|
Wraps GET /api/v2/oauth/clients/{clientId}
|
86
94
|
|
95
|
+
Requires ANY permissions:
|
96
|
+
|
97
|
+
* oauth:client:view
|
98
|
+
|
87
99
|
|
88
100
|
### Example
|
89
101
|
~~~ruby
|
@@ -137,12 +149,18 @@ Name | Type | Description | Notes
|
|
137
149
|
|
138
150
|
## -[**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_oauth_clients
|
139
151
|
|
152
|
+
|
153
|
+
|
140
154
|
The list of OAuth clients
|
141
155
|
|
142
156
|
|
143
157
|
|
144
158
|
Wraps GET /api/v2/oauth/clients
|
145
159
|
|
160
|
+
Requires ANY permissions:
|
161
|
+
|
162
|
+
* oauth:client:view
|
163
|
+
|
146
164
|
|
147
165
|
### Example
|
148
166
|
~~~ruby
|
@@ -190,12 +208,18 @@ This endpoint does not need any parameter.
|
|
190
208
|
|
191
209
|
## -[**OAuthClient**](OAuthClient.html) post_oauth_client_secret(client_id)
|
192
210
|
|
211
|
+
|
212
|
+
|
193
213
|
Regenerate Client Secret
|
194
214
|
|
195
215
|
This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
|
196
216
|
|
197
217
|
Wraps POST /api/v2/oauth/clients/{clientId}/secret
|
198
218
|
|
219
|
+
Requires ANY permissions:
|
220
|
+
|
221
|
+
* oauth:client:edit
|
222
|
+
|
199
223
|
|
200
224
|
### Example
|
201
225
|
~~~ruby
|
@@ -249,12 +273,18 @@ Name | Type | Description | Notes
|
|
249
273
|
|
250
274
|
## -[**OAuthClient**](OAuthClient.html) post_oauth_clients(body)
|
251
275
|
|
276
|
+
|
277
|
+
|
252
278
|
Create OAuth client
|
253
279
|
|
254
280
|
The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles via the 'roleIds' field.
|
255
281
|
|
256
282
|
Wraps POST /api/v2/oauth/clients
|
257
283
|
|
284
|
+
Requires ANY permissions:
|
285
|
+
|
286
|
+
* oauth:client:add
|
287
|
+
|
258
288
|
|
259
289
|
### Example
|
260
290
|
~~~ruby
|
@@ -308,12 +338,18 @@ Name | Type | Description | Notes
|
|
308
338
|
|
309
339
|
## -[**OAuthClient**](OAuthClient.html) put_oauth_client(client_id, body)
|
310
340
|
|
341
|
+
|
342
|
+
|
311
343
|
Update OAuth Client
|
312
344
|
|
313
345
|
|
314
346
|
|
315
347
|
Wraps PUT /api/v2/oauth/clients/{clientId}
|
316
348
|
|
349
|
+
Requires ANY permissions:
|
350
|
+
|
351
|
+
* oauth:client:edit
|
352
|
+
|
317
353
|
|
318
354
|
### Example
|
319
355
|
~~~ruby
|