purecloudplatformclientv2 60.0.0 → 64.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +299 -32
- data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectApi.md +85 -16
- data/docs/ArrayNode.md +4 -4
- data/docs/AsyncConversationQuery.md +6 -6
- data/docs/AsyncQueryResponse.md +13 -0
- data/docs/AsyncQueryStatus.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/Attribute.md +2 -2
- data/docs/AuthorizationApi.md +11 -7
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BillingApi.md +4 -4
- data/docs/BillingUsageReport.md +1 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +6 -6
- data/docs/CallableContactsDiagnostic.md +4 -4
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +5 -5
- data/docs/Campaign.md +11 -11
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- 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 +1 -1
- data/docs/CampaignSchedule.md +1 -1
- data/docs/CampaignSequence.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +5 -5
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +5 -5
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactList.md +2 -2
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilter.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationAggregateDataContainer.md +14 -0
- data/docs/ConversationAggregateQueryClause.md +14 -0
- data/docs/ConversationAggregateQueryFilter.md +15 -0
- data/docs/ConversationAggregateQueryPredicate.md +17 -0
- data/docs/ConversationAggregateQueryResponse.md +13 -0
- data/docs/ConversationAggregationQuery.md +20 -0
- data/docs/ConversationAggregationView.md +16 -0
- data/docs/ConversationDetailQueryClause.md +14 -0
- data/docs/ConversationDetailQueryFilter.md +15 -0
- data/docs/ConversationDetailQueryPredicate.md +18 -0
- data/docs/ConversationDivisionMembership.md +2 -2
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationQuery.md +6 -6
- data/docs/ConversationsApi.md +2259 -498
- data/docs/CreateCallbackResponse.md +1 -1
- data/docs/CreateQueueMediaAssociationRequest.md +1 -0
- data/docs/CreateQueueRequest.md +2 -2
- data/docs/CreateShareResponse.md +4 -4
- data/docs/CreateUser.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DID.md +2 -2
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +3 -3
- data/docs/DataTableImportJob.md +24 -0
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyStatus.md +2 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncList.md +1 -1
- data/docs/DncListCreate.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/Document.md +4 -4
- data/docs/DocumentAudit.md +2 -2
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DocumentUpload.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/{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 +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeInterface.md +1 -1
- data/docs/EdgeLine.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EdgeMetrics.md +1 -1
- data/docs/EdgeTrunkBase.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +5 -5
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmbeddedIntegration.md +14 -0
- data/docs/EmergencyCallFlow.md +2 -2
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/Endpoint.md +2 -2
- data/docs/EvaluationAggregateDataContainer.md +14 -0
- data/docs/EvaluationAggregateQueryClause.md +14 -0
- data/docs/EvaluationAggregateQueryFilter.md +15 -0
- data/docs/EvaluationAggregateQueryPredicate.md +17 -0
- data/docs/EvaluationAggregateQueryResponse.md +13 -0
- data/docs/EvaluationAggregationQuery.md +20 -0
- data/docs/EvaluationAggregationView.md +16 -0
- data/docs/EvaluationDetailQueryClause.md +14 -0
- data/docs/EvaluationDetailQueryFilter.md +15 -0
- data/docs/EvaluationDetailQueryPredicate.md +18 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/EventLog.md +2 -2
- data/docs/Extension.md +2 -2
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegration.md +3 -3
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocument.md +2 -2
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +2 -1
- data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md} +2 -2
- data/docs/FlowAggregateQueryClause.md +14 -0
- data/docs/FlowAggregateQueryFilter.md +15 -0
- data/docs/FlowAggregateQueryPredicate.md +17 -0
- data/docs/FlowAggregateQueryResponse.md +13 -0
- data/docs/{AggregationQuery.md → FlowAggregationQuery.md} +4 -4
- data/docs/{AnalyticsView.md → FlowAggregationView.md} +3 -3
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md} +2 -2
- data/docs/{ObservationQuery.md → FlowObservationQuery.md} +3 -3
- data/docs/FlowObservationQueryClause.md +14 -0
- data/docs/FlowObservationQueryFilter.md +15 -0
- data/docs/FlowObservationQueryPredicate.md +17 -0
- data/docs/FlowObservationQueryResponse.md +13 -0
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersion.md +1 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/FlowsApi.md +8 -8
- data/docs/GDPRRequest.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupContact.md +1 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +1 -1
- data/docs/HistoryEntry.md +2 -1
- data/docs/HistoryListing.md +1 -0
- data/docs/IVR.md +4 -4
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRoute.md +5 -5
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationExport.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/Line.md +6 -6
- data/docs/LineBase.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegration.md +3 -3
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/Location.md +4 -4
- data/docs/{LocationUpdateDefinition.md → LocationCreateUpdateDefinition.md} +7 -6
- data/docs/LocationDefinition.md +1 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationSearchRequest.md +1 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/LockInfo.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +2 -2
- data/docs/MediaEndpointStatDetailQueryClause.md +14 -0
- data/docs/MediaEndpointStatDetailQueryFilter.md +15 -0
- data/docs/MediaEndpointStatDetailQueryPredicate.md +17 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageInfo.md +4 -4
- data/docs/MessageMediaParticipant.md +5 -5
- data/docs/MessagingApi.md +7 -1015
- data/docs/MessagingIntegration.md +3 -3
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClient.md +2 -2
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthClientListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObjectsApi.md +1 -1
- data/docs/Operation.md +1 -0
- data/docs/OrgOAuthClient.md +2 -2
- data/docs/OrganizationApi.md +133 -8
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +4 -4
- data/docs/OutboundRoute.md +1 -1
- data/docs/OutboundRouteBase.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/Phone.md +5 -5
- data/docs/PhoneBase.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhoneStatus.md +1 -1
- data/docs/Photo.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceDetailQueryClause.md +14 -0
- data/docs/PresenceDetailQueryFilter.md +15 -0
- data/docs/PresenceDetailQueryPredicate.md +17 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +8 -8
- data/docs/QualityAuditPage.md +1 -1
- data/docs/Queue.md +2 -2
- data/docs/QueueEmailAddress.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMediaAssociation.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueMessagingAddresses.md +1 -1
- data/docs/QueueObservationDataContainer.md +14 -0
- data/docs/QueueObservationQuery.md +15 -0
- data/docs/QueueObservationQueryClause.md +14 -0
- data/docs/QueueObservationQueryFilter.md +15 -0
- data/docs/QueueObservationQueryPredicate.md +17 -0
- data/docs/{QualifierMappingObservationQueryResponse.md → QueueObservationQueryResponse.md} +3 -3
- data/docs/QueueRequest.md +2 -2
- data/docs/QueueUtilizationDiagnostic.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +4 -4
- data/docs/RecordingApi.md +11 -3
- data/docs/RecordingJob.md +1 -0
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +2 -0
- data/docs/RecordingMetadata.md +29 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReplaceResponse.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/Response.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +144 -7
- data/docs/RoutingStatusDetailQueryClause.md +14 -0
- data/docs/RoutingStatusDetailQueryFilter.md +15 -0
- data/docs/RoutingStatusDetailQueryPredicate.md +17 -0
- data/docs/RuleSet.md +2 -2
- data/docs/RuleSetDiagnostic.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +278 -0
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroup.md +3 -3
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +20 -0
- data/docs/ScimConfigResourceTypeSchemaExtension.md +14 -0
- data/docs/ScimConfigResourceTypesListResponse.md +17 -0
- data/docs/ScimEmail.md +3 -3
- data/docs/ScimError.md +16 -0
- data/docs/ScimGroupListResponse.md +4 -4
- data/docs/ScimMetadata.md +4 -4
- data/docs/ScimPhoneNumber.md +3 -3
- data/docs/ScimServiceProviderConfig.md +9 -1
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +18 -0
- data/docs/ScimServiceProviderConfigBulkFeature.md +15 -0
- data/docs/ScimServiceProviderConfigFilterFeature.md +14 -0
- data/docs/ScimServiceProviderConfigSimpleFeature.md +13 -0
- data/docs/ScimUserListResponse.md +4 -4
- data/docs/ScimV2CreateUser.md +12 -12
- data/docs/ScimV2EnterpriseUser.md +3 -3
- data/docs/ScimV2Group.md +4 -4
- data/docs/ScimV2GroupReference.md +3 -4
- data/docs/ScimV2MemberReference.md +3 -4
- data/docs/ScimV2PatchOperation.md +3 -3
- data/docs/ScimV2PatchRequest.md +1 -1
- data/docs/ScimV2User.md +14 -13
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +4 -4
- data/docs/SecureSession.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SegmentDetailQueryClause.md +14 -0
- data/docs/SegmentDetailQueryFilter.md +15 -0
- data/docs/{AnalyticsQueryPredicate.md → SegmentDetailQueryPredicate.md} +4 -4
- data/docs/SequenceSchedule.md +1 -1
- data/docs/Share.md +4 -4
- data/docs/ShareEntityListing.md +1 -1
- data/docs/Site.md +2 -2
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddress.md +21 -0
- data/docs/SmsAddressEntityListing.md +22 -0
- data/docs/SmsPhoneNumber.md +2 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SmsPhoneNumberProvision.md +1 -0
- data/docs/SpeechTextAnalyticsApi.md +14 -144
- data/docs/Station.md +2 -2
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SuggestApi.md +2 -2
- data/docs/Survey.md +1 -1
- data/docs/SurveyAggregateDataContainer.md +14 -0
- data/docs/SurveyAggregateQueryClause.md +14 -0
- data/docs/SurveyAggregateQueryFilter.md +15 -0
- data/docs/SurveyAggregateQueryPredicate.md +17 -0
- data/docs/SurveyAggregateQueryResponse.md +13 -0
- data/docs/SurveyAggregationQuery.md +20 -0
- data/docs/SurveyAggregationView.md +16 -0
- data/docs/SurveyAssignment.md +1 -1
- data/docs/SurveyDetailQueryClause.md +14 -0
- data/docs/SurveyDetailQueryFilter.md +15 -0
- data/docs/SurveyDetailQueryPredicate.md +18 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +10 -6
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TimeZoneMappingPreview.md +1 -1
- data/docs/TokenInfo.md +1 -0
- data/docs/TokensApi.md +2 -1
- data/docs/TranscriptProperty.md +15 -0
- data/docs/Trunk.md +5 -5
- data/docs/TrunkBase.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrunkMetrics.md +2 -2
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegration.md +3 -3
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregateDataContainer.md +14 -0
- data/docs/UserAggregateQueryClause.md +14 -0
- data/docs/UserAggregateQueryFilter.md +15 -0
- data/docs/UserAggregateQueryPredicate.md +17 -0
- data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md} +3 -3
- data/docs/UserAggregationQuery.md +20 -0
- data/docs/UserAggregationView.md +16 -0
- data/docs/UserAuthorization.md +1 -0
- data/docs/UserDetailQueryClause.md +14 -0
- data/docs/UserDetailQueryFilter.md +15 -0
- data/docs/UserDetailQueryPredicate.md +17 -0
- data/docs/UserDetailsQuery.md +3 -3
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserObservationDataContainer.md +14 -0
- data/docs/UserObservationQuery.md +15 -0
- data/docs/UserObservationQueryClause.md +14 -0
- data/docs/UserObservationQueryFilter.md +15 -0
- data/docs/UserObservationQueryPredicate.md +17 -0
- data/docs/UserObservationQueryResponse.md +13 -0
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueue.md +2 -2
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecording.md +2 -2
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UserTokensTopicTokenNotification.md +3 -0
- data/docs/UsersApi.md +19 -19
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatDeployment.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- 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/WorkforceManagementApi.md +1 -1
- data/docs/Workspace.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMember.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +99 -20
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +292 -24
- data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +2663 -810
- data/lib/purecloudplatformclientv2/api/flows_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/locations_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +10 -1042
- data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/organization_api.rb +124 -4
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/quality_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +51 -3
- data/lib/purecloudplatformclientv2/api/routing_api.rb +153 -6
- data/lib/purecloudplatformclientv2/api/scim_api.rb +332 -0
- data/lib/purecloudplatformclientv2/api/search_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +19 -139
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +22 -4
- data/lib/purecloudplatformclientv2/api/users_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +1 -15
- 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_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +31 -3
- data/lib/purecloudplatformclientv2/models/array_node.rb +57 -57
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +28 -28
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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 +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- 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 +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_clause.rb → conversation_aggregate_query_clause.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/{analytics_query_filter.rb → conversation_aggregate_query_filter.rb} +4 -4
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +28 -28
- data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +27 -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 +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +3 -3
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +521 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_status.rb +28 -1
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did.rb +2 -2
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document.rb +4 -4
- data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +29 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +29 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +29 -1
- data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{base_topic_entitiy.rb → embedded_integration.rb} +16 -41
- data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/{analytics_view.rb → evaluation_aggregation_view.rb} +17 -3
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/{create_topic_request.rb → evaluation_detail_query_predicate.rb} +91 -141
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +30 -3
- data/lib/purecloudplatformclientv2/models/{aggregate_data_container.rb → flow_aggregate_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{aggregate_query_response.rb → flow_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/{aggregation_query.rb → flow_aggregation_query.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/flow_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{observation_data_container.rb → flow_observation_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/{observation_query.rb → flow_observation_query.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{observation_query_response.rb → flow_observation_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version.rb +26 -1
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_contact.rb +27 -1
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/history_entry.rb +28 -1
- data/lib/purecloudplatformclientv2/models/history_listing.rb +26 -1
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +57 -57
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location.rb +4 -0
- data/lib/purecloudplatformclientv2/models/{location_update_definition.rb → location_create_update_definition.rb} +56 -25
- data/lib/purecloudplatformclientv2/models/location_definition.rb +27 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +3 -3
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_info.rb +4 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +1 -15
- data/lib/purecloudplatformclientv2/models/operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
- data/lib/purecloudplatformclientv2/models/photo.rb +2 -2
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/presence_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/queue_media_association.rb +17 -17
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{qualifier_mapping_observation_query_response.rb → queue_observation_query_response.rb} +2 -2
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +4 -2
- data/lib/purecloudplatformclientv2/models/recording_job.rb +30 -4
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +55 -3
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +644 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +30 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_predicate.rb +348 -0
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +389 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_email.rb +3 -3
- data/lib/purecloudplatformclientv2/models/{phrase.rb → scim_error.rb} +57 -57
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +215 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +362 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +255 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +21 -19
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +6 -32
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +6 -32
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +52 -24
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/segment_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_predicate.rb → segment_detail_query_predicate.rb} +7 -7
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/site.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{program.rb → sms_address.rb} +45 -83
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +67 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +27 -1
- data/lib/purecloudplatformclientv2/models/station.rb +2 -2
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +2 -2
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -4
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
- data/lib/purecloudplatformclientv2/models/token_info.rb +29 -1
- data/lib/purecloudplatformclientv2/models/{base_program_entity.rb → transcript_property.rb} +23 -22
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{presence_query_response.rb → user_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/user_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +33 -34
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_tokens_topic_token_notification.rb +79 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{topic.rb → whats_app_integration.rb} +120 -96
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +200 -42
- data/docs/AggregateQueryResponse.md +0 -13
- data/docs/AnalyticsQueryClause.md +0 -14
- data/docs/AnalyticsQueryFilter.md +0 -15
- data/docs/BaseProgramEntity.md +0 -15
- data/docs/BaseTopicEntitiy.md +0 -15
- data/docs/CreateTopicRequest.md +0 -20
- data/docs/ObservationQueryResponse.md +0 -13
- data/docs/Phrase.md +0 -15
- data/docs/Program.md +0 -22
- data/docs/Topic.md +0 -25
data/docs/LockInfo.md
CHANGED
|
@@ -7,7 +7,7 @@ title: LockInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **locked_by** | [**
|
|
10
|
+
| **locked_by** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
|
|
11
11
|
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
12
12
|
| **date_expires** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **action** | **String** | | [optional] |
|
|
@@ -14,8 +14,8 @@ title: LogicalInterfaceEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ManagementUnitListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Manager.md
CHANGED
|
@@ -7,8 +7,8 @@ title: Manager
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **value** | **String** |
|
|
11
|
-
| **ref** | **String** | URI
|
|
10
|
+
| **value** | **String** | The ID of the manager. | [optional] |
|
|
11
|
+
| **ref** | **String** | The URI of the manager's user record. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MediaEndpointStatDetailQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MediaEndpointStatDetailQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<MediaEndpointStatDetailQueryPredicate>**](MediaEndpointStatDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MediaEndpointStatDetailQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MediaEndpointStatDetailQueryFilter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
|
11
|
+
| **clauses** | [**Array<MediaEndpointStatDetailQueryClause>**](MediaEndpointStatDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<MediaEndpointStatDetailQueryPredicate>**](MediaEndpointStatDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MediaEndpointStatDetailQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MediaEndpointStatDetailQueryPredicate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
|
12
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
|
13
|
+
| **value** | **String** | Right hand side for dimension predicates | [optional] |
|
|
14
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -14,8 +14,8 @@ title: MessageConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/MessageInfo.md
CHANGED
|
@@ -7,10 +7,10 @@ title: MessageInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **localizable_message_code** | **String** |
|
|
11
|
-
| **message** | **String** |
|
|
12
|
-
| **message_with_params** | **String** |
|
|
13
|
-
| **message_params** | **Hash<String, String>** |
|
|
10
|
+
| **localizable_message_code** | **String** | Key that can be used to localize the message. | [optional] |
|
|
11
|
+
| **message** | **String** | Description of the message. | [optional] |
|
|
12
|
+
| **message_with_params** | **String** | Message with template fields for variable replacement. | [optional] |
|
|
13
|
+
| **message_params** | **Hash<String, String>** | Map with fields for variable replacement. | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
|
@@ -21,17 +21,17 @@ title: MessageMediaParticipant
|
|
|
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/MessagingApi.md
CHANGED
|
@@ -8,20 +8,9 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
[**delete_conversations_messaging_integrations_facebook_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
|
12
|
-
[**delete_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
|
13
|
-
[**delete_conversations_messaging_integrations_twitter_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
|
14
11
|
[**delete_messaging_integrations_facebook_integration_id**](MessagingApi.html#delete_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
|
15
12
|
[**delete_messaging_integrations_line_integration_id**](MessagingApi.html#delete_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
|
16
13
|
[**delete_messaging_integrations_twitter_integration_id**](MessagingApi.html#delete_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
|
17
|
-
[**get_conversations_messaging_integrations**](MessagingApi.html#get_conversations_messaging_integrations) | Get a list of Integrations
|
|
18
|
-
[**get_conversations_messaging_integrations_facebook**](MessagingApi.html#get_conversations_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
|
19
|
-
[**get_conversations_messaging_integrations_facebook_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
|
20
|
-
[**get_conversations_messaging_integrations_line**](MessagingApi.html#get_conversations_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
|
21
|
-
[**get_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
|
22
|
-
[**get_conversations_messaging_integrations_twitter**](MessagingApi.html#get_conversations_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
|
23
|
-
[**get_conversations_messaging_integrations_twitter_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
|
24
|
-
[**get_conversations_messaging_sticker**](MessagingApi.html#get_conversations_messaging_sticker) | Get a list of Messaging Stickers
|
|
25
14
|
[**get_messaging_integrations**](MessagingApi.html#get_messaging_integrations) | Get a list of Integrations
|
|
26
15
|
[**get_messaging_integrations_facebook**](MessagingApi.html#get_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
|
27
16
|
[**get_messaging_integrations_facebook_integration_id**](MessagingApi.html#get_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
|
@@ -30,208 +19,12 @@ Method | Description
|
|
|
30
19
|
[**get_messaging_integrations_twitter**](MessagingApi.html#get_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
|
31
20
|
[**get_messaging_integrations_twitter_integration_id**](MessagingApi.html#get_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
|
32
21
|
[**get_messaging_sticker**](MessagingApi.html#get_messaging_sticker) | Get a list of Messaging Stickers
|
|
33
|
-
[**post_conversations_messaging_integrations_facebook**](MessagingApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
|
|
34
|
-
[**post_conversations_messaging_integrations_line**](MessagingApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
|
|
35
|
-
[**post_conversations_messaging_integrations_twitter**](MessagingApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
|
|
36
22
|
[**post_messaging_integrations_facebook**](MessagingApi.html#post_messaging_integrations_facebook) | Create a Facebook Integration
|
|
37
23
|
[**post_messaging_integrations_line**](MessagingApi.html#post_messaging_integrations_line) | Create a LINE messenger Integration
|
|
38
24
|
[**post_messaging_integrations_twitter**](MessagingApi.html#post_messaging_integrations_twitter) | Create a Twitter Integration
|
|
39
|
-
[**put_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#put_conversations_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
|
40
25
|
[**put_messaging_integrations_line_integration_id**](MessagingApi.html#put_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
|
41
26
|
{: class="table table-striped"}
|
|
42
27
|
|
|
43
|
-
<a name="delete_conversations_messaging_integrations_facebook_integration_id"></a>
|
|
44
|
-
|
|
45
|
-
## delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
Delete a Facebook messaging integration
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
Wraps DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
|
54
|
-
|
|
55
|
-
Requires ANY permissions:
|
|
56
|
-
|
|
57
|
-
* messaging:integration:delete
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### Example
|
|
61
|
-
```{"language":"ruby"}
|
|
62
|
-
# load the gem
|
|
63
|
-
require 'purecloudplatformclientv2'
|
|
64
|
-
# setup authorization
|
|
65
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
66
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
67
|
-
environment = "mypurecloud.com"
|
|
68
|
-
|
|
69
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
70
|
-
|
|
71
|
-
PureCloud.configure do |config|
|
|
72
|
-
config.access_token = @authToken
|
|
73
|
-
end
|
|
74
|
-
|
|
75
|
-
api_instance = PureCloud::MessagingApi.new
|
|
76
|
-
|
|
77
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
begin
|
|
81
|
-
#Delete a Facebook messaging integration
|
|
82
|
-
api_instance.delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
83
|
-
rescue PureCloud::ApiError => e
|
|
84
|
-
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
|
85
|
-
end
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### Parameters
|
|
89
|
-
|
|
90
|
-
Name | Type | Description | Notes
|
|
91
|
-
------------- | ------------- | ------------- | -------------
|
|
92
|
-
**integration_id** | **String**| Integration ID | |
|
|
93
|
-
{: class="table table-striped"}
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
### Return type
|
|
97
|
-
|
|
98
|
-
nil (empty response body)
|
|
99
|
-
|
|
100
|
-
### HTTP request headers
|
|
101
|
-
|
|
102
|
-
- **Content-Type**: application/json
|
|
103
|
-
- **Accept**: application/json
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
<a name="delete_conversations_messaging_integrations_line_integration_id"></a>
|
|
108
|
-
|
|
109
|
-
## delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
Delete a LINE messenger integration
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
Wraps DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
118
|
-
|
|
119
|
-
Requires ANY permissions:
|
|
120
|
-
|
|
121
|
-
* messaging:integration:delete
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
### Example
|
|
125
|
-
```{"language":"ruby"}
|
|
126
|
-
# load the gem
|
|
127
|
-
require 'purecloudplatformclientv2'
|
|
128
|
-
# setup authorization
|
|
129
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
130
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
131
|
-
environment = "mypurecloud.com"
|
|
132
|
-
|
|
133
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
134
|
-
|
|
135
|
-
PureCloud.configure do |config|
|
|
136
|
-
config.access_token = @authToken
|
|
137
|
-
end
|
|
138
|
-
|
|
139
|
-
api_instance = PureCloud::MessagingApi.new
|
|
140
|
-
|
|
141
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
begin
|
|
145
|
-
#Delete a LINE messenger integration
|
|
146
|
-
api_instance.delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
147
|
-
rescue PureCloud::ApiError => e
|
|
148
|
-
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
149
|
-
end
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
### Parameters
|
|
153
|
-
|
|
154
|
-
Name | Type | Description | Notes
|
|
155
|
-
------------- | ------------- | ------------- | -------------
|
|
156
|
-
**integration_id** | **String**| Integration ID | |
|
|
157
|
-
{: class="table table-striped"}
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
### Return type
|
|
161
|
-
|
|
162
|
-
nil (empty response body)
|
|
163
|
-
|
|
164
|
-
### HTTP request headers
|
|
165
|
-
|
|
166
|
-
- **Content-Type**: application/json
|
|
167
|
-
- **Accept**: application/json
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
<a name="delete_conversations_messaging_integrations_twitter_integration_id"></a>
|
|
172
|
-
|
|
173
|
-
## delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
Delete a Twitter messaging integration
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
Wraps DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
|
182
|
-
|
|
183
|
-
Requires ANY permissions:
|
|
184
|
-
|
|
185
|
-
* messaging:integration:delete
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
### Example
|
|
189
|
-
```{"language":"ruby"}
|
|
190
|
-
# load the gem
|
|
191
|
-
require 'purecloudplatformclientv2'
|
|
192
|
-
# setup authorization
|
|
193
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
194
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
195
|
-
environment = "mypurecloud.com"
|
|
196
|
-
|
|
197
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
198
|
-
|
|
199
|
-
PureCloud.configure do |config|
|
|
200
|
-
config.access_token = @authToken
|
|
201
|
-
end
|
|
202
|
-
|
|
203
|
-
api_instance = PureCloud::MessagingApi.new
|
|
204
|
-
|
|
205
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
begin
|
|
209
|
-
#Delete a Twitter messaging integration
|
|
210
|
-
api_instance.delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
211
|
-
rescue PureCloud::ApiError => e
|
|
212
|
-
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
|
213
|
-
end
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
### Parameters
|
|
217
|
-
|
|
218
|
-
Name | Type | Description | Notes
|
|
219
|
-
------------- | ------------- | ------------- | -------------
|
|
220
|
-
**integration_id** | **String**| Integration ID | |
|
|
221
|
-
{: class="table table-striped"}
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
### Return type
|
|
225
|
-
|
|
226
|
-
nil (empty response body)
|
|
227
|
-
|
|
228
|
-
### HTTP request headers
|
|
229
|
-
|
|
230
|
-
- **Content-Type**: application/json
|
|
231
|
-
- **Accept**: application/json
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
28
|
<a name="delete_messaging_integrations_facebook_integration_id"></a>
|
|
236
29
|
|
|
237
30
|
## delete_messaging_integrations_facebook_integration_id(integration_id)
|
|
@@ -394,550 +187,14 @@ end
|
|
|
394
187
|
|
|
395
188
|
api_instance = PureCloud::MessagingApi.new
|
|
396
189
|
|
|
397
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
begin
|
|
401
|
-
#Delete a Twitter messaging integration
|
|
402
|
-
api_instance.delete_messaging_integrations_twitter_integration_id(integration_id)
|
|
403
|
-
rescue PureCloud::ApiError => e
|
|
404
|
-
puts "Exception when calling MessagingApi->delete_messaging_integrations_twitter_integration_id: #{e}"
|
|
405
|
-
end
|
|
406
|
-
```
|
|
407
|
-
|
|
408
|
-
### Parameters
|
|
409
|
-
|
|
410
|
-
Name | Type | Description | Notes
|
|
411
|
-
------------- | ------------- | ------------- | -------------
|
|
412
|
-
**integration_id** | **String**| Integration ID | |
|
|
413
|
-
{: class="table table-striped"}
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
### Return type
|
|
417
|
-
|
|
418
|
-
nil (empty response body)
|
|
419
|
-
|
|
420
|
-
### HTTP request headers
|
|
421
|
-
|
|
422
|
-
- **Content-Type**: application/json
|
|
423
|
-
- **Accept**: application/json
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
<a name="get_conversations_messaging_integrations"></a>
|
|
428
|
-
|
|
429
|
-
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_conversations_messaging_integrations(opts)
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
Get a list of Integrations
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
Wraps GET /api/v2/conversations/messaging/integrations
|
|
438
|
-
|
|
439
|
-
Requires ANY permissions:
|
|
440
|
-
|
|
441
|
-
* messaging:integration:view
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
### Example
|
|
445
|
-
```{"language":"ruby"}
|
|
446
|
-
# load the gem
|
|
447
|
-
require 'purecloudplatformclientv2'
|
|
448
|
-
# setup authorization
|
|
449
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
450
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
451
|
-
environment = "mypurecloud.com"
|
|
452
|
-
|
|
453
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
454
|
-
|
|
455
|
-
PureCloud.configure do |config|
|
|
456
|
-
config.access_token = @authToken
|
|
457
|
-
end
|
|
458
|
-
|
|
459
|
-
api_instance = PureCloud::MessagingApi.new
|
|
460
|
-
|
|
461
|
-
opts = {
|
|
462
|
-
page_size: 25, # Integer | Page size
|
|
463
|
-
page_number: 1 # Integer | Page number
|
|
464
|
-
}
|
|
465
|
-
|
|
466
|
-
begin
|
|
467
|
-
#Get a list of Integrations
|
|
468
|
-
result = api_instance.get_conversations_messaging_integrations(opts)
|
|
469
|
-
p result
|
|
470
|
-
rescue PureCloud::ApiError => e
|
|
471
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations: #{e}"
|
|
472
|
-
end
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
### Parameters
|
|
476
|
-
|
|
477
|
-
Name | Type | Description | Notes
|
|
478
|
-
------------- | ------------- | ------------- | -------------
|
|
479
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
480
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
481
|
-
{: class="table table-striped"}
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
### Return type
|
|
485
|
-
|
|
486
|
-
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
|
487
|
-
|
|
488
|
-
### HTTP request headers
|
|
489
|
-
|
|
490
|
-
- **Content-Type**: application/json
|
|
491
|
-
- **Accept**: application/json
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
<a name="get_conversations_messaging_integrations_facebook"></a>
|
|
496
|
-
|
|
497
|
-
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_conversations_messaging_integrations_facebook(opts)
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
Get a list of Facebook Integrations
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
Wraps GET /api/v2/conversations/messaging/integrations/facebook
|
|
506
|
-
|
|
507
|
-
Requires ANY permissions:
|
|
508
|
-
|
|
509
|
-
* messaging:integration:view
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
### Example
|
|
513
|
-
```{"language":"ruby"}
|
|
514
|
-
# load the gem
|
|
515
|
-
require 'purecloudplatformclientv2'
|
|
516
|
-
# setup authorization
|
|
517
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
518
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
519
|
-
environment = "mypurecloud.com"
|
|
520
|
-
|
|
521
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
522
|
-
|
|
523
|
-
PureCloud.configure do |config|
|
|
524
|
-
config.access_token = @authToken
|
|
525
|
-
end
|
|
526
|
-
|
|
527
|
-
api_instance = PureCloud::MessagingApi.new
|
|
528
|
-
|
|
529
|
-
opts = {
|
|
530
|
-
page_size: 25, # Integer | Page size
|
|
531
|
-
page_number: 1 # Integer | Page number
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
begin
|
|
535
|
-
#Get a list of Facebook Integrations
|
|
536
|
-
result = api_instance.get_conversations_messaging_integrations_facebook(opts)
|
|
537
|
-
p result
|
|
538
|
-
rescue PureCloud::ApiError => e
|
|
539
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_facebook: #{e}"
|
|
540
|
-
end
|
|
541
|
-
```
|
|
542
|
-
|
|
543
|
-
### Parameters
|
|
544
|
-
|
|
545
|
-
Name | Type | Description | Notes
|
|
546
|
-
------------- | ------------- | ------------- | -------------
|
|
547
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
548
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
549
|
-
{: class="table table-striped"}
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
### Return type
|
|
553
|
-
|
|
554
|
-
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
|
555
|
-
|
|
556
|
-
### HTTP request headers
|
|
557
|
-
|
|
558
|
-
- **Content-Type**: application/json
|
|
559
|
-
- **Accept**: application/json
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
<a name="get_conversations_messaging_integrations_facebook_integration_id"></a>
|
|
564
|
-
|
|
565
|
-
## [**FacebookIntegration**](FacebookIntegration.html) get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
Get a Facebook messaging integration
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
Wraps GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
|
574
|
-
|
|
575
|
-
Requires ANY permissions:
|
|
576
|
-
|
|
577
|
-
* messaging:integration:view
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
### Example
|
|
581
|
-
```{"language":"ruby"}
|
|
582
|
-
# load the gem
|
|
583
|
-
require 'purecloudplatformclientv2'
|
|
584
|
-
# setup authorization
|
|
585
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
586
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
587
|
-
environment = "mypurecloud.com"
|
|
588
|
-
|
|
589
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
590
|
-
|
|
591
|
-
PureCloud.configure do |config|
|
|
592
|
-
config.access_token = @authToken
|
|
593
|
-
end
|
|
594
|
-
|
|
595
|
-
api_instance = PureCloud::MessagingApi.new
|
|
596
|
-
|
|
597
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
begin
|
|
601
|
-
#Get a Facebook messaging integration
|
|
602
|
-
result = api_instance.get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
603
|
-
p result
|
|
604
|
-
rescue PureCloud::ApiError => e
|
|
605
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
|
606
|
-
end
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
### Parameters
|
|
610
|
-
|
|
611
|
-
Name | Type | Description | Notes
|
|
612
|
-
------------- | ------------- | ------------- | -------------
|
|
613
|
-
**integration_id** | **String**| Integration ID | |
|
|
614
|
-
{: class="table table-striped"}
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
### Return type
|
|
618
|
-
|
|
619
|
-
[**FacebookIntegration**](FacebookIntegration.html)
|
|
620
|
-
|
|
621
|
-
### HTTP request headers
|
|
622
|
-
|
|
623
|
-
- **Content-Type**: application/json
|
|
624
|
-
- **Accept**: application/json
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
<a name="get_conversations_messaging_integrations_line"></a>
|
|
629
|
-
|
|
630
|
-
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_conversations_messaging_integrations_line(opts)
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
Get a list of LINE messenger Integrations
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
Wraps GET /api/v2/conversations/messaging/integrations/line
|
|
639
|
-
|
|
640
|
-
Requires ANY permissions:
|
|
641
|
-
|
|
642
|
-
* messaging:integration:view
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
### Example
|
|
646
|
-
```{"language":"ruby"}
|
|
647
|
-
# load the gem
|
|
648
|
-
require 'purecloudplatformclientv2'
|
|
649
|
-
# setup authorization
|
|
650
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
651
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
652
|
-
environment = "mypurecloud.com"
|
|
653
|
-
|
|
654
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
655
|
-
|
|
656
|
-
PureCloud.configure do |config|
|
|
657
|
-
config.access_token = @authToken
|
|
658
|
-
end
|
|
659
|
-
|
|
660
|
-
api_instance = PureCloud::MessagingApi.new
|
|
661
|
-
|
|
662
|
-
opts = {
|
|
663
|
-
page_size: 25, # Integer | Page size
|
|
664
|
-
page_number: 1 # Integer | Page number
|
|
665
|
-
}
|
|
666
|
-
|
|
667
|
-
begin
|
|
668
|
-
#Get a list of LINE messenger Integrations
|
|
669
|
-
result = api_instance.get_conversations_messaging_integrations_line(opts)
|
|
670
|
-
p result
|
|
671
|
-
rescue PureCloud::ApiError => e
|
|
672
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_line: #{e}"
|
|
673
|
-
end
|
|
674
|
-
```
|
|
675
|
-
|
|
676
|
-
### Parameters
|
|
677
|
-
|
|
678
|
-
Name | Type | Description | Notes
|
|
679
|
-
------------- | ------------- | ------------- | -------------
|
|
680
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
681
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
682
|
-
{: class="table table-striped"}
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
### Return type
|
|
686
|
-
|
|
687
|
-
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
|
688
|
-
|
|
689
|
-
### HTTP request headers
|
|
690
|
-
|
|
691
|
-
- **Content-Type**: application/json
|
|
692
|
-
- **Accept**: application/json
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
<a name="get_conversations_messaging_integrations_line_integration_id"></a>
|
|
697
|
-
|
|
698
|
-
## [**LineIntegration**](LineIntegration.html) get_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
Get a LINE messenger integration
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
Wraps GET /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
707
|
-
|
|
708
|
-
Requires ANY permissions:
|
|
709
|
-
|
|
710
|
-
* messaging:integration:view
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
### Example
|
|
714
|
-
```{"language":"ruby"}
|
|
715
|
-
# load the gem
|
|
716
|
-
require 'purecloudplatformclientv2'
|
|
717
|
-
# setup authorization
|
|
718
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
719
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
720
|
-
environment = "mypurecloud.com"
|
|
721
|
-
|
|
722
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
723
|
-
|
|
724
|
-
PureCloud.configure do |config|
|
|
725
|
-
config.access_token = @authToken
|
|
726
|
-
end
|
|
727
|
-
|
|
728
|
-
api_instance = PureCloud::MessagingApi.new
|
|
729
|
-
|
|
730
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
begin
|
|
734
|
-
#Get a LINE messenger integration
|
|
735
|
-
result = api_instance.get_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
736
|
-
p result
|
|
737
|
-
rescue PureCloud::ApiError => e
|
|
738
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
739
|
-
end
|
|
740
|
-
```
|
|
741
|
-
|
|
742
|
-
### Parameters
|
|
743
|
-
|
|
744
|
-
Name | Type | Description | Notes
|
|
745
|
-
------------- | ------------- | ------------- | -------------
|
|
746
|
-
**integration_id** | **String**| Integration ID | |
|
|
747
|
-
{: class="table table-striped"}
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
### Return type
|
|
751
|
-
|
|
752
|
-
[**LineIntegration**](LineIntegration.html)
|
|
753
|
-
|
|
754
|
-
### HTTP request headers
|
|
755
|
-
|
|
756
|
-
- **Content-Type**: application/json
|
|
757
|
-
- **Accept**: application/json
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
<a name="get_conversations_messaging_integrations_twitter"></a>
|
|
762
|
-
|
|
763
|
-
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_conversations_messaging_integrations_twitter(opts)
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
Get a list of Twitter Integrations
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
Wraps GET /api/v2/conversations/messaging/integrations/twitter
|
|
772
|
-
|
|
773
|
-
Requires ANY permissions:
|
|
774
|
-
|
|
775
|
-
* messaging:integration:view
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
### Example
|
|
779
|
-
```{"language":"ruby"}
|
|
780
|
-
# load the gem
|
|
781
|
-
require 'purecloudplatformclientv2'
|
|
782
|
-
# setup authorization
|
|
783
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
784
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
785
|
-
environment = "mypurecloud.com"
|
|
786
|
-
|
|
787
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
788
|
-
|
|
789
|
-
PureCloud.configure do |config|
|
|
790
|
-
config.access_token = @authToken
|
|
791
|
-
end
|
|
792
|
-
|
|
793
|
-
api_instance = PureCloud::MessagingApi.new
|
|
794
|
-
|
|
795
|
-
opts = {
|
|
796
|
-
page_size: 25, # Integer | Page size
|
|
797
|
-
page_number: 1 # Integer | Page number
|
|
798
|
-
}
|
|
799
|
-
|
|
800
|
-
begin
|
|
801
|
-
#Get a list of Twitter Integrations
|
|
802
|
-
result = api_instance.get_conversations_messaging_integrations_twitter(opts)
|
|
803
|
-
p result
|
|
804
|
-
rescue PureCloud::ApiError => e
|
|
805
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_twitter: #{e}"
|
|
806
|
-
end
|
|
807
|
-
```
|
|
808
|
-
|
|
809
|
-
### Parameters
|
|
810
|
-
|
|
811
|
-
Name | Type | Description | Notes
|
|
812
|
-
------------- | ------------- | ------------- | -------------
|
|
813
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
814
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
815
|
-
{: class="table table-striped"}
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
### Return type
|
|
819
|
-
|
|
820
|
-
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
|
821
|
-
|
|
822
|
-
### HTTP request headers
|
|
823
|
-
|
|
824
|
-
- **Content-Type**: application/json
|
|
825
|
-
- **Accept**: application/json
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
<a name="get_conversations_messaging_integrations_twitter_integration_id"></a>
|
|
830
|
-
|
|
831
|
-
## [**TwitterIntegration**](TwitterIntegration.html) get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
Get a Twitter messaging integration
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
Wraps GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
|
840
|
-
|
|
841
|
-
Requires ANY permissions:
|
|
842
|
-
|
|
843
|
-
* messaging:integration:view
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
### Example
|
|
847
|
-
```{"language":"ruby"}
|
|
848
|
-
# load the gem
|
|
849
|
-
require 'purecloudplatformclientv2'
|
|
850
|
-
# setup authorization
|
|
851
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
852
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
853
|
-
environment = "mypurecloud.com"
|
|
854
|
-
|
|
855
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
856
|
-
|
|
857
|
-
PureCloud.configure do |config|
|
|
858
|
-
config.access_token = @authToken
|
|
859
|
-
end
|
|
860
|
-
|
|
861
|
-
api_instance = PureCloud::MessagingApi.new
|
|
862
|
-
|
|
863
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
begin
|
|
867
|
-
#Get a Twitter messaging integration
|
|
868
|
-
result = api_instance.get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
869
|
-
p result
|
|
870
|
-
rescue PureCloud::ApiError => e
|
|
871
|
-
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
|
872
|
-
end
|
|
873
|
-
```
|
|
874
|
-
|
|
875
|
-
### Parameters
|
|
876
|
-
|
|
877
|
-
Name | Type | Description | Notes
|
|
878
|
-
------------- | ------------- | ------------- | -------------
|
|
879
|
-
**integration_id** | **String**| Integration ID | |
|
|
880
|
-
{: class="table table-striped"}
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
### Return type
|
|
884
|
-
|
|
885
|
-
[**TwitterIntegration**](TwitterIntegration.html)
|
|
886
|
-
|
|
887
|
-
### HTTP request headers
|
|
888
|
-
|
|
889
|
-
- **Content-Type**: application/json
|
|
890
|
-
- **Accept**: application/json
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
<a name="get_conversations_messaging_sticker"></a>
|
|
895
|
-
|
|
896
|
-
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_conversations_messaging_sticker(messenger_type, opts)
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
Get a list of Messaging Stickers
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
Wraps GET /api/v2/conversations/messaging/stickers/{messengerType}
|
|
905
|
-
|
|
906
|
-
Requires ANY permissions:
|
|
907
|
-
|
|
908
|
-
* conversation:message:create
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
### Example
|
|
912
|
-
```{"language":"ruby"}
|
|
913
|
-
# load the gem
|
|
914
|
-
require 'purecloudplatformclientv2'
|
|
915
|
-
# setup authorization
|
|
916
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
917
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
918
|
-
environment = "mypurecloud.com"
|
|
919
|
-
|
|
920
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
921
|
-
|
|
922
|
-
PureCloud.configure do |config|
|
|
923
|
-
config.access_token = @authToken
|
|
924
|
-
end
|
|
925
|
-
|
|
926
|
-
api_instance = PureCloud::MessagingApi.new
|
|
927
|
-
|
|
928
|
-
messenger_type = "messenger_type_example" # String | Messenger Type
|
|
929
|
-
|
|
930
|
-
opts = {
|
|
931
|
-
page_size: 25, # Integer | Page size
|
|
932
|
-
page_number: 1 # Integer | Page number
|
|
933
|
-
}
|
|
190
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
191
|
+
|
|
934
192
|
|
|
935
193
|
begin
|
|
936
|
-
#
|
|
937
|
-
|
|
938
|
-
p result
|
|
194
|
+
#Delete a Twitter messaging integration
|
|
195
|
+
api_instance.delete_messaging_integrations_twitter_integration_id(integration_id)
|
|
939
196
|
rescue PureCloud::ApiError => e
|
|
940
|
-
puts "Exception when calling MessagingApi->
|
|
197
|
+
puts "Exception when calling MessagingApi->delete_messaging_integrations_twitter_integration_id: #{e}"
|
|
941
198
|
end
|
|
942
199
|
```
|
|
943
200
|
|
|
@@ -945,15 +202,13 @@ end
|
|
|
945
202
|
|
|
946
203
|
Name | Type | Description | Notes
|
|
947
204
|
------------- | ------------- | ------------- | -------------
|
|
948
|
-
**
|
|
949
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
950
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
205
|
+
**integration_id** | **String**| Integration ID | |
|
|
951
206
|
{: class="table table-striped"}
|
|
952
207
|
|
|
953
208
|
|
|
954
209
|
### Return type
|
|
955
210
|
|
|
956
|
-
|
|
211
|
+
nil (empty response body)
|
|
957
212
|
|
|
958
213
|
### HTTP request headers
|
|
959
214
|
|
|
@@ -1500,201 +755,6 @@ Name | Type | Description | Notes
|
|
|
1500
755
|
|
|
1501
756
|
|
|
1502
757
|
|
|
1503
|
-
<a name="post_conversations_messaging_integrations_facebook"></a>
|
|
1504
|
-
|
|
1505
|
-
## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
Create a Facebook Integration
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
Wraps POST /api/v2/conversations/messaging/integrations/facebook
|
|
1514
|
-
|
|
1515
|
-
Requires ANY permissions:
|
|
1516
|
-
|
|
1517
|
-
* messaging:integration:add
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
### Example
|
|
1521
|
-
```{"language":"ruby"}
|
|
1522
|
-
# load the gem
|
|
1523
|
-
require 'purecloudplatformclientv2'
|
|
1524
|
-
# setup authorization
|
|
1525
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1526
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1527
|
-
environment = "mypurecloud.com"
|
|
1528
|
-
|
|
1529
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1530
|
-
|
|
1531
|
-
PureCloud.configure do |config|
|
|
1532
|
-
config.access_token = @authToken
|
|
1533
|
-
end
|
|
1534
|
-
|
|
1535
|
-
api_instance = PureCloud::MessagingApi.new
|
|
1536
|
-
|
|
1537
|
-
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
begin
|
|
1541
|
-
#Create a Facebook Integration
|
|
1542
|
-
result = api_instance.post_conversations_messaging_integrations_facebook(body)
|
|
1543
|
-
p result
|
|
1544
|
-
rescue PureCloud::ApiError => e
|
|
1545
|
-
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_facebook: #{e}"
|
|
1546
|
-
end
|
|
1547
|
-
```
|
|
1548
|
-
|
|
1549
|
-
### Parameters
|
|
1550
|
-
|
|
1551
|
-
Name | Type | Description | Notes
|
|
1552
|
-
------------- | ------------- | ------------- | -------------
|
|
1553
|
-
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
|
1554
|
-
{: class="table table-striped"}
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
### Return type
|
|
1558
|
-
|
|
1559
|
-
[**FacebookIntegration**](FacebookIntegration.html)
|
|
1560
|
-
|
|
1561
|
-
### HTTP request headers
|
|
1562
|
-
|
|
1563
|
-
- **Content-Type**: application/json
|
|
1564
|
-
- **Accept**: application/json
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
<a name="post_conversations_messaging_integrations_line"></a>
|
|
1569
|
-
|
|
1570
|
-
## [**LineIntegration**](LineIntegration.html) post_conversations_messaging_integrations_line(body)
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
Create a LINE messenger Integration
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
Wraps POST /api/v2/conversations/messaging/integrations/line
|
|
1579
|
-
|
|
1580
|
-
Requires ANY permissions:
|
|
1581
|
-
|
|
1582
|
-
* messaging:integration:add
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
### Example
|
|
1586
|
-
```{"language":"ruby"}
|
|
1587
|
-
# load the gem
|
|
1588
|
-
require 'purecloudplatformclientv2'
|
|
1589
|
-
# setup authorization
|
|
1590
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1591
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1592
|
-
environment = "mypurecloud.com"
|
|
1593
|
-
|
|
1594
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1595
|
-
|
|
1596
|
-
PureCloud.configure do |config|
|
|
1597
|
-
config.access_token = @authToken
|
|
1598
|
-
end
|
|
1599
|
-
|
|
1600
|
-
api_instance = PureCloud::MessagingApi.new
|
|
1601
|
-
|
|
1602
|
-
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
begin
|
|
1606
|
-
#Create a LINE messenger Integration
|
|
1607
|
-
result = api_instance.post_conversations_messaging_integrations_line(body)
|
|
1608
|
-
p result
|
|
1609
|
-
rescue PureCloud::ApiError => e
|
|
1610
|
-
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_line: #{e}"
|
|
1611
|
-
end
|
|
1612
|
-
```
|
|
1613
|
-
|
|
1614
|
-
### Parameters
|
|
1615
|
-
|
|
1616
|
-
Name | Type | Description | Notes
|
|
1617
|
-
------------- | ------------- | ------------- | -------------
|
|
1618
|
-
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
|
1619
|
-
{: class="table table-striped"}
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
### Return type
|
|
1623
|
-
|
|
1624
|
-
[**LineIntegration**](LineIntegration.html)
|
|
1625
|
-
|
|
1626
|
-
### HTTP request headers
|
|
1627
|
-
|
|
1628
|
-
- **Content-Type**: application/json
|
|
1629
|
-
- **Accept**: application/json
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
<a name="post_conversations_messaging_integrations_twitter"></a>
|
|
1634
|
-
|
|
1635
|
-
## [**TwitterIntegration**](TwitterIntegration.html) post_conversations_messaging_integrations_twitter(body)
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
Create a Twitter Integration
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
Wraps POST /api/v2/conversations/messaging/integrations/twitter
|
|
1644
|
-
|
|
1645
|
-
Requires ANY permissions:
|
|
1646
|
-
|
|
1647
|
-
* messaging:integration:add
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
### Example
|
|
1651
|
-
```{"language":"ruby"}
|
|
1652
|
-
# load the gem
|
|
1653
|
-
require 'purecloudplatformclientv2'
|
|
1654
|
-
# setup authorization
|
|
1655
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1656
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1657
|
-
environment = "mypurecloud.com"
|
|
1658
|
-
|
|
1659
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1660
|
-
|
|
1661
|
-
PureCloud.configure do |config|
|
|
1662
|
-
config.access_token = @authToken
|
|
1663
|
-
end
|
|
1664
|
-
|
|
1665
|
-
api_instance = PureCloud::MessagingApi.new
|
|
1666
|
-
|
|
1667
|
-
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
begin
|
|
1671
|
-
#Create a Twitter Integration
|
|
1672
|
-
result = api_instance.post_conversations_messaging_integrations_twitter(body)
|
|
1673
|
-
p result
|
|
1674
|
-
rescue PureCloud::ApiError => e
|
|
1675
|
-
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_twitter: #{e}"
|
|
1676
|
-
end
|
|
1677
|
-
```
|
|
1678
|
-
|
|
1679
|
-
### Parameters
|
|
1680
|
-
|
|
1681
|
-
Name | Type | Description | Notes
|
|
1682
|
-
------------- | ------------- | ------------- | -------------
|
|
1683
|
-
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
|
1684
|
-
{: class="table table-striped"}
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
### Return type
|
|
1688
|
-
|
|
1689
|
-
[**TwitterIntegration**](TwitterIntegration.html)
|
|
1690
|
-
|
|
1691
|
-
### HTTP request headers
|
|
1692
|
-
|
|
1693
|
-
- **Content-Type**: application/json
|
|
1694
|
-
- **Accept**: application/json
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
758
|
<a name="post_messaging_integrations_facebook"></a>
|
|
1699
759
|
|
|
1700
760
|
## [**FacebookIntegration**](FacebookIntegration.html) post_messaging_integrations_facebook(body)
|
|
@@ -1890,74 +950,6 @@ Name | Type | Description | Notes
|
|
|
1890
950
|
|
|
1891
951
|
|
|
1892
952
|
|
|
1893
|
-
<a name="put_conversations_messaging_integrations_line_integration_id"></a>
|
|
1894
|
-
|
|
1895
|
-
## [**LineIntegration**](LineIntegration.html) put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
Update a LINE messenger integration
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
Wraps PUT /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
1904
|
-
|
|
1905
|
-
Requires ANY permissions:
|
|
1906
|
-
|
|
1907
|
-
* messaging:integration:edit
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
### Example
|
|
1911
|
-
```{"language":"ruby"}
|
|
1912
|
-
# load the gem
|
|
1913
|
-
require 'purecloudplatformclientv2'
|
|
1914
|
-
# setup authorization
|
|
1915
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1916
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1917
|
-
environment = "mypurecloud.com"
|
|
1918
|
-
|
|
1919
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1920
|
-
|
|
1921
|
-
PureCloud.configure do |config|
|
|
1922
|
-
config.access_token = @authToken
|
|
1923
|
-
end
|
|
1924
|
-
|
|
1925
|
-
api_instance = PureCloud::MessagingApi.new
|
|
1926
|
-
|
|
1927
|
-
integration_id = "integration_id_example" # String | Integration ID
|
|
1928
|
-
|
|
1929
|
-
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
begin
|
|
1933
|
-
#Update a LINE messenger integration
|
|
1934
|
-
result = api_instance.put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
|
1935
|
-
p result
|
|
1936
|
-
rescue PureCloud::ApiError => e
|
|
1937
|
-
puts "Exception when calling MessagingApi->put_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
1938
|
-
end
|
|
1939
|
-
```
|
|
1940
|
-
|
|
1941
|
-
### Parameters
|
|
1942
|
-
|
|
1943
|
-
Name | Type | Description | Notes
|
|
1944
|
-
------------- | ------------- | ------------- | -------------
|
|
1945
|
-
**integration_id** | **String**| Integration ID | |
|
|
1946
|
-
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
|
1947
|
-
{: class="table table-striped"}
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
### Return type
|
|
1951
|
-
|
|
1952
|
-
[**LineIntegration**](LineIntegration.html)
|
|
1953
|
-
|
|
1954
|
-
### HTTP request headers
|
|
1955
|
-
|
|
1956
|
-
- **Content-Type**: application/json
|
|
1957
|
-
- **Accept**: application/json
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
953
|
<a name="put_messaging_integrations_line_integration_id"></a>
|
|
1962
954
|
|
|
1963
955
|
## [**LineIntegration**](LineIntegration.html) put_messaging_integrations_line_integration_id(integration_id, body)
|