67.0.0

MyPureCloud · Sep 15, 2021 · 48bab82 · 48bab82
1 parent 1783256
commit 48bab82
Show file tree

Hide file tree

Showing 585 changed files with 6,303 additions and 2,012 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 = '66.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '66.0.0' }
+  s.version = '67.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '67.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
@@ -12,7 +12,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 => '66.0.0'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '67.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 = '66.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '66.0.0' }
+  s.version = '67.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '67.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
@@ -12,7 +12,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 => '66.0.0'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '67.0.0'
 ```
 
 Then install your project's dependencies:

diff --git a/build/docs/ADFS.md b/build/docs/ADFS.md
@@ -14,9 +14,9 @@ title: ADFS
 | **ssoTargetURI** | **String** |  | [optional] |
 | **sloURI** | **String** |  | [optional] |
 | **sloBinding** | **String** |  | [optional] |
+| **relyingPartyIdentifier** | **String** |  | [optional] |
 | **certificate** | **String** |  | [optional] |
 | **certificates** | **[String]** |  | [optional] |
-| **relyingPartyIdentifier** | **String** |  | [optional] |
 | **selfUri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/AchievedOutcome.md b/build/docs/AchievedOutcome.md
@@ -0,0 +1,15 @@
+---
+title: AchievedOutcome
+---
+## AchievedOutcome
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **_id** | **String** | The globally unique identifier for the object. | [optional] |
+| **outcome** | [**AddressableEntityRef**](AddressableEntityRef.html) | The ID of the outcome achieved. | [optional] |
+| **selfUri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/ActionEntityListing.md b/build/docs/ActionEntityListing.md
@@ -13,8 +13,8 @@ title: ActionEntityListing
 | **total** | **Int64** |  | [optional] |
 | **firstUri** | **String** |  | [optional] |
 | **selfUri** | **String** |  | [optional] |
-| **nextUri** | **String** |  | [optional] |
 | **previousUri** | **String** |  | [optional] |
+| **nextUri** | **String** |  | [optional] |
 | **lastUri** | **String** |  | [optional] |
 | **pageCount** | **Int** |  | [optional] |
 {: class="table table-striped"}

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

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

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

diff --git a/build/docs/AnalyticsAPI.md b/build/docs/AnalyticsAPI.md
@@ -30,6 +30,7 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**getAnalyticsUsersDetailsJob**](AnalyticsAPI.html#getAnalyticsUsersDetailsJob) | Get status for async query for user details |
 | [**getAnalyticsUsersDetailsJobResults**](AnalyticsAPI.html#getAnalyticsUsersDetailsJobResults) | Fetch a page of results for an async query |
 | [**getAnalyticsUsersDetailsJobsAvailability**](AnalyticsAPI.html#getAnalyticsUsersDetailsJobsAvailability) | Lookup the datalake availability date and time |
+| [**patchAnalyticsReportingSettings**](AnalyticsAPI.html#patchAnalyticsReportingSettings) | Patch AnalyticsReportingSettings values for an organization |
 | [**postAnalyticsBotsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsBotsAggregatesQuery) | Query for bot aggregates |
 | [**postAnalyticsConversationDetailsProperties**](AnalyticsAPI.html#postAnalyticsConversationDetailsProperties) | Index conversation properties |
 | [**postAnalyticsConversationsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsConversationsAggregatesQuery) | Query for conversation aggregates |
@@ -1251,6 +1252,60 @@ This endpoint does not require any parameters.
 
 [**DataAvailabilityResponse**](DataAvailabilityResponse.html)
 
+<a name="patchAnalyticsReportingSettings"></a>
+
+# **patchAnalyticsReportingSettings**
+
+
+
+> [AnalyticsReportingSettings](AnalyticsReportingSettings.html) patchAnalyticsReportingSettings(body)
+
+Patch AnalyticsReportingSettings values for an organization
+
+
+
+Wraps PATCH /api/v2/analytics/reporting/settings  
+
+Requires ANY permissions: 
+
+* recording:recordingSegment:view
+* analytics:conversationDetail:view
+* analytics:dashboardConfigurations:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let body: AnalyticsReportingSettings = new AnalyticsReportingSettings(...) // AnalyticsReportingSettingsRequest
+
+// Code example
+AnalyticsAPI.patchAnalyticsReportingSettings(body: body) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AnalyticsAPI.patchAnalyticsReportingSettings was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **body** | [**AnalyticsReportingSettings**](AnalyticsReportingSettings.html)| AnalyticsReportingSettingsRequest | |
+{: class="table-striped"}
+
+
+### Return type
+
+[**AnalyticsReportingSettings**](AnalyticsReportingSettings.html)
+
 <a name="postAnalyticsBotsAggregatesQuery"></a>
 
 # **postAnalyticsBotsAggregatesQuery**
@@ -2205,7 +2260,7 @@ Wraps POST /api/v2/analytics/users/details/query
 
 Requires ANY permissions: 
 
-* analytics:userObservation:view
+* analytics:userDetail:view
 
 ### Example
 

diff --git a/build/docs/AnalyticsReportingSettings.md b/build/docs/AnalyticsReportingSettings.md
@@ -0,0 +1,13 @@
+---
+title: AnalyticsReportingSettings
+---
+## AnalyticsReportingSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **piiMaskingEnabled** | **Bool** | Indication of whether or not personal data is masked in data export and the Analytics/Reporting UI | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/Annotation.md b/build/docs/Annotation.md
@@ -17,7 +17,7 @@ title: Annotation
 | **recordingLocation** | **Int64** | Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts | [optional] |
 | **recordingDurationMs** | **Int64** | Duration of annotation (milliseconds), adjusted for any recording cuts. | [optional] |
 | **user** | [**User**](User.html) | User that created this annotation (if any). | [optional] |
-| **_description** | **String** | Text of annotation. | [optional] |
+| **_description** | **String** | Text of annotation. Maximum character limit is 500. | [optional] |
 | **selfUri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/ArchitectAPI.md b/build/docs/ArchitectAPI.md
@@ -62,6 +62,8 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**getFlowsDatatableRow**](ArchitectAPI.html#getFlowsDatatableRow) | Returns a specific row for the datatable |
 | [**getFlowsDatatableRows**](ArchitectAPI.html#getFlowsDatatableRows) | Returns the rows for the datatable with the given id |
 | [**getFlowsDatatables**](ArchitectAPI.html#getFlowsDatatables) | Retrieve a list of datatables for the org |
+| [**getFlowsDatatablesDivisionview**](ArchitectAPI.html#getFlowsDatatablesDivisionview) | Returns a specific datatable by id |
+| [**getFlowsDatatablesDivisionviews**](ArchitectAPI.html#getFlowsDatatablesDivisionviews) | Retrieve a list of datatables for the org |
 | [**getFlowsDivisionviews**](ArchitectAPI.html#getFlowsDivisionviews) | Get a pageable list of basic flow information objects filterable by query parameters. |
 | [**getFlowsExecution**](ArchitectAPI.html#getFlowsExecution) | Get a flow execution&#39;s details. Flow execution details are available for several days after the flow is started. |
 | [**getFlowsMilestone**](ArchitectAPI.html#getFlowsMilestone) | Get a flow milestone |
@@ -3237,6 +3239,124 @@ ArchitectAPI.getFlowsDatatables(expand: expand, pageNumber: pageNumber, pageSize
 {: class="table-striped"}
 
 
+### Return type
+
+[**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html)
+
+<a name="getFlowsDatatablesDivisionview"></a>
+
+# **getFlowsDatatablesDivisionview**
+
+
+
+> [DataTable](DataTable.html) getFlowsDatatablesDivisionview(datatableId, expand)
+
+Returns a specific datatable by id
+
+Given a datatableId returns the datatable object and schema associated with it.
+
+Wraps GET /api/v2/flows/datatables/divisionviews/{datatableId}  
+
+Requires ALL permissions: 
+
+* architect:datatable:search
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let datatableId: String = "" // id of datatable
+let expand: ArchitectAPI.Expand_getFlowsDatatablesDivisionview = ArchitectAPI.Expand_getFlowsDatatablesDivisionview.enummember // Expand instructions for the result
+
+// Code example
+ArchitectAPI.getFlowsDatatablesDivisionview(datatableId: datatableId, expand: expand) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("ArchitectAPI.getFlowsDatatablesDivisionview was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **datatableId** | **String**| id of datatable | |
+| **expand** | **String**| Expand instructions for the result | [optional]<br />**Values**: schema ("schema") |
+{: class="table-striped"}
+
+
+### Return type
+
+[**DataTable**](DataTable.html)
+
+<a name="getFlowsDatatablesDivisionviews"></a>
+
+# **getFlowsDatatablesDivisionviews**
+
+
+
+> [DataTablesDomainEntityListing](DataTablesDomainEntityListing.html) getFlowsDatatablesDivisionviews(expand, pageNumber, pageSize, sortBy, sortOrder, divisionId, name)
+
+Retrieve a list of datatables for the org
+
+Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
+
+Wraps GET /api/v2/flows/datatables/divisionviews  
+
+Requires ALL permissions: 
+
+* architect:datatable:search
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let expand: ArchitectAPI.Expand_getFlowsDatatablesDivisionviews = ArchitectAPI.Expand_getFlowsDatatablesDivisionviews.enummember // Expand instructions for the result
+let pageNumber: Int = 1 // Page number
+let pageSize: Int = 25 // Page size
+let sortBy: ArchitectAPI.SortBy_getFlowsDatatablesDivisionviews = ArchitectAPI.SortBy_getFlowsDatatablesDivisionviews.enummember // Sort by
+let sortOrder: String = "ascending" // Sort order
+let divisionId: [String] = [""] // division ID(s)
+let name: String = "" // Name to filter by
+
+// Code example
+ArchitectAPI.getFlowsDatatablesDivisionviews(expand: expand, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, divisionId: divisionId, name: name) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("ArchitectAPI.getFlowsDatatablesDivisionviews was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **expand** | **String**| Expand instructions for the result | [optional]<br />**Values**: schema ("schema") |
+| **pageNumber** | **Int**| Page number | [optional] [default to 1] |
+| **pageSize** | **Int**| Page size | [optional] [default to 25] |
+| **sortBy** | **String**| Sort by | [optional] [default to id]<br />**Values**: _id ("id"), name ("name") |
+| **sortOrder** | **String**| Sort order | [optional] [default to ascending] |
+| **divisionId** | [**[String]**](String.html)| division ID(s) | [optional] |
+| **name** | **String**| Name to filter by | [optional] |
+{: class="table-striped"}
+
+
 ### Return type
 
 [**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html)

diff --git a/build/docs/AssignedSegment.md b/build/docs/AssignedSegment.md
@@ -0,0 +1,15 @@
+---
+title: AssignedSegment
+---
+## AssignedSegment
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **_id** | **String** | The globally unique identifier for the object. | [optional] |
+| **segment** | [**AddressableEntityRef**](AddressableEntityRef.html) | The ID of the segment assigned. | [optional] |
+| **selfUri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AssignmentGroup.md b/build/docs/AssignmentGroup.md
diff --git a/build/docs/AttemptLimitsEntityListing.md b/build/docs/AttemptLimitsEntityListing.md
@@ -13,8 +13,8 @@ title: AttemptLimitsEntityListing
 | **total** | **Int64** |  | [optional] |
 | **firstUri** | **String** |  | [optional] |
 | **selfUri** | **String** |  | [optional] |
-| **nextUri** | **String** |  | [optional] |
 | **previousUri** | **String** |  | [optional] |
+| **nextUri** | **String** |  | [optional] |
 | **lastUri** | **String** |  | [optional] |
 | **pageCount** | **Int** |  | [optional] |
 {: class="table table-striped"}