purecloudplatformclientv2 9.0.0 → 10.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/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- 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/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/ConversationEntityListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.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/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/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 +130 -4
- data/docs/ExternalOrganization.md +1 -0
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- 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 +3 -3
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +4 -4
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.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/OrgUser.md +36 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- 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/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.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/RoutingStatusAlertContainer.md +1 -1
- data/docs/RoutingStatusRuleContainer.md +1 -1
- data/docs/RuleSetEntityListing.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/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/Trustor.md +18 -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/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 +2 -2
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +166 -9
- data/lib/purecloudplatformclientv2/api/license_api.rb +6 -6
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization.rb +26 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +29 -29
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/org_user.rb +822 -0
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{license_definition_listing.rb → trustor.rb} +48 -139
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +6 -6
- data/docs/LicenseDefinitionListing.md +0 -22
- data/docs/LicenseUpdateResponse.md +0 -13
- data/lib/purecloudplatformclientv2/models/license_update_response.rb +0 -203
@@ -14,8 +14,8 @@ title: EndpointEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: EvaluationEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: EvaluationFormEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: EvaluatorActivityEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ExtensionEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: ExtensionPoolEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_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
@@ -12,6 +12,7 @@ Method | Description
|
|
12
12
|
[**delete_externalcontacts_contact_note**](ExternalContactsApi.html#delete_externalcontacts_contact_note) | Delete a note for an external contact
|
13
13
|
[**delete_externalcontacts_organization**](ExternalContactsApi.html#delete_externalcontacts_organization) | Delete an external organization
|
14
14
|
[**delete_externalcontacts_organization_note**](ExternalContactsApi.html#delete_externalcontacts_organization_note) | Delete a note for an external organization
|
15
|
+
[**delete_externalcontacts_organization_trustor**](ExternalContactsApi.html#delete_externalcontacts_organization_trustor) | Unlink the Trustor for this External Organization
|
15
16
|
[**delete_externalcontacts_relationship**](ExternalContactsApi.html#delete_externalcontacts_relationship) | Delete a relationship
|
16
17
|
[**get_externalcontacts_contact**](ExternalContactsApi.html#get_externalcontacts_contact) | Fetch an external contact
|
17
18
|
[**get_externalcontacts_contact_note**](ExternalContactsApi.html#get_externalcontacts_contact_note) | Fetch a note for an external contact
|
@@ -35,6 +36,7 @@ Method | Description
|
|
35
36
|
[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
|
36
37
|
[**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
|
37
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 Extenral Organization
|
38
40
|
[**put_externalcontacts_relationship**](ExternalContactsApi.html#put_externalcontacts_relationship) | Update a relationship
|
39
41
|
{: class="table table-striped"}
|
40
42
|
|
@@ -276,6 +278,64 @@ nil (empty response body)
|
|
276
278
|
|
277
279
|
|
278
280
|
|
281
|
+
<a name="delete_externalcontacts_organization_trustor"></a>
|
282
|
+
|
283
|
+
## - delete_externalcontacts_organization_trustor(external_organization_id)
|
284
|
+
|
285
|
+
Unlink the Trustor for this External Organization
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
Wraps DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor
|
290
|
+
|
291
|
+
|
292
|
+
### Example
|
293
|
+
~~~ruby
|
294
|
+
# load the gem
|
295
|
+
require 'purecloudplatformclientv2'
|
296
|
+
# setup authorization
|
297
|
+
@secret = ENV['PURECLOUD_SECRET']
|
298
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
299
|
+
environment = "mypurecloud.com"
|
300
|
+
|
301
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
302
|
+
|
303
|
+
PureCloud.configure do |config|
|
304
|
+
config.access_token = @authToken
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
308
|
+
|
309
|
+
external_organization_id = "external_organization_id_example" # String | External Organization ID
|
310
|
+
|
311
|
+
|
312
|
+
begin
|
313
|
+
#Unlink the Trustor for this External Organization
|
314
|
+
api_instance.delete_externalcontacts_organization_trustor(external_organization_id)
|
315
|
+
rescue PureCloud::ApiError => e
|
316
|
+
puts "Exception when calling ExternalContactsApi->delete_externalcontacts_organization_trustor: #{e}"
|
317
|
+
end
|
318
|
+
~~~
|
319
|
+
|
320
|
+
### Parameters
|
321
|
+
|
322
|
+
Name | Type | Description | Notes
|
323
|
+
------------- | ------------- | ------------- | -------------
|
324
|
+
**external_organization_id** | **String**| External Organization ID | |
|
325
|
+
{: class="table table-striped"}
|
326
|
+
|
327
|
+
|
328
|
+
### Return type
|
329
|
+
|
330
|
+
nil (empty response body)
|
331
|
+
|
332
|
+
### HTTP request headers
|
333
|
+
|
334
|
+
- **Content-Type**: application/json
|
335
|
+
- **Accept**: application/json
|
336
|
+
|
337
|
+
|
338
|
+
|
279
339
|
<a name="delete_externalcontacts_relationship"></a>
|
280
340
|
|
281
341
|
## - delete_externalcontacts_relationship(relationship_id)
|
@@ -631,7 +691,8 @@ api_instance = PureCloud::ExternalContactsApi.new
|
|
631
691
|
external_organization_id = "external_organization_id_example" # String | External Organization ID
|
632
692
|
|
633
693
|
opts = {
|
634
|
-
expand:
|
694
|
+
expand: "expand_example", # String | which fields, if any, to expand (externalDataSources)
|
695
|
+
include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
|
635
696
|
}
|
636
697
|
|
637
698
|
begin
|
@@ -648,7 +709,8 @@ end
|
|
648
709
|
Name | Type | Description | Notes
|
649
710
|
------------- | ------------- | ------------- | -------------
|
650
711
|
**external_organization_id** | **String**| External Organization ID | |
|
651
|
-
**expand** |
|
712
|
+
**expand** | **String**| which fields, if any, to expand (externalDataSources) | [optional] <br />**Values**: externalDataSources |
|
713
|
+
**include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
|
652
714
|
{: class="table table-striped"}
|
653
715
|
|
654
716
|
|
@@ -971,7 +1033,8 @@ opts = {
|
|
971
1033
|
page_number: 1, # Integer | Page number
|
972
1034
|
q: "q_example", # String | Search query
|
973
1035
|
sort_order: "sort_order_example", # String | Sort order
|
974
|
-
expand: "expand_example" # String | which fields, if any, to expand
|
1036
|
+
expand: ["expand_example"], # Array<String> | which fields, if any, to expand
|
1037
|
+
include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
|
975
1038
|
}
|
976
1039
|
|
977
1040
|
begin
|
@@ -991,7 +1054,8 @@ Name | Type | Description | Notes
|
|
991
1054
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
992
1055
|
**q** | **String**| Search query | [optional] |
|
993
1056
|
**sort_order** | **String**| Sort order | [optional] |
|
994
|
-
**expand** | **String
|
1057
|
+
**expand** | [**Array<String>**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
|
1058
|
+
**include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
|
995
1059
|
{: class="table table-striped"}
|
996
1060
|
|
997
1061
|
|
@@ -1758,6 +1822,68 @@ Name | Type | Description | Notes
|
|
1758
1822
|
|
1759
1823
|
|
1760
1824
|
|
1825
|
+
<a name="put_externalcontacts_organization_trustor_trustor_id"></a>
|
1826
|
+
|
1827
|
+
## -[**ExternalOrganization**](ExternalOrganization.html) put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id)
|
1828
|
+
|
1829
|
+
Links a Trustor with an Extenral Organization
|
1830
|
+
|
1831
|
+
|
1832
|
+
|
1833
|
+
Wraps PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}
|
1834
|
+
|
1835
|
+
|
1836
|
+
### Example
|
1837
|
+
~~~ruby
|
1838
|
+
# load the gem
|
1839
|
+
require 'purecloudplatformclientv2'
|
1840
|
+
# setup authorization
|
1841
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1842
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1843
|
+
environment = "mypurecloud.com"
|
1844
|
+
|
1845
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1846
|
+
|
1847
|
+
PureCloud.configure do |config|
|
1848
|
+
config.access_token = @authToken
|
1849
|
+
end
|
1850
|
+
|
1851
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
1852
|
+
|
1853
|
+
external_organization_id = "external_organization_id_example" # String | External Organization ID
|
1854
|
+
|
1855
|
+
trustor_id = "trustor_id_example" # String | Trustor ID
|
1856
|
+
|
1857
|
+
|
1858
|
+
begin
|
1859
|
+
#Links a Trustor with an Extenral Organization
|
1860
|
+
result = api_instance.put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id)
|
1861
|
+
p result
|
1862
|
+
rescue PureCloud::ApiError => e
|
1863
|
+
puts "Exception when calling ExternalContactsApi->put_externalcontacts_organization_trustor_trustor_id: #{e}"
|
1864
|
+
end
|
1865
|
+
~~~
|
1866
|
+
|
1867
|
+
### Parameters
|
1868
|
+
|
1869
|
+
Name | Type | Description | Notes
|
1870
|
+
------------- | ------------- | ------------- | -------------
|
1871
|
+
**external_organization_id** | **String**| External Organization ID | |
|
1872
|
+
**trustor_id** | **String**| Trustor ID | |
|
1873
|
+
{: class="table table-striped"}
|
1874
|
+
|
1875
|
+
|
1876
|
+
### Return type
|
1877
|
+
|
1878
|
+
[**ExternalOrganization**](ExternalOrganization.html)
|
1879
|
+
|
1880
|
+
### HTTP request headers
|
1881
|
+
|
1882
|
+
- **Content-Type**: application/json
|
1883
|
+
- **Accept**: application/json
|
1884
|
+
|
1885
|
+
|
1886
|
+
|
1761
1887
|
<a name="put_externalcontacts_relationship"></a>
|
1762
1888
|
|
1763
1889
|
## -[**Relationship**](Relationship.html) put_externalcontacts_relationship(relationship_id, opts)
|
@@ -23,6 +23,7 @@ title: ExternalOrganization
|
|
23
23
|
| **twitter_id** | [**TwitterId**](TwitterId.html) | | [optional] |
|
24
24
|
| **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
25
|
| **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
26
|
+
| **trustor** | [**Trustor**](Trustor.html) | | [optional] |
|
26
27
|
| **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
|
27
28
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
28
29
|
{: class="table table-striped"}
|
@@ -14,8 +14,8 @@ title: ExternalOrganizationListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: FaxDocumentEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/FlowEntityListing.md
CHANGED
@@ -14,8 +14,8 @@ title: FlowEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: FlowVersionEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/GreetingListing.md
CHANGED
@@ -14,8 +14,8 @@ title: GreetingListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/GroupEntityListing.md
CHANGED
@@ -14,8 +14,8 @@ title: GroupEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: HeartBeatAlertContainer
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: HeartBeatRuleContainer
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: InboundDomainEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: InboundRouteEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: InteractionStatsAlertContainer
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: InteractionStatsRuleContainer
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/JsonNode.md
CHANGED
@@ -12,7 +12,8 @@ title: JsonNode
|
|
12
12
|
| **object** | **BOOLEAN** | | [optional] |
|
13
13
|
| **boolean** | **BOOLEAN** | | [optional] |
|
14
14
|
| **number** | **BOOLEAN** | | [optional] |
|
15
|
-
| **
|
15
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
16
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
16
17
|
| **pojo** | **BOOLEAN** | | [optional] |
|
17
18
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
18
19
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
@@ -24,8 +25,7 @@ title: JsonNode
|
|
24
25
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
25
26
|
| **textual** | **BOOLEAN** | | [optional] |
|
26
27
|
| **binary** | **BOOLEAN** | | [optional] |
|
27
|
-
| **
|
28
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
28
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
@@ -14,8 +14,8 @@ title: KeywordSetEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: LanguageEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -14,8 +14,8 @@ title: LibraryEntityListing
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/LicenseApi.md
CHANGED
@@ -77,7 +77,7 @@ Name | Type | Description | Notes
|
|
77
77
|
|
78
78
|
<a name="get_license_definitions"></a>
|
79
79
|
|
80
|
-
## -[**
|
80
|
+
## -[**Array<LicenseDefinition>**](LicenseDefinition.html) get_license_definitions
|
81
81
|
|
82
82
|
Get all PureCloud license definitions available for the organization.
|
83
83
|
|
@@ -119,7 +119,7 @@ This endpoint does not need any parameter.
|
|
119
119
|
|
120
120
|
### Return type
|
121
121
|
|
122
|
-
[**
|
122
|
+
[**Array<LicenseDefinition>**](LicenseDefinition.html)
|
123
123
|
|
124
124
|
### HTTP request headers
|
125
125
|
|
@@ -242,7 +242,7 @@ Name | Type | Description | Notes
|
|
242
242
|
|
243
243
|
<a name="post_license_organization"></a>
|
244
244
|
|
245
|
-
## -[**
|
245
|
+
## -[**Array<LicenseUpdateStatus>**](LicenseUpdateStatus.html) post_license_organization(opts)
|
246
246
|
|
247
247
|
Update the organization's license assignments in a batch.
|
248
248
|
|
@@ -291,7 +291,7 @@ Name | Type | Description | Notes
|
|
291
291
|
|
292
292
|
### Return type
|
293
293
|
|
294
|
-
[**
|
294
|
+
[**Array<LicenseUpdateStatus>**](LicenseUpdateStatus.html)
|
295
295
|
|
296
296
|
### HTTP request headers
|
297
297
|
|