purecloud-platform-client-v2 217.0.0 → 218.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "217.0.0",
+  "version": "218.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 217.0.0
+ * @version 218.0.0
  */
 class ApiClient {
 	/**

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -145,7 +145,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {String} pinnedMessageId pinnedMessageId
-	 * deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsUserMessagesPin(userId, pinnedMessageId) { 
 		// verify the required parameter 'userId' is set
@@ -392,7 +391,6 @@ class ChatApi {
 	 * Get information for a 1on1
 	 * 
 	 * @param {String} userId userId
-	 * getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUser(userId) { 
 		// verify the required parameter 'userId' is set
@@ -850,7 +848,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {Object} body Pinned Message Ids
-	 * postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsUserMessagesPins(userId, body) { 
 		// verify the required parameter 'userId' is set

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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -270,6 +270,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Delete Twitter messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 */
+	deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) { 
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null) {
+			throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter/{integrationId}', 
+			'DELETE', 
+			{ 'integrationId': integrationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete a WhatsApp messaging integration
 	 * 
@@ -2260,6 +2285,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get twitter oauth settings to patch an integration
+	 * 
+	 * @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
+	 */
+	getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) { 
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null) {
+			throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings', 
+			'GET', 
+			{ 'integrationId': integrationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of Integrations
 	 * 
@@ -2459,6 +2509,83 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Get a list of Twitter Integrations
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Object} opts.expand Expand instructions for the return value.
+	 * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
+	 * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
+	 */
+	getConversationsMessagingIntegrationsTwitter(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter', 
+			'GET', 
+			{  },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get Twitter messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.expand Expand instructions for the return value.
+	 */
+	getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null) {
+			throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter/{integrationId}', 
+			'GET', 
+			{ 'integrationId': integrationId },
+			{ 'expand': opts['expand'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get twitter oauth settings
+	 * 
+	 */
+	getConversationsMessagingIntegrationsTwitterOauthSettings() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter/oauth/settings', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a list of WhatsApp Integrations
 	 * 
@@ -4096,6 +4223,36 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Update a Twitter messaging integration
+	 * 
+	 * @param {String} integrationId Integration ID
+	 * @param {Object} body TwitterIntegrationUpdateRequest
+	 */
+	patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) { 
+		// verify the required parameter 'integrationId' is set
+		if (integrationId === undefined || integrationId === null) {
+			throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter/{integrationId}', 
+			'PATCH', 
+			{ 'integrationId': integrationId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
 	 * Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
@@ -6432,6 +6589,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Create Twitter Integration
+	 * 
+	 * @param {Object} body TwitterIntegrationRequest
+	 */
+	postConversationsMessagingIntegrationsTwitter(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/integrations/twitter', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
 	 * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
@@ -6637,6 +6819,37 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Create an Agent-Type video conference and assign an agent to it
+	 * 
+	 * @param {String} conversationId conversationId
+	 * @param {String} communicationId communicationId
+	 * postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) { 
+		// verify the required parameter 'conversationId' is set
+		if (conversationId === undefined || conversationId === null) {
+			throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
+		}
+		// verify the required parameter 'communicationId' is set
+		if (communicationId === undefined || communicationId === null) {
+			throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}', 
+			'POST', 
+			{ 'conversationId': conversationId,'communicationId': communicationId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Apply wrap-up for this conversation communication
 	 * 

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -489,6 +489,57 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Get export for exportId
+	 * 
+	 * @param {String} exportId Export id
+	 */
+	getExternalcontactsContactsExport(exportId) { 
+		// verify the required parameter 'exportId' is set
+		if (exportId === undefined || exportId === null) {
+			throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/exports/{exportId}', 
+			'GET', 
+			{ 'exportId': exportId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * List exports for organization
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.divisionIds Division IDs of entities
+	 * @param {String} opts.after The cursor that points to the end of the set of entities
+	 * @param {Number} opts.pageSize Number of entities to return
+	 */
+	getExternalcontactsContactsExports(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/exports', 
+			'GET', 
+			{  },
+			{ 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a schema
 	 * 
@@ -1997,6 +2048,31 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Create bulk export
+	 * 
+	 * @param {Object} body Export
+	 */
+	postExternalcontactsContactsExports(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/exports', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create a schema
 	 * 

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**

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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.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 217.0.0
+	 * @version 218.0.0
 	 */
 
 	/**