purecloudplatformclientv2 91.0.0 → 96.0.0

data/docs/CreateCoachingAppointmentRequest.md

@@ -9,7 +9,7 @@ title: CreateCoachingAppointmentRequest
 |------------ | ------------- | ------------- | -------------|
 | **name** | **String** | The name of coaching appointment. | |
 | **description** | **String** | The description of coaching appointment. | |
-| **date_start** | **DateTime** | The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **date_start** | **DateTime** | The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
 | **length_in_minutes** | **Integer** | The duration of coaching appointment in minutes. | |
 | **facilitator_id** | **String** | The facilitator ID of coaching appointment. | [optional] |
 | **attendee_ids** | **Array<String>** | IDs of attendees in the coaching appointment. | |

data/docs/CursorContactListing.md

@@ -0,0 +1,16 @@
+---
+title: CursorContactListing
+---
+## PureCloud::CursorContactListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<ExternalContact>**](ExternalContact.html) |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CursorNoteListing.md

@@ -0,0 +1,16 @@
+---
+title: CursorNoteListing
+---
+## PureCloud::CursorNoteListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<Note>**](Note.html) |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CursorOrganizationListing.md

@@ -0,0 +1,16 @@
+---
+title: CursorOrganizationListing
+---
+## PureCloud::CursorOrganizationListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<ExternalOrganization>**](ExternalOrganization.html) |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CursorRelationshipListing.md

@@ -0,0 +1,16 @@
+---
+title: CursorRelationshipListing
+---
+## PureCloud::CursorRelationshipListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<Relationship>**](Relationship.html) |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/EdgeGroup.md

@@ -19,6 +19,7 @@ title: EdgeGroup
 | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
 | **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **managed** | **BOOLEAN** | Is this edge group being managed remotely. | [optional] |
+| **hybrid** | **BOOLEAN** | Is this edge group hybrid. | [optional] |
 | **edge_trunk_base_assignment** | [**TrunkBaseAssignment**](TrunkBaseAssignment.html) | A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication. | |
 | **phone_trunk_bases** | [**Array<TrunkBase>**](TrunkBase.html) | Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication. | |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/Education.md

@@ -0,0 +1,17 @@
+---
+title: Education
+---
+## PureCloud::Education
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **school** | **String** |  | [optional] |
+| **field_of_study** | **String** |  | [optional] |
+| **notes** | **String** | Notes about education has a 2000 character limit | [optional] |
+| **date_start** | **Date** | Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
+| **date_end** | **Date** | Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Email.md

@@ -29,6 +29,7 @@ title: Email
 | **draft_attachments** | [**Array<Attachment>**](Attachment.html) | A list of uploaded attachments on the email draft. | [optional] |
 | **spam** | **BOOLEAN** | Indicates if the inbound email was marked as spam. | [optional] |
 | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
+| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/EntityListing.md

@@ -7,11 +7,7 @@ title: EntityListing
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **entities** | [**Array<DataTableImportJob>**](DataTableImportJob.html) |  | [optional] |
-| **page_size** | **Integer** |  | [optional] |
-| **page_number** | **Integer** |  | [optional] |
-| **total** | **Integer** |  | [optional] |
-| **page_count** | **Integer** |  | [optional] |
+| **entities** | **Array<Object>** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ExternalContactsApi.md

@@ -35,6 +35,10 @@ Method | Description
 [**get_externalcontacts_organizations_schemas**](ExternalContactsApi.html#get_externalcontacts_organizations_schemas) | Get a list of schemas.
 [**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
 [**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
+[**get_externalcontacts_scan_contacts**](ExternalContactsApi.html#get_externalcontacts_scan_contacts) | Scan for external contacts using paging
+[**get_externalcontacts_scan_notes**](ExternalContactsApi.html#get_externalcontacts_scan_notes) | Scan for notes using paging
+[**get_externalcontacts_scan_organizations**](ExternalContactsApi.html#get_externalcontacts_scan_organizations) | Scan for external organizations using paging
+[**get_externalcontacts_scan_relationships**](ExternalContactsApi.html#get_externalcontacts_scan_relationships) | Scan for relationships
 [**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
 [**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
 [**post_externalcontacts_contacts_schemas**](ExternalContactsApi.html#post_externalcontacts_contacts_schemas) | Create a schema
@@ -45,7 +49,7 @@ Method | Description
 [**put_externalcontacts_contact**](ExternalContactsApi.html#put_externalcontacts_contact) | Update an external contact
 [**put_externalcontacts_contact_note**](ExternalContactsApi.html#put_externalcontacts_contact_note) | Update a note for an external contact
 [**put_externalcontacts_contacts_schema**](ExternalContactsApi.html#put_externalcontacts_contacts_schema) | Update a schema
-[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
+[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate/disassociate an external contact with a conversation
 [**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
 [**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization
 [**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an External Organization
@@ -1907,6 +1911,278 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_externalcontacts_scan_contacts"></a>
+
+## [**CursorContactListing**](CursorContactListing.html) get_externalcontacts_scan_contacts(opts)
+
+
+
+Scan for external contacts using paging
+
+
+
+Wraps GET /api/v2/externalcontacts/scan/contacts 
+
+Requires ANY permissions: 
+
+* externalContacts:contact:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ExternalContactsApi.new
+
+opts = { 
+  limit: 56, # Integer | The number of contacts per page; must be between 10 and 200, default is 100)
+  cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+}
+
+begin
+  #Scan for external contacts using paging
+  result = api_instance.get_externalcontacts_scan_contacts(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of contacts per page; must be between 10 and 200, default is 100) | [optional]  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CursorContactListing**](CursorContactListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_externalcontacts_scan_notes"></a>
+
+## [**CursorNoteListing**](CursorNoteListing.html) get_externalcontacts_scan_notes(opts)
+
+
+
+Scan for notes using paging
+
+
+
+Wraps GET /api/v2/externalcontacts/scan/notes 
+
+Requires ANY permissions: 
+
+* externalContacts:contact:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ExternalContactsApi.new
+
+opts = { 
+  limit: 56, # Integer | The number of notes per page; must be between 10 and 200, default is 100)
+  cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+}
+
+begin
+  #Scan for notes using paging
+  result = api_instance.get_externalcontacts_scan_notes(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of notes per page; must be between 10 and 200, default is 100) | [optional]  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CursorNoteListing**](CursorNoteListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_externalcontacts_scan_organizations"></a>
+
+## [**CursorOrganizationListing**](CursorOrganizationListing.html) get_externalcontacts_scan_organizations(opts)
+
+
+
+Scan for external organizations using paging
+
+
+
+Wraps GET /api/v2/externalcontacts/scan/organizations 
+
+Requires ANY permissions: 
+
+* externalContacts:externalOrganization:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ExternalContactsApi.new
+
+opts = { 
+  limit: 56, # Integer | The number of organizations per page; must be between 10 and 200, default is 100)
+  cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+}
+
+begin
+  #Scan for external organizations using paging
+  result = api_instance.get_externalcontacts_scan_organizations(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_organizations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of organizations per page; must be between 10 and 200, default is 100) | [optional]  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CursorOrganizationListing**](CursorOrganizationListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_externalcontacts_scan_relationships"></a>
+
+## [**CursorRelationshipListing**](CursorRelationshipListing.html) get_externalcontacts_scan_relationships(opts)
+
+
+
+Scan for relationships
+
+
+
+Wraps GET /api/v2/externalcontacts/scan/relationships 
+
+Requires ANY permissions: 
+
+* externalContacts:contact:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::ExternalContactsApi.new
+
+opts = { 
+  limit: 56, # Integer | The number of relationships per page; must be between 10 and 200, default is 100)
+  cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+}
+
+begin
+  #Scan for relationships
+  result = api_instance.get_externalcontacts_scan_relationships(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_relationships: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of relationships per page; must be between 10 and 200, default is 100) | [optional]  |
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CursorRelationshipListing**](CursorRelationshipListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_externalcontacts_contact_notes"></a>
 
 ## [**Note**](Note.html) post_externalcontacts_contact_notes(contact_id, body)
@@ -2579,13 +2855,13 @@ Name | Type | Description  | Notes
 
 <a name="put_externalcontacts_conversation"></a>
 
-##  put_externalcontacts_conversation(conversation_id, body)
+##  put_externalcontacts_conversation(body, conversation_id)
 
 
 
-Associate an external contact with a conversation
-
+Associate/disassociate an external contact with a conversation
 
+To associate, supply a value for the externalContactId.  To disassociate, do not include the property at all.
 
 Wraps PUT /api/v2/externalcontacts/conversations/{conversationId} 
 
@@ -2611,14 +2887,14 @@ end
 
 api_instance = PureCloud::ExternalContactsApi.new
 
-conversation_id = "conversation_id_example" # String | Conversation ID
-
 body = PureCloud::ConversationAssociation.new # ConversationAssociation | ConversationAssociation
 
+conversation_id = "conversation_id_example" # String | Conversation ID
+
 
 begin
-  #Associate an external contact with a conversation
-  api_instance.put_externalcontacts_conversation(conversation_id, body)
+  #Associate/disassociate an external contact with a conversation
+  api_instance.put_externalcontacts_conversation(body, conversation_id)
 rescue PureCloud::ApiError => e
   puts "Exception when calling ExternalContactsApi->put_externalcontacts_conversation: #{e}"
 end
@@ -2628,8 +2904,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **conversation_id** | **String**| Conversation ID |  |
  **body** | [**ConversationAssociation**](ConversationAssociation.html)| ConversationAssociation |  |
+ **conversation_id** | **String**| Conversation ID |  |
 {: class="table table-striped"}