purecloudplatformclientv2 30.1.0 → 31.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AppFoundryApi.md +229 -0
- data/docs/AppFoundryListing.md +36 -0
- data/docs/AppFoundryListingCategory.md +14 -0
- data/docs/AppFoundryListingRegistryInfo.md +14 -0
- data/docs/ArchitectApi.md +14 -14
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +0 -120
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
- data/docs/CallConversationNotificationParticipants.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
- data/docs/CallbackConversationNotificationParticipants.md +1 -0
- data/docs/CallbackMediaParticipant.md +1 -0
- 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/CertificateDetails.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
- data/docs/ChatConversationNotificationParticipants.md +1 -0
- data/docs/ChatMediaParticipant.md +1 -0
- data/docs/ClientApp.md +21 -0
- data/docs/ClientAppConfigurationInfo.md +14 -0
- data/docs/ClientAppEntityListing.md +22 -0
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
- data/docs/CobrowseConversationNotificationParticipants.md +1 -0
- data/docs/CobrowseMediaParticipant.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationNotificationParticipant.md +1 -0
- data/docs/ConversationNotificationParticipants.md +1 -0
- data/docs/ConversationNotificationVideo.md +1 -0
- data/docs/ConversationNotificationVideos.md +1 -0
- data/docs/CreateCallRequest.md +2 -0
- data/docs/CreateIntegrationRequest.md +16 -0
- data/docs/Credential.md +17 -0
- data/docs/CredentialInfo.md +18 -0
- data/docs/CredentialInfoListing.md +22 -0
- data/docs/CredentialSpecification.md +15 -0
- data/docs/CredentialType.md +17 -0
- data/docs/CredentialTypeListing.md +22 -0
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataExportNotificationNotification.md +22 -0
- 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/DirectoryUserDevicesListing.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/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EffectiveConfiguration.md +17 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/EventEntity.md +14 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GSuite.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/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/Integration.md +21 -0
- data/docs/IntegrationConfiguration.md +20 -0
- data/docs/IntegrationConfigurationInfo.md +13 -0
- data/docs/IntegrationEntityListing.md +22 -0
- data/docs/IntegrationEvent.md +23 -0
- data/docs/IntegrationEventEntityListing.md +22 -0
- data/docs/IntegrationStatusInfo.md +16 -0
- data/docs/IntegrationType.md +26 -0
- data/docs/IntegrationTypeEntityListing.md +22 -0
- data/docs/IntegrationsApi.md +1457 -175
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IntradayDataUpdateNotification.md +2 -2
- data/docs/IntradayDataUpdateNotificationDateTime.md +16 -0
- data/docs/IntradayDataUpdateNotificationStartDate.md +16 -0
- data/docs/JsonNode.md +3 -3
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocalizedField.md +12 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MarketingInfo.md +14 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +1 -0
- data/docs/MessageConversationNotificationParticipants.md +1 -0
- data/docs/MessageInfo.md +16 -0
- data/docs/MessageMediaParticipant.md +1 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.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/PagedListingEntity.md +17 -0
- data/docs/Participant.md +1 -0
- data/docs/ParticipantBasic.md +1 -0
- 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/PingIdentity.md +1 -1
- data/docs/Platform.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PricingOption.md +14 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RegionTimeZone.md +16 -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/ReportingExportJobRequest.md +1 -1
- data/docs/ReportingExportJobResponse.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/Salesforce.md +1 -1
- 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/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
- 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/SmartCase.md +14 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialConversationNotificationParticipants.md +1 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- 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/{WfmMoveAgentsCompleteNotificationUser.md → TimeOffRequestUpdateNotificationUserReference.md} +2 -2
- data/docs/TimeZone.md +4 -4
- data/docs/TimeZoneEntityListing.md +2 -2
- 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/UserActionCategory.md +15 -0
- data/docs/UserActionCategoryEntityListing.md +22 -0
- 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/UserScheduleAdherence.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotification.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +16 -0
- data/docs/{TimeOffRequestUpdateNotificationUser.md → UserScheduleAdherenceUpdateNotificationUserReference.md} +2 -2
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VendorConnectionRequest.md +15 -0
- data/docs/VideoConversationNotificationParticipants.md +2 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WfmMoveAgentsCompleteNotificationResults.md +1 -1
- data/docs/{UserScheduleAdherenceUpdateNotificationUser.md → WfmMoveAgentsCompleteNotificationUserReference.md} +2 -2
- data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +43 -6
- data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +360 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +0 -145
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +1926 -321
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/app_foundry_listing.rb +815 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +231 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +231 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attribute_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_conversation_notification_call_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +41 -1
- 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/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/client_app.rb +432 -0
- data/lib/purecloudplatformclientv2/models/client_app_configuration_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +41 -1
- 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_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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +28 -1
- data/lib/purecloudplatformclientv2/models/create_call_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_integration_request.rb +291 -0
- data/lib/purecloudplatformclientv2/models/credential.rb +311 -0
- data/lib/purecloudplatformclientv2/models/credential_info.rb +331 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/credential_specification.rb +257 -0
- data/lib/purecloudplatformclientv2/models/credential_type.rb +309 -0
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +482 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- 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_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/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.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/effective_configuration.rb +338 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +41 -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/endpoint_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/event_entity.rb +228 -0
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/g_suite.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/identity_now.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.rb +432 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration.rb +417 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration_info.rb +203 -0
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/integration_event.rb +481 -0
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{data_column.rb → integration_status_info.rb} +79 -36
- data/lib/purecloudplatformclientv2/models/integration_type.rb +551 -0
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +428 -0
- 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/intraday_data_update_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +276 -0
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +66 -66
- 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/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/localized_field.rb +177 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/marketing_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_info.rb +278 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +43 -3
- 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/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.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/paged_listing_entity.rb +303 -0
- data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -4
- 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/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/platform.rb +236 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/pricing_option.rb +234 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_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/{authz_typed_object.rb → region_time_zone.rb} +58 -32
- 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 +35 -37
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -34
- 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/salesforce.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/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +40 -1
- 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/smart_case.rb +229 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- 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/{user_schedule_adherence_update_notification_user.rb → time_off_request_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -26
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- 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/user_action_category.rb +253 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +428 -0
- 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_schedule_adherence.rb +28 -2
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +43 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/{wfm_move_agents_complete_notification_user.rb → user_schedule_adherence_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/vendor_connection_request.rb +269 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +70 -4
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +70 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_notice_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_results.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request_update_notification_user.rb → wfm_move_agents_complete_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data.rb +1 -1
- 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 +88 -14
- data/docs/AuthzTypedObject.md +0 -14
- data/docs/DataColumn.md +0 -14
- data/docs/ObjectsApi.md +0 -132
- data/lib/purecloudplatformclientv2/api/objects_api.rb +0 -172
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: IntegrationEvent
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::IntegrationEvent
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | Unique ID for this event | [optional] |
|
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
12
|
+
| **correlation_id** | **String** | Correlation ID for the event | [optional] |
|
|
13
|
+
| **timestamp** | **DateTime** | Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
| **level** | **String** | Indicates the severity of the event. | [optional] |
|
|
15
|
+
| **event_code** | **String** | A classification for the event. Suitable for programmatic searching, sorting, or filtering | [optional] |
|
|
16
|
+
| **message** | [**MessageInfo**](MessageInfo.html) | Message indicating what happened | [optional] |
|
|
17
|
+
| **entities** | [**Array<EventEntity>**](EventEntity.html) | Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors) | [optional] |
|
|
18
|
+
| **context_attributes** | **Hash<String, String>** | Map of context attributes specific to this event. | [optional] |
|
|
19
|
+
| **detail_message** | [**MessageInfo**](MessageInfo.html) | Message with additional details about the event. (e.g. an exception cause.) | [optional] |
|
|
20
|
+
| **user** | [**User**](User.html) | User that took an action that resulted in the event. | [optional] |
|
|
21
|
+
{: class="table table-striped"}
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: IntegrationEventEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::IntegrationEventEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<IntegrationEvent>**](IntegrationEvent.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: IntegrationStatusInfo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::IntegrationStatusInfo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **code** | **String** | Machine-readable status as reported by the integration. | [optional] |
|
|
11
|
+
| **effective** | **String** | Localized, human-readable, effective status of the integration. | [optional] |
|
|
12
|
+
| **detail** | [**MessageInfo**](MessageInfo.html) | Localizable status details for the integration. | [optional] |
|
|
13
|
+
| **last_updated** | **DateTime** | Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: IntegrationType
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::IntegrationType
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The ID of the integration type. | |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **description** | **String** | Description of the integration type. | [optional] |
|
|
13
|
+
| **provider** | **String** | PureCloud provider of the integration type. | [optional] |
|
|
14
|
+
| **category** | **String** | Category describing the integration type. | [optional] |
|
|
15
|
+
| **images** | [**Array<UserImage>**](UserImage.html) | Collection of logos. | [optional] |
|
|
16
|
+
| **config_properties_schema_uri** | **String** | URI of the schema describing the key-value properties needed to configure an integration of this type. | [optional] |
|
|
17
|
+
| **config_advanced_schema_uri** | **String** | URI of the schema describing the advanced JSON document needed to configure an integration of this type. | [optional] |
|
|
18
|
+
| **help_uri** | **String** | URI of a page with more information about the integration type | [optional] |
|
|
19
|
+
| **credentials** | [**Hash<String, CredentialSpecification>**](CredentialSpecification.html) | Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration. | [optional] |
|
|
20
|
+
| **non_installable** | **BOOLEAN** | Indicates if the integration type is installable or not. | [optional] |
|
|
21
|
+
| **max_instances** | **Integer** | The maximum number of integration instances allowable for this integration type | [optional] |
|
|
22
|
+
| **user_permissions** | **Array<String>** | List of permissions required to permit user access to the integration type. | [optional] |
|
|
23
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
24
|
+
{: class="table table-striped"}
|
|
25
|
+
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: IntegrationTypeEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::IntegrationTypeEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<IntegrationType>**](IntegrationType.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/docs/IntegrationsApi.md
CHANGED
|
@@ -8,8 +8,13 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
+
[**delete_integration**](IntegrationsApi.html#delete_integration) | Delete integration.
|
|
11
12
|
[**delete_integrations_action**](IntegrationsApi.html#delete_integrations_action) | Delete an Action
|
|
12
13
|
[**delete_integrations_action_draft**](IntegrationsApi.html#delete_integrations_action_draft) | Delete a Draft
|
|
14
|
+
[**delete_integrations_credential**](IntegrationsApi.html#delete_integrations_credential) | Delete a set of credentials
|
|
15
|
+
[**get_integration**](IntegrationsApi.html#get_integration) | Get integration.
|
|
16
|
+
[**get_integration_config_current**](IntegrationsApi.html#get_integration_config_current) | Get integration configuration.
|
|
17
|
+
[**get_integrations**](IntegrationsApi.html#get_integrations) | List integrations
|
|
13
18
|
[**get_integrations_action**](IntegrationsApi.html#get_integrations_action) | Retrieves a single Action matching id.
|
|
14
19
|
[**get_integrations_action_draft**](IntegrationsApi.html#get_integrations_action_draft) | Retrieve a Draft
|
|
15
20
|
[**get_integrations_action_draft_schema**](IntegrationsApi.html#get_integrations_action_draft_schema) | Retrieve schema for a Draft based on filename.
|
|
@@ -20,8 +25,19 @@ Method | Description
|
|
|
20
25
|
[**get_integrations_actions**](IntegrationsApi.html#get_integrations_actions) | Retrieves all actions associated with filters passed in via query param.
|
|
21
26
|
[**get_integrations_actions_categories**](IntegrationsApi.html#get_integrations_actions_categories) | Retrieves all categories of available Actions
|
|
22
27
|
[**get_integrations_actions_drafts**](IntegrationsApi.html#get_integrations_actions_drafts) | Retrieves all action drafts associated with the filters passed in via query param.
|
|
28
|
+
[**get_integrations_clientapps**](IntegrationsApi.html#get_integrations_clientapps) | List permitted client app integrations for the logged in user
|
|
29
|
+
[**get_integrations_credential**](IntegrationsApi.html#get_integrations_credential) | Get a single credential with sensitive fields redacted
|
|
30
|
+
[**get_integrations_credentials**](IntegrationsApi.html#get_integrations_credentials) | List multiple sets of credentials
|
|
31
|
+
[**get_integrations_credentials_types**](IntegrationsApi.html#get_integrations_credentials_types) | List all credential types
|
|
32
|
+
[**get_integrations_eventlog**](IntegrationsApi.html#get_integrations_eventlog) | List all events
|
|
33
|
+
[**get_integrations_eventlog_event_id**](IntegrationsApi.html#get_integrations_eventlog_event_id) | Get a single event
|
|
34
|
+
[**get_integrations_type**](IntegrationsApi.html#get_integrations_type) | Get integration type.
|
|
35
|
+
[**get_integrations_type_configschema**](IntegrationsApi.html#get_integrations_type_configschema) | Get properties config schema for an integration type.
|
|
36
|
+
[**get_integrations_types**](IntegrationsApi.html#get_integrations_types) | List integration types
|
|
37
|
+
[**patch_integration**](IntegrationsApi.html#patch_integration) | Update an integration.
|
|
23
38
|
[**patch_integrations_action**](IntegrationsApi.html#patch_integrations_action) | Patch an Action
|
|
24
39
|
[**patch_integrations_action_draft**](IntegrationsApi.html#patch_integrations_action_draft) | Update an existing Draft
|
|
40
|
+
[**post_integrations**](IntegrationsApi.html#post_integrations) | Create an integration.
|
|
25
41
|
[**post_integrations_action_draft**](IntegrationsApi.html#post_integrations_action_draft) | Create a new Draft from existing Action
|
|
26
42
|
[**post_integrations_action_draft_publish**](IntegrationsApi.html#post_integrations_action_draft_publish) | Publish a Draft and make it the active Action configuration
|
|
27
43
|
[**post_integrations_action_draft_test**](IntegrationsApi.html#post_integrations_action_draft_test) | Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
@@ -29,17 +45,969 @@ Method | Description
|
|
|
29
45
|
[**post_integrations_action_test**](IntegrationsApi.html#post_integrations_action_test) | Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
30
46
|
[**post_integrations_actions**](IntegrationsApi.html#post_integrations_actions) | Create a new Action
|
|
31
47
|
[**post_integrations_actions_drafts**](IntegrationsApi.html#post_integrations_actions_drafts) | Create a new Draft
|
|
48
|
+
[**post_integrations_credentials**](IntegrationsApi.html#post_integrations_credentials) | Create a set of credentials
|
|
49
|
+
[**post_integrations_workforcemanagement_vendorconnection**](IntegrationsApi.html#post_integrations_workforcemanagement_vendorconnection) | Add a vendor connection
|
|
50
|
+
[**put_integration_config_current**](IntegrationsApi.html#put_integration_config_current) | Update integration configuration.
|
|
51
|
+
[**put_integrations_credential**](IntegrationsApi.html#put_integrations_credential) | Update a set of credentials
|
|
32
52
|
{: class="table table-striped"}
|
|
33
53
|
|
|
54
|
+
<a name="delete_integration"></a>
|
|
55
|
+
|
|
56
|
+
## -[**Integration**](Integration.html) delete_integration(integration_id)
|
|
57
|
+
|
|
58
|
+
Delete integration.
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
Wraps DELETE /api/v2/integrations/{integrationId}
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### Example
|
|
66
|
+
~~~ruby
|
|
67
|
+
# load the gem
|
|
68
|
+
require 'purecloudplatformclientv2'
|
|
69
|
+
# setup authorization
|
|
70
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
71
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
72
|
+
environment = "mypurecloud.com"
|
|
73
|
+
|
|
74
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
75
|
+
|
|
76
|
+
PureCloud.configure do |config|
|
|
77
|
+
config.access_token = @authToken
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
81
|
+
|
|
82
|
+
integration_id = "integration_id_example" # String | Integration Id
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
begin
|
|
86
|
+
#Delete integration.
|
|
87
|
+
result = api_instance.delete_integration(integration_id)
|
|
88
|
+
p result
|
|
89
|
+
rescue PureCloud::ApiError => e
|
|
90
|
+
puts "Exception when calling IntegrationsApi->delete_integration: #{e}"
|
|
91
|
+
end
|
|
92
|
+
~~~
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
Name | Type | Description | Notes
|
|
97
|
+
------------- | ------------- | ------------- | -------------
|
|
98
|
+
**integration_id** | **String**| Integration Id | |
|
|
99
|
+
{: class="table table-striped"}
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**Integration**](Integration.html)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: application/json
|
|
109
|
+
- **Accept**: application/json
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
34
113
|
<a name="delete_integrations_action"></a>
|
|
35
114
|
|
|
36
|
-
## - delete_integrations_action(action_id)
|
|
115
|
+
## - delete_integrations_action(action_id)
|
|
116
|
+
|
|
117
|
+
Delete an Action
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
Wraps DELETE /api/v2/integrations/actions/{actionId}
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
### Example
|
|
125
|
+
~~~ruby
|
|
126
|
+
# load the gem
|
|
127
|
+
require 'purecloudplatformclientv2'
|
|
128
|
+
# setup authorization
|
|
129
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
130
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
131
|
+
environment = "mypurecloud.com"
|
|
132
|
+
|
|
133
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
134
|
+
|
|
135
|
+
PureCloud.configure do |config|
|
|
136
|
+
config.access_token = @authToken
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
140
|
+
|
|
141
|
+
action_id = "action_id_example" # String | actionId
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
begin
|
|
145
|
+
#Delete an Action
|
|
146
|
+
api_instance.delete_integrations_action(action_id)
|
|
147
|
+
rescue PureCloud::ApiError => e
|
|
148
|
+
puts "Exception when calling IntegrationsApi->delete_integrations_action: #{e}"
|
|
149
|
+
end
|
|
150
|
+
~~~
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
Name | Type | Description | Notes
|
|
155
|
+
------------- | ------------- | ------------- | -------------
|
|
156
|
+
**action_id** | **String**| actionId | |
|
|
157
|
+
{: class="table table-striped"}
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### Return type
|
|
161
|
+
|
|
162
|
+
nil (empty response body)
|
|
163
|
+
|
|
164
|
+
### HTTP request headers
|
|
165
|
+
|
|
166
|
+
- **Content-Type**: application/json
|
|
167
|
+
- **Accept**: application/json
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<a name="delete_integrations_action_draft"></a>
|
|
172
|
+
|
|
173
|
+
## - delete_integrations_action_draft(action_id)
|
|
174
|
+
|
|
175
|
+
Delete a Draft
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
Wraps DELETE /api/v2/integrations/actions/{actionId}/draft
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
~~~ruby
|
|
184
|
+
# load the gem
|
|
185
|
+
require 'purecloudplatformclientv2'
|
|
186
|
+
# setup authorization
|
|
187
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
188
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
189
|
+
environment = "mypurecloud.com"
|
|
190
|
+
|
|
191
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
192
|
+
|
|
193
|
+
PureCloud.configure do |config|
|
|
194
|
+
config.access_token = @authToken
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
198
|
+
|
|
199
|
+
action_id = "action_id_example" # String | actionId
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
begin
|
|
203
|
+
#Delete a Draft
|
|
204
|
+
api_instance.delete_integrations_action_draft(action_id)
|
|
205
|
+
rescue PureCloud::ApiError => e
|
|
206
|
+
puts "Exception when calling IntegrationsApi->delete_integrations_action_draft: #{e}"
|
|
207
|
+
end
|
|
208
|
+
~~~
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
Name | Type | Description | Notes
|
|
213
|
+
------------- | ------------- | ------------- | -------------
|
|
214
|
+
**action_id** | **String**| actionId | |
|
|
215
|
+
{: class="table table-striped"}
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
### Return type
|
|
219
|
+
|
|
220
|
+
nil (empty response body)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: application/json
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<a name="delete_integrations_credential"></a>
|
|
230
|
+
|
|
231
|
+
## - delete_integrations_credential(credential_id)
|
|
232
|
+
|
|
233
|
+
Delete a set of credentials
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
Wraps DELETE /api/v2/integrations/credentials/{credentialId}
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
### Example
|
|
241
|
+
~~~ruby
|
|
242
|
+
# load the gem
|
|
243
|
+
require 'purecloudplatformclientv2'
|
|
244
|
+
# setup authorization
|
|
245
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
246
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
247
|
+
environment = "mypurecloud.com"
|
|
248
|
+
|
|
249
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
250
|
+
|
|
251
|
+
PureCloud.configure do |config|
|
|
252
|
+
config.access_token = @authToken
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
256
|
+
|
|
257
|
+
credential_id = "credential_id_example" # String | Credential ID
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
begin
|
|
261
|
+
#Delete a set of credentials
|
|
262
|
+
api_instance.delete_integrations_credential(credential_id)
|
|
263
|
+
rescue PureCloud::ApiError => e
|
|
264
|
+
puts "Exception when calling IntegrationsApi->delete_integrations_credential: #{e}"
|
|
265
|
+
end
|
|
266
|
+
~~~
|
|
267
|
+
|
|
268
|
+
### Parameters
|
|
269
|
+
|
|
270
|
+
Name | Type | Description | Notes
|
|
271
|
+
------------- | ------------- | ------------- | -------------
|
|
272
|
+
**credential_id** | **String**| Credential ID | |
|
|
273
|
+
{: class="table table-striped"}
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
### Return type
|
|
277
|
+
|
|
278
|
+
nil (empty response body)
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: application/json
|
|
283
|
+
- **Accept**: application/json
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<a name="get_integration"></a>
|
|
288
|
+
|
|
289
|
+
## -[**Integration**](Integration.html) get_integration(integration_id, opts)
|
|
290
|
+
|
|
291
|
+
Get integration.
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
Wraps GET /api/v2/integrations/{integrationId}
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
### Example
|
|
299
|
+
~~~ruby
|
|
300
|
+
# load the gem
|
|
301
|
+
require 'purecloudplatformclientv2'
|
|
302
|
+
# setup authorization
|
|
303
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
304
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
305
|
+
environment = "mypurecloud.com"
|
|
306
|
+
|
|
307
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
308
|
+
|
|
309
|
+
PureCloud.configure do |config|
|
|
310
|
+
config.access_token = @authToken
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
314
|
+
|
|
315
|
+
integration_id = "integration_id_example" # String | Integration Id
|
|
316
|
+
|
|
317
|
+
opts = {
|
|
318
|
+
page_size: 25, # Integer | The total page size requested
|
|
319
|
+
page_number: 1, # Integer | The page number requested
|
|
320
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
321
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
322
|
+
next_page: "next_page_example", # String | next page token
|
|
323
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
begin
|
|
327
|
+
#Get integration.
|
|
328
|
+
result = api_instance.get_integration(integration_id, opts)
|
|
329
|
+
p result
|
|
330
|
+
rescue PureCloud::ApiError => e
|
|
331
|
+
puts "Exception when calling IntegrationsApi->get_integration: #{e}"
|
|
332
|
+
end
|
|
333
|
+
~~~
|
|
334
|
+
|
|
335
|
+
### Parameters
|
|
336
|
+
|
|
337
|
+
Name | Type | Description | Notes
|
|
338
|
+
------------- | ------------- | ------------- | -------------
|
|
339
|
+
**integration_id** | **String**| Integration Id | |
|
|
340
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
341
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
342
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
343
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
344
|
+
**next_page** | **String**| next page token | [optional] |
|
|
345
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
346
|
+
{: class="table table-striped"}
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
### Return type
|
|
350
|
+
|
|
351
|
+
[**Integration**](Integration.html)
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: application/json
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<a name="get_integration_config_current"></a>
|
|
361
|
+
|
|
362
|
+
## -[**IntegrationConfiguration**](IntegrationConfiguration.html) get_integration_config_current(integration_id)
|
|
363
|
+
|
|
364
|
+
Get integration configuration.
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
Wraps GET /api/v2/integrations/{integrationId}/config/current
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
### Example
|
|
372
|
+
~~~ruby
|
|
373
|
+
# load the gem
|
|
374
|
+
require 'purecloudplatformclientv2'
|
|
375
|
+
# setup authorization
|
|
376
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
377
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
378
|
+
environment = "mypurecloud.com"
|
|
379
|
+
|
|
380
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
381
|
+
|
|
382
|
+
PureCloud.configure do |config|
|
|
383
|
+
config.access_token = @authToken
|
|
384
|
+
end
|
|
385
|
+
|
|
386
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
387
|
+
|
|
388
|
+
integration_id = "integration_id_example" # String | Integration Id
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
begin
|
|
392
|
+
#Get integration configuration.
|
|
393
|
+
result = api_instance.get_integration_config_current(integration_id)
|
|
394
|
+
p result
|
|
395
|
+
rescue PureCloud::ApiError => e
|
|
396
|
+
puts "Exception when calling IntegrationsApi->get_integration_config_current: #{e}"
|
|
397
|
+
end
|
|
398
|
+
~~~
|
|
399
|
+
|
|
400
|
+
### Parameters
|
|
401
|
+
|
|
402
|
+
Name | Type | Description | Notes
|
|
403
|
+
------------- | ------------- | ------------- | -------------
|
|
404
|
+
**integration_id** | **String**| Integration Id | |
|
|
405
|
+
{: class="table table-striped"}
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
### Return type
|
|
409
|
+
|
|
410
|
+
[**IntegrationConfiguration**](IntegrationConfiguration.html)
|
|
411
|
+
|
|
412
|
+
### HTTP request headers
|
|
413
|
+
|
|
414
|
+
- **Content-Type**: application/json
|
|
415
|
+
- **Accept**: application/json
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<a name="get_integrations"></a>
|
|
420
|
+
|
|
421
|
+
## -[**IntegrationEntityListing**](IntegrationEntityListing.html) get_integrations(opts)
|
|
422
|
+
|
|
423
|
+
List integrations
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
Wraps GET /api/v2/integrations
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
### Example
|
|
431
|
+
~~~ruby
|
|
432
|
+
# load the gem
|
|
433
|
+
require 'purecloudplatformclientv2'
|
|
434
|
+
# setup authorization
|
|
435
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
436
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
437
|
+
environment = "mypurecloud.com"
|
|
438
|
+
|
|
439
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
440
|
+
|
|
441
|
+
PureCloud.configure do |config|
|
|
442
|
+
config.access_token = @authToken
|
|
443
|
+
end
|
|
444
|
+
|
|
445
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
446
|
+
|
|
447
|
+
opts = {
|
|
448
|
+
page_size: 25, # Integer | The total page size requested
|
|
449
|
+
page_number: 1, # Integer | The page number requested
|
|
450
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
451
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
452
|
+
next_page: "next_page_example", # String | next page token
|
|
453
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
begin
|
|
457
|
+
#List integrations
|
|
458
|
+
result = api_instance.get_integrations(opts)
|
|
459
|
+
p result
|
|
460
|
+
rescue PureCloud::ApiError => e
|
|
461
|
+
puts "Exception when calling IntegrationsApi->get_integrations: #{e}"
|
|
462
|
+
end
|
|
463
|
+
~~~
|
|
464
|
+
|
|
465
|
+
### Parameters
|
|
466
|
+
|
|
467
|
+
Name | Type | Description | Notes
|
|
468
|
+
------------- | ------------- | ------------- | -------------
|
|
469
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
470
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
471
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
472
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
473
|
+
**next_page** | **String**| next page token | [optional] |
|
|
474
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
475
|
+
{: class="table table-striped"}
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
[**IntegrationEntityListing**](IntegrationEntityListing.html)
|
|
481
|
+
|
|
482
|
+
### HTTP request headers
|
|
483
|
+
|
|
484
|
+
- **Content-Type**: application/json
|
|
485
|
+
- **Accept**: application/json
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<a name="get_integrations_action"></a>
|
|
490
|
+
|
|
491
|
+
## -[**Action**](Action.html) get_integrations_action(action_id, opts)
|
|
492
|
+
|
|
493
|
+
Retrieves a single Action matching id.
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
Wraps GET /api/v2/integrations/actions/{actionId}
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
### Example
|
|
501
|
+
~~~ruby
|
|
502
|
+
# load the gem
|
|
503
|
+
require 'purecloudplatformclientv2'
|
|
504
|
+
# setup authorization
|
|
505
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
506
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
507
|
+
environment = "mypurecloud.com"
|
|
508
|
+
|
|
509
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
510
|
+
|
|
511
|
+
PureCloud.configure do |config|
|
|
512
|
+
config.access_token = @authToken
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
516
|
+
|
|
517
|
+
action_id = "action_id_example" # String | actionId
|
|
518
|
+
|
|
519
|
+
opts = {
|
|
520
|
+
expand: "expand_example", # String | Indicates fields of the response which should be expanded.
|
|
521
|
+
include_config: false # BOOLEAN | Show config when available
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
begin
|
|
525
|
+
#Retrieves a single Action matching id.
|
|
526
|
+
result = api_instance.get_integrations_action(action_id, opts)
|
|
527
|
+
p result
|
|
528
|
+
rescue PureCloud::ApiError => e
|
|
529
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action: #{e}"
|
|
530
|
+
end
|
|
531
|
+
~~~
|
|
532
|
+
|
|
533
|
+
### Parameters
|
|
534
|
+
|
|
535
|
+
Name | Type | Description | Notes
|
|
536
|
+
------------- | ------------- | ------------- | -------------
|
|
537
|
+
**action_id** | **String**| actionId | |
|
|
538
|
+
**expand** | **String**| Indicates fields of the response which should be expanded. | [optional] <br />**Values**: contract |
|
|
539
|
+
**include_config** | **BOOLEAN**| Show config when available | [optional] [default to false] |
|
|
540
|
+
{: class="table table-striped"}
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
### Return type
|
|
544
|
+
|
|
545
|
+
[**Action**](Action.html)
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: application/json
|
|
550
|
+
- **Accept**: application/json
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<a name="get_integrations_action_draft"></a>
|
|
555
|
+
|
|
556
|
+
## -[**Action**](Action.html) get_integrations_action_draft(action_id, opts)
|
|
557
|
+
|
|
558
|
+
Retrieve a Draft
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
### Example
|
|
566
|
+
~~~ruby
|
|
567
|
+
# load the gem
|
|
568
|
+
require 'purecloudplatformclientv2'
|
|
569
|
+
# setup authorization
|
|
570
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
571
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
572
|
+
environment = "mypurecloud.com"
|
|
573
|
+
|
|
574
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
575
|
+
|
|
576
|
+
PureCloud.configure do |config|
|
|
577
|
+
config.access_token = @authToken
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
581
|
+
|
|
582
|
+
action_id = "action_id_example" # String | actionId
|
|
583
|
+
|
|
584
|
+
opts = {
|
|
585
|
+
expand: "expand_example", # String | Indicates fields of the response which should be expanded.
|
|
586
|
+
include_config: false # BOOLEAN | Show config when available
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
begin
|
|
590
|
+
#Retrieve a Draft
|
|
591
|
+
result = api_instance.get_integrations_action_draft(action_id, opts)
|
|
592
|
+
p result
|
|
593
|
+
rescue PureCloud::ApiError => e
|
|
594
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft: #{e}"
|
|
595
|
+
end
|
|
596
|
+
~~~
|
|
597
|
+
|
|
598
|
+
### Parameters
|
|
599
|
+
|
|
600
|
+
Name | Type | Description | Notes
|
|
601
|
+
------------- | ------------- | ------------- | -------------
|
|
602
|
+
**action_id** | **String**| actionId | |
|
|
603
|
+
**expand** | **String**| Indicates fields of the response which should be expanded. | [optional] <br />**Values**: contract |
|
|
604
|
+
**include_config** | **BOOLEAN**| Show config when available | [optional] [default to false] |
|
|
605
|
+
{: class="table table-striped"}
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
[**Action**](Action.html)
|
|
611
|
+
|
|
612
|
+
### HTTP request headers
|
|
613
|
+
|
|
614
|
+
- **Content-Type**: application/json
|
|
615
|
+
- **Accept**: application/json
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
<a name="get_integrations_action_draft_schema"></a>
|
|
620
|
+
|
|
621
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_draft_schema(action_id, file_name)
|
|
622
|
+
|
|
623
|
+
Retrieve schema for a Draft based on filename.
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
### Example
|
|
631
|
+
~~~ruby
|
|
632
|
+
# load the gem
|
|
633
|
+
require 'purecloudplatformclientv2'
|
|
634
|
+
# setup authorization
|
|
635
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
636
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
637
|
+
environment = "mypurecloud.com"
|
|
638
|
+
|
|
639
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
640
|
+
|
|
641
|
+
PureCloud.configure do |config|
|
|
642
|
+
config.access_token = @authToken
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
646
|
+
|
|
647
|
+
action_id = "action_id_example" # String | actionId
|
|
648
|
+
|
|
649
|
+
file_name = "file_name_example" # String | Name of schema file to be retrieved for this draft.
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
begin
|
|
653
|
+
#Retrieve schema for a Draft based on filename.
|
|
654
|
+
result = api_instance.get_integrations_action_draft_schema(action_id, file_name)
|
|
655
|
+
p result
|
|
656
|
+
rescue PureCloud::ApiError => e
|
|
657
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_schema: #{e}"
|
|
658
|
+
end
|
|
659
|
+
~~~
|
|
660
|
+
|
|
661
|
+
### Parameters
|
|
662
|
+
|
|
663
|
+
Name | Type | Description | Notes
|
|
664
|
+
------------- | ------------- | ------------- | -------------
|
|
665
|
+
**action_id** | **String**| actionId | |
|
|
666
|
+
**file_name** | **String**| Name of schema file to be retrieved for this draft. | |
|
|
667
|
+
{: class="table table-striped"}
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
### Return type
|
|
671
|
+
|
|
672
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: application/json
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<a name="get_integrations_action_draft_template"></a>
|
|
682
|
+
|
|
683
|
+
## -String** get_integrations_action_draft_template(action_id, file_name)
|
|
684
|
+
|
|
685
|
+
Retrieve templates for a Draft based on filename.
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
### Example
|
|
693
|
+
~~~ruby
|
|
694
|
+
# load the gem
|
|
695
|
+
require 'purecloudplatformclientv2'
|
|
696
|
+
# setup authorization
|
|
697
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
698
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
699
|
+
environment = "mypurecloud.com"
|
|
700
|
+
|
|
701
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
702
|
+
|
|
703
|
+
PureCloud.configure do |config|
|
|
704
|
+
config.access_token = @authToken
|
|
705
|
+
end
|
|
706
|
+
|
|
707
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
708
|
+
|
|
709
|
+
action_id = "action_id_example" # String | actionId
|
|
710
|
+
|
|
711
|
+
file_name = "file_name_example" # String | Name of template file to be retrieved for this action draft.
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
begin
|
|
715
|
+
#Retrieve templates for a Draft based on filename.
|
|
716
|
+
result = api_instance.get_integrations_action_draft_template(action_id, file_name)
|
|
717
|
+
p result
|
|
718
|
+
rescue PureCloud::ApiError => e
|
|
719
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_template: #{e}"
|
|
720
|
+
end
|
|
721
|
+
~~~
|
|
722
|
+
|
|
723
|
+
### Parameters
|
|
724
|
+
|
|
725
|
+
Name | Type | Description | Notes
|
|
726
|
+
------------- | ------------- | ------------- | -------------
|
|
727
|
+
**action_id** | **String**| actionId | |
|
|
728
|
+
**file_name** | **String**| Name of template file to be retrieved for this action draft. | |
|
|
729
|
+
{: class="table table-striped"}
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
### Return type
|
|
733
|
+
|
|
734
|
+
**String**
|
|
735
|
+
|
|
736
|
+
### HTTP request headers
|
|
737
|
+
|
|
738
|
+
- **Content-Type**: application/json
|
|
739
|
+
- **Accept**: text/plain
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
<a name="get_integrations_action_draft_validation"></a>
|
|
744
|
+
|
|
745
|
+
## -[**DraftValidationResult**](DraftValidationResult.html) get_integrations_action_draft_validation(action_id)
|
|
746
|
+
|
|
747
|
+
Validate current Draft configuration.
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/validation
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
### Example
|
|
755
|
+
~~~ruby
|
|
756
|
+
# load the gem
|
|
757
|
+
require 'purecloudplatformclientv2'
|
|
758
|
+
# setup authorization
|
|
759
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
760
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
761
|
+
environment = "mypurecloud.com"
|
|
762
|
+
|
|
763
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
764
|
+
|
|
765
|
+
PureCloud.configure do |config|
|
|
766
|
+
config.access_token = @authToken
|
|
767
|
+
end
|
|
768
|
+
|
|
769
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
770
|
+
|
|
771
|
+
action_id = "action_id_example" # String | actionId
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
begin
|
|
775
|
+
#Validate current Draft configuration.
|
|
776
|
+
result = api_instance.get_integrations_action_draft_validation(action_id)
|
|
777
|
+
p result
|
|
778
|
+
rescue PureCloud::ApiError => e
|
|
779
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_validation: #{e}"
|
|
780
|
+
end
|
|
781
|
+
~~~
|
|
782
|
+
|
|
783
|
+
### Parameters
|
|
784
|
+
|
|
785
|
+
Name | Type | Description | Notes
|
|
786
|
+
------------- | ------------- | ------------- | -------------
|
|
787
|
+
**action_id** | **String**| actionId | |
|
|
788
|
+
{: class="table table-striped"}
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
### Return type
|
|
792
|
+
|
|
793
|
+
[**DraftValidationResult**](DraftValidationResult.html)
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: application/json
|
|
798
|
+
- **Accept**: application/json
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<a name="get_integrations_action_schema"></a>
|
|
803
|
+
|
|
804
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_schema(action_id, file_name)
|
|
805
|
+
|
|
806
|
+
Retrieve schema for an action based on filename.
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### Example
|
|
814
|
+
~~~ruby
|
|
815
|
+
# load the gem
|
|
816
|
+
require 'purecloudplatformclientv2'
|
|
817
|
+
# setup authorization
|
|
818
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
819
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
820
|
+
environment = "mypurecloud.com"
|
|
821
|
+
|
|
822
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
823
|
+
|
|
824
|
+
PureCloud.configure do |config|
|
|
825
|
+
config.access_token = @authToken
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
829
|
+
|
|
830
|
+
action_id = "action_id_example" # String | actionId
|
|
831
|
+
|
|
832
|
+
file_name = "file_name_example" # String | Name of schema file to be retrieved for this action.
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
begin
|
|
836
|
+
#Retrieve schema for an action based on filename.
|
|
837
|
+
result = api_instance.get_integrations_action_schema(action_id, file_name)
|
|
838
|
+
p result
|
|
839
|
+
rescue PureCloud::ApiError => e
|
|
840
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_schema: #{e}"
|
|
841
|
+
end
|
|
842
|
+
~~~
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
Name | Type | Description | Notes
|
|
847
|
+
------------- | ------------- | ------------- | -------------
|
|
848
|
+
**action_id** | **String**| actionId | |
|
|
849
|
+
**file_name** | **String**| Name of schema file to be retrieved for this action. | |
|
|
850
|
+
{: class="table table-striped"}
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
### Return type
|
|
854
|
+
|
|
855
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
|
856
|
+
|
|
857
|
+
### HTTP request headers
|
|
858
|
+
|
|
859
|
+
- **Content-Type**: application/json
|
|
860
|
+
- **Accept**: application/json
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<a name="get_integrations_action_template"></a>
|
|
865
|
+
|
|
866
|
+
## -String** get_integrations_action_template(action_id, file_name)
|
|
867
|
+
|
|
868
|
+
Retrieve text of templates for an action based on filename.
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/templates/{fileName}
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
### Example
|
|
876
|
+
~~~ruby
|
|
877
|
+
# load the gem
|
|
878
|
+
require 'purecloudplatformclientv2'
|
|
879
|
+
# setup authorization
|
|
880
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
881
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
882
|
+
environment = "mypurecloud.com"
|
|
883
|
+
|
|
884
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
885
|
+
|
|
886
|
+
PureCloud.configure do |config|
|
|
887
|
+
config.access_token = @authToken
|
|
888
|
+
end
|
|
889
|
+
|
|
890
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
891
|
+
|
|
892
|
+
action_id = "action_id_example" # String | actionId
|
|
893
|
+
|
|
894
|
+
file_name = "file_name_example" # String | Name of template file to be retrieved for this action.
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
begin
|
|
898
|
+
#Retrieve text of templates for an action based on filename.
|
|
899
|
+
result = api_instance.get_integrations_action_template(action_id, file_name)
|
|
900
|
+
p result
|
|
901
|
+
rescue PureCloud::ApiError => e
|
|
902
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_template: #{e}"
|
|
903
|
+
end
|
|
904
|
+
~~~
|
|
905
|
+
|
|
906
|
+
### Parameters
|
|
907
|
+
|
|
908
|
+
Name | Type | Description | Notes
|
|
909
|
+
------------- | ------------- | ------------- | -------------
|
|
910
|
+
**action_id** | **String**| actionId | |
|
|
911
|
+
**file_name** | **String**| Name of template file to be retrieved for this action. | |
|
|
912
|
+
{: class="table table-striped"}
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
### Return type
|
|
916
|
+
|
|
917
|
+
**String**
|
|
918
|
+
|
|
919
|
+
### HTTP request headers
|
|
920
|
+
|
|
921
|
+
- **Content-Type**: application/json
|
|
922
|
+
- **Accept**: text/plain
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
<a name="get_integrations_actions"></a>
|
|
927
|
+
|
|
928
|
+
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions(opts)
|
|
929
|
+
|
|
930
|
+
Retrieves all actions associated with filters passed in via query param.
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
Wraps GET /api/v2/integrations/actions
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
### Example
|
|
938
|
+
~~~ruby
|
|
939
|
+
# load the gem
|
|
940
|
+
require 'purecloudplatformclientv2'
|
|
941
|
+
# setup authorization
|
|
942
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
943
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
944
|
+
environment = "mypurecloud.com"
|
|
945
|
+
|
|
946
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
947
|
+
|
|
948
|
+
PureCloud.configure do |config|
|
|
949
|
+
config.access_token = @authToken
|
|
950
|
+
end
|
|
951
|
+
|
|
952
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
953
|
+
|
|
954
|
+
opts = {
|
|
955
|
+
category: "category_example", # String | Filter by category name
|
|
956
|
+
secure: "secure_example", # String | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
957
|
+
include_auth_actions: "include_auth_actions_example", # String | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
|
|
958
|
+
page_size: 25, # Integer | The total page size requested
|
|
959
|
+
page_number: 1, # Integer | The page number requested
|
|
960
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
961
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
962
|
+
next_page: "next_page_example", # String | next page token
|
|
963
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
begin
|
|
967
|
+
#Retrieves all actions associated with filters passed in via query param.
|
|
968
|
+
result = api_instance.get_integrations_actions(opts)
|
|
969
|
+
p result
|
|
970
|
+
rescue PureCloud::ApiError => e
|
|
971
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions: #{e}"
|
|
972
|
+
end
|
|
973
|
+
~~~
|
|
974
|
+
|
|
975
|
+
### Parameters
|
|
976
|
+
|
|
977
|
+
Name | Type | Description | Notes
|
|
978
|
+
------------- | ------------- | ------------- | -------------
|
|
979
|
+
**category** | **String**| Filter by category name | [optional] |
|
|
980
|
+
**secure** | **String**| Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. | [optional] <br />**Values**: true, false |
|
|
981
|
+
**include_auth_actions** | **String**| Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. | [optional] <br />**Values**: true, false |
|
|
982
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
983
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
984
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
985
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
986
|
+
**next_page** | **String**| next page token | [optional] |
|
|
987
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
988
|
+
{: class="table table-striped"}
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
### Return type
|
|
992
|
+
|
|
993
|
+
[**ActionEntityListing**](ActionEntityListing.html)
|
|
994
|
+
|
|
995
|
+
### HTTP request headers
|
|
37
996
|
|
|
38
|
-
|
|
997
|
+
- **Content-Type**: application/json
|
|
998
|
+
- **Accept**: application/json
|
|
39
999
|
|
|
40
1000
|
|
|
41
1001
|
|
|
42
|
-
|
|
1002
|
+
<a name="get_integrations_actions_categories"></a>
|
|
1003
|
+
|
|
1004
|
+
## -[**CategoryEntityListing**](CategoryEntityListing.html) get_integrations_actions_categories(opts)
|
|
1005
|
+
|
|
1006
|
+
Retrieves all categories of available Actions
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
Wraps GET /api/v2/integrations/actions/categories
|
|
43
1011
|
|
|
44
1012
|
|
|
45
1013
|
### Example
|
|
@@ -59,14 +1027,22 @@ end
|
|
|
59
1027
|
|
|
60
1028
|
api_instance = PureCloud::IntegrationsApi.new
|
|
61
1029
|
|
|
62
|
-
|
|
63
|
-
|
|
1030
|
+
opts = {
|
|
1031
|
+
secure: "secure_example", # String | Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
|
|
1032
|
+
page_size: 25, # Integer | The total page size requested
|
|
1033
|
+
page_number: 1, # Integer | The page number requested
|
|
1034
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
1035
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
1036
|
+
next_page: "next_page_example", # String | next page token
|
|
1037
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
1038
|
+
}
|
|
64
1039
|
|
|
65
1040
|
begin
|
|
66
|
-
#
|
|
67
|
-
api_instance.
|
|
1041
|
+
#Retrieves all categories of available Actions
|
|
1042
|
+
result = api_instance.get_integrations_actions_categories(opts)
|
|
1043
|
+
p result
|
|
68
1044
|
rescue PureCloud::ApiError => e
|
|
69
|
-
puts "Exception when calling IntegrationsApi->
|
|
1045
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions_categories: #{e}"
|
|
70
1046
|
end
|
|
71
1047
|
~~~
|
|
72
1048
|
|
|
@@ -74,13 +1050,19 @@ end
|
|
|
74
1050
|
|
|
75
1051
|
Name | Type | Description | Notes
|
|
76
1052
|
------------- | ------------- | ------------- | -------------
|
|
77
|
-
**
|
|
1053
|
+
**secure** | **String**| Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions. | [optional] <br />**Values**: true, false |
|
|
1054
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
1055
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
1056
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
1057
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
1058
|
+
**next_page** | **String**| next page token | [optional] |
|
|
1059
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
78
1060
|
{: class="table table-striped"}
|
|
79
1061
|
|
|
80
1062
|
|
|
81
1063
|
### Return type
|
|
82
1064
|
|
|
83
|
-
|
|
1065
|
+
[**CategoryEntityListing**](CategoryEntityListing.html)
|
|
84
1066
|
|
|
85
1067
|
### HTTP request headers
|
|
86
1068
|
|
|
@@ -89,15 +1071,15 @@ nil (empty response body)
|
|
|
89
1071
|
|
|
90
1072
|
|
|
91
1073
|
|
|
92
|
-
<a name="
|
|
1074
|
+
<a name="get_integrations_actions_drafts"></a>
|
|
93
1075
|
|
|
94
|
-
## -
|
|
1076
|
+
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions_drafts(opts)
|
|
95
1077
|
|
|
96
|
-
|
|
1078
|
+
Retrieves all action drafts associated with the filters passed in via query param.
|
|
97
1079
|
|
|
98
1080
|
|
|
99
1081
|
|
|
100
|
-
Wraps
|
|
1082
|
+
Wraps GET /api/v2/integrations/actions/drafts
|
|
101
1083
|
|
|
102
1084
|
|
|
103
1085
|
### Example
|
|
@@ -117,14 +1099,24 @@ end
|
|
|
117
1099
|
|
|
118
1100
|
api_instance = PureCloud::IntegrationsApi.new
|
|
119
1101
|
|
|
120
|
-
|
|
121
|
-
|
|
1102
|
+
opts = {
|
|
1103
|
+
category: "category_example", # String | Filter by category name
|
|
1104
|
+
secure: "secure_example", # String | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
1105
|
+
include_auth_actions: "include_auth_actions_example", # String | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
|
|
1106
|
+
page_size: 25, # Integer | The total page size requested
|
|
1107
|
+
page_number: 1, # Integer | The page number requested
|
|
1108
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
1109
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
1110
|
+
next_page: "next_page_example", # String | next page token
|
|
1111
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
1112
|
+
}
|
|
122
1113
|
|
|
123
1114
|
begin
|
|
124
|
-
#
|
|
125
|
-
api_instance.
|
|
1115
|
+
#Retrieves all action drafts associated with the filters passed in via query param.
|
|
1116
|
+
result = api_instance.get_integrations_actions_drafts(opts)
|
|
1117
|
+
p result
|
|
126
1118
|
rescue PureCloud::ApiError => e
|
|
127
|
-
puts "Exception when calling IntegrationsApi->
|
|
1119
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions_drafts: #{e}"
|
|
128
1120
|
end
|
|
129
1121
|
~~~
|
|
130
1122
|
|
|
@@ -132,13 +1124,21 @@ end
|
|
|
132
1124
|
|
|
133
1125
|
Name | Type | Description | Notes
|
|
134
1126
|
------------- | ------------- | ------------- | -------------
|
|
135
|
-
**
|
|
1127
|
+
**category** | **String**| Filter by category name | [optional] |
|
|
1128
|
+
**secure** | **String**| Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. | [optional] <br />**Values**: true, false |
|
|
1129
|
+
**include_auth_actions** | **String**| Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. | [optional] <br />**Values**: true, false |
|
|
1130
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
1131
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
1132
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
1133
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
1134
|
+
**next_page** | **String**| next page token | [optional] |
|
|
1135
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
136
1136
|
{: class="table table-striped"}
|
|
137
1137
|
|
|
138
1138
|
|
|
139
1139
|
### Return type
|
|
140
1140
|
|
|
141
|
-
|
|
1141
|
+
[**ActionEntityListing**](ActionEntityListing.html)
|
|
142
1142
|
|
|
143
1143
|
### HTTP request headers
|
|
144
1144
|
|
|
@@ -147,15 +1147,15 @@ nil (empty response body)
|
|
|
147
1147
|
|
|
148
1148
|
|
|
149
1149
|
|
|
150
|
-
<a name="
|
|
1150
|
+
<a name="get_integrations_clientapps"></a>
|
|
151
1151
|
|
|
152
|
-
## -[**
|
|
1152
|
+
## -[**ClientAppEntityListing**](ClientAppEntityListing.html) get_integrations_clientapps(opts)
|
|
153
1153
|
|
|
154
|
-
|
|
1154
|
+
List permitted client app integrations for the logged in user
|
|
155
1155
|
|
|
156
1156
|
|
|
157
1157
|
|
|
158
|
-
Wraps GET /api/v2/integrations/
|
|
1158
|
+
Wraps GET /api/v2/integrations/clientapps
|
|
159
1159
|
|
|
160
1160
|
|
|
161
1161
|
### Example
|
|
@@ -175,19 +1175,21 @@ end
|
|
|
175
1175
|
|
|
176
1176
|
api_instance = PureCloud::IntegrationsApi.new
|
|
177
1177
|
|
|
178
|
-
action_id = "action_id_example" # String | actionId
|
|
179
|
-
|
|
180
1178
|
opts = {
|
|
181
|
-
|
|
182
|
-
|
|
1179
|
+
page_size: 25, # Integer | The total page size requested
|
|
1180
|
+
page_number: 1, # Integer | The page number requested
|
|
1181
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
1182
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
|
1183
|
+
next_page: "next_page_example", # String | next page token
|
|
1184
|
+
previous_page: "previous_page_example" # String | Previous page token
|
|
183
1185
|
}
|
|
184
1186
|
|
|
185
1187
|
begin
|
|
186
|
-
#
|
|
187
|
-
result = api_instance.
|
|
1188
|
+
#List permitted client app integrations for the logged in user
|
|
1189
|
+
result = api_instance.get_integrations_clientapps(opts)
|
|
188
1190
|
p result
|
|
189
1191
|
rescue PureCloud::ApiError => e
|
|
190
|
-
puts "Exception when calling IntegrationsApi->
|
|
1192
|
+
puts "Exception when calling IntegrationsApi->get_integrations_clientapps: #{e}"
|
|
191
1193
|
end
|
|
192
1194
|
~~~
|
|
193
1195
|
|
|
@@ -195,15 +1197,18 @@ end
|
|
|
195
1197
|
|
|
196
1198
|
Name | Type | Description | Notes
|
|
197
1199
|
------------- | ------------- | ------------- | -------------
|
|
198
|
-
**
|
|
199
|
-
**
|
|
200
|
-
**
|
|
1200
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
1201
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
1202
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
1203
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
1204
|
+
**next_page** | **String**| next page token | [optional] |
|
|
1205
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
|
201
1206
|
{: class="table table-striped"}
|
|
202
1207
|
|
|
203
1208
|
|
|
204
1209
|
### Return type
|
|
205
1210
|
|
|
206
|
-
[**
|
|
1211
|
+
[**ClientAppEntityListing**](ClientAppEntityListing.html)
|
|
207
1212
|
|
|
208
1213
|
### HTTP request headers
|
|
209
1214
|
|
|
@@ -212,15 +1217,15 @@ Name | Type | Description | Notes
|
|
|
212
1217
|
|
|
213
1218
|
|
|
214
1219
|
|
|
215
|
-
<a name="
|
|
1220
|
+
<a name="get_integrations_credential"></a>
|
|
216
1221
|
|
|
217
|
-
## -[**
|
|
1222
|
+
## -[**Credential**](Credential.html) get_integrations_credential(credential_id)
|
|
218
1223
|
|
|
219
|
-
|
|
1224
|
+
Get a single credential with sensitive fields redacted
|
|
220
1225
|
|
|
221
1226
|
|
|
222
1227
|
|
|
223
|
-
Wraps GET /api/v2/integrations/
|
|
1228
|
+
Wraps GET /api/v2/integrations/credentials/{credentialId}
|
|
224
1229
|
|
|
225
1230
|
|
|
226
1231
|
### Example
|
|
@@ -240,19 +1245,15 @@ end
|
|
|
240
1245
|
|
|
241
1246
|
api_instance = PureCloud::IntegrationsApi.new
|
|
242
1247
|
|
|
243
|
-
|
|
1248
|
+
credential_id = "credential_id_example" # String | Credential ID
|
|
244
1249
|
|
|
245
|
-
opts = {
|
|
246
|
-
expand: "expand_example", # String | Indicates fields of the response which should be expanded.
|
|
247
|
-
include_config: false # BOOLEAN | Show config when available
|
|
248
|
-
}
|
|
249
1250
|
|
|
250
1251
|
begin
|
|
251
|
-
#
|
|
252
|
-
result = api_instance.
|
|
1252
|
+
#Get a single credential with sensitive fields redacted
|
|
1253
|
+
result = api_instance.get_integrations_credential(credential_id)
|
|
253
1254
|
p result
|
|
254
1255
|
rescue PureCloud::ApiError => e
|
|
255
|
-
puts "Exception when calling IntegrationsApi->
|
|
1256
|
+
puts "Exception when calling IntegrationsApi->get_integrations_credential: #{e}"
|
|
256
1257
|
end
|
|
257
1258
|
~~~
|
|
258
1259
|
|
|
@@ -260,15 +1261,13 @@ end
|
|
|
260
1261
|
|
|
261
1262
|
Name | Type | Description | Notes
|
|
262
1263
|
------------- | ------------- | ------------- | -------------
|
|
263
|
-
**
|
|
264
|
-
**expand** | **String**| Indicates fields of the response which should be expanded. | [optional] <br />**Values**: contract |
|
|
265
|
-
**include_config** | **BOOLEAN**| Show config when available | [optional] [default to false] |
|
|
1264
|
+
**credential_id** | **String**| Credential ID | |
|
|
266
1265
|
{: class="table table-striped"}
|
|
267
1266
|
|
|
268
1267
|
|
|
269
1268
|
### Return type
|
|
270
1269
|
|
|
271
|
-
[**
|
|
1270
|
+
[**Credential**](Credential.html)
|
|
272
1271
|
|
|
273
1272
|
### HTTP request headers
|
|
274
1273
|
|
|
@@ -277,15 +1276,15 @@ Name | Type | Description | Notes
|
|
|
277
1276
|
|
|
278
1277
|
|
|
279
1278
|
|
|
280
|
-
<a name="
|
|
1279
|
+
<a name="get_integrations_credentials"></a>
|
|
281
1280
|
|
|
282
|
-
## -[**
|
|
1281
|
+
## -[**CredentialInfoListing**](CredentialInfoListing.html) get_integrations_credentials(opts)
|
|
283
1282
|
|
|
284
|
-
|
|
1283
|
+
List multiple sets of credentials
|
|
285
1284
|
|
|
286
1285
|
|
|
287
1286
|
|
|
288
|
-
Wraps GET /api/v2/integrations/
|
|
1287
|
+
Wraps GET /api/v2/integrations/credentials
|
|
289
1288
|
|
|
290
1289
|
|
|
291
1290
|
### Example
|
|
@@ -305,17 +1304,17 @@ end
|
|
|
305
1304
|
|
|
306
1305
|
api_instance = PureCloud::IntegrationsApi.new
|
|
307
1306
|
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
1307
|
+
opts = {
|
|
1308
|
+
page_number: 1, # Integer | Page number
|
|
1309
|
+
page_size: 25 # Integer | Page size
|
|
1310
|
+
}
|
|
312
1311
|
|
|
313
1312
|
begin
|
|
314
|
-
#
|
|
315
|
-
result = api_instance.
|
|
1313
|
+
#List multiple sets of credentials
|
|
1314
|
+
result = api_instance.get_integrations_credentials(opts)
|
|
316
1315
|
p result
|
|
317
1316
|
rescue PureCloud::ApiError => e
|
|
318
|
-
puts "Exception when calling IntegrationsApi->
|
|
1317
|
+
puts "Exception when calling IntegrationsApi->get_integrations_credentials: #{e}"
|
|
319
1318
|
end
|
|
320
1319
|
~~~
|
|
321
1320
|
|
|
@@ -323,14 +1322,14 @@ end
|
|
|
323
1322
|
|
|
324
1323
|
Name | Type | Description | Notes
|
|
325
1324
|
------------- | ------------- | ------------- | -------------
|
|
326
|
-
**
|
|
327
|
-
**
|
|
1325
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1326
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
328
1327
|
{: class="table table-striped"}
|
|
329
1328
|
|
|
330
1329
|
|
|
331
1330
|
### Return type
|
|
332
1331
|
|
|
333
|
-
[**
|
|
1332
|
+
[**CredentialInfoListing**](CredentialInfoListing.html)
|
|
334
1333
|
|
|
335
1334
|
### HTTP request headers
|
|
336
1335
|
|
|
@@ -339,15 +1338,15 @@ Name | Type | Description | Notes
|
|
|
339
1338
|
|
|
340
1339
|
|
|
341
1340
|
|
|
342
|
-
<a name="
|
|
1341
|
+
<a name="get_integrations_credentials_types"></a>
|
|
343
1342
|
|
|
344
|
-
## -
|
|
1343
|
+
## -[**CredentialTypeListing**](CredentialTypeListing.html) get_integrations_credentials_types
|
|
345
1344
|
|
|
346
|
-
|
|
1345
|
+
List all credential types
|
|
347
1346
|
|
|
348
1347
|
|
|
349
1348
|
|
|
350
|
-
Wraps GET /api/v2/integrations/
|
|
1349
|
+
Wraps GET /api/v2/integrations/credentials/types
|
|
351
1350
|
|
|
352
1351
|
|
|
353
1352
|
### Example
|
|
@@ -367,49 +1366,40 @@ end
|
|
|
367
1366
|
|
|
368
1367
|
api_instance = PureCloud::IntegrationsApi.new
|
|
369
1368
|
|
|
370
|
-
action_id = "action_id_example" # String | actionId
|
|
371
|
-
|
|
372
|
-
file_name = "file_name_example" # String | Name of template file to be retrieved for this action draft.
|
|
373
|
-
|
|
374
|
-
|
|
375
1369
|
begin
|
|
376
|
-
#
|
|
377
|
-
result = api_instance.
|
|
1370
|
+
#List all credential types
|
|
1371
|
+
result = api_instance.get_integrations_credentials_types
|
|
378
1372
|
p result
|
|
379
1373
|
rescue PureCloud::ApiError => e
|
|
380
|
-
puts "Exception when calling IntegrationsApi->
|
|
1374
|
+
puts "Exception when calling IntegrationsApi->get_integrations_credentials_types: #{e}"
|
|
381
1375
|
end
|
|
382
1376
|
~~~
|
|
383
1377
|
|
|
384
1378
|
### Parameters
|
|
385
|
-
|
|
386
|
-
Name | Type | Description | Notes
|
|
387
|
-
------------- | ------------- | ------------- | -------------
|
|
388
|
-
**action_id** | **String**| actionId | |
|
|
389
|
-
**file_name** | **String**| Name of template file to be retrieved for this action draft. | |
|
|
1379
|
+
This endpoint does not need any parameter.
|
|
390
1380
|
{: class="table table-striped"}
|
|
391
1381
|
|
|
392
1382
|
|
|
393
1383
|
### Return type
|
|
394
1384
|
|
|
395
|
-
**
|
|
1385
|
+
[**CredentialTypeListing**](CredentialTypeListing.html)
|
|
396
1386
|
|
|
397
1387
|
### HTTP request headers
|
|
398
1388
|
|
|
399
1389
|
- **Content-Type**: application/json
|
|
400
|
-
- **Accept**:
|
|
1390
|
+
- **Accept**: application/json
|
|
401
1391
|
|
|
402
1392
|
|
|
403
1393
|
|
|
404
|
-
<a name="
|
|
1394
|
+
<a name="get_integrations_eventlog"></a>
|
|
405
1395
|
|
|
406
|
-
## -[**
|
|
1396
|
+
## -[**IntegrationEventEntityListing**](IntegrationEventEntityListing.html) get_integrations_eventlog(opts)
|
|
407
1397
|
|
|
408
|
-
|
|
1398
|
+
List all events
|
|
409
1399
|
|
|
410
1400
|
|
|
411
1401
|
|
|
412
|
-
Wraps GET /api/v2/integrations/
|
|
1402
|
+
Wraps GET /api/v2/integrations/eventlog
|
|
413
1403
|
|
|
414
1404
|
|
|
415
1405
|
### Example
|
|
@@ -429,15 +1419,20 @@ end
|
|
|
429
1419
|
|
|
430
1420
|
api_instance = PureCloud::IntegrationsApi.new
|
|
431
1421
|
|
|
432
|
-
|
|
433
|
-
|
|
1422
|
+
opts = {
|
|
1423
|
+
page_size: 25, # Integer | Page size
|
|
1424
|
+
page_number: 1, # Integer | Page number
|
|
1425
|
+
sort_by: "timestamp", # String | Sort by
|
|
1426
|
+
sort_order: "descending", # String | Order by
|
|
1427
|
+
entity_id: "entity_id_example" # String | Include only events with this entity ID
|
|
1428
|
+
}
|
|
434
1429
|
|
|
435
1430
|
begin
|
|
436
|
-
#
|
|
437
|
-
result = api_instance.
|
|
1431
|
+
#List all events
|
|
1432
|
+
result = api_instance.get_integrations_eventlog(opts)
|
|
438
1433
|
p result
|
|
439
1434
|
rescue PureCloud::ApiError => e
|
|
440
|
-
puts "Exception when calling IntegrationsApi->
|
|
1435
|
+
puts "Exception when calling IntegrationsApi->get_integrations_eventlog: #{e}"
|
|
441
1436
|
end
|
|
442
1437
|
~~~
|
|
443
1438
|
|
|
@@ -445,13 +1440,17 @@ end
|
|
|
445
1440
|
|
|
446
1441
|
Name | Type | Description | Notes
|
|
447
1442
|
------------- | ------------- | ------------- | -------------
|
|
448
|
-
**
|
|
1443
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1444
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1445
|
+
**sort_by** | **String**| Sort by | [optional] [default to timestamp] |
|
|
1446
|
+
**sort_order** | **String**| Order by | [optional] [default to descending] |
|
|
1447
|
+
**entity_id** | **String**| Include only events with this entity ID | [optional] |
|
|
449
1448
|
{: class="table table-striped"}
|
|
450
1449
|
|
|
451
1450
|
|
|
452
1451
|
### Return type
|
|
453
1452
|
|
|
454
|
-
[**
|
|
1453
|
+
[**IntegrationEventEntityListing**](IntegrationEventEntityListing.html)
|
|
455
1454
|
|
|
456
1455
|
### HTTP request headers
|
|
457
1456
|
|
|
@@ -460,15 +1459,15 @@ Name | Type | Description | Notes
|
|
|
460
1459
|
|
|
461
1460
|
|
|
462
1461
|
|
|
463
|
-
<a name="
|
|
1462
|
+
<a name="get_integrations_eventlog_event_id"></a>
|
|
464
1463
|
|
|
465
|
-
## -[**
|
|
1464
|
+
## -[**IntegrationEvent**](IntegrationEvent.html) get_integrations_eventlog_event_id(event_id)
|
|
466
1465
|
|
|
467
|
-
|
|
1466
|
+
Get a single event
|
|
468
1467
|
|
|
469
1468
|
|
|
470
1469
|
|
|
471
|
-
Wraps GET /api/v2/integrations/
|
|
1470
|
+
Wraps GET /api/v2/integrations/eventlog/{eventId}
|
|
472
1471
|
|
|
473
1472
|
|
|
474
1473
|
### Example
|
|
@@ -488,17 +1487,15 @@ end
|
|
|
488
1487
|
|
|
489
1488
|
api_instance = PureCloud::IntegrationsApi.new
|
|
490
1489
|
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
file_name = "file_name_example" # String | Name of schema file to be retrieved for this action.
|
|
1490
|
+
event_id = "event_id_example" # String | Event Id
|
|
494
1491
|
|
|
495
1492
|
|
|
496
1493
|
begin
|
|
497
|
-
#
|
|
498
|
-
result = api_instance.
|
|
1494
|
+
#Get a single event
|
|
1495
|
+
result = api_instance.get_integrations_eventlog_event_id(event_id)
|
|
499
1496
|
p result
|
|
500
1497
|
rescue PureCloud::ApiError => e
|
|
501
|
-
puts "Exception when calling IntegrationsApi->
|
|
1498
|
+
puts "Exception when calling IntegrationsApi->get_integrations_eventlog_event_id: #{e}"
|
|
502
1499
|
end
|
|
503
1500
|
~~~
|
|
504
1501
|
|
|
@@ -506,14 +1503,13 @@ end
|
|
|
506
1503
|
|
|
507
1504
|
Name | Type | Description | Notes
|
|
508
1505
|
------------- | ------------- | ------------- | -------------
|
|
509
|
-
**
|
|
510
|
-
**file_name** | **String**| Name of schema file to be retrieved for this action. | |
|
|
1506
|
+
**event_id** | **String**| Event Id | |
|
|
511
1507
|
{: class="table table-striped"}
|
|
512
1508
|
|
|
513
1509
|
|
|
514
1510
|
### Return type
|
|
515
1511
|
|
|
516
|
-
[**
|
|
1512
|
+
[**IntegrationEvent**](IntegrationEvent.html)
|
|
517
1513
|
|
|
518
1514
|
### HTTP request headers
|
|
519
1515
|
|
|
@@ -522,15 +1518,15 @@ Name | Type | Description | Notes
|
|
|
522
1518
|
|
|
523
1519
|
|
|
524
1520
|
|
|
525
|
-
<a name="
|
|
1521
|
+
<a name="get_integrations_type"></a>
|
|
526
1522
|
|
|
527
|
-
## -
|
|
1523
|
+
## -[**IntegrationType**](IntegrationType.html) get_integrations_type(type_id)
|
|
528
1524
|
|
|
529
|
-
|
|
1525
|
+
Get integration type.
|
|
530
1526
|
|
|
531
1527
|
|
|
532
1528
|
|
|
533
|
-
Wraps GET /api/v2/integrations/
|
|
1529
|
+
Wraps GET /api/v2/integrations/types/{typeId}
|
|
534
1530
|
|
|
535
1531
|
|
|
536
1532
|
### Example
|
|
@@ -550,17 +1546,15 @@ end
|
|
|
550
1546
|
|
|
551
1547
|
api_instance = PureCloud::IntegrationsApi.new
|
|
552
1548
|
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
file_name = "file_name_example" # String | Name of template file to be retrieved for this action.
|
|
1549
|
+
type_id = "type_id_example" # String | Integration Type Id
|
|
556
1550
|
|
|
557
1551
|
|
|
558
1552
|
begin
|
|
559
|
-
#
|
|
560
|
-
result = api_instance.
|
|
1553
|
+
#Get integration type.
|
|
1554
|
+
result = api_instance.get_integrations_type(type_id)
|
|
561
1555
|
p result
|
|
562
1556
|
rescue PureCloud::ApiError => e
|
|
563
|
-
puts "Exception when calling IntegrationsApi->
|
|
1557
|
+
puts "Exception when calling IntegrationsApi->get_integrations_type: #{e}"
|
|
564
1558
|
end
|
|
565
1559
|
~~~
|
|
566
1560
|
|
|
@@ -568,31 +1562,30 @@ end
|
|
|
568
1562
|
|
|
569
1563
|
Name | Type | Description | Notes
|
|
570
1564
|
------------- | ------------- | ------------- | -------------
|
|
571
|
-
**
|
|
572
|
-
**file_name** | **String**| Name of template file to be retrieved for this action. | |
|
|
1565
|
+
**type_id** | **String**| Integration Type Id | |
|
|
573
1566
|
{: class="table table-striped"}
|
|
574
1567
|
|
|
575
1568
|
|
|
576
1569
|
### Return type
|
|
577
1570
|
|
|
578
|
-
**
|
|
1571
|
+
[**IntegrationType**](IntegrationType.html)
|
|
579
1572
|
|
|
580
1573
|
### HTTP request headers
|
|
581
1574
|
|
|
582
1575
|
- **Content-Type**: application/json
|
|
583
|
-
- **Accept**:
|
|
1576
|
+
- **Accept**: application/json
|
|
584
1577
|
|
|
585
1578
|
|
|
586
1579
|
|
|
587
|
-
<a name="
|
|
1580
|
+
<a name="get_integrations_type_configschema"></a>
|
|
588
1581
|
|
|
589
|
-
## -[**
|
|
1582
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_type_configschema(type_id, config_type)
|
|
590
1583
|
|
|
591
|
-
|
|
1584
|
+
Get properties config schema for an integration type.
|
|
592
1585
|
|
|
593
1586
|
|
|
594
1587
|
|
|
595
|
-
Wraps GET /api/v2/integrations/
|
|
1588
|
+
Wraps GET /api/v2/integrations/types/{typeId}/configschemas/{configType}
|
|
596
1589
|
|
|
597
1590
|
|
|
598
1591
|
### Example
|
|
@@ -612,24 +1605,17 @@ end
|
|
|
612
1605
|
|
|
613
1606
|
api_instance = PureCloud::IntegrationsApi.new
|
|
614
1607
|
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
page_size: 25, # Integer | The total page size requested
|
|
620
|
-
page_number: 1, # Integer | The page number requested
|
|
621
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
622
|
-
expand: nil, # Array<Object> | variable name requested by expand list
|
|
623
|
-
next_page: "next_page_example", # String | next page token
|
|
624
|
-
previous_page: "previous_page_example" # String | Previous page token
|
|
625
|
-
}
|
|
1608
|
+
type_id = "type_id_example" # String | Integration Type Id
|
|
1609
|
+
|
|
1610
|
+
config_type = "config_type_example" # String | Config schema type
|
|
1611
|
+
|
|
626
1612
|
|
|
627
1613
|
begin
|
|
628
|
-
#
|
|
629
|
-
result = api_instance.
|
|
1614
|
+
#Get properties config schema for an integration type.
|
|
1615
|
+
result = api_instance.get_integrations_type_configschema(type_id, config_type)
|
|
630
1616
|
p result
|
|
631
1617
|
rescue PureCloud::ApiError => e
|
|
632
|
-
puts "Exception when calling IntegrationsApi->
|
|
1618
|
+
puts "Exception when calling IntegrationsApi->get_integrations_type_configschema: #{e}"
|
|
633
1619
|
end
|
|
634
1620
|
~~~
|
|
635
1621
|
|
|
@@ -637,21 +1623,14 @@ end
|
|
|
637
1623
|
|
|
638
1624
|
Name | Type | Description | Notes
|
|
639
1625
|
------------- | ------------- | ------------- | -------------
|
|
640
|
-
**
|
|
641
|
-
**
|
|
642
|
-
**include_auth_actions** | **String**| Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. | [optional] <br />**Values**: true, false |
|
|
643
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
644
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
645
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
646
|
-
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
647
|
-
**next_page** | **String**| next page token | [optional] |
|
|
648
|
-
**previous_page** | **String**| Previous page token | [optional] |
|
|
1626
|
+
**type_id** | **String**| Integration Type Id | |
|
|
1627
|
+
**config_type** | **String**| Config schema type | <br />**Values**: properties, advanced |
|
|
649
1628
|
{: class="table table-striped"}
|
|
650
1629
|
|
|
651
1630
|
|
|
652
1631
|
### Return type
|
|
653
1632
|
|
|
654
|
-
[**
|
|
1633
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
|
655
1634
|
|
|
656
1635
|
### HTTP request headers
|
|
657
1636
|
|
|
@@ -660,15 +1639,15 @@ Name | Type | Description | Notes
|
|
|
660
1639
|
|
|
661
1640
|
|
|
662
1641
|
|
|
663
|
-
<a name="
|
|
1642
|
+
<a name="get_integrations_types"></a>
|
|
664
1643
|
|
|
665
|
-
## -[**
|
|
1644
|
+
## -[**IntegrationTypeEntityListing**](IntegrationTypeEntityListing.html) get_integrations_types(opts)
|
|
666
1645
|
|
|
667
|
-
|
|
1646
|
+
List integration types
|
|
668
1647
|
|
|
669
1648
|
|
|
670
1649
|
|
|
671
|
-
Wraps GET /api/v2/integrations/
|
|
1650
|
+
Wraps GET /api/v2/integrations/types
|
|
672
1651
|
|
|
673
1652
|
|
|
674
1653
|
### Example
|
|
@@ -689,7 +1668,6 @@ end
|
|
|
689
1668
|
api_instance = PureCloud::IntegrationsApi.new
|
|
690
1669
|
|
|
691
1670
|
opts = {
|
|
692
|
-
secure: "secure_example", # String | Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
|
|
693
1671
|
page_size: 25, # Integer | The total page size requested
|
|
694
1672
|
page_number: 1, # Integer | The page number requested
|
|
695
1673
|
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
@@ -699,11 +1677,11 @@ opts = {
|
|
|
699
1677
|
}
|
|
700
1678
|
|
|
701
1679
|
begin
|
|
702
|
-
#
|
|
703
|
-
result = api_instance.
|
|
1680
|
+
#List integration types
|
|
1681
|
+
result = api_instance.get_integrations_types(opts)
|
|
704
1682
|
p result
|
|
705
1683
|
rescue PureCloud::ApiError => e
|
|
706
|
-
puts "Exception when calling IntegrationsApi->
|
|
1684
|
+
puts "Exception when calling IntegrationsApi->get_integrations_types: #{e}"
|
|
707
1685
|
end
|
|
708
1686
|
~~~
|
|
709
1687
|
|
|
@@ -711,7 +1689,6 @@ end
|
|
|
711
1689
|
|
|
712
1690
|
Name | Type | Description | Notes
|
|
713
1691
|
------------- | ------------- | ------------- | -------------
|
|
714
|
-
**secure** | **String**| Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions. | [optional] <br />**Values**: true, false |
|
|
715
1692
|
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
716
1693
|
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
717
1694
|
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
@@ -723,7 +1700,7 @@ Name | Type | Description | Notes
|
|
|
723
1700
|
|
|
724
1701
|
### Return type
|
|
725
1702
|
|
|
726
|
-
[**
|
|
1703
|
+
[**IntegrationTypeEntityListing**](IntegrationTypeEntityListing.html)
|
|
727
1704
|
|
|
728
1705
|
### HTTP request headers
|
|
729
1706
|
|
|
@@ -732,15 +1709,15 @@ Name | Type | Description | Notes
|
|
|
732
1709
|
|
|
733
1710
|
|
|
734
1711
|
|
|
735
|
-
<a name="
|
|
1712
|
+
<a name="patch_integration"></a>
|
|
736
1713
|
|
|
737
|
-
## -[**
|
|
1714
|
+
## -[**Integration**](Integration.html) patch_integration(integration_id, opts)
|
|
738
1715
|
|
|
739
|
-
|
|
1716
|
+
Update an integration.
|
|
740
1717
|
|
|
741
1718
|
|
|
742
1719
|
|
|
743
|
-
Wraps
|
|
1720
|
+
Wraps PATCH /api/v2/integrations/{integrationId}
|
|
744
1721
|
|
|
745
1722
|
|
|
746
1723
|
### Example
|
|
@@ -760,10 +1737,10 @@ end
|
|
|
760
1737
|
|
|
761
1738
|
api_instance = PureCloud::IntegrationsApi.new
|
|
762
1739
|
|
|
1740
|
+
integration_id = "integration_id_example" # String | Integration Id
|
|
1741
|
+
|
|
763
1742
|
opts = {
|
|
764
|
-
|
|
765
|
-
secure: "secure_example", # String | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
766
|
-
include_auth_actions: "include_auth_actions_example", # String | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.
|
|
1743
|
+
body: PureCloud::Integration.new, # Integration | Integration Update
|
|
767
1744
|
page_size: 25, # Integer | The total page size requested
|
|
768
1745
|
page_number: 1, # Integer | The page number requested
|
|
769
1746
|
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
@@ -773,11 +1750,11 @@ opts = {
|
|
|
773
1750
|
}
|
|
774
1751
|
|
|
775
1752
|
begin
|
|
776
|
-
#
|
|
777
|
-
result = api_instance.
|
|
1753
|
+
#Update an integration.
|
|
1754
|
+
result = api_instance.patch_integration(integration_id, opts)
|
|
778
1755
|
p result
|
|
779
1756
|
rescue PureCloud::ApiError => e
|
|
780
|
-
puts "Exception when calling IntegrationsApi->
|
|
1757
|
+
puts "Exception when calling IntegrationsApi->patch_integration: #{e}"
|
|
781
1758
|
end
|
|
782
1759
|
~~~
|
|
783
1760
|
|
|
@@ -785,9 +1762,8 @@ end
|
|
|
785
1762
|
|
|
786
1763
|
Name | Type | Description | Notes
|
|
787
1764
|
------------- | ------------- | ------------- | -------------
|
|
788
|
-
**
|
|
789
|
-
**
|
|
790
|
-
**include_auth_actions** | **String**| Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. | [optional] <br />**Values**: true, false |
|
|
1765
|
+
**integration_id** | **String**| Integration Id | |
|
|
1766
|
+
**body** | [**Integration**](Integration.html)| Integration Update | [optional] |
|
|
791
1767
|
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
792
1768
|
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
793
1769
|
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
@@ -799,7 +1775,7 @@ Name | Type | Description | Notes
|
|
|
799
1775
|
|
|
800
1776
|
### Return type
|
|
801
1777
|
|
|
802
|
-
[**
|
|
1778
|
+
[**Integration**](Integration.html)
|
|
803
1779
|
|
|
804
1780
|
### HTTP request headers
|
|
805
1781
|
|
|
@@ -932,6 +1908,66 @@ Name | Type | Description | Notes
|
|
|
932
1908
|
|
|
933
1909
|
|
|
934
1910
|
|
|
1911
|
+
<a name="post_integrations"></a>
|
|
1912
|
+
|
|
1913
|
+
## -[**Integration**](Integration.html) post_integrations(opts)
|
|
1914
|
+
|
|
1915
|
+
Create an integration.
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
Wraps POST /api/v2/integrations
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
### Example
|
|
1923
|
+
~~~ruby
|
|
1924
|
+
# load the gem
|
|
1925
|
+
require 'purecloudplatformclientv2'
|
|
1926
|
+
# setup authorization
|
|
1927
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1928
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1929
|
+
environment = "mypurecloud.com"
|
|
1930
|
+
|
|
1931
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1932
|
+
|
|
1933
|
+
PureCloud.configure do |config|
|
|
1934
|
+
config.access_token = @authToken
|
|
1935
|
+
end
|
|
1936
|
+
|
|
1937
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1938
|
+
|
|
1939
|
+
opts = {
|
|
1940
|
+
body: PureCloud::CreateIntegrationRequest.new # CreateIntegrationRequest | Integration
|
|
1941
|
+
}
|
|
1942
|
+
|
|
1943
|
+
begin
|
|
1944
|
+
#Create an integration.
|
|
1945
|
+
result = api_instance.post_integrations(opts)
|
|
1946
|
+
p result
|
|
1947
|
+
rescue PureCloud::ApiError => e
|
|
1948
|
+
puts "Exception when calling IntegrationsApi->post_integrations: #{e}"
|
|
1949
|
+
end
|
|
1950
|
+
~~~
|
|
1951
|
+
|
|
1952
|
+
### Parameters
|
|
1953
|
+
|
|
1954
|
+
Name | Type | Description | Notes
|
|
1955
|
+
------------- | ------------- | ------------- | -------------
|
|
1956
|
+
**body** | [**CreateIntegrationRequest**](CreateIntegrationRequest.html)| Integration | [optional] |
|
|
1957
|
+
{: class="table table-striped"}
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
### Return type
|
|
1961
|
+
|
|
1962
|
+
[**Integration**](Integration.html)
|
|
1963
|
+
|
|
1964
|
+
### HTTP request headers
|
|
1965
|
+
|
|
1966
|
+
- **Content-Type**: application/json
|
|
1967
|
+
- **Accept**: application/json
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
|
|
935
1971
|
<a name="post_integrations_action_draft"></a>
|
|
936
1972
|
|
|
937
1973
|
## -[**Action**](Action.html) post_integrations_action_draft(action_id)
|
|
@@ -1357,3 +2393,249 @@ Name | Type | Description | Notes
|
|
|
1357
2393
|
|
|
1358
2394
|
|
|
1359
2395
|
|
|
2396
|
+
<a name="post_integrations_credentials"></a>
|
|
2397
|
+
|
|
2398
|
+
## -[**CredentialInfo**](CredentialInfo.html) post_integrations_credentials(opts)
|
|
2399
|
+
|
|
2400
|
+
Create a set of credentials
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
Wraps POST /api/v2/integrations/credentials
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
### Example
|
|
2408
|
+
~~~ruby
|
|
2409
|
+
# load the gem
|
|
2410
|
+
require 'purecloudplatformclientv2'
|
|
2411
|
+
# setup authorization
|
|
2412
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2413
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2414
|
+
environment = "mypurecloud.com"
|
|
2415
|
+
|
|
2416
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2417
|
+
|
|
2418
|
+
PureCloud.configure do |config|
|
|
2419
|
+
config.access_token = @authToken
|
|
2420
|
+
end
|
|
2421
|
+
|
|
2422
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2423
|
+
|
|
2424
|
+
opts = {
|
|
2425
|
+
body: PureCloud::Credential.new # Credential | Credential
|
|
2426
|
+
}
|
|
2427
|
+
|
|
2428
|
+
begin
|
|
2429
|
+
#Create a set of credentials
|
|
2430
|
+
result = api_instance.post_integrations_credentials(opts)
|
|
2431
|
+
p result
|
|
2432
|
+
rescue PureCloud::ApiError => e
|
|
2433
|
+
puts "Exception when calling IntegrationsApi->post_integrations_credentials: #{e}"
|
|
2434
|
+
end
|
|
2435
|
+
~~~
|
|
2436
|
+
|
|
2437
|
+
### Parameters
|
|
2438
|
+
|
|
2439
|
+
Name | Type | Description | Notes
|
|
2440
|
+
------------- | ------------- | ------------- | -------------
|
|
2441
|
+
**body** | [**Credential**](Credential.html)| Credential | [optional] |
|
|
2442
|
+
{: class="table table-striped"}
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
### Return type
|
|
2446
|
+
|
|
2447
|
+
[**CredentialInfo**](CredentialInfo.html)
|
|
2448
|
+
|
|
2449
|
+
### HTTP request headers
|
|
2450
|
+
|
|
2451
|
+
- **Content-Type**: application/json
|
|
2452
|
+
- **Accept**: application/json
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
<a name="post_integrations_workforcemanagement_vendorconnection"></a>
|
|
2457
|
+
|
|
2458
|
+
## -[**UserActionCategoryEntityListing**](UserActionCategoryEntityListing.html) post_integrations_workforcemanagement_vendorconnection(opts)
|
|
2459
|
+
|
|
2460
|
+
Add a vendor connection
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
Wraps POST /api/v2/integrations/workforcemanagement/vendorconnection
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
### Example
|
|
2468
|
+
~~~ruby
|
|
2469
|
+
# load the gem
|
|
2470
|
+
require 'purecloudplatformclientv2'
|
|
2471
|
+
# setup authorization
|
|
2472
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2473
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2474
|
+
environment = "mypurecloud.com"
|
|
2475
|
+
|
|
2476
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2477
|
+
|
|
2478
|
+
PureCloud.configure do |config|
|
|
2479
|
+
config.access_token = @authToken
|
|
2480
|
+
end
|
|
2481
|
+
|
|
2482
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2483
|
+
|
|
2484
|
+
opts = {
|
|
2485
|
+
body: PureCloud::VendorConnectionRequest.new # VendorConnectionRequest |
|
|
2486
|
+
}
|
|
2487
|
+
|
|
2488
|
+
begin
|
|
2489
|
+
#Add a vendor connection
|
|
2490
|
+
result = api_instance.post_integrations_workforcemanagement_vendorconnection(opts)
|
|
2491
|
+
p result
|
|
2492
|
+
rescue PureCloud::ApiError => e
|
|
2493
|
+
puts "Exception when calling IntegrationsApi->post_integrations_workforcemanagement_vendorconnection: #{e}"
|
|
2494
|
+
end
|
|
2495
|
+
~~~
|
|
2496
|
+
|
|
2497
|
+
### Parameters
|
|
2498
|
+
|
|
2499
|
+
Name | Type | Description | Notes
|
|
2500
|
+
------------- | ------------- | ------------- | -------------
|
|
2501
|
+
**body** | [**VendorConnectionRequest**](VendorConnectionRequest.html)| | [optional] |
|
|
2502
|
+
{: class="table table-striped"}
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
### Return type
|
|
2506
|
+
|
|
2507
|
+
[**UserActionCategoryEntityListing**](UserActionCategoryEntityListing.html)
|
|
2508
|
+
|
|
2509
|
+
### HTTP request headers
|
|
2510
|
+
|
|
2511
|
+
- **Content-Type**: application/json
|
|
2512
|
+
- **Accept**: application/json
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
<a name="put_integration_config_current"></a>
|
|
2517
|
+
|
|
2518
|
+
## -[**IntegrationConfiguration**](IntegrationConfiguration.html) put_integration_config_current(integration_id, opts)
|
|
2519
|
+
|
|
2520
|
+
Update integration configuration.
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
Wraps PUT /api/v2/integrations/{integrationId}/config/current
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
### Example
|
|
2528
|
+
~~~ruby
|
|
2529
|
+
# load the gem
|
|
2530
|
+
require 'purecloudplatformclientv2'
|
|
2531
|
+
# setup authorization
|
|
2532
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2533
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2534
|
+
environment = "mypurecloud.com"
|
|
2535
|
+
|
|
2536
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2537
|
+
|
|
2538
|
+
PureCloud.configure do |config|
|
|
2539
|
+
config.access_token = @authToken
|
|
2540
|
+
end
|
|
2541
|
+
|
|
2542
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2543
|
+
|
|
2544
|
+
integration_id = "integration_id_example" # String | Integration Id
|
|
2545
|
+
|
|
2546
|
+
opts = {
|
|
2547
|
+
body: PureCloud::IntegrationConfiguration.new # IntegrationConfiguration | Integration Configuration
|
|
2548
|
+
}
|
|
2549
|
+
|
|
2550
|
+
begin
|
|
2551
|
+
#Update integration configuration.
|
|
2552
|
+
result = api_instance.put_integration_config_current(integration_id, opts)
|
|
2553
|
+
p result
|
|
2554
|
+
rescue PureCloud::ApiError => e
|
|
2555
|
+
puts "Exception when calling IntegrationsApi->put_integration_config_current: #{e}"
|
|
2556
|
+
end
|
|
2557
|
+
~~~
|
|
2558
|
+
|
|
2559
|
+
### Parameters
|
|
2560
|
+
|
|
2561
|
+
Name | Type | Description | Notes
|
|
2562
|
+
------------- | ------------- | ------------- | -------------
|
|
2563
|
+
**integration_id** | **String**| Integration Id | |
|
|
2564
|
+
**body** | [**IntegrationConfiguration**](IntegrationConfiguration.html)| Integration Configuration | [optional] |
|
|
2565
|
+
{: class="table table-striped"}
|
|
2566
|
+
|
|
2567
|
+
|
|
2568
|
+
### Return type
|
|
2569
|
+
|
|
2570
|
+
[**IntegrationConfiguration**](IntegrationConfiguration.html)
|
|
2571
|
+
|
|
2572
|
+
### HTTP request headers
|
|
2573
|
+
|
|
2574
|
+
- **Content-Type**: application/json
|
|
2575
|
+
- **Accept**: application/json
|
|
2576
|
+
|
|
2577
|
+
|
|
2578
|
+
|
|
2579
|
+
<a name="put_integrations_credential"></a>
|
|
2580
|
+
|
|
2581
|
+
## -[**CredentialInfo**](CredentialInfo.html) put_integrations_credential(credential_id, opts)
|
|
2582
|
+
|
|
2583
|
+
Update a set of credentials
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
|
|
2587
|
+
Wraps PUT /api/v2/integrations/credentials/{credentialId}
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
### Example
|
|
2591
|
+
~~~ruby
|
|
2592
|
+
# load the gem
|
|
2593
|
+
require 'purecloudplatformclientv2'
|
|
2594
|
+
# setup authorization
|
|
2595
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2596
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2597
|
+
environment = "mypurecloud.com"
|
|
2598
|
+
|
|
2599
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2600
|
+
|
|
2601
|
+
PureCloud.configure do |config|
|
|
2602
|
+
config.access_token = @authToken
|
|
2603
|
+
end
|
|
2604
|
+
|
|
2605
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2606
|
+
|
|
2607
|
+
credential_id = "credential_id_example" # String | Credential ID
|
|
2608
|
+
|
|
2609
|
+
opts = {
|
|
2610
|
+
body: PureCloud::Credential.new # Credential | Credential
|
|
2611
|
+
}
|
|
2612
|
+
|
|
2613
|
+
begin
|
|
2614
|
+
#Update a set of credentials
|
|
2615
|
+
result = api_instance.put_integrations_credential(credential_id, opts)
|
|
2616
|
+
p result
|
|
2617
|
+
rescue PureCloud::ApiError => e
|
|
2618
|
+
puts "Exception when calling IntegrationsApi->put_integrations_credential: #{e}"
|
|
2619
|
+
end
|
|
2620
|
+
~~~
|
|
2621
|
+
|
|
2622
|
+
### Parameters
|
|
2623
|
+
|
|
2624
|
+
Name | Type | Description | Notes
|
|
2625
|
+
------------- | ------------- | ------------- | -------------
|
|
2626
|
+
**credential_id** | **String**| Credential ID | |
|
|
2627
|
+
**body** | [**Credential**](Credential.html)| Credential | [optional] |
|
|
2628
|
+
{: class="table table-striped"}
|
|
2629
|
+
|
|
2630
|
+
|
|
2631
|
+
### Return type
|
|
2632
|
+
|
|
2633
|
+
[**CredentialInfo**](CredentialInfo.html)
|
|
2634
|
+
|
|
2635
|
+
### HTTP request headers
|
|
2636
|
+
|
|
2637
|
+
- **Content-Type**: application/json
|
|
2638
|
+
- **Accept**: application/json
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
|