purecloudplatformclientv2 60.0.0 → 61.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/ArchitectApi.md +16 -16
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AuthzDivisionEntityListing.md +2 -2
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListDivisionViewListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationsApi.md +1033 -25
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataSchema.md +1 -1
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DialogflowAgentSummaryEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListDivisionViewListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmbeddedIntegration.md +14 -0
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegrationEntityListing.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowOutcomeListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupContact.md +1 -0
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/IVREntityListing.md +2 -2
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LexBotAliasEntityListing.md +2 -2
- data/docs/LexBotEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegrationEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/Manager.md +1 -1
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessagingApi.md +7 -1015
- data/docs/MessagingIntegrationEntityListing.md +2 -2
- data/docs/MessagingStickerEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrganizationApi.md +133 -8
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/Photo.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/RecipientListing.md +2 -2
- data/docs/RecordingApi.md +9 -1
- data/docs/RecordingJobEntityListing.md +2 -2
- data/docs/RecordingJobsQuery.md +1 -0
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +137 -2
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScimEmail.md +3 -3
- data/docs/ScimMetadata.md +4 -4
- data/docs/ScimPhoneNumber.md +3 -3
- data/docs/ScimV2CreateUser.md +11 -10
- data/docs/ScimV2EnterpriseUser.md +3 -3
- data/docs/ScimV2Group.md +2 -2
- data/docs/ScimV2GroupReference.md +1 -1
- data/docs/ScimV2MemberReference.md +1 -1
- data/docs/ScimV2PatchOperation.md +3 -3
- data/docs/ScimV2PatchRequest.md +1 -1
- data/docs/ScimV2User.md +11 -10
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsAddress.md +21 -0
- data/docs/SmsAddressEntityListing.md +22 -0
- data/docs/SmsPhoneNumber.md +1 -0
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/SmsPhoneNumberProvision.md +1 -0
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TelephonyProvidersEdgeApi.md +4 -0
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TokenInfo.md +1 -0
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TtsEngineEntityListing.md +2 -2
- data/docs/TtsVoiceEntityListing.md +2 -2
- data/docs/TwitterIntegrationEntityListing.md +2 -2
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UserTokensTopicTokenNotification.md +3 -0
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WebChatMemberInfoEntityList.md +2 -2
- data/docs/WorkforceManagementApi.md +1 -1
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/lib/purecloudplatformclientv2.rb +3 -7
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +1056 -24
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +10 -1042
- data/lib/purecloudplatformclientv2/api/organization_api.rb +124 -4
- data/lib/purecloudplatformclientv2/api/recording_api.rb +48 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +141 -3
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
- 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 +13 -13
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{base_topic_entitiy.rb → embedded_integration.rb} +16 -41
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_contact.rb +27 -1
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/photo.rb +2 -2
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +34 -3
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/scim_email.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +39 -11
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +1 -1
- 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 +39 -11
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{program.rb → sms_address.rb} +45 -83
- data/lib/purecloudplatformclientv2/models/{base_program_entity.rb → sms_address_entity_listing.rb} +194 -19
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +27 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +27 -1
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/token_info.rb +29 -1
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_tokens_topic_token_notification.rb +79 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +8 -16
- data/docs/BaseProgramEntity.md +0 -15
- data/docs/BaseTopicEntitiy.md +0 -15
- data/docs/CreateTopicRequest.md +0 -20
- data/docs/Phrase.md +0 -15
- data/docs/Program.md +0 -22
- data/docs/SpeechTextAnalyticsApi.md +0 -210
- data/docs/Topic.md +0 -25
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +0 -222
- data/lib/purecloudplatformclientv2/models/create_topic_request.rb +0 -438
- data/lib/purecloudplatformclientv2/models/phrase.rb +0 -297
- data/lib/purecloudplatformclientv2/models/topic.rb +0 -538
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1b23bee99f935e73c5a5593cef913b9373aa76ae
|
4
|
+
data.tar.gz: 55fbd36b64fc039bd956ef0c5507e30231c6e340
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '098baf9df733831372f5d63a5d350d943f73e8974ef38ba12ed870761fc2bbb8b14e8176f926de96ba3fbcbedc58b4d5a4ad9689a93751def7eccf1a99bda10a'
|
7
|
+
data.tar.gz: 7c73ddb73d8594860f5568a12b967ed34742fcdedff647d060527fb7ef6ba41dbc9e16aa8c5ed77e9a494fb0e92cc5a5ab1b2e7f627531509503467301c2fdfa
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: PureCloud Ruby Gem
|
3
3
|
---
|
4
|
-

|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 61.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/ActionEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: ActionEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/ArchitectApi.md
CHANGED
@@ -1012,11 +1012,11 @@ Name | Type | Description | Notes
|
|
1012
1012
|
**name** | **String**| Object name to search for | |
|
1013
1013
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1014
1014
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1015
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1015
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1016
1016
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
1017
1017
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
1018
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1019
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1018
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1019
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1020
1020
|
{: class="table table-striped"}
|
1021
1021
|
|
1022
1022
|
|
@@ -1151,8 +1151,8 @@ Name | Type | Description | Notes
|
|
1151
1151
|
------------- | ------------- | ------------- | -------------
|
1152
1152
|
**id** | **String**| Consuming object ID | |
|
1153
1153
|
**version** | **String**| Consuming object version | |
|
1154
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1155
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1154
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1155
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1156
1156
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1157
1157
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1158
1158
|
{: class="table table-striped"}
|
@@ -1228,8 +1228,8 @@ end
|
|
1228
1228
|
Name | Type | Description | Notes
|
1229
1229
|
------------- | ------------- | ------------- | -------------
|
1230
1230
|
**id** | **String**| Consumed object ID | |
|
1231
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1232
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1231
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1232
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1233
1233
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1234
1234
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1235
1235
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
@@ -1305,10 +1305,10 @@ end
|
|
1305
1305
|
Name | Type | Description | Notes
|
1306
1306
|
------------- | ------------- | ------------- | -------------
|
1307
1307
|
**name** | **String**| Name to search for | [optional] |
|
1308
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1308
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1309
1309
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
1310
1310
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1311
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1311
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1312
1312
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1313
1313
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1314
1314
|
{: class="table table-striped"}
|
@@ -1385,11 +1385,11 @@ Name | Type | Description | Notes
|
|
1385
1385
|
------------- | ------------- | ------------- | -------------
|
1386
1386
|
**id** | **String**| Object ID | |
|
1387
1387
|
**version** | **String**| Object version | [optional] |
|
1388
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1388
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1389
1389
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
1390
1390
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
1391
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1392
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1391
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1392
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1393
1393
|
{: class="table table-striped"}
|
1394
1394
|
|
1395
1395
|
|
@@ -1594,9 +1594,9 @@ end
|
|
1594
1594
|
Name | Type | Description | Notes
|
1595
1595
|
------------- | ------------- | ------------- | -------------
|
1596
1596
|
**name** | **String**| Name to search for | [optional] |
|
1597
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1597
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1598
1598
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1599
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET
|
1599
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET |
|
1600
1600
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1601
1601
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1602
1602
|
{: class="table table-striped"}
|
@@ -3400,7 +3400,7 @@ end
|
|
3400
3400
|
|
3401
3401
|
Name | Type | Description | Notes
|
3402
3402
|
------------- | ------------- | ------------- | -------------
|
3403
|
-
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: commonmodule, inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite
|
3403
|
+
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: commonmodule, inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite |
|
3404
3404
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3405
3405
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3406
3406
|
**sort_by** | **String**| Sort by | [optional] [default to id] |
|
@@ -3781,7 +3781,7 @@ end
|
|
3781
3781
|
|
3782
3782
|
Name | Type | Description | Notes
|
3783
3783
|
------------- | ------------- | ------------- | -------------
|
3784
|
-
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: commonmodule, inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite
|
3784
|
+
**type** | [**Array<String>**](String.html)| Type | [optional] <br />**Values**: commonmodule, inboundcall, inboundchat, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite |
|
3785
3785
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3786
3786
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3787
3787
|
**sort_by** | **String**| Sort by | [optional] [default to id] |
|
@@ -13,9 +13,9 @@ title: AttemptLimitsEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: AuthzDivisionEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CalibrationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CallConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CallHistoryConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CallableTimeSetEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CallbackConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CampaignDivisionViewListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CampaignEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CampaignRuleEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CampaignSequenceEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CertificateAuthorityEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ChatConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ClientAppEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CobrowseConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: CommandStatusEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ConsumedResourcesEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ConsumingResourcesEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ContactListDivisionViewListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ContactListEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ContactListFilterEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/ContactListing.md
CHANGED
@@ -13,9 +13,9 @@ title: ContactListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: ConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/ConversationsApi.md
CHANGED
@@ -12,6 +12,9 @@ Method | Description
|
|
12
12
|
[**delete_conversation_participant_flaggedreason**](ConversationsApi.html#delete_conversation_participant_flaggedreason) | Remove flagged reason from conversation participant.
|
13
13
|
[**delete_conversations_call_participant_consult**](ConversationsApi.html#delete_conversations_call_participant_consult) | Cancel the transfer
|
14
14
|
[**delete_conversations_email_messages_draft_attachment**](ConversationsApi.html#delete_conversations_email_messages_draft_attachment) | Delete attachment from draft
|
15
|
+
[**delete_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
16
|
+
[**delete_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
17
|
+
[**delete_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
15
18
|
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
16
19
|
[**get_analytics_conversations_details**](ConversationsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
|
17
20
|
[**get_conversation**](ConversationsApi.html#get_conversation) | Get conversation
|
@@ -51,6 +54,14 @@ Method | Description
|
|
51
54
|
[**get_conversations_message_participant_wrapup**](ConversationsApi.html#get_conversations_message_participant_wrapup) | Get the wrap-up for this conversation participant.
|
52
55
|
[**get_conversations_message_participant_wrapupcodes**](ConversationsApi.html#get_conversations_message_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
53
56
|
[**get_conversations_messages**](ConversationsApi.html#get_conversations_messages) | Get active message conversations for the logged in user
|
57
|
+
[**get_conversations_messaging_integrations**](ConversationsApi.html#get_conversations_messaging_integrations) | Get a list of Integrations
|
58
|
+
[**get_conversations_messaging_integrations_facebook**](ConversationsApi.html#get_conversations_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
59
|
+
[**get_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
60
|
+
[**get_conversations_messaging_integrations_line**](ConversationsApi.html#get_conversations_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
61
|
+
[**get_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
62
|
+
[**get_conversations_messaging_integrations_twitter**](ConversationsApi.html#get_conversations_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
63
|
+
[**get_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
64
|
+
[**get_conversations_messaging_sticker**](ConversationsApi.html#get_conversations_messaging_sticker) | Get a list of Messaging Stickers
|
54
65
|
[**patch_conversation_participant**](ConversationsApi.html#patch_conversation_participant) | Update a participant.
|
55
66
|
[**patch_conversation_participant_attributes**](ConversationsApi.html#patch_conversation_participant_attributes) | Update the attributes on a conversation participant.
|
56
67
|
[**patch_conversations_call**](ConversationsApi.html#patch_conversations_call) | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
@@ -107,9 +118,13 @@ Method | Description
|
|
107
118
|
[**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
|
108
119
|
[**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
|
109
120
|
[**post_conversations_messages**](ConversationsApi.html#post_conversations_messages) | Create an outbound messaging conversation.
|
121
|
+
[**post_conversations_messaging_integrations_facebook**](ConversationsApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
|
122
|
+
[**post_conversations_messaging_integrations_line**](ConversationsApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
|
123
|
+
[**post_conversations_messaging_integrations_twitter**](ConversationsApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
|
110
124
|
[**put_conversation_participant_flaggedreason**](ConversationsApi.html#put_conversation_participant_flaggedreason) | Set flagged reason on conversation participant to indicate bad conversation quality.
|
111
125
|
[**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
|
112
126
|
[**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
|
127
|
+
[**put_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#put_conversations_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
113
128
|
{: class="table table-striped"}
|
114
129
|
|
115
130
|
<a name="delete_conversation_participant_code"></a>
|
@@ -379,6 +394,198 @@ nil (empty response body)
|
|
379
394
|
|
380
395
|
|
381
396
|
|
397
|
+
<a name="delete_conversations_messaging_integrations_facebook_integration_id"></a>
|
398
|
+
|
399
|
+
## delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
Delete a Facebook messaging integration
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
408
|
+
|
409
|
+
Requires ANY permissions:
|
410
|
+
|
411
|
+
* messaging:integration:delete
|
412
|
+
|
413
|
+
|
414
|
+
### Example
|
415
|
+
```{"language":"ruby"}
|
416
|
+
# load the gem
|
417
|
+
require 'purecloudplatformclientv2'
|
418
|
+
# setup authorization
|
419
|
+
@secret = ENV['PURECLOUD_SECRET']
|
420
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
421
|
+
environment = "mypurecloud.com"
|
422
|
+
|
423
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
424
|
+
|
425
|
+
PureCloud.configure do |config|
|
426
|
+
config.access_token = @authToken
|
427
|
+
end
|
428
|
+
|
429
|
+
api_instance = PureCloud::ConversationsApi.new
|
430
|
+
|
431
|
+
integration_id = "integration_id_example" # String | Integration ID
|
432
|
+
|
433
|
+
|
434
|
+
begin
|
435
|
+
#Delete a Facebook messaging integration
|
436
|
+
api_instance.delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
437
|
+
rescue PureCloud::ApiError => e
|
438
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
439
|
+
end
|
440
|
+
```
|
441
|
+
|
442
|
+
### Parameters
|
443
|
+
|
444
|
+
Name | Type | Description | Notes
|
445
|
+
------------- | ------------- | ------------- | -------------
|
446
|
+
**integration_id** | **String**| Integration ID | |
|
447
|
+
{: class="table table-striped"}
|
448
|
+
|
449
|
+
|
450
|
+
### Return type
|
451
|
+
|
452
|
+
nil (empty response body)
|
453
|
+
|
454
|
+
### HTTP request headers
|
455
|
+
|
456
|
+
- **Content-Type**: application/json
|
457
|
+
- **Accept**: application/json
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
<a name="delete_conversations_messaging_integrations_line_integration_id"></a>
|
462
|
+
|
463
|
+
## delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
Delete a LINE messenger integration
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}
|
472
|
+
|
473
|
+
Requires ANY permissions:
|
474
|
+
|
475
|
+
* messaging:integration:delete
|
476
|
+
|
477
|
+
|
478
|
+
### Example
|
479
|
+
```{"language":"ruby"}
|
480
|
+
# load the gem
|
481
|
+
require 'purecloudplatformclientv2'
|
482
|
+
# setup authorization
|
483
|
+
@secret = ENV['PURECLOUD_SECRET']
|
484
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
485
|
+
environment = "mypurecloud.com"
|
486
|
+
|
487
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
488
|
+
|
489
|
+
PureCloud.configure do |config|
|
490
|
+
config.access_token = @authToken
|
491
|
+
end
|
492
|
+
|
493
|
+
api_instance = PureCloud::ConversationsApi.new
|
494
|
+
|
495
|
+
integration_id = "integration_id_example" # String | Integration ID
|
496
|
+
|
497
|
+
|
498
|
+
begin
|
499
|
+
#Delete a LINE messenger integration
|
500
|
+
api_instance.delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
501
|
+
rescue PureCloud::ApiError => e
|
502
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_line_integration_id: #{e}"
|
503
|
+
end
|
504
|
+
```
|
505
|
+
|
506
|
+
### Parameters
|
507
|
+
|
508
|
+
Name | Type | Description | Notes
|
509
|
+
------------- | ------------- | ------------- | -------------
|
510
|
+
**integration_id** | **String**| Integration ID | |
|
511
|
+
{: class="table table-striped"}
|
512
|
+
|
513
|
+
|
514
|
+
### Return type
|
515
|
+
|
516
|
+
nil (empty response body)
|
517
|
+
|
518
|
+
### HTTP request headers
|
519
|
+
|
520
|
+
- **Content-Type**: application/json
|
521
|
+
- **Accept**: application/json
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
<a name="delete_conversations_messaging_integrations_twitter_integration_id"></a>
|
526
|
+
|
527
|
+
## delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
Delete a Twitter messaging integration
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
536
|
+
|
537
|
+
Requires ANY permissions:
|
538
|
+
|
539
|
+
* messaging:integration:delete
|
540
|
+
|
541
|
+
|
542
|
+
### Example
|
543
|
+
```{"language":"ruby"}
|
544
|
+
# load the gem
|
545
|
+
require 'purecloudplatformclientv2'
|
546
|
+
# setup authorization
|
547
|
+
@secret = ENV['PURECLOUD_SECRET']
|
548
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
549
|
+
environment = "mypurecloud.com"
|
550
|
+
|
551
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
552
|
+
|
553
|
+
PureCloud.configure do |config|
|
554
|
+
config.access_token = @authToken
|
555
|
+
end
|
556
|
+
|
557
|
+
api_instance = PureCloud::ConversationsApi.new
|
558
|
+
|
559
|
+
integration_id = "integration_id_example" # String | Integration ID
|
560
|
+
|
561
|
+
|
562
|
+
begin
|
563
|
+
#Delete a Twitter messaging integration
|
564
|
+
api_instance.delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
565
|
+
rescue PureCloud::ApiError => e
|
566
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
567
|
+
end
|
568
|
+
```
|
569
|
+
|
570
|
+
### Parameters
|
571
|
+
|
572
|
+
Name | Type | Description | Notes
|
573
|
+
------------- | ------------- | ------------- | -------------
|
574
|
+
**integration_id** | **String**| Integration ID | |
|
575
|
+
{: class="table table-striped"}
|
576
|
+
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
nil (empty response body)
|
581
|
+
|
582
|
+
### HTTP request headers
|
583
|
+
|
584
|
+
- **Content-Type**: application/json
|
585
|
+
- **Accept**: application/json
|
586
|
+
|
587
|
+
|
588
|
+
|
382
589
|
<a name="get_analytics_conversation_details"></a>
|
383
590
|
|
384
591
|
## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
@@ -2804,7 +3011,534 @@ Name | Type | Description | Notes
|
|
2804
3011
|
|
2805
3012
|
### Return type
|
2806
3013
|
|
2807
|
-
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
3014
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
3015
|
+
|
3016
|
+
### HTTP request headers
|
3017
|
+
|
3018
|
+
- **Content-Type**: application/json
|
3019
|
+
- **Accept**: application/json
|
3020
|
+
|
3021
|
+
|
3022
|
+
|
3023
|
+
<a name="get_conversations_message_participant_wrapupcodes"></a>
|
3024
|
+
|
3025
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
3026
|
+
|
3027
|
+
|
3028
|
+
|
3029
|
+
Get list of wrapup codes for this conversation participant
|
3030
|
+
|
3031
|
+
|
3032
|
+
|
3033
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes
|
3034
|
+
|
3035
|
+
Requires NO permissions:
|
3036
|
+
|
3037
|
+
|
3038
|
+
|
3039
|
+
### Example
|
3040
|
+
```{"language":"ruby"}
|
3041
|
+
# load the gem
|
3042
|
+
require 'purecloudplatformclientv2'
|
3043
|
+
# setup authorization
|
3044
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3045
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3046
|
+
environment = "mypurecloud.com"
|
3047
|
+
|
3048
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3049
|
+
|
3050
|
+
PureCloud.configure do |config|
|
3051
|
+
config.access_token = @authToken
|
3052
|
+
end
|
3053
|
+
|
3054
|
+
api_instance = PureCloud::ConversationsApi.new
|
3055
|
+
|
3056
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
3057
|
+
|
3058
|
+
participant_id = "participant_id_example" # String | participantId
|
3059
|
+
|
3060
|
+
|
3061
|
+
begin
|
3062
|
+
#Get list of wrapup codes for this conversation participant
|
3063
|
+
result = api_instance.get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
3064
|
+
p result
|
3065
|
+
rescue PureCloud::ApiError => e
|
3066
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapupcodes: #{e}"
|
3067
|
+
end
|
3068
|
+
```
|
3069
|
+
|
3070
|
+
### Parameters
|
3071
|
+
|
3072
|
+
Name | Type | Description | Notes
|
3073
|
+
------------- | ------------- | ------------- | -------------
|
3074
|
+
**conversation_id** | **String**| conversationId | |
|
3075
|
+
**participant_id** | **String**| participantId | |
|
3076
|
+
{: class="table table-striped"}
|
3077
|
+
|
3078
|
+
|
3079
|
+
### Return type
|
3080
|
+
|
3081
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
3082
|
+
|
3083
|
+
### HTTP request headers
|
3084
|
+
|
3085
|
+
- **Content-Type**: application/json
|
3086
|
+
- **Accept**: application/json
|
3087
|
+
|
3088
|
+
|
3089
|
+
|
3090
|
+
<a name="get_conversations_messages"></a>
|
3091
|
+
|
3092
|
+
## [**MessageConversationEntityListing**](MessageConversationEntityListing.html) get_conversations_messages
|
3093
|
+
|
3094
|
+
|
3095
|
+
|
3096
|
+
Get active message conversations for the logged in user
|
3097
|
+
|
3098
|
+
|
3099
|
+
|
3100
|
+
Wraps GET /api/v2/conversations/messages
|
3101
|
+
|
3102
|
+
Requires NO permissions:
|
3103
|
+
|
3104
|
+
|
3105
|
+
|
3106
|
+
### Example
|
3107
|
+
```{"language":"ruby"}
|
3108
|
+
# load the gem
|
3109
|
+
require 'purecloudplatformclientv2'
|
3110
|
+
# setup authorization
|
3111
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3112
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3113
|
+
environment = "mypurecloud.com"
|
3114
|
+
|
3115
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3116
|
+
|
3117
|
+
PureCloud.configure do |config|
|
3118
|
+
config.access_token = @authToken
|
3119
|
+
end
|
3120
|
+
|
3121
|
+
api_instance = PureCloud::ConversationsApi.new
|
3122
|
+
|
3123
|
+
begin
|
3124
|
+
#Get active message conversations for the logged in user
|
3125
|
+
result = api_instance.get_conversations_messages
|
3126
|
+
p result
|
3127
|
+
rescue PureCloud::ApiError => e
|
3128
|
+
puts "Exception when calling ConversationsApi->get_conversations_messages: #{e}"
|
3129
|
+
end
|
3130
|
+
```
|
3131
|
+
|
3132
|
+
### Parameters
|
3133
|
+
This endpoint does not need any parameter.
|
3134
|
+
{: class="table table-striped"}
|
3135
|
+
|
3136
|
+
|
3137
|
+
### Return type
|
3138
|
+
|
3139
|
+
[**MessageConversationEntityListing**](MessageConversationEntityListing.html)
|
3140
|
+
|
3141
|
+
### HTTP request headers
|
3142
|
+
|
3143
|
+
- **Content-Type**: application/json
|
3144
|
+
- **Accept**: application/json
|
3145
|
+
|
3146
|
+
|
3147
|
+
|
3148
|
+
<a name="get_conversations_messaging_integrations"></a>
|
3149
|
+
|
3150
|
+
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_conversations_messaging_integrations(opts)
|
3151
|
+
|
3152
|
+
|
3153
|
+
|
3154
|
+
Get a list of Integrations
|
3155
|
+
|
3156
|
+
|
3157
|
+
|
3158
|
+
Wraps GET /api/v2/conversations/messaging/integrations
|
3159
|
+
|
3160
|
+
Requires ANY permissions:
|
3161
|
+
|
3162
|
+
* messaging:integration:view
|
3163
|
+
|
3164
|
+
|
3165
|
+
### Example
|
3166
|
+
```{"language":"ruby"}
|
3167
|
+
# load the gem
|
3168
|
+
require 'purecloudplatformclientv2'
|
3169
|
+
# setup authorization
|
3170
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3171
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3172
|
+
environment = "mypurecloud.com"
|
3173
|
+
|
3174
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3175
|
+
|
3176
|
+
PureCloud.configure do |config|
|
3177
|
+
config.access_token = @authToken
|
3178
|
+
end
|
3179
|
+
|
3180
|
+
api_instance = PureCloud::ConversationsApi.new
|
3181
|
+
|
3182
|
+
opts = {
|
3183
|
+
page_size: 25, # Integer | Page size
|
3184
|
+
page_number: 1 # Integer | Page number
|
3185
|
+
}
|
3186
|
+
|
3187
|
+
begin
|
3188
|
+
#Get a list of Integrations
|
3189
|
+
result = api_instance.get_conversations_messaging_integrations(opts)
|
3190
|
+
p result
|
3191
|
+
rescue PureCloud::ApiError => e
|
3192
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations: #{e}"
|
3193
|
+
end
|
3194
|
+
```
|
3195
|
+
|
3196
|
+
### Parameters
|
3197
|
+
|
3198
|
+
Name | Type | Description | Notes
|
3199
|
+
------------- | ------------- | ------------- | -------------
|
3200
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3201
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3202
|
+
{: class="table table-striped"}
|
3203
|
+
|
3204
|
+
|
3205
|
+
### Return type
|
3206
|
+
|
3207
|
+
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
3208
|
+
|
3209
|
+
### HTTP request headers
|
3210
|
+
|
3211
|
+
- **Content-Type**: application/json
|
3212
|
+
- **Accept**: application/json
|
3213
|
+
|
3214
|
+
|
3215
|
+
|
3216
|
+
<a name="get_conversations_messaging_integrations_facebook"></a>
|
3217
|
+
|
3218
|
+
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_conversations_messaging_integrations_facebook(opts)
|
3219
|
+
|
3220
|
+
|
3221
|
+
|
3222
|
+
Get a list of Facebook Integrations
|
3223
|
+
|
3224
|
+
|
3225
|
+
|
3226
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook
|
3227
|
+
|
3228
|
+
Requires ANY permissions:
|
3229
|
+
|
3230
|
+
* messaging:integration:view
|
3231
|
+
|
3232
|
+
|
3233
|
+
### Example
|
3234
|
+
```{"language":"ruby"}
|
3235
|
+
# load the gem
|
3236
|
+
require 'purecloudplatformclientv2'
|
3237
|
+
# setup authorization
|
3238
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3239
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3240
|
+
environment = "mypurecloud.com"
|
3241
|
+
|
3242
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3243
|
+
|
3244
|
+
PureCloud.configure do |config|
|
3245
|
+
config.access_token = @authToken
|
3246
|
+
end
|
3247
|
+
|
3248
|
+
api_instance = PureCloud::ConversationsApi.new
|
3249
|
+
|
3250
|
+
opts = {
|
3251
|
+
page_size: 25, # Integer | Page size
|
3252
|
+
page_number: 1 # Integer | Page number
|
3253
|
+
}
|
3254
|
+
|
3255
|
+
begin
|
3256
|
+
#Get a list of Facebook Integrations
|
3257
|
+
result = api_instance.get_conversations_messaging_integrations_facebook(opts)
|
3258
|
+
p result
|
3259
|
+
rescue PureCloud::ApiError => e
|
3260
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook: #{e}"
|
3261
|
+
end
|
3262
|
+
```
|
3263
|
+
|
3264
|
+
### Parameters
|
3265
|
+
|
3266
|
+
Name | Type | Description | Notes
|
3267
|
+
------------- | ------------- | ------------- | -------------
|
3268
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3269
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3270
|
+
{: class="table table-striped"}
|
3271
|
+
|
3272
|
+
|
3273
|
+
### Return type
|
3274
|
+
|
3275
|
+
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
3276
|
+
|
3277
|
+
### HTTP request headers
|
3278
|
+
|
3279
|
+
- **Content-Type**: application/json
|
3280
|
+
- **Accept**: application/json
|
3281
|
+
|
3282
|
+
|
3283
|
+
|
3284
|
+
<a name="get_conversations_messaging_integrations_facebook_integration_id"></a>
|
3285
|
+
|
3286
|
+
## [**FacebookIntegration**](FacebookIntegration.html) get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
3287
|
+
|
3288
|
+
|
3289
|
+
|
3290
|
+
Get a Facebook messaging integration
|
3291
|
+
|
3292
|
+
|
3293
|
+
|
3294
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
3295
|
+
|
3296
|
+
Requires ANY permissions:
|
3297
|
+
|
3298
|
+
* messaging:integration:view
|
3299
|
+
|
3300
|
+
|
3301
|
+
### Example
|
3302
|
+
```{"language":"ruby"}
|
3303
|
+
# load the gem
|
3304
|
+
require 'purecloudplatformclientv2'
|
3305
|
+
# setup authorization
|
3306
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3307
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3308
|
+
environment = "mypurecloud.com"
|
3309
|
+
|
3310
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3311
|
+
|
3312
|
+
PureCloud.configure do |config|
|
3313
|
+
config.access_token = @authToken
|
3314
|
+
end
|
3315
|
+
|
3316
|
+
api_instance = PureCloud::ConversationsApi.new
|
3317
|
+
|
3318
|
+
integration_id = "integration_id_example" # String | Integration ID
|
3319
|
+
|
3320
|
+
|
3321
|
+
begin
|
3322
|
+
#Get a Facebook messaging integration
|
3323
|
+
result = api_instance.get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
3324
|
+
p result
|
3325
|
+
rescue PureCloud::ApiError => e
|
3326
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
3327
|
+
end
|
3328
|
+
```
|
3329
|
+
|
3330
|
+
### Parameters
|
3331
|
+
|
3332
|
+
Name | Type | Description | Notes
|
3333
|
+
------------- | ------------- | ------------- | -------------
|
3334
|
+
**integration_id** | **String**| Integration ID | |
|
3335
|
+
{: class="table table-striped"}
|
3336
|
+
|
3337
|
+
|
3338
|
+
### Return type
|
3339
|
+
|
3340
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
3341
|
+
|
3342
|
+
### HTTP request headers
|
3343
|
+
|
3344
|
+
- **Content-Type**: application/json
|
3345
|
+
- **Accept**: application/json
|
3346
|
+
|
3347
|
+
|
3348
|
+
|
3349
|
+
<a name="get_conversations_messaging_integrations_line"></a>
|
3350
|
+
|
3351
|
+
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_conversations_messaging_integrations_line(opts)
|
3352
|
+
|
3353
|
+
|
3354
|
+
|
3355
|
+
Get a list of LINE messenger Integrations
|
3356
|
+
|
3357
|
+
|
3358
|
+
|
3359
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line
|
3360
|
+
|
3361
|
+
Requires ANY permissions:
|
3362
|
+
|
3363
|
+
* messaging:integration:view
|
3364
|
+
|
3365
|
+
|
3366
|
+
### Example
|
3367
|
+
```{"language":"ruby"}
|
3368
|
+
# load the gem
|
3369
|
+
require 'purecloudplatformclientv2'
|
3370
|
+
# setup authorization
|
3371
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3372
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3373
|
+
environment = "mypurecloud.com"
|
3374
|
+
|
3375
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3376
|
+
|
3377
|
+
PureCloud.configure do |config|
|
3378
|
+
config.access_token = @authToken
|
3379
|
+
end
|
3380
|
+
|
3381
|
+
api_instance = PureCloud::ConversationsApi.new
|
3382
|
+
|
3383
|
+
opts = {
|
3384
|
+
page_size: 25, # Integer | Page size
|
3385
|
+
page_number: 1 # Integer | Page number
|
3386
|
+
}
|
3387
|
+
|
3388
|
+
begin
|
3389
|
+
#Get a list of LINE messenger Integrations
|
3390
|
+
result = api_instance.get_conversations_messaging_integrations_line(opts)
|
3391
|
+
p result
|
3392
|
+
rescue PureCloud::ApiError => e
|
3393
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_line: #{e}"
|
3394
|
+
end
|
3395
|
+
```
|
3396
|
+
|
3397
|
+
### Parameters
|
3398
|
+
|
3399
|
+
Name | Type | Description | Notes
|
3400
|
+
------------- | ------------- | ------------- | -------------
|
3401
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3402
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3403
|
+
{: class="table table-striped"}
|
3404
|
+
|
3405
|
+
|
3406
|
+
### Return type
|
3407
|
+
|
3408
|
+
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
3409
|
+
|
3410
|
+
### HTTP request headers
|
3411
|
+
|
3412
|
+
- **Content-Type**: application/json
|
3413
|
+
- **Accept**: application/json
|
3414
|
+
|
3415
|
+
|
3416
|
+
|
3417
|
+
<a name="get_conversations_messaging_integrations_line_integration_id"></a>
|
3418
|
+
|
3419
|
+
## [**LineIntegration**](LineIntegration.html) get_conversations_messaging_integrations_line_integration_id(integration_id)
|
3420
|
+
|
3421
|
+
|
3422
|
+
|
3423
|
+
Get a LINE messenger integration
|
3424
|
+
|
3425
|
+
|
3426
|
+
|
3427
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line/{integrationId}
|
3428
|
+
|
3429
|
+
Requires ANY permissions:
|
3430
|
+
|
3431
|
+
* messaging:integration:view
|
3432
|
+
|
3433
|
+
|
3434
|
+
### Example
|
3435
|
+
```{"language":"ruby"}
|
3436
|
+
# load the gem
|
3437
|
+
require 'purecloudplatformclientv2'
|
3438
|
+
# setup authorization
|
3439
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3440
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3441
|
+
environment = "mypurecloud.com"
|
3442
|
+
|
3443
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3444
|
+
|
3445
|
+
PureCloud.configure do |config|
|
3446
|
+
config.access_token = @authToken
|
3447
|
+
end
|
3448
|
+
|
3449
|
+
api_instance = PureCloud::ConversationsApi.new
|
3450
|
+
|
3451
|
+
integration_id = "integration_id_example" # String | Integration ID
|
3452
|
+
|
3453
|
+
|
3454
|
+
begin
|
3455
|
+
#Get a LINE messenger integration
|
3456
|
+
result = api_instance.get_conversations_messaging_integrations_line_integration_id(integration_id)
|
3457
|
+
p result
|
3458
|
+
rescue PureCloud::ApiError => e
|
3459
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_line_integration_id: #{e}"
|
3460
|
+
end
|
3461
|
+
```
|
3462
|
+
|
3463
|
+
### Parameters
|
3464
|
+
|
3465
|
+
Name | Type | Description | Notes
|
3466
|
+
------------- | ------------- | ------------- | -------------
|
3467
|
+
**integration_id** | **String**| Integration ID | |
|
3468
|
+
{: class="table table-striped"}
|
3469
|
+
|
3470
|
+
|
3471
|
+
### Return type
|
3472
|
+
|
3473
|
+
[**LineIntegration**](LineIntegration.html)
|
3474
|
+
|
3475
|
+
### HTTP request headers
|
3476
|
+
|
3477
|
+
- **Content-Type**: application/json
|
3478
|
+
- **Accept**: application/json
|
3479
|
+
|
3480
|
+
|
3481
|
+
|
3482
|
+
<a name="get_conversations_messaging_integrations_twitter"></a>
|
3483
|
+
|
3484
|
+
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_conversations_messaging_integrations_twitter(opts)
|
3485
|
+
|
3486
|
+
|
3487
|
+
|
3488
|
+
Get a list of Twitter Integrations
|
3489
|
+
|
3490
|
+
|
3491
|
+
|
3492
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter
|
3493
|
+
|
3494
|
+
Requires ANY permissions:
|
3495
|
+
|
3496
|
+
* messaging:integration:view
|
3497
|
+
|
3498
|
+
|
3499
|
+
### Example
|
3500
|
+
```{"language":"ruby"}
|
3501
|
+
# load the gem
|
3502
|
+
require 'purecloudplatformclientv2'
|
3503
|
+
# setup authorization
|
3504
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3505
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3506
|
+
environment = "mypurecloud.com"
|
3507
|
+
|
3508
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3509
|
+
|
3510
|
+
PureCloud.configure do |config|
|
3511
|
+
config.access_token = @authToken
|
3512
|
+
end
|
3513
|
+
|
3514
|
+
api_instance = PureCloud::ConversationsApi.new
|
3515
|
+
|
3516
|
+
opts = {
|
3517
|
+
page_size: 25, # Integer | Page size
|
3518
|
+
page_number: 1 # Integer | Page number
|
3519
|
+
}
|
3520
|
+
|
3521
|
+
begin
|
3522
|
+
#Get a list of Twitter Integrations
|
3523
|
+
result = api_instance.get_conversations_messaging_integrations_twitter(opts)
|
3524
|
+
p result
|
3525
|
+
rescue PureCloud::ApiError => e
|
3526
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_twitter: #{e}"
|
3527
|
+
end
|
3528
|
+
```
|
3529
|
+
|
3530
|
+
### Parameters
|
3531
|
+
|
3532
|
+
Name | Type | Description | Notes
|
3533
|
+
------------- | ------------- | ------------- | -------------
|
3534
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3535
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3536
|
+
{: class="table table-striped"}
|
3537
|
+
|
3538
|
+
|
3539
|
+
### Return type
|
3540
|
+
|
3541
|
+
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
2808
3542
|
|
2809
3543
|
### HTTP request headers
|
2810
3544
|
|
@@ -2813,20 +3547,21 @@ Name | Type | Description | Notes
|
|
2813
3547
|
|
2814
3548
|
|
2815
3549
|
|
2816
|
-
<a name="
|
3550
|
+
<a name="get_conversations_messaging_integrations_twitter_integration_id"></a>
|
2817
3551
|
|
2818
|
-
## [**
|
3552
|
+
## [**TwitterIntegration**](TwitterIntegration.html) get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
2819
3553
|
|
2820
3554
|
|
2821
3555
|
|
2822
|
-
Get
|
3556
|
+
Get a Twitter messaging integration
|
2823
3557
|
|
2824
3558
|
|
2825
3559
|
|
2826
|
-
Wraps GET /api/v2/conversations/
|
3560
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
2827
3561
|
|
2828
|
-
Requires
|
3562
|
+
Requires ANY permissions:
|
2829
3563
|
|
3564
|
+
* messaging:integration:view
|
2830
3565
|
|
2831
3566
|
|
2832
3567
|
### Example
|
@@ -2846,17 +3581,15 @@ end
|
|
2846
3581
|
|
2847
3582
|
api_instance = PureCloud::ConversationsApi.new
|
2848
3583
|
|
2849
|
-
|
2850
|
-
|
2851
|
-
participant_id = "participant_id_example" # String | participantId
|
3584
|
+
integration_id = "integration_id_example" # String | Integration ID
|
2852
3585
|
|
2853
3586
|
|
2854
3587
|
begin
|
2855
|
-
#Get
|
2856
|
-
result = api_instance.
|
3588
|
+
#Get a Twitter messaging integration
|
3589
|
+
result = api_instance.get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
2857
3590
|
p result
|
2858
3591
|
rescue PureCloud::ApiError => e
|
2859
|
-
puts "Exception when calling ConversationsApi->
|
3592
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
2860
3593
|
end
|
2861
3594
|
```
|
2862
3595
|
|
@@ -2864,14 +3597,13 @@ end
|
|
2864
3597
|
|
2865
3598
|
Name | Type | Description | Notes
|
2866
3599
|
------------- | ------------- | ------------- | -------------
|
2867
|
-
**
|
2868
|
-
**participant_id** | **String**| participantId | |
|
3600
|
+
**integration_id** | **String**| Integration ID | |
|
2869
3601
|
{: class="table table-striped"}
|
2870
3602
|
|
2871
3603
|
|
2872
3604
|
### Return type
|
2873
3605
|
|
2874
|
-
[**
|
3606
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
2875
3607
|
|
2876
3608
|
### HTTP request headers
|
2877
3609
|
|
@@ -2880,20 +3612,21 @@ Name | Type | Description | Notes
|
|
2880
3612
|
|
2881
3613
|
|
2882
3614
|
|
2883
|
-
<a name="
|
3615
|
+
<a name="get_conversations_messaging_sticker"></a>
|
2884
3616
|
|
2885
|
-
## [**
|
3617
|
+
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_conversations_messaging_sticker(messenger_type, opts)
|
2886
3618
|
|
2887
3619
|
|
2888
3620
|
|
2889
|
-
Get
|
3621
|
+
Get a list of Messaging Stickers
|
2890
3622
|
|
2891
3623
|
|
2892
3624
|
|
2893
|
-
Wraps GET /api/v2/conversations/
|
3625
|
+
Wraps GET /api/v2/conversations/messaging/stickers/{messengerType}
|
2894
3626
|
|
2895
|
-
Requires
|
3627
|
+
Requires ANY permissions:
|
2896
3628
|
|
3629
|
+
* conversation:message:create
|
2897
3630
|
|
2898
3631
|
|
2899
3632
|
### Example
|
@@ -2913,23 +3646,35 @@ end
|
|
2913
3646
|
|
2914
3647
|
api_instance = PureCloud::ConversationsApi.new
|
2915
3648
|
|
3649
|
+
messenger_type = "messenger_type_example" # String | Messenger Type
|
3650
|
+
|
3651
|
+
opts = {
|
3652
|
+
page_size: 25, # Integer | Page size
|
3653
|
+
page_number: 1 # Integer | Page number
|
3654
|
+
}
|
3655
|
+
|
2916
3656
|
begin
|
2917
|
-
#Get
|
2918
|
-
result = api_instance.
|
3657
|
+
#Get a list of Messaging Stickers
|
3658
|
+
result = api_instance.get_conversations_messaging_sticker(messenger_type, opts)
|
2919
3659
|
p result
|
2920
3660
|
rescue PureCloud::ApiError => e
|
2921
|
-
puts "Exception when calling ConversationsApi->
|
3661
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_sticker: #{e}"
|
2922
3662
|
end
|
2923
3663
|
```
|
2924
3664
|
|
2925
3665
|
### Parameters
|
2926
|
-
|
3666
|
+
|
3667
|
+
Name | Type | Description | Notes
|
3668
|
+
------------- | ------------- | ------------- | -------------
|
3669
|
+
**messenger_type** | **String**| Messenger Type | |
|
3670
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3671
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
2927
3672
|
{: class="table table-striped"}
|
2928
3673
|
|
2929
3674
|
|
2930
3675
|
### Return type
|
2931
3676
|
|
2932
|
-
[**
|
3677
|
+
[**MessagingStickerEntityListing**](MessagingStickerEntityListing.html)
|
2933
3678
|
|
2934
3679
|
### HTTP request headers
|
2935
3680
|
|
@@ -6785,6 +7530,201 @@ Name | Type | Description | Notes
|
|
6785
7530
|
|
6786
7531
|
|
6787
7532
|
|
7533
|
+
<a name="post_conversations_messaging_integrations_facebook"></a>
|
7534
|
+
|
7535
|
+
## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
|
7536
|
+
|
7537
|
+
|
7538
|
+
|
7539
|
+
Create a Facebook Integration
|
7540
|
+
|
7541
|
+
|
7542
|
+
|
7543
|
+
Wraps POST /api/v2/conversations/messaging/integrations/facebook
|
7544
|
+
|
7545
|
+
Requires ANY permissions:
|
7546
|
+
|
7547
|
+
* messaging:integration:add
|
7548
|
+
|
7549
|
+
|
7550
|
+
### Example
|
7551
|
+
```{"language":"ruby"}
|
7552
|
+
# load the gem
|
7553
|
+
require 'purecloudplatformclientv2'
|
7554
|
+
# setup authorization
|
7555
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7556
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7557
|
+
environment = "mypurecloud.com"
|
7558
|
+
|
7559
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7560
|
+
|
7561
|
+
PureCloud.configure do |config|
|
7562
|
+
config.access_token = @authToken
|
7563
|
+
end
|
7564
|
+
|
7565
|
+
api_instance = PureCloud::ConversationsApi.new
|
7566
|
+
|
7567
|
+
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
7568
|
+
|
7569
|
+
|
7570
|
+
begin
|
7571
|
+
#Create a Facebook Integration
|
7572
|
+
result = api_instance.post_conversations_messaging_integrations_facebook(body)
|
7573
|
+
p result
|
7574
|
+
rescue PureCloud::ApiError => e
|
7575
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_facebook: #{e}"
|
7576
|
+
end
|
7577
|
+
```
|
7578
|
+
|
7579
|
+
### Parameters
|
7580
|
+
|
7581
|
+
Name | Type | Description | Notes
|
7582
|
+
------------- | ------------- | ------------- | -------------
|
7583
|
+
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
7584
|
+
{: class="table table-striped"}
|
7585
|
+
|
7586
|
+
|
7587
|
+
### Return type
|
7588
|
+
|
7589
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
7590
|
+
|
7591
|
+
### HTTP request headers
|
7592
|
+
|
7593
|
+
- **Content-Type**: application/json
|
7594
|
+
- **Accept**: application/json
|
7595
|
+
|
7596
|
+
|
7597
|
+
|
7598
|
+
<a name="post_conversations_messaging_integrations_line"></a>
|
7599
|
+
|
7600
|
+
## [**LineIntegration**](LineIntegration.html) post_conversations_messaging_integrations_line(body)
|
7601
|
+
|
7602
|
+
|
7603
|
+
|
7604
|
+
Create a LINE messenger Integration
|
7605
|
+
|
7606
|
+
|
7607
|
+
|
7608
|
+
Wraps POST /api/v2/conversations/messaging/integrations/line
|
7609
|
+
|
7610
|
+
Requires ANY permissions:
|
7611
|
+
|
7612
|
+
* messaging:integration:add
|
7613
|
+
|
7614
|
+
|
7615
|
+
### Example
|
7616
|
+
```{"language":"ruby"}
|
7617
|
+
# load the gem
|
7618
|
+
require 'purecloudplatformclientv2'
|
7619
|
+
# setup authorization
|
7620
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7621
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7622
|
+
environment = "mypurecloud.com"
|
7623
|
+
|
7624
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7625
|
+
|
7626
|
+
PureCloud.configure do |config|
|
7627
|
+
config.access_token = @authToken
|
7628
|
+
end
|
7629
|
+
|
7630
|
+
api_instance = PureCloud::ConversationsApi.new
|
7631
|
+
|
7632
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
7633
|
+
|
7634
|
+
|
7635
|
+
begin
|
7636
|
+
#Create a LINE messenger Integration
|
7637
|
+
result = api_instance.post_conversations_messaging_integrations_line(body)
|
7638
|
+
p result
|
7639
|
+
rescue PureCloud::ApiError => e
|
7640
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_line: #{e}"
|
7641
|
+
end
|
7642
|
+
```
|
7643
|
+
|
7644
|
+
### Parameters
|
7645
|
+
|
7646
|
+
Name | Type | Description | Notes
|
7647
|
+
------------- | ------------- | ------------- | -------------
|
7648
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
7649
|
+
{: class="table table-striped"}
|
7650
|
+
|
7651
|
+
|
7652
|
+
### Return type
|
7653
|
+
|
7654
|
+
[**LineIntegration**](LineIntegration.html)
|
7655
|
+
|
7656
|
+
### HTTP request headers
|
7657
|
+
|
7658
|
+
- **Content-Type**: application/json
|
7659
|
+
- **Accept**: application/json
|
7660
|
+
|
7661
|
+
|
7662
|
+
|
7663
|
+
<a name="post_conversations_messaging_integrations_twitter"></a>
|
7664
|
+
|
7665
|
+
## [**TwitterIntegration**](TwitterIntegration.html) post_conversations_messaging_integrations_twitter(body)
|
7666
|
+
|
7667
|
+
|
7668
|
+
|
7669
|
+
Create a Twitter Integration
|
7670
|
+
|
7671
|
+
|
7672
|
+
|
7673
|
+
Wraps POST /api/v2/conversations/messaging/integrations/twitter
|
7674
|
+
|
7675
|
+
Requires ANY permissions:
|
7676
|
+
|
7677
|
+
* messaging:integration:add
|
7678
|
+
|
7679
|
+
|
7680
|
+
### Example
|
7681
|
+
```{"language":"ruby"}
|
7682
|
+
# load the gem
|
7683
|
+
require 'purecloudplatformclientv2'
|
7684
|
+
# setup authorization
|
7685
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7686
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7687
|
+
environment = "mypurecloud.com"
|
7688
|
+
|
7689
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7690
|
+
|
7691
|
+
PureCloud.configure do |config|
|
7692
|
+
config.access_token = @authToken
|
7693
|
+
end
|
7694
|
+
|
7695
|
+
api_instance = PureCloud::ConversationsApi.new
|
7696
|
+
|
7697
|
+
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
7698
|
+
|
7699
|
+
|
7700
|
+
begin
|
7701
|
+
#Create a Twitter Integration
|
7702
|
+
result = api_instance.post_conversations_messaging_integrations_twitter(body)
|
7703
|
+
p result
|
7704
|
+
rescue PureCloud::ApiError => e
|
7705
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_twitter: #{e}"
|
7706
|
+
end
|
7707
|
+
```
|
7708
|
+
|
7709
|
+
### Parameters
|
7710
|
+
|
7711
|
+
Name | Type | Description | Notes
|
7712
|
+
------------- | ------------- | ------------- | -------------
|
7713
|
+
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
7714
|
+
{: class="table table-striped"}
|
7715
|
+
|
7716
|
+
|
7717
|
+
### Return type
|
7718
|
+
|
7719
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
7720
|
+
|
7721
|
+
### HTTP request headers
|
7722
|
+
|
7723
|
+
- **Content-Type**: application/json
|
7724
|
+
- **Accept**: application/json
|
7725
|
+
|
7726
|
+
|
7727
|
+
|
6788
7728
|
<a name="put_conversation_participant_flaggedreason"></a>
|
6789
7729
|
|
6790
7730
|
## put_conversation_participant_flaggedreason(conversation_id, participant_id)
|
@@ -6991,3 +7931,71 @@ Name | Type | Description | Notes
|
|
6991
7931
|
|
6992
7932
|
|
6993
7933
|
|
7934
|
+
<a name="put_conversations_messaging_integrations_line_integration_id"></a>
|
7935
|
+
|
7936
|
+
## [**LineIntegration**](LineIntegration.html) put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
7937
|
+
|
7938
|
+
|
7939
|
+
|
7940
|
+
Update a LINE messenger integration
|
7941
|
+
|
7942
|
+
|
7943
|
+
|
7944
|
+
Wraps PUT /api/v2/conversations/messaging/integrations/line/{integrationId}
|
7945
|
+
|
7946
|
+
Requires ANY permissions:
|
7947
|
+
|
7948
|
+
* messaging:integration:edit
|
7949
|
+
|
7950
|
+
|
7951
|
+
### Example
|
7952
|
+
```{"language":"ruby"}
|
7953
|
+
# load the gem
|
7954
|
+
require 'purecloudplatformclientv2'
|
7955
|
+
# setup authorization
|
7956
|
+
@secret = ENV['PURECLOUD_SECRET']
|
7957
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
7958
|
+
environment = "mypurecloud.com"
|
7959
|
+
|
7960
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7961
|
+
|
7962
|
+
PureCloud.configure do |config|
|
7963
|
+
config.access_token = @authToken
|
7964
|
+
end
|
7965
|
+
|
7966
|
+
api_instance = PureCloud::ConversationsApi.new
|
7967
|
+
|
7968
|
+
integration_id = "integration_id_example" # String | Integration ID
|
7969
|
+
|
7970
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
7971
|
+
|
7972
|
+
|
7973
|
+
begin
|
7974
|
+
#Update a LINE messenger integration
|
7975
|
+
result = api_instance.put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
7976
|
+
p result
|
7977
|
+
rescue PureCloud::ApiError => e
|
7978
|
+
puts "Exception when calling ConversationsApi->put_conversations_messaging_integrations_line_integration_id: #{e}"
|
7979
|
+
end
|
7980
|
+
```
|
7981
|
+
|
7982
|
+
### Parameters
|
7983
|
+
|
7984
|
+
Name | Type | Description | Notes
|
7985
|
+
------------- | ------------- | ------------- | -------------
|
7986
|
+
**integration_id** | **String**| Integration ID | |
|
7987
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
7988
|
+
{: class="table table-striped"}
|
7989
|
+
|
7990
|
+
|
7991
|
+
### Return type
|
7992
|
+
|
7993
|
+
[**LineIntegration**](LineIntegration.html)
|
7994
|
+
|
7995
|
+
### HTTP request headers
|
7996
|
+
|
7997
|
+
- **Content-Type**: application/json
|
7998
|
+
- **Accept**: application/json
|
7999
|
+
|
8000
|
+
|
8001
|
+
|