purecloudplatformclientv2 34.0.0 → 35.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
@@ -13,9 +13,9 @@ title: CredentialInfoListing
|
|
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: CredentialTypeListing
|
|
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/DIDEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: DIDEntityListing
|
|
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: DIDPoolEntityListing
|
|
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: DataTableRowEntityListing
|
|
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: DataTablesDomainEntityListing
|
|
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: DependencyObjectEntityListing
|
|
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: DependencyTypeEntityListing
|
|
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: DialerEventEntityListing
|
|
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: DirectoryUserDevicesListing
|
|
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: DncListEntityListing
|
|
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: DocumentAuditEntityListing
|
|
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: DocumentEntityListing
|
|
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: DomainEdgeSoftwareVersionDtoEntityListing
|
|
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/DomainEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: DomainEntityListing
|
|
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: DomainEntityListingEvaluationForm
|
|
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: DomainEntityListingQueryResult
|
|
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: DomainEntityListingSurveyForm
|
|
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
|
|
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
|
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleCreate
|
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleUpdate
|
|
15
15
|
| **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
|
16
16
|
| **user_count** | **Integer** | | [optional] |
|
17
17
|
| **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
|
18
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
data/docs/EdgeEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: EdgeEntityListing
|
|
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: EdgeGroupEntityListing
|
|
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: EdgeLineEntityListing
|
|
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: EmailConversationEntityListing
|
|
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/EmailMessageListing.md
CHANGED
@@ -13,9 +13,9 @@ title: EmailMessageListing
|
|
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: EmergencyGroupListing
|
|
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: EncryptionKeyEntityListing
|
|
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: EndpointEntityListing
|
|
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: EvaluationEntityListing
|
|
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: EvaluationFormEntityListing
|
|
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: EvaluatorActivityEntityListing
|
|
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: ExtensionEntityListing
|
|
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: ExtensionPoolEntityListing
|
|
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/ExternalContactsApi.md
CHANGED
@@ -36,7 +36,7 @@ Method | Description
|
|
36
36
|
[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
|
37
37
|
[**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
|
38
38
|
[**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization
|
39
|
-
[**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an
|
39
|
+
[**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an External Organization
|
40
40
|
[**put_externalcontacts_relationship**](ExternalContactsApi.html#put_externalcontacts_relationship) | Update a relationship
|
41
41
|
{: class="table table-striped"}
|
42
42
|
|
@@ -44,12 +44,18 @@ Method | Description
|
|
44
44
|
|
45
45
|
## - delete_externalcontacts_contact(contact_id)
|
46
46
|
|
47
|
+
|
48
|
+
|
47
49
|
Delete an external contact
|
48
50
|
|
49
51
|
|
50
52
|
|
51
53
|
Wraps DELETE /api/v2/externalcontacts/contacts/{contactId}
|
52
54
|
|
55
|
+
Requires ANY permissions:
|
56
|
+
|
57
|
+
* externalContacts:contact:delete
|
58
|
+
|
53
59
|
|
54
60
|
### Example
|
55
61
|
~~~ruby
|
@@ -102,12 +108,18 @@ nil (empty response body)
|
|
102
108
|
|
103
109
|
## - delete_externalcontacts_contact_note(contact_id, note_id)
|
104
110
|
|
111
|
+
|
112
|
+
|
105
113
|
Delete a note for an external contact
|
106
114
|
|
107
115
|
|
108
116
|
|
109
117
|
Wraps DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
|
110
118
|
|
119
|
+
Requires ANY permissions:
|
120
|
+
|
121
|
+
* externalContacts:contact:edit
|
122
|
+
|
111
123
|
|
112
124
|
### Example
|
113
125
|
~~~ruby
|
@@ -163,12 +175,18 @@ nil (empty response body)
|
|
163
175
|
|
164
176
|
## - delete_externalcontacts_organization(external_organization_id)
|
165
177
|
|
178
|
+
|
179
|
+
|
166
180
|
Delete an external organization
|
167
181
|
|
168
182
|
|
169
183
|
|
170
184
|
Wraps DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}
|
171
185
|
|
186
|
+
Requires ANY permissions:
|
187
|
+
|
188
|
+
* externalContacts:externalOrganization:delete
|
189
|
+
|
172
190
|
|
173
191
|
### Example
|
174
192
|
~~~ruby
|
@@ -221,12 +239,18 @@ nil (empty response body)
|
|
221
239
|
|
222
240
|
## - delete_externalcontacts_organization_note(external_organization_id, note_id)
|
223
241
|
|
242
|
+
|
243
|
+
|
224
244
|
Delete a note for an external organization
|
225
245
|
|
226
246
|
|
227
247
|
|
228
248
|
Wraps DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
|
229
249
|
|
250
|
+
Requires ANY permissions:
|
251
|
+
|
252
|
+
* externalContacts:externalOrganization:edit
|
253
|
+
|
230
254
|
|
231
255
|
### Example
|
232
256
|
~~~ruby
|
@@ -282,12 +306,18 @@ nil (empty response body)
|
|
282
306
|
|
283
307
|
## - delete_externalcontacts_organization_trustor(external_organization_id)
|
284
308
|
|
309
|
+
|
310
|
+
|
285
311
|
Unlink the Trustor for this External Organization
|
286
312
|
|
287
313
|
|
288
314
|
|
289
315
|
Wraps DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor
|
290
316
|
|
317
|
+
Requires ANY permissions:
|
318
|
+
|
319
|
+
* externalContacts:externalOrganization:edit
|
320
|
+
|
291
321
|
|
292
322
|
### Example
|
293
323
|
~~~ruby
|
@@ -340,12 +370,18 @@ nil (empty response body)
|
|
340
370
|
|
341
371
|
## - delete_externalcontacts_relationship(relationship_id)
|
342
372
|
|
373
|
+
|
374
|
+
|
343
375
|
Delete a relationship
|
344
376
|
|
345
377
|
|
346
378
|
|
347
379
|
Wraps DELETE /api/v2/externalcontacts/relationships/{relationshipId}
|
348
380
|
|
381
|
+
Requires ANY permissions:
|
382
|
+
|
383
|
+
* externalContacts:externalOrganization:edit
|
384
|
+
|
349
385
|
|
350
386
|
### Example
|
351
387
|
~~~ruby
|
@@ -398,12 +434,18 @@ nil (empty response body)
|
|
398
434
|
|
399
435
|
## -[**ExternalContact**](ExternalContact.html) get_externalcontacts_contact(contact_id, opts)
|
400
436
|
|
437
|
+
|
438
|
+
|
401
439
|
Fetch an external contact
|
402
440
|
|
403
441
|
|
404
442
|
|
405
443
|
Wraps GET /api/v2/externalcontacts/contacts/{contactId}
|
406
444
|
|
445
|
+
Requires ANY permissions:
|
446
|
+
|
447
|
+
* externalContacts:contact:view
|
448
|
+
|
407
449
|
|
408
450
|
### Example
|
409
451
|
~~~ruby
|
@@ -461,12 +503,18 @@ Name | Type | Description | Notes
|
|
461
503
|
|
462
504
|
## -[**Note**](Note.html) get_externalcontacts_contact_note(contact_id, note_id, opts)
|
463
505
|
|
506
|
+
|
507
|
+
|
464
508
|
Fetch a note for an external contact
|
465
509
|
|
466
510
|
|
467
511
|
|
468
512
|
Wraps GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
|
469
513
|
|
514
|
+
Requires ANY permissions:
|
515
|
+
|
516
|
+
* externalContacts:contact:view
|
517
|
+
|
470
518
|
|
471
519
|
### Example
|
472
520
|
~~~ruby
|
@@ -527,12 +575,18 @@ Name | Type | Description | Notes
|
|
527
575
|
|
528
576
|
## -[**NoteListing**](NoteListing.html) get_externalcontacts_contact_notes(contact_id, opts)
|
529
577
|
|
578
|
+
|
579
|
+
|
530
580
|
List notes for an external contact
|
531
581
|
|
532
582
|
|
533
583
|
|
534
584
|
Wraps GET /api/v2/externalcontacts/contacts/{contactId}/notes
|
535
585
|
|
586
|
+
Requires ANY permissions:
|
587
|
+
|
588
|
+
* externalContacts:contact:view
|
589
|
+
|
536
590
|
|
537
591
|
### Example
|
538
592
|
~~~ruby
|
@@ -596,12 +650,18 @@ Name | Type | Description | Notes
|
|
596
650
|
|
597
651
|
## -[**ContactListing**](ContactListing.html) get_externalcontacts_contacts(opts)
|
598
652
|
|
653
|
+
|
654
|
+
|
599
655
|
Search for external contacts
|
600
656
|
|
601
657
|
|
602
658
|
|
603
659
|
Wraps GET /api/v2/externalcontacts/contacts
|
604
660
|
|
661
|
+
Requires ANY permissions:
|
662
|
+
|
663
|
+
* externalContacts:contact:view
|
664
|
+
|
605
665
|
|
606
666
|
### Example
|
607
667
|
~~~ruby
|
@@ -664,12 +724,18 @@ Name | Type | Description | Notes
|
|
664
724
|
|
665
725
|
## -[**ExternalOrganization**](ExternalOrganization.html) get_externalcontacts_organization(external_organization_id, opts)
|
666
726
|
|
727
|
+
|
728
|
+
|
667
729
|
Fetch an external organization
|
668
730
|
|
669
731
|
|
670
732
|
|
671
733
|
Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}
|
672
734
|
|
735
|
+
Requires ANY permissions:
|
736
|
+
|
737
|
+
* externalContacts:externalOrganization:view
|
738
|
+
|
673
739
|
|
674
740
|
### Example
|
675
741
|
~~~ruby
|
@@ -729,12 +795,18 @@ Name | Type | Description | Notes
|
|
729
795
|
|
730
796
|
## -[**ContactListing**](ContactListing.html) get_externalcontacts_organization_contacts(external_organization_id, opts)
|
731
797
|
|
798
|
+
|
799
|
+
|
732
800
|
Search for external contacts in an external organization
|
733
801
|
|
734
802
|
|
735
803
|
|
736
804
|
Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts
|
737
805
|
|
806
|
+
Requires ANY permissions:
|
807
|
+
|
808
|
+
* externalContacts:contact:view
|
809
|
+
|
738
810
|
|
739
811
|
### Example
|
740
812
|
~~~ruby
|
@@ -800,12 +872,18 @@ Name | Type | Description | Notes
|
|
800
872
|
|
801
873
|
## -[**Note**](Note.html) get_externalcontacts_organization_note(external_organization_id, note_id, opts)
|
802
874
|
|
875
|
+
|
876
|
+
|
803
877
|
Fetch a note for an external organization
|
804
878
|
|
805
879
|
|
806
880
|
|
807
881
|
Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
|
808
882
|
|
883
|
+
Requires ANY permissions:
|
884
|
+
|
885
|
+
* externalContacts:externalOrganization:view
|
886
|
+
|
809
887
|
|
810
888
|
### Example
|
811
889
|
~~~ruby
|
@@ -866,12 +944,18 @@ Name | Type | Description | Notes
|
|
866
944
|
|
867
945
|
## -[**NoteListing**](NoteListing.html) get_externalcontacts_organization_notes(external_organization_id, opts)
|
868
946
|
|
947
|
+
|
948
|
+
|
869
949
|
List notes for an external organization
|
870
950
|
|
871
951
|
|
872
952
|
|
873
953
|
Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
|
874
954
|
|
955
|
+
Requires ANY permissions:
|
956
|
+
|
957
|
+
* externalContacts:externalOrganization:view
|
958
|
+
|
875
959
|
|
876
960
|
### Example
|
877
961
|
~~~ruby
|
@@ -935,12 +1019,18 @@ Name | Type | Description | Notes
|
|
935
1019
|
|
936
1020
|
## -[**RelationshipListing**](RelationshipListing.html) get_externalcontacts_organization_relationships(external_organization_id, opts)
|
937
1021
|
|
1022
|
+
|
1023
|
+
|
938
1024
|
Fetch a relationship for an external organization
|
939
1025
|
|
940
1026
|
|
941
1027
|
|
942
1028
|
Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships
|
943
1029
|
|
1030
|
+
Requires ANY permissions:
|
1031
|
+
|
1032
|
+
* externalContacts:externalOrganization:view
|
1033
|
+
|
944
1034
|
|
945
1035
|
### Example
|
946
1036
|
~~~ruby
|
@@ -1004,12 +1094,18 @@ Name | Type | Description | Notes
|
|
1004
1094
|
|
1005
1095
|
## -[**ExternalOrganizationListing**](ExternalOrganizationListing.html) get_externalcontacts_organizations(opts)
|
1006
1096
|
|
1097
|
+
|
1098
|
+
|
1007
1099
|
Search for external organizations
|
1008
1100
|
|
1009
1101
|
|
1010
1102
|
|
1011
1103
|
Wraps GET /api/v2/externalcontacts/organizations
|
1012
1104
|
|
1105
|
+
Requires ANY permissions:
|
1106
|
+
|
1107
|
+
* externalContacts:externalOrganization:view
|
1108
|
+
|
1013
1109
|
|
1014
1110
|
### Example
|
1015
1111
|
~~~ruby
|
@@ -1076,12 +1172,18 @@ Name | Type | Description | Notes
|
|
1076
1172
|
|
1077
1173
|
## -[**Relationship**](Relationship.html) get_externalcontacts_relationship(relationship_id, opts)
|
1078
1174
|
|
1175
|
+
|
1176
|
+
|
1079
1177
|
Fetch a relationship
|
1080
1178
|
|
1081
1179
|
|
1082
1180
|
|
1083
1181
|
Wraps GET /api/v2/externalcontacts/relationships/{relationshipId}
|
1084
1182
|
|
1183
|
+
Requires ANY permissions:
|
1184
|
+
|
1185
|
+
* externalContacts:externalOrganization:view
|
1186
|
+
|
1085
1187
|
|
1086
1188
|
### Example
|
1087
1189
|
~~~ruby
|
@@ -1139,12 +1241,18 @@ Name | Type | Description | Notes
|
|
1139
1241
|
|
1140
1242
|
## -[**ReverseWhitepagesLookupResult**](ReverseWhitepagesLookupResult.html) get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
|
1141
1243
|
|
1244
|
+
|
1245
|
+
|
1142
1246
|
Lookup contacts and externalOrganizations based on an attribute
|
1143
1247
|
|
1144
1248
|
|
1145
1249
|
|
1146
1250
|
Wraps GET /api/v2/externalcontacts/reversewhitepageslookup
|
1147
1251
|
|
1252
|
+
Requires ANY permissions:
|
1253
|
+
|
1254
|
+
* externalContacts:contact:view
|
1255
|
+
|
1148
1256
|
|
1149
1257
|
### Example
|
1150
1258
|
~~~ruby
|
@@ -1200,7 +1308,9 @@ Name | Type | Description | Notes
|
|
1200
1308
|
|
1201
1309
|
<a name="post_externalcontacts_contact_notes"></a>
|
1202
1310
|
|
1203
|
-
## -[**Note**](Note.html) post_externalcontacts_contact_notes(contact_id,
|
1311
|
+
## -[**Note**](Note.html) post_externalcontacts_contact_notes(contact_id, body)
|
1312
|
+
|
1313
|
+
|
1204
1314
|
|
1205
1315
|
Create a note for an external contact
|
1206
1316
|
|
@@ -1208,6 +1318,10 @@ Create a note for an external contact
|
|
1208
1318
|
|
1209
1319
|
Wraps POST /api/v2/externalcontacts/contacts/{contactId}/notes
|
1210
1320
|
|
1321
|
+
Requires ANY permissions:
|
1322
|
+
|
1323
|
+
* externalContacts:contact:edit
|
1324
|
+
|
1211
1325
|
|
1212
1326
|
### Example
|
1213
1327
|
~~~ruby
|
@@ -1228,13 +1342,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1228
1342
|
|
1229
1343
|
contact_id = "contact_id_example" # String | ExternalContact Id
|
1230
1344
|
|
1231
|
-
|
1232
|
-
|
1233
|
-
}
|
1345
|
+
body = PureCloud::Note.new # Note | ExternalContact
|
1346
|
+
|
1234
1347
|
|
1235
1348
|
begin
|
1236
1349
|
#Create a note for an external contact
|
1237
|
-
result = api_instance.post_externalcontacts_contact_notes(contact_id,
|
1350
|
+
result = api_instance.post_externalcontacts_contact_notes(contact_id, body)
|
1238
1351
|
p result
|
1239
1352
|
rescue PureCloud::ApiError => e
|
1240
1353
|
puts "Exception when calling ExternalContactsApi->post_externalcontacts_contact_notes: #{e}"
|
@@ -1246,7 +1359,7 @@ end
|
|
1246
1359
|
Name | Type | Description | Notes
|
1247
1360
|
------------- | ------------- | ------------- | -------------
|
1248
1361
|
**contact_id** | **String**| ExternalContact Id | |
|
1249
|
-
**body** | [**Note**](Note.html)| ExternalContact |
|
1362
|
+
**body** | [**Note**](Note.html)| ExternalContact | |
|
1250
1363
|
{: class="table table-striped"}
|
1251
1364
|
|
1252
1365
|
|
@@ -1263,7 +1376,9 @@ Name | Type | Description | Notes
|
|
1263
1376
|
|
1264
1377
|
<a name="post_externalcontacts_contacts"></a>
|
1265
1378
|
|
1266
|
-
## -[**ExternalContact**](ExternalContact.html) post_externalcontacts_contacts(
|
1379
|
+
## -[**ExternalContact**](ExternalContact.html) post_externalcontacts_contacts(body)
|
1380
|
+
|
1381
|
+
|
1267
1382
|
|
1268
1383
|
Create an external contact
|
1269
1384
|
|
@@ -1271,6 +1386,10 @@ Create an external contact
|
|
1271
1386
|
|
1272
1387
|
Wraps POST /api/v2/externalcontacts/contacts
|
1273
1388
|
|
1389
|
+
Requires ANY permissions:
|
1390
|
+
|
1391
|
+
* externalContacts:contact:add
|
1392
|
+
|
1274
1393
|
|
1275
1394
|
### Example
|
1276
1395
|
~~~ruby
|
@@ -1289,13 +1408,12 @@ end
|
|
1289
1408
|
|
1290
1409
|
api_instance = PureCloud::ExternalContactsApi.new
|
1291
1410
|
|
1292
|
-
|
1293
|
-
|
1294
|
-
}
|
1411
|
+
body = PureCloud::ExternalContact.new # ExternalContact | ExternalContact
|
1412
|
+
|
1295
1413
|
|
1296
1414
|
begin
|
1297
1415
|
#Create an external contact
|
1298
|
-
result = api_instance.post_externalcontacts_contacts(
|
1416
|
+
result = api_instance.post_externalcontacts_contacts(body)
|
1299
1417
|
p result
|
1300
1418
|
rescue PureCloud::ApiError => e
|
1301
1419
|
puts "Exception when calling ExternalContactsApi->post_externalcontacts_contacts: #{e}"
|
@@ -1306,7 +1424,7 @@ end
|
|
1306
1424
|
|
1307
1425
|
Name | Type | Description | Notes
|
1308
1426
|
------------- | ------------- | ------------- | -------------
|
1309
|
-
**body** | [**ExternalContact**](ExternalContact.html)| ExternalContact |
|
1427
|
+
**body** | [**ExternalContact**](ExternalContact.html)| ExternalContact | |
|
1310
1428
|
{: class="table table-striped"}
|
1311
1429
|
|
1312
1430
|
|
@@ -1323,7 +1441,9 @@ Name | Type | Description | Notes
|
|
1323
1441
|
|
1324
1442
|
<a name="post_externalcontacts_organization_notes"></a>
|
1325
1443
|
|
1326
|
-
## -[**Note**](Note.html) post_externalcontacts_organization_notes(external_organization_id,
|
1444
|
+
## -[**Note**](Note.html) post_externalcontacts_organization_notes(external_organization_id, body)
|
1445
|
+
|
1446
|
+
|
1327
1447
|
|
1328
1448
|
Create a note for an external organization
|
1329
1449
|
|
@@ -1331,6 +1451,10 @@ Create a note for an external organization
|
|
1331
1451
|
|
1332
1452
|
Wraps POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
|
1333
1453
|
|
1454
|
+
Requires ANY permissions:
|
1455
|
+
|
1456
|
+
* externalContacts:externalOrganization:edit
|
1457
|
+
|
1334
1458
|
|
1335
1459
|
### Example
|
1336
1460
|
~~~ruby
|
@@ -1351,13 +1475,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1351
1475
|
|
1352
1476
|
external_organization_id = "external_organization_id_example" # String | External Organization Id
|
1353
1477
|
|
1354
|
-
|
1355
|
-
|
1356
|
-
}
|
1478
|
+
body = PureCloud::Note.new # Note | ExternalContact
|
1479
|
+
|
1357
1480
|
|
1358
1481
|
begin
|
1359
1482
|
#Create a note for an external organization
|
1360
|
-
result = api_instance.post_externalcontacts_organization_notes(external_organization_id,
|
1483
|
+
result = api_instance.post_externalcontacts_organization_notes(external_organization_id, body)
|
1361
1484
|
p result
|
1362
1485
|
rescue PureCloud::ApiError => e
|
1363
1486
|
puts "Exception when calling ExternalContactsApi->post_externalcontacts_organization_notes: #{e}"
|
@@ -1369,7 +1492,7 @@ end
|
|
1369
1492
|
Name | Type | Description | Notes
|
1370
1493
|
------------- | ------------- | ------------- | -------------
|
1371
1494
|
**external_organization_id** | **String**| External Organization Id | |
|
1372
|
-
**body** | [**Note**](Note.html)| ExternalContact |
|
1495
|
+
**body** | [**Note**](Note.html)| ExternalContact | |
|
1373
1496
|
{: class="table table-striped"}
|
1374
1497
|
|
1375
1498
|
|
@@ -1386,7 +1509,9 @@ Name | Type | Description | Notes
|
|
1386
1509
|
|
1387
1510
|
<a name="post_externalcontacts_organizations"></a>
|
1388
1511
|
|
1389
|
-
## -[**ExternalOrganization**](ExternalOrganization.html) post_externalcontacts_organizations(
|
1512
|
+
## -[**ExternalOrganization**](ExternalOrganization.html) post_externalcontacts_organizations(body)
|
1513
|
+
|
1514
|
+
|
1390
1515
|
|
1391
1516
|
Create an external organization
|
1392
1517
|
|
@@ -1394,6 +1519,10 @@ Create an external organization
|
|
1394
1519
|
|
1395
1520
|
Wraps POST /api/v2/externalcontacts/organizations
|
1396
1521
|
|
1522
|
+
Requires ANY permissions:
|
1523
|
+
|
1524
|
+
* externalContacts:externalOrganization:add
|
1525
|
+
|
1397
1526
|
|
1398
1527
|
### Example
|
1399
1528
|
~~~ruby
|
@@ -1412,13 +1541,12 @@ end
|
|
1412
1541
|
|
1413
1542
|
api_instance = PureCloud::ExternalContactsApi.new
|
1414
1543
|
|
1415
|
-
|
1416
|
-
|
1417
|
-
}
|
1544
|
+
body = PureCloud::ExternalOrganization.new # ExternalOrganization | ExternalOrganization
|
1545
|
+
|
1418
1546
|
|
1419
1547
|
begin
|
1420
1548
|
#Create an external organization
|
1421
|
-
result = api_instance.post_externalcontacts_organizations(
|
1549
|
+
result = api_instance.post_externalcontacts_organizations(body)
|
1422
1550
|
p result
|
1423
1551
|
rescue PureCloud::ApiError => e
|
1424
1552
|
puts "Exception when calling ExternalContactsApi->post_externalcontacts_organizations: #{e}"
|
@@ -1429,7 +1557,7 @@ end
|
|
1429
1557
|
|
1430
1558
|
Name | Type | Description | Notes
|
1431
1559
|
------------- | ------------- | ------------- | -------------
|
1432
|
-
**body** | [**ExternalOrganization**](ExternalOrganization.html)| ExternalOrganization |
|
1560
|
+
**body** | [**ExternalOrganization**](ExternalOrganization.html)| ExternalOrganization | |
|
1433
1561
|
{: class="table table-striped"}
|
1434
1562
|
|
1435
1563
|
|
@@ -1446,7 +1574,9 @@ Name | Type | Description | Notes
|
|
1446
1574
|
|
1447
1575
|
<a name="post_externalcontacts_relationships"></a>
|
1448
1576
|
|
1449
|
-
## -[**Relationship**](Relationship.html) post_externalcontacts_relationships(
|
1577
|
+
## -[**Relationship**](Relationship.html) post_externalcontacts_relationships(body)
|
1578
|
+
|
1579
|
+
|
1450
1580
|
|
1451
1581
|
Create a relationship
|
1452
1582
|
|
@@ -1454,6 +1584,10 @@ Create a relationship
|
|
1454
1584
|
|
1455
1585
|
Wraps POST /api/v2/externalcontacts/relationships
|
1456
1586
|
|
1587
|
+
Requires ANY permissions:
|
1588
|
+
|
1589
|
+
* externalContacts:externalOrganization:edit
|
1590
|
+
|
1457
1591
|
|
1458
1592
|
### Example
|
1459
1593
|
~~~ruby
|
@@ -1472,13 +1606,12 @@ end
|
|
1472
1606
|
|
1473
1607
|
api_instance = PureCloud::ExternalContactsApi.new
|
1474
1608
|
|
1475
|
-
|
1476
|
-
|
1477
|
-
}
|
1609
|
+
body = PureCloud::Relationship.new # Relationship | Relationship
|
1610
|
+
|
1478
1611
|
|
1479
1612
|
begin
|
1480
1613
|
#Create a relationship
|
1481
|
-
result = api_instance.post_externalcontacts_relationships(
|
1614
|
+
result = api_instance.post_externalcontacts_relationships(body)
|
1482
1615
|
p result
|
1483
1616
|
rescue PureCloud::ApiError => e
|
1484
1617
|
puts "Exception when calling ExternalContactsApi->post_externalcontacts_relationships: #{e}"
|
@@ -1489,7 +1622,7 @@ end
|
|
1489
1622
|
|
1490
1623
|
Name | Type | Description | Notes
|
1491
1624
|
------------- | ------------- | ------------- | -------------
|
1492
|
-
**body** | [**Relationship**](Relationship.html)| Relationship |
|
1625
|
+
**body** | [**Relationship**](Relationship.html)| Relationship | |
|
1493
1626
|
{: class="table table-striped"}
|
1494
1627
|
|
1495
1628
|
|
@@ -1506,7 +1639,9 @@ Name | Type | Description | Notes
|
|
1506
1639
|
|
1507
1640
|
<a name="put_externalcontacts_contact"></a>
|
1508
1641
|
|
1509
|
-
## -[**ExternalContact**](ExternalContact.html) put_externalcontacts_contact(contact_id,
|
1642
|
+
## -[**ExternalContact**](ExternalContact.html) put_externalcontacts_contact(contact_id, body)
|
1643
|
+
|
1644
|
+
|
1510
1645
|
|
1511
1646
|
Update an external contact
|
1512
1647
|
|
@@ -1514,6 +1649,10 @@ Update an external contact
|
|
1514
1649
|
|
1515
1650
|
Wraps PUT /api/v2/externalcontacts/contacts/{contactId}
|
1516
1651
|
|
1652
|
+
Requires ANY permissions:
|
1653
|
+
|
1654
|
+
* externalContacts:contact:edit
|
1655
|
+
|
1517
1656
|
|
1518
1657
|
### Example
|
1519
1658
|
~~~ruby
|
@@ -1534,13 +1673,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1534
1673
|
|
1535
1674
|
contact_id = "contact_id_example" # String | ExternalContact ID
|
1536
1675
|
|
1537
|
-
|
1538
|
-
|
1539
|
-
}
|
1676
|
+
body = PureCloud::ExternalContact.new # ExternalContact | ExternalContact
|
1677
|
+
|
1540
1678
|
|
1541
1679
|
begin
|
1542
1680
|
#Update an external contact
|
1543
|
-
result = api_instance.put_externalcontacts_contact(contact_id,
|
1681
|
+
result = api_instance.put_externalcontacts_contact(contact_id, body)
|
1544
1682
|
p result
|
1545
1683
|
rescue PureCloud::ApiError => e
|
1546
1684
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_contact: #{e}"
|
@@ -1552,7 +1690,7 @@ end
|
|
1552
1690
|
Name | Type | Description | Notes
|
1553
1691
|
------------- | ------------- | ------------- | -------------
|
1554
1692
|
**contact_id** | **String**| ExternalContact ID | |
|
1555
|
-
**body** | [**ExternalContact**](ExternalContact.html)| ExternalContact |
|
1693
|
+
**body** | [**ExternalContact**](ExternalContact.html)| ExternalContact | |
|
1556
1694
|
{: class="table table-striped"}
|
1557
1695
|
|
1558
1696
|
|
@@ -1569,7 +1707,9 @@ Name | Type | Description | Notes
|
|
1569
1707
|
|
1570
1708
|
<a name="put_externalcontacts_contact_note"></a>
|
1571
1709
|
|
1572
|
-
## -[**Note**](Note.html) put_externalcontacts_contact_note(contact_id, note_id,
|
1710
|
+
## -[**Note**](Note.html) put_externalcontacts_contact_note(contact_id, note_id, body)
|
1711
|
+
|
1712
|
+
|
1573
1713
|
|
1574
1714
|
Update a note for an external contact
|
1575
1715
|
|
@@ -1577,6 +1717,10 @@ Update a note for an external contact
|
|
1577
1717
|
|
1578
1718
|
Wraps PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
|
1579
1719
|
|
1720
|
+
Requires ANY permissions:
|
1721
|
+
|
1722
|
+
* externalContacts:contact:edit
|
1723
|
+
|
1580
1724
|
|
1581
1725
|
### Example
|
1582
1726
|
~~~ruby
|
@@ -1599,13 +1743,12 @@ contact_id = "contact_id_example" # String | ExternalContact Id
|
|
1599
1743
|
|
1600
1744
|
note_id = "note_id_example" # String | Note Id
|
1601
1745
|
|
1602
|
-
|
1603
|
-
|
1604
|
-
}
|
1746
|
+
body = PureCloud::Note.new # Note | Note
|
1747
|
+
|
1605
1748
|
|
1606
1749
|
begin
|
1607
1750
|
#Update a note for an external contact
|
1608
|
-
result = api_instance.put_externalcontacts_contact_note(contact_id, note_id,
|
1751
|
+
result = api_instance.put_externalcontacts_contact_note(contact_id, note_id, body)
|
1609
1752
|
p result
|
1610
1753
|
rescue PureCloud::ApiError => e
|
1611
1754
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_contact_note: #{e}"
|
@@ -1618,7 +1761,7 @@ Name | Type | Description | Notes
|
|
1618
1761
|
------------- | ------------- | ------------- | -------------
|
1619
1762
|
**contact_id** | **String**| ExternalContact Id | |
|
1620
1763
|
**note_id** | **String**| Note Id | |
|
1621
|
-
**body** | [**Note**](Note.html)| Note |
|
1764
|
+
**body** | [**Note**](Note.html)| Note | |
|
1622
1765
|
{: class="table table-striped"}
|
1623
1766
|
|
1624
1767
|
|
@@ -1635,7 +1778,9 @@ Name | Type | Description | Notes
|
|
1635
1778
|
|
1636
1779
|
<a name="put_externalcontacts_conversation"></a>
|
1637
1780
|
|
1638
|
-
## - put_externalcontacts_conversation(conversation_id,
|
1781
|
+
## - put_externalcontacts_conversation(conversation_id, body)
|
1782
|
+
|
1783
|
+
|
1639
1784
|
|
1640
1785
|
Associate an external contact with a conversation
|
1641
1786
|
|
@@ -1643,6 +1788,10 @@ Associate an external contact with a conversation
|
|
1643
1788
|
|
1644
1789
|
Wraps PUT /api/v2/externalcontacts/conversations/{conversationId}
|
1645
1790
|
|
1791
|
+
Requires ANY permissions:
|
1792
|
+
|
1793
|
+
* externalContacts:conversation:associate
|
1794
|
+
|
1646
1795
|
|
1647
1796
|
### Example
|
1648
1797
|
~~~ruby
|
@@ -1663,13 +1812,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1663
1812
|
|
1664
1813
|
conversation_id = "conversation_id_example" # String | Conversation ID
|
1665
1814
|
|
1666
|
-
|
1667
|
-
|
1668
|
-
}
|
1815
|
+
body = PureCloud::ConversationAssociation.new # ConversationAssociation | ConversationAssociation
|
1816
|
+
|
1669
1817
|
|
1670
1818
|
begin
|
1671
1819
|
#Associate an external contact with a conversation
|
1672
|
-
api_instance.put_externalcontacts_conversation(conversation_id,
|
1820
|
+
api_instance.put_externalcontacts_conversation(conversation_id, body)
|
1673
1821
|
rescue PureCloud::ApiError => e
|
1674
1822
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_conversation: #{e}"
|
1675
1823
|
end
|
@@ -1680,7 +1828,7 @@ end
|
|
1680
1828
|
Name | Type | Description | Notes
|
1681
1829
|
------------- | ------------- | ------------- | -------------
|
1682
1830
|
**conversation_id** | **String**| Conversation ID | |
|
1683
|
-
**body** | [**ConversationAssociation**](ConversationAssociation.html)| ConversationAssociation |
|
1831
|
+
**body** | [**ConversationAssociation**](ConversationAssociation.html)| ConversationAssociation | |
|
1684
1832
|
{: class="table table-striped"}
|
1685
1833
|
|
1686
1834
|
|
@@ -1697,7 +1845,9 @@ nil (empty response body)
|
|
1697
1845
|
|
1698
1846
|
<a name="put_externalcontacts_organization"></a>
|
1699
1847
|
|
1700
|
-
## -[**ExternalOrganization**](ExternalOrganization.html) put_externalcontacts_organization(external_organization_id,
|
1848
|
+
## -[**ExternalOrganization**](ExternalOrganization.html) put_externalcontacts_organization(external_organization_id, body)
|
1849
|
+
|
1850
|
+
|
1701
1851
|
|
1702
1852
|
Update an external organization
|
1703
1853
|
|
@@ -1705,6 +1855,10 @@ Update an external organization
|
|
1705
1855
|
|
1706
1856
|
Wraps PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}
|
1707
1857
|
|
1858
|
+
Requires ANY permissions:
|
1859
|
+
|
1860
|
+
* externalContacts:externalOrganization:edit
|
1861
|
+
|
1708
1862
|
|
1709
1863
|
### Example
|
1710
1864
|
~~~ruby
|
@@ -1725,13 +1879,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1725
1879
|
|
1726
1880
|
external_organization_id = "external_organization_id_example" # String | External Organization ID
|
1727
1881
|
|
1728
|
-
|
1729
|
-
|
1730
|
-
}
|
1882
|
+
body = PureCloud::ExternalOrganization.new # ExternalOrganization | ExternalOrganization
|
1883
|
+
|
1731
1884
|
|
1732
1885
|
begin
|
1733
1886
|
#Update an external organization
|
1734
|
-
result = api_instance.put_externalcontacts_organization(external_organization_id,
|
1887
|
+
result = api_instance.put_externalcontacts_organization(external_organization_id, body)
|
1735
1888
|
p result
|
1736
1889
|
rescue PureCloud::ApiError => e
|
1737
1890
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_organization: #{e}"
|
@@ -1743,7 +1896,7 @@ end
|
|
1743
1896
|
Name | Type | Description | Notes
|
1744
1897
|
------------- | ------------- | ------------- | -------------
|
1745
1898
|
**external_organization_id** | **String**| External Organization ID | |
|
1746
|
-
**body** | [**ExternalOrganization**](ExternalOrganization.html)| ExternalOrganization |
|
1899
|
+
**body** | [**ExternalOrganization**](ExternalOrganization.html)| ExternalOrganization | |
|
1747
1900
|
{: class="table table-striped"}
|
1748
1901
|
|
1749
1902
|
|
@@ -1760,7 +1913,9 @@ Name | Type | Description | Notes
|
|
1760
1913
|
|
1761
1914
|
<a name="put_externalcontacts_organization_note"></a>
|
1762
1915
|
|
1763
|
-
## -[**Note**](Note.html) put_externalcontacts_organization_note(external_organization_id, note_id,
|
1916
|
+
## -[**Note**](Note.html) put_externalcontacts_organization_note(external_organization_id, note_id, body)
|
1917
|
+
|
1918
|
+
|
1764
1919
|
|
1765
1920
|
Update a note for an external organization
|
1766
1921
|
|
@@ -1768,6 +1923,10 @@ Update a note for an external organization
|
|
1768
1923
|
|
1769
1924
|
Wraps PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
|
1770
1925
|
|
1926
|
+
Requires ANY permissions:
|
1927
|
+
|
1928
|
+
* externalContacts:externalOrganization:edit
|
1929
|
+
|
1771
1930
|
|
1772
1931
|
### Example
|
1773
1932
|
~~~ruby
|
@@ -1790,13 +1949,12 @@ external_organization_id = "external_organization_id_example" # String | Externa
|
|
1790
1949
|
|
1791
1950
|
note_id = "note_id_example" # String | Note Id
|
1792
1951
|
|
1793
|
-
|
1794
|
-
|
1795
|
-
}
|
1952
|
+
body = PureCloud::Note.new # Note | Note
|
1953
|
+
|
1796
1954
|
|
1797
1955
|
begin
|
1798
1956
|
#Update a note for an external organization
|
1799
|
-
result = api_instance.put_externalcontacts_organization_note(external_organization_id, note_id,
|
1957
|
+
result = api_instance.put_externalcontacts_organization_note(external_organization_id, note_id, body)
|
1800
1958
|
p result
|
1801
1959
|
rescue PureCloud::ApiError => e
|
1802
1960
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_organization_note: #{e}"
|
@@ -1809,7 +1967,7 @@ Name | Type | Description | Notes
|
|
1809
1967
|
------------- | ------------- | ------------- | -------------
|
1810
1968
|
**external_organization_id** | **String**| External Organization Id | |
|
1811
1969
|
**note_id** | **String**| Note Id | |
|
1812
|
-
**body** | [**Note**](Note.html)| Note |
|
1970
|
+
**body** | [**Note**](Note.html)| Note | |
|
1813
1971
|
{: class="table table-striped"}
|
1814
1972
|
|
1815
1973
|
|
@@ -1828,12 +1986,18 @@ Name | Type | Description | Notes
|
|
1828
1986
|
|
1829
1987
|
## -[**ExternalOrganization**](ExternalOrganization.html) put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id)
|
1830
1988
|
|
1831
|
-
|
1989
|
+
|
1990
|
+
|
1991
|
+
Links a Trustor with an External Organization
|
1832
1992
|
|
1833
1993
|
|
1834
1994
|
|
1835
1995
|
Wraps PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}
|
1836
1996
|
|
1997
|
+
Requires ANY permissions:
|
1998
|
+
|
1999
|
+
* externalContacts:externalOrganization:edit
|
2000
|
+
|
1837
2001
|
|
1838
2002
|
### Example
|
1839
2003
|
~~~ruby
|
@@ -1858,7 +2022,7 @@ trustor_id = "trustor_id_example" # String | Trustor ID
|
|
1858
2022
|
|
1859
2023
|
|
1860
2024
|
begin
|
1861
|
-
#Links a Trustor with an
|
2025
|
+
#Links a Trustor with an External Organization
|
1862
2026
|
result = api_instance.put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id)
|
1863
2027
|
p result
|
1864
2028
|
rescue PureCloud::ApiError => e
|
@@ -1888,7 +2052,9 @@ Name | Type | Description | Notes
|
|
1888
2052
|
|
1889
2053
|
<a name="put_externalcontacts_relationship"></a>
|
1890
2054
|
|
1891
|
-
## -[**Relationship**](Relationship.html) put_externalcontacts_relationship(relationship_id,
|
2055
|
+
## -[**Relationship**](Relationship.html) put_externalcontacts_relationship(relationship_id, body)
|
2056
|
+
|
2057
|
+
|
1892
2058
|
|
1893
2059
|
Update a relationship
|
1894
2060
|
|
@@ -1896,6 +2062,10 @@ Update a relationship
|
|
1896
2062
|
|
1897
2063
|
Wraps PUT /api/v2/externalcontacts/relationships/{relationshipId}
|
1898
2064
|
|
2065
|
+
Requires ANY permissions:
|
2066
|
+
|
2067
|
+
* externalContacts:externalOrganization:edit
|
2068
|
+
|
1899
2069
|
|
1900
2070
|
### Example
|
1901
2071
|
~~~ruby
|
@@ -1916,13 +2086,12 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
1916
2086
|
|
1917
2087
|
relationship_id = "relationship_id_example" # String | Relationship Id
|
1918
2088
|
|
1919
|
-
|
1920
|
-
|
1921
|
-
}
|
2089
|
+
body = PureCloud::Relationship.new # Relationship | Relationship
|
2090
|
+
|
1922
2091
|
|
1923
2092
|
begin
|
1924
2093
|
#Update a relationship
|
1925
|
-
result = api_instance.put_externalcontacts_relationship(relationship_id,
|
2094
|
+
result = api_instance.put_externalcontacts_relationship(relationship_id, body)
|
1926
2095
|
p result
|
1927
2096
|
rescue PureCloud::ApiError => e
|
1928
2097
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_relationship: #{e}"
|
@@ -1934,7 +2103,7 @@ end
|
|
1934
2103
|
Name | Type | Description | Notes
|
1935
2104
|
------------- | ------------- | ------------- | -------------
|
1936
2105
|
**relationship_id** | **String**| Relationship Id | |
|
1937
|
-
**body** | [**Relationship**](Relationship.html)| Relationship |
|
2106
|
+
**body** | [**Relationship**](Relationship.html)| Relationship | |
|
1938
2107
|
{: class="table table-striped"}
|
1939
2108
|
|
1940
2109
|
|