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/Attribute.md
CHANGED
|
@@ -11,9 +11,9 @@ title: Attribute
|
|
|
11
11
|
| **name** | **String** | The attribute name. | |
|
|
12
12
|
| **version** | **Integer** | | [optional] |
|
|
13
13
|
| **description** | **String** | | [optional] |
|
|
14
|
-
| **created_by** | [**
|
|
14
|
+
| **created_by** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
15
15
|
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | [**
|
|
16
|
+
| **modified_by** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
17
17
|
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
data/docs/AuthorizationApi.md
CHANGED
|
@@ -838,7 +838,7 @@ This endpoint does not need any parameter.
|
|
|
838
838
|
|
|
839
839
|
<a name="get_authorization_role"></a>
|
|
840
840
|
|
|
841
|
-
## [**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
|
|
841
|
+
## [**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id, opts)
|
|
842
842
|
|
|
843
843
|
|
|
844
844
|
|
|
@@ -872,10 +872,13 @@ api_instance = PureCloud::AuthorizationApi.new
|
|
|
872
872
|
|
|
873
873
|
role_id = "role_id_example" # String | Role ID
|
|
874
874
|
|
|
875
|
+
opts = {
|
|
876
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
|
|
877
|
+
}
|
|
875
878
|
|
|
876
879
|
begin
|
|
877
880
|
#Get a single organization role.
|
|
878
|
-
result = api_instance.get_authorization_role(role_id)
|
|
881
|
+
result = api_instance.get_authorization_role(role_id, opts)
|
|
879
882
|
p result
|
|
880
883
|
rescue PureCloud::ApiError => e
|
|
881
884
|
puts "Exception when calling AuthorizationApi->get_authorization_role: #{e}"
|
|
@@ -887,6 +890,7 @@ end
|
|
|
887
890
|
Name | Type | Description | Notes
|
|
888
891
|
------------- | ------------- | ------------- | -------------
|
|
889
892
|
**role_id** | **String**| Role ID | |
|
|
893
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: unusedPermissions |
|
|
890
894
|
{: class="table table-striped"}
|
|
891
895
|
|
|
892
896
|
|
|
@@ -13,9 +13,9 @@ title: AuthzDivisionEntityListing
|
|
|
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/BillingApi.md
CHANGED
|
@@ -8,7 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
[**get_billing_reports_billableusage**](BillingApi.html#get_billing_reports_billableusage) | Get a report of the billable usages
|
|
11
|
+
[**get_billing_reports_billableusage**](BillingApi.html#get_billing_reports_billableusage) | Get a report of the billable license usages
|
|
12
12
|
[**get_billing_trusteebillingoverview_trustor_org_id**](BillingApi.html#get_billing_trusteebillingoverview_trustor_org_id) | Get the billing overview for an organization that is managed by a partner.
|
|
13
13
|
{: class="table table-striped"}
|
|
14
14
|
|
|
@@ -18,9 +18,9 @@ Method | Description
|
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
21
|
-
Get a report of the billable usages
|
|
22
|
-
|
|
21
|
+
Get a report of the billable license usages
|
|
23
22
|
|
|
23
|
+
Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
|
|
24
24
|
|
|
25
25
|
Wraps GET /api/v2/billing/reports/billableusage
|
|
26
26
|
|
|
@@ -55,7 +55,7 @@ end_date = DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | The period e
|
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
begin
|
|
58
|
-
#Get a report of the billable usages
|
|
58
|
+
#Get a report of the billable license usages
|
|
59
59
|
result = api_instance.get_billing_reports_billableusage(start_date, end_date)
|
|
60
60
|
p result
|
|
61
61
|
rescue PureCloud::ApiError => e
|
data/docs/BillingUsageReport.md
CHANGED
|
@@ -11,6 +11,7 @@ title: BillingUsageReport
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **start_date** | **DateTime** | The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
13
13
|
| **end_date** | **DateTime** | The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
14
|
+
| **status** | **String** | Generation status of report | [optional] |
|
|
14
15
|
| **usages** | [**Array<BillingUsage>**](BillingUsage.html) | The usages for the given period. | |
|
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
16
17
|
{: class="table table-striped"}
|
|
@@ -13,9 +13,9 @@ title: CalibrationEntityListing
|
|
|
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: CallConversationEntityListing
|
|
|
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: CallHistoryConversationEntityListing
|
|
|
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
|
|
|
@@ -21,17 +21,17 @@ title: CallMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
|
24
|
-
| **user** | [**
|
|
25
|
-
| **queue** | [**
|
|
24
|
+
| **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
|
|
25
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
|
28
|
-
| **script** | [**
|
|
28
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
|
31
31
|
| **alerting_timeout_ms** | **Integer** | Specifies how long the agent has to answer an interaction before being marked as not responding. | [optional] |
|
|
32
32
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
|
33
|
-
| **external_contact** | [**
|
|
34
|
-
| **external_organization** | [**
|
|
33
|
+
| **external_contact** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
|
34
|
+
| **external_organization** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
35
35
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
@@ -41,7 +41,7 @@ title: CallMediaParticipant
|
|
|
41
41
|
| **confined** | **BOOLEAN** | Value is true when the call is confined. | [optional] |
|
|
42
42
|
| **recording** | **BOOLEAN** | Value is true when the call is being recorded. | [optional] |
|
|
43
43
|
| **recording_state** | **String** | The state of the call recording. | [optional] |
|
|
44
|
-
| **group** | [**
|
|
44
|
+
| **group** | [**DomainEntityRef**](DomainEntityRef.html) | The group involved in the group ring call. | [optional] |
|
|
45
45
|
| **ani** | **String** | The call ANI. | [optional] |
|
|
46
46
|
| **dnis** | **String** | The call DNIS. | [optional] |
|
|
47
47
|
| **document_id** | **String** | The ID of the Content Management document if the call is a fax. | [optional] |
|
|
@@ -7,10 +7,10 @@ title: CallableContactsDiagnostic
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **attempt_limits** | [**
|
|
11
|
-
| **dnc_lists** | [**Array<
|
|
12
|
-
| **callable_time_set** | [**
|
|
13
|
-
| **rule_sets** | [**Array<
|
|
10
|
+
| **attempt_limits** | [**DomainEntityRef**](DomainEntityRef.html) | Attempt limits for the campaign's contact list | [optional] |
|
|
11
|
+
| **dnc_lists** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | Do not call lists for the campaign | [optional] |
|
|
12
|
+
| **callable_time_set** | [**DomainEntityRef**](DomainEntityRef.html) | Callable time sets for the campaign | [optional] |
|
|
13
|
+
| **rule_sets** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | Rule sets for the campaign | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
|
@@ -13,9 +13,9 @@ title: CallableTimeSetEntityListing
|
|
|
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: CallbackConversationEntityListing
|
|
|
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
|
|
|
@@ -21,17 +21,17 @@ title: CallbackMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
|
24
|
-
| **user** | [**
|
|
25
|
-
| **queue** | [**
|
|
24
|
+
| **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
|
|
25
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
|
28
|
-
| **script** | [**
|
|
28
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
|
31
31
|
| **alerting_timeout_ms** | **Integer** | Specifies how long the agent has to answer an interaction before being marked as not responding. | [optional] |
|
|
32
32
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
|
33
|
-
| **external_contact** | [**
|
|
34
|
-
| **external_organization** | [**
|
|
33
|
+
| **external_contact** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
|
34
|
+
| **external_organization** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
35
35
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
data/docs/Campaign.md
CHANGED
|
@@ -12,23 +12,23 @@ title: Campaign
|
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
-
| **contact_list** | [**
|
|
16
|
-
| **queue** | [**
|
|
15
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The ContactList for this Campaign to dial. | |
|
|
16
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The Queue for this Campaign to route calls to. Required for all dialing modes except agentless. | [optional] |
|
|
17
17
|
| **dialing_mode** | **String** | The strategy this Campaign will use for dialing. | |
|
|
18
|
-
| **script** | [**
|
|
19
|
-
| **edge_group** | [**
|
|
20
|
-
| **site** | [**
|
|
18
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless. | [optional] |
|
|
19
|
+
| **edge_group** | [**DomainEntityRef**](DomainEntityRef.html) | The EdgeGroup that will place the calls. Required for all dialing modes except preview. | [optional] |
|
|
20
|
+
| **site** | [**DomainEntityRef**](DomainEntityRef.html) | The identifier of the site to be used for dialing; can be set in place of an edge group. | [optional] |
|
|
21
21
|
| **campaign_status** | **String** | The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates. | [optional] |
|
|
22
22
|
| **phone_columns** | [**Array<PhoneColumn>**](PhoneColumn.html) | The ContactPhoneNumberColumns on the ContactList that this Campaign should dial. | |
|
|
23
23
|
| **abandon_rate** | **Float** | The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns. | [optional] |
|
|
24
|
-
| **dnc_lists** | [**Array<
|
|
25
|
-
| **callable_time_set** | [**
|
|
26
|
-
| **call_analysis_response_set** | [**
|
|
24
|
+
| **dnc_lists** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | DncLists for this Campaign to check before placing a call. | [optional] |
|
|
25
|
+
| **callable_time_set** | [**DomainEntityRef**](DomainEntityRef.html) | The callable time set for this campaign to check before placing a call. | [optional] |
|
|
26
|
+
| **call_analysis_response_set** | [**DomainEntityRef**](DomainEntityRef.html) | The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview. | [optional] |
|
|
27
27
|
| **errors** | [**Array<RestErrorDetail>**](RestErrorDetail.html) | A list of current error conditions associated with the campaign. | [optional] |
|
|
28
28
|
| **caller_name** | **String** | The caller id name to be displayed on the outbound call. | |
|
|
29
29
|
| **caller_address** | **String** | The caller id phone number to be displayed on the outbound call. | |
|
|
30
30
|
| **outbound_line_count** | **Integer** | The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. | [optional] |
|
|
31
|
-
| **rule_sets** | [**Array<
|
|
31
|
+
| **rule_sets** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | Rule sets to be applied while this campaign is dialing. | [optional] |
|
|
32
32
|
| **skip_preview_disabled** | **BOOLEAN** | Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. | [optional] |
|
|
33
33
|
| **preview_time_out_seconds** | **Integer** | The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns. | [optional] |
|
|
34
34
|
| **always_running** | **BOOLEAN** | Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually. | [optional] |
|
|
@@ -37,8 +37,8 @@ title: Campaign
|
|
|
37
37
|
| **no_answer_timeout** | **Integer** | How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns. | [optional] |
|
|
38
38
|
| **call_analysis_language** | **String** | The language the edge will use to analyze the call. | [optional] |
|
|
39
39
|
| **priority** | **Integer** | The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. | [optional] |
|
|
40
|
-
| **contact_list_filters** | [**Array<
|
|
41
|
-
| **division** | [**
|
|
40
|
+
| **contact_list_filters** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. | [optional] |
|
|
41
|
+
| **division** | [**DomainEntityRef**](DomainEntityRef.html) | The division this campaign belongs to. | [optional] |
|
|
42
42
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
43
43
|
{: class="table table-striped"}
|
|
44
44
|
|
|
@@ -13,9 +13,9 @@ title: CampaignDivisionViewListing
|
|
|
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: CampaignEntityListing
|
|
|
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/CampaignInteraction.md
CHANGED
|
@@ -8,9 +8,9 @@ title: CampaignInteraction
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | | [optional] |
|
|
11
|
-
| **campaign** | [**
|
|
12
|
-
| **agent** | [**
|
|
13
|
-
| **contact** | [**
|
|
11
|
+
| **campaign** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
12
|
+
| **agent** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
13
|
+
| **contact** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
14
14
|
| **destination_address** | **String** | | [optional] |
|
|
15
15
|
| **active_preview_call** | **BOOLEAN** | Boolean value if there is an active preview call on the interaction | [optional] |
|
|
16
16
|
| **last_active_preview_wrapup_time** | **DateTime** | The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
@@ -18,8 +18,8 @@ title: CampaignInteraction
|
|
|
18
18
|
| **call_placed_time** | **DateTime** | The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
19
19
|
| **call_routed_time** | **DateTime** | The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
20
20
|
| **preview_connected_time** | **DateTime** | The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
21
|
-
| **queue** | [**
|
|
22
|
-
| **script** | [**
|
|
21
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
22
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
23
23
|
| **disposition** | **String** | Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer | [optional] |
|
|
24
24
|
| **caller_name** | **String** | | [optional] |
|
|
25
25
|
| **caller_address** | **String** | | [optional] |
|
|
@@ -27,7 +27,7 @@ title: CampaignInteraction
|
|
|
27
27
|
| **conversation** | [**ConversationBasic**](ConversationBasic.html) | | [optional] |
|
|
28
28
|
| **dialer_system_participant_id** | **String** | conversation participant id that is the dialer system participant to monitor the call from dialer perspective | [optional] |
|
|
29
29
|
| **dialing_mode** | **String** | | [optional] |
|
|
30
|
-
| **skills** | [**Array<
|
|
30
|
+
| **skills** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | Any skills that are attached to the call for routing | [optional] |
|
|
31
31
|
{: class="table table-striped"}
|
|
32
32
|
|
|
33
33
|
|
|
@@ -7,7 +7,7 @@ title: CampaignInteractions
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaign** | [**
|
|
10
|
+
| **campaign** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
11
11
|
| **pending_interactions** | [**Array<CampaignInteraction>**](CampaignInteraction.html) | | [optional] |
|
|
12
12
|
| **proceeding_interactions** | [**Array<CampaignInteraction>**](CampaignInteraction.html) | | [optional] |
|
|
13
13
|
| **previewing_interactions** | [**Array<CampaignInteraction>**](CampaignInteraction.html) | | [optional] |
|
data/docs/CampaignProgress.md
CHANGED
|
@@ -7,8 +7,8 @@ title: CampaignProgress
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaign** | [**
|
|
11
|
-
| **contact_list** | [**
|
|
10
|
+
| **campaign** | [**DomainEntityRef**](DomainEntityRef.html) | Identifier of the campaign | |
|
|
11
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | Identifier of the contact list | |
|
|
12
12
|
| **number_of_contacts_called** | **Integer** | Number of contacts processed during the campaign | [optional] |
|
|
13
13
|
| **total_number_of_contacts** | **Integer** | Total number of contacts in the campaign | [optional] |
|
|
14
14
|
| **percentage** | **Integer** | Percentage of contacts processed during the campaign | [optional] |
|
|
@@ -7,8 +7,8 @@ title: CampaignRuleActionEntities
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaigns** | [**Array<
|
|
11
|
-
| **sequences** | [**Array<
|
|
10
|
+
| **campaigns** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. | [optional] |
|
|
11
|
+
| **sequences** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. | [optional] |
|
|
12
12
|
| **use_triggering_entity** | **BOOLEAN** | If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition. | [optional] |
|
|
13
13
|
{: class="table table-striped"}
|
|
14
14
|
|
|
@@ -7,8 +7,8 @@ title: CampaignRuleEntities
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaigns** | [**Array<
|
|
11
|
-
| **sequences** | [**Array<
|
|
10
|
+
| **campaigns** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. | [optional] |
|
|
11
|
+
| **sequences** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -13,9 +13,9 @@ title: CampaignRuleEntityListing
|
|
|
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/CampaignSchedule.md
CHANGED
|
@@ -14,7 +14,7 @@ title: CampaignSchedule
|
|
|
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 Campaign. | |
|
|
16
16
|
| **time_zone** | **String** | The time zone for this CampaignSchedule. For example, Africa/Abidjan. | |
|
|
17
|
-
| **campaign** | [**
|
|
17
|
+
| **campaign** | [**DomainEntityRef**](DomainEntityRef.html) | The Campaign that this CampaignSchedule is for. | |
|
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
data/docs/CampaignSequence.md
CHANGED
|
@@ -12,7 +12,7 @@ title: CampaignSequence
|
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
-
| **campaigns** | [**Array<
|
|
15
|
+
| **campaigns** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The ordered list of Campaigns that this CampaignSequence will run. | |
|
|
16
16
|
| **current_campaign** | **Integer** | A zero-based index indicating which Campaign this CampaignSequence is currently on. | |
|
|
17
17
|
| **status** | **String** | The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'. | |
|
|
18
18
|
| **stop_message** | **String** | A message indicating if and why a CampaignSequence has stopped unexpectedly. | [optional] |
|
|
@@ -13,9 +13,9 @@ title: CampaignSequenceEntityListing
|
|
|
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: CertificateAuthorityEntityListing
|
|
|
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: ChatConversationEntityListing
|
|
|
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
|
|