37.0.0

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 = '36.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '36.0.0' }
+  s.version = '37.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '37.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   s.license = 'MIT'

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

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 = '36.0.0'
-  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '36.0.0' }
+  s.version = '37.0.0'
+  s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '37.0.0' }
   s.authors = 'Genesys Developer Evangelists'
   s.social_media_url = 'https://twitter.com/PureCloud_Dev'
   s.license = 'MIT'

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

build/docs/AnalyticsProposedAgent.md

@@ -0,0 +1,14 @@
+---
+title: AnalyticsProposedAgent
+---
+## AnalyticsProposedAgent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **proposedAgentId** | **String** | Unique identifier of an agent that was proposed by predictive routing | [optional] |
+| **agentRank** | **Int** | Proposed agent rank for this conversation from predictive routing (lower is better) | [optional] |
+{: class="table table-striped"}
+
+

build/docs/AnalyticsSession.md

@@ -64,6 +64,8 @@ title: AnalyticsSession
 | **usedRouting** | **String** | Complete routing method | [optional] |
 | **selectedAgentId** | **String** | Selected agent id | [optional] |
 | **selectedAgentRank** | **Int** | Selected agent GPR rank | [optional] |
+| **agentAssistantId** | **String** | Unique identifier of the active virtual agent assistant | [optional] |
+| **proposedAgents** | [**[AnalyticsProposedAgent]**](AnalyticsProposedAgent.html) | Proposed agents | [optional] |
 {: class="table table-striped"}
 
 

build/docs/ArrayNode.md

@@ -12,11 +12,8 @@ title: ArrayNode
 | **number** | **Bool** |  | [optional] |
 | **boolean** | **Bool** |  | [optional] |
 | **object** | **Bool** |  | [optional] |
-| **valueNode** | **Bool** |  | [optional] |
-| **containerNode** | **Bool** |  | [optional] |
-| **missingNode** | **Bool** |  | [optional] |
-| **pojo** | **Bool** |  | [optional] |
 | **floatingPointNumber** | **Bool** |  | [optional] |
+| **pojo** | **Bool** |  | [optional] |
 | **integralNumber** | **Bool** |  | [optional] |
 | **short** | **Bool** |  | [optional] |
 | **int** | **Bool** |  | [optional] |
@@ -26,6 +23,9 @@ title: ArrayNode
 | **bigInteger** | **Bool** |  | [optional] |
 | **textual** | **Bool** |  | [optional] |
 | **binary** | **Bool** |  | [optional] |
+| **valueNode** | **Bool** |  | [optional] |
+| **containerNode** | **Bool** |  | [optional] |
+| **missingNode** | **Bool** |  | [optional] |
 | **array** | **Bool** |  | [optional] |
 | **null** | **Bool** |  | [optional] |
 {: class="table table-striped"}

build/docs/AuditAPI.md

@@ -7,13 +7,62 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 | Method | Description |
 | ------------- | ------------- |
+| [**getAuditsQueryRealtimeServicemapping**](AuditAPI.html#getAuditsQueryRealtimeServicemapping) | Get service mapping information used in audits. |
 | [**getAuditsQueryServicemapping**](AuditAPI.html#getAuditsQueryServicemapping) | Get service mapping information used in audits. |
 | [**getAuditsQueryTransactionId**](AuditAPI.html#getAuditsQueryTransactionId) | Get status of audit query execution |
 | [**getAuditsQueryTransactionIdResults**](AuditAPI.html#getAuditsQueryTransactionIdResults) | Get results of audit query |
 | [**postAuditsQuery**](AuditAPI.html#postAuditsQuery) | Create audit query execution |
 | [**postAuditsQueryRealtime**](AuditAPI.html#postAuditsQueryRealtime) | This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits. |
 {: class="table-striped"}
 
+<a name="getAuditsQueryRealtimeServicemapping"></a>
+
+# **getAuditsQueryRealtimeServicemapping**
+
+
+
+> [AuditQueryServiceMapping](AuditQueryServiceMapping.html) getAuditsQueryRealtimeServicemapping()
+
+Get service mapping information used in audits.
+
+
+
+Wraps GET /api/v2/audits/query/realtime/servicemapping  
+
+Requires ALL permissions: 
+
+* audits:audit:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+
+// Code example
+AuditAPI.getAuditsQueryRealtimeServicemapping() { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("AuditAPI.getAuditsQueryRealtimeServicemapping was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+This endpoint does not require any parameters.
+
+
+
+### Return type
+
+[**AuditQueryServiceMapping**](AuditQueryServiceMapping.html)
+
 <a name="getAuditsQueryServicemapping"></a>
 
 # **getAuditsQueryServicemapping**

build/docs/BuAgentSchedulesQueryResponse.md

@@ -8,6 +8,7 @@ title: BuAgentSchedulesQueryResponse
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **agentSchedules** | [**[BuAgentScheduleQueryResponse]**](BuAgentScheduleQueryResponse.html) | The requested agent schedules | [optional] |
+| **businessUnitTimeZone** | **String** | The time zone configured for the business unit to which these schedules apply | [optional] |
 {: class="table table-striped"}
 
 

build/docs/CoachingAPI.md

@@ -23,6 +23,7 @@ All URIs are relative to *https://api.mypurecloud.com*
 | [**patchCoachingNotification**](CoachingAPI.html#patchCoachingNotification) | Update an existing notification. |
 | [**postCoachingAppointmentAnnotations**](CoachingAPI.html#postCoachingAppointmentAnnotations) | Create a new annotation. |
 | [**postCoachingAppointments**](CoachingAPI.html#postCoachingAppointments) | Create a new appointment |
+| [**postCoachingAppointmentsAggregatesQuery**](CoachingAPI.html#postCoachingAppointmentsAggregatesQuery) | Retrieve aggregated appointment data |
 {: class="table-striped"}
 
 <a name="deleteCoachingAppointment"></a>
@@ -357,7 +358,7 @@ CoachingAPI.getCoachingAppointmentStatuses(appointmentId: appointmentId, pageNum
 
 
 
-> [CoachingAppointmentResponseList](CoachingAppointmentResponseList.html) getCoachingAppointments(userIds, interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder)
+> [CoachingAppointmentResponseList](CoachingAppointmentResponseList.html) getCoachingAppointments(userIds, interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue)
 
 Get appointments for users and optional date range
 
@@ -384,9 +385,12 @@ let pageSize: Int = 25 // Page size
 let statuses: [String] = [CoachingAPI.Statuses_getCoachingAppointments.enummember.rawValue] // Appointment Statuses to filter by
 let facilitatorIds: [String] = [""] // The facilitator IDs for which to retrieve appointments
 let sortOrder: CoachingAPI.SortOrder_getCoachingAppointments = CoachingAPI.SortOrder_getCoachingAppointments.enummember // Sort (by due date) either Asc or Desc
+let relationships: [String] = [CoachingAPI.Relationships_getCoachingAppointments.enummember.rawValue] // Relationships to filter by
+let completionInterval: String = "" // Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
+let overdue: CoachingAPI.Overdue_getCoachingAppointments = CoachingAPI.Overdue_getCoachingAppointments.enummember // Overdue status to filter by
 
 // Code example
-CoachingAPI.getCoachingAppointments(userIds: userIds, interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder) { (response, error) in
+CoachingAPI.getCoachingAppointments(userIds: userIds, interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue) { (response, error) in
     if let error = error {
         dump(error)
     } else if let response = response {
@@ -408,6 +412,9 @@ CoachingAPI.getCoachingAppointments(userIds: userIds, interval: interval, pageNu
 | **statuses** | [**[String]**](String.html)| Appointment Statuses to filter by | [optional]<br />**Values**: scheduled ("Scheduled"), inProgress ("InProgress"), completed ("Completed"), invalidSchedule ("InvalidSchedule") |
 | **facilitatorIds** | [**[String]**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
 | **sortOrder** | **String**| Sort (by due date) either Asc or Desc | [optional]<br />**Values**: desc ("Desc"), asc ("Asc") |
+| **relationships** | [**[String]**](String.html)| Relationships to filter by | [optional]<br />**Values**: creator ("Creator"), facilitator ("Facilitator"), attendee ("Attendee") |
+| **completionInterval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
+| **overdue** | **String**| Overdue status to filter by | [optional]<br />**Values**: any ("Any"), _true ("True"), _false ("False") |
 {: class="table-striped"}
 
 
@@ -421,7 +428,7 @@ CoachingAPI.getCoachingAppointments(userIds: userIds, interval: interval, pageNu
 
 
 
-> [CoachingAppointmentResponseList](CoachingAppointmentResponseList.html) getCoachingAppointmentsMe(interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder)
+> [CoachingAppointmentResponseList](CoachingAppointmentResponseList.html) getCoachingAppointmentsMe(interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue)
 
 Get my appointments for a given date range
 
@@ -446,9 +453,12 @@ let pageSize: Int = 25 // Page size
 let statuses: [String] = [CoachingAPI.Statuses_getCoachingAppointmentsMe.enummember.rawValue] // Appointment Statuses to filter by
 let facilitatorIds: [String] = [""] // The facilitator IDs for which to retrieve appointments
 let sortOrder: CoachingAPI.SortOrder_getCoachingAppointmentsMe = CoachingAPI.SortOrder_getCoachingAppointmentsMe.enummember // Sort (by due date) either Asc or Desc
+let relationships: [String] = [CoachingAPI.Relationships_getCoachingAppointmentsMe.enummember.rawValue] // Relationships to filter by
+let completionInterval: String = "" // Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
+let overdue: CoachingAPI.Overdue_getCoachingAppointmentsMe = CoachingAPI.Overdue_getCoachingAppointmentsMe.enummember // Overdue status to filter by
 
 // Code example
-CoachingAPI.getCoachingAppointmentsMe(interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder) { (response, error) in
+CoachingAPI.getCoachingAppointmentsMe(interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue) { (response, error) in
     if let error = error {
         dump(error)
     } else if let response = response {
@@ -469,6 +479,9 @@ CoachingAPI.getCoachingAppointmentsMe(interval: interval, pageNumber: pageNumber
 | **statuses** | [**[String]**](String.html)| Appointment Statuses to filter by | [optional]<br />**Values**: scheduled ("Scheduled"), inProgress ("InProgress"), completed ("Completed") |
 | **facilitatorIds** | [**[String]**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
 | **sortOrder** | **String**| Sort (by due date) either Asc or Desc | [optional]<br />**Values**: desc ("Desc"), asc ("Asc") |
+| **relationships** | [**[String]**](String.html)| Relationships to filter by | [optional]<br />**Values**: creator ("Creator"), facilitator ("Facilitator"), attendee ("Attendee") |
+| **completionInterval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
+| **overdue** | **String**| Overdue status to filter by | [optional]<br />**Values**: any ("Any"), _true ("True"), _false ("False") |
 {: class="table-striped"}
 
 
@@ -910,3 +923,55 @@ CoachingAPI.postCoachingAppointments(body: body) { (response, error) in
 
 [**CoachingAppointmentResponse**](CoachingAppointmentResponse.html)
 
+<a name="postCoachingAppointmentsAggregatesQuery"></a>
+
+# **postCoachingAppointmentsAggregatesQuery**
+
+
+
+> [CoachingAppointmentAggregateResponse](CoachingAppointmentAggregateResponse.html) postCoachingAppointmentsAggregatesQuery(body)
+
+Retrieve aggregated appointment data
+
+
+
+Wraps POST /api/v2/coaching/appointments/aggregates/query  
+
+Requires ANY permissions: 
+
+* coaching:appointment:view
+
+### Example
+
+```{"language":"swift"}
+import PureCloudPlatformClientV2
+
+PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com"
+PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..."
+
+let body: CoachingAppointmentAggregateRequest = new CoachingAppointmentAggregateRequest(...) // Aggregate Request
+
+// Code example
+CoachingAPI.postCoachingAppointmentsAggregatesQuery(body: body) { (response, error) in
+    if let error = error {
+        dump(error)
+    } else if let response = response {
+        print("CoachingAPI.postCoachingAppointmentsAggregatesQuery was successful")
+        dump(response)
+    }
+}
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **body** | [**CoachingAppointmentAggregateRequest**](CoachingAppointmentAggregateRequest.html)| Aggregate Request | |
+{: class="table-striped"}
+
+
+### Return type
+
+[**CoachingAppointmentAggregateResponse**](CoachingAppointmentAggregateResponse.html)
+

build/docs/CoachingAppointmentAggregateRequest.md

@@ -0,0 +1,16 @@
+---
+title: CoachingAppointmentAggregateRequest
+---
+## CoachingAppointmentAggregateRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Interval to aggregate across. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
+| **metrics** | **[String]** | A list of metrics to aggregate.  If omitted, all metrics are returned. | [optional] |
+| **groupBy** | **[String]** | An optional list of items by which to group the result data. | [optional] |
+| **filter** | [**QueryRequestFilter**](QueryRequestFilter.html) | The filter applied to the data | |
+{: class="table table-striped"}
+
+

build/docs/CoachingAppointmentAggregateResponse.md

@@ -0,0 +1,13 @@
+---
+title: CoachingAppointmentAggregateResponse
+---
+## CoachingAppointmentAggregateResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**[QueryResponseGroupedData]**](QueryResponseGroupedData.html) | The results of the query | [optional] |
+{: class="table table-striped"}
+
+

build/docs/CoachingAppointmentResponse.md

@@ -22,6 +22,7 @@ Coaching appointment response
 | **dateModified** | [**Date**](Date.html) | The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **conversations** | [**[ConversationReference]**](ConversationReference.html) | The list of conversations associated with coaching appointment. | [optional] |
 | **documents** | [**[DocumentReference]**](DocumentReference.html) | The list of documents associated with coaching appointment. | [optional] |
+| **isOverdue** | **Bool** | Whether the appointment is overdue. | [optional] |
 | **selfUri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

build/docs/ConversationMetrics.md

@@ -0,0 +1,15 @@
+---
+title: ConversationMetrics
+---
+## ConversationMetrics
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **conversation** | [**AddressableEntityRef**](AddressableEntityRef.html) | The Conversation Reference | [optional] |
+| **sentimentScore** | **Double** | The Sentiment Score | [optional] |
+| **sentimentTrend** | **Double** | The Sentiment Trend | [optional] |
+{: class="table table-striped"}
+
+

build/docs/ExternalOrganizationTrustorLink.md

@@ -7,11 +7,10 @@ title: ExternalOrganizationTrustorLink
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **_id** | **String** | The globally unique identifier for the object. | [optional] |
 | **externalOrganizationId** | **String** | The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org | [optional] |
 | **trustorOrgId** | **String** | The id of a PureCloud organization that has granted trust to this PureCloud organization | [optional] |
 | **dateCreated** | [**Date**](Date.html) | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **selfUri** | **String** | The URI for this object | [optional] |
+| **externalOrganizationUri** | **String** | The URI for the External Organization that is linked to the trustor org | [optional] |
 {: class="table table-striped"}
 
 

build/docs/GenericSAML.md

@@ -9,8 +9,8 @@ title: GenericSAML
 |------------ | ------------- | ------------- | -------------|
 | **_id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **relyingPartyIdentifier** | **String** |  | [optional] |
 | **logoImageData** | **String** |  | [optional] |
+| **relyingPartyIdentifier** | **String** |  | [optional] |
 | **endpointCompression** | **Bool** |  | [optional] |
 | **certificate** | **String** |  | [optional] |
 | **issuerURI** | **String** |  | [optional] |

build/docs/JsonNode.md

@@ -12,11 +12,8 @@ title: JsonNode
 | **number** | **Bool** |  | [optional] |
 | **boolean** | **Bool** |  | [optional] |
 | **object** | **Bool** |  | [optional] |
-| **valueNode** | **Bool** |  | [optional] |
-| **containerNode** | **Bool** |  | [optional] |
-| **missingNode** | **Bool** |  | [optional] |
-| **pojo** | **Bool** |  | [optional] |
 | **floatingPointNumber** | **Bool** |  | [optional] |
+| **pojo** | **Bool** |  | [optional] |
 | **integralNumber** | **Bool** |  | [optional] |
 | **short** | **Bool** |  | [optional] |
 | **int** | **Bool** |  | [optional] |
@@ -26,6 +23,9 @@ title: JsonNode
 | **bigInteger** | **Bool** |  | [optional] |
 | **textual** | **Bool** |  | [optional] |
 | **binary** | **Bool** |  | [optional] |
+| **valueNode** | **Bool** |  | [optional] |
+| **containerNode** | **Bool** |  | [optional] |
+| **missingNode** | **Bool** |  | [optional] |
 | **array** | **Bool** |  | [optional] |
 | **null** | **Bool** |  | [optional] |
 {: class="table table-striped"}