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
data/docs/RelationshipListing.md
CHANGED
@@ -13,9 +13,9 @@ title: RelationshipListing
|
|
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: ReportMetaDataEntityListing
|
|
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: ReportRunEntryEntityDomainListing
|
|
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: ReportScheduleEntityListing
|
|
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: ReportingExportJobListing
|
|
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/ResponseEntityList.md
CHANGED
@@ -13,9 +13,9 @@ title: ResponseEntityList
|
|
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: ResponseEntityListing
|
|
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
|
|
@@ -25,12 +25,18 @@ Method | Description
|
|
25
25
|
|
26
26
|
## - delete_responsemanagement_library(library_id)
|
27
27
|
|
28
|
+
|
29
|
+
|
28
30
|
Delete an existing response library.
|
29
31
|
|
30
32
|
This will remove any responses associated with the library.
|
31
33
|
|
32
34
|
Wraps DELETE /api/v2/responsemanagement/libraries/{libraryId}
|
33
35
|
|
36
|
+
Requires NO permissions:
|
37
|
+
|
38
|
+
|
39
|
+
|
34
40
|
|
35
41
|
### Example
|
36
42
|
~~~ruby
|
@@ -83,12 +89,18 @@ nil (empty response body)
|
|
83
89
|
|
84
90
|
## - delete_responsemanagement_response(response_id)
|
85
91
|
|
92
|
+
|
93
|
+
|
86
94
|
Delete an existing response.
|
87
95
|
|
88
96
|
This will remove the response from any libraries associated with it.
|
89
97
|
|
90
98
|
Wraps DELETE /api/v2/responsemanagement/responses/{responseId}
|
91
99
|
|
100
|
+
Requires NO permissions:
|
101
|
+
|
102
|
+
|
103
|
+
|
92
104
|
|
93
105
|
### Example
|
94
106
|
~~~ruby
|
@@ -141,12 +153,18 @@ nil (empty response body)
|
|
141
153
|
|
142
154
|
## -[**LibraryEntityListing**](LibraryEntityListing.html) get_responsemanagement_libraries(opts)
|
143
155
|
|
156
|
+
|
157
|
+
|
144
158
|
Gets a list of existing response libraries.
|
145
159
|
|
146
160
|
|
147
161
|
|
148
162
|
Wraps GET /api/v2/responsemanagement/libraries
|
149
163
|
|
164
|
+
Requires NO permissions:
|
165
|
+
|
166
|
+
|
167
|
+
|
150
168
|
|
151
169
|
### Example
|
152
170
|
~~~ruby
|
@@ -203,12 +221,18 @@ Name | Type | Description | Notes
|
|
203
221
|
|
204
222
|
## -[**Library**](Library.html) get_responsemanagement_library(library_id)
|
205
223
|
|
224
|
+
|
225
|
+
|
206
226
|
Get details about an existing response library.
|
207
227
|
|
208
228
|
|
209
229
|
|
210
230
|
Wraps GET /api/v2/responsemanagement/libraries/{libraryId}
|
211
231
|
|
232
|
+
Requires NO permissions:
|
233
|
+
|
234
|
+
|
235
|
+
|
212
236
|
|
213
237
|
### Example
|
214
238
|
~~~ruby
|
@@ -262,12 +286,18 @@ Name | Type | Description | Notes
|
|
262
286
|
|
263
287
|
## -[**Response**](Response.html) get_responsemanagement_response(response_id, opts)
|
264
288
|
|
289
|
+
|
290
|
+
|
265
291
|
Get details about an existing response.
|
266
292
|
|
267
293
|
|
268
294
|
|
269
295
|
Wraps GET /api/v2/responsemanagement/responses/{responseId}
|
270
296
|
|
297
|
+
Requires NO permissions:
|
298
|
+
|
299
|
+
|
300
|
+
|
271
301
|
|
272
302
|
### Example
|
273
303
|
~~~ruby
|
@@ -325,12 +355,18 @@ Name | Type | Description | Notes
|
|
325
355
|
|
326
356
|
## -[**ResponseEntityListing**](ResponseEntityListing.html) get_responsemanagement_responses(library_id, opts)
|
327
357
|
|
358
|
+
|
359
|
+
|
328
360
|
Gets a list of existing responses.
|
329
361
|
|
330
362
|
|
331
363
|
|
332
364
|
Wraps GET /api/v2/responsemanagement/responses
|
333
365
|
|
366
|
+
Requires NO permissions:
|
367
|
+
|
368
|
+
|
369
|
+
|
334
370
|
|
335
371
|
### Example
|
336
372
|
~~~ruby
|
@@ -392,12 +428,18 @@ Name | Type | Description | Notes
|
|
392
428
|
|
393
429
|
## -[**Library**](Library.html) post_responsemanagement_libraries(body)
|
394
430
|
|
431
|
+
|
432
|
+
|
395
433
|
Create a response library.
|
396
434
|
|
397
435
|
|
398
436
|
|
399
437
|
Wraps POST /api/v2/responsemanagement/libraries
|
400
438
|
|
439
|
+
Requires NO permissions:
|
440
|
+
|
441
|
+
|
442
|
+
|
401
443
|
|
402
444
|
### Example
|
403
445
|
~~~ruby
|
@@ -451,12 +493,18 @@ Name | Type | Description | Notes
|
|
451
493
|
|
452
494
|
## -[**Response**](Response.html) post_responsemanagement_responses(body, opts)
|
453
495
|
|
496
|
+
|
497
|
+
|
454
498
|
Create a response.
|
455
499
|
|
456
500
|
|
457
501
|
|
458
502
|
Wraps POST /api/v2/responsemanagement/responses
|
459
503
|
|
504
|
+
Requires NO permissions:
|
505
|
+
|
506
|
+
|
507
|
+
|
460
508
|
|
461
509
|
### Example
|
462
510
|
~~~ruby
|
@@ -514,12 +562,18 @@ Name | Type | Description | Notes
|
|
514
562
|
|
515
563
|
## -[**ResponseQueryResults**](ResponseQueryResults.html) post_responsemanagement_responses_query(body)
|
516
564
|
|
565
|
+
|
566
|
+
|
517
567
|
Query responses
|
518
568
|
|
519
569
|
|
520
570
|
|
521
571
|
Wraps POST /api/v2/responsemanagement/responses/query
|
522
572
|
|
573
|
+
Requires NO permissions:
|
574
|
+
|
575
|
+
|
576
|
+
|
523
577
|
|
524
578
|
### Example
|
525
579
|
~~~ruby
|
@@ -573,12 +627,18 @@ Name | Type | Description | Notes
|
|
573
627
|
|
574
628
|
## -[**Library**](Library.html) put_responsemanagement_library(library_id, body)
|
575
629
|
|
630
|
+
|
631
|
+
|
576
632
|
Update an existing response library.
|
577
633
|
|
578
634
|
Fields that can be updated: name. The most recent version is required for updates.
|
579
635
|
|
580
636
|
Wraps PUT /api/v2/responsemanagement/libraries/{libraryId}
|
581
637
|
|
638
|
+
Requires NO permissions:
|
639
|
+
|
640
|
+
|
641
|
+
|
582
642
|
|
583
643
|
### Example
|
584
644
|
~~~ruby
|
@@ -635,12 +695,18 @@ Name | Type | Description | Notes
|
|
635
695
|
|
636
696
|
## -[**Response**](Response.html) put_responsemanagement_response(response_id, body, opts)
|
637
697
|
|
698
|
+
|
699
|
+
|
638
700
|
Update an existing response.
|
639
701
|
|
640
702
|
Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
|
641
703
|
|
642
704
|
Wraps PUT /api/v2/responsemanagement/responses/{responseId}
|
643
705
|
|
706
|
+
Requires NO permissions:
|
707
|
+
|
708
|
+
|
709
|
+
|
644
710
|
|
645
711
|
### Example
|
646
712
|
~~~ruby
|
@@ -13,9 +13,9 @@ title: ResponseSetEntityListing
|
|
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/RoutingApi.md
CHANGED
@@ -72,12 +72,18 @@ Method | Description
|
|
72
72
|
|
73
73
|
## - delete_routing_email_domain(domain_id)
|
74
74
|
|
75
|
+
|
76
|
+
|
75
77
|
Delete a domain
|
76
78
|
|
77
79
|
|
78
80
|
|
79
81
|
Wraps DELETE /api/v2/routing/email/domains/{domainId}
|
80
82
|
|
83
|
+
Requires ANY permissions:
|
84
|
+
|
85
|
+
* routing:email:manage
|
86
|
+
|
81
87
|
|
82
88
|
### Example
|
83
89
|
~~~ruby
|
@@ -130,12 +136,18 @@ nil (empty response body)
|
|
130
136
|
|
131
137
|
## - delete_routing_email_domain_route(domain_name, route_id)
|
132
138
|
|
139
|
+
|
140
|
+
|
133
141
|
Delete a route
|
134
142
|
|
135
143
|
|
136
144
|
|
137
145
|
Wraps DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
138
146
|
|
147
|
+
Requires ANY permissions:
|
148
|
+
|
149
|
+
* routing:email:manage
|
150
|
+
|
139
151
|
|
140
152
|
### Example
|
141
153
|
~~~ruby
|
@@ -191,12 +203,18 @@ nil (empty response body)
|
|
191
203
|
|
192
204
|
## - delete_routing_queue(queue_id, opts)
|
193
205
|
|
206
|
+
|
207
|
+
|
194
208
|
Delete a queue
|
195
209
|
|
196
210
|
|
197
211
|
|
198
212
|
Wraps DELETE /api/v2/routing/queues/{queueId}
|
199
213
|
|
214
|
+
Requires ANY permissions:
|
215
|
+
|
216
|
+
* routing:queue:delete
|
217
|
+
|
200
218
|
|
201
219
|
### Example
|
202
220
|
~~~ruby
|
@@ -253,12 +271,18 @@ nil (empty response body)
|
|
253
271
|
|
254
272
|
## - delete_routing_queue_user(queue_id, member_id)
|
255
273
|
|
274
|
+
|
275
|
+
|
256
276
|
Delete queue member
|
257
277
|
|
258
278
|
|
259
279
|
|
260
280
|
Wraps DELETE /api/v2/routing/queues/{queueId}/users/{memberId}
|
261
281
|
|
282
|
+
Requires ANY permissions:
|
283
|
+
|
284
|
+
* routing:queue:edit
|
285
|
+
|
262
286
|
|
263
287
|
### Example
|
264
288
|
~~~ruby
|
@@ -314,12 +338,18 @@ nil (empty response body)
|
|
314
338
|
|
315
339
|
## - delete_routing_queue_wrapupcode(queue_id, code_id)
|
316
340
|
|
341
|
+
|
342
|
+
|
317
343
|
Delete a wrap-up code from a queue
|
318
344
|
|
319
345
|
|
320
346
|
|
321
347
|
Wraps DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}
|
322
348
|
|
349
|
+
Requires ANY permissions:
|
350
|
+
|
351
|
+
* routing:queue:edit
|
352
|
+
|
323
353
|
|
324
354
|
### Example
|
325
355
|
~~~ruby
|
@@ -375,12 +405,18 @@ nil (empty response body)
|
|
375
405
|
|
376
406
|
## - delete_routing_skill(skill_id)
|
377
407
|
|
408
|
+
|
409
|
+
|
378
410
|
Delete Routing Skill
|
379
411
|
|
380
412
|
|
381
413
|
|
382
414
|
Wraps DELETE /api/v2/routing/skills/{skillId}
|
383
415
|
|
416
|
+
Requires ANY permissions:
|
417
|
+
|
418
|
+
* routing:skill:manage
|
419
|
+
|
384
420
|
|
385
421
|
### Example
|
386
422
|
~~~ruby
|
@@ -433,12 +469,18 @@ nil (empty response body)
|
|
433
469
|
|
434
470
|
## - delete_routing_sms_phonenumber(address_id)
|
435
471
|
|
472
|
+
|
473
|
+
|
436
474
|
Delete a phone number provisioned for SMS.
|
437
475
|
|
438
476
|
|
439
477
|
|
440
478
|
Wraps DELETE /api/v2/routing/sms/phonenumbers/{addressId}
|
441
479
|
|
480
|
+
Requires ANY permissions:
|
481
|
+
|
482
|
+
* sms:phoneNumber:delete
|
483
|
+
|
442
484
|
|
443
485
|
### Example
|
444
486
|
~~~ruby
|
@@ -491,12 +533,18 @@ nil (empty response body)
|
|
491
533
|
|
492
534
|
## - delete_routing_utilization
|
493
535
|
|
536
|
+
|
537
|
+
|
494
538
|
Delete utilization settings and revert to system defaults.
|
495
539
|
|
496
540
|
|
497
541
|
|
498
542
|
Wraps DELETE /api/v2/routing/utilization
|
499
543
|
|
544
|
+
Requires ANY permissions:
|
545
|
+
|
546
|
+
* routing:utilization:manage
|
547
|
+
|
500
548
|
|
501
549
|
### Example
|
502
550
|
~~~ruby
|
@@ -543,12 +591,18 @@ nil (empty response body)
|
|
543
591
|
|
544
592
|
## - delete_routing_wrapupcode(code_id)
|
545
593
|
|
594
|
+
|
595
|
+
|
546
596
|
Delete wrap-up code
|
547
597
|
|
548
598
|
|
549
599
|
|
550
600
|
Wraps DELETE /api/v2/routing/wrapupcodes/{codeId}
|
551
601
|
|
602
|
+
Requires ANY permissions:
|
603
|
+
|
604
|
+
* routing:wrapupCode:delete
|
605
|
+
|
552
606
|
|
553
607
|
### Example
|
554
608
|
~~~ruby
|
@@ -601,12 +655,18 @@ nil (empty response body)
|
|
601
655
|
|
602
656
|
## - delete_user_routinglanguage(user_id, language_id)
|
603
657
|
|
658
|
+
|
659
|
+
|
604
660
|
Remove routing language from user
|
605
661
|
|
606
662
|
|
607
663
|
|
608
664
|
Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId}
|
609
665
|
|
666
|
+
Requires ANY permissions:
|
667
|
+
|
668
|
+
* routing:skill:assign* admin
|
669
|
+
|
610
670
|
|
611
671
|
### Example
|
612
672
|
~~~ruby
|
@@ -662,12 +722,18 @@ nil (empty response body)
|
|
662
722
|
|
663
723
|
## - delete_user_routingskill(user_id, skill_id)
|
664
724
|
|
725
|
+
|
726
|
+
|
665
727
|
Remove routing skill from user
|
666
728
|
|
667
729
|
|
668
730
|
|
669
731
|
Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
|
670
732
|
|
733
|
+
Requires ANY permissions:
|
734
|
+
|
735
|
+
* routing:skill:assign* admin
|
736
|
+
|
671
737
|
|
672
738
|
### Example
|
673
739
|
~~~ruby
|
@@ -723,12 +789,18 @@ nil (empty response body)
|
|
723
789
|
|
724
790
|
## -[**InboundDomain**](InboundDomain.html) get_routing_email_domain(domain_id)
|
725
791
|
|
792
|
+
|
793
|
+
|
726
794
|
Get domain
|
727
795
|
|
728
796
|
|
729
797
|
|
730
798
|
Wraps GET /api/v2/routing/email/domains/{domainId}
|
731
799
|
|
800
|
+
Requires ANY permissions:
|
801
|
+
|
802
|
+
* routing:email:manage
|
803
|
+
|
732
804
|
|
733
805
|
### Example
|
734
806
|
~~~ruby
|
@@ -782,12 +854,18 @@ Name | Type | Description | Notes
|
|
782
854
|
|
783
855
|
## -[**InboundRoute**](InboundRoute.html) get_routing_email_domain_route(domain_name, route_id)
|
784
856
|
|
857
|
+
|
858
|
+
|
785
859
|
Get a route
|
786
860
|
|
787
861
|
|
788
862
|
|
789
863
|
Wraps GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
790
864
|
|
865
|
+
Requires ANY permissions:
|
866
|
+
|
867
|
+
* routing:email:manage
|
868
|
+
|
791
869
|
|
792
870
|
### Example
|
793
871
|
~~~ruby
|
@@ -844,12 +922,18 @@ Name | Type | Description | Notes
|
|
844
922
|
|
845
923
|
## -[**InboundRouteEntityListing**](InboundRouteEntityListing.html) get_routing_email_domain_routes(domain_name, opts)
|
846
924
|
|
925
|
+
|
926
|
+
|
847
927
|
Get routes
|
848
928
|
|
849
929
|
|
850
930
|
|
851
931
|
Wraps GET /api/v2/routing/email/domains/{domainName}/routes
|
852
932
|
|
933
|
+
Requires ANY permissions:
|
934
|
+
|
935
|
+
* routing:email:manage
|
936
|
+
|
853
937
|
|
854
938
|
### Example
|
855
939
|
~~~ruby
|
@@ -911,12 +995,18 @@ Name | Type | Description | Notes
|
|
911
995
|
|
912
996
|
## -[**InboundDomainEntityListing**](InboundDomainEntityListing.html) get_routing_email_domains
|
913
997
|
|
998
|
+
|
999
|
+
|
914
1000
|
Get domains
|
915
1001
|
|
916
1002
|
|
917
1003
|
|
918
1004
|
Wraps GET /api/v2/routing/email/domains
|
919
1005
|
|
1006
|
+
Requires ANY permissions:
|
1007
|
+
|
1008
|
+
* routing:email:manage
|
1009
|
+
|
920
1010
|
|
921
1011
|
### Example
|
922
1012
|
~~~ruby
|
@@ -964,12 +1054,18 @@ This endpoint does not need any parameter.
|
|
964
1054
|
|
965
1055
|
## -[**EmailSetup**](EmailSetup.html) get_routing_email_setup
|
966
1056
|
|
1057
|
+
|
1058
|
+
|
967
1059
|
Get email setup
|
968
1060
|
|
969
1061
|
|
970
1062
|
|
971
1063
|
Wraps GET /api/v2/routing/email/setup
|
972
1064
|
|
1065
|
+
Requires ANY permissions:
|
1066
|
+
|
1067
|
+
* routing:email:manage
|
1068
|
+
|
973
1069
|
|
974
1070
|
### Example
|
975
1071
|
~~~ruby
|
@@ -1017,12 +1113,18 @@ This endpoint does not need any parameter.
|
|
1017
1113
|
|
1018
1114
|
## -[**LanguageEntityListing**](LanguageEntityListing.html) get_routing_languages(opts)
|
1019
1115
|
|
1116
|
+
|
1117
|
+
|
1020
1118
|
Get the list of supported languages.
|
1021
1119
|
|
1022
1120
|
|
1023
1121
|
|
1024
1122
|
Wraps GET /api/v2/routing/languages
|
1025
1123
|
|
1124
|
+
Requires ANY permissions:
|
1125
|
+
|
1126
|
+
* routing:skill:manage
|
1127
|
+
|
1026
1128
|
|
1027
1129
|
### Example
|
1028
1130
|
~~~ruby
|
@@ -1083,12 +1185,18 @@ Name | Type | Description | Notes
|
|
1083
1185
|
|
1084
1186
|
## -[**Recipient**](Recipient.html) get_routing_message_recipient(recipient_id)
|
1085
1187
|
|
1188
|
+
|
1189
|
+
|
1086
1190
|
Get a recipient
|
1087
1191
|
|
1088
1192
|
|
1089
1193
|
|
1090
1194
|
Wraps GET /api/v2/routing/message/recipients/{recipientId}
|
1091
1195
|
|
1196
|
+
Requires ANY permissions:
|
1197
|
+
|
1198
|
+
* routing:message:manage
|
1199
|
+
|
1092
1200
|
|
1093
1201
|
### Example
|
1094
1202
|
~~~ruby
|
@@ -1142,12 +1250,18 @@ Name | Type | Description | Notes
|
|
1142
1250
|
|
1143
1251
|
## -[**RecipientListing**](RecipientListing.html) get_routing_message_recipients(opts)
|
1144
1252
|
|
1253
|
+
|
1254
|
+
|
1145
1255
|
Get recipients
|
1146
1256
|
|
1147
1257
|
|
1148
1258
|
|
1149
1259
|
Wraps GET /api/v2/routing/message/recipients
|
1150
1260
|
|
1261
|
+
Requires ANY permissions:
|
1262
|
+
|
1263
|
+
* routing:message:manage
|
1264
|
+
|
1151
1265
|
|
1152
1266
|
### Example
|
1153
1267
|
~~~ruby
|
@@ -1204,12 +1318,18 @@ Name | Type | Description | Notes
|
|
1204
1318
|
|
1205
1319
|
## -[**Queue**](Queue.html) get_routing_queue(queue_id)
|
1206
1320
|
|
1321
|
+
|
1322
|
+
|
1207
1323
|
Get details about this queue.
|
1208
1324
|
|
1209
1325
|
|
1210
1326
|
|
1211
1327
|
Wraps GET /api/v2/routing/queues/{queueId}
|
1212
1328
|
|
1329
|
+
Requires ANY permissions:
|
1330
|
+
|
1331
|
+
* routing:queue:view
|
1332
|
+
|
1213
1333
|
|
1214
1334
|
### Example
|
1215
1335
|
~~~ruby
|
@@ -1263,12 +1383,18 @@ Name | Type | Description | Notes
|
|
1263
1383
|
|
1264
1384
|
## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_routing_queue_estimatedwaittime(queue_id, opts)
|
1265
1385
|
|
1386
|
+
|
1387
|
+
|
1266
1388
|
Get Estimated Wait Time
|
1267
1389
|
|
1268
1390
|
|
1269
1391
|
|
1270
1392
|
Wraps GET /api/v2/routing/queues/{queueId}/estimatedwaittime
|
1271
1393
|
|
1394
|
+
Requires ANY permissions:
|
1395
|
+
|
1396
|
+
* routing:queue:view
|
1397
|
+
|
1272
1398
|
|
1273
1399
|
### Example
|
1274
1400
|
~~~ruby
|
@@ -1326,12 +1452,18 @@ Name | Type | Description | Notes
|
|
1326
1452
|
|
1327
1453
|
## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_routing_queue_mediatype_estimatedwaittime(queue_id, media_type)
|
1328
1454
|
|
1455
|
+
|
1456
|
+
|
1329
1457
|
Get Estimated Wait Time
|
1330
1458
|
|
1331
1459
|
|
1332
1460
|
|
1333
1461
|
Wraps GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime
|
1334
1462
|
|
1463
|
+
Requires ANY permissions:
|
1464
|
+
|
1465
|
+
* routing:queue:view
|
1466
|
+
|
1335
1467
|
|
1336
1468
|
### Example
|
1337
1469
|
~~~ruby
|
@@ -1388,12 +1520,18 @@ Name | Type | Description | Notes
|
|
1388
1520
|
|
1389
1521
|
## -[**QueueMemberEntityListing**](QueueMemberEntityListing.html) get_routing_queue_users(queue_id, opts)
|
1390
1522
|
|
1523
|
+
|
1524
|
+
|
1391
1525
|
Get the members of this queue
|
1392
1526
|
|
1393
1527
|
|
1394
1528
|
|
1395
1529
|
Wraps GET /api/v2/routing/queues/{queueId}/users
|
1396
1530
|
|
1531
|
+
Requires ANY permissions:
|
1532
|
+
|
1533
|
+
* routing:queue:view
|
1534
|
+
|
1397
1535
|
|
1398
1536
|
### Example
|
1399
1537
|
~~~ruby
|
@@ -1471,12 +1609,18 @@ Name | Type | Description | Notes
|
|
1471
1609
|
|
1472
1610
|
## -[**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_routing_queue_wrapupcodes(queue_id)
|
1473
1611
|
|
1612
|
+
|
1613
|
+
|
1474
1614
|
Get the wrap-up codes for a queue
|
1475
1615
|
|
1476
1616
|
|
1477
1617
|
|
1478
1618
|
Wraps GET /api/v2/routing/queues/{queueId}/wrapupcodes
|
1479
1619
|
|
1620
|
+
Requires ANY permissions:
|
1621
|
+
|
1622
|
+
* routing:queue:view
|
1623
|
+
|
1480
1624
|
|
1481
1625
|
### Example
|
1482
1626
|
~~~ruby
|
@@ -1530,12 +1674,18 @@ Name | Type | Description | Notes
|
|
1530
1674
|
|
1531
1675
|
## -[**QueueEntityListing**](QueueEntityListing.html) get_routing_queues(opts)
|
1532
1676
|
|
1677
|
+
|
1678
|
+
|
1533
1679
|
Get list of queues.
|
1534
1680
|
|
1535
1681
|
|
1536
1682
|
|
1537
1683
|
Wraps GET /api/v2/routing/queues
|
1538
1684
|
|
1685
|
+
Requires ANY permissions:
|
1686
|
+
|
1687
|
+
* routing:queue:view
|
1688
|
+
|
1539
1689
|
|
1540
1690
|
### Example
|
1541
1691
|
~~~ruby
|
@@ -1559,7 +1709,8 @@ opts = {
|
|
1559
1709
|
page_number: 1, # Integer | Page number
|
1560
1710
|
sort_by: "name", # String | Sort by
|
1561
1711
|
name: "name_example", # String | Name
|
1562
|
-
active: true # BOOLEAN | Active
|
1712
|
+
active: true, # BOOLEAN | Active
|
1713
|
+
division_id: ["division_id_example"] # Array<String> | Division ID(s)
|
1563
1714
|
}
|
1564
1715
|
|
1565
1716
|
begin
|
@@ -1580,6 +1731,7 @@ Name | Type | Description | Notes
|
|
1580
1731
|
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
1581
1732
|
**name** | **String**| Name | [optional] |
|
1582
1733
|
**active** | **BOOLEAN**| Active | [optional] |
|
1734
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
1583
1735
|
{: class="table table-striped"}
|
1584
1736
|
|
1585
1737
|
|
@@ -1598,12 +1750,18 @@ Name | Type | Description | Notes
|
|
1598
1750
|
|
1599
1751
|
## -[**RoutingSkill**](RoutingSkill.html) get_routing_skill(skill_id)
|
1600
1752
|
|
1753
|
+
|
1754
|
+
|
1601
1755
|
Get Routing Skill
|
1602
1756
|
|
1603
1757
|
|
1604
1758
|
|
1605
1759
|
Wraps GET /api/v2/routing/skills/{skillId}
|
1606
1760
|
|
1761
|
+
Requires ANY permissions:
|
1762
|
+
|
1763
|
+
* routing:skill:manage
|
1764
|
+
|
1607
1765
|
|
1608
1766
|
### Example
|
1609
1767
|
~~~ruby
|
@@ -1657,12 +1815,18 @@ Name | Type | Description | Notes
|
|
1657
1815
|
|
1658
1816
|
## -[**SkillEntityListing**](SkillEntityListing.html) get_routing_skills(opts)
|
1659
1817
|
|
1818
|
+
|
1819
|
+
|
1660
1820
|
Get the list of routing skills.
|
1661
1821
|
|
1662
1822
|
|
1663
1823
|
|
1664
1824
|
Wraps GET /api/v2/routing/skills
|
1665
1825
|
|
1826
|
+
Requires ANY permissions:
|
1827
|
+
|
1828
|
+
* routing:skill:manage
|
1829
|
+
|
1666
1830
|
|
1667
1831
|
### Example
|
1668
1832
|
~~~ruby
|
@@ -1721,12 +1885,18 @@ Name | Type | Description | Notes
|
|
1721
1885
|
|
1722
1886
|
## -[**SMSAvailablePhoneNumberEntityListing**](SMSAvailablePhoneNumberEntityListing.html) get_routing_sms_availablephonenumbers(country_code, phone_number_type, opts)
|
1723
1887
|
|
1888
|
+
|
1889
|
+
|
1724
1890
|
Get a list of available phone numbers for SMS provisioning.
|
1725
1891
|
|
1726
1892
|
This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
|
1727
1893
|
|
1728
1894
|
Wraps GET /api/v2/routing/sms/availablephonenumbers
|
1729
1895
|
|
1896
|
+
Requires ANY permissions:
|
1897
|
+
|
1898
|
+
* sms:phoneNumber:add
|
1899
|
+
|
1730
1900
|
|
1731
1901
|
### Example
|
1732
1902
|
~~~ruby
|
@@ -1795,12 +1965,18 @@ Name | Type | Description | Notes
|
|
1795
1965
|
|
1796
1966
|
## -[**SmsPhoneNumber**](SmsPhoneNumber.html) get_routing_sms_phonenumber(address_id)
|
1797
1967
|
|
1968
|
+
|
1969
|
+
|
1798
1970
|
Get a phone number provisioned for SMS.
|
1799
1971
|
|
1800
1972
|
|
1801
1973
|
|
1802
1974
|
Wraps GET /api/v2/routing/sms/phonenumbers/{addressId}
|
1803
1975
|
|
1976
|
+
Requires ANY permissions:
|
1977
|
+
|
1978
|
+
* sms:phoneNumber:view
|
1979
|
+
|
1804
1980
|
|
1805
1981
|
### Example
|
1806
1982
|
~~~ruby
|
@@ -1854,12 +2030,18 @@ Name | Type | Description | Notes
|
|
1854
2030
|
|
1855
2031
|
## -[**SmsPhoneNumberEntityListing**](SmsPhoneNumberEntityListing.html) get_routing_sms_phonenumbers(opts)
|
1856
2032
|
|
2033
|
+
|
2034
|
+
|
1857
2035
|
Get a list of provisioned phone numbers.
|
1858
2036
|
|
1859
2037
|
|
1860
2038
|
|
1861
2039
|
Wraps GET /api/v2/routing/sms/phonenumbers
|
1862
2040
|
|
2041
|
+
Requires ANY permissions:
|
2042
|
+
|
2043
|
+
* sms:phoneNumber:view
|
2044
|
+
|
1863
2045
|
|
1864
2046
|
### Example
|
1865
2047
|
~~~ruby
|
@@ -1922,12 +2104,18 @@ Name | Type | Description | Notes
|
|
1922
2104
|
|
1923
2105
|
## -[**Utilization**](Utilization.html) get_routing_utilization
|
1924
2106
|
|
2107
|
+
|
2108
|
+
|
1925
2109
|
Get the utilization settings.
|
1926
2110
|
|
1927
2111
|
|
1928
2112
|
|
1929
2113
|
Wraps GET /api/v2/routing/utilization
|
1930
2114
|
|
2115
|
+
Requires ANY permissions:
|
2116
|
+
|
2117
|
+
* routing:utilization:manage* routing:utilization:view
|
2118
|
+
|
1931
2119
|
|
1932
2120
|
### Example
|
1933
2121
|
~~~ruby
|
@@ -1975,12 +2163,18 @@ This endpoint does not need any parameter.
|
|
1975
2163
|
|
1976
2164
|
## -[**WrapupCode**](WrapupCode.html) get_routing_wrapupcode(code_id)
|
1977
2165
|
|
2166
|
+
|
2167
|
+
|
1978
2168
|
Get details about this wrap-up code.
|
1979
2169
|
|
1980
2170
|
|
1981
2171
|
|
1982
2172
|
Wraps GET /api/v2/routing/wrapupcodes/{codeId}
|
1983
2173
|
|
2174
|
+
Requires ANY permissions:
|
2175
|
+
|
2176
|
+
* routing:wrapupCode:view
|
2177
|
+
|
1984
2178
|
|
1985
2179
|
### Example
|
1986
2180
|
~~~ruby
|
@@ -2034,12 +2228,18 @@ Name | Type | Description | Notes
|
|
2034
2228
|
|
2035
2229
|
## -[**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_routing_wrapupcodes(opts)
|
2036
2230
|
|
2231
|
+
|
2232
|
+
|
2037
2233
|
Get list of wrapup codes.
|
2038
2234
|
|
2039
2235
|
|
2040
2236
|
|
2041
2237
|
Wraps GET /api/v2/routing/wrapupcodes
|
2042
2238
|
|
2239
|
+
Requires ANY permissions:
|
2240
|
+
|
2241
|
+
* routing:wrapupCode:view
|
2242
|
+
|
2043
2243
|
|
2044
2244
|
### Example
|
2045
2245
|
~~~ruby
|
@@ -2100,12 +2300,18 @@ Name | Type | Description | Notes
|
|
2100
2300
|
|
2101
2301
|
## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
|
2102
2302
|
|
2303
|
+
|
2304
|
+
|
2103
2305
|
List routing language for user
|
2104
2306
|
|
2105
2307
|
|
2106
2308
|
|
2107
2309
|
Wraps GET /api/v2/users/{userId}/routinglanguages
|
2108
2310
|
|
2311
|
+
Requires NO permissions:
|
2312
|
+
|
2313
|
+
|
2314
|
+
|
2109
2315
|
|
2110
2316
|
### Example
|
2111
2317
|
~~~ruby
|
@@ -2167,12 +2373,18 @@ Name | Type | Description | Notes
|
|
2167
2373
|
|
2168
2374
|
## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
|
2169
2375
|
|
2376
|
+
|
2377
|
+
|
2170
2378
|
List routing skills for user
|
2171
2379
|
|
2172
2380
|
|
2173
2381
|
|
2174
2382
|
Wraps GET /api/v2/users/{userId}/routingskills
|
2175
2383
|
|
2384
|
+
Requires NO permissions:
|
2385
|
+
|
2386
|
+
|
2387
|
+
|
2176
2388
|
|
2177
2389
|
### Example
|
2178
2390
|
~~~ruby
|
@@ -2234,12 +2446,18 @@ Name | Type | Description | Notes
|
|
2234
2446
|
|
2235
2447
|
## -[**QueueMember**](QueueMember.html) patch_routing_queue_user(queue_id, member_id, body)
|
2236
2448
|
|
2449
|
+
|
2450
|
+
|
2237
2451
|
Update the ring number of joined status for a User in a Queue
|
2238
2452
|
|
2239
2453
|
|
2240
2454
|
|
2241
2455
|
Wraps PATCH /api/v2/routing/queues/{queueId}/users/{memberId}
|
2242
2456
|
|
2457
|
+
Requires ANY permissions:
|
2458
|
+
|
2459
|
+
* routing:queue:edit
|
2460
|
+
|
2243
2461
|
|
2244
2462
|
### Example
|
2245
2463
|
~~~ruby
|
@@ -2299,12 +2517,18 @@ Name | Type | Description | Notes
|
|
2299
2517
|
|
2300
2518
|
## -[**QueueMemberEntityListing**](QueueMemberEntityListing.html) patch_routing_queue_users(queue_id, body)
|
2301
2519
|
|
2520
|
+
|
2521
|
+
|
2302
2522
|
Join or unjoin a set of users for a queue
|
2303
2523
|
|
2304
2524
|
|
2305
2525
|
|
2306
2526
|
Wraps PATCH /api/v2/routing/queues/{queueId}/users
|
2307
2527
|
|
2528
|
+
Requires ANY permissions:
|
2529
|
+
|
2530
|
+
* routing:queue:edit
|
2531
|
+
|
2308
2532
|
|
2309
2533
|
### Example
|
2310
2534
|
~~~ruby
|
@@ -2361,12 +2585,18 @@ Name | Type | Description | Notes
|
|
2361
2585
|
|
2362
2586
|
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
|
2363
2587
|
|
2588
|
+
|
2589
|
+
|
2364
2590
|
Update routing language proficiency or state.
|
2365
2591
|
|
2366
2592
|
|
2367
2593
|
|
2368
2594
|
Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId}
|
2369
2595
|
|
2596
|
+
Requires ANY permissions:
|
2597
|
+
|
2598
|
+
* routing:skill:assign* admin
|
2599
|
+
|
2370
2600
|
|
2371
2601
|
### Example
|
2372
2602
|
~~~ruby
|
@@ -2426,12 +2656,18 @@ Name | Type | Description | Notes
|
|
2426
2656
|
|
2427
2657
|
## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
|
2428
2658
|
|
2659
|
+
|
2660
|
+
|
2429
2661
|
Query for queue observations
|
2430
2662
|
|
2431
2663
|
|
2432
2664
|
|
2433
2665
|
Wraps POST /api/v2/analytics/queues/observations/query
|
2434
2666
|
|
2667
|
+
Requires ANY permissions:
|
2668
|
+
|
2669
|
+
* analytics:queueObservation:view
|
2670
|
+
|
2435
2671
|
|
2436
2672
|
### Example
|
2437
2673
|
~~~ruby
|
@@ -2485,12 +2721,18 @@ Name | Type | Description | Notes
|
|
2485
2721
|
|
2486
2722
|
## -[**InboundRoute**](InboundRoute.html) post_routing_email_domain_routes(domain_name, body)
|
2487
2723
|
|
2724
|
+
|
2725
|
+
|
2488
2726
|
Create a route
|
2489
2727
|
|
2490
2728
|
|
2491
2729
|
|
2492
2730
|
Wraps POST /api/v2/routing/email/domains/{domainName}/routes
|
2493
2731
|
|
2732
|
+
Requires ANY permissions:
|
2733
|
+
|
2734
|
+
* routing:email:manage
|
2735
|
+
|
2494
2736
|
|
2495
2737
|
### Example
|
2496
2738
|
~~~ruby
|
@@ -2547,12 +2789,18 @@ Name | Type | Description | Notes
|
|
2547
2789
|
|
2548
2790
|
## -[**InboundDomain**](InboundDomain.html) post_routing_email_domains(body)
|
2549
2791
|
|
2792
|
+
|
2793
|
+
|
2550
2794
|
Create a domain
|
2551
2795
|
|
2552
2796
|
|
2553
2797
|
|
2554
2798
|
Wraps POST /api/v2/routing/email/domains
|
2555
2799
|
|
2800
|
+
Requires ANY permissions:
|
2801
|
+
|
2802
|
+
* routing:email:manage
|
2803
|
+
|
2556
2804
|
|
2557
2805
|
### Example
|
2558
2806
|
~~~ruby
|
@@ -2606,12 +2854,18 @@ Name | Type | Description | Notes
|
|
2606
2854
|
|
2607
2855
|
## -[**Language**](Language.html) post_routing_languages(body)
|
2608
2856
|
|
2857
|
+
|
2858
|
+
|
2609
2859
|
Create Language
|
2610
2860
|
|
2611
2861
|
|
2612
2862
|
|
2613
2863
|
Wraps POST /api/v2/routing/languages
|
2614
2864
|
|
2865
|
+
Requires ANY permissions:
|
2866
|
+
|
2867
|
+
* routing:skill:manage
|
2868
|
+
|
2615
2869
|
|
2616
2870
|
### Example
|
2617
2871
|
~~~ruby
|
@@ -2665,12 +2919,18 @@ Name | Type | Description | Notes
|
|
2665
2919
|
|
2666
2920
|
## -String** post_routing_queue_users(queue_id, body, opts)
|
2667
2921
|
|
2922
|
+
|
2923
|
+
|
2668
2924
|
Bulk add or delete up to 100 queue members
|
2669
2925
|
|
2670
2926
|
|
2671
2927
|
|
2672
2928
|
Wraps POST /api/v2/routing/queues/{queueId}/users
|
2673
2929
|
|
2930
|
+
Requires ANY permissions:
|
2931
|
+
|
2932
|
+
* routing:queue:edit
|
2933
|
+
|
2674
2934
|
|
2675
2935
|
### Example
|
2676
2936
|
~~~ruby
|
@@ -2731,12 +2991,18 @@ Name | Type | Description | Notes
|
|
2731
2991
|
|
2732
2992
|
## -[**Array<WrapupCode>**](WrapupCode.html) post_routing_queue_wrapupcodes(queue_id, body)
|
2733
2993
|
|
2994
|
+
|
2995
|
+
|
2734
2996
|
Add up to 100 wrap-up codes to a queue
|
2735
2997
|
|
2736
2998
|
|
2737
2999
|
|
2738
3000
|
Wraps POST /api/v2/routing/queues/{queueId}/wrapupcodes
|
2739
3001
|
|
3002
|
+
Requires ANY permissions:
|
3003
|
+
|
3004
|
+
* routing:queue:edit
|
3005
|
+
|
2740
3006
|
|
2741
3007
|
### Example
|
2742
3008
|
~~~ruby
|
@@ -2793,12 +3059,18 @@ Name | Type | Description | Notes
|
|
2793
3059
|
|
2794
3060
|
## -[**Queue**](Queue.html) post_routing_queues(body)
|
2795
3061
|
|
3062
|
+
|
3063
|
+
|
2796
3064
|
Create queue
|
2797
3065
|
|
2798
3066
|
|
2799
3067
|
|
2800
3068
|
Wraps POST /api/v2/routing/queues
|
2801
3069
|
|
3070
|
+
Requires ANY permissions:
|
3071
|
+
|
3072
|
+
* routing:queue:add
|
3073
|
+
|
2802
3074
|
|
2803
3075
|
### Example
|
2804
3076
|
~~~ruby
|
@@ -2852,12 +3124,18 @@ Name | Type | Description | Notes
|
|
2852
3124
|
|
2853
3125
|
## -[**RoutingSkill**](RoutingSkill.html) post_routing_skills(body)
|
2854
3126
|
|
3127
|
+
|
3128
|
+
|
2855
3129
|
Create Skill
|
2856
3130
|
|
2857
3131
|
|
2858
3132
|
|
2859
3133
|
Wraps POST /api/v2/routing/skills
|
2860
3134
|
|
3135
|
+
Requires ANY permissions:
|
3136
|
+
|
3137
|
+
* routing:skill:manage
|
3138
|
+
|
2861
3139
|
|
2862
3140
|
### Example
|
2863
3141
|
~~~ruby
|
@@ -2911,12 +3189,18 @@ Name | Type | Description | Notes
|
|
2911
3189
|
|
2912
3190
|
## -[**SmsPhoneNumber**](SmsPhoneNumber.html) post_routing_sms_addresses(body)
|
2913
3191
|
|
3192
|
+
|
3193
|
+
|
2914
3194
|
Provision an Address for SMS
|
2915
3195
|
|
2916
3196
|
|
2917
3197
|
|
2918
3198
|
Wraps POST /api/v2/routing/sms/addresses
|
2919
3199
|
|
3200
|
+
Requires ANY permissions:
|
3201
|
+
|
3202
|
+
* sms:phoneNumber:add
|
3203
|
+
|
2920
3204
|
|
2921
3205
|
### Example
|
2922
3206
|
~~~ruby
|
@@ -2970,12 +3254,18 @@ Name | Type | Description | Notes
|
|
2970
3254
|
|
2971
3255
|
## -[**SmsPhoneNumber**](SmsPhoneNumber.html) post_routing_sms_phonenumbers(body)
|
2972
3256
|
|
3257
|
+
|
3258
|
+
|
2973
3259
|
Provision a phone number for SMS
|
2974
3260
|
|
2975
3261
|
|
2976
3262
|
|
2977
3263
|
Wraps POST /api/v2/routing/sms/phonenumbers
|
2978
3264
|
|
3265
|
+
Requires ANY permissions:
|
3266
|
+
|
3267
|
+
* sms:phoneNumber:add
|
3268
|
+
|
2979
3269
|
|
2980
3270
|
### Example
|
2981
3271
|
~~~ruby
|
@@ -3029,12 +3319,18 @@ Name | Type | Description | Notes
|
|
3029
3319
|
|
3030
3320
|
## -[**WrapupCode**](WrapupCode.html) post_routing_wrapupcodes(body)
|
3031
3321
|
|
3322
|
+
|
3323
|
+
|
3032
3324
|
Create a wrap-up code
|
3033
3325
|
|
3034
3326
|
|
3035
3327
|
|
3036
3328
|
Wraps POST /api/v2/routing/wrapupcodes
|
3037
3329
|
|
3330
|
+
Requires ANY permissions:
|
3331
|
+
|
3332
|
+
* routing:wrapupCode:add
|
3333
|
+
|
3038
3334
|
|
3039
3335
|
### Example
|
3040
3336
|
~~~ruby
|
@@ -3088,12 +3384,18 @@ Name | Type | Description | Notes
|
|
3088
3384
|
|
3089
3385
|
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
|
3090
3386
|
|
3387
|
+
|
3388
|
+
|
3091
3389
|
Add routing language to user
|
3092
3390
|
|
3093
3391
|
|
3094
3392
|
|
3095
3393
|
Wraps POST /api/v2/users/{userId}/routinglanguages
|
3096
3394
|
|
3395
|
+
Requires ANY permissions:
|
3396
|
+
|
3397
|
+
* routing:skill:assign* admin
|
3398
|
+
|
3097
3399
|
|
3098
3400
|
### Example
|
3099
3401
|
~~~ruby
|
@@ -3150,12 +3452,18 @@ Name | Type | Description | Notes
|
|
3150
3452
|
|
3151
3453
|
## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
|
3152
3454
|
|
3455
|
+
|
3456
|
+
|
3153
3457
|
Add routing skill to user
|
3154
3458
|
|
3155
3459
|
|
3156
3460
|
|
3157
3461
|
Wraps POST /api/v2/users/{userId}/routingskills
|
3158
3462
|
|
3463
|
+
Requires ANY permissions:
|
3464
|
+
|
3465
|
+
* routing:skill:assign* admin
|
3466
|
+
|
3159
3467
|
|
3160
3468
|
### Example
|
3161
3469
|
~~~ruby
|
@@ -3212,12 +3520,18 @@ Name | Type | Description | Notes
|
|
3212
3520
|
|
3213
3521
|
## -[**InboundRoute**](InboundRoute.html) put_routing_email_domain_route(domain_name, route_id, body)
|
3214
3522
|
|
3523
|
+
|
3524
|
+
|
3215
3525
|
Update a route
|
3216
3526
|
|
3217
3527
|
|
3218
3528
|
|
3219
3529
|
Wraps PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
3220
3530
|
|
3531
|
+
Requires ANY permissions:
|
3532
|
+
|
3533
|
+
* routing:email:manage
|
3534
|
+
|
3221
3535
|
|
3222
3536
|
### Example
|
3223
3537
|
~~~ruby
|
@@ -3277,12 +3591,18 @@ Name | Type | Description | Notes
|
|
3277
3591
|
|
3278
3592
|
## -[**Recipient**](Recipient.html) put_routing_message_recipient(recipient_id, body)
|
3279
3593
|
|
3594
|
+
|
3595
|
+
|
3280
3596
|
Update a recipient
|
3281
3597
|
|
3282
3598
|
|
3283
3599
|
|
3284
3600
|
Wraps PUT /api/v2/routing/message/recipients/{recipientId}
|
3285
3601
|
|
3602
|
+
Requires ANY permissions:
|
3603
|
+
|
3604
|
+
* routing:message:manage
|
3605
|
+
|
3286
3606
|
|
3287
3607
|
### Example
|
3288
3608
|
~~~ruby
|
@@ -3339,12 +3659,18 @@ Name | Type | Description | Notes
|
|
3339
3659
|
|
3340
3660
|
## -[**Queue**](Queue.html) put_routing_queue(queue_id, body)
|
3341
3661
|
|
3662
|
+
|
3663
|
+
|
3342
3664
|
Update a queue
|
3343
3665
|
|
3344
3666
|
|
3345
3667
|
|
3346
3668
|
Wraps PUT /api/v2/routing/queues/{queueId}
|
3347
3669
|
|
3670
|
+
Requires ANY permissions:
|
3671
|
+
|
3672
|
+
* routing:queue:edit
|
3673
|
+
|
3348
3674
|
|
3349
3675
|
### Example
|
3350
3676
|
~~~ruby
|
@@ -3401,12 +3727,18 @@ Name | Type | Description | Notes
|
|
3401
3727
|
|
3402
3728
|
## -[**SmsPhoneNumber**](SmsPhoneNumber.html) put_routing_sms_phonenumber(address_id, body)
|
3403
3729
|
|
3730
|
+
|
3731
|
+
|
3404
3732
|
Update a phone number provisioned for SMS.
|
3405
3733
|
|
3406
3734
|
|
3407
3735
|
|
3408
3736
|
Wraps PUT /api/v2/routing/sms/phonenumbers/{addressId}
|
3409
3737
|
|
3738
|
+
Requires ANY permissions:
|
3739
|
+
|
3740
|
+
* sms:phoneNumber:edit
|
3741
|
+
|
3410
3742
|
|
3411
3743
|
### Example
|
3412
3744
|
~~~ruby
|
@@ -3463,12 +3795,18 @@ Name | Type | Description | Notes
|
|
3463
3795
|
|
3464
3796
|
## -[**Utilization**](Utilization.html) put_routing_utilization(body)
|
3465
3797
|
|
3798
|
+
|
3799
|
+
|
3466
3800
|
Update the utilization settings.
|
3467
3801
|
|
3468
3802
|
|
3469
3803
|
|
3470
3804
|
Wraps PUT /api/v2/routing/utilization
|
3471
3805
|
|
3806
|
+
Requires ANY permissions:
|
3807
|
+
|
3808
|
+
* routing:utilization:manage
|
3809
|
+
|
3472
3810
|
|
3473
3811
|
### Example
|
3474
3812
|
~~~ruby
|
@@ -3522,12 +3860,18 @@ Name | Type | Description | Notes
|
|
3522
3860
|
|
3523
3861
|
## -[**WrapupCode**](WrapupCode.html) put_routing_wrapupcode(code_id, body)
|
3524
3862
|
|
3863
|
+
|
3864
|
+
|
3525
3865
|
Update wrap-up code
|
3526
3866
|
|
3527
3867
|
|
3528
3868
|
|
3529
3869
|
Wraps PUT /api/v2/routing/wrapupcodes/{codeId}
|
3530
3870
|
|
3871
|
+
Requires ANY permissions:
|
3872
|
+
|
3873
|
+
* routing:wrapupCode:edit
|
3874
|
+
|
3531
3875
|
|
3532
3876
|
### Example
|
3533
3877
|
~~~ruby
|
@@ -3584,12 +3928,18 @@ Name | Type | Description | Notes
|
|
3584
3928
|
|
3585
3929
|
## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
|
3586
3930
|
|
3931
|
+
|
3932
|
+
|
3587
3933
|
Update routing skill proficiency or state.
|
3588
3934
|
|
3589
3935
|
|
3590
3936
|
|
3591
3937
|
Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
|
3592
3938
|
|
3939
|
+
Requires ANY permissions:
|
3940
|
+
|
3941
|
+
* routing:skill:assign* admin
|
3942
|
+
|
3593
3943
|
|
3594
3944
|
### Example
|
3595
3945
|
~~~ruby
|