npm - purecloud-platform-client-v2 - Versions diffs - 190.0.0 → 191.0.0 - Mend

purecloud-platform-client-v2 190.0.0 → 191.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 (85) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "190.0.0",
+  "version": "191.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

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 190.0.0
+ * @version 191.0.0
  */
 class ApiClient {
 	/**

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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.0.0
 	 */
 	/**
@@ -755,6 +755,59 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Get dashboards summary for a user
+	 *
+	 * @param {String} userId User ID
+	 */
+	getAnalyticsReportingDashboardsUser(userId) {
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users/{userId}',
+			'GET',
+			{ 'userId': userId },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Get dashboards summary for users in a org
+	 *
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.sortBy  (default to asc)
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 25)
+	 * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
+	 * @param {Object} opts.state Only list users of this state
+	 */
+	getAnalyticsReportingDashboardsUsers(opts) {
+		opts = opts || {};
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users',
+			'GET',
+			{  },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get all view export requests for a user
 	 *
@@ -1030,6 +1083,39 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Get list of dashboards for an user
+	 *
+	 * @param {String} userId User ID
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.sortBy  (default to asc)
+	 * @param {Number} opts.pageNumber  (default to 1)
+	 * @param {Number} opts.pageSize  (default to 50)
+	 * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
+	 * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
+	 */
+	getAnalyticsReportingSettingsUserDashboards(userId, opts) {
+		opts = opts || {};
+		// verify the required parameter 'userId' is set
+		if (userId === undefined || userId === null) {
+			throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
+			'GET',
+			{ 'userId': userId },
+			{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get a list of report time periods.
 	 *
@@ -2080,6 +2166,31 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Bulk delete dashboards owned by other user(s)
+	 *
+	 * @param {Array.<String>} body List of userIds
+	 */
+	postAnalyticsReportingDashboardsUsersBulkRemove(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/dashboards/users/bulk/remove',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Generate a view export request
 	 * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
@@ -2157,6 +2268,56 @@ class AnalyticsApi {
 		);
 	}
+	/**
+	 * Bulk remove dashboard configurations
+	 *
+	 * @param {Object} body
+	 */
+	postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/dashboards/bulk/remove',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
+	/**
+	 * Query dashboard configurations
+	 *
+	 * @param {Object} body
+	 */
+	postAnalyticsReportingSettingsDashboardsQuery(body) {
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
+		}
+		return this.apiClient.callApi(
+			'/api/v2/analytics/reporting/settings/dashboards/query',
+			'POST',
+			{  },
+			{  },
+			{  },
+			{  },
+			body,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Query for resolution aggregates asynchronously
 	 *

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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.0.0
 	 */
 	/**
@@ -2116,6 +2116,26 @@ class ConversationsApi {
 		);
 	}
+	/**
+	 * Get a list of Facebook Permissions
+	 *
+	 */
+	getConversationsMessagingFacebookPermissions() {
+		return this.apiClient.callApi(
+			'/api/v2/conversations/messaging/facebook/permissions',
+			'GET',
+			{  },
+			{  },
+			{  },
+			{  },
+			null,
+			['PureCloud OAuth'],
+			['application/json'],
+			['application/json']
+		);
+	}
 	/**
 	 * Get a list of Integrations
 	 *

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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.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 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**
@@ -449,7 +449,6 @@ class LearningApi {
 	 * @param {String} moduleId Key identifier for the module
 	 * @param {String} userId Key identifier for the user
 	 * @param {Object} body The learning request for updating the assignment
-	 * patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchLearningModuleUserAssignments(moduleId, userId, body) {
 		// verify the required parameter 'moduleId' is set

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

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 190.0.0
+	 * @version 191.0.0
 	 */
 	/**