purecloudplatformclientv2 34.0.0 → 35.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -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/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/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/EmailConversationEntityListing.md +1 -1
- 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/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- 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/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.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/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- 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/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- 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 +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
|
@@ -13,9 +13,9 @@ title: InboundDomainEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: InboundRouteEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: IntegrationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: IntegrationEventEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: IntegrationTypeEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/IntegrationsApi.md
CHANGED
|
@@ -55,12 +55,18 @@ Method | Description
|
|
|
55
55
|
|
|
56
56
|
## -[**Integration**](Integration.html) delete_integration(integration_id)
|
|
57
57
|
|
|
58
|
+
|
|
59
|
+
|
|
58
60
|
Delete integration.
|
|
59
61
|
|
|
60
62
|
|
|
61
63
|
|
|
62
64
|
Wraps DELETE /api/v2/integrations/{integrationId}
|
|
63
65
|
|
|
66
|
+
Requires NO permissions:
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
64
70
|
|
|
65
71
|
### Example
|
|
66
72
|
~~~ruby
|
|
@@ -114,12 +120,18 @@ Name | Type | Description | Notes
|
|
|
114
120
|
|
|
115
121
|
## - delete_integrations_action(action_id)
|
|
116
122
|
|
|
123
|
+
|
|
124
|
+
|
|
117
125
|
Delete an Action
|
|
118
126
|
|
|
119
127
|
|
|
120
128
|
|
|
121
129
|
Wraps DELETE /api/v2/integrations/actions/{actionId}
|
|
122
130
|
|
|
131
|
+
Requires ANY permissions:
|
|
132
|
+
|
|
133
|
+
* integrations:action:delete
|
|
134
|
+
|
|
123
135
|
|
|
124
136
|
### Example
|
|
125
137
|
~~~ruby
|
|
@@ -172,12 +184,18 @@ nil (empty response body)
|
|
|
172
184
|
|
|
173
185
|
## - delete_integrations_action_draft(action_id)
|
|
174
186
|
|
|
187
|
+
|
|
188
|
+
|
|
175
189
|
Delete a Draft
|
|
176
190
|
|
|
177
191
|
|
|
178
192
|
|
|
179
193
|
Wraps DELETE /api/v2/integrations/actions/{actionId}/draft
|
|
180
194
|
|
|
195
|
+
Requires ANY permissions:
|
|
196
|
+
|
|
197
|
+
* integrations:action:delete
|
|
198
|
+
|
|
181
199
|
|
|
182
200
|
### Example
|
|
183
201
|
~~~ruby
|
|
@@ -230,12 +248,18 @@ nil (empty response body)
|
|
|
230
248
|
|
|
231
249
|
## - delete_integrations_credential(credential_id)
|
|
232
250
|
|
|
251
|
+
|
|
252
|
+
|
|
233
253
|
Delete a set of credentials
|
|
234
254
|
|
|
235
255
|
|
|
236
256
|
|
|
237
257
|
Wraps DELETE /api/v2/integrations/credentials/{credentialId}
|
|
238
258
|
|
|
259
|
+
Requires NO permissions:
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
239
263
|
|
|
240
264
|
### Example
|
|
241
265
|
~~~ruby
|
|
@@ -288,12 +312,18 @@ nil (empty response body)
|
|
|
288
312
|
|
|
289
313
|
## -[**Integration**](Integration.html) get_integration(integration_id, opts)
|
|
290
314
|
|
|
315
|
+
|
|
316
|
+
|
|
291
317
|
Get integration.
|
|
292
318
|
|
|
293
319
|
|
|
294
320
|
|
|
295
321
|
Wraps GET /api/v2/integrations/{integrationId}
|
|
296
322
|
|
|
323
|
+
Requires NO permissions:
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
297
327
|
|
|
298
328
|
### Example
|
|
299
329
|
~~~ruby
|
|
@@ -361,12 +391,18 @@ Name | Type | Description | Notes
|
|
|
361
391
|
|
|
362
392
|
## -[**IntegrationConfiguration**](IntegrationConfiguration.html) get_integration_config_current(integration_id)
|
|
363
393
|
|
|
394
|
+
|
|
395
|
+
|
|
364
396
|
Get integration configuration.
|
|
365
397
|
|
|
366
398
|
|
|
367
399
|
|
|
368
400
|
Wraps GET /api/v2/integrations/{integrationId}/config/current
|
|
369
401
|
|
|
402
|
+
Requires NO permissions:
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
370
406
|
|
|
371
407
|
### Example
|
|
372
408
|
~~~ruby
|
|
@@ -420,12 +456,18 @@ Name | Type | Description | Notes
|
|
|
420
456
|
|
|
421
457
|
## -[**IntegrationEntityListing**](IntegrationEntityListing.html) get_integrations(opts)
|
|
422
458
|
|
|
459
|
+
|
|
460
|
+
|
|
423
461
|
List integrations
|
|
424
462
|
|
|
425
463
|
|
|
426
464
|
|
|
427
465
|
Wraps GET /api/v2/integrations
|
|
428
466
|
|
|
467
|
+
Requires NO permissions:
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
429
471
|
|
|
430
472
|
### Example
|
|
431
473
|
~~~ruby
|
|
@@ -490,12 +532,18 @@ Name | Type | Description | Notes
|
|
|
490
532
|
|
|
491
533
|
## -[**Action**](Action.html) get_integrations_action(action_id, opts)
|
|
492
534
|
|
|
535
|
+
|
|
536
|
+
|
|
493
537
|
Retrieves a single Action matching id.
|
|
494
538
|
|
|
495
539
|
|
|
496
540
|
|
|
497
541
|
Wraps GET /api/v2/integrations/actions/{actionId}
|
|
498
542
|
|
|
543
|
+
Requires ANY permissions:
|
|
544
|
+
|
|
545
|
+
* integrations:action:view* bridge:actions:view
|
|
546
|
+
|
|
499
547
|
|
|
500
548
|
### Example
|
|
501
549
|
~~~ruby
|
|
@@ -555,12 +603,18 @@ Name | Type | Description | Notes
|
|
|
555
603
|
|
|
556
604
|
## -[**Action**](Action.html) get_integrations_action_draft(action_id, opts)
|
|
557
605
|
|
|
606
|
+
|
|
607
|
+
|
|
558
608
|
Retrieve a Draft
|
|
559
609
|
|
|
560
610
|
|
|
561
611
|
|
|
562
612
|
Wraps GET /api/v2/integrations/actions/{actionId}/draft
|
|
563
613
|
|
|
614
|
+
Requires ANY permissions:
|
|
615
|
+
|
|
616
|
+
* integrations:action:view* bridge:actions:view
|
|
617
|
+
|
|
564
618
|
|
|
565
619
|
### Example
|
|
566
620
|
~~~ruby
|
|
@@ -620,12 +674,18 @@ Name | Type | Description | Notes
|
|
|
620
674
|
|
|
621
675
|
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_draft_schema(action_id, file_name)
|
|
622
676
|
|
|
677
|
+
|
|
678
|
+
|
|
623
679
|
Retrieve schema for a Draft based on filename.
|
|
624
680
|
|
|
625
681
|
|
|
626
682
|
|
|
627
683
|
Wraps GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}
|
|
628
684
|
|
|
685
|
+
Requires ANY permissions:
|
|
686
|
+
|
|
687
|
+
* integrations:action:view* bridge:actions:view
|
|
688
|
+
|
|
629
689
|
|
|
630
690
|
### Example
|
|
631
691
|
~~~ruby
|
|
@@ -682,12 +742,18 @@ Name | Type | Description | Notes
|
|
|
682
742
|
|
|
683
743
|
## -String** get_integrations_action_draft_template(action_id, file_name)
|
|
684
744
|
|
|
745
|
+
|
|
746
|
+
|
|
685
747
|
Retrieve templates for a Draft based on filename.
|
|
686
748
|
|
|
687
749
|
|
|
688
750
|
|
|
689
751
|
Wraps GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}
|
|
690
752
|
|
|
753
|
+
Requires ANY permissions:
|
|
754
|
+
|
|
755
|
+
* integrations:action:view* bridge:actions:view
|
|
756
|
+
|
|
691
757
|
|
|
692
758
|
### Example
|
|
693
759
|
~~~ruby
|
|
@@ -744,12 +810,18 @@ Name | Type | Description | Notes
|
|
|
744
810
|
|
|
745
811
|
## -[**DraftValidationResult**](DraftValidationResult.html) get_integrations_action_draft_validation(action_id)
|
|
746
812
|
|
|
813
|
+
|
|
814
|
+
|
|
747
815
|
Validate current Draft configuration.
|
|
748
816
|
|
|
749
817
|
|
|
750
818
|
|
|
751
819
|
Wraps GET /api/v2/integrations/actions/{actionId}/draft/validation
|
|
752
820
|
|
|
821
|
+
Requires ANY permissions:
|
|
822
|
+
|
|
823
|
+
* integrations:action:edit
|
|
824
|
+
|
|
753
825
|
|
|
754
826
|
### Example
|
|
755
827
|
~~~ruby
|
|
@@ -803,12 +875,18 @@ Name | Type | Description | Notes
|
|
|
803
875
|
|
|
804
876
|
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_schema(action_id, file_name)
|
|
805
877
|
|
|
878
|
+
|
|
879
|
+
|
|
806
880
|
Retrieve schema for an action based on filename.
|
|
807
881
|
|
|
808
882
|
|
|
809
883
|
|
|
810
884
|
Wraps GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}
|
|
811
885
|
|
|
886
|
+
Requires ANY permissions:
|
|
887
|
+
|
|
888
|
+
* integrations:action:view* bridge:actions:view
|
|
889
|
+
|
|
812
890
|
|
|
813
891
|
### Example
|
|
814
892
|
~~~ruby
|
|
@@ -865,12 +943,18 @@ Name | Type | Description | Notes
|
|
|
865
943
|
|
|
866
944
|
## -String** get_integrations_action_template(action_id, file_name)
|
|
867
945
|
|
|
946
|
+
|
|
947
|
+
|
|
868
948
|
Retrieve text of templates for an action based on filename.
|
|
869
949
|
|
|
870
950
|
|
|
871
951
|
|
|
872
952
|
Wraps GET /api/v2/integrations/actions/{actionId}/templates/{fileName}
|
|
873
953
|
|
|
954
|
+
Requires ANY permissions:
|
|
955
|
+
|
|
956
|
+
* integrations:action:view* bridge:actions:view
|
|
957
|
+
|
|
874
958
|
|
|
875
959
|
### Example
|
|
876
960
|
~~~ruby
|
|
@@ -927,12 +1011,18 @@ Name | Type | Description | Notes
|
|
|
927
1011
|
|
|
928
1012
|
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions(opts)
|
|
929
1013
|
|
|
1014
|
+
|
|
1015
|
+
|
|
930
1016
|
Retrieves all actions associated with filters passed in via query param.
|
|
931
1017
|
|
|
932
1018
|
|
|
933
1019
|
|
|
934
1020
|
Wraps GET /api/v2/integrations/actions
|
|
935
1021
|
|
|
1022
|
+
Requires ANY permissions:
|
|
1023
|
+
|
|
1024
|
+
* integrations:action:view* bridge:actions:view
|
|
1025
|
+
|
|
936
1026
|
|
|
937
1027
|
### Example
|
|
938
1028
|
~~~ruby
|
|
@@ -1003,12 +1093,18 @@ Name | Type | Description | Notes
|
|
|
1003
1093
|
|
|
1004
1094
|
## -[**CategoryEntityListing**](CategoryEntityListing.html) get_integrations_actions_categories(opts)
|
|
1005
1095
|
|
|
1096
|
+
|
|
1097
|
+
|
|
1006
1098
|
Retrieves all categories of available Actions
|
|
1007
1099
|
|
|
1008
1100
|
|
|
1009
1101
|
|
|
1010
1102
|
Wraps GET /api/v2/integrations/actions/categories
|
|
1011
1103
|
|
|
1104
|
+
Requires ANY permissions:
|
|
1105
|
+
|
|
1106
|
+
* integrations:action:view* bridge:actions:view
|
|
1107
|
+
|
|
1012
1108
|
|
|
1013
1109
|
### Example
|
|
1014
1110
|
~~~ruby
|
|
@@ -1075,12 +1171,18 @@ Name | Type | Description | Notes
|
|
|
1075
1171
|
|
|
1076
1172
|
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions_drafts(opts)
|
|
1077
1173
|
|
|
1174
|
+
|
|
1175
|
+
|
|
1078
1176
|
Retrieves all action drafts associated with the filters passed in via query param.
|
|
1079
1177
|
|
|
1080
1178
|
|
|
1081
1179
|
|
|
1082
1180
|
Wraps GET /api/v2/integrations/actions/drafts
|
|
1083
1181
|
|
|
1182
|
+
Requires ANY permissions:
|
|
1183
|
+
|
|
1184
|
+
* integrations:action:view* bridge:actions:view
|
|
1185
|
+
|
|
1084
1186
|
|
|
1085
1187
|
### Example
|
|
1086
1188
|
~~~ruby
|
|
@@ -1151,12 +1253,18 @@ Name | Type | Description | Notes
|
|
|
1151
1253
|
|
|
1152
1254
|
## -[**ClientAppEntityListing**](ClientAppEntityListing.html) get_integrations_clientapps(opts)
|
|
1153
1255
|
|
|
1256
|
+
|
|
1257
|
+
|
|
1154
1258
|
List permitted client app integrations for the logged in user
|
|
1155
1259
|
|
|
1156
1260
|
|
|
1157
1261
|
|
|
1158
1262
|
Wraps GET /api/v2/integrations/clientapps
|
|
1159
1263
|
|
|
1264
|
+
Requires NO permissions:
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1160
1268
|
|
|
1161
1269
|
### Example
|
|
1162
1270
|
~~~ruby
|
|
@@ -1221,12 +1329,18 @@ Name | Type | Description | Notes
|
|
|
1221
1329
|
|
|
1222
1330
|
## -[**Credential**](Credential.html) get_integrations_credential(credential_id)
|
|
1223
1331
|
|
|
1332
|
+
|
|
1333
|
+
|
|
1224
1334
|
Get a single credential with sensitive fields redacted
|
|
1225
1335
|
|
|
1226
1336
|
|
|
1227
1337
|
|
|
1228
1338
|
Wraps GET /api/v2/integrations/credentials/{credentialId}
|
|
1229
1339
|
|
|
1340
|
+
Requires NO permissions:
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1230
1344
|
|
|
1231
1345
|
### Example
|
|
1232
1346
|
~~~ruby
|
|
@@ -1280,12 +1394,18 @@ Name | Type | Description | Notes
|
|
|
1280
1394
|
|
|
1281
1395
|
## -[**CredentialInfoListing**](CredentialInfoListing.html) get_integrations_credentials(opts)
|
|
1282
1396
|
|
|
1397
|
+
|
|
1398
|
+
|
|
1283
1399
|
List multiple sets of credentials
|
|
1284
1400
|
|
|
1285
1401
|
|
|
1286
1402
|
|
|
1287
1403
|
Wraps GET /api/v2/integrations/credentials
|
|
1288
1404
|
|
|
1405
|
+
Requires NO permissions:
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1289
1409
|
|
|
1290
1410
|
### Example
|
|
1291
1411
|
~~~ruby
|
|
@@ -1342,12 +1462,18 @@ Name | Type | Description | Notes
|
|
|
1342
1462
|
|
|
1343
1463
|
## -[**CredentialTypeListing**](CredentialTypeListing.html) get_integrations_credentials_types
|
|
1344
1464
|
|
|
1465
|
+
|
|
1466
|
+
|
|
1345
1467
|
List all credential types
|
|
1346
1468
|
|
|
1347
1469
|
|
|
1348
1470
|
|
|
1349
1471
|
Wraps GET /api/v2/integrations/credentials/types
|
|
1350
1472
|
|
|
1473
|
+
Requires NO permissions:
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1351
1477
|
|
|
1352
1478
|
### Example
|
|
1353
1479
|
~~~ruby
|
|
@@ -1395,12 +1521,18 @@ This endpoint does not need any parameter.
|
|
|
1395
1521
|
|
|
1396
1522
|
## -[**IntegrationEventEntityListing**](IntegrationEventEntityListing.html) get_integrations_eventlog(opts)
|
|
1397
1523
|
|
|
1524
|
+
|
|
1525
|
+
|
|
1398
1526
|
List all events
|
|
1399
1527
|
|
|
1400
1528
|
|
|
1401
1529
|
|
|
1402
1530
|
Wraps GET /api/v2/integrations/eventlog
|
|
1403
1531
|
|
|
1532
|
+
Requires ANY permissions:
|
|
1533
|
+
|
|
1534
|
+
* integrations:integration:view* bridge:notification:view
|
|
1535
|
+
|
|
1404
1536
|
|
|
1405
1537
|
### Example
|
|
1406
1538
|
~~~ruby
|
|
@@ -1463,12 +1595,18 @@ Name | Type | Description | Notes
|
|
|
1463
1595
|
|
|
1464
1596
|
## -[**IntegrationEvent**](IntegrationEvent.html) get_integrations_eventlog_event_id(event_id)
|
|
1465
1597
|
|
|
1598
|
+
|
|
1599
|
+
|
|
1466
1600
|
Get a single event
|
|
1467
1601
|
|
|
1468
1602
|
|
|
1469
1603
|
|
|
1470
1604
|
Wraps GET /api/v2/integrations/eventlog/{eventId}
|
|
1471
1605
|
|
|
1606
|
+
Requires ANY permissions:
|
|
1607
|
+
|
|
1608
|
+
* integrations:integration:view* bridge:notification:view
|
|
1609
|
+
|
|
1472
1610
|
|
|
1473
1611
|
### Example
|
|
1474
1612
|
~~~ruby
|
|
@@ -1522,12 +1660,18 @@ Name | Type | Description | Notes
|
|
|
1522
1660
|
|
|
1523
1661
|
## -[**IntegrationType**](IntegrationType.html) get_integrations_type(type_id)
|
|
1524
1662
|
|
|
1663
|
+
|
|
1664
|
+
|
|
1525
1665
|
Get integration type.
|
|
1526
1666
|
|
|
1527
1667
|
|
|
1528
1668
|
|
|
1529
1669
|
Wraps GET /api/v2/integrations/types/{typeId}
|
|
1530
1670
|
|
|
1671
|
+
Requires NO permissions:
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
|
|
1531
1675
|
|
|
1532
1676
|
### Example
|
|
1533
1677
|
~~~ruby
|
|
@@ -1581,12 +1725,18 @@ Name | Type | Description | Notes
|
|
|
1581
1725
|
|
|
1582
1726
|
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_type_configschema(type_id, config_type)
|
|
1583
1727
|
|
|
1728
|
+
|
|
1729
|
+
|
|
1584
1730
|
Get properties config schema for an integration type.
|
|
1585
1731
|
|
|
1586
1732
|
|
|
1587
1733
|
|
|
1588
1734
|
Wraps GET /api/v2/integrations/types/{typeId}/configschemas/{configType}
|
|
1589
1735
|
|
|
1736
|
+
Requires NO permissions:
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1590
1740
|
|
|
1591
1741
|
### Example
|
|
1592
1742
|
~~~ruby
|
|
@@ -1643,12 +1793,18 @@ Name | Type | Description | Notes
|
|
|
1643
1793
|
|
|
1644
1794
|
## -[**IntegrationTypeEntityListing**](IntegrationTypeEntityListing.html) get_integrations_types(opts)
|
|
1645
1795
|
|
|
1796
|
+
|
|
1797
|
+
|
|
1646
1798
|
List integration types
|
|
1647
1799
|
|
|
1648
1800
|
|
|
1649
1801
|
|
|
1650
1802
|
Wraps GET /api/v2/integrations/types
|
|
1651
1803
|
|
|
1804
|
+
Requires NO permissions:
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1652
1808
|
|
|
1653
1809
|
### Example
|
|
1654
1810
|
~~~ruby
|
|
@@ -1713,12 +1869,18 @@ Name | Type | Description | Notes
|
|
|
1713
1869
|
|
|
1714
1870
|
## -[**Integration**](Integration.html) patch_integration(integration_id, opts)
|
|
1715
1871
|
|
|
1872
|
+
|
|
1873
|
+
|
|
1716
1874
|
Update an integration.
|
|
1717
1875
|
|
|
1718
1876
|
|
|
1719
1877
|
|
|
1720
1878
|
Wraps PATCH /api/v2/integrations/{integrationId}
|
|
1721
1879
|
|
|
1880
|
+
Requires NO permissions:
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1722
1884
|
|
|
1723
1885
|
### Example
|
|
1724
1886
|
~~~ruby
|
|
@@ -1788,12 +1950,18 @@ Name | Type | Description | Notes
|
|
|
1788
1950
|
|
|
1789
1951
|
## -[**Action**](Action.html) patch_integrations_action(action_id, body)
|
|
1790
1952
|
|
|
1953
|
+
|
|
1954
|
+
|
|
1791
1955
|
Patch an Action
|
|
1792
1956
|
|
|
1793
1957
|
|
|
1794
1958
|
|
|
1795
1959
|
Wraps PATCH /api/v2/integrations/actions/{actionId}
|
|
1796
1960
|
|
|
1961
|
+
Requires ANY permissions:
|
|
1962
|
+
|
|
1963
|
+
* integrations:action:edit
|
|
1964
|
+
|
|
1797
1965
|
|
|
1798
1966
|
### Example
|
|
1799
1967
|
~~~ruby
|
|
@@ -1850,12 +2018,18 @@ Name | Type | Description | Notes
|
|
|
1850
2018
|
|
|
1851
2019
|
## -[**Action**](Action.html) patch_integrations_action_draft(action_id, body)
|
|
1852
2020
|
|
|
2021
|
+
|
|
2022
|
+
|
|
1853
2023
|
Update an existing Draft
|
|
1854
2024
|
|
|
1855
2025
|
|
|
1856
2026
|
|
|
1857
2027
|
Wraps PATCH /api/v2/integrations/actions/{actionId}/draft
|
|
1858
2028
|
|
|
2029
|
+
Requires ANY permissions:
|
|
2030
|
+
|
|
2031
|
+
* integrations:action:edit
|
|
2032
|
+
|
|
1859
2033
|
|
|
1860
2034
|
### Example
|
|
1861
2035
|
~~~ruby
|
|
@@ -1912,12 +2086,18 @@ Name | Type | Description | Notes
|
|
|
1912
2086
|
|
|
1913
2087
|
## -[**Integration**](Integration.html) post_integrations(opts)
|
|
1914
2088
|
|
|
2089
|
+
|
|
2090
|
+
|
|
1915
2091
|
Create an integration.
|
|
1916
2092
|
|
|
1917
2093
|
|
|
1918
2094
|
|
|
1919
2095
|
Wraps POST /api/v2/integrations
|
|
1920
2096
|
|
|
2097
|
+
Requires NO permissions:
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
1921
2101
|
|
|
1922
2102
|
### Example
|
|
1923
2103
|
~~~ruby
|
|
@@ -1972,12 +2152,18 @@ Name | Type | Description | Notes
|
|
|
1972
2152
|
|
|
1973
2153
|
## -[**Action**](Action.html) post_integrations_action_draft(action_id)
|
|
1974
2154
|
|
|
2155
|
+
|
|
2156
|
+
|
|
1975
2157
|
Create a new Draft from existing Action
|
|
1976
2158
|
|
|
1977
2159
|
|
|
1978
2160
|
|
|
1979
2161
|
Wraps POST /api/v2/integrations/actions/{actionId}/draft
|
|
1980
2162
|
|
|
2163
|
+
Requires ANY permissions:
|
|
2164
|
+
|
|
2165
|
+
* integrations:action:edit
|
|
2166
|
+
|
|
1981
2167
|
|
|
1982
2168
|
### Example
|
|
1983
2169
|
~~~ruby
|
|
@@ -2031,12 +2217,18 @@ Name | Type | Description | Notes
|
|
|
2031
2217
|
|
|
2032
2218
|
## -[**Action**](Action.html) post_integrations_action_draft_publish(action_id, body)
|
|
2033
2219
|
|
|
2220
|
+
|
|
2221
|
+
|
|
2034
2222
|
Publish a Draft and make it the active Action configuration
|
|
2035
2223
|
|
|
2036
2224
|
|
|
2037
2225
|
|
|
2038
2226
|
Wraps POST /api/v2/integrations/actions/{actionId}/draft/publish
|
|
2039
2227
|
|
|
2228
|
+
Requires ANY permissions:
|
|
2229
|
+
|
|
2230
|
+
* integrations:action:edit
|
|
2231
|
+
|
|
2040
2232
|
|
|
2041
2233
|
### Example
|
|
2042
2234
|
~~~ruby
|
|
@@ -2093,12 +2285,18 @@ Name | Type | Description | Notes
|
|
|
2093
2285
|
|
|
2094
2286
|
## -[**TestExecutionResult**](TestExecutionResult.html) post_integrations_action_draft_test(action_id, body)
|
|
2095
2287
|
|
|
2288
|
+
|
|
2289
|
+
|
|
2096
2290
|
Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
2097
2291
|
|
|
2098
2292
|
|
|
2099
2293
|
|
|
2100
2294
|
Wraps POST /api/v2/integrations/actions/{actionId}/draft/test
|
|
2101
2295
|
|
|
2296
|
+
Requires ANY permissions:
|
|
2297
|
+
|
|
2298
|
+
* integrations:action:execute
|
|
2299
|
+
|
|
2102
2300
|
|
|
2103
2301
|
### Example
|
|
2104
2302
|
~~~ruby
|
|
@@ -2155,12 +2353,18 @@ Name | Type | Description | Notes
|
|
|
2155
2353
|
|
|
2156
2354
|
## -Object** post_integrations_action_execute(action_id, body)
|
|
2157
2355
|
|
|
2356
|
+
|
|
2357
|
+
|
|
2158
2358
|
Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
|
2159
2359
|
|
|
2160
2360
|
|
|
2161
2361
|
|
|
2162
2362
|
Wraps POST /api/v2/integrations/actions/{actionId}/execute
|
|
2163
2363
|
|
|
2364
|
+
Requires ANY permissions:
|
|
2365
|
+
|
|
2366
|
+
* integrations:action:execute* bridge:actions:execute
|
|
2367
|
+
|
|
2164
2368
|
|
|
2165
2369
|
### Example
|
|
2166
2370
|
~~~ruby
|
|
@@ -2217,12 +2421,18 @@ Name | Type | Description | Notes
|
|
|
2217
2421
|
|
|
2218
2422
|
## -[**TestExecutionResult**](TestExecutionResult.html) post_integrations_action_test(action_id, body)
|
|
2219
2423
|
|
|
2424
|
+
|
|
2425
|
+
|
|
2220
2426
|
Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
2221
2427
|
|
|
2222
2428
|
|
|
2223
2429
|
|
|
2224
2430
|
Wraps POST /api/v2/integrations/actions/{actionId}/test
|
|
2225
2431
|
|
|
2432
|
+
Requires ANY permissions:
|
|
2433
|
+
|
|
2434
|
+
* integrations:action:execute* bridge:actions:execute
|
|
2435
|
+
|
|
2226
2436
|
|
|
2227
2437
|
### Example
|
|
2228
2438
|
~~~ruby
|
|
@@ -2279,12 +2489,18 @@ Name | Type | Description | Notes
|
|
|
2279
2489
|
|
|
2280
2490
|
## -[**Action**](Action.html) post_integrations_actions(body)
|
|
2281
2491
|
|
|
2492
|
+
|
|
2493
|
+
|
|
2282
2494
|
Create a new Action
|
|
2283
2495
|
|
|
2284
2496
|
|
|
2285
2497
|
|
|
2286
2498
|
Wraps POST /api/v2/integrations/actions
|
|
2287
2499
|
|
|
2500
|
+
Requires ANY permissions:
|
|
2501
|
+
|
|
2502
|
+
* integrations:action:add
|
|
2503
|
+
|
|
2288
2504
|
|
|
2289
2505
|
### Example
|
|
2290
2506
|
~~~ruby
|
|
@@ -2338,12 +2554,18 @@ Name | Type | Description | Notes
|
|
|
2338
2554
|
|
|
2339
2555
|
## -[**Action**](Action.html) post_integrations_actions_drafts(body)
|
|
2340
2556
|
|
|
2557
|
+
|
|
2558
|
+
|
|
2341
2559
|
Create a new Draft
|
|
2342
2560
|
|
|
2343
2561
|
|
|
2344
2562
|
|
|
2345
2563
|
Wraps POST /api/v2/integrations/actions/drafts
|
|
2346
2564
|
|
|
2565
|
+
Requires ANY permissions:
|
|
2566
|
+
|
|
2567
|
+
* integrations:action:add
|
|
2568
|
+
|
|
2347
2569
|
|
|
2348
2570
|
### Example
|
|
2349
2571
|
~~~ruby
|
|
@@ -2397,12 +2619,18 @@ Name | Type | Description | Notes
|
|
|
2397
2619
|
|
|
2398
2620
|
## -[**CredentialInfo**](CredentialInfo.html) post_integrations_credentials(opts)
|
|
2399
2621
|
|
|
2622
|
+
|
|
2623
|
+
|
|
2400
2624
|
Create a set of credentials
|
|
2401
2625
|
|
|
2402
2626
|
|
|
2403
2627
|
|
|
2404
2628
|
Wraps POST /api/v2/integrations/credentials
|
|
2405
2629
|
|
|
2630
|
+
Requires NO permissions:
|
|
2631
|
+
|
|
2632
|
+
|
|
2633
|
+
|
|
2406
2634
|
|
|
2407
2635
|
### Example
|
|
2408
2636
|
~~~ruby
|
|
@@ -2457,12 +2685,18 @@ Name | Type | Description | Notes
|
|
|
2457
2685
|
|
|
2458
2686
|
## -[**UserActionCategoryEntityListing**](UserActionCategoryEntityListing.html) post_integrations_workforcemanagement_vendorconnection(opts)
|
|
2459
2687
|
|
|
2688
|
+
|
|
2689
|
+
|
|
2460
2690
|
Add a vendor connection
|
|
2461
2691
|
|
|
2462
2692
|
|
|
2463
2693
|
|
|
2464
2694
|
Wraps POST /api/v2/integrations/workforcemanagement/vendorconnection
|
|
2465
2695
|
|
|
2696
|
+
Requires NO permissions:
|
|
2697
|
+
|
|
2698
|
+
|
|
2699
|
+
|
|
2466
2700
|
|
|
2467
2701
|
### Example
|
|
2468
2702
|
~~~ruby
|
|
@@ -2517,12 +2751,18 @@ Name | Type | Description | Notes
|
|
|
2517
2751
|
|
|
2518
2752
|
## -[**IntegrationConfiguration**](IntegrationConfiguration.html) put_integration_config_current(integration_id, opts)
|
|
2519
2753
|
|
|
2754
|
+
|
|
2755
|
+
|
|
2520
2756
|
Update integration configuration.
|
|
2521
2757
|
|
|
2522
2758
|
|
|
2523
2759
|
|
|
2524
2760
|
Wraps PUT /api/v2/integrations/{integrationId}/config/current
|
|
2525
2761
|
|
|
2762
|
+
Requires NO permissions:
|
|
2763
|
+
|
|
2764
|
+
|
|
2765
|
+
|
|
2526
2766
|
|
|
2527
2767
|
### Example
|
|
2528
2768
|
~~~ruby
|
|
@@ -2580,12 +2820,18 @@ Name | Type | Description | Notes
|
|
|
2580
2820
|
|
|
2581
2821
|
## -[**CredentialInfo**](CredentialInfo.html) put_integrations_credential(credential_id, opts)
|
|
2582
2822
|
|
|
2823
|
+
|
|
2824
|
+
|
|
2583
2825
|
Update a set of credentials
|
|
2584
2826
|
|
|
2585
2827
|
|
|
2586
2828
|
|
|
2587
2829
|
Wraps PUT /api/v2/integrations/credentials/{credentialId}
|
|
2588
2830
|
|
|
2831
|
+
Requires NO permissions:
|
|
2832
|
+
|
|
2833
|
+
|
|
2834
|
+
|
|
2589
2835
|
|
|
2590
2836
|
### Example
|
|
2591
2837
|
~~~ruby
|