purecloudplatformclientv2 3.1.7 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +3 -4
- data/docs/ArchitectApi.md +14 -15
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +2 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -1
- data/docs/CallConversationNotificationParticipants.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -1
- data/docs/CallbackConversationNotificationParticipants.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignNotification.md +1 -1
- data/docs/CampaignProgressNotification.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignRuleNotificationCampaignRuleEntities.md +1 -1
- data/docs/CampaignScheduleNotification.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CampaignSequenceNotification.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -1
- data/docs/ChatConversationNotificationParticipants.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -1
- data/docs/CobrowseConversationNotificationParticipants.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/ContactListFilterNotification.md +22 -0
- data/docs/ContactListFilterNotificationClauses.md +15 -0
- data/docs/ContactListFilterNotificationFilterClause.md +15 -0
- data/docs/ContactListFilterNotificationFilterPredicate.md +18 -0
- data/docs/ContactListFilterNotificationPredicates.md +18 -0
- data/docs/ContactListFilterNotificationRange.md +18 -0
- data/docs/ContactListFilterNotificationUriReference.md +14 -0
- data/docs/ContactListNotification.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationAssociation.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +6 -8
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +20 -0
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTrackingBuildNotificationNotification.md +15 -0
- data/docs/DependencyTrackingBuildNotificationNotificationUser.md +14 -0
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/Document.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentDataV2Notification.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/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/EmailConversationNotificationEmailMediaParticipant.md +1 -1
- data/docs/EmailConversationNotificationParticipants.md +1 -1
- data/docs/EmailMessageListing.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 +228 -37
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDataV2Notification.md +1 -1
- data/docs/FaxDocument.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowNotificationNotification.md +20 -0
- data/docs/FlowNotificationNotificationArchitectOperation.md +21 -0
- data/docs/FlowNotificationNotificationErrorDetail.md +16 -0
- data/docs/FlowNotificationNotificationErrorMessageParams.md +13 -0
- data/docs/FlowNotificationNotificationFlowVersion.md +13 -0
- data/docs/{DocumentDataV2NotificationCreatedBy.md → FlowNotificationNotificationUser.md} +2 -2
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/HeartBeatAlertContainer.md +1 -1
- data/docs/HeartBeatRuleContainer.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +6 -6
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseDefinitionListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +33 -44
- 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/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PromptNotificationNotification.md +16 -0
- data/docs/PromptNotificationNotificationArchitectOperation.md +21 -0
- data/docs/PromptNotificationNotificationCurrentOperation.md +21 -0
- data/docs/PromptNotificationNotificationCurrentOperationErrorDetails.md +16 -0
- data/docs/PromptNotificationNotificationCurrentOperationErrorMessageParams.md +13 -0
- data/docs/PromptNotificationNotificationErrorDetail.md +16 -0
- data/docs/PromptNotificationNotificationErrorMessageParams.md +13 -0
- data/docs/PromptNotificationNotificationUser.md +14 -0
- data/docs/PromptResourceNotificationNotification.md +18 -0
- data/docs/PublishFlowNotificationNotification.md +16 -0
- data/docs/QualityApi.md +8 -10
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecordingApi.md +6 -8
- data/docs/RecordingDataV2Notification.md +1 -1
- 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/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +27 -36
- data/docs/RoutingStatusAlertContainer.md +1 -1
- data/docs/RoutingStatusRuleContainer.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/RuleSetNotification.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScreenShareConversationNotificationParticipants.md +1 -1
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SequenceScheduleNotification.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SocialConversationNotificationParticipants.md +1 -1
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -1
- data/docs/Station.md +2 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +5 -4
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/SystemPromptResourceNotificationNotification.md +18 -0
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +41 -54
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +3 -4
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkConnectedStatus.md +14 -0
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkErrorInfo.md +15 -0
- data/docs/TrunkErrorInfoDetails.md +15 -0
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrunkMetricsNetworkTypeIp.md +14 -0
- data/docs/TrunkMetricsOptions.md +16 -0
- data/docs/TrunkMetricsRegisters.md +16 -0
- data/docs/UpdateUser.md +28 -0
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserPresenceAlertContainer.md +1 -1
- data/docs/UserPresenceRuleContainer.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +5 -6
- data/docs/VideoConversationNotificationParticipants.md +1 -1
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +1 -1
- data/docs/VoicemailApi.md +6 -8
- data/docs/VoicemailGroupPolicy.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +34 -1
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +5 -6
- data/lib/purecloudplatformclientv2/api/architect_api.rb +19 -20
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +3 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +10 -12
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +242 -58
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +55 -66
- data/lib/purecloudplatformclientv2/api/quality_api.rb +12 -14
- data/lib/purecloudplatformclientv2/api/recording_api.rb +10 -12
- data/lib/purecloudplatformclientv2/api/routing_api.rb +45 -54
- data/lib/purecloudplatformclientv2/api/stations_api.rb +8 -6
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +68 -81
- data/lib/purecloudplatformclientv2/api/tokens_api.rb +5 -6
- data/lib/purecloudplatformclientv2/api/users_api.rb +5 -6
- data/lib/purecloudplatformclientv2/api/voicemail_api.rb +10 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_entities.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_schedule_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_sequence_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification.rb +277 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_clauses.rb +212 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_filter_clause.rb +212 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_filter_predicate.rb +251 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_predicates.rb +251 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_range.rb +225 -0
- data/lib/purecloudplatformclientv2/models/contact_list_filter_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +11 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/data_schema.rb +258 -0
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/dependency_tracking_build_notification_notification.rb +196 -0
- data/lib/purecloudplatformclientv2/models/dependency_tracking_build_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/document.rb +10 -10
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/fax_document.rb +10 -10
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/flow_notification_notification.rb +241 -0
- data/lib/purecloudplatformclientv2/models/flow_notification_notification_architect_operation.rb +280 -0
- data/lib/purecloudplatformclientv2/models/flow_notification_notification_error_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/flow_notification_notification_error_message_params.rb +180 -0
- data/lib/purecloudplatformclientv2/models/flow_notification_notification_flow_version.rb +178 -0
- data/lib/purecloudplatformclientv2/models/{document_data_v2_notification_created_by.rb → flow_notification_notification_user.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/json_node.rb +43 -43
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/license_definition_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/note_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification.rb +205 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_architect_operation.rb +280 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_current_operation.rb +280 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_current_operation_error_details.rb +205 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_current_operation_error_message_params.rb +180 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_error_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_error_message_params.rb +180 -0
- data/lib/purecloudplatformclientv2/models/prompt_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/prompt_resource_notification_notification.rb +223 -0
- data/lib/purecloudplatformclientv2/models/publish_flow_notification_notification.rb +205 -0
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +10 -10
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/rule_set_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/sequence_schedule_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/station.rb +12 -1
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/system_prompt_resource_notification_notification.rb +223 -0
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_connected_status.rb +188 -0
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_error_info.rb +196 -0
- data/lib/purecloudplatformclientv2/models/trunk_error_info_details.rb +196 -0
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_metrics_network_type_ip.rb +189 -0
- data/lib/purecloudplatformclientv2/models/trunk_metrics_options.rb +207 -0
- data/lib/purecloudplatformclientv2/models/trunk_metrics_registers.rb +208 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +332 -0
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/voicemail_group_policy.rb +38 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +70 -4
|
@@ -11,8 +11,8 @@ title: DomainEdgeSoftwareVersionDtoEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
data/docs/DomainEntityListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: DomainEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: DomainEntityListingEvaluationForm
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: DomainEntityListingQueryResult
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -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
|
@@ -11,8 +11,8 @@ title: EdgeEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EdgeGroupEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EdgeLineEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EmailConversationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -21,7 +21,7 @@ title: EmailConversationNotificationEmailMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
24
|
-
| **user** | [**
|
|
24
|
+
| **user** | [**DependencyTrackingBuildNotificationNotificationUser**](DependencyTrackingBuildNotificationNotificationUser.html) | | [optional] |
|
|
25
25
|
| **queue** | [**EmailConversationNotificationUriReference**](EmailConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**EmailConversationNotificationErrorInfo**](EmailConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -21,7 +21,7 @@ title: EmailConversationNotificationParticipants
|
|
|
21
21
|
| **held** | **BOOLEAN** | | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
24
|
-
| **user** | [**
|
|
24
|
+
| **user** | [**DependencyTrackingBuildNotificationNotificationUser**](DependencyTrackingBuildNotificationNotificationUser.html) | | [optional] |
|
|
25
25
|
| **queue** | [**EmailConversationNotificationUriReference**](EmailConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**EmailConversationNotificationErrorInfo**](EmailConversationNotificationErrorInfo.html) | | [optional] |
|
data/docs/EmailMessageListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: EmailMessageListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EncryptionKeyEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EndpointEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluationFormEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: EvaluatorActivityEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: ExtensionEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: ExtensionPoolEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
data/docs/ExternalContactsApi.md
CHANGED
|
@@ -17,15 +17,16 @@ Method | Description
|
|
|
17
17
|
[**get_externalcontacts_contact_note**](ExternalContactsApi.html#get_externalcontacts_contact_note) | Fetch a note for an external contact
|
|
18
18
|
[**get_externalcontacts_contact_notes**](ExternalContactsApi.html#get_externalcontacts_contact_notes) | List notes for an external contact
|
|
19
19
|
[**get_externalcontacts_contacts**](ExternalContactsApi.html#get_externalcontacts_contacts) | Search for external contacts
|
|
20
|
+
[**get_externalcontacts_contacts_schema**](ExternalContactsApi.html#get_externalcontacts_contacts_schema) | Get a schema
|
|
20
21
|
[**get_externalcontacts_organization**](ExternalContactsApi.html#get_externalcontacts_organization) | Fetch an external organization
|
|
21
22
|
[**get_externalcontacts_organization_contacts**](ExternalContactsApi.html#get_externalcontacts_organization_contacts) | Search for external contacts in an external organization
|
|
22
23
|
[**get_externalcontacts_organization_note**](ExternalContactsApi.html#get_externalcontacts_organization_note) | Fetch a note for an external organization
|
|
23
24
|
[**get_externalcontacts_organization_notes**](ExternalContactsApi.html#get_externalcontacts_organization_notes) | List notes for an external organization
|
|
24
25
|
[**get_externalcontacts_organization_relationships**](ExternalContactsApi.html#get_externalcontacts_organization_relationships) | Fetch a relationship for an external organization
|
|
25
26
|
[**get_externalcontacts_organizations**](ExternalContactsApi.html#get_externalcontacts_organizations) | Search for external organizations
|
|
27
|
+
[**get_externalcontacts_organizations_schema**](ExternalContactsApi.html#get_externalcontacts_organizations_schema) | Get a schema
|
|
26
28
|
[**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
|
|
27
29
|
[**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Lookup contacts and externalOrganizations based on an attribute
|
|
28
|
-
[**post_externalcontacts_contact_associateconversation**](ExternalContactsApi.html#post_externalcontacts_contact_associateconversation) | Associate an external contact with a conversation
|
|
29
30
|
[**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
|
|
30
31
|
[**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
|
|
31
32
|
[**post_externalcontacts_organization_notes**](ExternalContactsApi.html#post_externalcontacts_organization_notes) | Create a note for an external organization
|
|
@@ -33,9 +34,11 @@ Method | Description
|
|
|
33
34
|
[**post_externalcontacts_relationships**](ExternalContactsApi.html#post_externalcontacts_relationships) | Create a relationship
|
|
34
35
|
[**put_externalcontacts_contact**](ExternalContactsApi.html#put_externalcontacts_contact) | Update an external contact
|
|
35
36
|
[**put_externalcontacts_contact_note**](ExternalContactsApi.html#put_externalcontacts_contact_note) | Update a note for an external contact
|
|
37
|
+
[**put_externalcontacts_contacts_schema**](ExternalContactsApi.html#put_externalcontacts_contacts_schema) | Update a schema
|
|
36
38
|
[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
|
|
37
39
|
[**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
|
|
38
40
|
[**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization
|
|
41
|
+
[**put_externalcontacts_organizations_schema**](ExternalContactsApi.html#put_externalcontacts_organizations_schema) | Update a schema
|
|
39
42
|
[**put_externalcontacts_relationship**](ExternalContactsApi.html#put_externalcontacts_relationship) | Update a relationship
|
|
40
43
|
{: class="table table-striped"}
|
|
41
44
|
|
|
@@ -601,6 +604,69 @@ Name | Type | Description | Notes
|
|
|
601
604
|
|
|
602
605
|
|
|
603
606
|
|
|
607
|
+
<a name="get_externalcontacts_contacts_schema"></a>
|
|
608
|
+
|
|
609
|
+
## -[**DataSchema**](DataSchema.html) get_externalcontacts_contacts_schema(schema_id, opts)
|
|
610
|
+
|
|
611
|
+
Get a schema
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
Wraps GET /api/v2/externalcontacts/contacts/schemas/{schemaId}
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
### Example
|
|
619
|
+
~~~ruby
|
|
620
|
+
# load the gem
|
|
621
|
+
require 'purecloudplatformclientv2'
|
|
622
|
+
# setup authorization
|
|
623
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
624
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
625
|
+
environment = "mypurecloud.com"
|
|
626
|
+
|
|
627
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
628
|
+
|
|
629
|
+
PureCloud.configure do |config|
|
|
630
|
+
config.access_token = @authToken
|
|
631
|
+
end
|
|
632
|
+
|
|
633
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
634
|
+
|
|
635
|
+
schema_id = "schema_id_example" # String | Schema ID
|
|
636
|
+
|
|
637
|
+
opts = {
|
|
638
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand. Expand 'jsonSchema.definitions' to get a readonly schema for data validation.
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
begin
|
|
642
|
+
#Get a schema
|
|
643
|
+
result = api_instance.get_externalcontacts_contacts_schema(schema_id, opts)
|
|
644
|
+
p result
|
|
645
|
+
rescue PureCloud::ApiError => e
|
|
646
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema: #{e}"
|
|
647
|
+
end
|
|
648
|
+
~~~
|
|
649
|
+
|
|
650
|
+
### Parameters
|
|
651
|
+
|
|
652
|
+
Name | Type | Description | Notes
|
|
653
|
+
------------- | ------------- | ------------- | -------------
|
|
654
|
+
**schema_id** | **String**| Schema ID |
|
|
655
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. Expand 'jsonSchema.definitions' to get a readonly schema for data validation. | [optional]
|
|
656
|
+
{: class="table table-striped"}
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
### Return type
|
|
660
|
+
|
|
661
|
+
[**DataSchema**](DataSchema.html)
|
|
662
|
+
|
|
663
|
+
### HTTP request headers
|
|
664
|
+
|
|
665
|
+
- **Content-Type**: application/json
|
|
666
|
+
- **Accept**: application/json
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
604
670
|
<a name="get_externalcontacts_organization"></a>
|
|
605
671
|
|
|
606
672
|
## -[**ExternalOrganization**](ExternalOrganization.html) get_externalcontacts_organization(external_organization_id, opts)
|
|
@@ -1007,15 +1073,15 @@ Name | Type | Description | Notes
|
|
|
1007
1073
|
|
|
1008
1074
|
|
|
1009
1075
|
|
|
1010
|
-
<a name="
|
|
1076
|
+
<a name="get_externalcontacts_organizations_schema"></a>
|
|
1011
1077
|
|
|
1012
|
-
## -[**
|
|
1078
|
+
## -[**DataSchema**](DataSchema.html) get_externalcontacts_organizations_schema(schema_id, opts)
|
|
1013
1079
|
|
|
1014
|
-
|
|
1080
|
+
Get a schema
|
|
1015
1081
|
|
|
1016
1082
|
|
|
1017
1083
|
|
|
1018
|
-
Wraps GET /api/v2/externalcontacts/
|
|
1084
|
+
Wraps GET /api/v2/externalcontacts/organizations/schemas/{schemaId}
|
|
1019
1085
|
|
|
1020
1086
|
|
|
1021
1087
|
### Example
|
|
@@ -1035,18 +1101,18 @@ end
|
|
|
1035
1101
|
|
|
1036
1102
|
api_instance = PureCloud::ExternalContactsApi.new
|
|
1037
1103
|
|
|
1038
|
-
|
|
1104
|
+
schema_id = "schema_id_example" # String | Schema ID
|
|
1039
1105
|
|
|
1040
1106
|
opts = {
|
|
1041
|
-
expand: "expand_example" # String |
|
|
1107
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand. Expand 'jsonSchema.definitions' to get a readonly schema for data validation.
|
|
1042
1108
|
}
|
|
1043
1109
|
|
|
1044
1110
|
begin
|
|
1045
|
-
#
|
|
1046
|
-
result = api_instance.
|
|
1111
|
+
#Get a schema
|
|
1112
|
+
result = api_instance.get_externalcontacts_organizations_schema(schema_id, opts)
|
|
1047
1113
|
p result
|
|
1048
1114
|
rescue PureCloud::ApiError => e
|
|
1049
|
-
puts "Exception when calling ExternalContactsApi->
|
|
1115
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema: #{e}"
|
|
1050
1116
|
end
|
|
1051
1117
|
~~~
|
|
1052
1118
|
|
|
@@ -1054,14 +1120,14 @@ end
|
|
|
1054
1120
|
|
|
1055
1121
|
Name | Type | Description | Notes
|
|
1056
1122
|
------------- | ------------- | ------------- | -------------
|
|
1057
|
-
**
|
|
1058
|
-
**expand** | **String
|
|
1123
|
+
**schema_id** | **String**| Schema ID |
|
|
1124
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. Expand 'jsonSchema.definitions' to get a readonly schema for data validation. | [optional]
|
|
1059
1125
|
{: class="table table-striped"}
|
|
1060
1126
|
|
|
1061
1127
|
|
|
1062
1128
|
### Return type
|
|
1063
1129
|
|
|
1064
|
-
[**
|
|
1130
|
+
[**DataSchema**](DataSchema.html)
|
|
1065
1131
|
|
|
1066
1132
|
### HTTP request headers
|
|
1067
1133
|
|
|
@@ -1070,15 +1136,15 @@ Name | Type | Description | Notes
|
|
|
1070
1136
|
|
|
1071
1137
|
|
|
1072
1138
|
|
|
1073
|
-
<a name="
|
|
1139
|
+
<a name="get_externalcontacts_relationship"></a>
|
|
1074
1140
|
|
|
1075
|
-
## -[**
|
|
1141
|
+
## -[**Relationship**](Relationship.html) get_externalcontacts_relationship(relationship_id, opts)
|
|
1076
1142
|
|
|
1077
|
-
|
|
1143
|
+
Fetch a relationship
|
|
1078
1144
|
|
|
1079
1145
|
|
|
1080
1146
|
|
|
1081
|
-
Wraps GET /api/v2/externalcontacts/
|
|
1147
|
+
Wraps GET /api/v2/externalcontacts/relationships/{relationshipId}
|
|
1082
1148
|
|
|
1083
1149
|
|
|
1084
1150
|
### Example
|
|
@@ -1098,18 +1164,18 @@ end
|
|
|
1098
1164
|
|
|
1099
1165
|
api_instance = PureCloud::ExternalContactsApi.new
|
|
1100
1166
|
|
|
1101
|
-
|
|
1167
|
+
relationship_id = "relationship_id_example" # String | Relationship Id
|
|
1102
1168
|
|
|
1103
1169
|
opts = {
|
|
1104
|
-
expand:
|
|
1170
|
+
expand: "expand_example" # String | which fields, if any, to expand
|
|
1105
1171
|
}
|
|
1106
1172
|
|
|
1107
1173
|
begin
|
|
1108
|
-
#
|
|
1109
|
-
result = api_instance.
|
|
1174
|
+
#Fetch a relationship
|
|
1175
|
+
result = api_instance.get_externalcontacts_relationship(relationship_id, opts)
|
|
1110
1176
|
p result
|
|
1111
1177
|
rescue PureCloud::ApiError => e
|
|
1112
|
-
puts "Exception when calling ExternalContactsApi->
|
|
1178
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_relationship: #{e}"
|
|
1113
1179
|
end
|
|
1114
1180
|
~~~
|
|
1115
1181
|
|
|
@@ -1117,14 +1183,14 @@ end
|
|
|
1117
1183
|
|
|
1118
1184
|
Name | Type | Description | Notes
|
|
1119
1185
|
------------- | ------------- | ------------- | -------------
|
|
1120
|
-
**
|
|
1121
|
-
**expand** |
|
|
1186
|
+
**relationship_id** | **String**| Relationship Id |
|
|
1187
|
+
**expand** | **String**| which fields, if any, to expand | [optional]
|
|
1122
1188
|
{: class="table table-striped"}
|
|
1123
1189
|
|
|
1124
1190
|
|
|
1125
1191
|
### Return type
|
|
1126
1192
|
|
|
1127
|
-
[**
|
|
1193
|
+
[**Relationship**](Relationship.html)
|
|
1128
1194
|
|
|
1129
1195
|
### HTTP request headers
|
|
1130
1196
|
|
|
@@ -1133,15 +1199,15 @@ Name | Type | Description | Notes
|
|
|
1133
1199
|
|
|
1134
1200
|
|
|
1135
1201
|
|
|
1136
|
-
<a name="
|
|
1202
|
+
<a name="get_externalcontacts_reversewhitepageslookup"></a>
|
|
1137
1203
|
|
|
1138
|
-
## -
|
|
1204
|
+
## -[**ReverseWhitepagesLookupResult**](ReverseWhitepagesLookupResult.html) get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
|
|
1139
1205
|
|
|
1140
|
-
|
|
1206
|
+
Lookup contacts and externalOrganizations based on an attribute
|
|
1141
1207
|
|
|
1142
1208
|
|
|
1143
1209
|
|
|
1144
|
-
Wraps
|
|
1210
|
+
Wraps GET /api/v2/externalcontacts/reversewhitepageslookup
|
|
1145
1211
|
|
|
1146
1212
|
|
|
1147
1213
|
### Example
|
|
@@ -1161,17 +1227,18 @@ end
|
|
|
1161
1227
|
|
|
1162
1228
|
api_instance = PureCloud::ExternalContactsApi.new
|
|
1163
1229
|
|
|
1164
|
-
|
|
1230
|
+
lookup_val = "lookup_val_example" # String | User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
1165
1231
|
|
|
1166
1232
|
opts = {
|
|
1167
|
-
|
|
1233
|
+
expand: ["expand_example"] # Array<String> | which field, if any, to expand
|
|
1168
1234
|
}
|
|
1169
1235
|
|
|
1170
1236
|
begin
|
|
1171
|
-
#
|
|
1172
|
-
api_instance.
|
|
1237
|
+
#Lookup contacts and externalOrganizations based on an attribute
|
|
1238
|
+
result = api_instance.get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
|
|
1239
|
+
p result
|
|
1173
1240
|
rescue PureCloud::ApiError => e
|
|
1174
|
-
puts "Exception when calling ExternalContactsApi->
|
|
1241
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_reversewhitepageslookup: #{e}"
|
|
1175
1242
|
end
|
|
1176
1243
|
~~~
|
|
1177
1244
|
|
|
@@ -1179,14 +1246,14 @@ end
|
|
|
1179
1246
|
|
|
1180
1247
|
Name | Type | Description | Notes
|
|
1181
1248
|
------------- | ------------- | ------------- | -------------
|
|
1182
|
-
**
|
|
1183
|
-
**
|
|
1249
|
+
**lookup_val** | **String**| User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names) |
|
|
1250
|
+
**expand** | [**Array<String>**](String.html)| which field, if any, to expand | [optional]
|
|
1184
1251
|
{: class="table table-striped"}
|
|
1185
1252
|
|
|
1186
1253
|
|
|
1187
1254
|
### Return type
|
|
1188
1255
|
|
|
1189
|
-
|
|
1256
|
+
[**ReverseWhitepagesLookupResult**](ReverseWhitepagesLookupResult.html)
|
|
1190
1257
|
|
|
1191
1258
|
### HTTP request headers
|
|
1192
1259
|
|
|
@@ -1630,6 +1697,68 @@ Name | Type | Description | Notes
|
|
|
1630
1697
|
|
|
1631
1698
|
|
|
1632
1699
|
|
|
1700
|
+
<a name="put_externalcontacts_contacts_schema"></a>
|
|
1701
|
+
|
|
1702
|
+
## -[**DataSchema**](DataSchema.html) put_externalcontacts_contacts_schema(schema_id, body)
|
|
1703
|
+
|
|
1704
|
+
Update a schema
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
Wraps PUT /api/v2/externalcontacts/contacts/schemas/{schemaId}
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
### Example
|
|
1712
|
+
~~~ruby
|
|
1713
|
+
# load the gem
|
|
1714
|
+
require 'purecloudplatformclientv2'
|
|
1715
|
+
# setup authorization
|
|
1716
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1717
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1718
|
+
environment = "mypurecloud.com"
|
|
1719
|
+
|
|
1720
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1721
|
+
|
|
1722
|
+
PureCloud.configure do |config|
|
|
1723
|
+
config.access_token = @authToken
|
|
1724
|
+
end
|
|
1725
|
+
|
|
1726
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
1727
|
+
|
|
1728
|
+
schema_id = "schema_id_example" # String | Schema ID
|
|
1729
|
+
|
|
1730
|
+
body = PureCloud::DataSchema.new # DataSchema | Data Schema
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
begin
|
|
1734
|
+
#Update a schema
|
|
1735
|
+
result = api_instance.put_externalcontacts_contacts_schema(schema_id, body)
|
|
1736
|
+
p result
|
|
1737
|
+
rescue PureCloud::ApiError => e
|
|
1738
|
+
puts "Exception when calling ExternalContactsApi->put_externalcontacts_contacts_schema: #{e}"
|
|
1739
|
+
end
|
|
1740
|
+
~~~
|
|
1741
|
+
|
|
1742
|
+
### Parameters
|
|
1743
|
+
|
|
1744
|
+
Name | Type | Description | Notes
|
|
1745
|
+
------------- | ------------- | ------------- | -------------
|
|
1746
|
+
**schema_id** | **String**| Schema ID |
|
|
1747
|
+
**body** | [**DataSchema**](DataSchema.html)| Data Schema |
|
|
1748
|
+
{: class="table table-striped"}
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
### Return type
|
|
1752
|
+
|
|
1753
|
+
[**DataSchema**](DataSchema.html)
|
|
1754
|
+
|
|
1755
|
+
### HTTP request headers
|
|
1756
|
+
|
|
1757
|
+
- **Content-Type**: application/json
|
|
1758
|
+
- **Accept**: application/json
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1633
1762
|
<a name="put_externalcontacts_conversation"></a>
|
|
1634
1763
|
|
|
1635
1764
|
## - put_externalcontacts_conversation(conversation_id, opts)
|
|
@@ -1821,6 +1950,68 @@ Name | Type | Description | Notes
|
|
|
1821
1950
|
|
|
1822
1951
|
|
|
1823
1952
|
|
|
1953
|
+
<a name="put_externalcontacts_organizations_schema"></a>
|
|
1954
|
+
|
|
1955
|
+
## -[**DataSchema**](DataSchema.html) put_externalcontacts_organizations_schema(schema_id, body)
|
|
1956
|
+
|
|
1957
|
+
Update a schema
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
Wraps PUT /api/v2/externalcontacts/organizations/schemas/{schemaId}
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
### Example
|
|
1965
|
+
~~~ruby
|
|
1966
|
+
# load the gem
|
|
1967
|
+
require 'purecloudplatformclientv2'
|
|
1968
|
+
# setup authorization
|
|
1969
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1970
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1971
|
+
environment = "mypurecloud.com"
|
|
1972
|
+
|
|
1973
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1974
|
+
|
|
1975
|
+
PureCloud.configure do |config|
|
|
1976
|
+
config.access_token = @authToken
|
|
1977
|
+
end
|
|
1978
|
+
|
|
1979
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
1980
|
+
|
|
1981
|
+
schema_id = "schema_id_example" # String | Schema ID
|
|
1982
|
+
|
|
1983
|
+
body = PureCloud::DataSchema.new # DataSchema | Data Schema
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
begin
|
|
1987
|
+
#Update a schema
|
|
1988
|
+
result = api_instance.put_externalcontacts_organizations_schema(schema_id, body)
|
|
1989
|
+
p result
|
|
1990
|
+
rescue PureCloud::ApiError => e
|
|
1991
|
+
puts "Exception when calling ExternalContactsApi->put_externalcontacts_organizations_schema: #{e}"
|
|
1992
|
+
end
|
|
1993
|
+
~~~
|
|
1994
|
+
|
|
1995
|
+
### Parameters
|
|
1996
|
+
|
|
1997
|
+
Name | Type | Description | Notes
|
|
1998
|
+
------------- | ------------- | ------------- | -------------
|
|
1999
|
+
**schema_id** | **String**| Schema ID |
|
|
2000
|
+
**body** | [**DataSchema**](DataSchema.html)| Data Schema |
|
|
2001
|
+
{: class="table table-striped"}
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
### Return type
|
|
2005
|
+
|
|
2006
|
+
[**DataSchema**](DataSchema.html)
|
|
2007
|
+
|
|
2008
|
+
### HTTP request headers
|
|
2009
|
+
|
|
2010
|
+
- **Content-Type**: application/json
|
|
2011
|
+
- **Accept**: application/json
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
1824
2015
|
<a name="put_externalcontacts_relationship"></a>
|
|
1825
2016
|
|
|
1826
2017
|
## -[**Relationship**](Relationship.html) put_externalcontacts_relationship(relationship_id, opts)
|