purecloudplatformclientv2 61.0.0 → 62.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 +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AnalyticsApi.md +267 -0
- data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ArrayNode.md +7 -7
- data/docs/AsyncQueryResponse.md +13 -0
- data/docs/AsyncQueryStatus.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/Attribute.md +2 -2
- data/docs/AuthorizationApi.md +6 -2
- data/docs/AuthzDivisionEntityListing.md +2 -2
- data/docs/BillingApi.md +4 -4
- data/docs/BillingUsageReport.md +1 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallMediaParticipant.md +6 -6
- data/docs/CallableContactsDiagnostic.md +4 -4
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CallbackMediaParticipant.md +5 -5
- data/docs/Campaign.md +11 -11
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignInteraction.md +6 -6
- data/docs/CampaignInteractions.md +1 -1
- data/docs/CampaignProgress.md +2 -2
- data/docs/CampaignRuleActionEntities.md +2 -2
- data/docs/CampaignRuleEntities.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSchedule.md +1 -1
- data/docs/CampaignSequence.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ChatMediaParticipant.md +5 -5
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CobrowseMediaParticipant.md +5 -5
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactList.md +2 -2
- data/docs/ContactListDivisionViewListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilter.md +1 -1
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationDivisionMembership.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationsApi.md +471 -0
- data/docs/CreateCallbackResponse.md +1 -1
- data/docs/CreateQueueRequest.md +2 -2
- data/docs/CreateShareResponse.md +4 -4
- data/docs/CreateUser.md +1 -0
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/DID.md +2 -2
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataSchema.md +1 -1
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DialogflowAgentSummaryEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncList.md +1 -1
- data/docs/DncListCreate.md +1 -1
- data/docs/DncListDivisionViewListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/Document.md +4 -4
- data/docs/DocumentAudit.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DocumentUpload.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/{UriReference.md → DomainEntityRef.md} +2 -2
- data/docs/DomainOrganizationRole.md +1 -0
- data/docs/DomainOrganizationRoleCreate.md +1 -0
- data/docs/DomainOrganizationRoleUpdate.md +1 -0
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeInterface.md +1 -1
- data/docs/EdgeLine.md +1 -1
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EdgeMetrics.md +1 -1
- data/docs/EdgeTrunkBase.md +1 -1
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMediaParticipant.md +5 -5
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyCallFlow.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/Endpoint.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/EventLog.md +2 -2
- data/docs/Extension.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegration.md +3 -3
- data/docs/FacebookIntegrationEntityListing.md +2 -2
- data/docs/FaxDocument.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowOutcomeListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GDPRRequest.md +1 -1
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +1 -1
- data/docs/IVR.md +4 -4
- data/docs/IVREntityListing.md +2 -2
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRoute.md +5 -5
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationExport.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +7 -7
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LexBotAliasEntityListing.md +2 -2
- data/docs/LexBotEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/Line.md +6 -6
- data/docs/LineBase.md +1 -1
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegration.md +3 -3
- data/docs/LineIntegrationEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LockInfo.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/Manager.md +1 -1
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessageMediaParticipant.md +5 -5
- data/docs/MessagingIntegration.md +3 -3
- data/docs/MessagingIntegrationEntityListing.md +2 -2
- data/docs/MessagingStickerEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClient.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthClientListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrgOAuthClient.md +2 -2
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundApi.md +4 -4
- data/docs/OutboundRoute.md +1 -1
- data/docs/OutboundRouteBase.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/Phone.md +5 -5
- data/docs/PhoneBase.md +1 -1
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhoneStatus.md +1 -1
- data/docs/Photo.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/Queue.md +2 -2
- data/docs/QueueEmailAddress.md +1 -1
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/QueueMessagingAddresses.md +1 -1
- data/docs/QueueRequest.md +2 -2
- data/docs/QueueUtilizationDiagnostic.md +1 -1
- data/docs/RecipientListing.md +2 -2
- data/docs/RecordingJobEntityListing.md +2 -2
- data/docs/RecordingJobsQuery.md +2 -1
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReplaceResponse.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/Response.md +1 -1
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +3 -1
- data/docs/RuleSet.md +2 -2
- data/docs/RuleSetDiagnostic.md +1 -1
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroup.md +3 -3
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScimGroupListResponse.md +4 -4
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimUserListResponse.md +4 -4
- data/docs/ScimV2CreateUser.md +2 -3
- data/docs/ScimV2Group.md +2 -2
- data/docs/ScimV2GroupReference.md +2 -3
- data/docs/ScimV2MemberReference.md +2 -3
- data/docs/ScimV2User.md +4 -4
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchApi.md +2 -2
- data/docs/SecureSession.md +1 -1
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/SequenceSchedule.md +1 -1
- data/docs/Share.md +4 -4
- data/docs/ShareEntityListing.md +2 -2
- data/docs/Site.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsAddressEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/SpeechTextAnalyticsApi.md +80 -0
- data/docs/Station.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SuggestApi.md +2 -2
- data/docs/Survey.md +1 -1
- data/docs/SurveyAssignment.md +1 -1
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TimeZoneMappingPreview.md +1 -1
- data/docs/TranscriptProperty.md +15 -0
- data/docs/Trunk.md +5 -5
- data/docs/TrunkBase.md +1 -1
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrunkMetrics.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TtsEngineEntityListing.md +2 -2
- data/docs/TtsVoiceEntityListing.md +2 -2
- data/docs/TwitterIntegration.md +3 -3
- data/docs/TwitterIntegrationEntityListing.md +2 -2
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserAuthorization.md +1 -0
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueue.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecording.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +9 -9
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WebChatDeployment.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +2 -2
- data/docs/WhatsAppIntegration.md +25 -0
- data/docs/WhatsAppIntegrationEntityListing.md +22 -0
- data/docs/WhatsAppIntegrationUpdateRequest.md +18 -0
- data/docs/WidgetDeployment.md +1 -1
- data/docs/Workspace.md +1 -1
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMember.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/lib/purecloudplatformclientv2.rb +9 -1
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +268 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +481 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +229 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +75 -75
- data/lib/purecloudplatformclientv2/models/async_query_response.rb +202 -0
- data/lib/purecloudplatformclientv2/models/async_query_status.rb +320 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +6 -6
- data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +4 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/campaign.rb +11 -11
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +6 -6
- data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/create_share_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/create_user.rb +44 -4
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did.rb +2 -2
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document.rb +4 -4
- data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +28 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +28 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +28 -1
- data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_metrics.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/json_node.rb +75 -75
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line.rb +6 -6
- data/lib/purecloudplatformclientv2/models/line_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/manager.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone.rb +5 -5
- data/lib/purecloudplatformclientv2/models/phone_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
- data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_email_address.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +27 -6
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/rule_set.rb +2 -2
- data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +17 -17
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/share.rb +4 -4
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/site.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/station.rb +2 -2
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
- data/lib/purecloudplatformclientv2/models/transcript_property.rb +254 -0
- data/lib/purecloudplatformclientv2/models/trunk.rb +5 -5
- data/lib/purecloudplatformclientv2/models/trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +28 -1
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/whats_app_integration.rb +562 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_update_request.rb +365 -0
- data/lib/purecloudplatformclientv2/models/widget_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +20 -4
data/docs/SecureSession.md
CHANGED
@@ -8,7 +8,7 @@ title: SecureSession
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **flow** | [**
|
11
|
+
| **flow** | [**DomainEntityRef**](DomainEntityRef.html) | The flow to execute securely | |
|
12
12
|
| **user_data** | **String** | Customer-provided data | [optional] |
|
13
13
|
| **state** | **String** | The current state of a secure session | |
|
14
14
|
| **source_participant_id** | **String** | Unique identifier for the participant initiating the secure session. | [optional] |
|
@@ -13,9 +13,9 @@ title: SecurityProfileEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/SequenceSchedule.md
CHANGED
@@ -14,7 +14,7 @@ title: SequenceSchedule
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
15
15
|
| **intervals** | [**Array<ScheduleInterval>**](ScheduleInterval.html) | A list of intervals during which to run the associated CampaignSequence. | |
|
16
16
|
| **time_zone** | **String** | The time zone for this SequenceSchedule. For example, Africa/Abidjan. | |
|
17
|
-
| **sequence** | [**
|
17
|
+
| **sequence** | [**DomainEntityRef**](DomainEntityRef.html) | The CampaignSequence that this SequenceSchedule is for. | |
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
19
19
|
{: class="table table-striped"}
|
20
20
|
|
data/docs/Share.md
CHANGED
@@ -10,11 +10,11 @@ title: Share
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **shared_entity_type** | **String** | | [optional] |
|
13
|
-
| **shared_entity** | [**
|
13
|
+
| **shared_entity** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
14
14
|
| **member_type** | **String** | | [optional] |
|
15
|
-
| **member** | [**
|
16
|
-
| **shared_by** | [**
|
17
|
-
| **workspace** | [**
|
15
|
+
| **member** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
16
|
+
| **shared_by** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
17
|
+
| **workspace** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
18
18
|
| **user** | [**User**](User.html) | | [optional] |
|
19
19
|
| **group** | [**Group**](Group.html) | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
data/docs/ShareEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: ShareEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/Site.md
CHANGED
@@ -18,8 +18,8 @@ title: Site
|
|
18
18
|
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
19
19
|
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
20
20
|
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
21
|
-
| **primary_sites** | [**Array<
|
22
|
-
| **secondary_sites** | [**Array<
|
21
|
+
| **primary_sites** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | | [optional] |
|
22
|
+
| **secondary_sites** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | | [optional] |
|
23
23
|
| **primary_edges** | [**Array<Edge>**](Edge.html) | | [optional] |
|
24
24
|
| **secondary_edges** | [**Array<Edge>**](Edge.html) | | [optional] |
|
25
25
|
| **addresses** | [**Array<Contact>**](Contact.html) | | [optional] |
|
data/docs/SiteEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: SiteEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/SkillEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: SkillEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SmsAddressEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SmsPhoneNumberEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -0,0 +1,80 @@
|
|
1
|
+
---
|
2
|
+
title: SpeechTextAnalyticsApi
|
3
|
+
---
|
4
|
+
|
5
|
+
## PureCloud::SpeechTextAnalyticsApi
|
6
|
+
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
8
|
+
|
9
|
+
Method | Description
|
10
|
+
------------- | ------------- | -------------
|
11
|
+
[**get_conversation_transcriptproperty**](SpeechTextAnalyticsApi.html#get_conversation_transcriptproperty) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
<a name="get_conversation_transcriptproperty"></a>
|
15
|
+
|
16
|
+
## [**TranscriptProperty**](TranscriptProperty.html) get_conversation_transcriptproperty(conversation_id, communication_id)
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
21
|
+
|
22
|
+
|
23
|
+
|
24
|
+
Wraps GET /api/v2/conversations/{conversationId}/transcriptproperties/{communicationId}
|
25
|
+
|
26
|
+
Requires NO permissions:
|
27
|
+
|
28
|
+
|
29
|
+
|
30
|
+
### Example
|
31
|
+
```{"language":"ruby"}
|
32
|
+
# load the gem
|
33
|
+
require 'purecloudplatformclientv2'
|
34
|
+
# setup authorization
|
35
|
+
@secret = ENV['PURECLOUD_SECRET']
|
36
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
37
|
+
environment = "mypurecloud.com"
|
38
|
+
|
39
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
40
|
+
|
41
|
+
PureCloud.configure do |config|
|
42
|
+
config.access_token = @authToken
|
43
|
+
end
|
44
|
+
|
45
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
46
|
+
|
47
|
+
conversation_id = "conversation_id_example" # String | Conversation ID
|
48
|
+
|
49
|
+
communication_id = "communication_id_example" # String | Communication ID
|
50
|
+
|
51
|
+
|
52
|
+
begin
|
53
|
+
#Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
54
|
+
result = api_instance.get_conversation_transcriptproperty(conversation_id, communication_id)
|
55
|
+
p result
|
56
|
+
rescue PureCloud::ApiError => e
|
57
|
+
puts "Exception when calling SpeechTextAnalyticsApi->get_conversation_transcriptproperty: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
Name | Type | Description | Notes
|
64
|
+
------------- | ------------- | ------------- | -------------
|
65
|
+
**conversation_id** | **String**| Conversation ID | |
|
66
|
+
**communication_id** | **String**| Communication ID | |
|
67
|
+
{: class="table table-striped"}
|
68
|
+
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**TranscriptProperty**](TranscriptProperty.html)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
|
data/docs/Station.md
CHANGED
@@ -13,8 +13,8 @@ title: Station
|
|
13
13
|
| **status** | **String** | | [optional] |
|
14
14
|
| **user_id** | **String** | The Id of the user currently logged in and associated with the station. | [optional] |
|
15
15
|
| **web_rtc_user_id** | **String** | The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone. | [optional] |
|
16
|
-
| **primary_edge** | [**
|
17
|
-
| **secondary_edge** | [**
|
16
|
+
| **primary_edge** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
17
|
+
| **secondary_edge** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
18
18
|
| **type** | **String** | | [optional] |
|
19
19
|
| **line_appearance_id** | **String** | | [optional] |
|
20
20
|
| **web_rtc_media_dscp** | **Integer** | The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone. | [optional] |
|
@@ -13,9 +13,9 @@ title: StationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SubjectDivisionGrantsEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/SuggestApi.md
CHANGED
@@ -68,7 +68,7 @@ end
|
|
68
68
|
Name | Type | Description | Notes
|
69
69
|
------------- | ------------- | ------------- | -------------
|
70
70
|
**q64** | **String**| q64 | |
|
71
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
71
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
72
72
|
**profile** | **BOOLEAN**| profile | [optional] [default to true] |
|
73
73
|
{: class="table table-striped"}
|
74
74
|
|
@@ -138,7 +138,7 @@ end
|
|
138
138
|
Name | Type | Description | Notes
|
139
139
|
------------- | ------------- | ------------- | -------------
|
140
140
|
**q64** | **String**| q64 | |
|
141
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
141
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
|
142
142
|
**profile** | **BOOLEAN**| profile | [optional] [default to true] |
|
143
143
|
{: class="table table-striped"}
|
144
144
|
|
data/docs/Survey.md
CHANGED
@@ -11,7 +11,7 @@ title: Survey
|
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **conversation** | [**Conversation**](Conversation.html) | | [optional] |
|
13
13
|
| **survey_form** | [**SurveyForm**](SurveyForm.html) | Survey form used for this survey. | [optional] |
|
14
|
-
| **agent** | [**
|
14
|
+
| **agent** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
15
15
|
| **status** | **String** | | [optional] |
|
16
16
|
| **queue** | [**QueueReference**](QueueReference.html) | | [optional] |
|
17
17
|
| **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
|
data/docs/SurveyAssignment.md
CHANGED
@@ -8,7 +8,7 @@ title: SurveyAssignment
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **survey_form** | [**PublishedSurveyFormReference**](PublishedSurveyFormReference.html) | The survey form used for this survey. | [optional] |
|
11
|
-
| **flow** | [**
|
11
|
+
| **flow** | [**DomainEntityRef**](DomainEntityRef.html) | The URI reference to the flow associated with this survey. | [optional] |
|
12
12
|
| **invite_time_interval** | **String** | An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days. | [optional] |
|
13
13
|
| **sending_user** | **String** | User together with sendingDomain used to send email, null to use no-reply | [optional] |
|
14
14
|
| **sending_domain** | **String** | Validated email domain, required | |
|
@@ -13,9 +13,9 @@ 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
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SystemPromptAssetEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SystemPromptEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: TagValueEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TextMessageListing.md
CHANGED
@@ -13,9 +13,9 @@ 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
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: TimeZoneEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,7 +7,7 @@ title: TimeZoneMappingPreview
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **contact_list** | [**
|
10
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The associated ContactList | [optional] |
|
11
11
|
| **contacts_per_time_zone** | **Hash<String, Integer>** | The number of contacts per time zone that mapped to only that time zone | [optional] |
|
12
12
|
| **contacts_mapped_using_zip_code** | **Hash<String, Integer>** | The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column | [optional] |
|
13
13
|
| **contacts_mapped_to_a_single_zone** | **Integer** | The total number of contacts that mapped to a single time zone | [optional] |
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: TranscriptProperty
|
3
|
+
---
|
4
|
+
## PureCloud::TranscriptProperty
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **url** | **String** | The pre-signed S3 URL of the transcript | [optional] |
|
11
|
+
| **conversation** | [**AddressableEntityRef**](AddressableEntityRef.html) | The conversation reference | [optional] |
|
12
|
+
| **communication_id** | **String** | The communication ID | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
data/docs/Trunk.md
CHANGED
@@ -19,13 +19,13 @@ title: Trunk
|
|
19
19
|
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
20
20
|
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
21
21
|
| **trunk_type** | **String** | The type of this trunk. | [optional] |
|
22
|
-
| **edge** | [**
|
23
|
-
| **trunk_base** | [**
|
24
|
-
| **trunk_metabase** | [**
|
25
|
-
| **edge_group** | [**
|
22
|
+
| **edge** | [**DomainEntityRef**](DomainEntityRef.html) | The Edge using this trunk. | [optional] |
|
23
|
+
| **trunk_base** | [**DomainEntityRef**](DomainEntityRef.html) | The trunk base configuration used on this trunk. | [optional] |
|
24
|
+
| **trunk_metabase** | [**DomainEntityRef**](DomainEntityRef.html) | The metabase used to create this trunk. | [optional] |
|
25
|
+
| **edge_group** | [**DomainEntityRef**](DomainEntityRef.html) | The edge group associated with this trunk. | [optional] |
|
26
26
|
| **in_service** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
|
27
27
|
| **enabled** | **BOOLEAN** | True if the Edge used by this trunk is in-service | [optional] |
|
28
|
-
| **logical_interface** | [**
|
28
|
+
| **logical_interface** | [**DomainEntityRef**](DomainEntityRef.html) | The Logical Interface on the Edge to which the trunk is assigned. | [optional] |
|
29
29
|
| **connected_status** | [**TrunkConnectedStatus**](TrunkConnectedStatus.html) | The connected status of the trunk | [optional] |
|
30
30
|
| **options_status** | [**Array<TrunkMetricsOptions>**](TrunkMetricsOptions.html) | The trunk optionsStatus | [optional] |
|
31
31
|
| **registers_status** | [**Array<TrunkMetricsRegisters>**](TrunkMetricsRegisters.html) | The trunk registersStatus | [optional] |
|
data/docs/TrunkBase.md
CHANGED
@@ -18,7 +18,7 @@ title: TrunkBase
|
|
18
18
|
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
19
19
|
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
20
20
|
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
21
|
-
| **trunk_metabase** | [**
|
21
|
+
| **trunk_metabase** | [**DomainEntityRef**](DomainEntityRef.html) | The meta-base this trunk is based on. | |
|
22
22
|
| **properties** | **Hash<String, Object>** | | [optional] |
|
23
23
|
| **trunk_type** | **String** | The type of this trunk base. | |
|
24
24
|
| **managed** | **BOOLEAN** | Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned. | [optional] |
|
@@ -13,9 +13,9 @@ 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
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ 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
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: TrunkMetabaseEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|