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
|
@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
|
|
|
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/WebChatApi.md
CHANGED
|
@@ -22,12 +22,18 @@ Method | Description
|
|
|
22
22
|
|
|
23
23
|
## - delete_webchat_deployment(deployment_id)
|
|
24
24
|
|
|
25
|
+
|
|
26
|
+
|
|
25
27
|
Delete a WebChat deployment
|
|
26
28
|
|
|
27
29
|
|
|
28
30
|
|
|
29
31
|
Wraps DELETE /api/v2/webchat/deployments/{deploymentId}
|
|
30
32
|
|
|
33
|
+
Requires ANY permissions:
|
|
34
|
+
|
|
35
|
+
* webchat:deployment:delete
|
|
36
|
+
|
|
31
37
|
|
|
32
38
|
### Example
|
|
33
39
|
~~~ruby
|
|
@@ -80,12 +86,18 @@ nil (empty response body)
|
|
|
80
86
|
|
|
81
87
|
## - delete_webchat_settings
|
|
82
88
|
|
|
89
|
+
|
|
90
|
+
|
|
83
91
|
Remove WebChat deployment settings
|
|
84
92
|
|
|
85
93
|
|
|
86
94
|
|
|
87
95
|
Wraps DELETE /api/v2/webchat/settings
|
|
88
96
|
|
|
97
|
+
Requires ANY permissions:
|
|
98
|
+
|
|
99
|
+
* webchat:deployment:delete
|
|
100
|
+
|
|
89
101
|
|
|
90
102
|
### Example
|
|
91
103
|
~~~ruby
|
|
@@ -132,12 +144,18 @@ nil (empty response body)
|
|
|
132
144
|
|
|
133
145
|
## -[**WebChatDeployment**](WebChatDeployment.html) get_webchat_deployment(deployment_id)
|
|
134
146
|
|
|
147
|
+
|
|
148
|
+
|
|
135
149
|
Get a WebChat deployment
|
|
136
150
|
|
|
137
151
|
|
|
138
152
|
|
|
139
153
|
Wraps GET /api/v2/webchat/deployments/{deploymentId}
|
|
140
154
|
|
|
155
|
+
Requires ANY permissions:
|
|
156
|
+
|
|
157
|
+
* webchat:deployment:read
|
|
158
|
+
|
|
141
159
|
|
|
142
160
|
### Example
|
|
143
161
|
~~~ruby
|
|
@@ -191,12 +209,18 @@ Name | Type | Description | Notes
|
|
|
191
209
|
|
|
192
210
|
## -[**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html) get_webchat_deployments
|
|
193
211
|
|
|
212
|
+
|
|
213
|
+
|
|
194
214
|
List WebChat deployments
|
|
195
215
|
|
|
196
216
|
|
|
197
217
|
|
|
198
218
|
Wraps GET /api/v2/webchat/deployments
|
|
199
219
|
|
|
220
|
+
Requires ANY permissions:
|
|
221
|
+
|
|
222
|
+
* webchat:deployment:read
|
|
223
|
+
|
|
200
224
|
|
|
201
225
|
### Example
|
|
202
226
|
~~~ruby
|
|
@@ -244,12 +268,18 @@ This endpoint does not need any parameter.
|
|
|
244
268
|
|
|
245
269
|
## -[**WebChatSettings**](WebChatSettings.html) get_webchat_settings
|
|
246
270
|
|
|
271
|
+
|
|
272
|
+
|
|
247
273
|
Get WebChat deployment settings
|
|
248
274
|
|
|
249
275
|
|
|
250
276
|
|
|
251
277
|
Wraps GET /api/v2/webchat/settings
|
|
252
278
|
|
|
279
|
+
Requires ANY permissions:
|
|
280
|
+
|
|
281
|
+
* webchat:deployment:read
|
|
282
|
+
|
|
253
283
|
|
|
254
284
|
### Example
|
|
255
285
|
~~~ruby
|
|
@@ -297,12 +327,18 @@ This endpoint does not need any parameter.
|
|
|
297
327
|
|
|
298
328
|
## -[**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
|
|
299
329
|
|
|
330
|
+
|
|
331
|
+
|
|
300
332
|
Create WebChat deployment
|
|
301
333
|
|
|
302
334
|
|
|
303
335
|
|
|
304
336
|
Wraps POST /api/v2/webchat/deployments
|
|
305
337
|
|
|
338
|
+
Requires ANY permissions:
|
|
339
|
+
|
|
340
|
+
* webchat:deployment:create
|
|
341
|
+
|
|
306
342
|
|
|
307
343
|
### Example
|
|
308
344
|
~~~ruby
|
|
@@ -356,12 +392,18 @@ Name | Type | Description | Notes
|
|
|
356
392
|
|
|
357
393
|
## -[**WebChatDeployment**](WebChatDeployment.html) put_webchat_deployment(deployment_id, body)
|
|
358
394
|
|
|
395
|
+
|
|
396
|
+
|
|
359
397
|
Update a WebChat deployment
|
|
360
398
|
|
|
361
399
|
|
|
362
400
|
|
|
363
401
|
Wraps PUT /api/v2/webchat/deployments/{deploymentId}
|
|
364
402
|
|
|
403
|
+
Requires ANY permissions:
|
|
404
|
+
|
|
405
|
+
* webchat:deployment:update
|
|
406
|
+
|
|
365
407
|
|
|
366
408
|
### Example
|
|
367
409
|
~~~ruby
|
|
@@ -418,12 +460,18 @@ Name | Type | Description | Notes
|
|
|
418
460
|
|
|
419
461
|
## -[**WebChatSettings**](WebChatSettings.html) put_webchat_settings(body)
|
|
420
462
|
|
|
463
|
+
|
|
464
|
+
|
|
421
465
|
Update WebChat deployment settings
|
|
422
466
|
|
|
423
467
|
|
|
424
468
|
|
|
425
469
|
Wraps PUT /api/v2/webchat/settings
|
|
426
470
|
|
|
471
|
+
Requires ANY permissions:
|
|
472
|
+
|
|
473
|
+
* webchat:deployment:update
|
|
474
|
+
|
|
427
475
|
|
|
428
476
|
### Example
|
|
429
477
|
~~~ruby
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WebChatConfig
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WebChatConfig
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **web_chat_skin** | **String** | css class to be applied to the web chat widget. | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
data/docs/WebChatDeployment.md
CHANGED
|
@@ -11,8 +11,9 @@ title: WebChatDeployment
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **description** | **String** | | [optional] |
|
|
13
13
|
| **authentication_required** | **BOOLEAN** | | [optional] |
|
|
14
|
-
| **authentication_url** | **String** | URL for third party service authenticating
|
|
14
|
+
| **authentication_url** | **String** | URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **web_chat_config** | [**WebChatConfig**](WebChatConfig.html) | | [optional] |
|
|
16
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
18
|
{: class="table table-striped"}
|
|
18
19
|
|
|
@@ -26,12 +26,18 @@ Method | Description
|
|
|
26
26
|
|
|
27
27
|
## -[**Array<UserScheduleAdherence>**](UserScheduleAdherence.html) get_workforcemanagement_adherence(user_id)
|
|
28
28
|
|
|
29
|
+
|
|
30
|
+
|
|
29
31
|
Get a list of UserScheduleAdherence records for the requested users
|
|
30
32
|
|
|
31
33
|
|
|
32
34
|
|
|
33
35
|
Wraps GET /api/v2/workforcemanagement/adherence
|
|
34
36
|
|
|
37
|
+
Requires ANY permissions:
|
|
38
|
+
|
|
39
|
+
* wfm:realtimeAdherence:view
|
|
40
|
+
|
|
35
41
|
|
|
36
42
|
### Example
|
|
37
43
|
~~~ruby
|
|
@@ -85,12 +91,18 @@ Name | Type | Description | Notes
|
|
|
85
91
|
|
|
86
92
|
## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
|
|
87
93
|
|
|
94
|
+
|
|
95
|
+
|
|
88
96
|
Get activity codes
|
|
89
97
|
|
|
90
98
|
|
|
91
99
|
|
|
92
100
|
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
|
93
101
|
|
|
102
|
+
Requires ANY permissions:
|
|
103
|
+
|
|
104
|
+
* wfm:activityCode:administer* wfm:agent:administer* wfm:agentSchedule:view* wfm:historicalAdherence:view* wfm:intraday:view* wfm:managementUnit:administer* wfm:publishedSchedule:view* wfm:realtimeAdherence:view* wfm:schedule:administer* wfm:schedule:generate* wfm:serviceGoalGroup:administer* wfm:shortTermForecast:administer* wfm:agentTimeOffRequest:submit* wfm:timeOffRequest:administer* wfm:workPlan:administer
|
|
105
|
+
|
|
94
106
|
|
|
95
107
|
### Example
|
|
96
108
|
~~~ruby
|
|
@@ -144,12 +156,18 @@ Name | Type | Description | Notes
|
|
|
144
156
|
|
|
145
157
|
## -[**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
|
|
146
158
|
|
|
159
|
+
|
|
160
|
+
|
|
147
161
|
Get intraday queues for the given date
|
|
148
162
|
|
|
149
163
|
|
|
150
164
|
|
|
151
165
|
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/intraday/queues
|
|
152
166
|
|
|
167
|
+
Requires ANY permissions:
|
|
168
|
+
|
|
169
|
+
* wfm:intraday:view
|
|
170
|
+
|
|
153
171
|
|
|
154
172
|
### Example
|
|
155
173
|
~~~ruby
|
|
@@ -206,12 +224,18 @@ Name | Type | Description | Notes
|
|
|
206
224
|
|
|
207
225
|
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
|
|
208
226
|
|
|
227
|
+
|
|
228
|
+
|
|
209
229
|
Get a time off request
|
|
210
230
|
|
|
211
231
|
|
|
212
232
|
|
|
213
233
|
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
|
|
214
234
|
|
|
235
|
+
Requires ANY permissions:
|
|
236
|
+
|
|
237
|
+
* wfm:timeOffRequest:administer
|
|
238
|
+
|
|
215
239
|
|
|
216
240
|
### Example
|
|
217
241
|
~~~ruby
|
|
@@ -271,12 +295,18 @@ Name | Type | Description | Notes
|
|
|
271
295
|
|
|
272
296
|
## -[**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_managementunit_user_timeoffrequests(mu_id, user_id, opts)
|
|
273
297
|
|
|
298
|
+
|
|
299
|
+
|
|
274
300
|
Get a list of time off requests for a given user
|
|
275
301
|
|
|
276
302
|
|
|
277
303
|
|
|
278
304
|
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests
|
|
279
305
|
|
|
306
|
+
Requires ANY permissions:
|
|
307
|
+
|
|
308
|
+
* wfm:timeOffRequest:administer
|
|
309
|
+
|
|
280
310
|
|
|
281
311
|
### Example
|
|
282
312
|
~~~ruby
|
|
@@ -337,12 +367,18 @@ Name | Type | Description | Notes
|
|
|
337
367
|
|
|
338
368
|
## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_users(mu_id)
|
|
339
369
|
|
|
370
|
+
|
|
371
|
+
|
|
340
372
|
Get agents in the management unit
|
|
341
373
|
|
|
342
374
|
|
|
343
375
|
|
|
344
376
|
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
|
|
345
377
|
|
|
378
|
+
Requires ANY permissions:
|
|
379
|
+
|
|
380
|
+
* wfm:agent:administer
|
|
381
|
+
|
|
346
382
|
|
|
347
383
|
### Example
|
|
348
384
|
~~~ruby
|
|
@@ -396,12 +432,18 @@ Name | Type | Description | Notes
|
|
|
396
432
|
|
|
397
433
|
## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits(opts)
|
|
398
434
|
|
|
435
|
+
|
|
436
|
+
|
|
399
437
|
Get management units
|
|
400
438
|
|
|
401
439
|
|
|
402
440
|
|
|
403
441
|
Wraps GET /api/v2/workforcemanagement/managementunits
|
|
404
442
|
|
|
443
|
+
Requires NO permissions:
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
405
447
|
|
|
406
448
|
### Example
|
|
407
449
|
~~~ruby
|
|
@@ -422,7 +464,7 @@ api_instance = PureCloud::WorkforceManagementApi.new
|
|
|
422
464
|
|
|
423
465
|
opts = {
|
|
424
466
|
page_size: 56, # Integer |
|
|
425
|
-
page_number:
|
|
467
|
+
page_number: 56, # Integer |
|
|
426
468
|
expand: "expand_example" # String |
|
|
427
469
|
}
|
|
428
470
|
|
|
@@ -440,7 +482,7 @@ end
|
|
|
440
482
|
Name | Type | Description | Notes
|
|
441
483
|
------------- | ------------- | ------------- | -------------
|
|
442
484
|
**page_size** | **Integer**| | [optional] |
|
|
443
|
-
**page_number** | **Integer**| | [optional]
|
|
485
|
+
**page_number** | **Integer**| | [optional] |
|
|
444
486
|
**expand** | **String**| | [optional] <br />**Values**: details |
|
|
445
487
|
{: class="table table-striped"}
|
|
446
488
|
|
|
@@ -460,12 +502,18 @@ Name | Type | Description | Notes
|
|
|
460
502
|
|
|
461
503
|
## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
|
|
462
504
|
|
|
505
|
+
|
|
506
|
+
|
|
463
507
|
Update a time off request
|
|
464
508
|
|
|
465
509
|
|
|
466
510
|
|
|
467
511
|
Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
|
|
468
512
|
|
|
513
|
+
Requires ANY permissions:
|
|
514
|
+
|
|
515
|
+
* wfm:timeOffRequest:administer
|
|
516
|
+
|
|
469
517
|
|
|
470
518
|
### Example
|
|
471
519
|
~~~ruby
|
|
@@ -529,12 +577,18 @@ Name | Type | Description | Notes
|
|
|
529
577
|
|
|
530
578
|
## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
|
|
531
579
|
|
|
580
|
+
|
|
581
|
+
|
|
532
582
|
Create a new activity code
|
|
533
583
|
|
|
534
584
|
|
|
535
585
|
|
|
536
586
|
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
|
537
587
|
|
|
588
|
+
Requires ANY permissions:
|
|
589
|
+
|
|
590
|
+
* wfm:activityCode:administer
|
|
591
|
+
|
|
538
592
|
|
|
539
593
|
### Example
|
|
540
594
|
~~~ruby
|
|
@@ -592,12 +646,18 @@ Name | Type | Description | Notes
|
|
|
592
646
|
|
|
593
647
|
## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
|
|
594
648
|
|
|
649
|
+
|
|
650
|
+
|
|
595
651
|
Request a historical adherence report
|
|
596
652
|
|
|
597
653
|
|
|
598
654
|
|
|
599
655
|
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
|
|
600
656
|
|
|
657
|
+
Requires ANY permissions:
|
|
658
|
+
|
|
659
|
+
* wfm:historicalAdherence:view
|
|
660
|
+
|
|
601
661
|
|
|
602
662
|
### Example
|
|
603
663
|
~~~ruby
|
|
@@ -655,12 +715,18 @@ Name | Type | Description | Notes
|
|
|
655
715
|
|
|
656
716
|
## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
|
|
657
717
|
|
|
718
|
+
|
|
719
|
+
|
|
658
720
|
Get intraday data for the given date for the requested queueIds
|
|
659
721
|
|
|
660
722
|
|
|
661
723
|
|
|
662
724
|
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
|
|
663
725
|
|
|
726
|
+
Requires ANY permissions:
|
|
727
|
+
|
|
728
|
+
* wfm:intraday:view
|
|
729
|
+
|
|
664
730
|
|
|
665
731
|
### Example
|
|
666
732
|
~~~ruby
|
|
@@ -718,12 +784,18 @@ Name | Type | Description | Notes
|
|
|
718
784
|
|
|
719
785
|
## -[**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
|
|
720
786
|
|
|
787
|
+
|
|
788
|
+
|
|
721
789
|
Query published schedules for given given time range for set of users
|
|
722
790
|
|
|
723
791
|
|
|
724
792
|
|
|
725
793
|
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
|
|
726
794
|
|
|
795
|
+
Requires ANY permissions:
|
|
796
|
+
|
|
797
|
+
* wfm:schedule:administer* wfm:publishedSchedule:view
|
|
798
|
+
|
|
727
799
|
|
|
728
800
|
### Example
|
|
729
801
|
~~~ruby
|
|
@@ -13,9 +13,9 @@ title: WorkspaceEntityListing
|
|
|
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: WorkspaceMemberEntityListing
|
|
|
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
|
|