npm - purecloud-platform-client-v2 - Versions diffs - 255.0.0 → 256.0.0 - Mend

purecloud-platform-client-v2 255.0.0 → 256.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (98) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "255.0.0",
+  "version": "256.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 CHANGED Viewed

@@ -5,7 +5,7 @@ import HttpRequestOptions from './HttpRequestOptions.js';
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 255.0.0
+ * @version 256.0.0
  */
 class ApiClient {
 	/**

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**
@@ -2842,6 +2842,40 @@ class ArchitectApi {
 		);
 	}
+	/**
+	 * Look up flows by ID
+	 * Returns only flows matching the specified ID(s). Returns an empty listing if no flows match the given IDs.
+	 * @param {Array.<String>} id Flow ID(s)
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.pageNumber Page number (default to 1)
+	 * @param {Number} opts.pageSize Page size (default to 25)
+	 * @param {String} opts.sortBy Sort by (default to id)
+	 * @param {String} opts.sortOrder Sort order (default to asc)
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	getFlowsLookup(id, opts) {
+		opts = opts || {};
+		// verify the required parameter 'id' is set
+		if (id === undefined || id === null) {
+			throw 'Missing the required parameter "id" when calling getFlowsLookup';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/flows/lookup',
+			'GET',
+			{  },
+			{ 'id': this.apiClient.buildCollectionParam(id, 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Get a flow milestone
 	 * Returns a specified flow milestone

package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class AssistantCopilotVariationsApi {
 	/**
 	 * AssistantCopilotVariations service.
 	 * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class BackgroundAssistantApi {
 	/**
 	 * BackgroundAssistant service.
 	 * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

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

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

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

package/src/purecloud-platform-client-v2/api/CaseManagementApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class CaseManagementApi {
 	/**
 	 * CaseManagement service.
 	 * @module purecloud-platform-client-v2/api/CaseManagementApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**
@@ -1930,6 +1930,81 @@ class ExternalContactsApi {
 		);
 	}
+	/**
+	 * Update a Contact Note
+	 *
+	 * @param {String} contactId ExternalContact Id
+	 * @param {String} noteId Note Id
+	 * @param {Object} body Note field to update
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	patchExternalcontactsContactNote(contactId, noteId, body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'contactId' is set
+		if (contactId === undefined || contactId === null || contactId === '') {
+			throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactNote';
+		}
+		// verify the required parameter 'noteId' is set
+		if (noteId === undefined || noteId === null || noteId === '') {
+			throw 'Missing the required parameter "noteId" when calling patchExternalcontactsContactNote';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchExternalcontactsContactNote';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}',
+			'PATCH',
+			{ 'contactId': contactId,'noteId': noteId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
+	/**
+	 * Update specific fields of an external organization
+	 *
+	 * @param {String} externalOrganizationId External Organization ID
+	 * @param {Object} body External Organization fields to update
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	patchExternalcontactsOrganization(externalOrganizationId, body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'externalOrganizationId' is set
+		if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
+			throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganization';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganization';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/organizations/{externalOrganizationId}',
+			'PATCH',
+			{ 'externalOrganizationId': externalOrganizationId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Claim or release identifiers for an external organization
 	 *
@@ -1965,6 +2040,81 @@ class ExternalContactsApi {
 		);
 	}
+	/**
+	 * Update an External Organization Note
+	 *
+	 * @param {String} externalOrganizationId External Organization Id
+	 * @param {String} noteId Note Id
+	 * @param {Object} body Note field to update
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	patchExternalcontactsOrganizationNote(externalOrganizationId, noteId, body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'externalOrganizationId' is set
+		if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
+			throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationNote';
+		}
+		// verify the required parameter 'noteId' is set
+		if (noteId === undefined || noteId === null || noteId === '') {
+			throw 'Missing the required parameter "noteId" when calling patchExternalcontactsOrganizationNote';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationNote';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}',
+			'PATCH',
+			{ 'externalOrganizationId': externalOrganizationId,'noteId': noteId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
+	/**
+	 * Update specific fields of a relationship
+	 *
+	 * @param {String} relationshipId Relationship Id
+	 * @param {Object} body Relationship fields to update
+	 * @param {Object} opts Optional parameters
+	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
+	 */
+	patchExternalcontactsRelationship(relationshipId, body, opts) {
+		opts = opts || {};
+		// verify the required parameter 'relationshipId' is set
+		if (relationshipId === undefined || relationshipId === null || relationshipId === '') {
+			throw 'Missing the required parameter "relationshipId" when calling patchExternalcontactsRelationship';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchExternalcontactsRelationship';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/relationships/{relationshipId}',
+			'PATCH',
+			{ 'relationshipId': relationshipId },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json'],
+			opts['customHeaders']
+		);
+	}
 	/**
 	 * Bulk fetch contacts
 	 *

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

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

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

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

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

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**
@@ -219,6 +219,7 @@ class IntegrationsApi {
 	 * @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
 	 * @param {String} opts.integrationType Filter integrations by integration type ID
 	 * @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
+	 * @param {String} opts.credentialId Filter integrations by credential ID
 	 * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
 	 */
 	getIntegrations(opts) {
@@ -229,7 +230,7 @@ class IntegrationsApi {
 			'/api/v2/integrations',
 			'GET',
 			{  },
-			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
+			{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'],'credentialId': opts['credentialId'] },
 			{  },
 			{  },
 			null,

package/src/purecloud-platform-client-v2/api/IntentsApi.js CHANGED Viewed

@@ -5,7 +5,7 @@ class IntentsApi {
 	/**
 	 * Intents service.
 	 * @module purecloud-platform-client-v2/api/IntentsApi
-	 * @version 255.0.0
+	 * @version 256.0.0
 	 */
 	/**

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

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

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

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

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

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

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

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