purecloudplatformclientv2 34.0.0 → 35.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/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
data/docs/ArchitectApi.md
CHANGED
@@ -95,12 +95,18 @@ Method | Description
|
|
95
95
|
|
96
96
|
## - delete_architect_emergencygroup(emergency_group_id)
|
97
97
|
|
98
|
+
|
99
|
+
|
98
100
|
Deletes a emergency group by ID
|
99
101
|
|
100
102
|
|
101
103
|
|
102
104
|
Wraps DELETE /api/v2/architect/emergencygroups/{emergencyGroupId}
|
103
105
|
|
106
|
+
Requires ANY permissions:
|
107
|
+
|
108
|
+
* telephony:plugin:all
|
109
|
+
|
104
110
|
|
105
111
|
### Example
|
106
112
|
~~~ruby
|
@@ -153,12 +159,18 @@ nil (empty response body)
|
|
153
159
|
|
154
160
|
## - delete_architect_ivr(ivr_id)
|
155
161
|
|
162
|
+
|
163
|
+
|
156
164
|
Delete an IVR Config.
|
157
165
|
|
158
166
|
|
159
167
|
|
160
168
|
Wraps DELETE /api/v2/architect/ivrs/{ivrId}
|
161
169
|
|
170
|
+
Requires ANY permissions:
|
171
|
+
|
172
|
+
* telephony:plugin:all
|
173
|
+
|
162
174
|
|
163
175
|
### Example
|
164
176
|
~~~ruby
|
@@ -211,12 +223,18 @@ nil (empty response body)
|
|
211
223
|
|
212
224
|
## - delete_architect_prompt(prompt_id, opts)
|
213
225
|
|
226
|
+
|
227
|
+
|
214
228
|
Delete specified user prompt
|
215
229
|
|
216
230
|
|
217
231
|
|
218
232
|
Wraps DELETE /api/v2/architect/prompts/{promptId}
|
219
233
|
|
234
|
+
Requires ANY permissions:
|
235
|
+
|
236
|
+
* architect:user:admin* architect:user:editor
|
237
|
+
|
220
238
|
|
221
239
|
### Example
|
222
240
|
~~~ruby
|
@@ -273,12 +291,18 @@ nil (empty response body)
|
|
273
291
|
|
274
292
|
## - delete_architect_prompt_resource(prompt_id, language_code)
|
275
293
|
|
294
|
+
|
295
|
+
|
276
296
|
Delete specified user prompt resource
|
277
297
|
|
278
298
|
|
279
299
|
|
280
300
|
Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
281
301
|
|
302
|
+
Requires ANY permissions:
|
303
|
+
|
304
|
+
* architect:user:admin* architect:user:editor
|
305
|
+
|
282
306
|
|
283
307
|
### Example
|
284
308
|
~~~ruby
|
@@ -334,12 +358,18 @@ nil (empty response body)
|
|
334
358
|
|
335
359
|
## -[**Operation**](Operation.html) delete_architect_prompts(id)
|
336
360
|
|
361
|
+
|
362
|
+
|
337
363
|
Batch-delete a list of prompts
|
338
364
|
|
339
365
|
Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}
|
340
366
|
|
341
367
|
Wraps DELETE /api/v2/architect/prompts
|
342
368
|
|
369
|
+
Requires ANY permissions:
|
370
|
+
|
371
|
+
* architect:user:admin* architect:user:editor
|
372
|
+
|
343
373
|
|
344
374
|
### Example
|
345
375
|
~~~ruby
|
@@ -393,12 +423,18 @@ Name | Type | Description | Notes
|
|
393
423
|
|
394
424
|
## - delete_architect_schedule(schedule_id)
|
395
425
|
|
426
|
+
|
427
|
+
|
396
428
|
Delete a schedule by id
|
397
429
|
|
398
430
|
|
399
431
|
|
400
432
|
Wraps DELETE /api/v2/architect/schedules/{scheduleId}
|
401
433
|
|
434
|
+
Requires ANY permissions:
|
435
|
+
|
436
|
+
* telephony:plugin:all
|
437
|
+
|
402
438
|
|
403
439
|
### Example
|
404
440
|
~~~ruby
|
@@ -451,12 +487,18 @@ nil (empty response body)
|
|
451
487
|
|
452
488
|
## - delete_architect_schedulegroup(schedule_group_id)
|
453
489
|
|
490
|
+
|
491
|
+
|
454
492
|
Deletes a schedule group by ID
|
455
493
|
|
456
494
|
|
457
495
|
|
458
496
|
Wraps DELETE /api/v2/architect/schedulegroups/{scheduleGroupId}
|
459
497
|
|
498
|
+
Requires ANY permissions:
|
499
|
+
|
500
|
+
* telephony:plugin:all
|
501
|
+
|
460
502
|
|
461
503
|
### Example
|
462
504
|
~~~ruby
|
@@ -509,12 +551,18 @@ nil (empty response body)
|
|
509
551
|
|
510
552
|
## - delete_architect_systemprompt_resource(prompt_id, language_code)
|
511
553
|
|
554
|
+
|
555
|
+
|
512
556
|
Delete a system prompt resource override.
|
513
557
|
|
514
558
|
|
515
559
|
|
516
560
|
Wraps DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
517
561
|
|
562
|
+
Requires ANY permissions:
|
563
|
+
|
564
|
+
* architect:user:admin* architect:user:editor
|
565
|
+
|
518
566
|
|
519
567
|
### Example
|
520
568
|
~~~ruby
|
@@ -570,12 +618,18 @@ nil (empty response body)
|
|
570
618
|
|
571
619
|
## - delete_flow(flow_id)
|
572
620
|
|
621
|
+
|
622
|
+
|
573
623
|
Delete flow
|
574
624
|
|
575
625
|
|
576
626
|
|
577
627
|
Wraps DELETE /api/v2/flows/{flowId}
|
578
628
|
|
629
|
+
Requires ANY permissions:
|
630
|
+
|
631
|
+
* architect:user:admin* architect:user:editor
|
632
|
+
|
579
633
|
|
580
634
|
### Example
|
581
635
|
~~~ruby
|
@@ -628,12 +682,18 @@ nil (empty response body)
|
|
628
682
|
|
629
683
|
## -[**Operation**](Operation.html) delete_flows(id)
|
630
684
|
|
685
|
+
|
686
|
+
|
631
687
|
Batch-delete a list of flows
|
632
688
|
|
633
689
|
Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}
|
634
690
|
|
635
691
|
Wraps DELETE /api/v2/flows
|
636
692
|
|
693
|
+
Requires ANY permissions:
|
694
|
+
|
695
|
+
* architect:user:admin* architect:user:editor
|
696
|
+
|
637
697
|
|
638
698
|
### Example
|
639
699
|
~~~ruby
|
@@ -687,12 +747,18 @@ Name | Type | Description | Notes
|
|
687
747
|
|
688
748
|
## - delete_flows_datatable(datatable_id, opts)
|
689
749
|
|
750
|
+
|
751
|
+
|
690
752
|
deletes a specific datatable by id
|
691
753
|
|
692
754
|
deletes an entire datatable (including schema and data) with a given id)
|
693
755
|
|
694
756
|
Wraps DELETE /api/v2/flows/datatables/{datatableId}
|
695
757
|
|
758
|
+
Requires ANY permissions:
|
759
|
+
|
760
|
+
* architect:datatable:delete
|
761
|
+
|
696
762
|
|
697
763
|
### Example
|
698
764
|
~~~ruby
|
@@ -749,12 +815,18 @@ nil (empty response body)
|
|
749
815
|
|
750
816
|
## - delete_flows_datatable_row(datatable_id, row_id)
|
751
817
|
|
818
|
+
|
819
|
+
|
752
820
|
Delete a row entry
|
753
821
|
|
754
822
|
Deletes a row with a given rowId.
|
755
823
|
|
756
824
|
Wraps DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
757
825
|
|
826
|
+
Requires ANY permissions:
|
827
|
+
|
828
|
+
* architect:datatable:delete
|
829
|
+
|
758
830
|
|
759
831
|
### Example
|
760
832
|
~~~ruby
|
@@ -810,12 +882,18 @@ nil (empty response body)
|
|
810
882
|
|
811
883
|
## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking(name, opts)
|
812
884
|
|
885
|
+
|
886
|
+
|
813
887
|
Get Dependency Tracking objects that have a given display name
|
814
888
|
|
815
889
|
|
816
890
|
|
817
891
|
Wraps GET /api/v2/architect/dependencytracking
|
818
892
|
|
893
|
+
Requires ANY permissions:
|
894
|
+
|
895
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
896
|
+
|
819
897
|
|
820
898
|
### Example
|
821
899
|
~~~ruby
|
@@ -885,12 +963,18 @@ Name | Type | Description | Notes
|
|
885
963
|
|
886
964
|
## -[**DependencyStatus**](DependencyStatus.html) get_architect_dependencytracking_build
|
887
965
|
|
966
|
+
|
967
|
+
|
888
968
|
Get Dependency Tracking build status for an organization
|
889
969
|
|
890
970
|
|
891
971
|
|
892
972
|
Wraps GET /api/v2/architect/dependencytracking/build
|
893
973
|
|
974
|
+
Requires ANY permissions:
|
975
|
+
|
976
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
977
|
+
|
894
978
|
|
895
979
|
### Example
|
896
980
|
~~~ruby
|
@@ -938,12 +1022,18 @@ This endpoint does not need any parameter.
|
|
938
1022
|
|
939
1023
|
## -[**ConsumedResourcesEntityListing**](ConsumedResourcesEntityListing.html) get_architect_dependencytracking_consumedresources(id, version, object_type, opts)
|
940
1024
|
|
1025
|
+
|
1026
|
+
|
941
1027
|
Get resources that are consumed by a given Dependency Tracking object
|
942
1028
|
|
943
1029
|
|
944
1030
|
|
945
1031
|
Wraps GET /api/v2/architect/dependencytracking/consumedresources
|
946
1032
|
|
1033
|
+
Requires ANY permissions:
|
1034
|
+
|
1035
|
+
* admin* editor* readonly
|
1036
|
+
|
947
1037
|
|
948
1038
|
### Example
|
949
1039
|
~~~ruby
|
@@ -1007,12 +1097,18 @@ Name | Type | Description | Notes
|
|
1007
1097
|
|
1008
1098
|
## -[**ConsumingResourcesEntityListing**](ConsumingResourcesEntityListing.html) get_architect_dependencytracking_consumingresources(id, object_type, opts)
|
1009
1099
|
|
1100
|
+
|
1101
|
+
|
1010
1102
|
Get resources that consume a given Dependency Tracking object
|
1011
1103
|
|
1012
1104
|
|
1013
1105
|
|
1014
1106
|
Wraps GET /api/v2/architect/dependencytracking/consumingresources
|
1015
1107
|
|
1108
|
+
Requires ANY permissions:
|
1109
|
+
|
1110
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1111
|
+
|
1016
1112
|
|
1017
1113
|
### Example
|
1018
1114
|
~~~ruby
|
@@ -1073,12 +1169,18 @@ Name | Type | Description | Notes
|
|
1073
1169
|
|
1074
1170
|
## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_deletedresourceconsumers(opts)
|
1075
1171
|
|
1172
|
+
|
1173
|
+
|
1076
1174
|
Get Dependency Tracking objects that consume deleted resources
|
1077
1175
|
|
1078
1176
|
|
1079
1177
|
|
1080
1178
|
Wraps GET /api/v2/architect/dependencytracking/deletedresourceconsumers
|
1081
1179
|
|
1180
|
+
Requires ANY permissions:
|
1181
|
+
|
1182
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1183
|
+
|
1082
1184
|
|
1083
1185
|
### Example
|
1084
1186
|
~~~ruby
|
@@ -1145,12 +1247,18 @@ Name | Type | Description | Notes
|
|
1145
1247
|
|
1146
1248
|
## -[**DependencyObject**](DependencyObject.html) get_architect_dependencytracking_object(id, opts)
|
1147
1249
|
|
1250
|
+
|
1251
|
+
|
1148
1252
|
Get a Dependency Tracking object
|
1149
1253
|
|
1150
1254
|
|
1151
1255
|
|
1152
1256
|
Wraps GET /api/v2/architect/dependencytracking/object
|
1153
1257
|
|
1258
|
+
Requires ANY permissions:
|
1259
|
+
|
1260
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1261
|
+
|
1154
1262
|
|
1155
1263
|
### Example
|
1156
1264
|
~~~ruby
|
@@ -1218,12 +1326,18 @@ Name | Type | Description | Notes
|
|
1218
1326
|
|
1219
1327
|
## -[**DependencyType**](DependencyType.html) get_architect_dependencytracking_type(type_id)
|
1220
1328
|
|
1329
|
+
|
1330
|
+
|
1221
1331
|
Get a Dependency Tracking type.
|
1222
1332
|
|
1223
1333
|
|
1224
1334
|
|
1225
1335
|
Wraps GET /api/v2/architect/dependencytracking/types/{typeId}
|
1226
1336
|
|
1337
|
+
Requires ANY permissions:
|
1338
|
+
|
1339
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1340
|
+
|
1227
1341
|
|
1228
1342
|
### Example
|
1229
1343
|
~~~ruby
|
@@ -1277,12 +1391,18 @@ Name | Type | Description | Notes
|
|
1277
1391
|
|
1278
1392
|
## -[**DependencyTypeEntityListing**](DependencyTypeEntityListing.html) get_architect_dependencytracking_types(opts)
|
1279
1393
|
|
1394
|
+
|
1395
|
+
|
1280
1396
|
Get Dependency Tracking types.
|
1281
1397
|
|
1282
1398
|
|
1283
1399
|
|
1284
1400
|
Wraps GET /api/v2/architect/dependencytracking/types
|
1285
1401
|
|
1402
|
+
Requires ANY permissions:
|
1403
|
+
|
1404
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1405
|
+
|
1286
1406
|
|
1287
1407
|
### Example
|
1288
1408
|
~~~ruby
|
@@ -1339,12 +1459,18 @@ Name | Type | Description | Notes
|
|
1339
1459
|
|
1340
1460
|
## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_updatedresourceconsumers(opts)
|
1341
1461
|
|
1462
|
+
|
1463
|
+
|
1342
1464
|
Get Dependency Tracking objects that depend on updated resources
|
1343
1465
|
|
1344
1466
|
|
1345
1467
|
|
1346
1468
|
Wraps GET /api/v2/architect/dependencytracking/updatedresourceconsumers
|
1347
1469
|
|
1470
|
+
Requires ANY permissions:
|
1471
|
+
|
1472
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1473
|
+
|
1348
1474
|
|
1349
1475
|
### Example
|
1350
1476
|
~~~ruby
|
@@ -1409,12 +1535,18 @@ Name | Type | Description | Notes
|
|
1409
1535
|
|
1410
1536
|
## -[**EmergencyGroup**](EmergencyGroup.html) get_architect_emergencygroup(emergency_group_id)
|
1411
1537
|
|
1538
|
+
|
1539
|
+
|
1412
1540
|
Gets a emergency group by ID
|
1413
1541
|
|
1414
1542
|
|
1415
1543
|
|
1416
1544
|
Wraps GET /api/v2/architect/emergencygroups/{emergencyGroupId}
|
1417
1545
|
|
1546
|
+
Requires ANY permissions:
|
1547
|
+
|
1548
|
+
* telephony:plugin:all
|
1549
|
+
|
1418
1550
|
|
1419
1551
|
### Example
|
1420
1552
|
~~~ruby
|
@@ -1468,12 +1600,18 @@ Name | Type | Description | Notes
|
|
1468
1600
|
|
1469
1601
|
## -[**EmergencyGroupListing**](EmergencyGroupListing.html) get_architect_emergencygroups(opts)
|
1470
1602
|
|
1603
|
+
|
1604
|
+
|
1471
1605
|
Get a list of emergency groups.
|
1472
1606
|
|
1473
1607
|
|
1474
1608
|
|
1475
1609
|
Wraps GET /api/v2/architect/emergencygroups
|
1476
1610
|
|
1611
|
+
Requires ANY permissions:
|
1612
|
+
|
1613
|
+
* telephony:plugin:all
|
1614
|
+
|
1477
1615
|
|
1478
1616
|
### Example
|
1479
1617
|
~~~ruby
|
@@ -1536,12 +1674,18 @@ Name | Type | Description | Notes
|
|
1536
1674
|
|
1537
1675
|
## -[**IVR**](IVR.html) get_architect_ivr(ivr_id)
|
1538
1676
|
|
1677
|
+
|
1678
|
+
|
1539
1679
|
Get an IVR config.
|
1540
1680
|
|
1541
1681
|
|
1542
1682
|
|
1543
1683
|
Wraps GET /api/v2/architect/ivrs/{ivrId}
|
1544
1684
|
|
1685
|
+
Requires ANY permissions:
|
1686
|
+
|
1687
|
+
* telephony:plugin:all
|
1688
|
+
|
1545
1689
|
|
1546
1690
|
### Example
|
1547
1691
|
~~~ruby
|
@@ -1595,12 +1739,18 @@ Name | Type | Description | Notes
|
|
1595
1739
|
|
1596
1740
|
## -[**IVREntityListing**](IVREntityListing.html) get_architect_ivrs(opts)
|
1597
1741
|
|
1742
|
+
|
1743
|
+
|
1598
1744
|
Get IVR configs.
|
1599
1745
|
|
1600
1746
|
|
1601
1747
|
|
1602
1748
|
Wraps GET /api/v2/architect/ivrs
|
1603
1749
|
|
1750
|
+
Requires ANY permissions:
|
1751
|
+
|
1752
|
+
* telephony:plugin:all
|
1753
|
+
|
1604
1754
|
|
1605
1755
|
### Example
|
1606
1756
|
~~~ruby
|
@@ -1663,12 +1813,18 @@ Name | Type | Description | Notes
|
|
1663
1813
|
|
1664
1814
|
## -[**Prompt**](Prompt.html) get_architect_prompt(prompt_id)
|
1665
1815
|
|
1816
|
+
|
1817
|
+
|
1666
1818
|
Get specified user prompt
|
1667
1819
|
|
1668
1820
|
|
1669
1821
|
|
1670
1822
|
Wraps GET /api/v2/architect/prompts/{promptId}
|
1671
1823
|
|
1824
|
+
Requires ANY permissions:
|
1825
|
+
|
1826
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1827
|
+
|
1672
1828
|
|
1673
1829
|
### Example
|
1674
1830
|
~~~ruby
|
@@ -1722,12 +1878,18 @@ Name | Type | Description | Notes
|
|
1722
1878
|
|
1723
1879
|
## -[**HistoryListing**](HistoryListing.html) get_architect_prompt_history_history_id(prompt_id, history_id, opts)
|
1724
1880
|
|
1881
|
+
|
1882
|
+
|
1725
1883
|
Get generated prompt history
|
1726
1884
|
|
1727
1885
|
|
1728
1886
|
|
1729
1887
|
Wraps GET /api/v2/architect/prompts/{promptId}/history/{historyId}
|
1730
1888
|
|
1889
|
+
Requires ANY permissions:
|
1890
|
+
|
1891
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1892
|
+
|
1731
1893
|
|
1732
1894
|
### Example
|
1733
1895
|
~~~ruby
|
@@ -1796,12 +1958,18 @@ Name | Type | Description | Notes
|
|
1796
1958
|
|
1797
1959
|
## -[**PromptAsset**](PromptAsset.html) get_architect_prompt_resource(prompt_id, language_code)
|
1798
1960
|
|
1961
|
+
|
1962
|
+
|
1799
1963
|
Get specified user prompt resource
|
1800
1964
|
|
1801
1965
|
|
1802
1966
|
|
1803
1967
|
Wraps GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
1804
1968
|
|
1969
|
+
Requires ANY permissions:
|
1970
|
+
|
1971
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
1972
|
+
|
1805
1973
|
|
1806
1974
|
### Example
|
1807
1975
|
~~~ruby
|
@@ -1858,12 +2026,18 @@ Name | Type | Description | Notes
|
|
1858
2026
|
|
1859
2027
|
## -[**PromptAssetEntityListing**](PromptAssetEntityListing.html) get_architect_prompt_resources(prompt_id, opts)
|
1860
2028
|
|
2029
|
+
|
2030
|
+
|
1861
2031
|
Get a pageable list of user prompt resources
|
1862
2032
|
|
1863
2033
|
The returned list is pageable, and query parameters can be used for filtering.
|
1864
2034
|
|
1865
2035
|
Wraps GET /api/v2/architect/prompts/{promptId}/resources
|
1866
2036
|
|
2037
|
+
Requires ANY permissions:
|
2038
|
+
|
2039
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2040
|
+
|
1867
2041
|
|
1868
2042
|
### Example
|
1869
2043
|
~~~ruby
|
@@ -1923,12 +2097,18 @@ Name | Type | Description | Notes
|
|
1923
2097
|
|
1924
2098
|
## -[**PromptEntityListing**](PromptEntityListing.html) get_architect_prompts(opts)
|
1925
2099
|
|
2100
|
+
|
2101
|
+
|
1926
2102
|
Get a pageable list of user prompts
|
1927
2103
|
|
1928
2104
|
The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.
|
1929
2105
|
|
1930
2106
|
Wraps GET /api/v2/architect/prompts
|
1931
2107
|
|
2108
|
+
Requires ANY permissions:
|
2109
|
+
|
2110
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2111
|
+
|
1932
2112
|
|
1933
2113
|
### Example
|
1934
2114
|
~~~ruby
|
@@ -1995,12 +2175,18 @@ Name | Type | Description | Notes
|
|
1995
2175
|
|
1996
2176
|
## -[**Schedule**](Schedule.html) get_architect_schedule(schedule_id)
|
1997
2177
|
|
2178
|
+
|
2179
|
+
|
1998
2180
|
Get a schedule by ID
|
1999
2181
|
|
2000
2182
|
|
2001
2183
|
|
2002
2184
|
Wraps GET /api/v2/architect/schedules/{scheduleId}
|
2003
2185
|
|
2186
|
+
Requires ANY permissions:
|
2187
|
+
|
2188
|
+
* telephony:plugin:all
|
2189
|
+
|
2004
2190
|
|
2005
2191
|
### Example
|
2006
2192
|
~~~ruby
|
@@ -2054,12 +2240,18 @@ Name | Type | Description | Notes
|
|
2054
2240
|
|
2055
2241
|
## -[**ScheduleGroup**](ScheduleGroup.html) get_architect_schedulegroup(schedule_group_id)
|
2056
2242
|
|
2243
|
+
|
2244
|
+
|
2057
2245
|
Gets a schedule group by ID
|
2058
2246
|
|
2059
2247
|
|
2060
2248
|
|
2061
2249
|
Wraps GET /api/v2/architect/schedulegroups/{scheduleGroupId}
|
2062
2250
|
|
2251
|
+
Requires ANY permissions:
|
2252
|
+
|
2253
|
+
* telephony:plugin:all
|
2254
|
+
|
2063
2255
|
|
2064
2256
|
### Example
|
2065
2257
|
~~~ruby
|
@@ -2113,12 +2305,18 @@ Name | Type | Description | Notes
|
|
2113
2305
|
|
2114
2306
|
## -[**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html) get_architect_schedulegroups(opts)
|
2115
2307
|
|
2308
|
+
|
2309
|
+
|
2116
2310
|
Get a list of schedule groups.
|
2117
2311
|
|
2118
2312
|
|
2119
2313
|
|
2120
2314
|
Wraps GET /api/v2/architect/schedulegroups
|
2121
2315
|
|
2316
|
+
Requires ANY permissions:
|
2317
|
+
|
2318
|
+
* telephony:plugin:all
|
2319
|
+
|
2122
2320
|
|
2123
2321
|
### Example
|
2124
2322
|
~~~ruby
|
@@ -2181,12 +2379,18 @@ Name | Type | Description | Notes
|
|
2181
2379
|
|
2182
2380
|
## -[**ScheduleEntityListing**](ScheduleEntityListing.html) get_architect_schedules(opts)
|
2183
2381
|
|
2382
|
+
|
2383
|
+
|
2184
2384
|
Get a list of schedules.
|
2185
2385
|
|
2186
2386
|
|
2187
2387
|
|
2188
2388
|
Wraps GET /api/v2/architect/schedules
|
2189
2389
|
|
2390
|
+
Requires ANY permissions:
|
2391
|
+
|
2392
|
+
* telephony:plugin:all
|
2393
|
+
|
2190
2394
|
|
2191
2395
|
### Example
|
2192
2396
|
~~~ruby
|
@@ -2249,12 +2453,18 @@ Name | Type | Description | Notes
|
|
2249
2453
|
|
2250
2454
|
## -[**SystemPrompt**](SystemPrompt.html) get_architect_systemprompt(prompt_id)
|
2251
2455
|
|
2456
|
+
|
2457
|
+
|
2252
2458
|
Get a system prompt
|
2253
2459
|
|
2254
2460
|
|
2255
2461
|
|
2256
2462
|
Wraps GET /api/v2/architect/systemprompts/{promptId}
|
2257
2463
|
|
2464
|
+
Requires ANY permissions:
|
2465
|
+
|
2466
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2467
|
+
|
2258
2468
|
|
2259
2469
|
### Example
|
2260
2470
|
~~~ruby
|
@@ -2308,12 +2518,18 @@ Name | Type | Description | Notes
|
|
2308
2518
|
|
2309
2519
|
## -[**HistoryListing**](HistoryListing.html) get_architect_systemprompt_history_history_id(prompt_id, history_id, opts)
|
2310
2520
|
|
2521
|
+
|
2522
|
+
|
2311
2523
|
Get generated prompt history
|
2312
2524
|
|
2313
2525
|
|
2314
2526
|
|
2315
2527
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}
|
2316
2528
|
|
2529
|
+
Requires ANY permissions:
|
2530
|
+
|
2531
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2532
|
+
|
2317
2533
|
|
2318
2534
|
### Example
|
2319
2535
|
~~~ruby
|
@@ -2382,12 +2598,18 @@ Name | Type | Description | Notes
|
|
2382
2598
|
|
2383
2599
|
## -[**SystemPromptAsset**](SystemPromptAsset.html) get_architect_systemprompt_resource(prompt_id, language_code)
|
2384
2600
|
|
2601
|
+
|
2602
|
+
|
2385
2603
|
Get a system prompt resource.
|
2386
2604
|
|
2387
2605
|
|
2388
2606
|
|
2389
2607
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
2390
2608
|
|
2609
|
+
Requires ANY permissions:
|
2610
|
+
|
2611
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2612
|
+
|
2391
2613
|
|
2392
2614
|
### Example
|
2393
2615
|
~~~ruby
|
@@ -2444,12 +2666,18 @@ Name | Type | Description | Notes
|
|
2444
2666
|
|
2445
2667
|
## -[**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html) get_architect_systemprompt_resources(prompt_id, opts)
|
2446
2668
|
|
2669
|
+
|
2670
|
+
|
2447
2671
|
Get system prompt resources.
|
2448
2672
|
|
2449
2673
|
|
2450
2674
|
|
2451
2675
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/resources
|
2452
2676
|
|
2677
|
+
Requires ANY permissions:
|
2678
|
+
|
2679
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2680
|
+
|
2453
2681
|
|
2454
2682
|
### Example
|
2455
2683
|
~~~ruby
|
@@ -2513,12 +2741,18 @@ Name | Type | Description | Notes
|
|
2513
2741
|
|
2514
2742
|
## -[**SystemPromptEntityListing**](SystemPromptEntityListing.html) get_architect_systemprompts(opts)
|
2515
2743
|
|
2744
|
+
|
2745
|
+
|
2516
2746
|
Get System Prompts
|
2517
2747
|
|
2518
2748
|
|
2519
2749
|
|
2520
2750
|
Wraps GET /api/v2/architect/systemprompts
|
2521
2751
|
|
2752
|
+
Requires ANY permissions:
|
2753
|
+
|
2754
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2755
|
+
|
2522
2756
|
|
2523
2757
|
### Example
|
2524
2758
|
~~~ruby
|
@@ -2585,12 +2819,18 @@ Name | Type | Description | Notes
|
|
2585
2819
|
|
2586
2820
|
## -[**Flow**](Flow.html) get_flow(flow_id, opts)
|
2587
2821
|
|
2822
|
+
|
2823
|
+
|
2588
2824
|
Get flow
|
2589
2825
|
|
2590
2826
|
|
2591
2827
|
|
2592
2828
|
Wraps GET /api/v2/flows/{flowId}
|
2593
2829
|
|
2830
|
+
Requires ANY permissions:
|
2831
|
+
|
2832
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2833
|
+
|
2594
2834
|
|
2595
2835
|
### Example
|
2596
2836
|
~~~ruby
|
@@ -2648,12 +2888,18 @@ Name | Type | Description | Notes
|
|
2648
2888
|
|
2649
2889
|
## -[**HistoryListing**](HistoryListing.html) get_flow_history_history_id(flow_id, history_id, opts)
|
2650
2890
|
|
2891
|
+
|
2892
|
+
|
2651
2893
|
Get generated flow history
|
2652
2894
|
|
2653
2895
|
|
2654
2896
|
|
2655
2897
|
Wraps GET /api/v2/flows/{flowId}/history/{historyId}
|
2656
2898
|
|
2899
|
+
Requires ANY permissions:
|
2900
|
+
|
2901
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2902
|
+
|
2657
2903
|
|
2658
2904
|
### Example
|
2659
2905
|
~~~ruby
|
@@ -2722,12 +2968,18 @@ Name | Type | Description | Notes
|
|
2722
2968
|
|
2723
2969
|
## -Object** get_flow_latestconfiguration(flow_id, opts)
|
2724
2970
|
|
2971
|
+
|
2972
|
+
|
2725
2973
|
Get the latest configuration for flow
|
2726
2974
|
|
2727
2975
|
|
2728
2976
|
|
2729
2977
|
Wraps GET /api/v2/flows/{flowId}/latestconfiguration
|
2730
2978
|
|
2979
|
+
Requires ANY permissions:
|
2980
|
+
|
2981
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
2982
|
+
|
2731
2983
|
|
2732
2984
|
### Example
|
2733
2985
|
~~~ruby
|
@@ -2785,12 +3037,18 @@ Name | Type | Description | Notes
|
|
2785
3037
|
|
2786
3038
|
## -[**FlowVersion**](FlowVersion.html) get_flow_version(flow_id, version_id, opts)
|
2787
3039
|
|
3040
|
+
|
3041
|
+
|
2788
3042
|
Get flow version
|
2789
3043
|
|
2790
3044
|
|
2791
3045
|
|
2792
3046
|
Wraps GET /api/v2/flows/{flowId}/versions/{versionId}
|
2793
3047
|
|
3048
|
+
Requires ANY permissions:
|
3049
|
+
|
3050
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
3051
|
+
|
2794
3052
|
|
2795
3053
|
### Example
|
2796
3054
|
~~~ruby
|
@@ -2851,12 +3109,18 @@ Name | Type | Description | Notes
|
|
2851
3109
|
|
2852
3110
|
## -Object** get_flow_version_configuration(flow_id, version_id, opts)
|
2853
3111
|
|
3112
|
+
|
3113
|
+
|
2854
3114
|
Create flow version configuration
|
2855
3115
|
|
2856
3116
|
|
2857
3117
|
|
2858
3118
|
Wraps GET /api/v2/flows/{flowId}/versions/{versionId}/configuration
|
2859
3119
|
|
3120
|
+
Requires ANY permissions:
|
3121
|
+
|
3122
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
3123
|
+
|
2860
3124
|
|
2861
3125
|
### Example
|
2862
3126
|
~~~ruby
|
@@ -2917,12 +3181,18 @@ Name | Type | Description | Notes
|
|
2917
3181
|
|
2918
3182
|
## -[**FlowVersionEntityListing**](FlowVersionEntityListing.html) get_flow_versions(flow_id, opts)
|
2919
3183
|
|
3184
|
+
|
3185
|
+
|
2920
3186
|
Get flow version list
|
2921
3187
|
|
2922
3188
|
|
2923
3189
|
|
2924
3190
|
Wraps GET /api/v2/flows/{flowId}/versions
|
2925
3191
|
|
3192
|
+
Requires ANY permissions:
|
3193
|
+
|
3194
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
3195
|
+
|
2926
3196
|
|
2927
3197
|
### Example
|
2928
3198
|
~~~ruby
|
@@ -2984,12 +3254,18 @@ Name | Type | Description | Notes
|
|
2984
3254
|
|
2985
3255
|
## -[**FlowEntityListing**](FlowEntityListing.html) get_flows(type, opts)
|
2986
3256
|
|
3257
|
+
|
3258
|
+
|
2987
3259
|
Get a pageable list of flows, filtered by query parameters
|
2988
3260
|
|
2989
3261
|
Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
|
2990
3262
|
|
2991
3263
|
Wraps GET /api/v2/flows
|
2992
3264
|
|
3265
|
+
Requires ANY permissions:
|
3266
|
+
|
3267
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
3268
|
+
|
2993
3269
|
|
2994
3270
|
### Example
|
2995
3271
|
~~~ruby
|
@@ -3026,7 +3302,8 @@ opts = {
|
|
3026
3302
|
deleted: false, # BOOLEAN | Include deleted
|
3027
3303
|
include_schemas: false, # BOOLEAN | Include variable schemas
|
3028
3304
|
published_after: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01", # String | Published after
|
3029
|
-
published_before: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01" # String | Published before
|
3305
|
+
published_before: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01", # String | Published before
|
3306
|
+
division_id: ["division_id_example"] # Array<String> | division ID(s)
|
3030
3307
|
}
|
3031
3308
|
|
3032
3309
|
begin
|
@@ -3059,6 +3336,7 @@ Name | Type | Description | Notes
|
|
3059
3336
|
**include_schemas** | **BOOLEAN**| Include variable schemas | [optional] [default to false] |
|
3060
3337
|
**published_after** | **String**| Published after | [optional] |
|
3061
3338
|
**published_before** | **String**| Published before | [optional] |
|
3339
|
+
**division_id** | [**Array<String>**](String.html)| division ID(s) | [optional] |
|
3062
3340
|
{: class="table table-striped"}
|
3063
3341
|
|
3064
3342
|
|
@@ -3077,12 +3355,18 @@ Name | Type | Description | Notes
|
|
3077
3355
|
|
3078
3356
|
## -[**DataTable**](DataTable.html) get_flows_datatable(datatable_id, opts)
|
3079
3357
|
|
3358
|
+
|
3359
|
+
|
3080
3360
|
Returns a specific datatable by id
|
3081
3361
|
|
3082
3362
|
Given a datableid returns the schema associated with it.
|
3083
3363
|
|
3084
3364
|
Wraps GET /api/v2/flows/datatables/{datatableId}
|
3085
3365
|
|
3366
|
+
Requires ANY permissions:
|
3367
|
+
|
3368
|
+
* architect:datatable:view
|
3369
|
+
|
3086
3370
|
|
3087
3371
|
### Example
|
3088
3372
|
~~~ruby
|
@@ -3140,12 +3424,18 @@ Name | Type | Description | Notes
|
|
3140
3424
|
|
3141
3425
|
## -Hash<String, Object>** get_flows_datatable_row(datatable_id, row_id, opts)
|
3142
3426
|
|
3427
|
+
|
3428
|
+
|
3143
3429
|
Returns a specific row for the datatable
|
3144
3430
|
|
3145
3431
|
Given a datatable id and a rowId (key) will return the full row contents for that rowId.
|
3146
3432
|
|
3147
3433
|
Wraps GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
3148
3434
|
|
3435
|
+
Requires ANY permissions:
|
3436
|
+
|
3437
|
+
* architect:datatable:view
|
3438
|
+
|
3149
3439
|
|
3150
3440
|
### Example
|
3151
3441
|
~~~ruby
|
@@ -3206,12 +3496,18 @@ Name | Type | Description | Notes
|
|
3206
3496
|
|
3207
3497
|
## -[**DataTableRowEntityListing**](DataTableRowEntityListing.html) get_flows_datatable_rows(datatable_id, opts)
|
3208
3498
|
|
3499
|
+
|
3500
|
+
|
3209
3501
|
Returns the rows for the datatable
|
3210
3502
|
|
3211
3503
|
Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
|
3212
3504
|
|
3213
3505
|
Wraps GET /api/v2/flows/datatables/{datatableId}/rows
|
3214
3506
|
|
3507
|
+
Requires ANY permissions:
|
3508
|
+
|
3509
|
+
* architect:datatable:view
|
3510
|
+
|
3215
3511
|
|
3216
3512
|
### Example
|
3217
3513
|
~~~ruby
|
@@ -3273,12 +3569,18 @@ Name | Type | Description | Notes
|
|
3273
3569
|
|
3274
3570
|
## -[**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html) get_flows_datatables(opts)
|
3275
3571
|
|
3572
|
+
|
3573
|
+
|
3276
3574
|
Retrieve a list of datatables for the org
|
3277
3575
|
|
3278
3576
|
Returns a metadata list of the datatables associated with this org, including ID, name and description.
|
3279
3577
|
|
3280
3578
|
Wraps GET /api/v2/flows/datatables
|
3281
3579
|
|
3580
|
+
Requires ANY permissions:
|
3581
|
+
|
3582
|
+
* architect:datatable:view
|
3583
|
+
|
3282
3584
|
|
3283
3585
|
### Example
|
3284
3586
|
~~~ruby
|
@@ -3341,12 +3643,18 @@ Name | Type | Description | Notes
|
|
3341
3643
|
|
3342
3644
|
## -[**FlowDivisionViewEntityListing**](FlowDivisionViewEntityListing.html) get_flows_divisionviews(type, opts)
|
3343
3645
|
|
3646
|
+
|
3647
|
+
|
3344
3648
|
Get a pageable list of basic flow information objects filterable by query parameters.
|
3345
3649
|
|
3346
3650
|
This returns a simplified version of /flow consisting of name and type.
|
3347
3651
|
|
3348
3652
|
Wraps GET /api/v2/flows/divisionviews
|
3349
3653
|
|
3654
|
+
Requires ANY permissions:
|
3655
|
+
|
3656
|
+
* architect:flow:search
|
3657
|
+
|
3350
3658
|
|
3351
3659
|
### Example
|
3352
3660
|
~~~ruby
|
@@ -3376,7 +3684,8 @@ opts = {
|
|
3376
3684
|
name: "name_example", # String | Name
|
3377
3685
|
publish_version_id: "publish_version_id_example", # String | Publish version ID
|
3378
3686
|
published_after: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01", # String | Published after
|
3379
|
-
published_before: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01" # String | Published before
|
3687
|
+
published_before: "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01", # String | Published before
|
3688
|
+
division_id: ["division_id_example"] # Array<String> | division ID(s)
|
3380
3689
|
}
|
3381
3690
|
|
3382
3691
|
begin
|
@@ -3402,6 +3711,7 @@ Name | Type | Description | Notes
|
|
3402
3711
|
**publish_version_id** | **String**| Publish version ID | [optional] |
|
3403
3712
|
**published_after** | **String**| Published after | [optional] |
|
3404
3713
|
**published_before** | **String**| Published before | [optional] |
|
3714
|
+
**division_id** | [**Array<String>**](String.html)| division ID(s) | [optional] |
|
3405
3715
|
{: class="table table-striped"}
|
3406
3716
|
|
3407
3717
|
|
@@ -3420,12 +3730,18 @@ Name | Type | Description | Notes
|
|
3420
3730
|
|
3421
3731
|
## - post_architect_dependencytracking_build
|
3422
3732
|
|
3733
|
+
|
3734
|
+
|
3423
3735
|
Rebuild Dependency Tracking data for an organization
|
3424
3736
|
|
3425
3737
|
Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
3426
3738
|
|
3427
3739
|
Wraps POST /api/v2/architect/dependencytracking/build
|
3428
3740
|
|
3741
|
+
Requires ANY permissions:
|
3742
|
+
|
3743
|
+
* architect:user:admin
|
3744
|
+
|
3429
3745
|
|
3430
3746
|
### Example
|
3431
3747
|
~~~ruby
|
@@ -3472,12 +3788,18 @@ nil (empty response body)
|
|
3472
3788
|
|
3473
3789
|
## -[**EmergencyGroup**](EmergencyGroup.html) post_architect_emergencygroups(opts)
|
3474
3790
|
|
3791
|
+
|
3792
|
+
|
3475
3793
|
Creates a new emergency group
|
3476
3794
|
|
3477
3795
|
|
3478
3796
|
|
3479
3797
|
Wraps POST /api/v2/architect/emergencygroups
|
3480
3798
|
|
3799
|
+
Requires ANY permissions:
|
3800
|
+
|
3801
|
+
* telephony:plugin:all
|
3802
|
+
|
3481
3803
|
|
3482
3804
|
### Example
|
3483
3805
|
~~~ruby
|
@@ -3532,12 +3854,18 @@ Name | Type | Description | Notes
|
|
3532
3854
|
|
3533
3855
|
## -[**IVR**](IVR.html) post_architect_ivrs(opts)
|
3534
3856
|
|
3857
|
+
|
3858
|
+
|
3535
3859
|
Create IVR config.
|
3536
3860
|
|
3537
3861
|
|
3538
3862
|
|
3539
3863
|
Wraps POST /api/v2/architect/ivrs
|
3540
3864
|
|
3865
|
+
Requires ANY permissions:
|
3866
|
+
|
3867
|
+
* telephony:plugin:all
|
3868
|
+
|
3541
3869
|
|
3542
3870
|
### Example
|
3543
3871
|
~~~ruby
|
@@ -3592,12 +3920,18 @@ Name | Type | Description | Notes
|
|
3592
3920
|
|
3593
3921
|
## -[**Operation**](Operation.html) post_architect_prompt_history(prompt_id)
|
3594
3922
|
|
3923
|
+
|
3924
|
+
|
3595
3925
|
Generate prompt history
|
3596
3926
|
|
3597
3927
|
Asynchronous. Notification topic: v2.architect.prompts.{promptId}
|
3598
3928
|
|
3599
3929
|
Wraps POST /api/v2/architect/prompts/{promptId}/history
|
3600
3930
|
|
3931
|
+
Requires ANY permissions:
|
3932
|
+
|
3933
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
3934
|
+
|
3601
3935
|
|
3602
3936
|
### Example
|
3603
3937
|
~~~ruby
|
@@ -3651,12 +3985,18 @@ Name | Type | Description | Notes
|
|
3651
3985
|
|
3652
3986
|
## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, opts)
|
3653
3987
|
|
3988
|
+
|
3989
|
+
|
3654
3990
|
Create a new user prompt resource
|
3655
3991
|
|
3656
3992
|
|
3657
3993
|
|
3658
3994
|
Wraps POST /api/v2/architect/prompts/{promptId}/resources
|
3659
3995
|
|
3996
|
+
Requires ANY permissions:
|
3997
|
+
|
3998
|
+
* architect:user:admin* architect:user:editor
|
3999
|
+
|
3660
4000
|
|
3661
4001
|
### Example
|
3662
4002
|
~~~ruby
|
@@ -3714,12 +4054,18 @@ Name | Type | Description | Notes
|
|
3714
4054
|
|
3715
4055
|
## -[**Prompt**](Prompt.html) post_architect_prompts(opts)
|
3716
4056
|
|
4057
|
+
|
4058
|
+
|
3717
4059
|
Create a new user prompt
|
3718
4060
|
|
3719
4061
|
|
3720
4062
|
|
3721
4063
|
Wraps POST /api/v2/architect/prompts
|
3722
4064
|
|
4065
|
+
Requires ANY permissions:
|
4066
|
+
|
4067
|
+
* architect:user:admin* architect:user:editor
|
4068
|
+
|
3723
4069
|
|
3724
4070
|
### Example
|
3725
4071
|
~~~ruby
|
@@ -3774,12 +4120,18 @@ Name | Type | Description | Notes
|
|
3774
4120
|
|
3775
4121
|
## -[**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(opts)
|
3776
4122
|
|
4123
|
+
|
4124
|
+
|
3777
4125
|
Creates a new schedule group
|
3778
4126
|
|
3779
4127
|
|
3780
4128
|
|
3781
4129
|
Wraps POST /api/v2/architect/schedulegroups
|
3782
4130
|
|
4131
|
+
Requires ANY permissions:
|
4132
|
+
|
4133
|
+
* telephony:plugin:all
|
4134
|
+
|
3783
4135
|
|
3784
4136
|
### Example
|
3785
4137
|
~~~ruby
|
@@ -3834,12 +4186,18 @@ Name | Type | Description | Notes
|
|
3834
4186
|
|
3835
4187
|
## -[**Schedule**](Schedule.html) post_architect_schedules(opts)
|
3836
4188
|
|
4189
|
+
|
4190
|
+
|
3837
4191
|
Create a new schedule.
|
3838
4192
|
|
3839
4193
|
|
3840
4194
|
|
3841
4195
|
Wraps POST /api/v2/architect/schedules
|
3842
4196
|
|
4197
|
+
Requires ANY permissions:
|
4198
|
+
|
4199
|
+
* telephony:plugin:all
|
4200
|
+
|
3843
4201
|
|
3844
4202
|
### Example
|
3845
4203
|
~~~ruby
|
@@ -3894,12 +4252,18 @@ Name | Type | Description | Notes
|
|
3894
4252
|
|
3895
4253
|
## -[**Operation**](Operation.html) post_architect_systemprompt_history(prompt_id)
|
3896
4254
|
|
4255
|
+
|
4256
|
+
|
3897
4257
|
Generate system prompt history
|
3898
4258
|
|
3899
4259
|
Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}
|
3900
4260
|
|
3901
4261
|
Wraps POST /api/v2/architect/systemprompts/{promptId}/history
|
3902
4262
|
|
4263
|
+
Requires ANY permissions:
|
4264
|
+
|
4265
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
4266
|
+
|
3903
4267
|
|
3904
4268
|
### Example
|
3905
4269
|
~~~ruby
|
@@ -3953,12 +4317,18 @@ Name | Type | Description | Notes
|
|
3953
4317
|
|
3954
4318
|
## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, opts)
|
3955
4319
|
|
4320
|
+
|
4321
|
+
|
3956
4322
|
Create system prompt resource override.
|
3957
4323
|
|
3958
4324
|
|
3959
4325
|
|
3960
4326
|
Wraps POST /api/v2/architect/systemprompts/{promptId}/resources
|
3961
4327
|
|
4328
|
+
Requires ANY permissions:
|
4329
|
+
|
4330
|
+
* architect:user:admin* architect:user:editor
|
4331
|
+
|
3962
4332
|
|
3963
4333
|
### Example
|
3964
4334
|
~~~ruby
|
@@ -4016,12 +4386,18 @@ Name | Type | Description | Notes
|
|
4016
4386
|
|
4017
4387
|
## -[**FlowVersion**](FlowVersion.html) post_flow_versions(flow_id, opts)
|
4018
4388
|
|
4389
|
+
|
4390
|
+
|
4019
4391
|
Create flow version
|
4020
4392
|
|
4021
4393
|
|
4022
4394
|
|
4023
4395
|
Wraps POST /api/v2/flows/{flowId}/versions
|
4024
4396
|
|
4397
|
+
Requires ANY permissions:
|
4398
|
+
|
4399
|
+
* architect:user:admin* architect:user:editor
|
4400
|
+
|
4025
4401
|
|
4026
4402
|
### Example
|
4027
4403
|
~~~ruby
|
@@ -4079,12 +4455,18 @@ Name | Type | Description | Notes
|
|
4079
4455
|
|
4080
4456
|
## -[**Flow**](Flow.html) post_flows(opts)
|
4081
4457
|
|
4458
|
+
|
4459
|
+
|
4082
4460
|
Create flow
|
4083
4461
|
|
4084
4462
|
|
4085
4463
|
|
4086
4464
|
Wraps POST /api/v2/flows
|
4087
4465
|
|
4466
|
+
Requires ANY permissions:
|
4467
|
+
|
4468
|
+
* architect:user:admin* architect:user:editor* architect:user:readonly
|
4469
|
+
|
4088
4470
|
|
4089
4471
|
### Example
|
4090
4472
|
~~~ruby
|
@@ -4139,12 +4521,18 @@ Name | Type | Description | Notes
|
|
4139
4521
|
|
4140
4522
|
## -[**Flow**](Flow.html) post_flows_actions_checkin(flow)
|
4141
4523
|
|
4524
|
+
|
4525
|
+
|
4142
4526
|
Check-in flow
|
4143
4527
|
|
4144
4528
|
Asynchronous. Notification topic: v2.flows.{flowId}
|
4145
4529
|
|
4146
4530
|
Wraps POST /api/v2/flows/actions/checkin
|
4147
4531
|
|
4532
|
+
Requires ANY permissions:
|
4533
|
+
|
4534
|
+
* architect:user:admin* architect:user:editor
|
4535
|
+
|
4148
4536
|
|
4149
4537
|
### Example
|
4150
4538
|
~~~ruby
|
@@ -4198,12 +4586,18 @@ Name | Type | Description | Notes
|
|
4198
4586
|
|
4199
4587
|
## -[**Flow**](Flow.html) post_flows_actions_checkout(flow)
|
4200
4588
|
|
4589
|
+
|
4590
|
+
|
4201
4591
|
Check-out flow
|
4202
4592
|
|
4203
4593
|
|
4204
4594
|
|
4205
4595
|
Wraps POST /api/v2/flows/actions/checkout
|
4206
4596
|
|
4597
|
+
Requires ANY permissions:
|
4598
|
+
|
4599
|
+
* architect:user:admin* architect:user:editor
|
4600
|
+
|
4207
4601
|
|
4208
4602
|
### Example
|
4209
4603
|
~~~ruby
|
@@ -4257,12 +4651,18 @@ Name | Type | Description | Notes
|
|
4257
4651
|
|
4258
4652
|
## -[**Flow**](Flow.html) post_flows_actions_deactivate(flow)
|
4259
4653
|
|
4654
|
+
|
4655
|
+
|
4260
4656
|
Deactivate flow
|
4261
4657
|
|
4262
4658
|
|
4263
4659
|
|
4264
4660
|
Wraps POST /api/v2/flows/actions/deactivate
|
4265
4661
|
|
4662
|
+
Requires ANY permissions:
|
4663
|
+
|
4664
|
+
* architect:user:admin* architect:user:editor
|
4665
|
+
|
4266
4666
|
|
4267
4667
|
### Example
|
4268
4668
|
~~~ruby
|
@@ -4316,12 +4716,18 @@ Name | Type | Description | Notes
|
|
4316
4716
|
|
4317
4717
|
## -[**Operation**](Operation.html) post_flows_actions_publish(flow, opts)
|
4318
4718
|
|
4719
|
+
|
4720
|
+
|
4319
4721
|
Publish flow
|
4320
4722
|
|
4321
4723
|
Asynchronous. Notification topic: v2.flows.{flowId}
|
4322
4724
|
|
4323
4725
|
Wraps POST /api/v2/flows/actions/publish
|
4324
4726
|
|
4727
|
+
Requires ANY permissions:
|
4728
|
+
|
4729
|
+
* architect:user:admin* architect:user:editor
|
4730
|
+
|
4325
4731
|
|
4326
4732
|
### Example
|
4327
4733
|
~~~ruby
|
@@ -4379,12 +4785,18 @@ Name | Type | Description | Notes
|
|
4379
4785
|
|
4380
4786
|
## -[**Flow**](Flow.html) post_flows_actions_revert(flow)
|
4381
4787
|
|
4788
|
+
|
4789
|
+
|
4382
4790
|
Revert flow
|
4383
4791
|
|
4384
4792
|
|
4385
4793
|
|
4386
4794
|
Wraps POST /api/v2/flows/actions/revert
|
4387
4795
|
|
4796
|
+
Requires ANY permissions:
|
4797
|
+
|
4798
|
+
* architect:user:admin* architect:user:editor
|
4799
|
+
|
4388
4800
|
|
4389
4801
|
### Example
|
4390
4802
|
~~~ruby
|
@@ -4438,12 +4850,18 @@ Name | Type | Description | Notes
|
|
4438
4850
|
|
4439
4851
|
## -[**Flow**](Flow.html) post_flows_actions_unlock(flow)
|
4440
4852
|
|
4853
|
+
|
4854
|
+
|
4441
4855
|
Unlock flow
|
4442
4856
|
|
4443
4857
|
Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.
|
4444
4858
|
|
4445
4859
|
Wraps POST /api/v2/flows/actions/unlock
|
4446
4860
|
|
4861
|
+
Requires ANY permissions:
|
4862
|
+
|
4863
|
+
* architect:user:admin
|
4864
|
+
|
4447
4865
|
|
4448
4866
|
### Example
|
4449
4867
|
~~~ruby
|
@@ -4497,12 +4915,18 @@ Name | Type | Description | Notes
|
|
4497
4915
|
|
4498
4916
|
## -Hash<String, Object>** post_flows_datatable_rows(datatable_id, data_table_row)
|
4499
4917
|
|
4918
|
+
|
4919
|
+
|
4500
4920
|
Create a new row entry
|
4501
4921
|
|
4502
4922
|
Will add the passed in row entry to the datatable with the given id after verifying it against the schema.
|
4503
4923
|
|
4504
4924
|
Wraps POST /api/v2/flows/datatables/{datatableId}/rows
|
4505
4925
|
|
4926
|
+
Requires ANY permissions:
|
4927
|
+
|
4928
|
+
* architect:datatable:add
|
4929
|
+
|
4506
4930
|
|
4507
4931
|
### Example
|
4508
4932
|
~~~ruby
|
@@ -4559,12 +4983,18 @@ Name | Type | Description | Notes
|
|
4559
4983
|
|
4560
4984
|
## -[**DataTable**](DataTable.html) post_flows_datatables(body)
|
4561
4985
|
|
4986
|
+
|
4987
|
+
|
4562
4988
|
Create a new datatable with the specified json-schema definition
|
4563
4989
|
|
4564
4990
|
This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
|
4565
4991
|
|
4566
4992
|
Wraps POST /api/v2/flows/datatables
|
4567
4993
|
|
4994
|
+
Requires ANY permissions:
|
4995
|
+
|
4996
|
+
* architect:datatable:add
|
4997
|
+
|
4568
4998
|
|
4569
4999
|
### Example
|
4570
5000
|
~~~ruby
|
@@ -4618,12 +5048,18 @@ Name | Type | Description | Notes
|
|
4618
5048
|
|
4619
5049
|
## -[**EmergencyGroup**](EmergencyGroup.html) put_architect_emergencygroup(emergency_group_id, opts)
|
4620
5050
|
|
5051
|
+
|
5052
|
+
|
4621
5053
|
Updates a emergency group by ID
|
4622
5054
|
|
4623
5055
|
|
4624
5056
|
|
4625
5057
|
Wraps PUT /api/v2/architect/emergencygroups/{emergencyGroupId}
|
4626
5058
|
|
5059
|
+
Requires ANY permissions:
|
5060
|
+
|
5061
|
+
* telephony:plugin:all
|
5062
|
+
|
4627
5063
|
|
4628
5064
|
### Example
|
4629
5065
|
~~~ruby
|
@@ -4681,12 +5117,18 @@ Name | Type | Description | Notes
|
|
4681
5117
|
|
4682
5118
|
## -[**IVR**](IVR.html) put_architect_ivr(ivr_id, opts)
|
4683
5119
|
|
5120
|
+
|
5121
|
+
|
4684
5122
|
Update an IVR Config.
|
4685
5123
|
|
4686
5124
|
|
4687
5125
|
|
4688
5126
|
Wraps PUT /api/v2/architect/ivrs/{ivrId}
|
4689
5127
|
|
5128
|
+
Requires ANY permissions:
|
5129
|
+
|
5130
|
+
* telephony:plugin:all
|
5131
|
+
|
4690
5132
|
|
4691
5133
|
### Example
|
4692
5134
|
~~~ruby
|
@@ -4744,12 +5186,18 @@ Name | Type | Description | Notes
|
|
4744
5186
|
|
4745
5187
|
## -[**Prompt**](Prompt.html) put_architect_prompt(prompt_id, opts)
|
4746
5188
|
|
5189
|
+
|
5190
|
+
|
4747
5191
|
Update specified user prompt
|
4748
5192
|
|
4749
5193
|
|
4750
5194
|
|
4751
5195
|
Wraps PUT /api/v2/architect/prompts/{promptId}
|
4752
5196
|
|
5197
|
+
Requires ANY permissions:
|
5198
|
+
|
5199
|
+
* architect:user:admin* architect:user:editor
|
5200
|
+
|
4753
5201
|
|
4754
5202
|
### Example
|
4755
5203
|
~~~ruby
|
@@ -4807,12 +5255,18 @@ Name | Type | Description | Notes
|
|
4807
5255
|
|
4808
5256
|
## -[**PromptAsset**](PromptAsset.html) put_architect_prompt_resource(prompt_id, language_code, opts)
|
4809
5257
|
|
5258
|
+
|
5259
|
+
|
4810
5260
|
Update specified user prompt resource
|
4811
5261
|
|
4812
5262
|
|
4813
5263
|
|
4814
5264
|
Wraps PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
4815
5265
|
|
5266
|
+
Requires ANY permissions:
|
5267
|
+
|
5268
|
+
* architect:user:admin* architect:user:editor
|
5269
|
+
|
4816
5270
|
|
4817
5271
|
### Example
|
4818
5272
|
~~~ruby
|
@@ -4873,12 +5327,18 @@ Name | Type | Description | Notes
|
|
4873
5327
|
|
4874
5328
|
## -[**Schedule**](Schedule.html) put_architect_schedule(schedule_id, opts)
|
4875
5329
|
|
5330
|
+
|
5331
|
+
|
4876
5332
|
Update schedule by ID
|
4877
5333
|
|
4878
5334
|
|
4879
5335
|
|
4880
5336
|
Wraps PUT /api/v2/architect/schedules/{scheduleId}
|
4881
5337
|
|
5338
|
+
Requires ANY permissions:
|
5339
|
+
|
5340
|
+
* telephony:plugin:all
|
5341
|
+
|
4882
5342
|
|
4883
5343
|
### Example
|
4884
5344
|
~~~ruby
|
@@ -4936,12 +5396,18 @@ Name | Type | Description | Notes
|
|
4936
5396
|
|
4937
5397
|
## -[**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id, opts)
|
4938
5398
|
|
5399
|
+
|
5400
|
+
|
4939
5401
|
Updates a schedule group by ID
|
4940
5402
|
|
4941
5403
|
|
4942
5404
|
|
4943
5405
|
Wraps PUT /api/v2/architect/schedulegroups/{scheduleGroupId}
|
4944
5406
|
|
5407
|
+
Requires ANY permissions:
|
5408
|
+
|
5409
|
+
* telephony:plugin:all
|
5410
|
+
|
4945
5411
|
|
4946
5412
|
### Example
|
4947
5413
|
~~~ruby
|
@@ -4999,12 +5465,18 @@ Name | Type | Description | Notes
|
|
4999
5465
|
|
5000
5466
|
## -[**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code, opts)
|
5001
5467
|
|
5468
|
+
|
5469
|
+
|
5002
5470
|
Updates a system prompt resource override.
|
5003
5471
|
|
5004
5472
|
|
5005
5473
|
|
5006
5474
|
Wraps PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
5007
5475
|
|
5476
|
+
Requires ANY permissions:
|
5477
|
+
|
5478
|
+
* architect:user:admin* architect:user:editor
|
5479
|
+
|
5008
5480
|
|
5009
5481
|
### Example
|
5010
5482
|
~~~ruby
|
@@ -5065,12 +5537,18 @@ Name | Type | Description | Notes
|
|
5065
5537
|
|
5066
5538
|
## -[**Flow**](Flow.html) put_flow(flow_id, opts)
|
5067
5539
|
|
5540
|
+
|
5541
|
+
|
5068
5542
|
Update flow
|
5069
5543
|
|
5070
5544
|
|
5071
5545
|
|
5072
5546
|
Wraps PUT /api/v2/flows/{flowId}
|
5073
5547
|
|
5548
|
+
Requires ANY permissions:
|
5549
|
+
|
5550
|
+
* architect:user:admin* architect:user:editor
|
5551
|
+
|
5074
5552
|
|
5075
5553
|
### Example
|
5076
5554
|
~~~ruby
|
@@ -5128,12 +5606,18 @@ Name | Type | Description | Notes
|
|
5128
5606
|
|
5129
5607
|
## -[**DataTable**](DataTable.html) put_flows_datatable(datatable_id, opts)
|
5130
5608
|
|
5609
|
+
|
5610
|
+
|
5131
5611
|
Updates a specific datatable by id
|
5132
5612
|
|
5133
5613
|
Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
|
5134
5614
|
|
5135
5615
|
Wraps PUT /api/v2/flows/datatables/{datatableId}
|
5136
5616
|
|
5617
|
+
Requires ANY permissions:
|
5618
|
+
|
5619
|
+
* architect:datatable:edit
|
5620
|
+
|
5137
5621
|
|
5138
5622
|
### Example
|
5139
5623
|
~~~ruby
|
@@ -5193,12 +5677,18 @@ Name | Type | Description | Notes
|
|
5193
5677
|
|
5194
5678
|
## -Hash<String, Object>** put_flows_datatable_row(datatable_id, row_id, opts)
|
5195
5679
|
|
5680
|
+
|
5681
|
+
|
5196
5682
|
Update a row entry
|
5197
5683
|
|
5198
5684
|
Updates a row with the given to the new values.
|
5199
5685
|
|
5200
5686
|
Wraps PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}
|
5201
5687
|
|
5688
|
+
Requires ANY permissions:
|
5689
|
+
|
5690
|
+
* architect:datatable:edit
|
5691
|
+
|
5202
5692
|
|
5203
5693
|
### Example
|
5204
5694
|
~~~ruby
|