purecloud-platform-client-v2 220.0.0 → 222.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "220.0.0",
+  "version": "222.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 220.0.0
+ * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.0.0
 	 */
 
 	/**
@@ -1039,7 +1039,6 @@ class ArchitectApi {
 	 * Get an IVR IdentityResolutionConfig.
 	 * 
 	 * @param {String} ivrId IVR id
-	 * getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getArchitectIvrIdentityresolution(ivrId) { 
 		// verify the required parameter 'ivrId' is set
@@ -1072,6 +1071,7 @@ class ArchitectApi {
 	 * @param {String} opts.name Name of the IVR to filter by.
 	 * @param {String} opts.dnis The phone number of the IVR to filter by.
 	 * @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
+	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
 	 */
 	getArchitectIvrs(opts) { 
 		opts = opts || {};
@@ -1081,7 +1081,7 @@ class ArchitectApi {
 			'/api/v2/architect/ivrs', 
 			'GET', 
 			{  },
-			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
+			{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -1979,6 +1979,7 @@ class ArchitectApi {
 	 * @param {Object} opts.secure Secure
 	 * @param {Boolean} opts.deleted Include deleted (default to false)
 	 * @param {Boolean} opts.includeSchemas Include variable schemas (default to false)
+	 * @param {Boolean} opts.virtualAgentEnabled Include/exclude virtual agent flows
 	 * @param {String} opts.publishedAfter Published after
 	 * @param {String} opts.publishedBefore Published before
 	 * @param {Array.<String>} opts.divisionId division ID(s)
@@ -1991,7 +1992,7 @@ class ArchitectApi {
 			'/api/v2/flows', 
 			'GET', 
 			{  },
-			{ 'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'publishVersionId': opts['publishVersionId'],'editableBy': opts['editableBy'],'lockedBy': opts['lockedBy'],'lockedByClientId': opts['lockedByClientId'],'secure': opts['secure'],'deleted': opts['deleted'],'includeSchemas': opts['includeSchemas'],'publishedAfter': opts['publishedAfter'],'publishedBefore': opts['publishedBefore'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
+			{ 'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'publishVersionId': opts['publishVersionId'],'editableBy': opts['editableBy'],'lockedBy': opts['lockedBy'],'lockedByClientId': opts['lockedByClientId'],'secure': opts['secure'],'deleted': opts['deleted'],'includeSchemas': opts['includeSchemas'],'virtualAgentEnabled': opts['virtualAgentEnabled'],'publishedAfter': opts['publishedAfter'],'publishedBefore': opts['publishedBefore'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
 			{  },
 			{  },
 			null, 
@@ -3887,7 +3888,6 @@ class ArchitectApi {
 	 * 
 	 * @param {String} ivrId IVR id
 	 * @param {Object} body 
-	 * putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	putArchitectIvrIdentityresolution(ivrId, body) { 
 		// verify the required parameter 'ivrId' is set

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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.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 220.0.0
+	 * @version 222.0.0
 	 */
 
 	/**
@@ -20,6 +20,182 @@ class BillingApi {
 	}
 
 
+	/**
+	 * Get billing contract
+	 * Retrieve a single contract from the system.
+	 * @param {String} contractId The contract number.
+	 * getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContract(contractId) { 
+		// verify the required parameter 'contractId' is set
+		if (contractId === undefined || contractId === null) {
+			throw 'Missing the required parameter "contractId" when calling getBillingContract';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts/{contractId}', 
+			'GET', 
+			{ 'contractId': contractId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get contract billing period
+	 * Fetch the billing information for a given Organization by billing period.
+	 * @param {String} contractId The contract number.
+	 * @param {String} billingPeriodId The Billing Period Id for the Org.
+	 * getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContractBillingperiod(contractId, billingPeriodId) { 
+		// verify the required parameter 'contractId' is set
+		if (contractId === undefined || contractId === null) {
+			throw 'Missing the required parameter "contractId" when calling getBillingContractBillingperiod';
+		}
+		// verify the required parameter 'billingPeriodId' is set
+		if (billingPeriodId === undefined || billingPeriodId === null) {
+			throw 'Missing the required parameter "billingPeriodId" when calling getBillingContractBillingperiod';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts/{contractId}/billingperiods/{billingPeriodId}', 
+			'GET', 
+			{ 'contractId': contractId,'billingPeriodId': billingPeriodId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get billing contracts
+	 * Retrieve a list of contracts stored in the system.
+	 * @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.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Object} opts.status Filter by the status of contracts
+	 * @param {String} opts.externalNumber Filter by the unique external number.
+	 * getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContracts(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': opts['status'],'externalNumber': opts['externalNumber'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get invoice document
+	 * Fetch the document for a specific invoice.
+	 * @param {String} invoiceId invoiceId
+	 * getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContractsInvoiceDocument(invoiceId) { 
+		// verify the required parameter 'invoiceId' is set
+		if (invoiceId === undefined || invoiceId === null) {
+			throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceDocument';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts/invoices/{invoiceId}/document', 
+			'GET', 
+			{ 'invoiceId': invoiceId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get invoice lines
+	 * Fetch a list of all bills for the specified account.
+	 * @param {String} invoiceId invoiceId
+	 * @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.
+	 * getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContractsInvoiceLines(invoiceId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'invoiceId' is set
+		if (invoiceId === undefined || invoiceId === null) {
+			throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceLines';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts/invoices/{invoiceId}/lines', 
+			'GET', 
+			{ 'invoiceId': invoiceId },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get invoices
+	 * Retrieve a list of invoices stored in the system.
+	 * @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.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+	 * @param {Object} opts.paymentStatus Payment Status
+	 * getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getBillingContractsInvoices(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/billing/contracts/invoices', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'paymentStatus': opts['paymentStatus'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get a report of the billable license usages
 	 * Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If responses status is InProgress, wait a few seconds, then try the same request again.