142.0.0

MyPureCloud · Jun 16, 2024 · af68d7f · af68d7f
1 parent 310fbac
commit af68d7f
Show file tree

Hide file tree

Showing 139 changed files with 10,360 additions and 5,412 deletions.
diff --git a/PureCloudPlatformClientV2.podspec b/PureCloudPlatformClientV2.podspec
@@ -4,8 +4,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '12.0'
   s.osx.deployment_target = '12.0'
   s.swift_version = '5.0'
-  s.version = '141.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '141.0.0' }
+  s.version = '142.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '142.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/'

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 => '141.0.0'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '142.0.0'
 ```
 
 Then install your project's dependencies:

diff --git a/build/.openapi-generator/FILES b/build/.openapi-generator/FILES
diff --git a/build/APIData.json b/build/APIData.json
diff --git a/build/PureCloudPlatformClientV2.podspec b/build/PureCloudPlatformClientV2.podspec
@@ -4,8 +4,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '12.0'
   s.osx.deployment_target = '12.0'
   s.swift_version = '5.0'
-  s.version = '141.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '141.0.0' }
+  s.version = '142.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '142.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/'

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 => '141.0.0'
+pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '142.0.0'
 ```
 
 Then install your project's dependencies:

diff --git a/build/docs/AgentMaxUtilizationResponse.md b/build/docs/AgentMaxUtilizationResponse.md
@@ -8,6 +8,7 @@ title: AgentMaxUtilizationResponse
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **utilization** | [**[String:MediaUtilization]**](MediaUtilization.html) | Map of media type to utilization settings. | [optional] |
+| **labelUtilizations** | [**[String:LabelUtilizationResponse]**](LabelUtilizationResponse.html) | Map of label ids to utilization settings. | [optional] |
 | **level** | **String** |  | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/AnalyticsAPI.md b/build/docs/AnalyticsAPI.md
@@ -23,6 +23,7 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**getAnalyticsReportingExports**](AnalyticsAPI.html#getAnalyticsReportingExports) | Get all view export requests for a user |
 | [**getAnalyticsReportingExportsMetadata**](AnalyticsAPI.html#getAnalyticsReportingExportsMetadata) | Get all export metadata |
 | [**getAnalyticsReportingSettings**](AnalyticsAPI.html#getAnalyticsReportingSettings) | Get AnalyticsReportingSettings for an organization |
+| [**getAnalyticsReportingSettingsDashboardsQuery**](AnalyticsAPI.html#getAnalyticsReportingSettingsDashboardsQuery) | Get list of dashboard configurations |
 | [**getAnalyticsReportingSettingsUserDashboards**](AnalyticsAPI.html#getAnalyticsReportingSettingsUserDashboards) | Get list of dashboards for an user |
 | [**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 |
@@ -44,7 +45,7 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**postAnalyticsJourneysAggregatesQuery**](AnalyticsAPI.html#postAnalyticsJourneysAggregatesQuery) | Query for journey aggregates |
 | [**postAnalyticsKnowledgeAggregatesQuery**](AnalyticsAPI.html#postAnalyticsKnowledgeAggregatesQuery) | Query for knowledge aggregates |
 | [**postAnalyticsQueuesObservationsQuery**](AnalyticsAPI.html#postAnalyticsQueuesObservationsQuery) | Query for queue observations |
-| [**postAnalyticsRatelimitsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsRatelimitsAggregatesQuery) | Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded |
+| [**postAnalyticsRatelimitsAggregatesQuery**](AnalyticsAPI.html#postAnalyticsRatelimitsAggregatesQuery) | Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. |
 | [**postAnalyticsReportingDashboardsUsersBulkRemove**](AnalyticsAPI.html#postAnalyticsReportingDashboardsUsersBulkRemove) | Bulk delete dashboards owned by other user(s) |
 | [**postAnalyticsReportingExports**](AnalyticsAPI.html#postAnalyticsReportingExports) | Generate a view export request |
 | [**postAnalyticsReportingSettingsDashboardsBulkRemove**](AnalyticsAPI.html#postAnalyticsReportingSettingsDashboardsBulkRemove) | Bulk remove dashboard configurations |
@@ -937,6 +938,66 @@ This endpoint does not require any parameters.
 
 [**AnalyticsReportingSettings**](AnalyticsReportingSettings.html)
 
+<a name="getAnalyticsReportingSettingsDashboardsQuery"></a>
+
+# **getAnalyticsReportingSettingsDashboardsQuery**
+
+
+
+> [DashboardConfigurationListing](DashboardConfigurationListing.html) getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, sortBy, pageNumber, pageSize)
+
+Get list of dashboard configurations
+
+
+
+Wraps GET /api/v2/analytics/reporting/settings/dashboards/query  
+
+Requires ALL permissions: 
+
+* analytics:dashboardConfigurations:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let dashboardType: AnalyticsAPI.DashboardType_getAnalyticsReportingSettingsDashboardsQuery = AnalyticsAPI.DashboardType_getAnalyticsReportingSettingsDashboardsQuery.enummember // List dashboard of given type
+let dashboardAccessFilter: AnalyticsAPI.DashboardAccessFilter_getAnalyticsReportingSettingsDashboardsQuery = AnalyticsAPI.DashboardAccessFilter_getAnalyticsReportingSettingsDashboardsQuery.enummember // Filter dashboard based on the owner of dashboard
+let sortBy: String = "" // 
+let pageNumber: Int = 0 // 
+let pageSize: Int = 0 // 
+
+// Code example
+AnalyticsAPI.getAnalyticsReportingSettingsDashboardsQuery(dashboardType: dashboardType, dashboardAccessFilter: dashboardAccessFilter, sortBy: sortBy, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AnalyticsAPI.getAnalyticsReportingSettingsDashboardsQuery was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **dashboardType** | **String**| List dashboard of given type |<br />**Values**: all ("All"), _public ("Public"), _private ("Private"), shared ("Shared"), favorites ("Favorites") |
+| **dashboardAccessFilter** | **String**| Filter dashboard based on the owner of dashboard |<br />**Values**: ownedByMe ("OwnedByMe"), ownedByAnyone ("OwnedByAnyone"), notOwnedByMe ("NotOwnedByMe") |
+| **sortBy** | **String**|  | [optional] |
+| **pageNumber** | **Int**|  | [optional] |
+| **pageSize** | **Int**|  | [optional] |
+{: class="table-striped"}
+
+
+### Return type
+
+[**DashboardConfigurationListing**](DashboardConfigurationListing.html)
+
 <a name="getAnalyticsReportingSettingsUserDashboards"></a>
 
 # **getAnalyticsReportingSettingsUserDashboards**
@@ -2062,7 +2123,9 @@ AnalyticsAPI.postAnalyticsQueuesObservationsQuery(body: body) { (response, error
 
 > [RateLimitAggregateQueryResponse](RateLimitAggregateQueryResponse.html) postAnalyticsRatelimitsAggregatesQuery(body)
 
-Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded
+Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.
+
+The &#39;max&#39; property can be used to determine estimated rate limit value hit.
 
 
 

diff --git a/build/docs/AnalyticsSession.md b/build/docs/AnalyticsSession.md
@@ -32,6 +32,8 @@ title: AnalyticsSession
 | **deliveryStatus** | **String** | The email or SMS delivery status | [optional] |
 | **deliveryStatusChangeDate** | [**Date**](Date.html) | Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
 | **destinationAddresses** | **[String]** | Destination address(es) of transfers or consults | [optional] |
+| **detectedSpeechEnd** | [**Date**](Date.html) | Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
+| **detectedSpeechStart** | [**Date**](Date.html) | Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
 | **direction** | **String** | The direction of the communication | [optional] |
 | **dispositionAnalyzer** | **String** | (Dialer) Analyzer (for example speech.person) | [optional] |
 | **dispositionName** | **String** | (Dialer) Result of the analysis (for example disposition.classification.callable.machine) | [optional] |

diff --git a/build/docs/AppEventRequest.md b/build/docs/AppEventRequest.md
@@ -17,7 +17,7 @@ title: AppEventRequest
 | **searchQuery** | **String** | Represents the keywords in a customer search query. | [optional] |
 | **attributes** | [**[String:CustomEventAttribute]**](CustomEventAttribute.html) | User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level. | [optional] |
 | **traits** | [**[String:CustomEventAttribute]**](CustomEventAttribute.html) | Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, lastName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions. | [optional] |
-| **customerCookieId** | **String** | Cookie ID of the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution. | |
+| **customerCookieId** | **String** | A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution. | |
 | **createdDate** | [**Date**](Date.html) | UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | |
 {: class="table table-striped"}
 

diff --git a/build/docs/AssignedLearningModule.md b/build/docs/AssignedLearningModule.md
@@ -19,6 +19,8 @@ Learning module response
 | **externalId** | **String** | The external ID of the learning module | [optional] |
 | **source** | **String** | The source of the learning module | [optional] |
 | **rule** | [**LearningModuleRule**](LearningModuleRule.html) | The rule for learning module; read-only, and only populated when requested via expand param. | [optional] |
+| **enforceContentOrder** | **Bool** | If true, learning module content should be viewed one by one in order | [optional] |
+| **reviewAssessmentResults** | [**ReviewAssessmentResults**](ReviewAssessmentResults.html) | Allows to view Assessment results in detail | [optional] |
 | **currentAssignments** | [**[LearningAssignment]**](LearningAssignment.html) | The current assignments for the requested users | [optional] |
 | **selfUri** | **String** | The URI for this object | [optional] |
 | **isArchived** | **Bool** | If true, learning module is archived | [optional] |

diff --git a/build/docs/CategoriesEntityListing.md b/build/docs/CategoriesEntityListing.md
@@ -0,0 +1,22 @@
+---
+title: CategoriesEntityListing
+---
+## CategoriesEntityListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**[StaCategory]**](StaCategory.html) |  | [optional] |
+| **pageSize** | **Int** |  | [optional] |
+| **pageNumber** | **Int** |  | [optional] |
+| **total** | **Int64** |  | [optional] |
+| **previousUri** | **String** |  | [optional] |
+| **lastUri** | **String** |  | [optional] |
+| **firstUri** | **String** |  | [optional] |
+| **selfUri** | **String** |  | [optional] |
+| **nextUri** | **String** |  | [optional] |
+| **pageCount** | **Int** |  | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CategoryRequest.md b/build/docs/CategoryRequest.md
@@ -0,0 +1,16 @@
+---
+title: CategoryRequest
+---
+## CategoryRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the category | |
+| **_description** | **String** | The description of the category | [optional] |
+| **interactionType** | **String** | The type of interaction the category will apply to | |
+| **criteria** | [**Operand**](Operand.html) | A collection of conditions joined together by logical operation to provide more refined filtering of conversations | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CertificateDetails.md b/build/docs/CertificateDetails.md
@@ -13,8 +13,8 @@ Represents the details of a parsed certificate.
 | **expirationDate** | [**Date**](Date.html) | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
 | **issueDate** | [**Date**](Date.html) | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
 | **expired** | **Bool** | True if the certificate is expired, false otherwise. | [optional] |
-| **signatureValid** | **Bool** |  | [optional] |
 | **valid** | **Bool** |  | [optional] |
+| **signatureValid** | **Bool** |  | [optional] |
 {: class="table table-striped"}
 
 
diff --git a/build/docs/CobrowseSettings.md b/build/docs/CobrowseSettings.md
@@ -14,6 +14,7 @@ Settings concerning cobrowse
 | **maskSelectors** | **[String]** | Mask patterns that will apply to pages being shared | [optional] |
 | **channels** | **[String]** | Cobrowse channels for web messenger | [optional] |
 | **readonlySelectors** | **[String]** | Readonly patterns that will apply to pages being shared | [optional] |
+| **pauseCriteria** | [**[PauseCriteria]**](PauseCriteria.html) | Pause criteria that will pause cobrowse if some of them are met in the user&#39;s URL | [optional] |
 {: class="table table-striped"}
 
 
diff --git a/build/docs/ContactListingRequest.md b/build/docs/ContactListingRequest.md
@@ -10,7 +10,7 @@ title: ContactListingRequest
 | **contactListFilterId** | **String** | Contact List Filter ID. | [optional] |
 | **criteria** | [**ContactBulkSearchCriteria**](ContactBulkSearchCriteria.html) | Criteria to filter the contacts by. | [optional] |
 | **pageNumber** | **Int** | Page number. | |
-| **pageSize** | **Int** | Page size. The max that will be returned is 50. | |
+| **pageSize** | **Int** | Page size. The max that will be returned is 100. | |
 | **contactSorts** | [**[ContactSort]**](ContactSort.html) | The order in which to sort contacts. | [optional] |
 {: class="table table-striped"}
 

diff --git a/build/docs/ConversationCategoriesEntityListing.md b/build/docs/ConversationCategoriesEntityListing.md
@@ -0,0 +1,22 @@
+---
+title: ConversationCategoriesEntityListing
+---
+## ConversationCategoriesEntityListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**[ConversationCategory]**](ConversationCategory.html) |  | [optional] |
+| **pageSize** | **Int** |  | [optional] |
+| **pageNumber** | **Int** |  | [optional] |
+| **total** | **Int64** |  | [optional] |
+| **previousUri** | **String** |  | [optional] |
+| **lastUri** | **String** |  | [optional] |
+| **firstUri** | **String** |  | [optional] |
+| **selfUri** | **String** |  | [optional] |
+| **nextUri** | **String** |  | [optional] |
+| **pageCount** | **Int** |  | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/ConversationCategory.md b/build/docs/ConversationCategory.md
@@ -0,0 +1,17 @@
+---
+title: ConversationCategory
+---
+## ConversationCategory
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **_id** | **String** | The id of the category | [optional] |
+| **name** | **String** | The name of the category | [optional] |
+| **_description** | **String** | The description of the category | [optional] |
+| **interactionType** | **String** | The type of interaction the category will apply to | [optional] |
+| **criteria** | [**Operand**](Operand.html) | A collection of conditions joined together by logical operation to provide more refined filtering of conversations | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/ConversationEventVideo.md b/build/docs/ConversationEventVideo.md
@@ -0,0 +1,16 @@
+---
+title: ConversationEventVideo
+---
+## ConversationEventVideo
+A Video event.
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Describes the type of Video event. | |
+| **offeringId** | **String** | The Video offering ID. | [optional] |
+| **jwt** | **String** | The Video offering JWT token. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/ConversationMessageEvent.md b/build/docs/ConversationMessageEvent.md
@@ -12,6 +12,7 @@ Message event element.  Examples include: system messages, typing indicators, co
 | **coBrowse** | [**ConversationEventCoBrowse**](ConversationEventCoBrowse.html) | CoBrowse event. | [optional] |
 | **typing** | [**ConversationEventTyping**](ConversationEventTyping.html) | Typing event. | [optional] |
 | **presence** | [**ConversationEventPresence**](ConversationEventPresence.html) | Presence event. | [optional] |
+| **video** | [**ConversationEventVideo**](ConversationEventVideo.html) | Video event. | [optional] |
 {: class="table table-striped"}
 
 
diff --git a/build/docs/ConversationMetricsTopicConversationMetricRecord.md b/build/docs/ConversationMetricsTopicConversationMetricRecord.md
@@ -85,6 +85,7 @@ title: ConversationMetricsTopicConversationMetricRecord
 | **teamId** | **String** | The team ID the user is a member of | [optional] |
 | **usedRouting** | **String** | Complete routing method | [optional] |
 | **userId** | **String** | Unique identifier for the user | [optional] |
+| **videoPresent** | **Bool** | Flag indicating if video is present | [optional] |
 | **waitingInteractionCounts** | **[Int]** | Number of waiting interactions for each predictive routing attempt | [optional] |
 | **wrapUpCode** | **String** | Wrap up code | [optional] |
 | **proposedAgents** | [**[ConversationMetricsTopicConversationProposedAgent]**](ConversationMetricsTopicConversationProposedAgent.html) | Proposed agents | [optional] |