purecloud-platform-client-v2 234.0.0 → 236.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "234.0.0",
+  "version": "236.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",

package/src/purecloud-platform-client-v2/ApiClient.js

@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 234.0.0
+ * @version 236.0.0
  */
 class ApiClient {
 	/**
@@ -209,6 +209,50 @@ class ApiClient {
 		this.config.setEnvironment(environment);
 	}
 
+	/**
+     * @description Sets the optional http headers used by the client
+     * @param {object} newHeaders - default headers to be used
+     */
+	setDefaultHeaders(newHeaders) {
+        if (!newHeaders || !(typeof newHeaders === 'object')) {
+            throw new Error("default headers must be a map");
+        }
+        this.defaultHeaders = newHeaders;
+    }
+
+	/**
+     * @description Gets the default http headers used by the client
+     */
+	getDefaultHeaders() {
+		return this.defaultHeaders;
+    }
+
+	/**
+     * @description Sets the optional Genesys-App http header used by the client
+     * @param {string} headerValue - value for the Genesys-App header
+     */
+	setGenesysAppHeader(headerValue) {
+		if (!headerValue || !(typeof headerValue === 'string')) throw new Error("headerValue must be a non empty string");
+        if (!this.defaultHeaders) {
+			this.defaultHeaders = {
+				"Genesys-App": headerValue
+			};
+		} else {
+			this.defaultHeaders["Genesys-App"] = headerValue;
+		}
+    }
+
+	/**
+     * @description Gets the Genesys-App http header used by the client
+     */
+	getGenesysAppHeader() {
+		if (this.defaultHeaders && this.defaultHeaders["Genesys-App"]) {
+			return this.defaultHeaders["Genesys-App"];
+		} else {
+			return null;
+		}
+    }
+
     /**
      * @description Sets the dynamic HttpClient used by the client
      * @param {object} httpClient - HttpClient to be injected

package/src/purecloud-platform-client-v2/api/AIStudioApi.js

@@ -5,7 +5,7 @@ class AIStudioApi {
 	/**
 	 * AIStudio service.
 	 * @module purecloud-platform-client-v2/api/AIStudioApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js

@@ -5,7 +5,7 @@ class AgentAssistantsApi {
 	/**
 	 * AgentAssistants service.
 	 * @module purecloud-platform-client-v2/api/AgentAssistantsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js

@@ -5,7 +5,7 @@ class AgentCopilotApi {
 	/**
 	 * AgentCopilot service.
 	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AgentUIApi.js

@@ -5,7 +5,7 @@ class AgentUIApi {
 	/**
 	 * AgentUI service.
 	 * @module purecloud-platform-client-v2/api/AgentUIApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AlertingApi.js

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AnalyticsApi.js

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ArchitectApi.js

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AuditApi.js

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AuthorizationApi.js

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**
@@ -302,7 +302,7 @@ class AuthorizationApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
 	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
-	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
 	 * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
 	 * @param {String} opts.name Optionally request specific divisions by division name
 	 */

package/src/purecloud-platform-client-v2/api/BillingApi.js

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js

@@ -5,7 +5,7 @@ class BusinessRulesApi {
 	/**
 	 * BusinessRules service.
 	 * @module purecloud-platform-client-v2/api/BusinessRulesApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ChatApi.js

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/CoachingApi.js

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**
@@ -316,6 +316,31 @@ class CoachingApi {
 		);
 	}
 
+	/**
+	 * Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
+	 * 
+	 * @param {String} jobId The ID of job
+	 */
+	getCoachingScheduleslotsJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null || jobId === '') {
+			throw 'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/coaching/scheduleslots/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update an existing appointment
 	 * Permission not required if you are the creator or facilitator of the appointment
@@ -551,6 +576,31 @@ class CoachingApi {
 		);
 	}
 
+	/**
+	 * Start job to retrieve the slots where a coaching appointment can be scheduled.
+	 * 
+	 * @param {Object} body The slots search request
+	 */
+	postCoachingScheduleslotsJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/coaching/scheduleslots/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get list of possible slots where a coaching appointment can be scheduled.
 	 * 

package/src/purecloud-platform-client-v2/api/ContentManagementApi.js

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ConversationsApi.js

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**
@@ -677,7 +677,6 @@ class ConversationsApi {
 	 * @param {String} conversationId conversationId
 	 * @param {String} communicationId communicationId
 	 * @param {String} messageId messageId
-	 * getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) { 
 		// verify the required parameter 'conversationId' is set
@@ -715,7 +714,6 @@ class ConversationsApi {
 	 * @param {Object} opts Optional parameters
 	 * @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
 	 * @param {Number} opts.pageNumber Page number (default to 1)
-	 * getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getConversationCommunicationInternalmessages(conversationId, communicationId, opts) { 
 		opts = opts || {};
@@ -1977,7 +1975,6 @@ class ConversationsApi {
 	 * Get internal message conversation
 	 * 
 	 * @param {String} conversationId conversationId
-	 * getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getConversationsInternalmessage(conversationId) { 
 		// verify the required parameter 'conversationId' is set
@@ -2002,7 +1999,6 @@ class ConversationsApi {
 	/**
 	 * Get active internal message conversations for the logged in user
 	 * 
-	 * getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getConversationsInternalmessages() { 
 
@@ -2090,6 +2086,42 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get message media list by status
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {String} communicationId communicationId
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.status The status on which to filter the response.
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 */
+	getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null || conversationId === '') {
+			throw 'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMedia';
+		}
+		// verify the required parameter 'communicationId' is set
+		if (communicationId === undefined || communicationId === null || communicationId === '') {
+			throw 'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMedia';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media', 
+			'GET', 
+			{ 'conversationId': conversationId,'communicationId': communicationId },
+			{ 'status': opts['status'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get media
 	 * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
@@ -5201,7 +5233,6 @@ class ConversationsApi {
 	 * @param {String} conversationId conversationId
 	 * @param {String} communicationId communicationId
 	 * @param {Object} body Message
-	 * postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postConversationCommunicationInternalmessages(conversationId, communicationId, body) { 
 		// verify the required parameter 'conversationId' is set
@@ -5330,7 +5361,6 @@ class ConversationsApi {
 	 * @param {String} conversationId conversation ID
 	 * @param {String} participantId participant ID
 	 * @param {Object} body Confer request
-	 * postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) { 
 		// verify the required parameter 'conversationId' is set
@@ -7240,7 +7270,7 @@ class ConversationsApi {
 
 	/**
 	 * Get messages in batch
-	 * The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
+	 * The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
 	 * @param {String} conversationId 
 	 * @param {Object} opts Optional parameters
 	 * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)

package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js

@@ -5,7 +5,7 @@ class DataPrivacyApi {
 	/**
 	 * DataPrivacy service.
 	 * @module purecloud-platform-client-v2/api/DataPrivacyApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/DownloadsApi.js

@@ -5,7 +5,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/EmailsApi.js

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js

@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
 	/**
 	 * EmployeeEngagement service.
 	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/EventsApi.js

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/FaxApi.js

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/FlowsApi.js

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GamificationApi.js

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**
@@ -560,6 +560,51 @@ class GamificationApi {
 		);
 	}
 
+	/**
+	 * Query managers in a profile during a period of time
+	 * 
+	 * @param {Object} filterType Filter type for the query request.
+	 * @param {String} filterId ID for the filter type.
+	 * @param {Object} granularity Granularity
+	 * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 100)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 */
+	getGamificationInsightsManagers(filterType, filterId, granularity, startWorkday, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'filterType' is set
+		if (filterType === undefined || filterType === null) {
+			throw 'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';
+		}
+		// verify the required parameter 'filterId' is set
+		if (filterId === undefined || filterId === null) {
+			throw 'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';
+		}
+		// verify the required parameter 'granularity' is set
+		if (granularity === undefined || granularity === null) {
+			throw 'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';
+		}
+		// verify the required parameter 'startWorkday' is set
+		if (startWorkday === undefined || startWorkday === null) {
+			throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/gamification/insights/managers', 
+			'GET', 
+			{  },
+			{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Query users in a profile during a period of time
 	 * 

package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GeolocationApi.js

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GreetingsApi.js

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GroupsApi.js

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js

@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/IntegrationsApi.js

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/JourneyApi.js

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/KnowledgeApi.js

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/LanguagesApi.js

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 234.0.0
+	 * @version 236.0.0
 	 */
 
 	/**