purecloudplatformclientv2 58.0.1 → 59.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 +1 -1
- data/docs/{Skill.md → AddressableEntityRef.md} +2 -2
- data/docs/Agent.md +1 -2
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/ArchitectApi.md +298 -14
- data/docs/AsyncConversationQuery.md +21 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversation.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/Conversation.md +1 -0
- data/docs/ConversationBasic.md +1 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationProperties.md +1 -0
- data/docs/ConversationRoutingData.md +3 -3
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/CreateUser.md +1 -1
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +4 -5
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgent.md +18 -0
- data/docs/DialogflowAgentSummary.md +17 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +22 -0
- data/docs/DialogflowIntent.md +14 -0
- data/docs/DialogflowParameter.md +14 -0
- data/docs/DialogflowProject.md +14 -0
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessage.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExecuteRecordingJobsQuery.md +13 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcome.md +17 -0
- data/docs/FlowOutcomeListing.md +22 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +762 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageOverride.md +15 -0
- data/docs/LexBot.md +16 -0
- data/docs/LexBotAlias.md +21 -0
- data/docs/LexBotAliasEntityListing.md +22 -0
- data/docs/LexBotEntityListing.md +22 -0
- data/docs/LexIntent.md +16 -0
- data/docs/LexSlot.md +16 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationDefinition.md +2 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationImage.md +14 -0
- data/docs/LocationsApi.md +6 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +5 -6
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingApi.md +1211 -134
- data/docs/MessagingIntegration.md +23 -0
- data/docs/MessagingIntegrationEntityListing.md +22 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MoveManagementUnitRequest.md +13 -0
- data/docs/MoveManagementUnitResponse.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAudit.md +1 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +335 -0
- data/docs/RecordingJob.md +23 -0
- data/docs/RecordingJobEntityListing.md +22 -0
- data/docs/RecordingJobsQuery.md +15 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +145 -145
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScoredAgent.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntity.md +20 -0
- data/docs/TtsEngineEntityListing.md +22 -0
- data/docs/TtsSettings.md +14 -0
- data/docs/TtsVoiceEntity.md +19 -0
- data/docs/TtsVoiceEntityListing.md +22 -0
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +15 -0
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmMoveManagementUnitTopicBusinessUnit.md +13 -0
- data/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +14 -0
- data/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +18 -0
- data/docs/WfmUserNotificationTopicWfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +158 -18
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +35 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +334 -6
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +851 -0
- data/lib/purecloudplatformclientv2/api/locations_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1111 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +342 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +124 -124
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +163 -21
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/agent.rb +8 -32
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +448 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_basic.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_properties.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +3 -3
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_user.rb +5 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +5 -31
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +335 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary.rb +305 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_intent.rb +240 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_parameter.rb +238 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_project.rb +226 -0
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_message.rb +27 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/execute_recording_jobs_query.rb +221 -0
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome.rb +309 -0
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_override.rb +269 -0
- data/lib/purecloudplatformclientv2/models/lex_bot.rb +279 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias.rb +444 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_intent.rb +297 -0
- data/lib/purecloudplatformclientv2/models/lex_slot.rb +290 -0
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_definition.rb +56 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_image.rb +227 -0
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +21 -57
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +510 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/move_management_unit_request.rb +207 -0
- data/lib/purecloudplatformclientv2/models/move_management_unit_response.rb +242 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +26 -1
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job.rb +480 -0
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +283 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scored_agent.rb +1 -1
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +30 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity.rb +399 -0
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/tts_settings.rb +240 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity.rb +372 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification.rb +240 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_request_notification.rb +344 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +28 -3
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +72 -4
@@ -13,8 +13,8 @@ title: InteractionStatsAlertContainer
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: InteractionStatsRuleContainer
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: KeywordSetEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: LanguageEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: LanguageOverride
|
3
|
+
---
|
4
|
+
## PureCloud::LanguageOverride
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **language** | **String** | The language code of the language being overridden | |
|
11
|
+
| **engine** | **String** | The ID of the TTS engine to use for this language override | |
|
12
|
+
| **voice** | **String** | The ID of the voice to use for this language override. The voice must be supported by the chosen engine. | |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
data/docs/LexBot.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: LexBot
|
3
|
+
---
|
4
|
+
## PureCloud::LexBot
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **description** | **String** | A description of the Lex bot | [optional] |
|
13
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
data/docs/LexBotAlias.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
---
|
2
|
+
title: LexBotAlias
|
3
|
+
---
|
4
|
+
## PureCloud::LexBotAlias
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **bot** | [**LexBot**](LexBot.html) | The Lex bot this is an alias for | [optional] |
|
13
|
+
| **bot_version** | **String** | The version of the Lex bot this alias points at | [optional] |
|
14
|
+
| **status** | **String** | The status of the Lex bot alias | |
|
15
|
+
| **failure_reason** | **String** | If the status is FAILED, Amazon Lex explains why it failed to build the bot | [optional] |
|
16
|
+
| **language** | **String** | The target language of the Lex bot | [optional] |
|
17
|
+
| **intents** | [**Array<LexIntent>**](LexIntent.html) | An array of Intents associated with this bot alias | [optional] |
|
18
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
19
|
+
{: class="table table-striped"}
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: LexBotAliasEntityListing
|
3
|
+
---
|
4
|
+
## PureCloud::LexBotAliasEntityListing
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<LexBotAlias>**](LexBotAlias.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: LexBotEntityListing
|
3
|
+
---
|
4
|
+
## PureCloud::LexBotEntityListing
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<LexBot>**](LexBot.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
data/docs/LexIntent.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: LexIntent
|
3
|
+
---
|
4
|
+
## PureCloud::LexIntent
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | The intent name | |
|
11
|
+
| **description** | **String** | A description of the intent | [optional] |
|
12
|
+
| **slots** | [**Hash<String, LexSlot>**](LexSlot.html) | An object mapping slot names to Slot objects | |
|
13
|
+
| **version** | **String** | The intent version | |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
data/docs/LexSlot.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: LexSlot
|
3
|
+
---
|
4
|
+
## PureCloud::LexSlot
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | The slot name | |
|
11
|
+
| **description** | **String** | The slot description | [optional] |
|
12
|
+
| **type** | **String** | The slot type | |
|
13
|
+
| **priority** | **Integer** | The priority of the slot | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -13,8 +13,8 @@ title: LibraryEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: LineBaseEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/LineEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: LineEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: LineIntegrationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/LocationDefinition.md
CHANGED
@@ -16,6 +16,8 @@ title: LocationDefinition
|
|
16
16
|
| **version** | **Integer** | | [optional] |
|
17
17
|
| **path** | **Array<String>** | | [optional] |
|
18
18
|
| **notes** | **String** | | [optional] |
|
19
|
+
| **profile_image** | [**Array<LocationImage>**](LocationImage.html) | Profile image set for the location | [optional] |
|
20
|
+
| **floorplan_image** | [**Array<LocationImage>**](LocationImage.html) | | [optional] |
|
19
21
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
22
|
{: class="table table-striped"}
|
21
23
|
|
@@ -13,8 +13,8 @@ title: LocationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: LocationImage
|
3
|
+
---
|
4
|
+
## PureCloud::LocationImage
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **resolution** | **String** | Height and/or width of image. ex: 640x480 or x128 | [optional] |
|
11
|
+
| **image_uri** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/docs/LocationsApi.md
CHANGED
@@ -83,7 +83,7 @@ nil (empty response body)
|
|
83
83
|
|
84
84
|
<a name="get_location"></a>
|
85
85
|
|
86
|
-
## [**LocationDefinition**](LocationDefinition.html) get_location(location_id)
|
86
|
+
## [**LocationDefinition**](LocationDefinition.html) get_location(location_id, opts)
|
87
87
|
|
88
88
|
|
89
89
|
|
@@ -116,10 +116,13 @@ api_instance = PureCloud::LocationsApi.new
|
|
116
116
|
|
117
117
|
location_id = "location_id_example" # String | Location ID
|
118
118
|
|
119
|
+
opts = {
|
120
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
121
|
+
}
|
119
122
|
|
120
123
|
begin
|
121
124
|
#Get Location by ID.
|
122
|
-
result = api_instance.get_location(location_id)
|
125
|
+
result = api_instance.get_location(location_id, opts)
|
123
126
|
p result
|
124
127
|
rescue PureCloud::ApiError => e
|
125
128
|
puts "Exception when calling LocationsApi->get_location: #{e}"
|
@@ -131,6 +134,7 @@ end
|
|
131
134
|
Name | Type | Description | Notes
|
132
135
|
------------- | ------------- | ------------- | -------------
|
133
136
|
**location_id** | **String**| Location ID | |
|
137
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: images |
|
134
138
|
{: class="table table-striped"}
|
135
139
|
|
136
140
|
|
@@ -13,8 +13,8 @@ title: LogicalInterfaceEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/ManagementUnit.md
CHANGED
@@ -10,14 +10,13 @@ title: ManagementUnit
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
13
|
-
| **business_unit** | [**BusinessUnitReference**](BusinessUnitReference.html) | The business unit to which this management unit belongs | [optional] |
|
14
13
|
| **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
|
15
|
-
| **time_zone** | **String** | The time zone for the management unit in standard Olson
|
14
|
+
| **time_zone** | **String** | The time zone for the management unit in standard Olson format | [optional] |
|
16
15
|
| **settings** | [**ManagementUnitSettings**](ManagementUnitSettings.html) | The configuration settings for this management unit | [optional] |
|
17
|
-
| **
|
18
|
-
| **
|
19
|
-
| **
|
20
|
-
| **
|
16
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for this management unit. Deprecated, use settings.metadata | [optional] |
|
17
|
+
| **version** | **Integer** | The version of the underlying entity. Deprecated, use field from settings.metadata instead | [optional] |
|
18
|
+
| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
19
|
+
| **modified_by** | [**UserReference**](UserReference.html) | The user who last modified this entity. Deprecated, use field from settings.metadata instead | [optional] |
|
21
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
22
21
|
{: class="table table-striped"}
|
23
22
|
|
@@ -13,8 +13,8 @@ title: ManagementUnitListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -13,8 +13,8 @@ title: MessageConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/MessagingApi.md
CHANGED
@@ -8,9 +8,21 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**delete_conversations_messaging_integrations_facebook_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
12
|
+
[**delete_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
13
|
+
[**delete_conversations_messaging_integrations_twitter_integration_id**](MessagingApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
11
14
|
[**delete_messaging_integrations_facebook_integration_id**](MessagingApi.html#delete_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
12
15
|
[**delete_messaging_integrations_line_integration_id**](MessagingApi.html#delete_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
13
16
|
[**delete_messaging_integrations_twitter_integration_id**](MessagingApi.html#delete_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
17
|
+
[**get_conversations_messaging_integrations**](MessagingApi.html#get_conversations_messaging_integrations) | Get a list of Integrations
|
18
|
+
[**get_conversations_messaging_integrations_facebook**](MessagingApi.html#get_conversations_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
19
|
+
[**get_conversations_messaging_integrations_facebook_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
20
|
+
[**get_conversations_messaging_integrations_line**](MessagingApi.html#get_conversations_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
21
|
+
[**get_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
22
|
+
[**get_conversations_messaging_integrations_twitter**](MessagingApi.html#get_conversations_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
23
|
+
[**get_conversations_messaging_integrations_twitter_integration_id**](MessagingApi.html#get_conversations_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
24
|
+
[**get_conversations_messaging_sticker**](MessagingApi.html#get_conversations_messaging_sticker) | Get a list of Messaging Stickers
|
25
|
+
[**get_messaging_integrations**](MessagingApi.html#get_messaging_integrations) | Get a list of Integrations
|
14
26
|
[**get_messaging_integrations_facebook**](MessagingApi.html#get_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
15
27
|
[**get_messaging_integrations_facebook_integration_id**](MessagingApi.html#get_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
16
28
|
[**get_messaging_integrations_line**](MessagingApi.html#get_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
@@ -18,15 +30,19 @@ Method | Description
|
|
18
30
|
[**get_messaging_integrations_twitter**](MessagingApi.html#get_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
19
31
|
[**get_messaging_integrations_twitter_integration_id**](MessagingApi.html#get_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
20
32
|
[**get_messaging_sticker**](MessagingApi.html#get_messaging_sticker) | Get a list of Messaging Stickers
|
33
|
+
[**post_conversations_messaging_integrations_facebook**](MessagingApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
|
34
|
+
[**post_conversations_messaging_integrations_line**](MessagingApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
|
35
|
+
[**post_conversations_messaging_integrations_twitter**](MessagingApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
|
21
36
|
[**post_messaging_integrations_facebook**](MessagingApi.html#post_messaging_integrations_facebook) | Create a Facebook Integration
|
22
37
|
[**post_messaging_integrations_line**](MessagingApi.html#post_messaging_integrations_line) | Create a LINE messenger Integration
|
23
38
|
[**post_messaging_integrations_twitter**](MessagingApi.html#post_messaging_integrations_twitter) | Create a Twitter Integration
|
39
|
+
[**put_conversations_messaging_integrations_line_integration_id**](MessagingApi.html#put_conversations_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
24
40
|
[**put_messaging_integrations_line_integration_id**](MessagingApi.html#put_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
25
41
|
{: class="table table-striped"}
|
26
42
|
|
27
|
-
<a name="
|
43
|
+
<a name="delete_conversations_messaging_integrations_facebook_integration_id"></a>
|
28
44
|
|
29
|
-
##
|
45
|
+
## delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
30
46
|
|
31
47
|
|
32
48
|
|
@@ -34,7 +50,7 @@ Delete a Facebook messaging integration
|
|
34
50
|
|
35
51
|
|
36
52
|
|
37
|
-
Wraps DELETE /api/v2/messaging/integrations/facebook/{integrationId}
|
53
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
38
54
|
|
39
55
|
Requires ANY permissions:
|
40
56
|
|
@@ -63,9 +79,9 @@ integration_id = "integration_id_example" # String | Integration ID
|
|
63
79
|
|
64
80
|
begin
|
65
81
|
#Delete a Facebook messaging integration
|
66
|
-
api_instance.
|
82
|
+
api_instance.delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
67
83
|
rescue PureCloud::ApiError => e
|
68
|
-
puts "Exception when calling MessagingApi->
|
84
|
+
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
69
85
|
end
|
70
86
|
```
|
71
87
|
|
@@ -88,9 +104,9 @@ nil (empty response body)
|
|
88
104
|
|
89
105
|
|
90
106
|
|
91
|
-
<a name="
|
107
|
+
<a name="delete_conversations_messaging_integrations_line_integration_id"></a>
|
92
108
|
|
93
|
-
##
|
109
|
+
## delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
94
110
|
|
95
111
|
|
96
112
|
|
@@ -98,7 +114,7 @@ Delete a LINE messenger integration
|
|
98
114
|
|
99
115
|
|
100
116
|
|
101
|
-
Wraps DELETE /api/v2/messaging/integrations/line/{integrationId}
|
117
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}
|
102
118
|
|
103
119
|
Requires ANY permissions:
|
104
120
|
|
@@ -127,9 +143,9 @@ integration_id = "integration_id_example" # String | Integration ID
|
|
127
143
|
|
128
144
|
begin
|
129
145
|
#Delete a LINE messenger integration
|
130
|
-
api_instance.
|
146
|
+
api_instance.delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
131
147
|
rescue PureCloud::ApiError => e
|
132
|
-
puts "Exception when calling MessagingApi->
|
148
|
+
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_line_integration_id: #{e}"
|
133
149
|
end
|
134
150
|
```
|
135
151
|
|
@@ -152,9 +168,9 @@ nil (empty response body)
|
|
152
168
|
|
153
169
|
|
154
170
|
|
155
|
-
<a name="
|
171
|
+
<a name="delete_conversations_messaging_integrations_twitter_integration_id"></a>
|
156
172
|
|
157
|
-
##
|
173
|
+
## delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
158
174
|
|
159
175
|
|
160
176
|
|
@@ -162,7 +178,7 @@ Delete a Twitter messaging integration
|
|
162
178
|
|
163
179
|
|
164
180
|
|
165
|
-
Wraps DELETE /api/v2/messaging/integrations/twitter/{integrationId}
|
181
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
166
182
|
|
167
183
|
Requires ANY permissions:
|
168
184
|
|
@@ -191,9 +207,9 @@ integration_id = "integration_id_example" # String | Integration ID
|
|
191
207
|
|
192
208
|
begin
|
193
209
|
#Delete a Twitter messaging integration
|
194
|
-
api_instance.
|
210
|
+
api_instance.delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
195
211
|
rescue PureCloud::ApiError => e
|
196
|
-
puts "Exception when calling MessagingApi->
|
212
|
+
puts "Exception when calling MessagingApi->delete_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
197
213
|
end
|
198
214
|
```
|
199
215
|
|
@@ -216,21 +232,21 @@ nil (empty response body)
|
|
216
232
|
|
217
233
|
|
218
234
|
|
219
|
-
<a name="
|
220
|
-
|
221
|
-
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_messaging_integrations_facebook(opts)
|
235
|
+
<a name="delete_messaging_integrations_facebook_integration_id"></a>
|
222
236
|
|
237
|
+
## delete_messaging_integrations_facebook_integration_id(integration_id)
|
223
238
|
|
239
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
224
240
|
|
225
|
-
|
241
|
+
Delete a Facebook messaging integration
|
226
242
|
|
227
243
|
|
228
244
|
|
229
|
-
Wraps
|
245
|
+
Wraps DELETE /api/v2/messaging/integrations/facebook/{integrationId}
|
230
246
|
|
231
247
|
Requires ANY permissions:
|
232
248
|
|
233
|
-
* messaging:integration:
|
249
|
+
* messaging:integration:delete
|
234
250
|
|
235
251
|
|
236
252
|
### Example
|
@@ -250,17 +266,14 @@ end
|
|
250
266
|
|
251
267
|
api_instance = PureCloud::MessagingApi.new
|
252
268
|
|
253
|
-
|
254
|
-
|
255
|
-
page_number: 1 # Integer | Page number
|
256
|
-
}
|
269
|
+
integration_id = "integration_id_example" # String | Integration ID
|
270
|
+
|
257
271
|
|
258
272
|
begin
|
259
|
-
#
|
260
|
-
|
261
|
-
p result
|
273
|
+
#Delete a Facebook messaging integration
|
274
|
+
api_instance.delete_messaging_integrations_facebook_integration_id(integration_id)
|
262
275
|
rescue PureCloud::ApiError => e
|
263
|
-
puts "Exception when calling MessagingApi->
|
276
|
+
puts "Exception when calling MessagingApi->delete_messaging_integrations_facebook_integration_id: #{e}"
|
264
277
|
end
|
265
278
|
```
|
266
279
|
|
@@ -268,14 +281,13 @@ end
|
|
268
281
|
|
269
282
|
Name | Type | Description | Notes
|
270
283
|
------------- | ------------- | ------------- | -------------
|
271
|
-
**
|
272
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
284
|
+
**integration_id** | **String**| Integration ID | |
|
273
285
|
{: class="table table-striped"}
|
274
286
|
|
275
287
|
|
276
288
|
### Return type
|
277
289
|
|
278
|
-
|
290
|
+
nil (empty response body)
|
279
291
|
|
280
292
|
### HTTP request headers
|
281
293
|
|
@@ -284,21 +296,21 @@ Name | Type | Description | Notes
|
|
284
296
|
|
285
297
|
|
286
298
|
|
287
|
-
<a name="
|
288
|
-
|
289
|
-
## [**FacebookIntegration**](FacebookIntegration.html) get_messaging_integrations_facebook_integration_id(integration_id)
|
299
|
+
<a name="delete_messaging_integrations_line_integration_id"></a>
|
290
300
|
|
301
|
+
## delete_messaging_integrations_line_integration_id(integration_id)
|
291
302
|
|
303
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
292
304
|
|
293
|
-
|
305
|
+
Delete a LINE messenger integration
|
294
306
|
|
295
307
|
|
296
308
|
|
297
|
-
Wraps
|
309
|
+
Wraps DELETE /api/v2/messaging/integrations/line/{integrationId}
|
298
310
|
|
299
311
|
Requires ANY permissions:
|
300
312
|
|
301
|
-
* messaging:integration:
|
313
|
+
* messaging:integration:delete
|
302
314
|
|
303
315
|
|
304
316
|
### Example
|
@@ -322,11 +334,10 @@ integration_id = "integration_id_example" # String | Integration ID
|
|
322
334
|
|
323
335
|
|
324
336
|
begin
|
325
|
-
#
|
326
|
-
|
327
|
-
p result
|
337
|
+
#Delete a LINE messenger integration
|
338
|
+
api_instance.delete_messaging_integrations_line_integration_id(integration_id)
|
328
339
|
rescue PureCloud::ApiError => e
|
329
|
-
puts "Exception when calling MessagingApi->
|
340
|
+
puts "Exception when calling MessagingApi->delete_messaging_integrations_line_integration_id: #{e}"
|
330
341
|
end
|
331
342
|
```
|
332
343
|
|
@@ -340,7 +351,7 @@ Name | Type | Description | Notes
|
|
340
351
|
|
341
352
|
### Return type
|
342
353
|
|
343
|
-
|
354
|
+
nil (empty response body)
|
344
355
|
|
345
356
|
### HTTP request headers
|
346
357
|
|
@@ -349,21 +360,21 @@ Name | Type | Description | Notes
|
|
349
360
|
|
350
361
|
|
351
362
|
|
352
|
-
<a name="
|
353
|
-
|
354
|
-
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_messaging_integrations_line(opts)
|
363
|
+
<a name="delete_messaging_integrations_twitter_integration_id"></a>
|
355
364
|
|
365
|
+
## delete_messaging_integrations_twitter_integration_id(integration_id)
|
356
366
|
|
367
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
357
368
|
|
358
|
-
|
369
|
+
Delete a Twitter messaging integration
|
359
370
|
|
360
371
|
|
361
372
|
|
362
|
-
Wraps
|
373
|
+
Wraps DELETE /api/v2/messaging/integrations/twitter/{integrationId}
|
363
374
|
|
364
375
|
Requires ANY permissions:
|
365
376
|
|
366
|
-
* messaging:integration:
|
377
|
+
* messaging:integration:delete
|
367
378
|
|
368
379
|
|
369
380
|
### Example
|
@@ -383,17 +394,14 @@ end
|
|
383
394
|
|
384
395
|
api_instance = PureCloud::MessagingApi.new
|
385
396
|
|
386
|
-
|
387
|
-
|
388
|
-
page_number: 1 # Integer | Page number
|
389
|
-
}
|
397
|
+
integration_id = "integration_id_example" # String | Integration ID
|
398
|
+
|
390
399
|
|
391
400
|
begin
|
392
|
-
#
|
393
|
-
|
394
|
-
p result
|
401
|
+
#Delete a Twitter messaging integration
|
402
|
+
api_instance.delete_messaging_integrations_twitter_integration_id(integration_id)
|
395
403
|
rescue PureCloud::ApiError => e
|
396
|
-
puts "Exception when calling MessagingApi->
|
404
|
+
puts "Exception when calling MessagingApi->delete_messaging_integrations_twitter_integration_id: #{e}"
|
397
405
|
end
|
398
406
|
```
|
399
407
|
|
@@ -401,14 +409,13 @@ end
|
|
401
409
|
|
402
410
|
Name | Type | Description | Notes
|
403
411
|
------------- | ------------- | ------------- | -------------
|
404
|
-
**
|
405
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
412
|
+
**integration_id** | **String**| Integration ID | |
|
406
413
|
{: class="table table-striped"}
|
407
414
|
|
408
415
|
|
409
416
|
### Return type
|
410
417
|
|
411
|
-
|
418
|
+
nil (empty response body)
|
412
419
|
|
413
420
|
### HTTP request headers
|
414
421
|
|
@@ -417,17 +424,17 @@ Name | Type | Description | Notes
|
|
417
424
|
|
418
425
|
|
419
426
|
|
420
|
-
<a name="
|
427
|
+
<a name="get_conversations_messaging_integrations"></a>
|
421
428
|
|
422
|
-
## [**
|
429
|
+
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_conversations_messaging_integrations(opts)
|
423
430
|
|
424
431
|
|
425
432
|
|
426
|
-
Get a
|
433
|
+
Get a list of Integrations
|
427
434
|
|
428
435
|
|
429
436
|
|
430
|
-
Wraps GET /api/v2/messaging/integrations
|
437
|
+
Wraps GET /api/v2/conversations/messaging/integrations
|
431
438
|
|
432
439
|
Requires ANY permissions:
|
433
440
|
|
@@ -451,15 +458,17 @@ end
|
|
451
458
|
|
452
459
|
api_instance = PureCloud::MessagingApi.new
|
453
460
|
|
454
|
-
|
455
|
-
|
461
|
+
opts = {
|
462
|
+
page_size: 25, # Integer | Page size
|
463
|
+
page_number: 1 # Integer | Page number
|
464
|
+
}
|
456
465
|
|
457
466
|
begin
|
458
|
-
#Get a
|
459
|
-
result = api_instance.
|
467
|
+
#Get a list of Integrations
|
468
|
+
result = api_instance.get_conversations_messaging_integrations(opts)
|
460
469
|
p result
|
461
470
|
rescue PureCloud::ApiError => e
|
462
|
-
puts "Exception when calling MessagingApi->
|
471
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations: #{e}"
|
463
472
|
end
|
464
473
|
```
|
465
474
|
|
@@ -467,13 +476,14 @@ end
|
|
467
476
|
|
468
477
|
Name | Type | Description | Notes
|
469
478
|
------------- | ------------- | ------------- | -------------
|
470
|
-
**
|
479
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
480
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
471
481
|
{: class="table table-striped"}
|
472
482
|
|
473
483
|
|
474
484
|
### Return type
|
475
485
|
|
476
|
-
[**
|
486
|
+
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
477
487
|
|
478
488
|
### HTTP request headers
|
479
489
|
|
@@ -482,17 +492,17 @@ Name | Type | Description | Notes
|
|
482
492
|
|
483
493
|
|
484
494
|
|
485
|
-
<a name="
|
495
|
+
<a name="get_conversations_messaging_integrations_facebook"></a>
|
486
496
|
|
487
|
-
## [**
|
497
|
+
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_conversations_messaging_integrations_facebook(opts)
|
488
498
|
|
489
499
|
|
490
500
|
|
491
|
-
Get a list of
|
501
|
+
Get a list of Facebook Integrations
|
492
502
|
|
493
503
|
|
494
504
|
|
495
|
-
Wraps GET /api/v2/messaging/integrations/
|
505
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook
|
496
506
|
|
497
507
|
Requires ANY permissions:
|
498
508
|
|
@@ -522,11 +532,11 @@ opts = {
|
|
522
532
|
}
|
523
533
|
|
524
534
|
begin
|
525
|
-
#Get a list of
|
526
|
-
result = api_instance.
|
535
|
+
#Get a list of Facebook Integrations
|
536
|
+
result = api_instance.get_conversations_messaging_integrations_facebook(opts)
|
527
537
|
p result
|
528
538
|
rescue PureCloud::ApiError => e
|
529
|
-
puts "Exception when calling MessagingApi->
|
539
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_facebook: #{e}"
|
530
540
|
end
|
531
541
|
```
|
532
542
|
|
@@ -541,7 +551,7 @@ Name | Type | Description | Notes
|
|
541
551
|
|
542
552
|
### Return type
|
543
553
|
|
544
|
-
[**
|
554
|
+
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
545
555
|
|
546
556
|
### HTTP request headers
|
547
557
|
|
@@ -550,17 +560,17 @@ Name | Type | Description | Notes
|
|
550
560
|
|
551
561
|
|
552
562
|
|
553
|
-
<a name="
|
563
|
+
<a name="get_conversations_messaging_integrations_facebook_integration_id"></a>
|
554
564
|
|
555
|
-
## [**
|
565
|
+
## [**FacebookIntegration**](FacebookIntegration.html) get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
556
566
|
|
557
567
|
|
558
568
|
|
559
|
-
Get a
|
569
|
+
Get a Facebook messaging integration
|
560
570
|
|
561
571
|
|
562
572
|
|
563
|
-
Wraps GET /api/v2/messaging/integrations/
|
573
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
564
574
|
|
565
575
|
Requires ANY permissions:
|
566
576
|
|
@@ -588,11 +598,11 @@ integration_id = "integration_id_example" # String | Integration ID
|
|
588
598
|
|
589
599
|
|
590
600
|
begin
|
591
|
-
#Get a
|
592
|
-
result = api_instance.
|
601
|
+
#Get a Facebook messaging integration
|
602
|
+
result = api_instance.get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
593
603
|
p result
|
594
604
|
rescue PureCloud::ApiError => e
|
595
|
-
puts "Exception when calling MessagingApi->
|
605
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
596
606
|
end
|
597
607
|
```
|
598
608
|
|
@@ -606,7 +616,7 @@ Name | Type | Description | Notes
|
|
606
616
|
|
607
617
|
### Return type
|
608
618
|
|
609
|
-
[**
|
619
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
610
620
|
|
611
621
|
### HTTP request headers
|
612
622
|
|
@@ -615,21 +625,21 @@ Name | Type | Description | Notes
|
|
615
625
|
|
616
626
|
|
617
627
|
|
618
|
-
<a name="
|
628
|
+
<a name="get_conversations_messaging_integrations_line"></a>
|
619
629
|
|
620
|
-
## [**
|
630
|
+
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_conversations_messaging_integrations_line(opts)
|
621
631
|
|
622
632
|
|
623
633
|
|
624
|
-
Get a list of
|
634
|
+
Get a list of LINE messenger Integrations
|
625
635
|
|
626
636
|
|
627
637
|
|
628
|
-
Wraps GET /api/v2/messaging/
|
638
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line
|
629
639
|
|
630
640
|
Requires ANY permissions:
|
631
641
|
|
632
|
-
*
|
642
|
+
* messaging:integration:view
|
633
643
|
|
634
644
|
|
635
645
|
### Example
|
@@ -649,19 +659,17 @@ end
|
|
649
659
|
|
650
660
|
api_instance = PureCloud::MessagingApi.new
|
651
661
|
|
652
|
-
messenger_type = "messenger_type_example" # String | Messenger Type
|
653
|
-
|
654
662
|
opts = {
|
655
663
|
page_size: 25, # Integer | Page size
|
656
664
|
page_number: 1 # Integer | Page number
|
657
665
|
}
|
658
666
|
|
659
667
|
begin
|
660
|
-
#Get a list of
|
661
|
-
result = api_instance.
|
668
|
+
#Get a list of LINE messenger Integrations
|
669
|
+
result = api_instance.get_conversations_messaging_integrations_line(opts)
|
662
670
|
p result
|
663
671
|
rescue PureCloud::ApiError => e
|
664
|
-
puts "Exception when calling MessagingApi->
|
672
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_line: #{e}"
|
665
673
|
end
|
666
674
|
```
|
667
675
|
|
@@ -669,7 +677,6 @@ end
|
|
669
677
|
|
670
678
|
Name | Type | Description | Notes
|
671
679
|
------------- | ------------- | ------------- | -------------
|
672
|
-
**messenger_type** | **String**| Messenger Type | |
|
673
680
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
674
681
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
675
682
|
{: class="table table-striped"}
|
@@ -677,7 +684,7 @@ Name | Type | Description | Notes
|
|
677
684
|
|
678
685
|
### Return type
|
679
686
|
|
680
|
-
[**
|
687
|
+
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
681
688
|
|
682
689
|
### HTTP request headers
|
683
690
|
|
@@ -686,21 +693,21 @@ Name | Type | Description | Notes
|
|
686
693
|
|
687
694
|
|
688
695
|
|
689
|
-
<a name="
|
696
|
+
<a name="get_conversations_messaging_integrations_line_integration_id"></a>
|
690
697
|
|
691
|
-
## [**
|
698
|
+
## [**LineIntegration**](LineIntegration.html) get_conversations_messaging_integrations_line_integration_id(integration_id)
|
692
699
|
|
693
700
|
|
694
701
|
|
695
|
-
|
702
|
+
Get a LINE messenger integration
|
696
703
|
|
697
704
|
|
698
705
|
|
699
|
-
Wraps
|
706
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line/{integrationId}
|
700
707
|
|
701
708
|
Requires ANY permissions:
|
702
709
|
|
703
|
-
* messaging:integration:
|
710
|
+
* messaging:integration:view
|
704
711
|
|
705
712
|
|
706
713
|
### Example
|
@@ -720,15 +727,15 @@ end
|
|
720
727
|
|
721
728
|
api_instance = PureCloud::MessagingApi.new
|
722
729
|
|
723
|
-
|
730
|
+
integration_id = "integration_id_example" # String | Integration ID
|
724
731
|
|
725
732
|
|
726
733
|
begin
|
727
|
-
#
|
728
|
-
result = api_instance.
|
734
|
+
#Get a LINE messenger integration
|
735
|
+
result = api_instance.get_conversations_messaging_integrations_line_integration_id(integration_id)
|
729
736
|
p result
|
730
737
|
rescue PureCloud::ApiError => e
|
731
|
-
puts "Exception when calling MessagingApi->
|
738
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_line_integration_id: #{e}"
|
732
739
|
end
|
733
740
|
```
|
734
741
|
|
@@ -736,13 +743,13 @@ end
|
|
736
743
|
|
737
744
|
Name | Type | Description | Notes
|
738
745
|
------------- | ------------- | ------------- | -------------
|
739
|
-
**
|
746
|
+
**integration_id** | **String**| Integration ID | |
|
740
747
|
{: class="table table-striped"}
|
741
748
|
|
742
749
|
|
743
750
|
### Return type
|
744
751
|
|
745
|
-
[**
|
752
|
+
[**LineIntegration**](LineIntegration.html)
|
746
753
|
|
747
754
|
### HTTP request headers
|
748
755
|
|
@@ -751,21 +758,21 @@ Name | Type | Description | Notes
|
|
751
758
|
|
752
759
|
|
753
760
|
|
754
|
-
<a name="
|
761
|
+
<a name="get_conversations_messaging_integrations_twitter"></a>
|
755
762
|
|
756
|
-
## [**
|
763
|
+
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_conversations_messaging_integrations_twitter(opts)
|
757
764
|
|
758
765
|
|
759
766
|
|
760
|
-
|
767
|
+
Get a list of Twitter Integrations
|
761
768
|
|
762
769
|
|
763
770
|
|
764
|
-
Wraps
|
771
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter
|
765
772
|
|
766
773
|
Requires ANY permissions:
|
767
774
|
|
768
|
-
* messaging:integration:
|
775
|
+
* messaging:integration:view
|
769
776
|
|
770
777
|
|
771
778
|
### Example
|
@@ -785,15 +792,17 @@ end
|
|
785
792
|
|
786
793
|
api_instance = PureCloud::MessagingApi.new
|
787
794
|
|
788
|
-
|
789
|
-
|
795
|
+
opts = {
|
796
|
+
page_size: 25, # Integer | Page size
|
797
|
+
page_number: 1 # Integer | Page number
|
798
|
+
}
|
790
799
|
|
791
800
|
begin
|
792
|
-
#
|
793
|
-
result = api_instance.
|
801
|
+
#Get a list of Twitter Integrations
|
802
|
+
result = api_instance.get_conversations_messaging_integrations_twitter(opts)
|
794
803
|
p result
|
795
804
|
rescue PureCloud::ApiError => e
|
796
|
-
puts "Exception when calling MessagingApi->
|
805
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_twitter: #{e}"
|
797
806
|
end
|
798
807
|
```
|
799
808
|
|
@@ -801,13 +810,14 @@ end
|
|
801
810
|
|
802
811
|
Name | Type | Description | Notes
|
803
812
|
------------- | ------------- | ------------- | -------------
|
804
|
-
**
|
813
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
814
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
805
815
|
{: class="table table-striped"}
|
806
816
|
|
807
817
|
|
808
818
|
### Return type
|
809
819
|
|
810
|
-
[**
|
820
|
+
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
811
821
|
|
812
822
|
### HTTP request headers
|
813
823
|
|
@@ -816,21 +826,21 @@ Name | Type | Description | Notes
|
|
816
826
|
|
817
827
|
|
818
828
|
|
819
|
-
<a name="
|
829
|
+
<a name="get_conversations_messaging_integrations_twitter_integration_id"></a>
|
820
830
|
|
821
|
-
## [**TwitterIntegration**](TwitterIntegration.html)
|
831
|
+
## [**TwitterIntegration**](TwitterIntegration.html) get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
822
832
|
|
823
833
|
|
824
834
|
|
825
|
-
|
835
|
+
Get a Twitter messaging integration
|
826
836
|
|
827
837
|
|
828
838
|
|
829
|
-
Wraps
|
839
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
830
840
|
|
831
841
|
Requires ANY permissions:
|
832
842
|
|
833
|
-
* messaging:integration:
|
843
|
+
* messaging:integration:view
|
834
844
|
|
835
845
|
|
836
846
|
### Example
|
@@ -850,15 +860,15 @@ end
|
|
850
860
|
|
851
861
|
api_instance = PureCloud::MessagingApi.new
|
852
862
|
|
853
|
-
|
863
|
+
integration_id = "integration_id_example" # String | Integration ID
|
854
864
|
|
855
865
|
|
856
866
|
begin
|
857
|
-
#
|
858
|
-
result = api_instance.
|
867
|
+
#Get a Twitter messaging integration
|
868
|
+
result = api_instance.get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
859
869
|
p result
|
860
870
|
rescue PureCloud::ApiError => e
|
861
|
-
puts "Exception when calling MessagingApi->
|
871
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
862
872
|
end
|
863
873
|
```
|
864
874
|
|
@@ -866,7 +876,7 @@ end
|
|
866
876
|
|
867
877
|
Name | Type | Description | Notes
|
868
878
|
------------- | ------------- | ------------- | -------------
|
869
|
-
**
|
879
|
+
**integration_id** | **String**| Integration ID | |
|
870
880
|
{: class="table table-striped"}
|
871
881
|
|
872
882
|
|
@@ -881,11 +891,1078 @@ Name | Type | Description | Notes
|
|
881
891
|
|
882
892
|
|
883
893
|
|
884
|
-
<a name="
|
894
|
+
<a name="get_conversations_messaging_sticker"></a>
|
885
895
|
|
886
|
-
## [**
|
896
|
+
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_conversations_messaging_sticker(messenger_type, opts)
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
Get a list of Messaging Stickers
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
Wraps GET /api/v2/conversations/messaging/stickers/{messengerType}
|
905
|
+
|
906
|
+
Requires ANY permissions:
|
907
|
+
|
908
|
+
* conversation:message:create
|
909
|
+
|
910
|
+
|
911
|
+
### Example
|
912
|
+
```{"language":"ruby"}
|
913
|
+
# load the gem
|
914
|
+
require 'purecloudplatformclientv2'
|
915
|
+
# setup authorization
|
916
|
+
@secret = ENV['PURECLOUD_SECRET']
|
917
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
918
|
+
environment = "mypurecloud.com"
|
919
|
+
|
920
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
921
|
+
|
922
|
+
PureCloud.configure do |config|
|
923
|
+
config.access_token = @authToken
|
924
|
+
end
|
925
|
+
|
926
|
+
api_instance = PureCloud::MessagingApi.new
|
927
|
+
|
928
|
+
messenger_type = "messenger_type_example" # String | Messenger Type
|
929
|
+
|
930
|
+
opts = {
|
931
|
+
page_size: 25, # Integer | Page size
|
932
|
+
page_number: 1 # Integer | Page number
|
933
|
+
}
|
934
|
+
|
935
|
+
begin
|
936
|
+
#Get a list of Messaging Stickers
|
937
|
+
result = api_instance.get_conversations_messaging_sticker(messenger_type, opts)
|
938
|
+
p result
|
939
|
+
rescue PureCloud::ApiError => e
|
940
|
+
puts "Exception when calling MessagingApi->get_conversations_messaging_sticker: #{e}"
|
941
|
+
end
|
942
|
+
```
|
943
|
+
|
944
|
+
### Parameters
|
945
|
+
|
946
|
+
Name | Type | Description | Notes
|
947
|
+
------------- | ------------- | ------------- | -------------
|
948
|
+
**messenger_type** | **String**| Messenger Type | |
|
949
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
950
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
951
|
+
{: class="table table-striped"}
|
887
952
|
|
888
953
|
|
954
|
+
### Return type
|
955
|
+
|
956
|
+
[**MessagingStickerEntityListing**](MessagingStickerEntityListing.html)
|
957
|
+
|
958
|
+
### HTTP request headers
|
959
|
+
|
960
|
+
- **Content-Type**: application/json
|
961
|
+
- **Accept**: application/json
|
962
|
+
|
963
|
+
|
964
|
+
|
965
|
+
<a name="get_messaging_integrations"></a>
|
966
|
+
|
967
|
+
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_messaging_integrations(opts)
|
968
|
+
|
969
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
970
|
+
|
971
|
+
Get a list of Integrations
|
972
|
+
|
973
|
+
|
974
|
+
|
975
|
+
Wraps GET /api/v2/messaging/integrations
|
976
|
+
|
977
|
+
Requires ANY permissions:
|
978
|
+
|
979
|
+
* messaging:integration:view
|
980
|
+
|
981
|
+
|
982
|
+
### Example
|
983
|
+
```{"language":"ruby"}
|
984
|
+
# load the gem
|
985
|
+
require 'purecloudplatformclientv2'
|
986
|
+
# setup authorization
|
987
|
+
@secret = ENV['PURECLOUD_SECRET']
|
988
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
989
|
+
environment = "mypurecloud.com"
|
990
|
+
|
991
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
992
|
+
|
993
|
+
PureCloud.configure do |config|
|
994
|
+
config.access_token = @authToken
|
995
|
+
end
|
996
|
+
|
997
|
+
api_instance = PureCloud::MessagingApi.new
|
998
|
+
|
999
|
+
opts = {
|
1000
|
+
page_size: 25, # Integer | Page size
|
1001
|
+
page_number: 1 # Integer | Page number
|
1002
|
+
}
|
1003
|
+
|
1004
|
+
begin
|
1005
|
+
#Get a list of Integrations
|
1006
|
+
result = api_instance.get_messaging_integrations(opts)
|
1007
|
+
p result
|
1008
|
+
rescue PureCloud::ApiError => e
|
1009
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations: #{e}"
|
1010
|
+
end
|
1011
|
+
```
|
1012
|
+
|
1013
|
+
### Parameters
|
1014
|
+
|
1015
|
+
Name | Type | Description | Notes
|
1016
|
+
------------- | ------------- | ------------- | -------------
|
1017
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1018
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1019
|
+
{: class="table table-striped"}
|
1020
|
+
|
1021
|
+
|
1022
|
+
### Return type
|
1023
|
+
|
1024
|
+
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
1025
|
+
|
1026
|
+
### HTTP request headers
|
1027
|
+
|
1028
|
+
- **Content-Type**: application/json
|
1029
|
+
- **Accept**: application/json
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
<a name="get_messaging_integrations_facebook"></a>
|
1034
|
+
|
1035
|
+
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_messaging_integrations_facebook(opts)
|
1036
|
+
|
1037
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1038
|
+
|
1039
|
+
Get a list of Facebook Integrations
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
Wraps GET /api/v2/messaging/integrations/facebook
|
1044
|
+
|
1045
|
+
Requires ANY permissions:
|
1046
|
+
|
1047
|
+
* messaging:integration:view
|
1048
|
+
|
1049
|
+
|
1050
|
+
### Example
|
1051
|
+
```{"language":"ruby"}
|
1052
|
+
# load the gem
|
1053
|
+
require 'purecloudplatformclientv2'
|
1054
|
+
# setup authorization
|
1055
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1056
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1057
|
+
environment = "mypurecloud.com"
|
1058
|
+
|
1059
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1060
|
+
|
1061
|
+
PureCloud.configure do |config|
|
1062
|
+
config.access_token = @authToken
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
api_instance = PureCloud::MessagingApi.new
|
1066
|
+
|
1067
|
+
opts = {
|
1068
|
+
page_size: 25, # Integer | Page size
|
1069
|
+
page_number: 1 # Integer | Page number
|
1070
|
+
}
|
1071
|
+
|
1072
|
+
begin
|
1073
|
+
#Get a list of Facebook Integrations
|
1074
|
+
result = api_instance.get_messaging_integrations_facebook(opts)
|
1075
|
+
p result
|
1076
|
+
rescue PureCloud::ApiError => e
|
1077
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_facebook: #{e}"
|
1078
|
+
end
|
1079
|
+
```
|
1080
|
+
|
1081
|
+
### Parameters
|
1082
|
+
|
1083
|
+
Name | Type | Description | Notes
|
1084
|
+
------------- | ------------- | ------------- | -------------
|
1085
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1086
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1087
|
+
{: class="table table-striped"}
|
1088
|
+
|
1089
|
+
|
1090
|
+
### Return type
|
1091
|
+
|
1092
|
+
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
1093
|
+
|
1094
|
+
### HTTP request headers
|
1095
|
+
|
1096
|
+
- **Content-Type**: application/json
|
1097
|
+
- **Accept**: application/json
|
1098
|
+
|
1099
|
+
|
1100
|
+
|
1101
|
+
<a name="get_messaging_integrations_facebook_integration_id"></a>
|
1102
|
+
|
1103
|
+
## [**FacebookIntegration**](FacebookIntegration.html) get_messaging_integrations_facebook_integration_id(integration_id)
|
1104
|
+
|
1105
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1106
|
+
|
1107
|
+
Get a Facebook messaging integration
|
1108
|
+
|
1109
|
+
|
1110
|
+
|
1111
|
+
Wraps GET /api/v2/messaging/integrations/facebook/{integrationId}
|
1112
|
+
|
1113
|
+
Requires ANY permissions:
|
1114
|
+
|
1115
|
+
* messaging:integration:view
|
1116
|
+
|
1117
|
+
|
1118
|
+
### Example
|
1119
|
+
```{"language":"ruby"}
|
1120
|
+
# load the gem
|
1121
|
+
require 'purecloudplatformclientv2'
|
1122
|
+
# setup authorization
|
1123
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1124
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1125
|
+
environment = "mypurecloud.com"
|
1126
|
+
|
1127
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1128
|
+
|
1129
|
+
PureCloud.configure do |config|
|
1130
|
+
config.access_token = @authToken
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
api_instance = PureCloud::MessagingApi.new
|
1134
|
+
|
1135
|
+
integration_id = "integration_id_example" # String | Integration ID
|
1136
|
+
|
1137
|
+
|
1138
|
+
begin
|
1139
|
+
#Get a Facebook messaging integration
|
1140
|
+
result = api_instance.get_messaging_integrations_facebook_integration_id(integration_id)
|
1141
|
+
p result
|
1142
|
+
rescue PureCloud::ApiError => e
|
1143
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_facebook_integration_id: #{e}"
|
1144
|
+
end
|
1145
|
+
```
|
1146
|
+
|
1147
|
+
### Parameters
|
1148
|
+
|
1149
|
+
Name | Type | Description | Notes
|
1150
|
+
------------- | ------------- | ------------- | -------------
|
1151
|
+
**integration_id** | **String**| Integration ID | |
|
1152
|
+
{: class="table table-striped"}
|
1153
|
+
|
1154
|
+
|
1155
|
+
### Return type
|
1156
|
+
|
1157
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
1158
|
+
|
1159
|
+
### HTTP request headers
|
1160
|
+
|
1161
|
+
- **Content-Type**: application/json
|
1162
|
+
- **Accept**: application/json
|
1163
|
+
|
1164
|
+
|
1165
|
+
|
1166
|
+
<a name="get_messaging_integrations_line"></a>
|
1167
|
+
|
1168
|
+
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_messaging_integrations_line(opts)
|
1169
|
+
|
1170
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1171
|
+
|
1172
|
+
Get a list of LINE messenger Integrations
|
1173
|
+
|
1174
|
+
|
1175
|
+
|
1176
|
+
Wraps GET /api/v2/messaging/integrations/line
|
1177
|
+
|
1178
|
+
Requires ANY permissions:
|
1179
|
+
|
1180
|
+
* messaging:integration:view
|
1181
|
+
|
1182
|
+
|
1183
|
+
### Example
|
1184
|
+
```{"language":"ruby"}
|
1185
|
+
# load the gem
|
1186
|
+
require 'purecloudplatformclientv2'
|
1187
|
+
# setup authorization
|
1188
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1189
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1190
|
+
environment = "mypurecloud.com"
|
1191
|
+
|
1192
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1193
|
+
|
1194
|
+
PureCloud.configure do |config|
|
1195
|
+
config.access_token = @authToken
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
api_instance = PureCloud::MessagingApi.new
|
1199
|
+
|
1200
|
+
opts = {
|
1201
|
+
page_size: 25, # Integer | Page size
|
1202
|
+
page_number: 1 # Integer | Page number
|
1203
|
+
}
|
1204
|
+
|
1205
|
+
begin
|
1206
|
+
#Get a list of LINE messenger Integrations
|
1207
|
+
result = api_instance.get_messaging_integrations_line(opts)
|
1208
|
+
p result
|
1209
|
+
rescue PureCloud::ApiError => e
|
1210
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_line: #{e}"
|
1211
|
+
end
|
1212
|
+
```
|
1213
|
+
|
1214
|
+
### Parameters
|
1215
|
+
|
1216
|
+
Name | Type | Description | Notes
|
1217
|
+
------------- | ------------- | ------------- | -------------
|
1218
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1219
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1220
|
+
{: class="table table-striped"}
|
1221
|
+
|
1222
|
+
|
1223
|
+
### Return type
|
1224
|
+
|
1225
|
+
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
1226
|
+
|
1227
|
+
### HTTP request headers
|
1228
|
+
|
1229
|
+
- **Content-Type**: application/json
|
1230
|
+
- **Accept**: application/json
|
1231
|
+
|
1232
|
+
|
1233
|
+
|
1234
|
+
<a name="get_messaging_integrations_line_integration_id"></a>
|
1235
|
+
|
1236
|
+
## [**LineIntegration**](LineIntegration.html) get_messaging_integrations_line_integration_id(integration_id)
|
1237
|
+
|
1238
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1239
|
+
|
1240
|
+
Get a LINE messenger integration
|
1241
|
+
|
1242
|
+
|
1243
|
+
|
1244
|
+
Wraps GET /api/v2/messaging/integrations/line/{integrationId}
|
1245
|
+
|
1246
|
+
Requires ANY permissions:
|
1247
|
+
|
1248
|
+
* messaging:integration:view
|
1249
|
+
|
1250
|
+
|
1251
|
+
### Example
|
1252
|
+
```{"language":"ruby"}
|
1253
|
+
# load the gem
|
1254
|
+
require 'purecloudplatformclientv2'
|
1255
|
+
# setup authorization
|
1256
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1257
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1258
|
+
environment = "mypurecloud.com"
|
1259
|
+
|
1260
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1261
|
+
|
1262
|
+
PureCloud.configure do |config|
|
1263
|
+
config.access_token = @authToken
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
api_instance = PureCloud::MessagingApi.new
|
1267
|
+
|
1268
|
+
integration_id = "integration_id_example" # String | Integration ID
|
1269
|
+
|
1270
|
+
|
1271
|
+
begin
|
1272
|
+
#Get a LINE messenger integration
|
1273
|
+
result = api_instance.get_messaging_integrations_line_integration_id(integration_id)
|
1274
|
+
p result
|
1275
|
+
rescue PureCloud::ApiError => e
|
1276
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_line_integration_id: #{e}"
|
1277
|
+
end
|
1278
|
+
```
|
1279
|
+
|
1280
|
+
### Parameters
|
1281
|
+
|
1282
|
+
Name | Type | Description | Notes
|
1283
|
+
------------- | ------------- | ------------- | -------------
|
1284
|
+
**integration_id** | **String**| Integration ID | |
|
1285
|
+
{: class="table table-striped"}
|
1286
|
+
|
1287
|
+
|
1288
|
+
### Return type
|
1289
|
+
|
1290
|
+
[**LineIntegration**](LineIntegration.html)
|
1291
|
+
|
1292
|
+
### HTTP request headers
|
1293
|
+
|
1294
|
+
- **Content-Type**: application/json
|
1295
|
+
- **Accept**: application/json
|
1296
|
+
|
1297
|
+
|
1298
|
+
|
1299
|
+
<a name="get_messaging_integrations_twitter"></a>
|
1300
|
+
|
1301
|
+
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_messaging_integrations_twitter(opts)
|
1302
|
+
|
1303
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1304
|
+
|
1305
|
+
Get a list of Twitter Integrations
|
1306
|
+
|
1307
|
+
|
1308
|
+
|
1309
|
+
Wraps GET /api/v2/messaging/integrations/twitter
|
1310
|
+
|
1311
|
+
Requires ANY permissions:
|
1312
|
+
|
1313
|
+
* messaging:integration:view
|
1314
|
+
|
1315
|
+
|
1316
|
+
### Example
|
1317
|
+
```{"language":"ruby"}
|
1318
|
+
# load the gem
|
1319
|
+
require 'purecloudplatformclientv2'
|
1320
|
+
# setup authorization
|
1321
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1322
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1323
|
+
environment = "mypurecloud.com"
|
1324
|
+
|
1325
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1326
|
+
|
1327
|
+
PureCloud.configure do |config|
|
1328
|
+
config.access_token = @authToken
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
api_instance = PureCloud::MessagingApi.new
|
1332
|
+
|
1333
|
+
opts = {
|
1334
|
+
page_size: 25, # Integer | Page size
|
1335
|
+
page_number: 1 # Integer | Page number
|
1336
|
+
}
|
1337
|
+
|
1338
|
+
begin
|
1339
|
+
#Get a list of Twitter Integrations
|
1340
|
+
result = api_instance.get_messaging_integrations_twitter(opts)
|
1341
|
+
p result
|
1342
|
+
rescue PureCloud::ApiError => e
|
1343
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_twitter: #{e}"
|
1344
|
+
end
|
1345
|
+
```
|
1346
|
+
|
1347
|
+
### Parameters
|
1348
|
+
|
1349
|
+
Name | Type | Description | Notes
|
1350
|
+
------------- | ------------- | ------------- | -------------
|
1351
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1352
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1353
|
+
{: class="table table-striped"}
|
1354
|
+
|
1355
|
+
|
1356
|
+
### Return type
|
1357
|
+
|
1358
|
+
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
1359
|
+
|
1360
|
+
### HTTP request headers
|
1361
|
+
|
1362
|
+
- **Content-Type**: application/json
|
1363
|
+
- **Accept**: application/json
|
1364
|
+
|
1365
|
+
|
1366
|
+
|
1367
|
+
<a name="get_messaging_integrations_twitter_integration_id"></a>
|
1368
|
+
|
1369
|
+
## [**TwitterIntegration**](TwitterIntegration.html) get_messaging_integrations_twitter_integration_id(integration_id)
|
1370
|
+
|
1371
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1372
|
+
|
1373
|
+
Get a Twitter messaging integration
|
1374
|
+
|
1375
|
+
|
1376
|
+
|
1377
|
+
Wraps GET /api/v2/messaging/integrations/twitter/{integrationId}
|
1378
|
+
|
1379
|
+
Requires ANY permissions:
|
1380
|
+
|
1381
|
+
* messaging:integration:view
|
1382
|
+
|
1383
|
+
|
1384
|
+
### Example
|
1385
|
+
```{"language":"ruby"}
|
1386
|
+
# load the gem
|
1387
|
+
require 'purecloudplatformclientv2'
|
1388
|
+
# setup authorization
|
1389
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1390
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1391
|
+
environment = "mypurecloud.com"
|
1392
|
+
|
1393
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1394
|
+
|
1395
|
+
PureCloud.configure do |config|
|
1396
|
+
config.access_token = @authToken
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
api_instance = PureCloud::MessagingApi.new
|
1400
|
+
|
1401
|
+
integration_id = "integration_id_example" # String | Integration ID
|
1402
|
+
|
1403
|
+
|
1404
|
+
begin
|
1405
|
+
#Get a Twitter messaging integration
|
1406
|
+
result = api_instance.get_messaging_integrations_twitter_integration_id(integration_id)
|
1407
|
+
p result
|
1408
|
+
rescue PureCloud::ApiError => e
|
1409
|
+
puts "Exception when calling MessagingApi->get_messaging_integrations_twitter_integration_id: #{e}"
|
1410
|
+
end
|
1411
|
+
```
|
1412
|
+
|
1413
|
+
### Parameters
|
1414
|
+
|
1415
|
+
Name | Type | Description | Notes
|
1416
|
+
------------- | ------------- | ------------- | -------------
|
1417
|
+
**integration_id** | **String**| Integration ID | |
|
1418
|
+
{: class="table table-striped"}
|
1419
|
+
|
1420
|
+
|
1421
|
+
### Return type
|
1422
|
+
|
1423
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
1424
|
+
|
1425
|
+
### HTTP request headers
|
1426
|
+
|
1427
|
+
- **Content-Type**: application/json
|
1428
|
+
- **Accept**: application/json
|
1429
|
+
|
1430
|
+
|
1431
|
+
|
1432
|
+
<a name="get_messaging_sticker"></a>
|
1433
|
+
|
1434
|
+
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_messaging_sticker(messenger_type, opts)
|
1435
|
+
|
1436
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1437
|
+
|
1438
|
+
Get a list of Messaging Stickers
|
1439
|
+
|
1440
|
+
|
1441
|
+
|
1442
|
+
Wraps GET /api/v2/messaging/stickers/{messengerType}
|
1443
|
+
|
1444
|
+
Requires ANY permissions:
|
1445
|
+
|
1446
|
+
* conversation:message:create
|
1447
|
+
|
1448
|
+
|
1449
|
+
### Example
|
1450
|
+
```{"language":"ruby"}
|
1451
|
+
# load the gem
|
1452
|
+
require 'purecloudplatformclientv2'
|
1453
|
+
# setup authorization
|
1454
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1455
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1456
|
+
environment = "mypurecloud.com"
|
1457
|
+
|
1458
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1459
|
+
|
1460
|
+
PureCloud.configure do |config|
|
1461
|
+
config.access_token = @authToken
|
1462
|
+
end
|
1463
|
+
|
1464
|
+
api_instance = PureCloud::MessagingApi.new
|
1465
|
+
|
1466
|
+
messenger_type = "messenger_type_example" # String | Messenger Type
|
1467
|
+
|
1468
|
+
opts = {
|
1469
|
+
page_size: 25, # Integer | Page size
|
1470
|
+
page_number: 1 # Integer | Page number
|
1471
|
+
}
|
1472
|
+
|
1473
|
+
begin
|
1474
|
+
#Get a list of Messaging Stickers
|
1475
|
+
result = api_instance.get_messaging_sticker(messenger_type, opts)
|
1476
|
+
p result
|
1477
|
+
rescue PureCloud::ApiError => e
|
1478
|
+
puts "Exception when calling MessagingApi->get_messaging_sticker: #{e}"
|
1479
|
+
end
|
1480
|
+
```
|
1481
|
+
|
1482
|
+
### Parameters
|
1483
|
+
|
1484
|
+
Name | Type | Description | Notes
|
1485
|
+
------------- | ------------- | ------------- | -------------
|
1486
|
+
**messenger_type** | **String**| Messenger Type | |
|
1487
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1488
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1489
|
+
{: class="table table-striped"}
|
1490
|
+
|
1491
|
+
|
1492
|
+
### Return type
|
1493
|
+
|
1494
|
+
[**MessagingStickerEntityListing**](MessagingStickerEntityListing.html)
|
1495
|
+
|
1496
|
+
### HTTP request headers
|
1497
|
+
|
1498
|
+
- **Content-Type**: application/json
|
1499
|
+
- **Accept**: application/json
|
1500
|
+
|
1501
|
+
|
1502
|
+
|
1503
|
+
<a name="post_conversations_messaging_integrations_facebook"></a>
|
1504
|
+
|
1505
|
+
## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
|
1506
|
+
|
1507
|
+
|
1508
|
+
|
1509
|
+
Create a Facebook Integration
|
1510
|
+
|
1511
|
+
|
1512
|
+
|
1513
|
+
Wraps POST /api/v2/conversations/messaging/integrations/facebook
|
1514
|
+
|
1515
|
+
Requires ANY permissions:
|
1516
|
+
|
1517
|
+
* messaging:integration:add
|
1518
|
+
|
1519
|
+
|
1520
|
+
### Example
|
1521
|
+
```{"language":"ruby"}
|
1522
|
+
# load the gem
|
1523
|
+
require 'purecloudplatformclientv2'
|
1524
|
+
# setup authorization
|
1525
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1526
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1527
|
+
environment = "mypurecloud.com"
|
1528
|
+
|
1529
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1530
|
+
|
1531
|
+
PureCloud.configure do |config|
|
1532
|
+
config.access_token = @authToken
|
1533
|
+
end
|
1534
|
+
|
1535
|
+
api_instance = PureCloud::MessagingApi.new
|
1536
|
+
|
1537
|
+
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
1538
|
+
|
1539
|
+
|
1540
|
+
begin
|
1541
|
+
#Create a Facebook Integration
|
1542
|
+
result = api_instance.post_conversations_messaging_integrations_facebook(body)
|
1543
|
+
p result
|
1544
|
+
rescue PureCloud::ApiError => e
|
1545
|
+
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_facebook: #{e}"
|
1546
|
+
end
|
1547
|
+
```
|
1548
|
+
|
1549
|
+
### Parameters
|
1550
|
+
|
1551
|
+
Name | Type | Description | Notes
|
1552
|
+
------------- | ------------- | ------------- | -------------
|
1553
|
+
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
1554
|
+
{: class="table table-striped"}
|
1555
|
+
|
1556
|
+
|
1557
|
+
### Return type
|
1558
|
+
|
1559
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
1560
|
+
|
1561
|
+
### HTTP request headers
|
1562
|
+
|
1563
|
+
- **Content-Type**: application/json
|
1564
|
+
- **Accept**: application/json
|
1565
|
+
|
1566
|
+
|
1567
|
+
|
1568
|
+
<a name="post_conversations_messaging_integrations_line"></a>
|
1569
|
+
|
1570
|
+
## [**LineIntegration**](LineIntegration.html) post_conversations_messaging_integrations_line(body)
|
1571
|
+
|
1572
|
+
|
1573
|
+
|
1574
|
+
Create a LINE messenger Integration
|
1575
|
+
|
1576
|
+
|
1577
|
+
|
1578
|
+
Wraps POST /api/v2/conversations/messaging/integrations/line
|
1579
|
+
|
1580
|
+
Requires ANY permissions:
|
1581
|
+
|
1582
|
+
* messaging:integration:add
|
1583
|
+
|
1584
|
+
|
1585
|
+
### Example
|
1586
|
+
```{"language":"ruby"}
|
1587
|
+
# load the gem
|
1588
|
+
require 'purecloudplatformclientv2'
|
1589
|
+
# setup authorization
|
1590
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1591
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1592
|
+
environment = "mypurecloud.com"
|
1593
|
+
|
1594
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1595
|
+
|
1596
|
+
PureCloud.configure do |config|
|
1597
|
+
config.access_token = @authToken
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
api_instance = PureCloud::MessagingApi.new
|
1601
|
+
|
1602
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
1603
|
+
|
1604
|
+
|
1605
|
+
begin
|
1606
|
+
#Create a LINE messenger Integration
|
1607
|
+
result = api_instance.post_conversations_messaging_integrations_line(body)
|
1608
|
+
p result
|
1609
|
+
rescue PureCloud::ApiError => e
|
1610
|
+
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_line: #{e}"
|
1611
|
+
end
|
1612
|
+
```
|
1613
|
+
|
1614
|
+
### Parameters
|
1615
|
+
|
1616
|
+
Name | Type | Description | Notes
|
1617
|
+
------------- | ------------- | ------------- | -------------
|
1618
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
1619
|
+
{: class="table table-striped"}
|
1620
|
+
|
1621
|
+
|
1622
|
+
### Return type
|
1623
|
+
|
1624
|
+
[**LineIntegration**](LineIntegration.html)
|
1625
|
+
|
1626
|
+
### HTTP request headers
|
1627
|
+
|
1628
|
+
- **Content-Type**: application/json
|
1629
|
+
- **Accept**: application/json
|
1630
|
+
|
1631
|
+
|
1632
|
+
|
1633
|
+
<a name="post_conversations_messaging_integrations_twitter"></a>
|
1634
|
+
|
1635
|
+
## [**TwitterIntegration**](TwitterIntegration.html) post_conversations_messaging_integrations_twitter(body)
|
1636
|
+
|
1637
|
+
|
1638
|
+
|
1639
|
+
Create a Twitter Integration
|
1640
|
+
|
1641
|
+
|
1642
|
+
|
1643
|
+
Wraps POST /api/v2/conversations/messaging/integrations/twitter
|
1644
|
+
|
1645
|
+
Requires ANY permissions:
|
1646
|
+
|
1647
|
+
* messaging:integration:add
|
1648
|
+
|
1649
|
+
|
1650
|
+
### Example
|
1651
|
+
```{"language":"ruby"}
|
1652
|
+
# load the gem
|
1653
|
+
require 'purecloudplatformclientv2'
|
1654
|
+
# setup authorization
|
1655
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1656
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1657
|
+
environment = "mypurecloud.com"
|
1658
|
+
|
1659
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1660
|
+
|
1661
|
+
PureCloud.configure do |config|
|
1662
|
+
config.access_token = @authToken
|
1663
|
+
end
|
1664
|
+
|
1665
|
+
api_instance = PureCloud::MessagingApi.new
|
1666
|
+
|
1667
|
+
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
1668
|
+
|
1669
|
+
|
1670
|
+
begin
|
1671
|
+
#Create a Twitter Integration
|
1672
|
+
result = api_instance.post_conversations_messaging_integrations_twitter(body)
|
1673
|
+
p result
|
1674
|
+
rescue PureCloud::ApiError => e
|
1675
|
+
puts "Exception when calling MessagingApi->post_conversations_messaging_integrations_twitter: #{e}"
|
1676
|
+
end
|
1677
|
+
```
|
1678
|
+
|
1679
|
+
### Parameters
|
1680
|
+
|
1681
|
+
Name | Type | Description | Notes
|
1682
|
+
------------- | ------------- | ------------- | -------------
|
1683
|
+
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
1684
|
+
{: class="table table-striped"}
|
1685
|
+
|
1686
|
+
|
1687
|
+
### Return type
|
1688
|
+
|
1689
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
1690
|
+
|
1691
|
+
### HTTP request headers
|
1692
|
+
|
1693
|
+
- **Content-Type**: application/json
|
1694
|
+
- **Accept**: application/json
|
1695
|
+
|
1696
|
+
|
1697
|
+
|
1698
|
+
<a name="post_messaging_integrations_facebook"></a>
|
1699
|
+
|
1700
|
+
## [**FacebookIntegration**](FacebookIntegration.html) post_messaging_integrations_facebook(body)
|
1701
|
+
|
1702
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1703
|
+
|
1704
|
+
Create a Facebook Integration
|
1705
|
+
|
1706
|
+
|
1707
|
+
|
1708
|
+
Wraps POST /api/v2/messaging/integrations/facebook
|
1709
|
+
|
1710
|
+
Requires ANY permissions:
|
1711
|
+
|
1712
|
+
* messaging:integration:add
|
1713
|
+
|
1714
|
+
|
1715
|
+
### Example
|
1716
|
+
```{"language":"ruby"}
|
1717
|
+
# load the gem
|
1718
|
+
require 'purecloudplatformclientv2'
|
1719
|
+
# setup authorization
|
1720
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1721
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1722
|
+
environment = "mypurecloud.com"
|
1723
|
+
|
1724
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1725
|
+
|
1726
|
+
PureCloud.configure do |config|
|
1727
|
+
config.access_token = @authToken
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
api_instance = PureCloud::MessagingApi.new
|
1731
|
+
|
1732
|
+
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
1733
|
+
|
1734
|
+
|
1735
|
+
begin
|
1736
|
+
#Create a Facebook Integration
|
1737
|
+
result = api_instance.post_messaging_integrations_facebook(body)
|
1738
|
+
p result
|
1739
|
+
rescue PureCloud::ApiError => e
|
1740
|
+
puts "Exception when calling MessagingApi->post_messaging_integrations_facebook: #{e}"
|
1741
|
+
end
|
1742
|
+
```
|
1743
|
+
|
1744
|
+
### Parameters
|
1745
|
+
|
1746
|
+
Name | Type | Description | Notes
|
1747
|
+
------------- | ------------- | ------------- | -------------
|
1748
|
+
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
1749
|
+
{: class="table table-striped"}
|
1750
|
+
|
1751
|
+
|
1752
|
+
### Return type
|
1753
|
+
|
1754
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
1755
|
+
|
1756
|
+
### HTTP request headers
|
1757
|
+
|
1758
|
+
- **Content-Type**: application/json
|
1759
|
+
- **Accept**: application/json
|
1760
|
+
|
1761
|
+
|
1762
|
+
|
1763
|
+
<a name="post_messaging_integrations_line"></a>
|
1764
|
+
|
1765
|
+
## [**LineIntegration**](LineIntegration.html) post_messaging_integrations_line(body)
|
1766
|
+
|
1767
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1768
|
+
|
1769
|
+
Create a LINE messenger Integration
|
1770
|
+
|
1771
|
+
|
1772
|
+
|
1773
|
+
Wraps POST /api/v2/messaging/integrations/line
|
1774
|
+
|
1775
|
+
Requires ANY permissions:
|
1776
|
+
|
1777
|
+
* messaging:integration:add
|
1778
|
+
|
1779
|
+
|
1780
|
+
### Example
|
1781
|
+
```{"language":"ruby"}
|
1782
|
+
# load the gem
|
1783
|
+
require 'purecloudplatformclientv2'
|
1784
|
+
# setup authorization
|
1785
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1786
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1787
|
+
environment = "mypurecloud.com"
|
1788
|
+
|
1789
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1790
|
+
|
1791
|
+
PureCloud.configure do |config|
|
1792
|
+
config.access_token = @authToken
|
1793
|
+
end
|
1794
|
+
|
1795
|
+
api_instance = PureCloud::MessagingApi.new
|
1796
|
+
|
1797
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
1798
|
+
|
1799
|
+
|
1800
|
+
begin
|
1801
|
+
#Create a LINE messenger Integration
|
1802
|
+
result = api_instance.post_messaging_integrations_line(body)
|
1803
|
+
p result
|
1804
|
+
rescue PureCloud::ApiError => e
|
1805
|
+
puts "Exception when calling MessagingApi->post_messaging_integrations_line: #{e}"
|
1806
|
+
end
|
1807
|
+
```
|
1808
|
+
|
1809
|
+
### Parameters
|
1810
|
+
|
1811
|
+
Name | Type | Description | Notes
|
1812
|
+
------------- | ------------- | ------------- | -------------
|
1813
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
1814
|
+
{: class="table table-striped"}
|
1815
|
+
|
1816
|
+
|
1817
|
+
### Return type
|
1818
|
+
|
1819
|
+
[**LineIntegration**](LineIntegration.html)
|
1820
|
+
|
1821
|
+
### HTTP request headers
|
1822
|
+
|
1823
|
+
- **Content-Type**: application/json
|
1824
|
+
- **Accept**: application/json
|
1825
|
+
|
1826
|
+
|
1827
|
+
|
1828
|
+
<a name="post_messaging_integrations_twitter"></a>
|
1829
|
+
|
1830
|
+
## [**TwitterIntegration**](TwitterIntegration.html) post_messaging_integrations_twitter(body)
|
1831
|
+
|
1832
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
1833
|
+
|
1834
|
+
Create a Twitter Integration
|
1835
|
+
|
1836
|
+
|
1837
|
+
|
1838
|
+
Wraps POST /api/v2/messaging/integrations/twitter
|
1839
|
+
|
1840
|
+
Requires ANY permissions:
|
1841
|
+
|
1842
|
+
* messaging:integration:add
|
1843
|
+
|
1844
|
+
|
1845
|
+
### Example
|
1846
|
+
```{"language":"ruby"}
|
1847
|
+
# load the gem
|
1848
|
+
require 'purecloudplatformclientv2'
|
1849
|
+
# setup authorization
|
1850
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1851
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1852
|
+
environment = "mypurecloud.com"
|
1853
|
+
|
1854
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1855
|
+
|
1856
|
+
PureCloud.configure do |config|
|
1857
|
+
config.access_token = @authToken
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
api_instance = PureCloud::MessagingApi.new
|
1861
|
+
|
1862
|
+
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
1863
|
+
|
1864
|
+
|
1865
|
+
begin
|
1866
|
+
#Create a Twitter Integration
|
1867
|
+
result = api_instance.post_messaging_integrations_twitter(body)
|
1868
|
+
p result
|
1869
|
+
rescue PureCloud::ApiError => e
|
1870
|
+
puts "Exception when calling MessagingApi->post_messaging_integrations_twitter: #{e}"
|
1871
|
+
end
|
1872
|
+
```
|
1873
|
+
|
1874
|
+
### Parameters
|
1875
|
+
|
1876
|
+
Name | Type | Description | Notes
|
1877
|
+
------------- | ------------- | ------------- | -------------
|
1878
|
+
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
1879
|
+
{: class="table table-striped"}
|
1880
|
+
|
1881
|
+
|
1882
|
+
### Return type
|
1883
|
+
|
1884
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
1885
|
+
|
1886
|
+
### HTTP request headers
|
1887
|
+
|
1888
|
+
- **Content-Type**: application/json
|
1889
|
+
- **Accept**: application/json
|
1890
|
+
|
1891
|
+
|
1892
|
+
|
1893
|
+
<a name="put_conversations_messaging_integrations_line_integration_id"></a>
|
1894
|
+
|
1895
|
+
## [**LineIntegration**](LineIntegration.html) put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
1896
|
+
|
1897
|
+
|
1898
|
+
|
1899
|
+
Update a LINE messenger integration
|
1900
|
+
|
1901
|
+
|
1902
|
+
|
1903
|
+
Wraps PUT /api/v2/conversations/messaging/integrations/line/{integrationId}
|
1904
|
+
|
1905
|
+
Requires ANY permissions:
|
1906
|
+
|
1907
|
+
* messaging:integration:edit
|
1908
|
+
|
1909
|
+
|
1910
|
+
### Example
|
1911
|
+
```{"language":"ruby"}
|
1912
|
+
# load the gem
|
1913
|
+
require 'purecloudplatformclientv2'
|
1914
|
+
# setup authorization
|
1915
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1916
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1917
|
+
environment = "mypurecloud.com"
|
1918
|
+
|
1919
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1920
|
+
|
1921
|
+
PureCloud.configure do |config|
|
1922
|
+
config.access_token = @authToken
|
1923
|
+
end
|
1924
|
+
|
1925
|
+
api_instance = PureCloud::MessagingApi.new
|
1926
|
+
|
1927
|
+
integration_id = "integration_id_example" # String | Integration ID
|
1928
|
+
|
1929
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
1930
|
+
|
1931
|
+
|
1932
|
+
begin
|
1933
|
+
#Update a LINE messenger integration
|
1934
|
+
result = api_instance.put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
1935
|
+
p result
|
1936
|
+
rescue PureCloud::ApiError => e
|
1937
|
+
puts "Exception when calling MessagingApi->put_conversations_messaging_integrations_line_integration_id: #{e}"
|
1938
|
+
end
|
1939
|
+
```
|
1940
|
+
|
1941
|
+
### Parameters
|
1942
|
+
|
1943
|
+
Name | Type | Description | Notes
|
1944
|
+
------------- | ------------- | ------------- | -------------
|
1945
|
+
**integration_id** | **String**| Integration ID | |
|
1946
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
1947
|
+
{: class="table table-striped"}
|
1948
|
+
|
1949
|
+
|
1950
|
+
### Return type
|
1951
|
+
|
1952
|
+
[**LineIntegration**](LineIntegration.html)
|
1953
|
+
|
1954
|
+
### HTTP request headers
|
1955
|
+
|
1956
|
+
- **Content-Type**: application/json
|
1957
|
+
- **Accept**: application/json
|
1958
|
+
|
1959
|
+
|
1960
|
+
|
1961
|
+
<a name="put_messaging_integrations_line_integration_id"></a>
|
1962
|
+
|
1963
|
+
## [**LineIntegration**](LineIntegration.html) put_messaging_integrations_line_integration_id(integration_id, body)
|
1964
|
+
|
1965
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
889
1966
|
|
890
1967
|
Update a LINE messenger integration
|
891
1968
|
|