purecloudplatformclientv2 56.0.0 → 57.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/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +66 -0
- data/docs/ArrayNode.md +7 -7
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- 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/CampaignDivisionViewListing.md +1 -1
- 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/ChatMediaParticipant.md +1 -0
- 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/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationsApi.md +134 -0
- data/docs/CreateWebChatConversationRequest.md +18 -0
- data/docs/CreateWebChatConversationResponse.md +16 -0
- data/docs/CreateWebChatMessageRequest.md +14 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CustomerInteractionCenter.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/DncListDivisionViewListing.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/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/Evaluation.md +3 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluationQuestion.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/FlowsApi.md +66 -0
- data/docs/GDPRJourneyCustomer.md +14 -0
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubject.md +2 -0
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GSuite.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GuestMemberInfo.md +15 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.md +1 -1
- 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/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +33 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +25 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/Meta.md +17 -0
- data/docs/MeteredAssignmentByAgent.md +18 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObservationValue.md +1 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PatchOperation.md +13 -0
- data/docs/PatchRequest.md +17 -0
- data/docs/Path.md +14 -0
- 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/Photo.md +14 -0
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyActions.md +1 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PureEngage.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +2 -1
- 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/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +1499 -0
- data/docs/Salesforce.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/ScimEmail.md +15 -0
- data/docs/ScimListResponse.md +17 -0
- data/docs/ScimMetadata.md +16 -0
- data/docs/ScimPhoneNumber.md +15 -0
- data/docs/ScimResource.md +15 -0
- data/docs/ScimServiceProviderConfig.md +14 -0
- data/docs/ScimV2CreateUser.md +24 -0
- data/docs/ScimV2EnterpriseUser.md +15 -0
- data/docs/ScimV2Group.md +17 -0
- data/docs/ScimV2GroupReference.md +17 -0
- data/docs/ScimV2MemberReference.md +17 -0
- data/docs/ScimV2PatchOperation.md +15 -0
- data/docs/ScimV2PatchRequest.md +14 -0
- data/docs/ScimV2User.md +25 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- 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/SmsPhoneNumber.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialHandle.md +14 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- 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 +2 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeInterval.md +2 -0
- data/docs/TimeZone.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- 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/TwitterIntegrationEntityListing.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/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +773 -24
- data/docs/WebChatConversation.md +16 -0
- data/docs/WebChatGuestMediaRequest.md +19 -0
- data/docs/WebChatGuestMediaRequestEntityList.md +13 -0
- data/docs/WebChatMemberInfo.md +21 -0
- data/docs/WebChatMemberInfoEntityList.md +22 -0
- data/docs/WebChatMessage.md +20 -0
- data/docs/WebChatMessageEntityList.md +17 -0
- data/docs/WebChatRoutingTarget.md +17 -0
- data/docs/WebChatTyping.md +16 -0
- data/docs/WidgetClientConfig.md +1 -0
- data/docs/WidgetClientConfigV1Http.md +14 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +39 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +148 -0
- data/lib/purecloudplatformclientv2/api/flows_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +1671 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/web_chat_api.rb +901 -30
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +79 -79
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb +352 -0
- data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_response.rb +280 -0
- data/lib/purecloudplatformclientv2/models/create_web_chat_message_request.rb +247 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation.rb +81 -1
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +238 -0
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject.rb +51 -1
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/guest_member_info.rb +261 -0
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +715 -0
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +521 -0
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/meta.rb +303 -0
- data/lib/purecloudplatformclientv2/models/metered_assignment_by_agent.rb +328 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/observation_value.rb +27 -1
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/patch_operation.rb +201 -0
- data/lib/purecloudplatformclientv2/models/patch_request.rb +310 -0
- data/lib/purecloudplatformclientv2/models/path.rb +226 -0
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/photo.rb +243 -0
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_actions.rb +28 -1
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/pure_engage.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/replacement_term.rb +2 -2
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_email.rb +269 -0
- data/lib/purecloudplatformclientv2/models/scim_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +295 -0
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +269 -0
- data/lib/purecloudplatformclientv2/models/scim_resource.rb +254 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +228 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +508 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +255 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +310 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +320 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +320 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +274 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +237 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +523 -0
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +5 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_handle.rb +240 -0
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_interval.rb +51 -1
- data/lib/purecloudplatformclientv2/models/time_zone.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_conversation.rb +279 -0
- data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request.rb +384 -0
- data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request_entity_list.rb +203 -0
- data/lib/purecloudplatformclientv2/models/web_chat_member_info.rb +445 -0
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/web_chat_message.rb +422 -0
- data/lib/purecloudplatformclientv2/models/web_chat_message_entity_list.rb +303 -0
- data/lib/purecloudplatformclientv2/models/web_chat_routing_target.rb +332 -0
- data/lib/purecloudplatformclientv2/models/web_chat_typing.rb +300 -0
- data/lib/purecloudplatformclientv2/models/widget_client_config.rb +26 -1
- data/lib/purecloudplatformclientv2/models/widget_client_config_v1_http.rb +240 -0
- data/lib/purecloudplatformclientv2/models/widget_deployment.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +80 -2
|
@@ -13,8 +13,8 @@ title: SurveyFormEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: SystemPromptAssetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: SystemPromptEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TagValueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -4297,6 +4297,7 @@ opts = {
|
|
|
4297
4297
|
phone_hardware_id: "phone_hardware_id_example", # String | Filter by phone_hardwareId
|
|
4298
4298
|
lines_id: "lines_id_example", # String | Filter by lines.id
|
|
4299
4299
|
lines_name: "lines_name_example", # String | Filter by lines.name
|
|
4300
|
+
name: "name_example", # String | Name of the Phone to filter by
|
|
4300
4301
|
expand: ["expand_example"], # Array<String> | Fields to expand in the response, comma-separated
|
|
4301
4302
|
fields: ["fields_example"] # Array<String> | Fields and properties to get, comma-separated
|
|
4302
4303
|
}
|
|
@@ -4326,6 +4327,7 @@ Name | Type | Description | Notes
|
|
|
4326
4327
|
**phone_hardware_id** | **String**| Filter by phone_hardwareId | [optional] |
|
|
4327
4328
|
**lines_id** | **String**| Filter by lines.id | [optional] |
|
|
4328
4329
|
**lines_name** | **String**| Filter by lines.name | [optional] |
|
|
4330
|
+
**name** | **String**| Name of the Phone to filter by | [optional] |
|
|
4329
4331
|
**expand** | [**Array<String>**](String.html)| Fields to expand in the response, comma-separated | [optional] <br />**Values**: properties, site, status, status.primaryEdgesStatus, status.secondaryEdgesStatus, phoneBaseSettings, lines |
|
|
4330
4332
|
**fields** | [**Array<String>**](String.html)| Fields and properties to get, comma-separated | [optional] <br />**Values**: webRtcUser, properties.*, lines.loggedInUser, lines.defaultForUser |
|
|
4331
4333
|
{: class="table table-striped"}
|
data/docs/TextMessageListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: TextMessageListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/TimeInterval.md
CHANGED
|
@@ -7,6 +7,8 @@ title: TimeInterval
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **months** | **Integer** | | [optional] |
|
|
11
|
+
| **weeks** | **Integer** | | [optional] |
|
|
10
12
|
| **days** | **Integer** | | [optional] |
|
|
11
13
|
| **hours** | **Integer** | | [optional] |
|
|
12
14
|
{: class="table table-striped"}
|
data/docs/TimeZone.md
CHANGED
|
@@ -9,8 +9,8 @@ title: TimeZone
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **display_name** | **String** | | [optional] |
|
|
11
11
|
| **id** | **String** | | [optional] |
|
|
12
|
-
| **dstsavings** | **Integer** | | [optional] |
|
|
13
12
|
| **raw_offset** | **Integer** | | [optional] |
|
|
13
|
+
| **dstsavings** | **Integer** | | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
|
@@ -13,8 +13,8 @@ title: TimeZoneEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TrunkBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/TrunkEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: TrunkEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TrunkMetabaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/TrustEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: TrustEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TrustUserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TrustorEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: TwitterIntegrationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserActionCategoryEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/UserEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: UserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserLanguageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserProfileEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserQueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserRecordingEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: VoicemailMessageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/WebChatApi.md
CHANGED
|
@@ -9,11 +9,22 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_webchat_deployment**](WebChatApi.html#delete_webchat_deployment) | Delete a WebChat deployment
|
|
12
|
+
[**delete_webchat_guest_conversation_member**](WebChatApi.html#delete_webchat_guest_conversation_member) | Remove a member from a chat conversation
|
|
12
13
|
[**delete_webchat_settings**](WebChatApi.html#delete_webchat_settings) | Remove WebChat deployment settings
|
|
13
14
|
[**get_webchat_deployment**](WebChatApi.html#get_webchat_deployment) | Get a WebChat deployment
|
|
14
15
|
[**get_webchat_deployments**](WebChatApi.html#get_webchat_deployments) | List WebChat deployments
|
|
16
|
+
[**get_webchat_guest_conversation_mediarequest**](WebChatApi.html#get_webchat_guest_conversation_mediarequest) | Get a media request in the conversation
|
|
17
|
+
[**get_webchat_guest_conversation_mediarequests**](WebChatApi.html#get_webchat_guest_conversation_mediarequests) | Get all media requests to the guest in the conversation
|
|
18
|
+
[**get_webchat_guest_conversation_member**](WebChatApi.html#get_webchat_guest_conversation_member) | Get a web chat conversation member
|
|
19
|
+
[**get_webchat_guest_conversation_members**](WebChatApi.html#get_webchat_guest_conversation_members) | Get the members of a chat conversation.
|
|
20
|
+
[**get_webchat_guest_conversation_message**](WebChatApi.html#get_webchat_guest_conversation_message) | Get a web chat conversation message
|
|
21
|
+
[**get_webchat_guest_conversation_messages**](WebChatApi.html#get_webchat_guest_conversation_messages) | Get the messages of a chat conversation.
|
|
15
22
|
[**get_webchat_settings**](WebChatApi.html#get_webchat_settings) | Get WebChat deployment settings
|
|
23
|
+
[**patch_webchat_guest_conversation_mediarequest**](WebChatApi.html#patch_webchat_guest_conversation_mediarequest) | Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
16
24
|
[**post_webchat_deployments**](WebChatApi.html#post_webchat_deployments) | Create WebChat deployment
|
|
25
|
+
[**post_webchat_guest_conversation_member_messages**](WebChatApi.html#post_webchat_guest_conversation_member_messages) | Send a message in a chat conversation.
|
|
26
|
+
[**post_webchat_guest_conversation_member_typing**](WebChatApi.html#post_webchat_guest_conversation_member_typing) | Send a typing-indicator in a chat conversation.
|
|
27
|
+
[**post_webchat_guest_conversations**](WebChatApi.html#post_webchat_guest_conversations) | Create an ACD chat conversation from an external customer.
|
|
17
28
|
[**put_webchat_deployment**](WebChatApi.html#put_webchat_deployment) | Update a WebChat deployment
|
|
18
29
|
[**put_webchat_settings**](WebChatApi.html#put_webchat_settings) | Update WebChat deployment settings
|
|
19
30
|
{: class="table table-striped"}
|
|
@@ -82,6 +93,72 @@ nil (empty response body)
|
|
|
82
93
|
|
|
83
94
|
|
|
84
95
|
|
|
96
|
+
<a name="delete_webchat_guest_conversation_member"></a>
|
|
97
|
+
|
|
98
|
+
## delete_webchat_guest_conversation_member(conversation_id, member_id)
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
Remove a member from a chat conversation
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
Wraps DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}
|
|
107
|
+
|
|
108
|
+
Requires NO permissions:
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Example
|
|
113
|
+
```{"language":"ruby"}
|
|
114
|
+
# load the gem
|
|
115
|
+
require 'purecloudplatformclientv2'
|
|
116
|
+
# setup authorization
|
|
117
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
118
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
119
|
+
environment = "mypurecloud.com"
|
|
120
|
+
|
|
121
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
122
|
+
|
|
123
|
+
PureCloud.configure do |config|
|
|
124
|
+
config.access_token = @authToken
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
api_instance = PureCloud::WebChatApi.new
|
|
128
|
+
|
|
129
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
130
|
+
|
|
131
|
+
member_id = "member_id_example" # String | memberId
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
begin
|
|
135
|
+
#Remove a member from a chat conversation
|
|
136
|
+
api_instance.delete_webchat_guest_conversation_member(conversation_id, member_id)
|
|
137
|
+
rescue PureCloud::ApiError => e
|
|
138
|
+
puts "Exception when calling WebChatApi->delete_webchat_guest_conversation_member: #{e}"
|
|
139
|
+
end
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
Name | Type | Description | Notes
|
|
145
|
+
------------- | ------------- | ------------- | -------------
|
|
146
|
+
**conversation_id** | **String**| conversationId | |
|
|
147
|
+
**member_id** | **String**| memberId | |
|
|
148
|
+
{: class="table table-striped"}
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
nil (empty response body)
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: application/json
|
|
158
|
+
- **Accept**: application/json
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
85
162
|
<a name="delete_webchat_settings"></a>
|
|
86
163
|
|
|
87
164
|
## delete_webchat_settings
|
|
@@ -264,21 +341,20 @@ This endpoint does not need any parameter.
|
|
|
264
341
|
|
|
265
342
|
|
|
266
343
|
|
|
267
|
-
<a name="
|
|
344
|
+
<a name="get_webchat_guest_conversation_mediarequest"></a>
|
|
268
345
|
|
|
269
|
-
## [**
|
|
346
|
+
## [**WebChatGuestMediaRequest**](WebChatGuestMediaRequest.html) get_webchat_guest_conversation_mediarequest(conversation_id, media_request_id)
|
|
270
347
|
|
|
271
348
|
|
|
272
349
|
|
|
273
|
-
Get
|
|
350
|
+
Get a media request in the conversation
|
|
274
351
|
|
|
275
352
|
|
|
276
353
|
|
|
277
|
-
Wraps GET /api/v2/webchat/
|
|
354
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}
|
|
278
355
|
|
|
279
|
-
Requires
|
|
356
|
+
Requires NO permissions:
|
|
280
357
|
|
|
281
|
-
* webchat:deployment:read
|
|
282
358
|
|
|
283
359
|
|
|
284
360
|
### Example
|
|
@@ -298,23 +374,32 @@ end
|
|
|
298
374
|
|
|
299
375
|
api_instance = PureCloud::WebChatApi.new
|
|
300
376
|
|
|
377
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
378
|
+
|
|
379
|
+
media_request_id = "media_request_id_example" # String | mediaRequestId
|
|
380
|
+
|
|
381
|
+
|
|
301
382
|
begin
|
|
302
|
-
#Get
|
|
303
|
-
result = api_instance.
|
|
383
|
+
#Get a media request in the conversation
|
|
384
|
+
result = api_instance.get_webchat_guest_conversation_mediarequest(conversation_id, media_request_id)
|
|
304
385
|
p result
|
|
305
386
|
rescue PureCloud::ApiError => e
|
|
306
|
-
puts "Exception when calling WebChatApi->
|
|
387
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_mediarequest: #{e}"
|
|
307
388
|
end
|
|
308
389
|
```
|
|
309
390
|
|
|
310
391
|
### Parameters
|
|
311
|
-
|
|
392
|
+
|
|
393
|
+
Name | Type | Description | Notes
|
|
394
|
+
------------- | ------------- | ------------- | -------------
|
|
395
|
+
**conversation_id** | **String**| conversationId | |
|
|
396
|
+
**media_request_id** | **String**| mediaRequestId | |
|
|
312
397
|
{: class="table table-striped"}
|
|
313
398
|
|
|
314
399
|
|
|
315
400
|
### Return type
|
|
316
401
|
|
|
317
|
-
[**
|
|
402
|
+
[**WebChatGuestMediaRequest**](WebChatGuestMediaRequest.html)
|
|
318
403
|
|
|
319
404
|
### HTTP request headers
|
|
320
405
|
|
|
@@ -323,21 +408,20 @@ This endpoint does not need any parameter.
|
|
|
323
408
|
|
|
324
409
|
|
|
325
410
|
|
|
326
|
-
<a name="
|
|
411
|
+
<a name="get_webchat_guest_conversation_mediarequests"></a>
|
|
327
412
|
|
|
328
|
-
## [**
|
|
413
|
+
## [**WebChatGuestMediaRequestEntityList**](WebChatGuestMediaRequestEntityList.html) get_webchat_guest_conversation_mediarequests(conversation_id)
|
|
329
414
|
|
|
330
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
331
415
|
|
|
332
|
-
Create WebChat deployment
|
|
333
416
|
|
|
417
|
+
Get all media requests to the guest in the conversation
|
|
334
418
|
|
|
335
419
|
|
|
336
|
-
Wraps POST /api/v2/webchat/deployments
|
|
337
420
|
|
|
338
|
-
|
|
421
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests
|
|
422
|
+
|
|
423
|
+
Requires NO permissions:
|
|
339
424
|
|
|
340
|
-
* webchat:deployment:create
|
|
341
425
|
|
|
342
426
|
|
|
343
427
|
### Example
|
|
@@ -357,15 +441,15 @@ end
|
|
|
357
441
|
|
|
358
442
|
api_instance = PureCloud::WebChatApi.new
|
|
359
443
|
|
|
360
|
-
|
|
444
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
361
445
|
|
|
362
446
|
|
|
363
447
|
begin
|
|
364
|
-
#
|
|
365
|
-
result = api_instance.
|
|
448
|
+
#Get all media requests to the guest in the conversation
|
|
449
|
+
result = api_instance.get_webchat_guest_conversation_mediarequests(conversation_id)
|
|
366
450
|
p result
|
|
367
451
|
rescue PureCloud::ApiError => e
|
|
368
|
-
puts "Exception when calling WebChatApi->
|
|
452
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_mediarequests: #{e}"
|
|
369
453
|
end
|
|
370
454
|
```
|
|
371
455
|
|
|
@@ -373,13 +457,678 @@ end
|
|
|
373
457
|
|
|
374
458
|
Name | Type | Description | Notes
|
|
375
459
|
------------- | ------------- | ------------- | -------------
|
|
376
|
-
**
|
|
460
|
+
**conversation_id** | **String**| conversationId | |
|
|
377
461
|
{: class="table table-striped"}
|
|
378
462
|
|
|
379
463
|
|
|
380
464
|
### Return type
|
|
381
465
|
|
|
382
|
-
[**
|
|
466
|
+
[**WebChatGuestMediaRequestEntityList**](WebChatGuestMediaRequestEntityList.html)
|
|
467
|
+
|
|
468
|
+
### HTTP request headers
|
|
469
|
+
|
|
470
|
+
- **Content-Type**: application/json
|
|
471
|
+
- **Accept**: application/json
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<a name="get_webchat_guest_conversation_member"></a>
|
|
476
|
+
|
|
477
|
+
## [**WebChatMemberInfo**](WebChatMemberInfo.html) get_webchat_guest_conversation_member(conversation_id, member_id)
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
Get a web chat conversation member
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}
|
|
486
|
+
|
|
487
|
+
Requires NO permissions:
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
### Example
|
|
492
|
+
```{"language":"ruby"}
|
|
493
|
+
# load the gem
|
|
494
|
+
require 'purecloudplatformclientv2'
|
|
495
|
+
# setup authorization
|
|
496
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
497
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
498
|
+
environment = "mypurecloud.com"
|
|
499
|
+
|
|
500
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
501
|
+
|
|
502
|
+
PureCloud.configure do |config|
|
|
503
|
+
config.access_token = @authToken
|
|
504
|
+
end
|
|
505
|
+
|
|
506
|
+
api_instance = PureCloud::WebChatApi.new
|
|
507
|
+
|
|
508
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
509
|
+
|
|
510
|
+
member_id = "member_id_example" # String | memberId
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
begin
|
|
514
|
+
#Get a web chat conversation member
|
|
515
|
+
result = api_instance.get_webchat_guest_conversation_member(conversation_id, member_id)
|
|
516
|
+
p result
|
|
517
|
+
rescue PureCloud::ApiError => e
|
|
518
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_member: #{e}"
|
|
519
|
+
end
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
### Parameters
|
|
523
|
+
|
|
524
|
+
Name | Type | Description | Notes
|
|
525
|
+
------------- | ------------- | ------------- | -------------
|
|
526
|
+
**conversation_id** | **String**| conversationId | |
|
|
527
|
+
**member_id** | **String**| memberId | |
|
|
528
|
+
{: class="table table-striped"}
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
### Return type
|
|
532
|
+
|
|
533
|
+
[**WebChatMemberInfo**](WebChatMemberInfo.html)
|
|
534
|
+
|
|
535
|
+
### HTTP request headers
|
|
536
|
+
|
|
537
|
+
- **Content-Type**: application/json
|
|
538
|
+
- **Accept**: application/json
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<a name="get_webchat_guest_conversation_members"></a>
|
|
543
|
+
|
|
544
|
+
## [**WebChatMemberInfoEntityList**](WebChatMemberInfoEntityList.html) get_webchat_guest_conversation_members(conversation_id, opts)
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
Get the members of a chat conversation.
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/members
|
|
553
|
+
|
|
554
|
+
Requires NO permissions:
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
### Example
|
|
559
|
+
```{"language":"ruby"}
|
|
560
|
+
# load the gem
|
|
561
|
+
require 'purecloudplatformclientv2'
|
|
562
|
+
# setup authorization
|
|
563
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
564
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
565
|
+
environment = "mypurecloud.com"
|
|
566
|
+
|
|
567
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
568
|
+
|
|
569
|
+
PureCloud.configure do |config|
|
|
570
|
+
config.access_token = @authToken
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
api_instance = PureCloud::WebChatApi.new
|
|
574
|
+
|
|
575
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
576
|
+
|
|
577
|
+
opts = {
|
|
578
|
+
page_size: 25, # Integer | The number of entries to return per page, or omitted for the default.
|
|
579
|
+
page_number: 1, # Integer | The page number to return, or omitted for the first page.
|
|
580
|
+
exclude_disconnected_members: false # BOOLEAN | If true, the results will not contain members who have a DISCONNECTED state.
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
begin
|
|
584
|
+
#Get the members of a chat conversation.
|
|
585
|
+
result = api_instance.get_webchat_guest_conversation_members(conversation_id, opts)
|
|
586
|
+
p result
|
|
587
|
+
rescue PureCloud::ApiError => e
|
|
588
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_members: #{e}"
|
|
589
|
+
end
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
### Parameters
|
|
593
|
+
|
|
594
|
+
Name | Type | Description | Notes
|
|
595
|
+
------------- | ------------- | ------------- | -------------
|
|
596
|
+
**conversation_id** | **String**| conversationId | |
|
|
597
|
+
**page_size** | **Integer**| The number of entries to return per page, or omitted for the default. | [optional] [default to 25] |
|
|
598
|
+
**page_number** | **Integer**| The page number to return, or omitted for the first page. | [optional] [default to 1] |
|
|
599
|
+
**exclude_disconnected_members** | **BOOLEAN**| If true, the results will not contain members who have a DISCONNECTED state. | [optional] [default to false] |
|
|
600
|
+
{: class="table table-striped"}
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
### Return type
|
|
604
|
+
|
|
605
|
+
[**WebChatMemberInfoEntityList**](WebChatMemberInfoEntityList.html)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: application/json
|
|
610
|
+
- **Accept**: application/json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<a name="get_webchat_guest_conversation_message"></a>
|
|
615
|
+
|
|
616
|
+
## [**WebChatMessage**](WebChatMessage.html) get_webchat_guest_conversation_message(conversation_id, message_id)
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
Get a web chat conversation message
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}
|
|
625
|
+
|
|
626
|
+
Requires NO permissions:
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
### Example
|
|
631
|
+
```{"language":"ruby"}
|
|
632
|
+
# load the gem
|
|
633
|
+
require 'purecloudplatformclientv2'
|
|
634
|
+
# setup authorization
|
|
635
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
636
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
637
|
+
environment = "mypurecloud.com"
|
|
638
|
+
|
|
639
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
640
|
+
|
|
641
|
+
PureCloud.configure do |config|
|
|
642
|
+
config.access_token = @authToken
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
api_instance = PureCloud::WebChatApi.new
|
|
646
|
+
|
|
647
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
648
|
+
|
|
649
|
+
message_id = "message_id_example" # String | messageId
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
begin
|
|
653
|
+
#Get a web chat conversation message
|
|
654
|
+
result = api_instance.get_webchat_guest_conversation_message(conversation_id, message_id)
|
|
655
|
+
p result
|
|
656
|
+
rescue PureCloud::ApiError => e
|
|
657
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_message: #{e}"
|
|
658
|
+
end
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
### Parameters
|
|
662
|
+
|
|
663
|
+
Name | Type | Description | Notes
|
|
664
|
+
------------- | ------------- | ------------- | -------------
|
|
665
|
+
**conversation_id** | **String**| conversationId | |
|
|
666
|
+
**message_id** | **String**| messageId | |
|
|
667
|
+
{: class="table table-striped"}
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
### Return type
|
|
671
|
+
|
|
672
|
+
[**WebChatMessage**](WebChatMessage.html)
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: application/json
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<a name="get_webchat_guest_conversation_messages"></a>
|
|
682
|
+
|
|
683
|
+
## [**WebChatMessageEntityList**](WebChatMessageEntityList.html) get_webchat_guest_conversation_messages(conversation_id, opts)
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
Get the messages of a chat conversation.
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
Wraps GET /api/v2/webchat/guest/conversations/{conversationId}/messages
|
|
692
|
+
|
|
693
|
+
Requires NO permissions:
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
### Example
|
|
698
|
+
```{"language":"ruby"}
|
|
699
|
+
# load the gem
|
|
700
|
+
require 'purecloudplatformclientv2'
|
|
701
|
+
# setup authorization
|
|
702
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
703
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
704
|
+
environment = "mypurecloud.com"
|
|
705
|
+
|
|
706
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
707
|
+
|
|
708
|
+
PureCloud.configure do |config|
|
|
709
|
+
config.access_token = @authToken
|
|
710
|
+
end
|
|
711
|
+
|
|
712
|
+
api_instance = PureCloud::WebChatApi.new
|
|
713
|
+
|
|
714
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
715
|
+
|
|
716
|
+
opts = {
|
|
717
|
+
after: "after_example", # String | If available, get the messages chronologically after the id of this message
|
|
718
|
+
before: "before_example", # String | If available, get the messages chronologically before the id of this message
|
|
719
|
+
sort_order: "ascending", # String | Sort order
|
|
720
|
+
max_results: 100 # Integer | Limit the returned number of messages, up to a maximum of 100
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
begin
|
|
724
|
+
#Get the messages of a chat conversation.
|
|
725
|
+
result = api_instance.get_webchat_guest_conversation_messages(conversation_id, opts)
|
|
726
|
+
p result
|
|
727
|
+
rescue PureCloud::ApiError => e
|
|
728
|
+
puts "Exception when calling WebChatApi->get_webchat_guest_conversation_messages: #{e}"
|
|
729
|
+
end
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
### Parameters
|
|
733
|
+
|
|
734
|
+
Name | Type | Description | Notes
|
|
735
|
+
------------- | ------------- | ------------- | -------------
|
|
736
|
+
**conversation_id** | **String**| conversationId | |
|
|
737
|
+
**after** | **String**| If available, get the messages chronologically after the id of this message | [optional] |
|
|
738
|
+
**before** | **String**| If available, get the messages chronologically before the id of this message | [optional] |
|
|
739
|
+
**sort_order** | **String**| Sort order | [optional] [default to ascending]<br />**Values**: ascending, descending |
|
|
740
|
+
**max_results** | **Integer**| Limit the returned number of messages, up to a maximum of 100 | [optional] [default to 100] |
|
|
741
|
+
{: class="table table-striped"}
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
### Return type
|
|
745
|
+
|
|
746
|
+
[**WebChatMessageEntityList**](WebChatMessageEntityList.html)
|
|
747
|
+
|
|
748
|
+
### HTTP request headers
|
|
749
|
+
|
|
750
|
+
- **Content-Type**: application/json
|
|
751
|
+
- **Accept**: application/json
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
<a name="get_webchat_settings"></a>
|
|
756
|
+
|
|
757
|
+
## [**WebChatSettings**](WebChatSettings.html) get_webchat_settings
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
Get WebChat deployment settings
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
Wraps GET /api/v2/webchat/settings
|
|
766
|
+
|
|
767
|
+
Requires ANY permissions:
|
|
768
|
+
|
|
769
|
+
* webchat:deployment:read
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
### Example
|
|
773
|
+
```{"language":"ruby"}
|
|
774
|
+
# load the gem
|
|
775
|
+
require 'purecloudplatformclientv2'
|
|
776
|
+
# setup authorization
|
|
777
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
778
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
779
|
+
environment = "mypurecloud.com"
|
|
780
|
+
|
|
781
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
782
|
+
|
|
783
|
+
PureCloud.configure do |config|
|
|
784
|
+
config.access_token = @authToken
|
|
785
|
+
end
|
|
786
|
+
|
|
787
|
+
api_instance = PureCloud::WebChatApi.new
|
|
788
|
+
|
|
789
|
+
begin
|
|
790
|
+
#Get WebChat deployment settings
|
|
791
|
+
result = api_instance.get_webchat_settings
|
|
792
|
+
p result
|
|
793
|
+
rescue PureCloud::ApiError => e
|
|
794
|
+
puts "Exception when calling WebChatApi->get_webchat_settings: #{e}"
|
|
795
|
+
end
|
|
796
|
+
```
|
|
797
|
+
|
|
798
|
+
### Parameters
|
|
799
|
+
This endpoint does not need any parameter.
|
|
800
|
+
{: class="table table-striped"}
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
### Return type
|
|
804
|
+
|
|
805
|
+
[**WebChatSettings**](WebChatSettings.html)
|
|
806
|
+
|
|
807
|
+
### HTTP request headers
|
|
808
|
+
|
|
809
|
+
- **Content-Type**: application/json
|
|
810
|
+
- **Accept**: application/json
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
<a name="patch_webchat_guest_conversation_mediarequest"></a>
|
|
815
|
+
|
|
816
|
+
## [**WebChatGuestMediaRequest**](WebChatGuestMediaRequest.html) patch_webchat_guest_conversation_mediarequest(conversation_id, media_request_id, body)
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
Wraps PATCH /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}
|
|
825
|
+
|
|
826
|
+
Requires NO permissions:
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
### Example
|
|
831
|
+
```{"language":"ruby"}
|
|
832
|
+
# load the gem
|
|
833
|
+
require 'purecloudplatformclientv2'
|
|
834
|
+
# setup authorization
|
|
835
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
836
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
837
|
+
environment = "mypurecloud.com"
|
|
838
|
+
|
|
839
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
840
|
+
|
|
841
|
+
PureCloud.configure do |config|
|
|
842
|
+
config.access_token = @authToken
|
|
843
|
+
end
|
|
844
|
+
|
|
845
|
+
api_instance = PureCloud::WebChatApi.new
|
|
846
|
+
|
|
847
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
848
|
+
|
|
849
|
+
media_request_id = "media_request_id_example" # String | mediaRequestId
|
|
850
|
+
|
|
851
|
+
body = PureCloud::WebChatGuestMediaRequest.new # WebChatGuestMediaRequest | Request
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
begin
|
|
855
|
+
#Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
856
|
+
result = api_instance.patch_webchat_guest_conversation_mediarequest(conversation_id, media_request_id, body)
|
|
857
|
+
p result
|
|
858
|
+
rescue PureCloud::ApiError => e
|
|
859
|
+
puts "Exception when calling WebChatApi->patch_webchat_guest_conversation_mediarequest: #{e}"
|
|
860
|
+
end
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
### Parameters
|
|
864
|
+
|
|
865
|
+
Name | Type | Description | Notes
|
|
866
|
+
------------- | ------------- | ------------- | -------------
|
|
867
|
+
**conversation_id** | **String**| conversationId | |
|
|
868
|
+
**media_request_id** | **String**| mediaRequestId | |
|
|
869
|
+
**body** | [**WebChatGuestMediaRequest**](WebChatGuestMediaRequest.html)| Request | |
|
|
870
|
+
{: class="table table-striped"}
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
### Return type
|
|
874
|
+
|
|
875
|
+
[**WebChatGuestMediaRequest**](WebChatGuestMediaRequest.html)
|
|
876
|
+
|
|
877
|
+
### HTTP request headers
|
|
878
|
+
|
|
879
|
+
- **Content-Type**: application/json
|
|
880
|
+
- **Accept**: application/json
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<a name="post_webchat_deployments"></a>
|
|
885
|
+
|
|
886
|
+
## [**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
|
|
887
|
+
|
|
888
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
889
|
+
|
|
890
|
+
Create WebChat deployment
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
Wraps POST /api/v2/webchat/deployments
|
|
895
|
+
|
|
896
|
+
Requires ANY permissions:
|
|
897
|
+
|
|
898
|
+
* webchat:deployment:create
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
### Example
|
|
902
|
+
```{"language":"ruby"}
|
|
903
|
+
# load the gem
|
|
904
|
+
require 'purecloudplatformclientv2'
|
|
905
|
+
# setup authorization
|
|
906
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
907
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
908
|
+
environment = "mypurecloud.com"
|
|
909
|
+
|
|
910
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
911
|
+
|
|
912
|
+
PureCloud.configure do |config|
|
|
913
|
+
config.access_token = @authToken
|
|
914
|
+
end
|
|
915
|
+
|
|
916
|
+
api_instance = PureCloud::WebChatApi.new
|
|
917
|
+
|
|
918
|
+
body = PureCloud::WebChatDeployment.new # WebChatDeployment | Deployment
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
begin
|
|
922
|
+
#Create WebChat deployment
|
|
923
|
+
result = api_instance.post_webchat_deployments(body)
|
|
924
|
+
p result
|
|
925
|
+
rescue PureCloud::ApiError => e
|
|
926
|
+
puts "Exception when calling WebChatApi->post_webchat_deployments: #{e}"
|
|
927
|
+
end
|
|
928
|
+
```
|
|
929
|
+
|
|
930
|
+
### Parameters
|
|
931
|
+
|
|
932
|
+
Name | Type | Description | Notes
|
|
933
|
+
------------- | ------------- | ------------- | -------------
|
|
934
|
+
**body** | [**WebChatDeployment**](WebChatDeployment.html)| Deployment | |
|
|
935
|
+
{: class="table table-striped"}
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
### Return type
|
|
939
|
+
|
|
940
|
+
[**WebChatDeployment**](WebChatDeployment.html)
|
|
941
|
+
|
|
942
|
+
### HTTP request headers
|
|
943
|
+
|
|
944
|
+
- **Content-Type**: application/json
|
|
945
|
+
- **Accept**: application/json
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
<a name="post_webchat_guest_conversation_member_messages"></a>
|
|
950
|
+
|
|
951
|
+
## [**WebChatMessage**](WebChatMessage.html) post_webchat_guest_conversation_member_messages(conversation_id, member_id, body)
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
Send a message in a chat conversation.
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
Wraps POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages
|
|
960
|
+
|
|
961
|
+
Requires NO permissions:
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
### Example
|
|
966
|
+
```{"language":"ruby"}
|
|
967
|
+
# load the gem
|
|
968
|
+
require 'purecloudplatformclientv2'
|
|
969
|
+
# setup authorization
|
|
970
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
971
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
972
|
+
environment = "mypurecloud.com"
|
|
973
|
+
|
|
974
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
975
|
+
|
|
976
|
+
PureCloud.configure do |config|
|
|
977
|
+
config.access_token = @authToken
|
|
978
|
+
end
|
|
979
|
+
|
|
980
|
+
api_instance = PureCloud::WebChatApi.new
|
|
981
|
+
|
|
982
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
983
|
+
|
|
984
|
+
member_id = "member_id_example" # String | memberId
|
|
985
|
+
|
|
986
|
+
body = PureCloud::CreateWebChatMessageRequest.new # CreateWebChatMessageRequest | Message
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
begin
|
|
990
|
+
#Send a message in a chat conversation.
|
|
991
|
+
result = api_instance.post_webchat_guest_conversation_member_messages(conversation_id, member_id, body)
|
|
992
|
+
p result
|
|
993
|
+
rescue PureCloud::ApiError => e
|
|
994
|
+
puts "Exception when calling WebChatApi->post_webchat_guest_conversation_member_messages: #{e}"
|
|
995
|
+
end
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### Parameters
|
|
999
|
+
|
|
1000
|
+
Name | Type | Description | Notes
|
|
1001
|
+
------------- | ------------- | ------------- | -------------
|
|
1002
|
+
**conversation_id** | **String**| conversationId | |
|
|
1003
|
+
**member_id** | **String**| memberId | |
|
|
1004
|
+
**body** | [**CreateWebChatMessageRequest**](CreateWebChatMessageRequest.html)| Message | |
|
|
1005
|
+
{: class="table table-striped"}
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
### Return type
|
|
1009
|
+
|
|
1010
|
+
[**WebChatMessage**](WebChatMessage.html)
|
|
1011
|
+
|
|
1012
|
+
### HTTP request headers
|
|
1013
|
+
|
|
1014
|
+
- **Content-Type**: application/json
|
|
1015
|
+
- **Accept**: application/json
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
<a name="post_webchat_guest_conversation_member_typing"></a>
|
|
1020
|
+
|
|
1021
|
+
## [**WebChatTyping**](WebChatTyping.html) post_webchat_guest_conversation_member_typing(conversation_id, member_id)
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
Send a typing-indicator in a chat conversation.
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
Wraps POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing
|
|
1030
|
+
|
|
1031
|
+
Requires NO permissions:
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
### Example
|
|
1036
|
+
```{"language":"ruby"}
|
|
1037
|
+
# load the gem
|
|
1038
|
+
require 'purecloudplatformclientv2'
|
|
1039
|
+
# setup authorization
|
|
1040
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1041
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1042
|
+
environment = "mypurecloud.com"
|
|
1043
|
+
|
|
1044
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1045
|
+
|
|
1046
|
+
PureCloud.configure do |config|
|
|
1047
|
+
config.access_token = @authToken
|
|
1048
|
+
end
|
|
1049
|
+
|
|
1050
|
+
api_instance = PureCloud::WebChatApi.new
|
|
1051
|
+
|
|
1052
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1053
|
+
|
|
1054
|
+
member_id = "member_id_example" # String | memberId
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
begin
|
|
1058
|
+
#Send a typing-indicator in a chat conversation.
|
|
1059
|
+
result = api_instance.post_webchat_guest_conversation_member_typing(conversation_id, member_id)
|
|
1060
|
+
p result
|
|
1061
|
+
rescue PureCloud::ApiError => e
|
|
1062
|
+
puts "Exception when calling WebChatApi->post_webchat_guest_conversation_member_typing: #{e}"
|
|
1063
|
+
end
|
|
1064
|
+
```
|
|
1065
|
+
|
|
1066
|
+
### Parameters
|
|
1067
|
+
|
|
1068
|
+
Name | Type | Description | Notes
|
|
1069
|
+
------------- | ------------- | ------------- | -------------
|
|
1070
|
+
**conversation_id** | **String**| conversationId | |
|
|
1071
|
+
**member_id** | **String**| memberId | |
|
|
1072
|
+
{: class="table table-striped"}
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
### Return type
|
|
1076
|
+
|
|
1077
|
+
[**WebChatTyping**](WebChatTyping.html)
|
|
1078
|
+
|
|
1079
|
+
### HTTP request headers
|
|
1080
|
+
|
|
1081
|
+
- **Content-Type**: application/json
|
|
1082
|
+
- **Accept**: application/json
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
<a name="post_webchat_guest_conversations"></a>
|
|
1087
|
+
|
|
1088
|
+
## [**CreateWebChatConversationResponse**](CreateWebChatConversationResponse.html) post_webchat_guest_conversations(body)
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
Create an ACD chat conversation from an external customer.
|
|
1093
|
+
|
|
1094
|
+
This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.
|
|
1095
|
+
|
|
1096
|
+
Wraps POST /api/v2/webchat/guest/conversations
|
|
1097
|
+
|
|
1098
|
+
Requires NO permissions:
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
### Example
|
|
1103
|
+
```{"language":"ruby"}
|
|
1104
|
+
# load the gem
|
|
1105
|
+
require 'purecloudplatformclientv2'
|
|
1106
|
+
|
|
1107
|
+
api_instance = PureCloud::WebChatApi.new
|
|
1108
|
+
|
|
1109
|
+
body = PureCloud::CreateWebChatConversationRequest.new # CreateWebChatConversationRequest | CreateConversationRequest
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
begin
|
|
1113
|
+
#Create an ACD chat conversation from an external customer.
|
|
1114
|
+
result = api_instance.post_webchat_guest_conversations(body)
|
|
1115
|
+
p result
|
|
1116
|
+
rescue PureCloud::ApiError => e
|
|
1117
|
+
puts "Exception when calling WebChatApi->post_webchat_guest_conversations: #{e}"
|
|
1118
|
+
end
|
|
1119
|
+
```
|
|
1120
|
+
|
|
1121
|
+
### Parameters
|
|
1122
|
+
|
|
1123
|
+
Name | Type | Description | Notes
|
|
1124
|
+
------------- | ------------- | ------------- | -------------
|
|
1125
|
+
**body** | [**CreateWebChatConversationRequest**](CreateWebChatConversationRequest.html)| CreateConversationRequest | |
|
|
1126
|
+
{: class="table table-striped"}
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
### Return type
|
|
1130
|
+
|
|
1131
|
+
[**CreateWebChatConversationResponse**](CreateWebChatConversationResponse.html)
|
|
383
1132
|
|
|
384
1133
|
### HTTP request headers
|
|
385
1134
|
|