3.0.0

MyPureCloud · Sep 17, 2019 · e06af4d · e06af4d
1 parent 06d6b91
commit e06af4d
Show file tree

Hide file tree

Showing 612 changed files with 5,892 additions and 2,618 deletions.
diff --git a/PureCloudPlatformClientV2.podspec b/PureCloudPlatformClientV2.podspec
@@ -3,8 +3,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '10.0'
   s.osx.deployment_target = '10.11'
   s.swift_version = '5.0'
-  s.version = '2.0.5'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '2.0.5' }
+  s.version = '3.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '3.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   s.license = 'MIT'

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl
 Reference the SDK's pod in your project's Podfile:
 
 ```
-pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '2.0.5'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '3.0.0'
 ```
 
 Then install your project's dependencies:

diff --git a/build/PureCloudPlatformClientV2.podspec b/build/PureCloudPlatformClientV2.podspec
@@ -3,8 +3,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '10.0'
   s.osx.deployment_target = '10.11'
   s.swift_version = '5.0'
-  s.version = '2.0.5'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '2.0.5' }
+  s.version = '3.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '3.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   s.license = 'MIT'

diff --git a/build/README.md b/build/README.md
@@ -11,7 +11,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl
 Reference the SDK's pod in your project's Podfile:
 
 ```
-pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '2.0.5'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '3.0.0'
 ```
 
 Then install your project's dependencies:

diff --git a/build/docs/ActionEntityListing.md b/build/docs/ActionEntityListing.md
@@ -13,9 +13,9 @@ title: ActionEntityListing
 | **total** | **Int64** |  | [optional] |
 | **firstUri** | **String** |  | [optional] |
 | **selfUri** | **String** |  | [optional] |
-| **lastUri** | **String** |  | [optional] |
-| **previousUri** | **String** |  | [optional] |
 | **nextUri** | **String** |  | [optional] |
+| **previousUri** | **String** |  | [optional] |
+| **lastUri** | **String** |  | [optional] |
 | **pageCount** | **Int** |  | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/AgentActivityEntityListing.md b/build/docs/AgentActivityEntityListing.md
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
 | **total** | **Int64** |  | [optional] |
 | **firstUri** | **String** |  | [optional] |
 | **selfUri** | **String** |  | [optional] |
-| **lastUri** | **String** |  | [optional] |
-| **previousUri** | **String** |  | [optional] |
 | **nextUri** | **String** |  | [optional] |
+| **previousUri** | **String** |  | [optional] |
+| **lastUri** | **String** |  | [optional] |
 | **pageCount** | **Int** |  | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/AnalyticsAPI.md b/build/docs/AnalyticsAPI.md
@@ -7,9 +7,12 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 | Method | Description |
 | ------------- | ------------- |
+| [**deleteAnalyticsConversationsDetailsJob**](AnalyticsAPI.html#deleteAnalyticsConversationsDetailsJob) | Delete/cancel an async request |
 | [**deleteAnalyticsReportingSchedule**](AnalyticsAPI.html#deleteAnalyticsReportingSchedule) | Delete a scheduled report job. |
 | [**getAnalyticsConversationDetails**](AnalyticsAPI.html#getAnalyticsConversationDetails) | Get a conversation by id |
 | [**getAnalyticsConversationsDetails**](AnalyticsAPI.html#getAnalyticsConversationsDetails) | Gets multiple conversations by id |
+| [**getAnalyticsConversationsDetailsJob**](AnalyticsAPI.html#getAnalyticsConversationsDetailsJob) | Get status for async query for conversation details |
+| [**getAnalyticsConversationsDetailsJobResults**](AnalyticsAPI.html#getAnalyticsConversationsDetailsJobResults) | Fetch a page of results for an async query |
 | [**getAnalyticsReportingExports**](AnalyticsAPI.html#getAnalyticsReportingExports) | Get all view export requests for a user |
 | [**getAnalyticsReportingMetadata**](AnalyticsAPI.html#getAnalyticsReportingMetadata) | Get list of reporting metadata. |
 | [**getAnalyticsReportingReportIdMetadata**](AnalyticsAPI.html#getAnalyticsReportingReportIdMetadata) | Get a reporting metadata. |
@@ -22,6 +25,7 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**getAnalyticsReportingTimeperiods**](AnalyticsAPI.html#getAnalyticsReportingTimeperiods) | Get a list of report time periods. |
 | [**postAnalyticsConversationDetailsProperties**](AnalyticsAPI.html#postAnalyticsConversationDetailsProperties) | Index conversation properties |
 | [**postAnalyticsConversationsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsConversationsAggregatesQuery) | Query for conversation aggregates |
+| [**postAnalyticsConversationsDetailsJobs**](AnalyticsAPI.html#postAnalyticsConversationsDetailsJobs) | Query for conversation details asynchronously |
 | [**postAnalyticsConversationsDetailsQuery**](AnalyticsAPI.html#postAnalyticsConversationsDetailsQuery) | Query for conversation details |
 | [**postAnalyticsEvaluationsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsEvaluationsAggregatesQuery) | Query for evaluation aggregates |
 | [**postAnalyticsFlowsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsFlowsAggregatesQuery) | Query for flow aggregates |
@@ -37,6 +41,57 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**putAnalyticsReportingSchedule**](AnalyticsAPI.html#putAnalyticsReportingSchedule) | Update a scheduled report job. |
 {: class="table-striped"}
 
+<a name="deleteAnalyticsConversationsDetailsJob"></a>
+
+# **deleteAnalyticsConversationsDetailsJob**
+
+
+
+> Void deleteAnalyticsConversationsDetailsJob(jobId)
+
+Delete/cancel an async request
+
+
+
+Wraps DELETE /api/v2/analytics/conversations/details/jobs/{jobId}  
+
+Requires ANY permissions: 
+
+* analytics:conversationDetail:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let jobId: String = "" // jobId
+
+// Code example
+AnalyticsAPI.deleteAnalyticsConversationsDetailsJob(jobId: jobId) { (error) in
+    if let error = error {
+        dump(error)
+    } else {
+        print("AnalyticsAPI.deleteAnalyticsConversationsDetailsJob was successful")
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **jobId** | **String**| jobId | |
+{: class="table-striped"}
+
+
+### Return type
+
+`nil` (empty response body)
+
 <a name="deleteAnalyticsReportingSchedule"></a>
 
 # **deleteAnalyticsReportingSchedule**
@@ -191,6 +246,112 @@ AnalyticsAPI.getAnalyticsConversationsDetails(_id: _id) { (response, error) in
 
 [**AnalyticsConversationMultiGetResponse**](AnalyticsConversationMultiGetResponse.html)
 
+<a name="getAnalyticsConversationsDetailsJob"></a>
+
+# **getAnalyticsConversationsDetailsJob**
+
+
+
+> [AsyncQueryStatus](AsyncQueryStatus.html) getAnalyticsConversationsDetailsJob(jobId)
+
+Get status for async query for conversation details
+
+
+
+Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}  
+
+Requires ANY permissions: 
+
+* analytics:conversationDetail:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let jobId: String = "" // jobId
+
+// Code example
+AnalyticsAPI.getAnalyticsConversationsDetailsJob(jobId: jobId) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AnalyticsAPI.getAnalyticsConversationsDetailsJob was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **jobId** | **String**| jobId | |
+{: class="table-striped"}
+
+
+### Return type
+
+[**AsyncQueryStatus**](AsyncQueryStatus.html)
+
+<a name="getAnalyticsConversationsDetailsJobResults"></a>
+
+# **getAnalyticsConversationsDetailsJobResults**
+
+
+
+> [AnalyticsConversationAsyncQueryResponse](AnalyticsConversationAsyncQueryResponse.html) getAnalyticsConversationsDetailsJobResults(jobId, cursor)
+
+Fetch a page of results for an async query
+
+
+
+Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}/results  
+
+Requires ANY permissions: 
+
+* analytics:conversationDetail:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let jobId: String = "" // jobId
+let cursor: String = "" // Indicates where to resume query results (not required for first page)
+
+// Code example
+AnalyticsAPI.getAnalyticsConversationsDetailsJobResults(jobId: jobId, cursor: cursor) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AnalyticsAPI.getAnalyticsConversationsDetailsJobResults was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **jobId** | **String**| jobId | |
+| **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
+{: class="table-striped"}
+
+
+### Return type
+
+[**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html)
+
 <a name="getAnalyticsReportingExports"></a>
 
 # **getAnalyticsReportingExports**
@@ -810,6 +971,58 @@ AnalyticsAPI.postAnalyticsConversationsAggregatesQuery(body: body) { (response,
 
 [**AggregateQueryResponse**](AggregateQueryResponse.html)
 
+<a name="postAnalyticsConversationsDetailsJobs"></a>
+
+# **postAnalyticsConversationsDetailsJobs**
+
+
+
+> [AsyncQueryResponse](AsyncQueryResponse.html) postAnalyticsConversationsDetailsJobs(body)
+
+Query for conversation details asynchronously
+
+
+
+Wraps POST /api/v2/analytics/conversations/details/jobs  
+
+Requires ANY permissions: 
+
+* analytics:conversationDetail:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let body: AsyncConversationQuery = new AsyncConversationQuery(...) // query
+
+// Code example
+AnalyticsAPI.postAnalyticsConversationsDetailsJobs(body: body) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AnalyticsAPI.postAnalyticsConversationsDetailsJobs was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **body** | [**AsyncConversationQuery**](AsyncConversationQuery.html)| query | |
+{: class="table-striped"}
+
+
+### Return type
+
+[**AsyncQueryResponse**](AsyncQueryResponse.html)
+
 <a name="postAnalyticsConversationsDetailsQuery"></a>
 
 # **postAnalyticsConversationsDetailsQuery**

diff --git a/build/docs/AnalyticsConversationAsyncQueryResponse.md b/build/docs/AnalyticsConversationAsyncQueryResponse.md
@@ -0,0 +1,14 @@
+---
+title: AnalyticsConversationAsyncQueryResponse
+---
+## AnalyticsConversationAsyncQueryResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **conversations** | [**[AnalyticsConversation]**](AnalyticsConversation.html) |  | [optional] |
+| **cursor** | **String** | Optional cursor to indicate where to resume the results | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AnalyticsEvaluation.md b/build/docs/AnalyticsEvaluation.md
@@ -16,8 +16,8 @@ title: AnalyticsEvaluation
 | **contextId** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
 | **formName** | **String** | Name of the evaluation form | [optional] |
 | **calibrationId** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
-| **oTotalCriticalScore** | **Int64** |  | [optional] |
 | **oTotalScore** | **Int64** |  | [optional] |
+| **oTotalCriticalScore** | **Int64** |  | [optional] |
 {: class="table table-striped"}
 
 
diff --git a/build/docs/ArrayNode.md b/build/docs/ArrayNode.md
@@ -12,20 +12,20 @@ title: ArrayNode
 | **number** | **Bool** |  | [optional] |
 | **object** | **Bool** |  | [optional] |
 | **boolean** | **Bool** |  | [optional] |
-| **floatingPointNumber** | **Bool** |  | [optional] |
+| **missingNode** | **Bool** |  | [optional] |
+| **valueNode** | **Bool** |  | [optional] |
+| **binary** | **Bool** |  | [optional] |
+| **pojo** | **Bool** |  | [optional] |
+| **containerNode** | **Bool** |  | [optional] |
+| **int** | **Bool** |  | [optional] |
 | **integralNumber** | **Bool** |  | [optional] |
 | **short** | **Bool** |  | [optional] |
-| **int** | **Bool** |  | [optional] |
 | **long** | **Bool** |  | [optional] |
+| **floatingPointNumber** | **Bool** |  | [optional] |
 | **double** | **Bool** |  | [optional] |
 | **bigDecimal** | **Bool** |  | [optional] |
 | **bigInteger** | **Bool** |  | [optional] |
 | **textual** | **Bool** |  | [optional] |
-| **binary** | **Bool** |  | [optional] |
-| **valueNode** | **Bool** |  | [optional] |
-| **containerNode** | **Bool** |  | [optional] |
-| **missingNode** | **Bool** |  | [optional] |
-| **pojo** | **Bool** |  | [optional] |
 | **array** | **Bool** |  | [optional] |
 | **null** | **Bool** |  | [optional] |
 {: class="table table-striped"}

diff --git a/build/docs/AsyncQueryResponse.md b/build/docs/AsyncQueryResponse.md
@@ -0,0 +1,13 @@
+---
+title: AsyncQueryResponse
+---
+## AsyncQueryResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **jobId** | **String** | Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AsyncQueryStatus.md b/build/docs/AsyncQueryStatus.md
@@ -0,0 +1,17 @@
+---
+title: AsyncQueryStatus
+---
+## AsyncQueryStatus
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **state** | **String** | The current state of the asynchronous query | [optional] |
+| **errorMessage** | **String** | The error associated with the current query, if the state is FAILED | [optional] |
+| **expirationDate** | [**Date**](Date.html) | The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **submissionDate** | [**Date**](Date.html) | The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **completionDate** | [**Date**](Date.html) | The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+