param.
+ */
+ paramToString(param) {
+ if (param == undefined || param == null) {
+ return '';
+ }
+ if (param instanceof Date) {
+ return param.toJSON();
+ }
+
+ return param.toString();
+ }
+
+ /**
+ * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
+ * NOTE: query parameters are not handled here.
+ * @param {String} path The path to append to the base URL.
+ * @param {Object} pathParams The parameter values to append.
+ * @returns {String} The encoded path with parameter values substituted.
+ */
+ buildUrl(path, pathParams) {
+ if (!path.match(/^\//)) {
+ path = '/' + path;
+ }
+
+ var url = this.basePath + path;
+ url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
+ var value;
+ if (pathParams.hasOwnProperty(key)) {
+ value = this.paramToString(pathParams[key]);
+ } else {
+ value = fullMatch;
+ }
+
+ return encodeURIComponent(value);
+ });
+
+ return url;
+ }
+
+ /**
+ * Checks whether the given content type represents JSON.true if contentType represents JSON, otherwise false.
+ */
+ isJsonMime(contentType) {
+ return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
+ }
+
+ /**
+ * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+ * @param {Array.true if param represents a file.
+ */
+ isFileParam(param) {
+ // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
+ if (typeof require === 'function') {
+ let fs;
+ try {
+ fs = require('fs');
+ } catch (err) {}
+ if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
+ return true;
+ }
+ }
+
+ // Buffer in Node.js
+ if (typeof Buffer === 'function' && param instanceof Buffer) {
+ return true;
+ }
+
+ // Blob in browser
+ if (typeof Blob === 'function' && param instanceof Blob) {
+ return true;
+ }
+
+ // File in browser (it seems File object is also instance of Blob, but keep this for safe)
+ if (typeof File === 'function' && param instanceof File) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Normalizes parameter values:
+ * csv
+ * @const
+ */
+ CSV: ',',
+
+ /**
+ * Space-separated values. Value: ssv
+ * @const
+ */
+ SSV: ' ',
+
+ /**
+ * Tab-separated values. Value: tsv
+ * @const
+ */
+ TSV: '\t',
+
+ /**
+ * Pipe(|)-separated values. Value: pipes
+ * @const
+ */
+ PIPES: '|',
+
+ /**
+ * Native array. Value: multi
+ * @const
+ */
+ MULTI: 'multi'
+ };
+
+ /**
+ * Builds a string representation of an array-type actual parameter, according to the given collection format.
+ * @param {Array} param An array parameter.
+ * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
+ * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
+ * param as is if collectionFormat is multi.
+ */
+ buildCollectionParam(param, collectionFormat) {
+ if (param == null) {
+ return null;
+ }
+ switch (collectionFormat) {
+ case 'csv':
+ return param.map(this.paramToString).join(',');
+ case 'ssv':
+ return param.map(this.paramToString).join(' ');
+ case 'tsv':
+ return param.map(this.paramToString).join('\t');
+ case 'pipes':
+ return param.map(this.paramToString).join('|');
+ case 'multi':
+ //return the array directly as SuperAgent will handle it as expected
+ return param.map(this.paramToString);
+ default:
+ throw new Error('Unknown collection format: ' + collectionFormat);
+ }
+ }
+
+ /**
+ * Applies authentication headers to the request.
+ * @param {Object} request The request object created by a superagent() call.
+ * @param {String} authName String representing authentication method name.
+ */
+ applyAuthToRequest(request, authName) {
+ var auth = this.authentication[authName];
+
+ if (auth.type === 'oauth2'){
+ if (auth.accessToken) {
+ request.set({'Authorization': 'Bearer ' + auth.accessToken});
+ }
+ }
+ else{
+ throw new Error('Unknown authentication type: ' + auth.type);
+ }
+ }
+
+ /**
+ * Deserializes an HTTP response body into a value of the specified type.
+ * @param {Object} response A SuperAgent response object.
+ * @param {(String|Array.data will be converted to this type.
+ * @returns A value of the specified type.
+ */
+ deserialize(response, returnType) {
+ if (response == null || returnType == null || response.status == 204) {
+ return null;
+ }
+
+ // Rely on SuperAgent for parsing response body.
+ // See http://visionmedia.github.io/superagent/#parsing-response-bodies
+ var data = response.body;
+ if (data == null || (typeof data === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length)) {
+ // SuperAgent does not always produce a body; use the unparsed response as a fallback
+ data = response.text;
+ }
+
+ return ApiClient.convertToType(data, returnType);
+ }
+
+
+
+ /**
+ * Invokes the REST service using the supplied settings and parameters.
+ * @param {String} path The base URL to invoke.
+ * @param {String} httpMethod The HTTP method to use.
+ * @param {Object.} pathParams A map of path parameters and their values.
+ * @param {Object.} queryParams A map of query parameters and their values.
+ * @param {Object.} headerParams A map of header parameters and their values.
+ * @param {Object.} formParams A map of form parameters and their values.
+ * @param {Object} bodyParam The value to pass as the request body.
+ * @param {String} authName String representing authentication method name.
+ * @param {Array.} contentTypes An array of request MIME types.
+ * @param {Array.} accepts An array of acceptable response MIME types.
+ * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
+ * constructor for a complex type.
+ * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
+ */
+ callApi(path, httpMethod, pathParams,
+ queryParams, headerParams, formParams, bodyParam, authName, contentTypes, accepts,
+ returnType, caller) {
+
+ var url = this.buildUrl(path, pathParams);
+ var request = superagent(httpMethod, url);
+
+ // apply authentication
+ this.applyAuthToRequest(request, authName);
+
+ // set query parameters
+ if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {
+ queryParams['_'] = new Date().getTime();
+ }
+
+ request.query(this.normalizeParams(queryParams));
+
+ // set header parameters
+ request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
+
+ // set requestAgent if it is set by user
+ if (this.requestAgent) {
+ request.agent(this.requestAgent);
+ }
+
+ // set request timeout
+ request.timeout(this.timeout);
+
+ var contentType = this.jsonPreferredMime(contentTypes);
+ if (contentType) {
+ // Issue with superagent and multipart/form-data (https://github.com/visionmedia/superagent/issues/746)
+ if(contentType != 'multipart/form-data') {
+ request.type(contentType);
+ }
+ } else if (!request.header['Content-Type']) {
+ request.type('application/json');
+ }
+
+ if (contentType === 'application/x-www-form-urlencoded') {
+ request.send(querystring.stringify(this.normalizeParams(formParams)));
+ } else if (contentType == 'multipart/form-data') {
+ var _formParams = this.normalizeParams(formParams);
+ for (var key in _formParams) {
+ if (_formParams.hasOwnProperty(key)) {
+ if (this.isFileParam(_formParams[key])) {
+ // file field
+ request.attach(key, _formParams[key]);
+ } else {
+ request.field(key, _formParams[key]);
+ }
+ }
+ }
+ } else if (bodyParam) {
+ request.send(bodyParam);
+ }
+
+ var accept = this.jsonPreferredMime(accepts);
+ if (accept) {
+ request.accept(accept);
+ }
+
+ if (returnType === 'Blob') {
+ request.responseType('blob');
+ } else if (returnType === 'String') {
+ request.responseType('string');
+ }
+
+ // Attach previously saved cookies, if enabled
+ if (this.enableCookies){
+ if (typeof window === 'undefined') {
+ this.agent.attachCookies(request);
+ }
+ else {
+ request.withCredentials();
+ }
+ }
+
+ return new Promise((resolve, reject) => {
+ request.end((error, response) => {
+ if (error) {
+ reject(ApiExceptionFactory.createCustomException(caller, error));
+ } else {
+ try {
+ var data = this.deserialize(response, returnType);
+
+ resolve({data, response});
+ } catch (err) {
+ reject(err);
+ }
+ }
+ });
+ });
+
+
+ }
+
+ /**
+ * Parses an ISO-8601 string representation of a date value.
+ * @param {String} str The date value as a string.
+ * @returns {Date} The parsed date object.
+ */
+ static parseDate(str) {
+ return new Date(str);
+ }
+
+ /**
+ * Converts a value to the specified type.
+ * @param {(String|Object)} data The data to convert, as a string or object.
+ * @param {(String|Array.|Object.|Function)} type The type to return. Pass a string for simple types
+ * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+ * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+ * all properties on data will be converted to this type.
+ * @returns An instance of the specified type or null or undefined if data is null or undefined.
+ */
+ static convertToType(data, type) {
+ if (data === null || data === undefined)
+ return data
+
+ switch (type) {
+ case 'Boolean':
+ return Boolean(data);
+ case 'Integer':
+ return parseInt(data, 10);
+ case 'Number':
+ return parseFloat(data);
+ case 'String':
+ return String(data);
+ case 'Date':
+ return ApiClient.parseDate(String(data));
+ case 'Blob':
+ return data;
+ default:
+ if (type === Object) {
+ // generic object, return directly
+ return data;
+ } else if (typeof type === 'function') {
+ // for model type like: User
+ return type.constructFromObject(data);
+ } else if (Array.isArray(type)) {
+ // for array type like: ['String']
+ var itemType = type[0];
+
+ return data.map((item) => {
+ return ApiClient.convertToType(item, itemType);
+ });
+ } else if (typeof type === 'object') {
+ // for plain object type like: {'String': 'Integer'}
+ var keyType, valueType;
+ for (var k in type) {
+ if (type.hasOwnProperty(k)) {
+ keyType = k;
+ valueType = type[k];
+ break;
+ }
+ }
+
+ var result = {};
+ for (var k in data) {
+ if (data.hasOwnProperty(k)) {
+ var key = ApiClient.convertToType(k, keyType);
+ var value = ApiClient.convertToType(data[k], valueType);
+ result[key] = value;
+ }
+ }
+
+ return result;
+ } else {
+ // for unknown type, return the data directly
+ return data;
+ }
+ }
+ }
+
+ /**
+ * Constructs a new map or array model from REST data.
+ * @param data {Object|Array} The REST data.
+ * @param obj {Object|Array} The target object or array.
+ */
+ static constructFromObject(data, obj, itemType) {
+ if (Array.isArray(data)) {
+ for (var i = 0; i < data.length; i++) {
+ if (data.hasOwnProperty(i))
+ obj[i] = ApiClient.convertToType(data[i], itemType);
+ }
+ } else {
+ for (var k in data) {
+ if (data.hasOwnProperty(k))
+ obj[k] = ApiClient.convertToType(data[k], itemType);
+ }
+ }
+ };
+}
+
+/**
+* The default API client implementation.
+* @type {module:ApiClient}
+*/
+
+module.exports = ApiClient;
\ No newline at end of file
diff --git a/src/Auth/AuthService.js b/src/Auth/AuthService.js
new file mode 100644
index 0000000..3401e27
--- /dev/null
+++ b/src/Auth/AuthService.js
@@ -0,0 +1,59 @@
+const RuntimeInformationProvider = require('../RuntimeInformationProvider');
+
+class AuthService{
+ constructor(clientConfig, apiClient, cacheService){
+ this.clientConfig = clientConfig;
+ this.apiClient = apiClient;
+ this.cacheService = cacheService;
+ }
+
+ async getTokenResponse() {
+
+ let cacheKey = this.getCacheKey();
+ let cachedTokenResponse = this.cacheService.get(cacheKey);
+
+ if(!cachedTokenResponse){
+ this.apiClient.basePath = this.clientConfig.authBaseUrl;
+
+ let authRequestResponse = await this.apiClient.callApi('v2/token',
+ 'POST',
+ {},
+ {},
+ {'User-Agent': new RuntimeInformationProvider().getUserAgentString()},
+ {},
+ this.getTokenRequestPayload(),
+ 'oauth2',
+ [],
+ [],
+ Object,
+ 'getTokenResponse'
+ );
+
+ this.cacheService.addOrUpdate(cacheKey, authRequestResponse.data);
+
+ return authRequestResponse.data;
+ }
+ else{
+ return cachedTokenResponse.tokenResponse;
+ }
+ }
+
+ getCacheKey(){
+ return this.clientConfig.clientId + '-' + this.clientConfig.accountId;
+ }
+
+ getTokenRequestPayload(){
+ let tokenRequestPayload = {
+ 'client_id': this.clientConfig.clientId,
+ 'client_secret': this.clientConfig.clientSecret,
+ 'grant_type': 'client_credentials',
+ 'account_id': this.clientConfig.accountId
+ };
+ if (this.clientConfig.scope) {
+ tokenRequestPayload['scope'] = this.clientConfig.scope;
+ }
+ return tokenRequestPayload;
+ }
+}
+
+module.exports = AuthService;
\ No newline at end of file
diff --git a/src/Auth/Authentication.js b/src/Auth/Authentication.js
new file mode 100644
index 0000000..c4598ce
--- /dev/null
+++ b/src/Auth/Authentication.js
@@ -0,0 +1,18 @@
+class Authentication {
+ constructor(){
+ this._accessToken = undefined;
+ this._type = "oauth2";
+ }
+
+ get accessToken() {
+ return this._accessToken;
+ }
+ set accessToken(value) {
+ this._accessToken = value;
+ }
+ get type() {
+ return this._type;
+ }
+}
+
+module.exports = Authentication;
\ No newline at end of file
diff --git a/src/Auth/CacheService.js b/src/Auth/CacheService.js
new file mode 100644
index 0000000..4e5617c
--- /dev/null
+++ b/src/Auth/CacheService.js
@@ -0,0 +1,26 @@
+class CacheService {
+ static cachedData = {};
+
+ get(cacheKey) {
+ if (CacheService.cachedData.hasOwnProperty(cacheKey) && this.isCachedValueValid(cacheKey)) {
+ return CacheService.cachedData[cacheKey];
+ }
+ return null;
+ }
+
+ addOrUpdate(cacheKey, value) {
+ let invalidCacheWindowInSeconds = 30;
+ let expirationTime = new Date().getTime() + (value.expires_in - invalidCacheWindowInSeconds) * 1000;
+
+ CacheService.cachedData[cacheKey] = {
+ expirationTime: expirationTime,
+ tokenResponse: value
+ }
+ }
+
+ isCachedValueValid(cacheKey) {
+ return new Date().getTime() < CacheService.cachedData[cacheKey].expirationTime;
+ }
+}
+
+module.exports = CacheService;
\ No newline at end of file
diff --git a/src/Auth/ClientConfiguration.js b/src/Auth/ClientConfiguration.js
new file mode 100644
index 0000000..5af5241
--- /dev/null
+++ b/src/Auth/ClientConfiguration.js
@@ -0,0 +1,30 @@
+class ClientConfiguration{
+ constructor(authBaseUrl, clientId, clientSecret, accountId, scope){
+ this._authBaseUrl = authBaseUrl;
+ this._clientId = clientId;
+ this._clientSecret = clientSecret;
+ this._accountId = accountId;
+ this._scope = scope;
+ }
+ get authBaseUrl() {
+ return this._authBaseUrl;
+ }
+
+ get clientId() {
+ return this._clientId;
+ }
+
+ get clientSecret() {
+ return this._clientSecret;
+ }
+
+ get accountId() {
+ return this._accountId;
+ }
+
+ get scope() {
+ return this._scope;
+ }
+}
+
+module.exports = ClientConfiguration;
\ No newline at end of file
diff --git a/src/EnvironmentConfigProvider.js b/src/EnvironmentConfigProvider.js
new file mode 100644
index 0000000..24c0322
--- /dev/null
+++ b/src/EnvironmentConfigProvider.js
@@ -0,0 +1,17 @@
+const EnvironmentVariableNotSetException = require('./Exception/EnvironmentVariableNotSetException');
+
+class EnvironmentConfigProvider {
+ get(envVariable, isMandatory = true) {
+ let envVariableValue = process.env[envVariable];
+
+ if (envVariableValue) {
+ return envVariableValue;
+ }
+ if (isMandatory) {
+ throw new EnvironmentVariableNotSetException(envVariable);
+ }
+ return null;
+ }
+}
+
+module.exports = EnvironmentConfigProvider;
\ No newline at end of file
diff --git a/src/Exception/ApiException.js b/src/Exception/ApiException.js
new file mode 100644
index 0000000..56e8483
--- /dev/null
+++ b/src/Exception/ApiException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class ApiException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = ApiException;
+
diff --git a/src/Exception/ApiExceptionFactory.js b/src/Exception/ApiExceptionFactory.js
new file mode 100644
index 0000000..29f7aa2
--- /dev/null
+++ b/src/Exception/ApiExceptionFactory.js
@@ -0,0 +1,50 @@
+const BadRequestException = require('./BadRequestException');
+const AuthenticationFailureException = require('./AuthenticationFailureException');
+const UnauthorizedAccessException = require('./UnauthorizedAccessException');
+const ResourceNotFoundException = require('./ResourceNotFoundException');
+const InternalServerErrorException = require('./InternalServerErrorException');
+const BadGatewayException = require('./BadGatewayException');
+const ServiceUnavailableException = require('./ServiceUnavailableException');
+const GatewayTimeoutException = require('./GatewayTimeoutException');
+const ServerUnreachableException = require('./ServerUnreachableException');
+const ApiException = require('./ApiException');
+
+class ApiExceptionFactory {
+ static createCustomException(caller, error) {
+ let statusCode = error.status;
+ let exceptionMessage;
+
+ if (statusCode >= 400) {
+
+ exceptionMessage = `Error calling ${caller}: ${JSON.stringify(error.response.body)}`;
+
+ switch (statusCode) {
+ case 400:
+ return new BadRequestException(exceptionMessage, statusCode);
+ case 401:
+ return new AuthenticationFailureException(exceptionMessage, statusCode);
+ case 403:
+ return new UnauthorizedAccessException(exceptionMessage, statusCode);
+ case 404:
+ return new ResourceNotFoundException(exceptionMessage, statusCode);
+ case 500:
+ return new InternalServerErrorException(exceptionMessage, statusCode);
+ case 502:
+ return new BadGatewayException(exceptionMessage, statusCode);
+ case 503:
+ return new ServiceUnavailableException(exceptionMessage, statusCode);
+ case 504:
+ return new GatewayTimeoutException(exceptionMessage, statusCode);
+ default:
+ return new ApiException(exceptionMessage, statusCode);
+ }
+ }
+ if(statusCode === undefined){
+ exceptionMessage = `Error calling ${caller}: ${JSON.stringify(error)}`;
+
+ return new ServerUnreachableException(exceptionMessage);
+ }
+ }
+}
+
+module.exports = ApiExceptionFactory;
\ No newline at end of file
diff --git a/src/Exception/AuthenticationFailureException.js b/src/Exception/AuthenticationFailureException.js
new file mode 100644
index 0000000..2e8e8d0
--- /dev/null
+++ b/src/Exception/AuthenticationFailureException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class AuthenticationFailureException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = AuthenticationFailureException;
+
diff --git a/src/Exception/BadGatewayException.js b/src/Exception/BadGatewayException.js
new file mode 100644
index 0000000..a2996eb
--- /dev/null
+++ b/src/Exception/BadGatewayException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class BadGatewayException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = BadGatewayException;
+
diff --git a/src/Exception/BadRequestException.js b/src/Exception/BadRequestException.js
new file mode 100644
index 0000000..ad4f312
--- /dev/null
+++ b/src/Exception/BadRequestException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class BadRequestException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = BadRequestException;
+
diff --git a/src/Exception/BaseApiException.js b/src/Exception/BaseApiException.js
new file mode 100644
index 0000000..c41631a
--- /dev/null
+++ b/src/Exception/BaseApiException.js
@@ -0,0 +1,10 @@
+class BaseApiException extends Error {
+ constructor(exceptionMessage, statusCode) {
+ super();
+ this.message = exceptionMessage;
+ this.status = statusCode;
+ }
+}
+
+module.exports = BaseApiException;
+
diff --git a/src/Exception/EnvironmentVariableNotSetException.js b/src/Exception/EnvironmentVariableNotSetException.js
new file mode 100644
index 0000000..3681fcb
--- /dev/null
+++ b/src/Exception/EnvironmentVariableNotSetException.js
@@ -0,0 +1,10 @@
+class EnvironmentVariableNotSetException extends Error {
+ constructor(envVariable) {
+ super();
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ this.message = `Environment variable ${envVariable} is not set`;
+ }
+}
+
+module.exports = EnvironmentVariableNotSetException;
+
diff --git a/src/Exception/GatewayTimeoutException.js b/src/Exception/GatewayTimeoutException.js
new file mode 100644
index 0000000..61417b1
--- /dev/null
+++ b/src/Exception/GatewayTimeoutException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class GatewayTimeoutException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = GatewayTimeoutException;
+
diff --git a/src/Exception/InternalServerErrorException.js b/src/Exception/InternalServerErrorException.js
new file mode 100644
index 0000000..bdfaa90
--- /dev/null
+++ b/src/Exception/InternalServerErrorException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class InternalServerErrorException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = InternalServerErrorException;
+
diff --git a/src/Exception/InvalidModelException.js b/src/Exception/InvalidModelException.js
new file mode 100644
index 0000000..293bf10
--- /dev/null
+++ b/src/Exception/InvalidModelException.js
@@ -0,0 +1,9 @@
+class InvalidModelException extends Error {
+ constructor(exceptionMessage) {
+ super();
+ this.message = exceptionMessage;
+ }
+}
+
+module.exports = InvalidModelException;
+
diff --git a/src/Exception/ResourceNotFoundException.js b/src/Exception/ResourceNotFoundException.js
new file mode 100644
index 0000000..5327912
--- /dev/null
+++ b/src/Exception/ResourceNotFoundException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class ResourceNotFoundException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = ResourceNotFoundException;
+
diff --git a/src/Exception/ServerUnreachableException.js b/src/Exception/ServerUnreachableException.js
new file mode 100644
index 0000000..7de19b8
--- /dev/null
+++ b/src/Exception/ServerUnreachableException.js
@@ -0,0 +1,10 @@
+class ServerUnreachableException extends Error {
+ constructor(exceptionMessage) {
+ super();
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ this.message = exceptionMessage;
+ }
+}
+
+module.exports = ServerUnreachableException;
+
diff --git a/src/Exception/ServiceUnavailableException.js b/src/Exception/ServiceUnavailableException.js
new file mode 100644
index 0000000..d35fc51
--- /dev/null
+++ b/src/Exception/ServiceUnavailableException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class ServiceUnavailableException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = ServiceUnavailableException;
+
diff --git a/src/Exception/UnauthorizedAccessException.js b/src/Exception/UnauthorizedAccessException.js
new file mode 100644
index 0000000..cc3e2c6
--- /dev/null
+++ b/src/Exception/UnauthorizedAccessException.js
@@ -0,0 +1,11 @@
+const BaseApiException = require('./BaseApiException');
+
+class UnauthorizedAccessException extends BaseApiException {
+ constructor(exceptionMessage, statusCode) {
+ super(exceptionMessage, statusCode);
+ this.name = 'Salesforce.MarketingCloud.Exceptions.' + this.constructor.name;
+ }
+}
+
+module.exports = UnauthorizedAccessException;
+
diff --git a/src/Model/ApiError.js b/src/Model/ApiError.js
new file mode 100644
index 0000000..6b91bbd
--- /dev/null
+++ b/src/Model/ApiError.js
@@ -0,0 +1,95 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The ApiError model module.
+* @module Model/ApiError
+* @version 1.0.0
+*/
+module.exports = class ApiError{
+ /**
+ * Constructs a new ApiError.
+ * @alias module:Model/ApiError
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a ApiError from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/ApiError} obj Optional instance to populate.
+ * @return {module:Model/ApiError} The populated ApiError instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new ApiError();
+
+
+
+
+
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('errorCode')) {
+ obj['errorCode'] = ApiClient.convertToType(data['errorCode'], 'Number');
+ }
+ if (data.hasOwnProperty('documentation')) {
+ obj['documentation'] = ApiClient.convertToType(data['documentation'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The error message
+ * @member {String} message
+ */
+ message = undefined;
+ /**
+ * The specific error code
+ * @member {Number} errorCode
+ */
+ errorCode = undefined;
+ /**
+ * Any specific documentation for the error
+ * @member {String} documentation
+ */
+ documentation = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/Asset.js b/src/Model/Asset.js
new file mode 100644
index 0000000..64aa7a6
--- /dev/null
+++ b/src/Model/Asset.js
@@ -0,0 +1,344 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const AssetType = require ('./AssetType');
+const SharingProperties = require ('./SharingProperties');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The Asset model module.
+* @module Model/Asset
+* @version 1.0.0
+*/
+module.exports = class Asset{
+ /**
+ * Constructs a new Asset.
+ * @alias module:Model/Asset
+ * @class
+ * @param customerKey {String} Reference to customer's private ID/name for the asset
+ * @param assetType {module:Model/AssetType}
+ * @param name {String} Name of the asset, set by the client
+ * @param description {String} Description of the asset, set by the client
+ */
+
+ constructor(customerKey, assetType, name, description) {
+
+
+ // verify the required parameter 'customerKey' is set
+ if(customerKey === undefined || customerKey === null){
+ throw new InvalidModelException('"customerKey" is a required property for Asset and cannot be undefined or null');
+ }
+ this['customerKey'] = customerKey;
+
+
+
+ // verify the required parameter 'assetType' is set
+ if(assetType === undefined || assetType === null){
+ throw new InvalidModelException('"assetType" is a required property for Asset and cannot be undefined or null');
+ }
+ this['assetType'] = assetType;
+
+
+
+
+ // verify the required parameter 'name' is set
+ if(name === undefined || name === null){
+ throw new InvalidModelException('"name" is a required property for Asset and cannot be undefined or null');
+ }
+ this['name'] = name;
+
+ // verify the required parameter 'description' is set
+ if(description === undefined || description === null){
+ throw new InvalidModelException('"description" is a required property for Asset and cannot be undefined or null');
+ }
+ this['description'] = description;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a Asset from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/Asset} obj Optional instance to populate.
+ * @return {module:Model/Asset} The populated Asset instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new Asset();
+
+
+
+
+
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'Number');
+ }
+ if (data.hasOwnProperty('customerKey')) {
+ obj['customerKey'] = ApiClient.convertToType(data['customerKey'], 'String');
+ }
+ if (data.hasOwnProperty('contentType')) {
+ obj['contentType'] = ApiClient.convertToType(data['contentType'], 'String');
+ }
+ if (data.hasOwnProperty('data')) {
+ obj['data'] = ApiClient.convertToType(data['data'], Object);
+ }
+ if (data.hasOwnProperty('assetType')) {
+ obj['assetType'] = AssetType.constructFromObject(data['assetType']);
+ }
+ if (data.hasOwnProperty('version')) {
+ obj['version'] = ApiClient.convertToType(data['version'], 'Number');
+ }
+ if (data.hasOwnProperty('locked')) {
+ obj['locked'] = ApiClient.convertToType(data['locked'], 'Boolean');
+ }
+ if (data.hasOwnProperty('fileProperties')) {
+ obj['fileProperties'] = ApiClient.convertToType(data['fileProperties'], Object);
+ }
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('category')) {
+ obj['category'] = ApiClient.convertToType(data['category'], Object);
+ }
+ if (data.hasOwnProperty('tags')) {
+ obj['tags'] = ApiClient.convertToType(data['tags'], ['String']);
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = ApiClient.convertToType(data['content'], 'String');
+ }
+ if (data.hasOwnProperty('design')) {
+ obj['design'] = ApiClient.convertToType(data['design'], 'String');
+ }
+ if (data.hasOwnProperty('superContent')) {
+ obj['superContent'] = ApiClient.convertToType(data['superContent'], 'String');
+ }
+ if (data.hasOwnProperty('customFields')) {
+ obj['customFields'] = ApiClient.convertToType(data['customFields'], Object);
+ }
+ if (data.hasOwnProperty('views')) {
+ obj['views'] = ApiClient.convertToType(data['views'], Object);
+ }
+ if (data.hasOwnProperty('blocks')) {
+ obj['blocks'] = ApiClient.convertToType(data['blocks'], Object);
+ }
+ if (data.hasOwnProperty('minBlocks')) {
+ obj['minBlocks'] = ApiClient.convertToType(data['minBlocks'], 'Number');
+ }
+ if (data.hasOwnProperty('maxBlocks')) {
+ obj['maxBlocks'] = ApiClient.convertToType(data['maxBlocks'], 'Number');
+ }
+ if (data.hasOwnProperty('channels')) {
+ obj['channels'] = ApiClient.convertToType(data['channels'], Object);
+ }
+ if (data.hasOwnProperty('allowedBlocks')) {
+ obj['allowedBlocks'] = ApiClient.convertToType(data['allowedBlocks'], ['String']);
+ }
+ if (data.hasOwnProperty('slots')) {
+ obj['slots'] = ApiClient.convertToType(data['slots'], Object);
+ }
+ if (data.hasOwnProperty('businessUnitAvailability')) {
+ obj['businessUnitAvailability'] = ApiClient.convertToType(data['businessUnitAvailability'], Object);
+ }
+ if (data.hasOwnProperty('sharingProperties')) {
+ obj['sharingProperties'] = SharingProperties.constructFromObject(data['sharingProperties']);
+ }
+ if (data.hasOwnProperty('template')) {
+ obj['template'] = ApiClient.convertToType(data['template'], Object);
+ }
+ if (data.hasOwnProperty('file')) {
+ obj['file'] = ApiClient.convertToType(data['file'], 'String');
+ }
+ if (data.hasOwnProperty('generateFrom')) {
+ obj['generateFrom'] = ApiClient.convertToType(data['generateFrom'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The id of the asset
+ * @member {Number} id
+ */
+ id = undefined;
+ /**
+ * Reference to customer's private ID/name for the asset
+ * @member {String} customerKey
+ */
+ customerKey = undefined;
+ /**
+ * The type that the content attribute will be in
+ * @member {String} contentType
+ */
+ contentType = undefined;
+ /**
+ * Property bag containing the asset data
+ * @member {Object} data
+ */
+ data = undefined;
+ /**
+ * @member {module:Model/AssetType} assetType
+ */
+ assetType = undefined;
+ /**
+ * The version of the asset
+ * @member {Number} version
+ */
+ version = undefined;
+ /**
+ * Specifies if the asset can be modified or not
+ * @member {Boolean} locked
+ */
+ locked = undefined;
+ /**
+ * Stores the different properties that this asset refers to if it is a file type
+ * @member {Object} fileProperties
+ */
+ fileProperties = undefined;
+ /**
+ * Name of the asset, set by the client
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * Description of the asset, set by the client
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * ID of the category the asset belongs to
+ * @member {Object} category
+ */
+ category = undefined;
+ /**
+ * List of tags associated with the asset
+ * @member {Array.} tags
+ */
+ tags = undefined;
+ /**
+ * The actual content of the asset
+ * @member {String} content
+ */
+ content = undefined;
+ /**
+ * Fallback for display when neither content nor supercontent are provided
+ * @member {String} design
+ */
+ design = undefined;
+ /**
+ * Content that supersedes content in terms of display
+ * @member {String} superContent
+ */
+ superContent = undefined;
+ /**
+ * Custom fields within an asset
+ * @member {Object} customFields
+ */
+ customFields = undefined;
+ /**
+ * Views within an asset
+ * @member {Object} views
+ */
+ views = undefined;
+ /**
+ * Blocks within the asset
+ * @member {Object} blocks
+ */
+ blocks = undefined;
+ /**
+ * Minimum number of blocks within an asset
+ * @member {Number} minBlocks
+ */
+ minBlocks = undefined;
+ /**
+ * Maximum number of blocks within an asset
+ * @member {Number} maxBlocks
+ */
+ maxBlocks = undefined;
+ /**
+ * List of channels that are allowed to use this asset
+ * @member {Object} channels
+ */
+ channels = undefined;
+ /**
+ * List of blocks that are allowed in the asset
+ * @member {Array.} allowedBlocks
+ */
+ allowedBlocks = undefined;
+ /**
+ * Slots within the asset
+ * @member {Object} slots
+ */
+ slots = undefined;
+ /**
+ * A dictionary of member IDs that have been granted access to the asset
+ * @member {Object} businessUnitAvailability
+ */
+ businessUnitAvailability = undefined;
+ /**
+ * @member {module:Model/SharingProperties} sharingProperties
+ */
+ sharingProperties = undefined;
+ /**
+ * Template the asset follows
+ * @member {Object} template
+ */
+ template = undefined;
+ /**
+ * Base64-encoded string of a file associated with an asset
+ * @member {String} file
+ */
+ file = undefined;
+ /**
+ * Tells the sending compiler what view to use for generating this view's content
+ * @member {String} generateFrom
+ */
+ generateFrom = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/AssetType.js b/src/Model/AssetType.js
new file mode 100644
index 0000000..b0954c8
--- /dev/null
+++ b/src/Model/AssetType.js
@@ -0,0 +1,108 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The AssetType model module.
+* @module Model/AssetType
+* @version 1.0.0
+*/
+module.exports = class AssetType{
+ /**
+ * Constructs a new AssetType.
+ * The asset type
+ * @alias module:Model/AssetType
+ * @class
+ * @param id {Number} The id of the asset type
+ * @param name {String} The name of the asset type
+ */
+
+ constructor(id, name) {
+
+ // verify the required parameter 'id' is set
+ if(id === undefined || id === null){
+ throw new InvalidModelException('"id" is a required property for AssetType and cannot be undefined or null');
+ }
+ this['id'] = id;
+
+ // verify the required parameter 'name' is set
+ if(name === undefined || name === null){
+ throw new InvalidModelException('"name" is a required property for AssetType and cannot be undefined or null');
+ }
+ this['name'] = name;
+
+
+ }
+
+ /**
+ * Constructs a AssetType from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/AssetType} obj Optional instance to populate.
+ * @return {module:Model/AssetType} The populated AssetType instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new AssetType();
+
+
+
+
+
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'Number');
+ }
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('displayName')) {
+ obj['displayName'] = ApiClient.convertToType(data['displayName'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The id of the asset type
+ * @member {Number} id
+ */
+ id = undefined;
+ /**
+ * The name of the asset type
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * The description of the asset type
+ * @member {String} displayName
+ */
+ displayName = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/Attributes.js b/src/Model/Attributes.js
new file mode 100644
index 0000000..8674c3f
--- /dev/null
+++ b/src/Model/Attributes.js
@@ -0,0 +1,68 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The Attributes model module.
+* @module Model/Attributes
+* @version 1.0.0
+*/
+module.exports = class Attributes{
+ /**
+ * Constructs a new Attributes.
+ * @alias module:Model/Attributes
+ * @class
+ */
+
+ constructor() {
+
+ }
+
+ /**
+ * Constructs a Attributes from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/Attributes} obj Optional instance to populate.
+ * @return {module:Model/Attributes} The populated Attributes instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new Attributes();
+
+
+
+
+
+ }
+ return obj;
+ }
+
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/Campaign.js b/src/Model/Campaign.js
new file mode 100644
index 0000000..b73f99e
--- /dev/null
+++ b/src/Model/Campaign.js
@@ -0,0 +1,179 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The Campaign model module.
+* @module Model/Campaign
+* @version 1.0.0
+*/
+module.exports = class Campaign{
+ /**
+ * Constructs a new Campaign.
+ * @alias module:Model/Campaign
+ * @class
+ * @param name {String} Name of the campaign with a maximum length of 128 characters
+ * @param description {String} Description of the campaign with a maximum length of 512 characters
+ * @param campaignCode {String} Unique identifier for the campaign with a maximum length of 36 characters
+ * @param color {String} Hex color value
+ * @param favorite {Boolean} Determines if the campaign will be flagged as a favorite
+ */
+
+ constructor(name, description, campaignCode, color, favorite) {
+
+ // verify the required parameter 'name' is set
+ if(name === undefined || name === null){
+ throw new InvalidModelException('"name" is a required property for Campaign and cannot be undefined or null');
+ }
+ if (name.length > 128) {
+ throw new InvalidModelException('invalid length for "name". It must be smaller than or equal to 128.');
+ }
+ this['name'] = name;
+
+ // verify the required parameter 'description' is set
+ if(description === undefined || description === null){
+ throw new InvalidModelException('"description" is a required property for Campaign and cannot be undefined or null');
+ }
+ if (description.length > 512) {
+ throw new InvalidModelException('invalid length for "description". It must be smaller than or equal to 512.');
+ }
+ this['description'] = description;
+
+ // verify the required parameter 'campaignCode' is set
+ if(campaignCode === undefined || campaignCode === null){
+ throw new InvalidModelException('"campaignCode" is a required property for Campaign and cannot be undefined or null');
+ }
+ if (campaignCode.length > 36) {
+ throw new InvalidModelException('invalid length for "campaignCode". It must be smaller than or equal to 36.');
+ }
+ this['campaignCode'] = campaignCode;
+
+ // verify the required parameter 'color' is set
+ if(color === undefined || color === null){
+ throw new InvalidModelException('"color" is a required property for Campaign and cannot be undefined or null');
+ }
+ this['color'] = color;
+
+ // verify the required parameter 'favorite' is set
+ if(favorite === undefined || favorite === null){
+ throw new InvalidModelException('"favorite" is a required property for Campaign and cannot be undefined or null');
+ }
+ this['favorite'] = favorite;
+
+
+
+
+ }
+
+ /**
+ * Constructs a Campaign from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/Campaign} obj Optional instance to populate.
+ * @return {module:Model/Campaign} The populated Campaign instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new Campaign();
+
+
+
+
+
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('campaignCode')) {
+ obj['campaignCode'] = ApiClient.convertToType(data['campaignCode'], 'String');
+ }
+ if (data.hasOwnProperty('color')) {
+ obj['color'] = ApiClient.convertToType(data['color'], 'String');
+ }
+ if (data.hasOwnProperty('favorite')) {
+ obj['favorite'] = ApiClient.convertToType(data['favorite'], 'Boolean');
+ }
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('createdDate')) {
+ obj['createdDate'] = ApiClient.convertToType(data['createdDate'], 'Date');
+ }
+ if (data.hasOwnProperty('modifiedDate')) {
+ obj['modifiedDate'] = ApiClient.convertToType(data['modifiedDate'], 'Date');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Name of the campaign with a maximum length of 128 characters
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * Description of the campaign with a maximum length of 512 characters
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * Unique identifier for the campaign with a maximum length of 36 characters
+ * @member {String} campaignCode
+ */
+ campaignCode = undefined;
+ /**
+ * Hex color value
+ * @member {String} color
+ */
+ color = undefined;
+ /**
+ * Determines if the campaign will be flagged as a favorite
+ * @member {Boolean} favorite
+ */
+ favorite = undefined;
+ /**
+ * The id of the campaign
+ * @member {String} id
+ */
+ id = undefined;
+ /**
+ * The date the object was created.
+ * @member {Date} createdDate
+ */
+ createdDate = undefined;
+ /**
+ * The date the object was modified.
+ * @member {Date} modifiedDate
+ */
+ modifiedDate = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateEmailDefinitionContent.js b/src/Model/CreateEmailDefinitionContent.js
new file mode 100644
index 0000000..f04aada
--- /dev/null
+++ b/src/Model/CreateEmailDefinitionContent.js
@@ -0,0 +1,83 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateEmailDefinitionContent model module.
+* @module Model/CreateEmailDefinitionContent
+* @version 1.0.0
+*/
+module.exports = class CreateEmailDefinitionContent{
+ /**
+ * Constructs a new CreateEmailDefinitionContent.
+ * @alias module:Model/CreateEmailDefinitionContent
+ * @class
+ * @param customerKey {String} Unique identifier of the content asset.
+ */
+
+ constructor(customerKey) {
+
+ // verify the required parameter 'customerKey' is set
+ if(customerKey === undefined || customerKey === null){
+ throw new InvalidModelException('"customerKey" is a required property for CreateEmailDefinitionContent and cannot be undefined or null');
+ }
+ this['customerKey'] = customerKey;
+
+ }
+
+ /**
+ * Constructs a CreateEmailDefinitionContent from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateEmailDefinitionContent} obj Optional instance to populate.
+ * @return {module:Model/CreateEmailDefinitionContent} The populated CreateEmailDefinitionContent instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateEmailDefinitionContent();
+
+
+
+
+
+ if (data.hasOwnProperty('customerKey')) {
+ obj['customerKey'] = ApiClient.convertToType(data['customerKey'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier of the content asset.
+ * @member {String} customerKey
+ */
+ customerKey = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateEmailDefinitionOptionsRequest.js b/src/Model/CreateEmailDefinitionOptionsRequest.js
new file mode 100644
index 0000000..bc79b91
--- /dev/null
+++ b/src/Model/CreateEmailDefinitionOptionsRequest.js
@@ -0,0 +1,77 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateEmailDefinitionOptionsRequest model module.
+* @module Model/CreateEmailDefinitionOptionsRequest
+* @version 1.0.0
+*/
+module.exports = class CreateEmailDefinitionOptionsRequest{
+ /**
+ * Constructs a new CreateEmailDefinitionOptionsRequest.
+ * @alias module:Model/CreateEmailDefinitionOptionsRequest
+ * @class
+ */
+
+ constructor() {
+
+
+ }
+
+ /**
+ * Constructs a CreateEmailDefinitionOptionsRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateEmailDefinitionOptionsRequest} obj Optional instance to populate.
+ * @return {module:Model/CreateEmailDefinitionOptionsRequest} The populated CreateEmailDefinitionOptionsRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateEmailDefinitionOptionsRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('trackLinks')) {
+ obj['trackLinks'] = ApiClient.convertToType(data['trackLinks'], 'Boolean');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Wraps links for tracking and reporting. Default is true.
+ * @member {Boolean} trackLinks
+ */
+ trackLinks = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateEmailDefinitionRequest.js b/src/Model/CreateEmailDefinitionRequest.js
new file mode 100644
index 0000000..8e93661
--- /dev/null
+++ b/src/Model/CreateEmailDefinitionRequest.js
@@ -0,0 +1,200 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateEmailDefinitionContent = require ('./CreateEmailDefinitionContent');
+const CreateEmailDefinitionOptionsRequest = require ('./CreateEmailDefinitionOptionsRequest');
+const CreateEmailDefinitionSubscriptions = require ('./CreateEmailDefinitionSubscriptions');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateEmailDefinitionRequest model module.
+* @module Model/CreateEmailDefinitionRequest
+* @version 1.0.0
+*/
+module.exports = class CreateEmailDefinitionRequest{
+ /**
+ * Constructs a new CreateEmailDefinitionRequest.
+ * @alias module:Model/CreateEmailDefinitionRequest
+ * @class
+ * @param name {String} Name of the definition. Must be unique.
+ * @param definitionKey {String} Unique, user-generated key to access the definition object.
+ * @param content {module:Model/CreateEmailDefinitionContent}
+ * @param subscriptions {module:Model/CreateEmailDefinitionSubscriptions}
+ */
+
+ constructor(name, definitionKey, content, subscriptions) {
+
+
+ // verify the required parameter 'name' is set
+ if(name === undefined || name === null){
+ throw new InvalidModelException('"name" is a required property for CreateEmailDefinitionRequest and cannot be undefined or null');
+ }
+ this['name'] = name;
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for CreateEmailDefinitionRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+
+
+
+
+
+
+ // verify the required parameter 'content' is set
+ if(content === undefined || content === null){
+ throw new InvalidModelException('"content" is a required property for CreateEmailDefinitionRequest and cannot be undefined or null');
+ }
+ this['content'] = content;
+
+ // verify the required parameter 'subscriptions' is set
+ if(subscriptions === undefined || subscriptions === null){
+ throw new InvalidModelException('"subscriptions" is a required property for CreateEmailDefinitionRequest and cannot be undefined or null');
+ }
+ this['subscriptions'] = subscriptions;
+
+
+ }
+
+ /**
+ * Constructs a CreateEmailDefinitionRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateEmailDefinitionRequest} obj Optional instance to populate.
+ * @return {module:Model/CreateEmailDefinitionRequest} The populated CreateEmailDefinitionRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateEmailDefinitionRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('definitionId')) {
+ obj['definitionId'] = ApiClient.convertToType(data['definitionId'], 'String');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('classification')) {
+ obj['classification'] = ApiClient.convertToType(data['classification'], 'String');
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('createdDate')) {
+ obj['createdDate'] = ApiClient.convertToType(data['createdDate'], 'Date');
+ }
+ if (data.hasOwnProperty('modifiedDate')) {
+ obj['modifiedDate'] = ApiClient.convertToType(data['modifiedDate'], 'Date');
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = CreateEmailDefinitionContent.constructFromObject(data['content']);
+ }
+ if (data.hasOwnProperty('subscriptions')) {
+ obj['subscriptions'] = CreateEmailDefinitionSubscriptions.constructFromObject(data['subscriptions']);
+ }
+ if (data.hasOwnProperty('options')) {
+ obj['options'] = CreateEmailDefinitionOptionsRequest.constructFromObject(data['options']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * Name of the definition. Must be unique.
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * Unique, user-generated key to access the definition object.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * Definition Id
+ * @member {String} definitionId
+ */
+ definitionId = undefined;
+ /**
+ * User-provided description of the email definition.
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
+ * @member {String} classification
+ */
+ classification = undefined;
+ /**
+ * Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
+ * @member {String} status
+ */
+ status = undefined;
+ /**
+ * The date the object was created.
+ * @member {Date} createdDate
+ */
+ createdDate = undefined;
+ /**
+ * The date the object was modified.
+ * @member {Date} modifiedDate
+ */
+ modifiedDate = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionContent} content
+ */
+ content = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionSubscriptions} subscriptions
+ */
+ subscriptions = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionOptionsRequest} options
+ */
+ options = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateEmailDefinitionSubscriptions.js b/src/Model/CreateEmailDefinitionSubscriptions.js
new file mode 100644
index 0000000..04fbe94
--- /dev/null
+++ b/src/Model/CreateEmailDefinitionSubscriptions.js
@@ -0,0 +1,111 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateEmailDefinitionSubscriptions model module.
+* @module Model/CreateEmailDefinitionSubscriptions
+* @version 1.0.0
+*/
+module.exports = class CreateEmailDefinitionSubscriptions{
+ /**
+ * Constructs a new CreateEmailDefinitionSubscriptions.
+ * @alias module:Model/CreateEmailDefinitionSubscriptions
+ * @class
+ * @param list {String} Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
+ */
+
+ constructor(list) {
+
+ // verify the required parameter 'list' is set
+ if(list === undefined || list === null){
+ throw new InvalidModelException('"list" is a required property for CreateEmailDefinitionSubscriptions and cannot be undefined or null');
+ }
+ this['list'] = list;
+
+
+
+
+ }
+
+ /**
+ * Constructs a CreateEmailDefinitionSubscriptions from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateEmailDefinitionSubscriptions} obj Optional instance to populate.
+ * @return {module:Model/CreateEmailDefinitionSubscriptions} The populated CreateEmailDefinitionSubscriptions instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateEmailDefinitionSubscriptions();
+
+
+
+
+
+ if (data.hasOwnProperty('list')) {
+ obj['list'] = ApiClient.convertToType(data['list'], 'String');
+ }
+ if (data.hasOwnProperty('dataExtension')) {
+ obj['dataExtension'] = ApiClient.convertToType(data['dataExtension'], 'String');
+ }
+ if (data.hasOwnProperty('autoAddSubscriber')) {
+ obj['autoAddSubscriber'] = ApiClient.convertToType(data['autoAddSubscriber'], 'Boolean');
+ }
+ if (data.hasOwnProperty('updateSubscriber')) {
+ obj['updateSubscriber'] = ApiClient.convertToType(data['updateSubscriber'], 'Boolean');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
+ * @member {String} list
+ */
+ list = undefined;
+ /**
+ * Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension.
+ * @member {String} dataExtension
+ */
+ dataExtension = undefined;
+ /**
+ * Adds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true.
+ * @member {Boolean} autoAddSubscriber
+ * @default true
+ */
+ autoAddSubscriber = true;
+ /**
+ * Updates the recipient’s contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.
+ * @member {Boolean} updateSubscriber
+ */
+ updateSubscriber = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateSmsDefinitionContent.js b/src/Model/CreateSmsDefinitionContent.js
new file mode 100644
index 0000000..dc39905
--- /dev/null
+++ b/src/Model/CreateSmsDefinitionContent.js
@@ -0,0 +1,83 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateSmsDefinitionContent model module.
+* @module Model/CreateSmsDefinitionContent
+* @version 1.0.0
+*/
+module.exports = class CreateSmsDefinitionContent{
+ /**
+ * Constructs a new CreateSmsDefinitionContent.
+ * @alias module:Model/CreateSmsDefinitionContent
+ * @class
+ * @param message {String} The message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message.
+ */
+
+ constructor(message) {
+
+ // verify the required parameter 'message' is set
+ if(message === undefined || message === null){
+ throw new InvalidModelException('"message" is a required property for CreateSmsDefinitionContent and cannot be undefined or null');
+ }
+ this['message'] = message;
+
+ }
+
+ /**
+ * Constructs a CreateSmsDefinitionContent from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateSmsDefinitionContent} obj Optional instance to populate.
+ * @return {module:Model/CreateSmsDefinitionContent} The populated CreateSmsDefinitionContent instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateSmsDefinitionContent();
+
+
+
+
+
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message.
+ * @member {String} message
+ */
+ message = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateSmsDefinitionRequest.js b/src/Model/CreateSmsDefinitionRequest.js
new file mode 100644
index 0000000..80bf4a8
--- /dev/null
+++ b/src/Model/CreateSmsDefinitionRequest.js
@@ -0,0 +1,173 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateSmsDefinitionContent = require ('./CreateSmsDefinitionContent');
+const CreateSmsDefinitionSubscriptions = require ('./CreateSmsDefinitionSubscriptions');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateSmsDefinitionRequest model module.
+* @module Model/CreateSmsDefinitionRequest
+* @version 1.0.0
+*/
+module.exports = class CreateSmsDefinitionRequest{
+ /**
+ * Constructs a new CreateSmsDefinitionRequest.
+ * @alias module:Model/CreateSmsDefinitionRequest
+ * @class
+ * @param definitionKey {String} Unique, user-generated key to access the definition object.
+ * @param name {String} Name of the definition. Must be unique.
+ * @param content {module:Model/CreateSmsDefinitionContent}
+ * @param subscriptions {module:Model/CreateSmsDefinitionSubscriptions}
+ */
+
+ constructor(definitionKey, name, content, subscriptions) {
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for CreateSmsDefinitionRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+ // verify the required parameter 'name' is set
+ if(name === undefined || name === null){
+ throw new InvalidModelException('"name" is a required property for CreateSmsDefinitionRequest and cannot be undefined or null');
+ }
+ this['name'] = name;
+
+ // verify the required parameter 'content' is set
+ if(content === undefined || content === null){
+ throw new InvalidModelException('"content" is a required property for CreateSmsDefinitionRequest and cannot be undefined or null');
+ }
+ this['content'] = content;
+
+
+
+
+
+ // verify the required parameter 'subscriptions' is set
+ if(subscriptions === undefined || subscriptions === null){
+ throw new InvalidModelException('"subscriptions" is a required property for CreateSmsDefinitionRequest and cannot be undefined or null');
+ }
+ this['subscriptions'] = subscriptions;
+
+
+ }
+
+ /**
+ * Constructs a CreateSmsDefinitionRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateSmsDefinitionRequest} obj Optional instance to populate.
+ * @return {module:Model/CreateSmsDefinitionRequest} The populated CreateSmsDefinitionRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateSmsDefinitionRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = CreateSmsDefinitionContent.constructFromObject(data['content']);
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('createdDate')) {
+ obj['createdDate'] = ApiClient.convertToType(data['createdDate'], 'Date');
+ }
+ if (data.hasOwnProperty('modifiedDate')) {
+ obj['modifiedDate'] = ApiClient.convertToType(data['modifiedDate'], 'Date');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('subscriptions')) {
+ obj['subscriptions'] = CreateSmsDefinitionSubscriptions.constructFromObject(data['subscriptions']);
+ }
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique, user-generated key to access the definition object.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * Name of the definition. Must be unique.
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * @member {module:Model/CreateSmsDefinitionContent} content
+ */
+ content = undefined;
+ /**
+ * Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
+ * @member {String} status
+ */
+ status = undefined;
+ /**
+ * The date the object was created.
+ * @member {Date} createdDate
+ */
+ createdDate = undefined;
+ /**
+ * The date the object was modified.
+ * @member {Date} modifiedDate
+ */
+ modifiedDate = undefined;
+ /**
+ * User-provided description of the SMS definition.
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * @member {module:Model/CreateSmsDefinitionSubscriptions} subscriptions
+ */
+ subscriptions = undefined;
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/CreateSmsDefinitionSubscriptions.js b/src/Model/CreateSmsDefinitionSubscriptions.js
new file mode 100644
index 0000000..61afbc1
--- /dev/null
+++ b/src/Model/CreateSmsDefinitionSubscriptions.js
@@ -0,0 +1,117 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The CreateSmsDefinitionSubscriptions model module.
+* @module Model/CreateSmsDefinitionSubscriptions
+* @version 1.0.0
+*/
+module.exports = class CreateSmsDefinitionSubscriptions{
+ /**
+ * Constructs a new CreateSmsDefinitionSubscriptions.
+ * @alias module:Model/CreateSmsDefinitionSubscriptions
+ * @class
+ * @param shortCode {String} The short code for the mobile transmissions for each message on this definition.
+ * @param countryCode {String} The country code associated with the shortCode for the mobile transmissions for each message on this definition.
+ */
+
+ constructor(shortCode, countryCode) {
+
+ // verify the required parameter 'shortCode' is set
+ if(shortCode === undefined || shortCode === null){
+ throw new InvalidModelException('"shortCode" is a required property for CreateSmsDefinitionSubscriptions and cannot be undefined or null');
+ }
+ this['shortCode'] = shortCode;
+
+ // verify the required parameter 'countryCode' is set
+ if(countryCode === undefined || countryCode === null){
+ throw new InvalidModelException('"countryCode" is a required property for CreateSmsDefinitionSubscriptions and cannot be undefined or null');
+ }
+ this['countryCode'] = countryCode;
+
+
+
+ }
+
+ /**
+ * Constructs a CreateSmsDefinitionSubscriptions from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/CreateSmsDefinitionSubscriptions} obj Optional instance to populate.
+ * @return {module:Model/CreateSmsDefinitionSubscriptions} The populated CreateSmsDefinitionSubscriptions instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new CreateSmsDefinitionSubscriptions();
+
+
+
+
+
+ if (data.hasOwnProperty('shortCode')) {
+ obj['shortCode'] = ApiClient.convertToType(data['shortCode'], 'String');
+ }
+ if (data.hasOwnProperty('countryCode')) {
+ obj['countryCode'] = ApiClient.convertToType(data['countryCode'], 'String');
+ }
+ if (data.hasOwnProperty('keyword')) {
+ obj['keyword'] = ApiClient.convertToType(data['keyword'], 'String');
+ }
+ if (data.hasOwnProperty('autoAddSubscriber')) {
+ obj['autoAddSubscriber'] = ApiClient.convertToType(data['autoAddSubscriber'], 'Boolean');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The short code for the mobile transmissions for each message on this definition.
+ * @member {String} shortCode
+ */
+ shortCode = undefined;
+ /**
+ * The country code associated with the shortCode for the mobile transmissions for each message on this definition.
+ * @member {String} countryCode
+ */
+ countryCode = undefined;
+ /**
+ * The keyword used to track messages.
+ * @member {String} keyword
+ */
+ keyword = undefined;
+ /**
+ * Permits adding a recipient as subscriber against the shortCode using contactKey. When false, the message is rejected if contactKey does not exist as a subscriber. Default is true.
+ * @member {Boolean} autoAddSubscriber
+ * @default true
+ */
+ autoAddSubscriber = true;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/DeleteQueuedMessagesForSendDefinitionResponse.js b/src/Model/DeleteQueuedMessagesForSendDefinitionResponse.js
new file mode 100644
index 0000000..e6f7a75
--- /dev/null
+++ b/src/Model/DeleteQueuedMessagesForSendDefinitionResponse.js
@@ -0,0 +1,77 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The DeleteQueuedMessagesForSendDefinitionResponse model module.
+* @module Model/DeleteQueuedMessagesForSendDefinitionResponse
+* @version 1.0.0
+*/
+module.exports = class DeleteQueuedMessagesForSendDefinitionResponse{
+ /**
+ * Constructs a new DeleteQueuedMessagesForSendDefinitionResponse.
+ * @alias module:Model/DeleteQueuedMessagesForSendDefinitionResponse
+ * @class
+ */
+
+ constructor() {
+
+
+ }
+
+ /**
+ * Constructs a DeleteQueuedMessagesForSendDefinitionResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/DeleteQueuedMessagesForSendDefinitionResponse} obj Optional instance to populate.
+ * @return {module:Model/DeleteQueuedMessagesForSendDefinitionResponse} The populated DeleteQueuedMessagesForSendDefinitionResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new DeleteQueuedMessagesForSendDefinitionResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/DeleteSendDefinitionResponse.js b/src/Model/DeleteSendDefinitionResponse.js
new file mode 100644
index 0000000..c25f37d
--- /dev/null
+++ b/src/Model/DeleteSendDefinitionResponse.js
@@ -0,0 +1,95 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The DeleteSendDefinitionResponse model module.
+* @module Model/DeleteSendDefinitionResponse
+* @version 1.0.0
+*/
+module.exports = class DeleteSendDefinitionResponse{
+ /**
+ * Constructs a new DeleteSendDefinitionResponse.
+ * @alias module:Model/DeleteSendDefinitionResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a DeleteSendDefinitionResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/DeleteSendDefinitionResponse} obj Optional instance to populate.
+ * @return {module:Model/DeleteSendDefinitionResponse} The populated DeleteSendDefinitionResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new DeleteSendDefinitionResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('deletedDefinitionKey')) {
+ obj['deletedDefinitionKey'] = ApiClient.convertToType(data['deletedDefinitionKey'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The response message
+ * @member {String} message
+ */
+ message = undefined;
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * The key of the deleted definition
+ * @member {String} deletedDefinitionKey
+ */
+ deletedDefinitionKey = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetDefinitionSendStatusForRecipientResponse.js b/src/Model/GetDefinitionSendStatusForRecipientResponse.js
new file mode 100644
index 0000000..b3f3ab8
--- /dev/null
+++ b/src/Model/GetDefinitionSendStatusForRecipientResponse.js
@@ -0,0 +1,113 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const GetDefinitionSendStatusForRecipientResponseInfo = require ('./GetDefinitionSendStatusForRecipientResponseInfo');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetDefinitionSendStatusForRecipientResponse model module.
+* @module Model/GetDefinitionSendStatusForRecipientResponse
+* @version 1.0.0
+*/
+module.exports = class GetDefinitionSendStatusForRecipientResponse{
+ /**
+ * Constructs a new GetDefinitionSendStatusForRecipientResponse.
+ * @alias module:Model/GetDefinitionSendStatusForRecipientResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetDefinitionSendStatusForRecipientResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetDefinitionSendStatusForRecipientResponse} obj Optional instance to populate.
+ * @return {module:Model/GetDefinitionSendStatusForRecipientResponse} The populated GetDefinitionSendStatusForRecipientResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetDefinitionSendStatusForRecipientResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('eventCategoryType')) {
+ obj['eventCategoryType'] = ApiClient.convertToType(data['eventCategoryType'], 'String');
+ }
+ if (data.hasOwnProperty('timestamp')) {
+ obj['timestamp'] = ApiClient.convertToType(data['timestamp'], 'Date');
+ }
+ if (data.hasOwnProperty('compositeId')) {
+ obj['compositeId'] = ApiClient.convertToType(data['compositeId'], 'String');
+ }
+ if (data.hasOwnProperty('info')) {
+ obj['info'] = GetDefinitionSendStatusForRecipientResponseInfo.constructFromObject(data['info']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * The status of the message
+ * @member {String} eventCategoryType
+ */
+ eventCategoryType = undefined;
+ /**
+ * The date the ...
+ * @member {Date} timestamp
+ */
+ timestamp = undefined;
+ /**
+ * The Id of ...
+ * @member {String} compositeId
+ */
+ compositeId = undefined;
+ /**
+ * @member {module:Model/GetDefinitionSendStatusForRecipientResponseInfo} info
+ */
+ info = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetDefinitionSendStatusForRecipientResponseInfo.js b/src/Model/GetDefinitionSendStatusForRecipientResponseInfo.js
new file mode 100644
index 0000000..f9e5c12
--- /dev/null
+++ b/src/Model/GetDefinitionSendStatusForRecipientResponseInfo.js
@@ -0,0 +1,113 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetDefinitionSendStatusForRecipientResponseInfo model module.
+* @module Model/GetDefinitionSendStatusForRecipientResponseInfo
+* @version 1.0.0
+*/
+module.exports = class GetDefinitionSendStatusForRecipientResponseInfo{
+ /**
+ * Constructs a new GetDefinitionSendStatusForRecipientResponseInfo.
+ * @alias module:Model/GetDefinitionSendStatusForRecipientResponseInfo
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetDefinitionSendStatusForRecipientResponseInfo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetDefinitionSendStatusForRecipientResponseInfo} obj Optional instance to populate.
+ * @return {module:Model/GetDefinitionSendStatusForRecipientResponseInfo} The populated GetDefinitionSendStatusForRecipientResponseInfo instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetDefinitionSendStatusForRecipientResponseInfo();
+
+
+
+
+
+ if (data.hasOwnProperty('messageKey')) {
+ obj['messageKey'] = ApiClient.convertToType(data['messageKey'], 'String');
+ }
+ if (data.hasOwnProperty('contactKey')) {
+ obj['contactKey'] = ApiClient.convertToType(data['contactKey'], 'String');
+ }
+ if (data.hasOwnProperty('to')) {
+ obj['to'] = ApiClient.convertToType(data['to'], 'String');
+ }
+ if (data.hasOwnProperty('statusCode')) {
+ obj['statusCode'] = ApiClient.convertToType(data['statusCode'], 'Number');
+ }
+ if (data.hasOwnProperty('statusMessage')) {
+ obj['statusMessage'] = ApiClient.convertToType(data['statusMessage'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier used to track message status.
+ * @member {String} messageKey
+ */
+ messageKey = undefined;
+ /**
+ * Unique identifier for a subscriber in Marketing Cloud. Each request must include a contactKey. You can use an existing subscriber key or create one at send time by using the recipient’s email address.
+ * @member {String} contactKey
+ */
+ contactKey = undefined;
+ /**
+ * Channel address of the recipient. For email, it’s the recipient's email address.
+ * @member {String} to
+ */
+ to = undefined;
+ /**
+ * The specific status code
+ * @member {Number} statusCode
+ */
+ statusCode = undefined;
+ /**
+ * The specific status message
+ * @member {String} statusMessage
+ */
+ statusMessage = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetDefinitionsNotSentToRecipientsMessage.js b/src/Model/GetDefinitionsNotSentToRecipientsMessage.js
new file mode 100644
index 0000000..4bab465
--- /dev/null
+++ b/src/Model/GetDefinitionsNotSentToRecipientsMessage.js
@@ -0,0 +1,131 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const GetDefinitionsNotSentToRecipientsMessageInfo = require ('./GetDefinitionsNotSentToRecipientsMessageInfo');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetDefinitionsNotSentToRecipientsMessage model module.
+* @module Model/GetDefinitionsNotSentToRecipientsMessage
+* @version 1.0.0
+*/
+module.exports = class GetDefinitionsNotSentToRecipientsMessage{
+ /**
+ * Constructs a new GetDefinitionsNotSentToRecipientsMessage.
+ * @alias module:Model/GetDefinitionsNotSentToRecipientsMessage
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetDefinitionsNotSentToRecipientsMessage from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetDefinitionsNotSentToRecipientsMessage} obj Optional instance to populate.
+ * @return {module:Model/GetDefinitionsNotSentToRecipientsMessage} The populated GetDefinitionsNotSentToRecipientsMessage instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetDefinitionsNotSentToRecipientsMessage();
+
+
+
+
+
+ if (data.hasOwnProperty('statusCode')) {
+ obj['statusCode'] = ApiClient.convertToType(data['statusCode'], 'Number');
+ }
+ if (data.hasOwnProperty('statusMessage')) {
+ obj['statusMessage'] = ApiClient.convertToType(data['statusMessage'], 'String');
+ }
+ if (data.hasOwnProperty('eventCategoryType')) {
+ obj['eventCategoryType'] = ApiClient.convertToType(data['eventCategoryType'], 'String');
+ }
+ if (data.hasOwnProperty('timestamp')) {
+ obj['timestamp'] = ApiClient.convertToType(data['timestamp'], 'Date');
+ }
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('eventID')) {
+ obj['eventID'] = ApiClient.convertToType(data['eventID'], 'Number');
+ }
+ if (data.hasOwnProperty('info')) {
+ obj['info'] = GetDefinitionsNotSentToRecipientsMessageInfo.constructFromObject(data['info']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The specific status code
+ * @member {Number} statusCode
+ */
+ statusCode = undefined;
+ /**
+ * The specific status message
+ * @member {String} statusMessage
+ */
+ statusMessage = undefined;
+ /**
+ * The status of the message
+ * @member {String} eventCategoryType
+ */
+ eventCategoryType = undefined;
+ /**
+ * The date the ...
+ * @member {Date} timestamp
+ */
+ timestamp = undefined;
+ /**
+ * Unique, user-generated key to access the definition object.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ *
+ * @member {Number} eventID
+ */
+ eventID = undefined;
+ /**
+ * @member {module:Model/GetDefinitionsNotSentToRecipientsMessageInfo} info
+ */
+ info = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetDefinitionsNotSentToRecipientsMessageInfo.js b/src/Model/GetDefinitionsNotSentToRecipientsMessageInfo.js
new file mode 100644
index 0000000..e3400be
--- /dev/null
+++ b/src/Model/GetDefinitionsNotSentToRecipientsMessageInfo.js
@@ -0,0 +1,95 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetDefinitionsNotSentToRecipientsMessageInfo model module.
+* @module Model/GetDefinitionsNotSentToRecipientsMessageInfo
+* @version 1.0.0
+*/
+module.exports = class GetDefinitionsNotSentToRecipientsMessageInfo{
+ /**
+ * Constructs a new GetDefinitionsNotSentToRecipientsMessageInfo.
+ * @alias module:Model/GetDefinitionsNotSentToRecipientsMessageInfo
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetDefinitionsNotSentToRecipientsMessageInfo from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetDefinitionsNotSentToRecipientsMessageInfo} obj Optional instance to populate.
+ * @return {module:Model/GetDefinitionsNotSentToRecipientsMessageInfo} The populated GetDefinitionsNotSentToRecipientsMessageInfo instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetDefinitionsNotSentToRecipientsMessageInfo();
+
+
+
+
+
+ if (data.hasOwnProperty('messageKey')) {
+ obj['messageKey'] = ApiClient.convertToType(data['messageKey'], 'String');
+ }
+ if (data.hasOwnProperty('contactKey')) {
+ obj['contactKey'] = ApiClient.convertToType(data['contactKey'], 'String');
+ }
+ if (data.hasOwnProperty('to')) {
+ obj['to'] = ApiClient.convertToType(data['to'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier used to track message status.
+ * @member {String} messageKey
+ */
+ messageKey = undefined;
+ /**
+ * Unique identifier for a subscriber in Marketing Cloud. Each request must include a contactKey. You can use an existing subscriber key or create one at send time by using the recipient’s email address.
+ * @member {String} contactKey
+ */
+ contactKey = undefined;
+ /**
+ * Channel address of the recipient. For email, it’s the recipient's email address.
+ * @member {String} to
+ */
+ to = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetDefinitionsNotSentToRecipientsResponse.js b/src/Model/GetDefinitionsNotSentToRecipientsResponse.js
new file mode 100644
index 0000000..a40f25b
--- /dev/null
+++ b/src/Model/GetDefinitionsNotSentToRecipientsResponse.js
@@ -0,0 +1,114 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const GetDefinitionsNotSentToRecipientsMessage = require ('./GetDefinitionsNotSentToRecipientsMessage');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetDefinitionsNotSentToRecipientsResponse model module.
+* @module Model/GetDefinitionsNotSentToRecipientsResponse
+* @version 1.0.0
+*/
+module.exports = class GetDefinitionsNotSentToRecipientsResponse{
+ /**
+ * Constructs a new GetDefinitionsNotSentToRecipientsResponse.
+ * @alias module:Model/GetDefinitionsNotSentToRecipientsResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetDefinitionsNotSentToRecipientsResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetDefinitionsNotSentToRecipientsResponse} obj Optional instance to populate.
+ * @return {module:Model/GetDefinitionsNotSentToRecipientsResponse} The populated GetDefinitionsNotSentToRecipientsResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetDefinitionsNotSentToRecipientsResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('lastEventID')) {
+ obj['lastEventID'] = ApiClient.convertToType(data['lastEventID'], 'Number');
+ }
+ if (data.hasOwnProperty('messages')) {
+ obj['messages'] = ApiClient.convertToType(data['messages'], [GetDefinitionsNotSentToRecipientsMessage]);
+ }
+ if (data.hasOwnProperty('count')) {
+ obj['count'] = ApiClient.convertToType(data['count'], 'Number');
+ }
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('pageSize')) {
+ obj['pageSize'] = ApiClient.convertToType(data['pageSize'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Event ID from which you want the response to start. To obtain the initial event ID, submit a request without a lastEventId. The events in the response are listed top to bottom from oldest to newest
+ * @member {Number} lastEventID
+ */
+ lastEventID = undefined;
+ /**
+ *
+ * @member {Array.} messages
+ */
+ messages = undefined;
+ /**
+ * Number of pages
+ * @member {Number} count
+ */
+ count = undefined;
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * Number of definitions, which are array elements, to return per paged response.
+ * @member {Number} pageSize
+ */
+ pageSize = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetEmailDefinitionsResponse.js b/src/Model/GetEmailDefinitionsResponse.js
new file mode 100644
index 0000000..25f5f68
--- /dev/null
+++ b/src/Model/GetEmailDefinitionsResponse.js
@@ -0,0 +1,113 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateEmailDefinitionRequest = require ('./CreateEmailDefinitionRequest');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetEmailDefinitionsResponse model module.
+* @module Model/GetEmailDefinitionsResponse
+* @version 1.0.0
+*/
+module.exports = class GetEmailDefinitionsResponse{
+ /**
+ * Constructs a new GetEmailDefinitionsResponse.
+ * @alias module:Model/GetEmailDefinitionsResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetEmailDefinitionsResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetEmailDefinitionsResponse} obj Optional instance to populate.
+ * @return {module:Model/GetEmailDefinitionsResponse} The populated GetEmailDefinitionsResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetEmailDefinitionsResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('definitions')) {
+ obj['definitions'] = ApiClient.convertToType(data['definitions'], [CreateEmailDefinitionRequest]);
+ }
+ if (data.hasOwnProperty('count')) {
+ obj['count'] = ApiClient.convertToType(data['count'], 'Number');
+ }
+ if (data.hasOwnProperty('page')) {
+ obj['page'] = ApiClient.convertToType(data['page'], 'Number');
+ }
+ if (data.hasOwnProperty('pageSize')) {
+ obj['pageSize'] = ApiClient.convertToType(data['pageSize'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * @member {Array.} definitions
+ */
+ definitions = undefined;
+ /**
+ * Number of pages
+ * @member {Number} count
+ */
+ count = undefined;
+ /**
+ * Page number to return.
+ * @member {Number} page
+ */
+ page = undefined;
+ /**
+ * Number of definitions, which are array elements, to return per paged response.
+ * @member {Number} pageSize
+ */
+ pageSize = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetQueueMetricsForSendDefinitionResponse.js b/src/Model/GetQueueMetricsForSendDefinitionResponse.js
new file mode 100644
index 0000000..7dc53c7
--- /dev/null
+++ b/src/Model/GetQueueMetricsForSendDefinitionResponse.js
@@ -0,0 +1,95 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetQueueMetricsForSendDefinitionResponse model module.
+* @module Model/GetQueueMetricsForSendDefinitionResponse
+* @version 1.0.0
+*/
+module.exports = class GetQueueMetricsForSendDefinitionResponse{
+ /**
+ * Constructs a new GetQueueMetricsForSendDefinitionResponse.
+ * @alias module:Model/GetQueueMetricsForSendDefinitionResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetQueueMetricsForSendDefinitionResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetQueueMetricsForSendDefinitionResponse} obj Optional instance to populate.
+ * @return {module:Model/GetQueueMetricsForSendDefinitionResponse} The populated GetQueueMetricsForSendDefinitionResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetQueueMetricsForSendDefinitionResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('count')) {
+ obj['count'] = ApiClient.convertToType(data['count'], 'Number');
+ }
+ if (data.hasOwnProperty('ageSeconds')) {
+ obj['ageSeconds'] = ApiClient.convertToType(data['ageSeconds'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * Number of pages
+ * @member {Number} count
+ */
+ count = undefined;
+ /**
+ * Number of seconds
+ * @member {Number} ageSeconds
+ */
+ ageSeconds = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/GetSmsDefinitionsResponse.js b/src/Model/GetSmsDefinitionsResponse.js
new file mode 100644
index 0000000..fc9a36f
--- /dev/null
+++ b/src/Model/GetSmsDefinitionsResponse.js
@@ -0,0 +1,113 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateSmsDefinitionRequest = require ('./CreateSmsDefinitionRequest');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The GetSmsDefinitionsResponse model module.
+* @module Model/GetSmsDefinitionsResponse
+* @version 1.0.0
+*/
+module.exports = class GetSmsDefinitionsResponse{
+ /**
+ * Constructs a new GetSmsDefinitionsResponse.
+ * @alias module:Model/GetSmsDefinitionsResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a GetSmsDefinitionsResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/GetSmsDefinitionsResponse} obj Optional instance to populate.
+ * @return {module:Model/GetSmsDefinitionsResponse} The populated GetSmsDefinitionsResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new GetSmsDefinitionsResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('definitions')) {
+ obj['definitions'] = ApiClient.convertToType(data['definitions'], [CreateSmsDefinitionRequest]);
+ }
+ if (data.hasOwnProperty('count')) {
+ obj['count'] = ApiClient.convertToType(data['count'], 'Number');
+ }
+ if (data.hasOwnProperty('page')) {
+ obj['page'] = ApiClient.convertToType(data['page'], 'Number');
+ }
+ if (data.hasOwnProperty('pageSize')) {
+ obj['pageSize'] = ApiClient.convertToType(data['pageSize'], 'Number');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * @member {Array.} definitions
+ */
+ definitions = undefined;
+ /**
+ * Number of pages
+ * @member {Number} count
+ */
+ count = undefined;
+ /**
+ * Page number to return.
+ * @member {Number} page
+ */
+ page = undefined;
+ /**
+ * Number of definitions, which are array elements, to return per paged response.
+ * @member {Number} pageSize
+ */
+ pageSize = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/Recipient.js b/src/Model/Recipient.js
new file mode 100644
index 0000000..2837957
--- /dev/null
+++ b/src/Model/Recipient.js
@@ -0,0 +1,110 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const Attributes = require ('./Attributes');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The Recipient model module.
+* @module Model/Recipient
+* @version 1.0.0
+*/
+module.exports = class Recipient{
+ /**
+ * Constructs a new Recipient.
+ * @alias module:Model/Recipient
+ * @class
+ * @param contactKey {String} Unique identifier for a subscriber in Marketing Cloud. Each request must include a contactKey. You can use an existing subscriber key or create one at send time by using the recipient’s email address.
+ */
+
+ constructor(contactKey) {
+
+ // verify the required parameter 'contactKey' is set
+ if(contactKey === undefined || contactKey === null){
+ throw new InvalidModelException('"contactKey" is a required property for Recipient and cannot be undefined or null');
+ }
+ this['contactKey'] = contactKey;
+
+
+
+
+ }
+
+ /**
+ * Constructs a Recipient from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/Recipient} obj Optional instance to populate.
+ * @return {module:Model/Recipient} The populated Recipient instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new Recipient();
+
+
+
+
+
+ if (data.hasOwnProperty('contactKey')) {
+ obj['contactKey'] = ApiClient.convertToType(data['contactKey'], 'String');
+ }
+ if (data.hasOwnProperty('to')) {
+ obj['to'] = ApiClient.convertToType(data['to'], 'String');
+ }
+ if (data.hasOwnProperty('messageKey')) {
+ obj['messageKey'] = ApiClient.convertToType(data['messageKey'], 'String');
+ }
+ if (data.hasOwnProperty('attributes')) {
+ obj['attributes'] = Attributes.constructFromObject(data['attributes']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier for a subscriber in Marketing Cloud. Each request must include a contactKey. You can use an existing subscriber key or create one at send time by using the recipient’s email address.
+ * @member {String} contactKey
+ */
+ contactKey = undefined;
+ /**
+ * Channel address of the recipient. For email, it’s the recipient's email address. For SMS, it’s the recipient's E.164-based mobile number.
+ * @member {String} to
+ */
+ to = undefined;
+ /**
+ * Unique identifier used to track message status. Can be automatically created when you create a message or provided as part of the request. Each recipient in a request must have a unique messageKey. If you use a duplicate messageKey in the same send request, the message is rejected.
+ * @member {String} messageKey
+ */
+ messageKey = undefined;
+ /**
+ * @member {module:Model/Attributes} attributes
+ */
+ attributes = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendDefinitionResponseItem.js b/src/Model/SendDefinitionResponseItem.js
new file mode 100644
index 0000000..ff43d09
--- /dev/null
+++ b/src/Model/SendDefinitionResponseItem.js
@@ -0,0 +1,95 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendDefinitionResponseItem model module.
+* @module Model/SendDefinitionResponseItem
+* @version 1.0.0
+*/
+module.exports = class SendDefinitionResponseItem{
+ /**
+ * Constructs a new SendDefinitionResponseItem.
+ * @alias module:Model/SendDefinitionResponseItem
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a SendDefinitionResponseItem from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendDefinitionResponseItem} obj Optional instance to populate.
+ * @return {module:Model/SendDefinitionResponseItem} The populated SendDefinitionResponseItem instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendDefinitionResponseItem();
+
+
+
+
+
+ if (data.hasOwnProperty('messageKey')) {
+ obj['messageKey'] = ApiClient.convertToType(data['messageKey'], 'String');
+ }
+ if (data.hasOwnProperty('errorCode')) {
+ obj['errorCode'] = ApiClient.convertToType(data['errorCode'], 'Number');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier used to track message status.
+ * @member {String} messageKey
+ */
+ messageKey = undefined;
+ /**
+ * The specific error code
+ * @member {Number} errorCode
+ */
+ errorCode = undefined;
+ /**
+ * The error message
+ * @member {String} message
+ */
+ message = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendDefinitionToMultipleRecipientsResponse.js b/src/Model/SendDefinitionToMultipleRecipientsResponse.js
new file mode 100644
index 0000000..f5dc6b2
--- /dev/null
+++ b/src/Model/SendDefinitionToMultipleRecipientsResponse.js
@@ -0,0 +1,105 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const SendDefinitionResponseItem = require ('./SendDefinitionResponseItem');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendDefinitionToMultipleRecipientsResponse model module.
+* @module Model/SendDefinitionToMultipleRecipientsResponse
+* @version 1.0.0
+*/
+module.exports = class SendDefinitionToMultipleRecipientsResponse{
+ /**
+ * Constructs a new SendDefinitionToMultipleRecipientsResponse.
+ * @alias module:Model/SendDefinitionToMultipleRecipientsResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a SendDefinitionToMultipleRecipientsResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendDefinitionToMultipleRecipientsResponse} obj Optional instance to populate.
+ * @return {module:Model/SendDefinitionToMultipleRecipientsResponse} The populated SendDefinitionToMultipleRecipientsResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendDefinitionToMultipleRecipientsResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('errorcode')) {
+ obj['errorcode'] = ApiClient.convertToType(data['errorcode'], 'Number');
+ }
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ if (data.hasOwnProperty('responses')) {
+ obj['responses'] = ApiClient.convertToType(data['responses'], [SendDefinitionResponseItem]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * The specific error code
+ * @member {Number} errorcode
+ */
+ errorcode = undefined;
+ /**
+ *
+ * @member {String} message
+ */
+ message = undefined;
+ /**
+ *
+ * @member {Array.} responses
+ */
+ responses = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendDefinitionToSingleRecipientResponse.js b/src/Model/SendDefinitionToSingleRecipientResponse.js
new file mode 100644
index 0000000..5be70cd
--- /dev/null
+++ b/src/Model/SendDefinitionToSingleRecipientResponse.js
@@ -0,0 +1,96 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const SendDefinitionResponseItem = require ('./SendDefinitionResponseItem');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendDefinitionToSingleRecipientResponse model module.
+* @module Model/SendDefinitionToSingleRecipientResponse
+* @version 1.0.0
+*/
+module.exports = class SendDefinitionToSingleRecipientResponse{
+ /**
+ * Constructs a new SendDefinitionToSingleRecipientResponse.
+ * @alias module:Model/SendDefinitionToSingleRecipientResponse
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+ }
+
+ /**
+ * Constructs a SendDefinitionToSingleRecipientResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendDefinitionToSingleRecipientResponse} obj Optional instance to populate.
+ * @return {module:Model/SendDefinitionToSingleRecipientResponse} The populated SendDefinitionToSingleRecipientResponse instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendDefinitionToSingleRecipientResponse();
+
+
+
+
+
+ if (data.hasOwnProperty('requestId')) {
+ obj['requestId'] = ApiClient.convertToType(data['requestId'], 'String');
+ }
+ if (data.hasOwnProperty('errorcode')) {
+ obj['errorcode'] = ApiClient.convertToType(data['errorcode'], 'Number');
+ }
+ if (data.hasOwnProperty('responses')) {
+ obj['responses'] = ApiClient.convertToType(data['responses'], [SendDefinitionResponseItem]);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * The ID of the request
+ * @member {String} requestId
+ */
+ requestId = undefined;
+ /**
+ * The specific error code
+ * @member {Number} errorcode
+ */
+ errorcode = undefined;
+ /**
+ *
+ * @member {Array.} responses
+ */
+ responses = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendEmailToMultipleRecipientsRequest.js b/src/Model/SendEmailToMultipleRecipientsRequest.js
new file mode 100644
index 0000000..d5be957
--- /dev/null
+++ b/src/Model/SendEmailToMultipleRecipientsRequest.js
@@ -0,0 +1,108 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const Attributes = require ('./Attributes');
+const Recipient = require ('./Recipient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendEmailToMultipleRecipientsRequest model module.
+* @module Model/SendEmailToMultipleRecipientsRequest
+* @version 1.0.0
+*/
+module.exports = class SendEmailToMultipleRecipientsRequest{
+ /**
+ * Constructs a new SendEmailToMultipleRecipientsRequest.
+ * @alias module:Model/SendEmailToMultipleRecipientsRequest
+ * @class
+ * @param definitionKey {String} Unique, user-generated key to access the definition object.
+ * @param recipients {Array.} Array of recipient objects that contain parameters and metadata for the recipients, such as send tracking and personalization attributes. Use this parameter to send to multiple recipients in one request. Use either the recipient or recipients parameter, but not both.
+ */
+
+ constructor(definitionKey, recipients) {
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for SendEmailToMultipleRecipientsRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+ // verify the required parameter 'recipients' is set
+ if(recipients === undefined || recipients === null){
+ throw new InvalidModelException('"recipients" is a required property for SendEmailToMultipleRecipientsRequest and cannot be undefined or null');
+ }
+ this['recipients'] = recipients;
+
+
+ }
+
+ /**
+ * Constructs a SendEmailToMultipleRecipientsRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendEmailToMultipleRecipientsRequest} obj Optional instance to populate.
+ * @return {module:Model/SendEmailToMultipleRecipientsRequest} The populated SendEmailToMultipleRecipientsRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendEmailToMultipleRecipientsRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('recipients')) {
+ obj['recipients'] = ApiClient.convertToType(data['recipients'], [Recipient]);
+ }
+ if (data.hasOwnProperty('attributes')) {
+ obj['attributes'] = Attributes.constructFromObject(data['attributes']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique, user-generated key to access the definition object.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * Array of recipient objects that contain parameters and metadata for the recipients, such as send tracking and personalization attributes. Use this parameter to send to multiple recipients in one request. Use either the recipient or recipients parameter, but not both.
+ * @member {Array.} recipients
+ */
+ recipients = undefined;
+ /**
+ * @member {module:Model/Attributes} attributes
+ */
+ attributes = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendEmailToSingleRecipientRequest.js b/src/Model/SendEmailToSingleRecipientRequest.js
new file mode 100644
index 0000000..a44c636
--- /dev/null
+++ b/src/Model/SendEmailToSingleRecipientRequest.js
@@ -0,0 +1,98 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const Recipient = require ('./Recipient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendEmailToSingleRecipientRequest model module.
+* @module Model/SendEmailToSingleRecipientRequest
+* @version 1.0.0
+*/
+module.exports = class SendEmailToSingleRecipientRequest{
+ /**
+ * Constructs a new SendEmailToSingleRecipientRequest.
+ * @alias module:Model/SendEmailToSingleRecipientRequest
+ * @class
+ * @param definitionKey {String} Unique identifier of the definition.
+ * @param recipient {module:Model/Recipient}
+ */
+
+ constructor(definitionKey, recipient) {
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for SendEmailToSingleRecipientRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+ // verify the required parameter 'recipient' is set
+ if(recipient === undefined || recipient === null){
+ throw new InvalidModelException('"recipient" is a required property for SendEmailToSingleRecipientRequest and cannot be undefined or null');
+ }
+ this['recipient'] = recipient;
+
+ }
+
+ /**
+ * Constructs a SendEmailToSingleRecipientRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendEmailToSingleRecipientRequest} obj Optional instance to populate.
+ * @return {module:Model/SendEmailToSingleRecipientRequest} The populated SendEmailToSingleRecipientRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendEmailToSingleRecipientRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('recipient')) {
+ obj['recipient'] = Recipient.constructFromObject(data['recipient']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier of the definition.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * @member {module:Model/Recipient} recipient
+ */
+ recipient = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendSmsContentRequest.js b/src/Model/SendSmsContentRequest.js
new file mode 100644
index 0000000..34c70be
--- /dev/null
+++ b/src/Model/SendSmsContentRequest.js
@@ -0,0 +1,77 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendSmsContentRequest model module.
+* @module Model/SendSmsContentRequest
+* @version 1.0.0
+*/
+module.exports = class SendSmsContentRequest{
+ /**
+ * Constructs a new SendSmsContentRequest.
+ * @alias module:Model/SendSmsContentRequest
+ * @class
+ */
+
+ constructor() {
+
+
+ }
+
+ /**
+ * Constructs a SendSmsContentRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendSmsContentRequest} obj Optional instance to populate.
+ * @return {module:Model/SendSmsContentRequest} The populated SendSmsContentRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendSmsContentRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('message')) {
+ obj['message'] = ApiClient.convertToType(data['message'], 'String');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Override for message content in the definition that you want sent with each message. Use substitution strings to personalize the content.
+ * @member {String} message
+ */
+ message = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendSmsToMultipleRecipientsRequest.js b/src/Model/SendSmsToMultipleRecipientsRequest.js
new file mode 100644
index 0000000..76e5611
--- /dev/null
+++ b/src/Model/SendSmsToMultipleRecipientsRequest.js
@@ -0,0 +1,126 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const Attributes = require ('./Attributes');
+const Recipient = require ('./Recipient');
+const SendSmsContentRequest = require ('./SendSmsContentRequest');
+const SendSmsToMultipleRecipientsSubscriptionsRequest = require ('./SendSmsToMultipleRecipientsSubscriptionsRequest');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendSmsToMultipleRecipientsRequest model module.
+* @module Model/SendSmsToMultipleRecipientsRequest
+* @version 1.0.0
+*/
+module.exports = class SendSmsToMultipleRecipientsRequest{
+ /**
+ * Constructs a new SendSmsToMultipleRecipientsRequest.
+ * @alias module:Model/SendSmsToMultipleRecipientsRequest
+ * @class
+ * @param definitionKey {String} Unique, user-generated key to access the definition object.
+ * @param recipients {Array.} Array of recipient objects that contain parameters and metadata for the recipients, such as send tracking and personalization attributes. Use this parameter to send to multiple recipients in one request. Use either the recipient or recipients parameter, but not both.
+ */
+
+ constructor(definitionKey, recipients) {
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for SendSmsToMultipleRecipientsRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+ // verify the required parameter 'recipients' is set
+ if(recipients === undefined || recipients === null){
+ throw new InvalidModelException('"recipients" is a required property for SendSmsToMultipleRecipientsRequest and cannot be undefined or null');
+ }
+ this['recipients'] = recipients;
+
+
+
+
+ }
+
+ /**
+ * Constructs a SendSmsToMultipleRecipientsRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendSmsToMultipleRecipientsRequest} obj Optional instance to populate.
+ * @return {module:Model/SendSmsToMultipleRecipientsRequest} The populated SendSmsToMultipleRecipientsRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendSmsToMultipleRecipientsRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('recipients')) {
+ obj['recipients'] = ApiClient.convertToType(data['recipients'], [Recipient]);
+ }
+ if (data.hasOwnProperty('subscriptions')) {
+ obj['subscriptions'] = SendSmsToMultipleRecipientsSubscriptionsRequest.constructFromObject(data['subscriptions']);
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = SendSmsContentRequest.constructFromObject(data['content']);
+ }
+ if (data.hasOwnProperty('attributes')) {
+ obj['attributes'] = Attributes.constructFromObject(data['attributes']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique, user-generated key to access the definition object.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * Array of recipient objects that contain parameters and metadata for the recipients, such as send tracking and personalization attributes. Use this parameter to send to multiple recipients in one request. Use either the recipient or recipients parameter, but not both.
+ * @member {Array.} recipients
+ */
+ recipients = undefined;
+ /**
+ * @member {module:Model/SendSmsToMultipleRecipientsSubscriptionsRequest} subscriptions
+ */
+ subscriptions = undefined;
+ /**
+ * @member {module:Model/SendSmsContentRequest} content
+ */
+ content = undefined;
+ /**
+ * @member {module:Model/Attributes} attributes
+ */
+ attributes = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendSmsToMultipleRecipientsSubscriptionsRequest.js b/src/Model/SendSmsToMultipleRecipientsSubscriptionsRequest.js
new file mode 100644
index 0000000..428b786
--- /dev/null
+++ b/src/Model/SendSmsToMultipleRecipientsSubscriptionsRequest.js
@@ -0,0 +1,77 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendSmsToMultipleRecipientsSubscriptionsRequest model module.
+* @module Model/SendSmsToMultipleRecipientsSubscriptionsRequest
+* @version 1.0.0
+*/
+module.exports = class SendSmsToMultipleRecipientsSubscriptionsRequest{
+ /**
+ * Constructs a new SendSmsToMultipleRecipientsSubscriptionsRequest.
+ * @alias module:Model/SendSmsToMultipleRecipientsSubscriptionsRequest
+ * @class
+ */
+
+ constructor() {
+
+
+ }
+
+ /**
+ * Constructs a SendSmsToMultipleRecipientsSubscriptionsRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendSmsToMultipleRecipientsSubscriptionsRequest} obj Optional instance to populate.
+ * @return {module:Model/SendSmsToMultipleRecipientsSubscriptionsRequest} The populated SendSmsToMultipleRecipientsSubscriptionsRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendSmsToMultipleRecipientsSubscriptionsRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('resubscribe')) {
+ obj['resubscribe'] = ApiClient.convertToType(data['resubscribe'], 'Boolean');
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Forces the message send request to subscribe the mobile number back into a short code if a user may have requested STOP. Often used to ensure that critical transactional messages are delivered irrespective of a mobile number subscriber status.
+ * @member {Boolean} resubscribe
+ */
+ resubscribe = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SendSmsToSingleRecipientRequest.js b/src/Model/SendSmsToSingleRecipientRequest.js
new file mode 100644
index 0000000..3c9360e
--- /dev/null
+++ b/src/Model/SendSmsToSingleRecipientRequest.js
@@ -0,0 +1,107 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const Recipient = require ('./Recipient');
+const SendSmsContentRequest = require ('./SendSmsContentRequest');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SendSmsToSingleRecipientRequest model module.
+* @module Model/SendSmsToSingleRecipientRequest
+* @version 1.0.0
+*/
+module.exports = class SendSmsToSingleRecipientRequest{
+ /**
+ * Constructs a new SendSmsToSingleRecipientRequest.
+ * @alias module:Model/SendSmsToSingleRecipientRequest
+ * @class
+ * @param definitionKey {String} Unique identifier of the definition.
+ * @param recipient {module:Model/Recipient}
+ */
+
+ constructor(definitionKey, recipient) {
+
+ // verify the required parameter 'definitionKey' is set
+ if(definitionKey === undefined || definitionKey === null){
+ throw new InvalidModelException('"definitionKey" is a required property for SendSmsToSingleRecipientRequest and cannot be undefined or null');
+ }
+ this['definitionKey'] = definitionKey;
+
+ // verify the required parameter 'recipient' is set
+ if(recipient === undefined || recipient === null){
+ throw new InvalidModelException('"recipient" is a required property for SendSmsToSingleRecipientRequest and cannot be undefined or null');
+ }
+ this['recipient'] = recipient;
+
+
+ }
+
+ /**
+ * Constructs a SendSmsToSingleRecipientRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SendSmsToSingleRecipientRequest} obj Optional instance to populate.
+ * @return {module:Model/SendSmsToSingleRecipientRequest} The populated SendSmsToSingleRecipientRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SendSmsToSingleRecipientRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('definitionKey')) {
+ obj['definitionKey'] = ApiClient.convertToType(data['definitionKey'], 'String');
+ }
+ if (data.hasOwnProperty('recipient')) {
+ obj['recipient'] = Recipient.constructFromObject(data['recipient']);
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = SendSmsContentRequest.constructFromObject(data['content']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Unique identifier of the definition.
+ * @member {String} definitionKey
+ */
+ definitionKey = undefined;
+ /**
+ * @member {module:Model/Recipient} recipient
+ */
+ recipient = undefined;
+ /**
+ * @member {module:Model/SendSmsContentRequest} content
+ */
+ content = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/SharingProperties.js b/src/Model/SharingProperties.js
new file mode 100644
index 0000000..2453ae0
--- /dev/null
+++ b/src/Model/SharingProperties.js
@@ -0,0 +1,112 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The SharingProperties model module.
+* @module Model/SharingProperties
+* @version 1.0.0
+*/
+module.exports = class SharingProperties{
+ /**
+ * Constructs a new SharingProperties.
+ * @alias module:Model/SharingProperties
+ * @class
+ */
+
+ constructor() {
+
+
+
+ }
+
+ /**
+ * Constructs a SharingProperties from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/SharingProperties} obj Optional instance to populate.
+ * @return {module:Model/SharingProperties} The populated SharingProperties instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new SharingProperties();
+
+
+
+
+
+ if (data.hasOwnProperty('sharingType')) {
+ obj['sharingType'] = ApiClient.convertToType(data['sharingType'], 'String');
+ }
+ if (data.hasOwnProperty('sharedWith')) {
+ obj['sharedWith'] = ApiClient.convertToType(data['sharedWith'], ['Number']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Indicates the permission that you are granting to the list of MIDs in sharedWith. Possible values are view, edit, or local.
+ * @member {module:Model/SharingProperties.SharingTypeEnum} sharingType
+ */
+ sharingType = undefined;
+ /**
+ * List of MID IDs the asset is shared with
+ * @member {Array.} sharedWith
+ */
+ sharedWith = undefined;
+
+
+
+
+
+
+ /**
+ * Allowed values for the sharingType property.
+ * @enum {String}
+ * @readonly
+ */
+ static SharingTypeEnum = {
+
+ /**
+ * value: "view"
+ * @const
+ */
+ "view": "view",
+
+ /**
+ * value: "edit"
+ * @const
+ */
+ "edit": "edit",
+
+ /**
+ * value: "local"
+ * @const
+ */
+ "local": "local"
+ };
+
+
+
+}
+
+
diff --git a/src/Model/UpdateEmailDefinitionRequest.js b/src/Model/UpdateEmailDefinitionRequest.js
new file mode 100644
index 0000000..23b4d6d
--- /dev/null
+++ b/src/Model/UpdateEmailDefinitionRequest.js
@@ -0,0 +1,131 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateEmailDefinitionContent = require ('./CreateEmailDefinitionContent');
+const CreateEmailDefinitionOptionsRequest = require ('./CreateEmailDefinitionOptionsRequest');
+const CreateEmailDefinitionSubscriptions = require ('./CreateEmailDefinitionSubscriptions');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The UpdateEmailDefinitionRequest model module.
+* @module Model/UpdateEmailDefinitionRequest
+* @version 1.0.0
+*/
+module.exports = class UpdateEmailDefinitionRequest{
+ /**
+ * Constructs a new UpdateEmailDefinitionRequest.
+ * @alias module:Model/UpdateEmailDefinitionRequest
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a UpdateEmailDefinitionRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/UpdateEmailDefinitionRequest} obj Optional instance to populate.
+ * @return {module:Model/UpdateEmailDefinitionRequest} The populated UpdateEmailDefinitionRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new UpdateEmailDefinitionRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = CreateEmailDefinitionContent.constructFromObject(data['content']);
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('classification')) {
+ obj['classification'] = ApiClient.convertToType(data['classification'], 'String');
+ }
+ if (data.hasOwnProperty('subscriptions')) {
+ obj['subscriptions'] = CreateEmailDefinitionSubscriptions.constructFromObject(data['subscriptions']);
+ }
+ if (data.hasOwnProperty('options')) {
+ obj['options'] = CreateEmailDefinitionOptionsRequest.constructFromObject(data['options']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Name of the definition. Must be unique.
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionContent} content
+ */
+ content = undefined;
+ /**
+ * Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
+ * @member {String} status
+ */
+ status = undefined;
+ /**
+ * User-provided description of the email definition.
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
+ * @member {String} classification
+ */
+ classification = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionSubscriptions} subscriptions
+ */
+ subscriptions = undefined;
+ /**
+ * @member {module:Model/CreateEmailDefinitionOptionsRequest} options
+ */
+ options = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/Model/UpdateSmsDefinitionRequest.js b/src/Model/UpdateSmsDefinitionRequest.js
new file mode 100644
index 0000000..0499af2
--- /dev/null
+++ b/src/Model/UpdateSmsDefinitionRequest.js
@@ -0,0 +1,113 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require ('../ApiClient');
+const CreateSmsDefinitionContent = require ('./CreateSmsDefinitionContent');
+const CreateSmsDefinitionSubscriptions = require ('./CreateSmsDefinitionSubscriptions');
+
+
+
+
+
+const InvalidModelException = require('../Exception/InvalidModelException');
+
+/**
+* The UpdateSmsDefinitionRequest model module.
+* @module Model/UpdateSmsDefinitionRequest
+* @version 1.0.0
+*/
+module.exports = class UpdateSmsDefinitionRequest{
+ /**
+ * Constructs a new UpdateSmsDefinitionRequest.
+ * @alias module:Model/UpdateSmsDefinitionRequest
+ * @class
+ */
+
+ constructor() {
+
+
+
+
+
+
+ }
+
+ /**
+ * Constructs a UpdateSmsDefinitionRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:Model/UpdateSmsDefinitionRequest} obj Optional instance to populate.
+ * @return {module:Model/UpdateSmsDefinitionRequest} The populated UpdateSmsDefinitionRequest instance.
+ */
+ static constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new UpdateSmsDefinitionRequest();
+
+
+
+
+
+ if (data.hasOwnProperty('name')) {
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
+ }
+ if (data.hasOwnProperty('content')) {
+ obj['content'] = CreateSmsDefinitionContent.constructFromObject(data['content']);
+ }
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ if (data.hasOwnProperty('description')) {
+ obj['description'] = ApiClient.convertToType(data['description'], 'String');
+ }
+ if (data.hasOwnProperty('subscriptions')) {
+ obj['subscriptions'] = CreateSmsDefinitionSubscriptions.constructFromObject(data['subscriptions']);
+ }
+ }
+ return obj;
+ }
+
+ /**
+ * Name of the definition. Must be unique.
+ * @member {String} name
+ */
+ name = undefined;
+ /**
+ * @member {module:Model/CreateSmsDefinitionContent} content
+ */
+ content = undefined;
+ /**
+ * Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days.
+ * @member {String} status
+ */
+ status = undefined;
+ /**
+ * User-provided description of the SMS definition.
+ * @member {String} description
+ */
+ description = undefined;
+ /**
+ * @member {module:Model/CreateSmsDefinitionSubscriptions} subscriptions
+ */
+ subscriptions = undefined;
+
+
+
+
+
+
+
+
+}
+
+
diff --git a/src/OAuth2ApiClient.js b/src/OAuth2ApiClient.js
new file mode 100644
index 0000000..ef6d706
--- /dev/null
+++ b/src/OAuth2ApiClient.js
@@ -0,0 +1,20 @@
+const ApiClient = require('./ApiClient');
+
+class OAuth2ApiClient extends ApiClient{
+ constructor(authService, runtimeInformationProvider){
+ super(runtimeInformationProvider);
+ this.authService = authService;
+ }
+
+ async callApi(path, httpMethod, pathParams, queryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts, returnType, caller) {
+
+ let tokenResponse = await this.authService.getTokenResponse();
+
+ this.basePath = tokenResponse['rest_instance_url'];
+ this.authentication['oauth2'].accessToken = tokenResponse['access_token'];
+
+ return super.callApi(path, httpMethod, pathParams, queryParams, headerParams, formParams, bodyParam, 'oauth2', contentTypes, accepts, returnType, caller);
+ }
+}
+
+module.exports = OAuth2ApiClient;
diff --git a/src/RuntimeInformationProvider.js b/src/RuntimeInformationProvider.js
new file mode 100644
index 0000000..9bbd56d
--- /dev/null
+++ b/src/RuntimeInformationProvider.js
@@ -0,0 +1,18 @@
+const pkg = require('../package');
+const os = require('os');
+
+class RuntimeInformationProvider{
+ constructor(){
+ this._nodeVersion = process.version;
+ this._osType = os.type();
+ this._osRelease = os.release();
+ }
+ getUserAgentString(){
+ return `MCSDK/NODE/${RuntimeInformationProvider.getSdkVersion()}/${this._nodeVersion}/${this._osType}/${this._osRelease}`;
+ }
+ static getSdkVersion(){
+ return pkg['version'];
+ }
+}
+
+module.exports = RuntimeInformationProvider;
\ No newline at end of file
diff --git a/src/index.js b/src/index.js
new file mode 100644
index 0000000..0deabb0
--- /dev/null
+++ b/src/index.js
@@ -0,0 +1,321 @@
+/**
+ * Marketing Cloud REST API
+ * Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release.
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: mc_sdk@salesforce.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ *
+ */
+
+
+const ApiClient = require('./ApiClient');
+const ApiError = require ('./Model/ApiError');
+const Asset = require ('./Model/Asset');
+const AssetType = require ('./Model/AssetType');
+const Attributes = require ('./Model/Attributes');
+const Campaign = require ('./Model/Campaign');
+const CreateEmailDefinitionContent = require ('./Model/CreateEmailDefinitionContent');
+const CreateEmailDefinitionOptionsRequest = require ('./Model/CreateEmailDefinitionOptionsRequest');
+const CreateEmailDefinitionRequest = require ('./Model/CreateEmailDefinitionRequest');
+const CreateEmailDefinitionSubscriptions = require ('./Model/CreateEmailDefinitionSubscriptions');
+const CreateSmsDefinitionContent = require ('./Model/CreateSmsDefinitionContent');
+const CreateSmsDefinitionRequest = require ('./Model/CreateSmsDefinitionRequest');
+const CreateSmsDefinitionSubscriptions = require ('./Model/CreateSmsDefinitionSubscriptions');
+const DeleteQueuedMessagesForSendDefinitionResponse = require ('./Model/DeleteQueuedMessagesForSendDefinitionResponse');
+const DeleteSendDefinitionResponse = require ('./Model/DeleteSendDefinitionResponse');
+const GetDefinitionSendStatusForRecipientResponse = require ('./Model/GetDefinitionSendStatusForRecipientResponse');
+const GetDefinitionSendStatusForRecipientResponseInfo = require ('./Model/GetDefinitionSendStatusForRecipientResponseInfo');
+const GetDefinitionsNotSentToRecipientsMessage = require ('./Model/GetDefinitionsNotSentToRecipientsMessage');
+const GetDefinitionsNotSentToRecipientsMessageInfo = require ('./Model/GetDefinitionsNotSentToRecipientsMessageInfo');
+const GetDefinitionsNotSentToRecipientsResponse = require ('./Model/GetDefinitionsNotSentToRecipientsResponse');
+const GetEmailDefinitionsResponse = require ('./Model/GetEmailDefinitionsResponse');
+const GetQueueMetricsForSendDefinitionResponse = require ('./Model/GetQueueMetricsForSendDefinitionResponse');
+const GetSmsDefinitionsResponse = require ('./Model/GetSmsDefinitionsResponse');
+const Recipient = require ('./Model/Recipient');
+const SendDefinitionResponseItem = require ('./Model/SendDefinitionResponseItem');
+const SendDefinitionToMultipleRecipientsResponse = require ('./Model/SendDefinitionToMultipleRecipientsResponse');
+const SendDefinitionToSingleRecipientResponse = require ('./Model/SendDefinitionToSingleRecipientResponse');
+const SendEmailToMultipleRecipientsRequest = require ('./Model/SendEmailToMultipleRecipientsRequest');
+const SendEmailToSingleRecipientRequest = require ('./Model/SendEmailToSingleRecipientRequest');
+const SendSmsContentRequest = require ('./Model/SendSmsContentRequest');
+const SendSmsToMultipleRecipientsRequest = require ('./Model/SendSmsToMultipleRecipientsRequest');
+const SendSmsToMultipleRecipientsSubscriptionsRequest = require ('./Model/SendSmsToMultipleRecipientsSubscriptionsRequest');
+const SendSmsToSingleRecipientRequest = require ('./Model/SendSmsToSingleRecipientRequest');
+const SharingProperties = require ('./Model/SharingProperties');
+const UpdateEmailDefinitionRequest = require ('./Model/UpdateEmailDefinitionRequest');
+const UpdateSmsDefinitionRequest = require ('./Model/UpdateSmsDefinitionRequest');
+const AssetApi = require ('./Api/AssetApi');
+const CampaignApi = require ('./Api/CampaignApi');
+const TransactionalMessagingApi = require ('./Api/TransactionalMessagingApi');
+
+
+/**
+* Marketing_Clouds_REST_API_is_our_newest_API__It_supports_multi_channel_use_cases_is_much_more_lightweight_and_easy_to_use_than_our_SOAP_API_and_is_getting_more_comprehensive_with_every_release_.
+* The index module provides access to constructors for all the classes which comprise the public API.
+*
+* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
+*
+* var SalesforceMarketingCloud = require('index'); // See note below*.
+* var xxxSvc = new SalesforceMarketingCloud.XxxApi(); // Allocate the API class we're going to use.
+* var yyyModel = new SalesforceMarketingCloud.Yyy(); // Construct a model instance.
+* yyyModel.someProperty = 'someValue';
+* ...
+* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+* ...
+*
+* *NOTE: For a top-level AMD script, use require(['index'], function(){...})
+* and put the application logic within the callback function.
+*
+*
+* A non-AMD browser application (discouraged) might do something like this:
+*
+* var xxxSvc = new SalesforceMarketingCloud.XxxApi(); // Allocate the API class we're going to use.
+* var yyy = new SalesforceMarketingCloud.Yyy(); // Construct a model instance.
+* yyyModel.someProperty = 'someValue';
+* ...
+* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+* ...
+*
+*
+* @module index
+* @version 1.0.0
+*/
+module.exports={
+ /**
+ * The ApiClient constructor.
+ * @property {module:ApiClient}
+ */
+ ApiClient,
+
+ /**
+ * The ApiError model constructor.
+ * @property {module:Model/ApiError}
+ */
+ ApiError,
+
+ /**
+ * The Asset model constructor.
+ * @property {module:Model/Asset}
+ */
+ Asset,
+
+ /**
+ * The AssetType model constructor.
+ * @property {module:Model/AssetType}
+ */
+ AssetType,
+
+ /**
+ * The Attributes model constructor.
+ * @property {module:Model/Attributes}
+ */
+ Attributes,
+
+ /**
+ * The Campaign model constructor.
+ * @property {module:Model/Campaign}
+ */
+ Campaign,
+
+ /**
+ * The CreateEmailDefinitionContent model constructor.
+ * @property {module:Model/CreateEmailDefinitionContent}
+ */
+ CreateEmailDefinitionContent,
+
+ /**
+ * The CreateEmailDefinitionOptionsRequest model constructor.
+ * @property {module:Model/CreateEmailDefinitionOptionsRequest}
+ */
+ CreateEmailDefinitionOptionsRequest,
+
+ /**
+ * The CreateEmailDefinitionRequest model constructor.
+ * @property {module:Model/CreateEmailDefinitionRequest}
+ */
+ CreateEmailDefinitionRequest,
+
+ /**
+ * The CreateEmailDefinitionSubscriptions model constructor.
+ * @property {module:Model/CreateEmailDefinitionSubscriptions}
+ */
+ CreateEmailDefinitionSubscriptions,
+
+ /**
+ * The CreateSmsDefinitionContent model constructor.
+ * @property {module:Model/CreateSmsDefinitionContent}
+ */
+ CreateSmsDefinitionContent,
+
+ /**
+ * The CreateSmsDefinitionRequest model constructor.
+ * @property {module:Model/CreateSmsDefinitionRequest}
+ */
+ CreateSmsDefinitionRequest,
+
+ /**
+ * The CreateSmsDefinitionSubscriptions model constructor.
+ * @property {module:Model/CreateSmsDefinitionSubscriptions}
+ */
+ CreateSmsDefinitionSubscriptions,
+
+ /**
+ * The DeleteQueuedMessagesForSendDefinitionResponse model constructor.
+ * @property {module:Model/DeleteQueuedMessagesForSendDefinitionResponse}
+ */
+ DeleteQueuedMessagesForSendDefinitionResponse,
+
+ /**
+ * The DeleteSendDefinitionResponse model constructor.
+ * @property {module:Model/DeleteSendDefinitionResponse}
+ */
+ DeleteSendDefinitionResponse,
+
+ /**
+ * The GetDefinitionSendStatusForRecipientResponse model constructor.
+ * @property {module:Model/GetDefinitionSendStatusForRecipientResponse}
+ */
+ GetDefinitionSendStatusForRecipientResponse,
+
+ /**
+ * The GetDefinitionSendStatusForRecipientResponseInfo model constructor.
+ * @property {module:Model/GetDefinitionSendStatusForRecipientResponseInfo}
+ */
+ GetDefinitionSendStatusForRecipientResponseInfo,
+
+ /**
+ * The GetDefinitionsNotSentToRecipientsMessage model constructor.
+ * @property {module:Model/GetDefinitionsNotSentToRecipientsMessage}
+ */
+ GetDefinitionsNotSentToRecipientsMessage,
+
+ /**
+ * The GetDefinitionsNotSentToRecipientsMessageInfo model constructor.
+ * @property {module:Model/GetDefinitionsNotSentToRecipientsMessageInfo}
+ */
+ GetDefinitionsNotSentToRecipientsMessageInfo,
+
+ /**
+ * The GetDefinitionsNotSentToRecipientsResponse model constructor.
+ * @property {module:Model/GetDefinitionsNotSentToRecipientsResponse}
+ */
+ GetDefinitionsNotSentToRecipientsResponse,
+
+ /**
+ * The GetEmailDefinitionsResponse model constructor.
+ * @property {module:Model/GetEmailDefinitionsResponse}
+ */
+ GetEmailDefinitionsResponse,
+
+ /**
+ * The GetQueueMetricsForSendDefinitionResponse model constructor.
+ * @property {module:Model/GetQueueMetricsForSendDefinitionResponse}
+ */
+ GetQueueMetricsForSendDefinitionResponse,
+
+ /**
+ * The GetSmsDefinitionsResponse model constructor.
+ * @property {module:Model/GetSmsDefinitionsResponse}
+ */
+ GetSmsDefinitionsResponse,
+
+ /**
+ * The Recipient model constructor.
+ * @property {module:Model/Recipient}
+ */
+ Recipient,
+
+ /**
+ * The SendDefinitionResponseItem model constructor.
+ * @property {module:Model/SendDefinitionResponseItem}
+ */
+ SendDefinitionResponseItem,
+
+ /**
+ * The SendDefinitionToMultipleRecipientsResponse model constructor.
+ * @property {module:Model/SendDefinitionToMultipleRecipientsResponse}
+ */
+ SendDefinitionToMultipleRecipientsResponse,
+
+ /**
+ * The SendDefinitionToSingleRecipientResponse model constructor.
+ * @property {module:Model/SendDefinitionToSingleRecipientResponse}
+ */
+ SendDefinitionToSingleRecipientResponse,
+
+ /**
+ * The SendEmailToMultipleRecipientsRequest model constructor.
+ * @property {module:Model/SendEmailToMultipleRecipientsRequest}
+ */
+ SendEmailToMultipleRecipientsRequest,
+
+ /**
+ * The SendEmailToSingleRecipientRequest model constructor.
+ * @property {module:Model/SendEmailToSingleRecipientRequest}
+ */
+ SendEmailToSingleRecipientRequest,
+
+ /**
+ * The SendSmsContentRequest model constructor.
+ * @property {module:Model/SendSmsContentRequest}
+ */
+ SendSmsContentRequest,
+
+ /**
+ * The SendSmsToMultipleRecipientsRequest model constructor.
+ * @property {module:Model/SendSmsToMultipleRecipientsRequest}
+ */
+ SendSmsToMultipleRecipientsRequest,
+
+ /**
+ * The SendSmsToMultipleRecipientsSubscriptionsRequest model constructor.
+ * @property {module:Model/SendSmsToMultipleRecipientsSubscriptionsRequest}
+ */
+ SendSmsToMultipleRecipientsSubscriptionsRequest,
+
+ /**
+ * The SendSmsToSingleRecipientRequest model constructor.
+ * @property {module:Model/SendSmsToSingleRecipientRequest}
+ */
+ SendSmsToSingleRecipientRequest,
+
+ /**
+ * The SharingProperties model constructor.
+ * @property {module:Model/SharingProperties}
+ */
+ SharingProperties,
+
+ /**
+ * The UpdateEmailDefinitionRequest model constructor.
+ * @property {module:Model/UpdateEmailDefinitionRequest}
+ */
+ UpdateEmailDefinitionRequest,
+
+ /**
+ * The UpdateSmsDefinitionRequest model constructor.
+ * @property {module:Model/UpdateSmsDefinitionRequest}
+ */
+ UpdateSmsDefinitionRequest,
+
+ /**
+ * The AssetApi service constructor.
+ * @property {module:Api/AssetApi}
+ */
+ AssetApi,
+
+ /**
+ * The CampaignApi service constructor.
+ * @property {module:Api/CampaignApi}
+ */
+ CampaignApi,
+
+ /**
+ * The TransactionalMessagingApi service constructor.
+ * @property {module:Api/TransactionalMessagingApi}
+ */
+ TransactionalMessagingApi
+};
diff --git a/test/TestHelper.js b/test/TestHelper.js
new file mode 100644
index 0000000..c76f906
--- /dev/null
+++ b/test/TestHelper.js
@@ -0,0 +1,52 @@
+const ClientConfiguration = require('../src/Auth/ClientConfiguration');
+
+class TestHelper {
+ static createTokenResponseData() {
+ return {
+ data: {
+ access_token: 'access_token',
+ expires_in: 1080,
+ rest_instance_url: 'rest_instance_url',
+ soap_instance_url: 'soap_instance_url',
+ scope: 'scope',
+ token_type: 'Bearer'
+ }
+ }
+ }
+ static createClientConfiguration() {
+ return new ClientConfiguration(
+ 'https://auth.com',
+ 'clientId',
+ 'clientSecret',
+ 123456,
+ 'scope'
+ )
+ }
+ static createRequestResponse(statusCode) {
+ return {
+ status: statusCode,
+ response: {
+ body: 'errorResponseBody'
+ }
+ }
+ }
+ static createServerUnreachableError(){
+ return {
+ code: 'ENOTFOUND',
+ errno: 'ENOTFOUND',
+ syscall: 'getaddrinfo',
+ hostname: 'host'
+ }
+ }
+ static createConfigProvider(){
+ return {
+ authBaseUrl: 'authBaseUrl',
+ clientId: 'clientId',
+ clientSecret: 'clientSecret',
+ accountId: 'accountId',
+ scope: 'scope',
+ }
+ }
+}
+
+module.exports = TestHelper;
\ No newline at end of file
diff --git a/test/integration/api/ApiSutFactory.js b/test/integration/api/ApiSutFactory.js
new file mode 100644
index 0000000..69768dc
--- /dev/null
+++ b/test/integration/api/ApiSutFactory.js
@@ -0,0 +1,20 @@
+const EnvironmentConfigProvider = require('../../../src/EnvironmentConfigProvider');
+
+class ApiSutFactory{
+ constructor(type){
+ this._type = type;
+ }
+ create(){
+ let environmentConfigProvider = new EnvironmentConfigProvider();
+
+ let authBaseUrl = environmentConfigProvider.get('SFMC_AUTH_BASE_URL');
+ let clientId = environmentConfigProvider.get('SFMC_CLIENT_ID');
+ let clientSecret = environmentConfigProvider.get('SFMC_CLIENT_SECRET');
+ let accountId = environmentConfigProvider.get('SFMC_ACCOUNT_ID');
+ let scope = environmentConfigProvider.get('SFMC_SCOPE', false);
+
+ return new this._type(authBaseUrl, clientId, clientSecret, accountId, scope);
+ }
+}
+
+module.exports = ApiSutFactory;
\ No newline at end of file
diff --git a/test/integration/api/AssetApi.spec.js b/test/integration/api/AssetApi.spec.js
new file mode 100644
index 0000000..6da584f
--- /dev/null
+++ b/test/integration/api/AssetApi.spec.js
@@ -0,0 +1,113 @@
+const ApiSutFactory = require('./ApiSutFactory');
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD.
+ define(['expect.js', '../../../src'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ factory(require('expect.js'), require('../../../src'));
+ } else {
+ // Browser globals (root is window)
+ factory(root.expect, root.SalesforceMarketingCloud);
+ }
+}(this, function(expect, SalesforceMarketingCloud) {
+ 'use strict';
+
+ const HTML_EMAIL_ASSET_TYPE_ID = 196;
+
+ let assetApiInstance;
+
+ before(()=>{
+ assetApiInstance = new ApiSutFactory(SalesforceMarketingCloud.AssetApi.prototype.constructor).create();
+ });
+
+ describe('AssetApi', function() {
+ describe('createAsset', function() {
+ it('should call createAsset successfully', async ()=>{
+ let asset = createAssetObject();
+
+ let createAssetResponse = await assetApiInstance.createAsset(asset);
+
+ expect(createAssetResponse.customerKey).to.eql(asset.customerKey);
+ expect(createAssetResponse.name).to.eql(asset.name);
+ expect(createAssetResponse.description).to.eql(asset.description);
+ expect(createAssetResponse.assetType.id).to.eql(asset.assetType.id);
+ expect(createAssetResponse.assetType.name).to.eql(asset.assetType.name);
+
+ await assetApiInstance.deleteAssetById(createAssetResponse.id);
+ });
+ });
+ describe('deleteAssetById', function() {
+ it('should call deleteAssetById successfully', async ()=>{
+ let asset = createAssetObject();
+ let createAssetResponse = await assetApiInstance.createAsset(asset);
+ let assetToDeleteId = createAssetResponse.id;
+
+ await assetApiInstance.deleteAssetById(assetToDeleteId);
+
+ try{
+ await assetApiInstance.getAssetById(assetToDeleteId);
+ }
+ catch(error) {
+ expect(error.status).to.eql(404);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ });
+ describe('getAssetById', function() {
+ it('should call getAssetById successfully', async ()=> {
+ let asset = createAssetObject();
+ let createAssetResponse = await assetApiInstance.createAsset(asset);
+ let assetToRetrieveId = createAssetResponse.id;
+
+ let getAssetByIdResponse = await assetApiInstance.getAssetById(assetToRetrieveId);
+
+ expect(getAssetByIdResponse.customerKey).to.eql(asset.customerKey);
+ expect(getAssetByIdResponse.name).to.eql(asset.name);
+ expect(getAssetByIdResponse.description).to.eql(asset.description);
+ expect(getAssetByIdResponse.assetType.id).to.eql(asset.assetType.id);
+ expect(getAssetByIdResponse.assetType.name).to.eql(asset.assetType.name);
+
+ await assetApiInstance.deleteAssetById(createAssetResponse.id);
+ });
+ });
+ describe('partiallyUpdateAssetById', function() {
+ it('should call partiallyUpdateAssetById successfully', async ()=> {
+ let asset = createAssetObject();
+ let createAssetResponse = await assetApiInstance.createAsset(asset);
+ let assetToPartiallyUpdateId = createAssetResponse.id;
+ createAssetResponse.description = 'Updated asset description';
+
+ let partiallyUpdateAssetResult = await assetApiInstance.partiallyUpdateAssetById(assetToPartiallyUpdateId, createAssetResponse);
+
+ expect(partiallyUpdateAssetResult.description).to.eql(createAssetResponse.description);
+
+ expect(partiallyUpdateAssetResult.customerKey).to.eql(asset.customerKey);
+ expect(partiallyUpdateAssetResult.name).to.eql(asset.name);
+ expect(partiallyUpdateAssetResult.assetType.id).to.eql(asset.assetType.id);
+ expect(partiallyUpdateAssetResult.assetType.name).to.eql(asset.assetType.name);
+
+ await assetApiInstance.deleteAssetById(createAssetResponse.id);
+ });
+ });
+ });
+
+ function createAssetObject() {
+ let assetType = new SalesforceMarketingCloud.AssetType(HTML_EMAIL_ASSET_TYPE_ID, 'textblock');
+
+ let customerKey = getUUID(10);
+ let assetName = 'Asset ' + getUUID(10);
+ let assetDescription = 'Asset from Automated Node.js SDK';
+
+ return new SalesforceMarketingCloud.Asset(customerKey, assetType, assetName, assetDescription);
+ }
+
+ function getUUID(length){
+ return Math.random().toString(16).substring(0, length);
+ }
+}));
+
+
diff --git a/test/integration/api/CampaignApi.spec.js b/test/integration/api/CampaignApi.spec.js
new file mode 100644
index 0000000..1095522
--- /dev/null
+++ b/test/integration/api/CampaignApi.spec.js
@@ -0,0 +1,90 @@
+const ApiSutFactory = require('./ApiSutFactory');
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD.
+ define(['expect.js', '../../../src'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ factory(require('expect.js'), require('../../../src'));
+ } else {
+ // Browser globals (root is window)
+ factory(root.expect, root.SalesforceMarketingCloud);
+ }
+}(this, function(expect, SalesforceMarketingCloud) {
+ 'use strict';
+
+ let campaignApiInstance;
+
+ before(()=>{
+ campaignApiInstance = new ApiSutFactory(SalesforceMarketingCloud.CampaignApi.prototype.constructor).create();
+ });
+
+ describe('CampaignApi', function() {
+ describe('createCampaign', function() {
+ it('should call createCampaign successfully', async ()=> {
+ let campaign = createCampaignObject();
+
+ let createCampaignResponse = await campaignApiInstance.createCampaign(campaign);
+
+ expect(createCampaignResponse.name).to.eql(campaign.name);
+ expect(createCampaignResponse.description).to.eql(campaign.description);
+ expect(createCampaignResponse.campaignCode).to.eql(campaign.campaignCode);
+ expect(createCampaignResponse.color).to.eql(campaign.color);
+ expect(createCampaignResponse.favorite).to.eql(campaign.favorite);
+
+ await campaignApiInstance.deleteCampaignById(createCampaignResponse.id);
+ });
+ });
+ describe('deleteCampaignById', function() {
+ it('should call deleteCampaignById successfully', async ()=> {
+ let campaign = createCampaignObject();
+ let createCampaignResponse = await campaignApiInstance.createCampaign(campaign);
+ let campaignToDeleteId = createCampaignResponse.id;
+
+ await campaignApiInstance.deleteCampaignById(campaignToDeleteId);
+
+ try {
+ await campaignApiInstance.getCampaignById(campaignToDeleteId);
+ }
+ catch (error) {
+ expect(error.status).to.eql(400);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ });
+ describe('getCampaignById', function() {
+ it('should call getCampaignById successfully', async ()=> {
+ let campaign = createCampaignObject();
+ let createCampaignResponse = await campaignApiInstance.createCampaign(campaign);
+ let campaignToRetrieveId = createCampaignResponse.id;
+
+ let getCampaignByIdResponse = await campaignApiInstance.getCampaignById(campaignToRetrieveId);
+
+ expect(getCampaignByIdResponse.name).to.eql(campaign.name);
+ expect(getCampaignByIdResponse.description).to.eql(campaign.description);
+ expect(getCampaignByIdResponse.campaignCode).to.eql(campaign.campaignCode);
+ expect(getCampaignByIdResponse.color).to.eql(campaign.color);
+ expect(getCampaignByIdResponse.favorite).to.eql(campaign.favorite);
+
+ await campaignApiInstance.deleteCampaignById(createCampaignResponse.id);
+ });
+ });
+ });
+
+ function createCampaignObject() {
+ let campaignName = 'Campaign ' + getUUID(10);
+ let campaignDescription = 'Campaign from Automated Node.js SDK';
+ let campaignCode = 'CampaignCode';
+ let campaignColor = "0000ff";
+ let favorite = false;
+
+ return new SalesforceMarketingCloud.Campaign(campaignName, campaignDescription, campaignCode, campaignColor, favorite);
+ }
+
+ function getUUID(length){
+ return Math.random().toString(16).substring(0, length);
+ }
+}));
diff --git a/test/integration/api/TransactionalMessagingApi.spec.js b/test/integration/api/TransactionalMessagingApi.spec.js
new file mode 100644
index 0000000..22ba05b
--- /dev/null
+++ b/test/integration/api/TransactionalMessagingApi.spec.js
@@ -0,0 +1,460 @@
+const ApiSutFactory = require('./ApiSutFactory');
+const EnvironmentConfigProvider = require('../../../src/EnvironmentConfigProvider');
+
+(function(root, factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD.
+ define(['expect.js', '../../../src'], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ factory(require('expect.js'), require('../../../src'));
+ } else {
+ // Browser globals (root is window)
+ factory(root.expect, root.SalesforceMarketingCloud);
+ }
+}(this, function(expect, SalesforceMarketingCloud) {
+ 'use strict';
+
+ const JOHN_DOE_GMAIL_COM = "johnDoe@gmail.com";
+ const JOHANNA_DOE_YAHOO_COM = "johannaDoe@yahoo.com";
+ const HTML_EMAIL_ASSET_TYPE_ID = 208;
+
+ let assetApiInstance;
+ let transactionalMessagingApiInstance;
+ let environmentConfigProvider;
+
+ before(()=>{
+ transactionalMessagingApiInstance = new ApiSutFactory(SalesforceMarketingCloud.TransactionalMessagingApi.prototype.constructor).create();
+ assetApiInstance = new ApiSutFactory(SalesforceMarketingCloud.AssetApi.prototype.constructor).create();
+ environmentConfigProvider = new EnvironmentConfigProvider();
+ });
+
+ describe('TransactionalMessagingApi', function() {
+ describe('createEmailDefinition', function() {
+ it('should call createEmailDefinition successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+
+ expect(createEmailDefinitionResult.name).to.eql(emailDefinition.name);
+ expect(createEmailDefinitionResult.definitionKey).to.eql(emailDefinition.definitionKey);
+ expect(createEmailDefinitionResult.content.customerKey).to.eql(emailDefinition.content.customerKey);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('createSmsDefinition', function() {
+ it('should call createSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+
+ expect(createSmsDefinitionResult.definitionKey).to.eql(smsDefinition.definitionKey);
+ expect(createSmsDefinitionResult.name).to.eql(smsDefinition.name);
+ expect(createSmsDefinitionResult.subscriptions.shortCode).to.eql(smsDefinition.subscriptions.shortCode);
+ expect(createSmsDefinitionResult.subscriptions.countryCode).to.eql(smsDefinition.subscriptions.countryCode);
+ expect(createSmsDefinitionResult.content).to.eql(smsDefinition.content);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('deleteEmailDefinition', function() {
+ it('should call deleteEmailDefinition successfully when definitionKey is valid', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+
+ let deleteEmailDefinitionResult = await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+
+ expect(deleteEmailDefinitionResult.requestId).not.be(undefined);
+ expect(deleteEmailDefinitionResult.deletedDefinitionKey).not.be(undefined);
+ expect(deleteEmailDefinitionResult.message).to.eql("Success");
+ });
+ });
+ describe('deleteEmailDefinition', function() {
+ it('should not call deleteEmailDefinition successfully when definitionKey is invalid', async ()=> {
+ let emailDefinitionToDeleteKey = 'NonExistingEmailDefinitionKey';
+
+ try{
+ await transactionalMessagingApiInstance.deleteEmailDefinition(emailDefinitionToDeleteKey);
+ }
+ catch (error) {
+ expect(error.status).to.eql(404);
+ }
+ });
+ });
+ describe('deleteQueuedMessagesForEmailDefinition', function() {
+ it('should call deleteQueuedMessagesForEmailDefinition successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ emailDefinition.status = 'inactive';
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+
+ let deleteQueuedMessagesForEmailDefinitionResult = await transactionalMessagingApiInstance.deleteQueuedMessagesForEmailDefinition(createEmailDefinitionResult.definitionKey);
+
+ expect(deleteQueuedMessagesForEmailDefinitionResult.requestId).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('deleteQueuedMessagesForSmsDefinition', function() {
+ it('should call deleteQueuedMessagesForSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ smsDefinition.status = 'inactive';
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+
+ let deleteQueuedMessagesForSmsDefinitionResult = await transactionalMessagingApiInstance.deleteQueuedMessagesForSmsDefinition(createSmsDefinitionResult.definitionKey);
+
+ expect(deleteQueuedMessagesForSmsDefinitionResult.requestId).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('deleteSmsDefinition', function() {
+ it('should call deleteSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+
+ let deleteSmsDefinitionResult = await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+
+ expect(deleteSmsDefinitionResult.requestId).not.be(undefined);
+ expect(deleteSmsDefinitionResult.deletedDefinitionKey).not.be(undefined);
+ expect(deleteSmsDefinitionResult.message).to.eql("Success");
+ });
+ });
+ describe('deleteSmsDefinition', function() {
+ it('should not call deleteSmsDefinition successfully when definitionKey is invalid', async ()=> {
+ let smsDefinitionToDeleteKey = 'NonExistingSmsDefinitionKey';
+
+ try{
+ await transactionalMessagingApiInstance.deleteSmsDefinition(smsDefinitionToDeleteKey);
+ }
+ catch (error) {
+ expect(error.status).to.eql(404);
+ }
+ });
+ });
+ describe('getEmailDefinition', function() {
+ it('should call getEmailDefinition successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+
+ let getEmailDefinitionsResult = await transactionalMessagingApiInstance.getEmailDefinition(createEmailDefinitionResult.definitionKey);
+
+ expect(getEmailDefinitionsResult.name).to.eql(emailDefinition.name);
+ expect(getEmailDefinitionsResult.definitionKey).to.eql(emailDefinition.definitionKey);
+ expect(getEmailDefinitionsResult.content.customerKey).to.eql(emailDefinition.content.customerKey);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('getEmailDefinitions', function() {
+ it('should call getEmailDefinitions successfully', async ()=> {
+ let opts = {
+ 'status': undefined,
+ 'orderBy': undefined,
+ 'pageSize': undefined,
+ 'page': undefined
+ };
+
+ let getEmailDefinitionsResult = await transactionalMessagingApiInstance.getEmailDefinitions(opts);
+
+ expect(getEmailDefinitionsResult.requestId).not.be(undefined);
+ expect(getEmailDefinitionsResult.definitions).not.be(undefined);
+ expect(getEmailDefinitionsResult.count).not.be(undefined);
+ expect(getEmailDefinitionsResult.page).not.be(undefined);
+ expect(getEmailDefinitionsResult.pageSize).not.be(undefined);
+ });
+ });
+ describe('getEmailSendStatusForRecipient', function() {
+ it('should call getEmailSendStatusForRecipient successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+ let recipient = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let messageRequestBody = new SalesforceMarketingCloud.SendEmailToSingleRecipientRequest(createEmailDefinitionResult.definitionKey, recipient);
+ let messageKey = getUUID();
+ await transactionalMessagingApiInstance.sendEmailToSingleRecipient(messageKey, messageRequestBody);
+
+ let getEmailSendStatusForRecipientResult = await transactionalMessagingApiInstance.getEmailSendStatusForRecipient(messageKey);
+
+ let eventCategoryTypes = ['TransactionalSendEvents.EmailSent', 'TransactionalSendEvents.EmailQueued', 'TransactionalSendEvents.EmailNotSent'];
+
+ expect(getEmailSendStatusForRecipientResult.requestId).not.be(undefined);
+ expect(getEmailSendStatusForRecipientResult.timestamp).not.be(undefined);
+ expect(eventCategoryTypes).to.contain(getEmailSendStatusForRecipientResult.eventCategoryType);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('getEmailsNotSentToRecipients', function() {
+ it('should call getEmailsNotSentToRecipients successfully', async ()=> {
+ let opts = {
+ 'pageSize':undefined,
+ 'lastEventId':undefined
+ };
+
+ let getEmailsNotSentToRecipientsResponse = await transactionalMessagingApiInstance.getEmailsNotSentToRecipients('notSent', opts);
+
+ expect(getEmailsNotSentToRecipientsResponse.requestId).not.be(undefined);
+ expect(getEmailsNotSentToRecipientsResponse.lastEventID).not.be(undefined);
+ expect(getEmailsNotSentToRecipientsResponse.messages).not.be(undefined);
+ expect(getEmailsNotSentToRecipientsResponse.count).not.be(undefined);
+ expect(getEmailsNotSentToRecipientsResponse.pageSize).not.be(undefined);
+ });
+ });
+ describe('getQueueMetricsForEmailDefinition', function() {
+ it('should call getQueueMetricsForEmailDefinition successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+
+ let getQueueMetricsForEmailDefinitionResult = await transactionalMessagingApiInstance.getQueueMetricsForEmailDefinition(createEmailDefinitionResult.definitionKey);
+
+ expect(getQueueMetricsForEmailDefinitionResult.requestId);
+ expect(getQueueMetricsForEmailDefinitionResult.count);
+ expect(getQueueMetricsForEmailDefinitionResult.ageSeconds);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('getQueueMetricsForSmsDefinition', function() {
+ it('should call getQueueMetricsForSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+
+ let getQueueMetricsForSmsDefinitionResult = await transactionalMessagingApiInstance.getQueueMetricsForSmsDefinition(createSmsDefinitionResult.definitionKey);
+
+ expect(getQueueMetricsForSmsDefinitionResult.requestId);
+ expect(getQueueMetricsForSmsDefinitionResult.count);
+ expect(getQueueMetricsForSmsDefinitionResult.ageSeconds);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('getSMSsNotSentToRecipients', function() {
+ it('should call getSMSsNotSentToRecipients successfully', async ()=> {
+ let opts = {
+ 'pageSize':undefined,
+ 'lastEventId':undefined
+ };
+
+ let getSMSsNotSentToRecipientsResponse = await transactionalMessagingApiInstance.getSMSsNotSentToRecipients('notSent', opts);
+
+ expect(getSMSsNotSentToRecipientsResponse.requestId).not.be(undefined);
+ expect(getSMSsNotSentToRecipientsResponse.lastEventID).not.be(undefined);
+ expect(getSMSsNotSentToRecipientsResponse.messages).not.be(undefined);
+ expect(getSMSsNotSentToRecipientsResponse.count).not.be(undefined);
+ expect(getSMSsNotSentToRecipientsResponse.pageSize).not.be(undefined);
+ });
+ });
+ describe('getSmsDefinition', function() {
+ it('should call getSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+
+ let getSmsDefinitionResult = await transactionalMessagingApiInstance.getSmsDefinition(createSmsDefinitionResult.definitionKey);
+
+ expect(getSmsDefinitionResult.definitionKey).to.eql(smsDefinition.definitionKey);
+ expect(getSmsDefinitionResult.name).to.eql(smsDefinition.name);
+ expect(getSmsDefinitionResult.subscriptions.shortCode).to.eql(smsDefinition.subscriptions.shortCode);
+ expect(getSmsDefinitionResult.subscriptions.countryCode).to.eql(smsDefinition.subscriptions.countryCode);
+ expect(getSmsDefinitionResult.content).to.eql(smsDefinition.content);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('getSmsDefinitions', function() {
+ it('should call getSmsDefinitions successfully', async ()=> {
+ let opts = {
+ 'status':undefined,
+ 'orderBy':undefined,
+ 'pageSize':undefined,
+ 'page':undefined
+ };
+
+ let getSmsDefinitionsResult = await transactionalMessagingApiInstance.getSmsDefinitions(opts);
+
+ expect(getSmsDefinitionsResult.requestId).not.be(undefined);
+ expect(getSmsDefinitionsResult.definitions).not.be(undefined);
+ expect(getSmsDefinitionsResult.count).not.be(undefined);
+ expect(getSmsDefinitionsResult.page).not.be(undefined);
+ expect(getSmsDefinitionsResult.pageSize).not.be(undefined);
+ });
+ });
+ describe('getSmsSendStatusForRecipient', function() {
+ it('should call getSmsSendStatusForRecipient successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+ let recipient = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let messageRequestBody = new SalesforceMarketingCloud.SendSmsToSingleRecipientRequest(createSmsDefinitionResult.definitionKey, recipient);
+ let messageKey = getUUID();
+ await transactionalMessagingApiInstance.sendSmsToSingleRecipient(messageKey, messageRequestBody);
+
+ let getSmsSendStatusForRecipientResult = await transactionalMessagingApiInstance.getSmsSendStatusForRecipient(messageKey);
+
+ let eventCategoryTypes = ['TransactionalSendEvents.SMSSent', 'TransactionalSendEvents.SMSQueued', 'TransactionalSendEvents.SMSNotSent'];
+
+ expect(getSmsSendStatusForRecipientResult.requestId).not.be(undefined);
+ expect(getSmsSendStatusForRecipientResult.timestamp).not.be(undefined);
+ expect(eventCategoryTypes).to.contain(getSmsSendStatusForRecipientResult.eventCategoryType);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('partiallyUpdateEmailDefinition', function() {
+ it('should call partiallyUpdateEmailDefinition successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+ let updatedDefinitionDescription = new SalesforceMarketingCloud.UpdateEmailDefinitionRequest();
+ updatedDefinitionDescription.description = 'Updated email definition description';
+
+ let partiallyUpdateEmailDefinitionResult = await transactionalMessagingApiInstance.partiallyUpdateEmailDefinition(createEmailDefinitionResult.definitionKey, updatedDefinitionDescription);
+
+ expect(partiallyUpdateEmailDefinitionResult.description).to.eql(updatedDefinitionDescription.description);
+
+ expect(partiallyUpdateEmailDefinitionResult.definitionKey).to.eql(emailDefinition.definitionKey);
+ expect(partiallyUpdateEmailDefinitionResult.name).to.eql(emailDefinition.name);
+ expect(partiallyUpdateEmailDefinitionResult.content.customerKey).to.eql(emailDefinition.content.customerKey);
+ expect(partiallyUpdateEmailDefinitionResult.content.customerKey).to.eql(emailDefinition.content.customerKey);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('partiallyUpdateSmsDefinition', function() {
+ it('should call partiallyUpdateSmsDefinition successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+ let updatedDefinitionDescription = new SalesforceMarketingCloud.UpdateSmsDefinitionRequest();
+ updatedDefinitionDescription.description = 'Updated SMS definition description';
+
+ let partiallyUpdateSmsDefinitionResult = await transactionalMessagingApiInstance.partiallyUpdateSmsDefinition(createSmsDefinitionResult.definitionKey, updatedDefinitionDescription);
+
+ expect(partiallyUpdateSmsDefinitionResult.description).to.eql(updatedDefinitionDescription.description);
+
+ expect(partiallyUpdateSmsDefinitionResult.definitionKey).to.eql(smsDefinition.definitionKey);
+ expect(partiallyUpdateSmsDefinitionResult.name).to.eql(smsDefinition.name);
+ expect(partiallyUpdateSmsDefinitionResult.content.customerKey).to.eql(smsDefinition.content.customerKey);
+ expect(partiallyUpdateSmsDefinitionResult.content.customerKey).to.eql(smsDefinition.content.customerKey);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('sendEmailToMultipleRecipients', function() {
+ it('should call sendEmailToMultipleRecipients successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+ let recipient1 = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let recipient2 = new SalesforceMarketingCloud.Recipient(JOHANNA_DOE_YAHOO_COM);
+ let recipientsList = [recipient1, recipient2];
+ let batchMessageRequestBody = new SalesforceMarketingCloud.SendEmailToMultipleRecipientsRequest(createEmailDefinitionResult.definitionKey, recipientsList);
+
+ let sendEmailToMultipleRecipientsResult = await transactionalMessagingApiInstance.sendEmailToMultipleRecipients(batchMessageRequestBody);
+
+ expect(sendEmailToMultipleRecipientsResult.requestId).not.be(undefined);
+ expect(sendEmailToMultipleRecipientsResult.errorcode).not.be(undefined);
+ expect(sendEmailToMultipleRecipientsResult.responses).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('sendEmailToSingleRecipient', function() {
+ it('should call sendEmailToSingleRecipient successfully', async ()=> {
+ let emailDefinition = await createEmailDefinitionObject();
+ let createEmailDefinitionResult = await transactionalMessagingApiInstance.createEmailDefinition(emailDefinition);
+ let recipient = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let messageRequestBody = new SalesforceMarketingCloud.SendEmailToSingleRecipientRequest(createEmailDefinitionResult.definitionKey, recipient);
+ let messageKey = getUUID();
+
+ let sendEmailToSingleRecipientResult = await transactionalMessagingApiInstance.sendEmailToSingleRecipient(messageKey, messageRequestBody);
+
+ expect(sendEmailToSingleRecipientResult.requestId).not.be(undefined);
+ expect(sendEmailToSingleRecipientResult.errorcode).not.be(undefined);
+ expect(sendEmailToSingleRecipientResult.responses).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ });
+ });
+ describe('sendSmsToMultipleRecipients', function() {
+ it('should call sendSmsToMultipleRecipients successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+ let recipient1 = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let recipient2 = new SalesforceMarketingCloud.Recipient(JOHANNA_DOE_YAHOO_COM);
+ let recipientsList = [recipient1, recipient2];
+ let batchMessageRequestBody = new SalesforceMarketingCloud.SendSmsToMultipleRecipientsRequest(createSmsDefinitionResult.definitionKey, recipientsList);
+
+ let sendSmsToMultipleRecipientsResult = await transactionalMessagingApiInstance.sendSmsToMultipleRecipients(batchMessageRequestBody);
+
+ expect(sendSmsToMultipleRecipientsResult.requestId).not.be(undefined);
+ expect(sendSmsToMultipleRecipientsResult.errorcode).not.be(undefined);
+ expect(sendSmsToMultipleRecipientsResult.responses).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ describe('sendSmsToSingleRecipient', function() {
+ it('should call sendSmsToSingleRecipient successfully', async ()=> {
+ let smsDefinition = createSmsDefinitionObject();
+ let createSmsDefinitionResult = await transactionalMessagingApiInstance.createSmsDefinition(smsDefinition);
+ let recipient = new SalesforceMarketingCloud.Recipient(JOHN_DOE_GMAIL_COM);
+ let messageRequestBody = new SalesforceMarketingCloud.SendSmsToSingleRecipientRequest(createSmsDefinitionResult.definitionKey, recipient);
+ let messageKey = getUUID();
+
+ let sendSmsToSingleRecipientResult = await transactionalMessagingApiInstance.sendSmsToSingleRecipient(messageKey, messageRequestBody);
+
+ expect(sendSmsToSingleRecipientResult.requestId).not.be(undefined);
+ expect(sendSmsToSingleRecipientResult.errorcode).not.be(undefined);
+ expect(sendSmsToSingleRecipientResult.responses).not.be(undefined);
+
+ await transactionalMessagingApiInstance.deleteSmsDefinition(createSmsDefinitionResult.definitionKey);
+ });
+ });
+ });
+
+ function createSmsDefinitionObject() {
+ let shortCode = environmentConfigProvider.get('SFMC_SHORT_CODE');
+ let countryCode = environmentConfigProvider.get('SFMC_COUNTRY_CODE');
+ let keyword = environmentConfigProvider.get('SFMC_KEYWORD');
+ let smsDefinitionSubscriptions = new SalesforceMarketingCloud.CreateSmsDefinitionSubscriptions(shortCode, countryCode);
+ smsDefinitionSubscriptions.keyword = keyword;
+
+ let smsDefinitionContent = new SalesforceMarketingCloud.CreateSmsDefinitionContent('SMS definition message content');
+
+ let smsDefinitionKey = getUUID(10);
+ let smsDefinitionName = 'SMSdefinition ' + getUUID(10);
+
+ return new SalesforceMarketingCloud.CreateSmsDefinitionRequest(smsDefinitionKey, smsDefinitionName, smsDefinitionContent, smsDefinitionSubscriptions);
+ }
+
+ async function createEmailDefinitionObject() {
+ let asset = createAssetObject();
+
+ let createAssetResponse = await assetApiInstance.createAsset(asset);
+ let customerKey = createAssetResponse.customerKey;
+
+ let emailDefinitionName = 'EmailDefinition ' + getUUID(10);
+ let emailDefinitionKey= 'EmailDefinition ' + getUUID(10);
+ let emailDefinitionContent = new SalesforceMarketingCloud.CreateEmailDefinitionContent(customerKey);
+ let emailDefinitionSubscriptions = new SalesforceMarketingCloud.CreateEmailDefinitionSubscriptions("All Subscribers");
+
+ return new SalesforceMarketingCloud.CreateEmailDefinitionRequest(emailDefinitionName, emailDefinitionKey, emailDefinitionContent, emailDefinitionSubscriptions);
+ }
+
+ function createAssetObject() {
+ let customerKey = getUUID(10);
+ let assetType = new SalesforceMarketingCloud.AssetType(HTML_EMAIL_ASSET_TYPE_ID, 'htmlemail');
+ let assetName = 'Asset ' + getUUID(10);
+ let assetDescription = 'Asset from Automated Node.js SDK';
+ let asset = new SalesforceMarketingCloud.Asset(customerKey, assetType, assetName, assetDescription);
+
+ asset.views = {
+ 'subjectline':{
+ 'content':'New TS Subject Line'
+ }
+ };
+
+ return asset;
+ }
+
+ function getUUID(length){
+
+ return Math.random().toString(16).substring(0, length);
+ }
+}));
diff --git a/test/integration/auth/AuthServiceIntegrationTests.spec.js b/test/integration/auth/AuthServiceIntegrationTests.spec.js
new file mode 100644
index 0000000..d0f95d6
--- /dev/null
+++ b/test/integration/auth/AuthServiceIntegrationTests.spec.js
@@ -0,0 +1,106 @@
+const EnvironmentConfigProvider = require('../../../src/EnvironmentConfigProvider');
+const ClientConfiguration = require('../../../src/Auth/ClientConfiguration');
+const ApiClient = require('../../../src/ApiClient');
+const RuntimeInformationProvider = require('../../../src/RuntimeInformationProvider');
+const AuthService = require('../../../src/Auth/AuthService');
+const CacheService = require('../../../src/Auth/CacheService');
+
+const expect = require('expect.js');
+const sinon = require('sinon');
+
+let authBaseUrl;
+let clientId;
+let clientSecret;
+let accountId;
+let scope;
+
+let environmentConfigProvider;
+let clientConfiguration;
+let apiClient;
+let cacheService;
+let authService;
+
+describe('AuthService', function () {
+
+ before(() => {
+ environmentConfigProvider = new EnvironmentConfigProvider();
+
+ authBaseUrl = environmentConfigProvider.get('SFMC_AUTH_BASE_URL');
+ clientId = environmentConfigProvider.get('SFMC_CLIENT_ID');
+ clientSecret = environmentConfigProvider.get('SFMC_CLIENT_SECRET');
+ accountId = environmentConfigProvider.get('SFMC_ACCOUNT_ID');
+ scope = environmentConfigProvider.get('SFMC_SCOPE', false);
+
+ cacheService = new CacheService();
+ apiClient = new ApiClient(new RuntimeInformationProvider());
+ });
+
+ afterEach(()=>{
+ CacheService.cachedData = {};
+ });
+
+ describe('getTokenResponse', function () {
+ it('should return token response for valid credentials', async () => {
+ clientConfiguration = new ClientConfiguration(authBaseUrl, clientId, clientSecret, accountId, scope);
+ authService = new AuthService(clientConfiguration, apiClient, cacheService);
+
+ let tokenResponse = await authService.getTokenResponse();
+
+ expect(tokenResponse.access_token).not.be(undefined);
+ expect(tokenResponse.rest_instance_url).not.be(undefined);
+ expect(tokenResponse.soap_instance_url).not.be(undefined);
+ expect(tokenResponse.token_type).not.be(undefined);
+ expect(tokenResponse.expires_in).to.be.greaterThan(0);
+ });
+ });
+ describe('getTokenResponse', function () {
+ it('should return Unauthorized error for invalid clientId', async () => {
+ let invalidClientConfiguration = new ClientConfiguration(authBaseUrl, 'invalidClientId', clientSecret, accountId, scope);
+ authService = new AuthService(invalidClientConfiguration, apiClient, cacheService);
+
+ try {
+ await authService.getTokenResponse();
+ } catch (e) {
+ expect(e.status).to.eql(401);
+ }
+ });
+ });
+ describe('getTokenResponse', function () {
+ it('should return Unauthorized error for invalid clientSecret', async () => {
+ let invalidClientConfiguration = new ClientConfiguration(authBaseUrl, clientId, 'invalidClientSecret', accountId, scope);
+ authService = new AuthService(invalidClientConfiguration, apiClient, cacheService);
+
+ try {
+ await authService.getTokenResponse();
+ } catch (e) {
+ expect(e.status).to.eql(401);
+ }
+ });
+ });
+ describe('getTokenResponse', function () {
+ it('should return the same token response object when called multiple times', async () => {
+ clientConfiguration = new ClientConfiguration(authBaseUrl, clientId, clientSecret, accountId, scope);
+ authService = new AuthService(clientConfiguration, apiClient, cacheService);
+
+ let tokenResponse1 = await authService.getTokenResponse();
+ let tokenResponse2 = await authService.getTokenResponse();
+
+ expect(tokenResponse1).to.eql(tokenResponse2);
+ });
+ });
+ describe('getTokenResponse', function () {
+ it('should call only one time the ApiClient callApi method when multiple instances are used', async () => {
+ clientConfiguration = new ClientConfiguration(authBaseUrl, clientId, clientSecret, accountId, scope);
+
+ let authService1 = new AuthService(clientConfiguration, apiClient, cacheService);
+ let authService2 = new AuthService(clientConfiguration, apiClient, cacheService);
+
+ let apiClientSpy = sinon.spy(apiClient, 'callApi');
+
+ await authService1.getTokenResponse();
+ await authService2.getTokenResponse();
+
+ expect(apiClientSpy.calledOnce).to.eql(true);
+ });
+ });
+});
diff --git a/test/integration/exception/ApiExceptionFactoryIntegrationTests.spec.js b/test/integration/exception/ApiExceptionFactoryIntegrationTests.spec.js
new file mode 100644
index 0000000..9b06e20
--- /dev/null
+++ b/test/integration/exception/ApiExceptionFactoryIntegrationTests.spec.js
@@ -0,0 +1,101 @@
+const EnvironmentConfigProvider = require('../../../src/EnvironmentConfigProvider');
+const ClientConfiguration = require('../../../src/Auth/ClientConfiguration');
+const ApiClient = require('../../../src/ApiClient');
+const RuntimeInformationProvider = require('../../../src/RuntimeInformationProvider');
+const AuthService = require('../../../src/Auth/AuthService');
+const CacheService = require('../../../src/Auth/CacheService');
+const AuthenticationFailureException = require('../../../src/Exception/AuthenticationFailureException');
+const ServerUnreachableException = require('../../../src/Exception/ServerUnreachableException');
+const BadRequestException = require('../../../src/Exception/BadRequestException');
+const ResourceNotFoundException = require('../../../src/Exception/ResourceNotFoundException');
+const ApiSutFactory = require('../api/ApiSutFactory');
+const AssetApi = require('../../../src/Api/AssetApi');
+
+const expect = require('expect.js');
+
+let authBaseUrl;
+let clientId;
+let clientSecret;
+let accountId;
+let scope;
+
+let environmentConfigProvider;
+let apiClient;
+let cacheService;
+let authService;
+let assetApiInstance;
+let clientConfiguration;
+
+describe('ApiExceptionFactory', function () {
+ before(() => {
+ environmentConfigProvider = new EnvironmentConfigProvider();
+
+ authBaseUrl = environmentConfigProvider.get('SFMC_AUTH_BASE_URL');
+ clientId = environmentConfigProvider.get('SFMC_CLIENT_ID');
+ clientSecret = environmentConfigProvider.get('SFMC_CLIENT_SECRET');
+ accountId = environmentConfigProvider.get('SFMC_ACCOUNT_ID');
+ scope = environmentConfigProvider.get('SFMC_SCOPE', false);
+
+ cacheService = new CacheService();
+ apiClient = new ApiClient(new RuntimeInformationProvider());
+ assetApiInstance = new ApiSutFactory(AssetApi.prototype.constructor).create();
+ clientConfiguration = new ClientConfiguration(authBaseUrl, clientId, clientSecret, accountId, scope);
+ });
+
+ describe('createCustomException', function () {
+ it('should return AuthenticationFailureException for invalid clientId', async () => {
+ let invalidClientIdConfig = new ClientConfiguration(authBaseUrl, 'invalidClientId', clientSecret, accountId, scope);
+ authService = new AuthService(invalidClientIdConfig, apiClient, cacheService);
+
+ try {
+ await authService.getTokenResponse();
+ } catch (e) {
+ expect(e).to.be.an(AuthenticationFailureException);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return BadRequestException when number passed for clientId', async () => {
+ let invalidClientSecretConfig = new ClientConfiguration(authBaseUrl, 3.141592, clientSecret, accountId, scope);
+ authService = new AuthService(invalidClientSecretConfig, apiClient, cacheService);
+
+ try {
+ await authService.getTokenResponse();
+ } catch (e) {
+ expect(e).to.be.an(BadRequestException);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return ServerUnreachableException for invalid authBaseUrl', async () => {
+ let invalidClientSecretConfig = new ClientConfiguration('invalidAuthBaseUrl', clientId, clientSecret, accountId, scope);
+ authService = new AuthService(invalidClientSecretConfig, apiClient, cacheService);
+
+ try {
+ await authService.getTokenResponse();
+ } catch (e) {
+ expect(e).to.be.an(ServerUnreachableException);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return ResourceNotFoundException for GET on invalid asset id', async () => {
+ try {
+ let randomInt = getRandomInt(7);
+ await assetApiInstance.getAssetById(randomInt);
+ } catch (e) {
+ expect(e).to.be.an(ResourceNotFoundException);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ });
+});
+
+function getRandomInt(length){
+ return Math.floor(Math.random() * Math.pow(10, length));
+}
diff --git a/test/samples/ConfigurationObjectClient.js b/test/samples/ConfigurationObjectClient.js
new file mode 100644
index 0000000..b4976a3
--- /dev/null
+++ b/test/samples/ConfigurationObjectClient.js
@@ -0,0 +1,59 @@
+const Client = require('../../src/Api/Client');
+const SampleHelper = require('./SampleHelper');
+const SalesforceMarketingCloud = require('../../src');
+
+(async () => {
+ // Replace 'CONTACT_KEY' with a real subscriber key
+ const CONTACT_KEY = 'CONTACT_KEY';
+
+ // Replace the values in the following object with your Marketing Cloud account credentials
+ const CONFIGURATION_OBJECT = {
+ authBaseUrl: 'YOUR AUTH BASE URL',
+ clientId: 'YOUR CLIENT ID',
+ clientSecret: 'YOUR CLIENT SECRET',
+ accountId: 'YOUR ACCOUNT ID'
+ };
+
+ // Configuration object instantiated client:
+ let client = new Client(CONFIGURATION_OBJECT);
+
+ // Get the the asset, transactional messaging API instances:
+ let assetApi = client.assetApi;
+ let transactionalMessagingApi = client.transactionalMessagingApi;
+
+ // Create email send definition:
+ let emailDefinitionObject = await SampleHelper.createEmailDefinitionObject(assetApi);
+ let createEmailDefinitionResult = await transactionalMessagingApi.createEmailDefinition(emailDefinitionObject);
+ console.log('createEmailDefinitionResult: ' + JSON.stringify(createEmailDefinitionResult));
+
+ // Get email send definition:
+ let getEmailDefinitionsResult = await transactionalMessagingApi.getEmailDefinition(createEmailDefinitionResult.definitionKey);
+ console.log('getEmailDefinitionsResult: ' + JSON.stringify(getEmailDefinitionsResult));
+
+ // Update email send definition:
+ let updatedDefinitionDescription = new SalesforceMarketingCloud.UpdateEmailDefinitionRequest();
+ updatedDefinitionDescription.description = 'Updated email definition description';
+
+ let partiallyUpdateEmailDefinitionResult = await transactionalMessagingApi.partiallyUpdateEmailDefinition(createEmailDefinitionResult.definitionKey, updatedDefinitionDescription);
+ console.log('partiallyUpdateEmailDefinitionResult: ' + JSON.stringify(partiallyUpdateEmailDefinitionResult));
+
+ // Get email send definition:
+ getEmailDefinitionsResult = await transactionalMessagingApi.getEmailDefinition(createEmailDefinitionResult.definitionKey);
+ console.log('getEmailDefinitionsResult: ' + JSON.stringify(getEmailDefinitionsResult));
+
+ // Send email to single recipient:
+ let recipient = new SalesforceMarketingCloud.Recipient(CONTACT_KEY);
+
+ let messageKey = SampleHelper.getUUID(5);
+ let messageRequestBody = new SalesforceMarketingCloud.SendEmailToSingleRecipientRequest(createEmailDefinitionResult.definitionKey, recipient);
+ let sendEmailToSingleRecipientResult = await transactionalMessagingApi.sendEmailToSingleRecipient(messageKey, messageRequestBody);
+ console.log('sendEmailToSingleRecipientResult: ' + JSON.stringify(sendEmailToSingleRecipientResult));
+
+ // Get the send status of the email send:
+ let recipientSendStatus = await transactionalMessagingApi.getEmailSendStatusForRecipient(messageKey);
+ console.log('send status for recipient: ' + JSON.stringify(recipientSendStatus));
+
+ // Delete email send definition:
+ let deleteEmailDefinitionResult = await transactionalMessagingApi.deleteEmailDefinition(createEmailDefinitionResult.definitionKey);
+ console.log('deleteEmailDefinitionResult: ' + JSON.stringify(deleteEmailDefinitionResult));
+})();
\ No newline at end of file
diff --git a/test/samples/EnvironmentVariablesClient.js b/test/samples/EnvironmentVariablesClient.js
new file mode 100644
index 0000000..c7a4711
--- /dev/null
+++ b/test/samples/EnvironmentVariablesClient.js
@@ -0,0 +1,38 @@
+const Client = require('../../src/Api/Client');
+const SampleHelper = require('./SampleHelper');
+const SalesforceMarketingCloud = require('../../src');
+
+(async () => {
+ // Replace 'CONTACT1_KEY' and 'CONTACT2_KEY' with real subscriber keys
+ const CONTACT1_KEY = 'CONTACT1_KEY';
+ const CONTACT2_KEY = 'CONTACT2_KEY';
+
+ // Environment variables instantiated client:
+ let client = new Client();
+
+ // Get the asset, transactional messaging API instances:
+ let assetApi = client.assetApi;
+ let transactionalMessagingApi = client.transactionalMessagingApi;
+
+ // Create email send definition:
+ let emailDefinitionObject = await SampleHelper.createEmailDefinitionObject(assetApi);
+ let createEmailDefinitionResult = await transactionalMessagingApi.createEmailDefinition(emailDefinitionObject);
+ console.log('createEmailDefinitionResult: ' + JSON.stringify(createEmailDefinitionResult));
+
+ // Send email to multiple recipients:
+ let recipient1 = new SalesforceMarketingCloud.Recipient(CONTACT1_KEY);
+ let recipient2 = new SalesforceMarketingCloud.Recipient(CONTACT2_KEY);
+ recipient1.messageKey = SampleHelper.getUUID(5);
+ recipient2.messageKey = SampleHelper.getUUID(5);
+ let recipientsList = [recipient1, recipient2];
+
+ let batchMessageRequestBody = new SalesforceMarketingCloud.SendEmailToMultipleRecipientsRequest(createEmailDefinitionResult.definitionKey, recipientsList);
+ let sendEmailToMultipleRecipientsResult = await transactionalMessagingApi.sendEmailToMultipleRecipients(batchMessageRequestBody);
+ console.log('sendEmailToMultipleRecipientsResult: ' + JSON.stringify(sendEmailToMultipleRecipientsResult));
+
+ // Get the send status of the two email sends:
+ let recipient1_sendStatus = await transactionalMessagingApi.getEmailSendStatusForRecipient(recipient1.messageKey);
+ let recipient2_sendStatus = await transactionalMessagingApi.getEmailSendStatusForRecipient(recipient2.messageKey);
+ console.log('send status for recipient1: ' + JSON.stringify(recipient1_sendStatus));
+ console.log('send status for recipient2: ' + JSON.stringify(recipient2_sendStatus));
+})();
\ No newline at end of file
diff --git a/test/samples/SampleHelper.js b/test/samples/SampleHelper.js
new file mode 100644
index 0000000..c2b67a8
--- /dev/null
+++ b/test/samples/SampleHelper.js
@@ -0,0 +1,49 @@
+const Asset = require('../../src/Model/Asset');
+const AssetType = require('../../src/Model/AssetType');
+const SalesforceMarketingCloud = require('../../src');
+
+class SampleHelper {
+ static createEmailAsset() {
+ let customerKey = 'EmailAssetCustomerKey' + SampleHelper.getUUID(5); // it has be unique
+ let assetName = 'EmailAssetName' + SampleHelper.getUUID(5); // it has be unique
+ let assetDescription = 'EmailAsset created from automated Node.js SDK';
+
+ const HTML_EMAIL_ASSET_TYPE_ID = 208;
+ const ASSET_TYPE_NAME = 'htmlemail';
+ let assetType = new AssetType(HTML_EMAIL_ASSET_TYPE_ID, ASSET_TYPE_NAME);
+
+ let asset = new Asset(customerKey, assetType, assetName, assetDescription);
+
+ /* An email asset has to have at least these minimal
+ properties set in order for the send definition to become active*/
+
+ asset.views = {
+ 'subjectline': {
+ 'content': 'New TS Subject Line'
+ }
+ };
+ return asset;
+ }
+
+ static async createEmailDefinitionObject(assetApi) {
+ /* Replace 'SUBSCRIBERS-LIST-KEY' with the key of
+ one of your subscribers lists or use 'All Subscribers'*/
+ const SUBSCRIBERS_LIST_KEY = 'SUBSCRIBERS_LIST_KEY';
+
+ let asset = SampleHelper.createEmailAsset();
+ let createAssetResponse = await assetApi.createAsset(asset);
+ let customerKey = createAssetResponse.customerKey;
+ let emailDefinitionName = 'EmailDefinitionName' + SampleHelper.getUUID(5); // it has be unique
+ let emailDefinitionKey = 'EmailDefinitionKey' + SampleHelper.getUUID(5); // it has be unique
+ let emailDefinitionContent = new SalesforceMarketingCloud.CreateEmailDefinitionContent(customerKey);
+ let emailDefinitionSubscriptions = new SalesforceMarketingCloud.CreateEmailDefinitionSubscriptions(SUBSCRIBERS_LIST_KEY);
+
+ return new SalesforceMarketingCloud.CreateEmailDefinitionRequest(emailDefinitionName, emailDefinitionKey, emailDefinitionContent, emailDefinitionSubscriptions);
+ }
+
+ static getUUID(length) {
+ return Math.random().toString(16).substring(0, length);
+ }
+}
+
+module.exports = SampleHelper;
\ No newline at end of file
diff --git a/test/unit/Client.spec.js b/test/unit/Client.spec.js
new file mode 100644
index 0000000..cd78a63
--- /dev/null
+++ b/test/unit/Client.spec.js
@@ -0,0 +1,102 @@
+const Client = require('../../src/Api/Client');
+const TestHelper = require('../TestHelper');
+
+(function (root, factory) {
+ factory(require('expect.js'), require('../../src'));
+}(this, function (expect, SalesforceMarketingCloud) {
+ 'use strict';
+
+ describe('Client', function () {
+
+ let client;
+ let configMock;
+
+ before(() => {
+ configMock = TestHelper.createConfigProvider();
+ client = new Client();
+ });
+
+ describe('assetApi getter', function () {
+ it('should return a AssetApi instance', () => {
+ let assetApi = client.assetApi;
+
+ expect(assetApi).to.be.a(SalesforceMarketingCloud.AssetApi);
+ });
+ it('should return the same AssetApi instance ', () => {
+ let assetApi1 = client.assetApi;
+ let assetApi2 = client.assetApi;
+
+ expect(assetApi1).to.be(assetApi2);
+ });
+ });
+ describe('campaignApi getter', function () {
+ it('should return a CampaignApi instance', () => {
+ let campaignApi = client.campaignApi;
+
+ expect(campaignApi).to.be.a(SalesforceMarketingCloud.CampaignApi);
+ });
+ it('should return the same CampaignApi instance', function () {
+ let campaignApi1 = client.campaignApi;
+ let campaignApi2 = client.campaignApi;
+
+ expect(campaignApi1).to.be(campaignApi2);
+ });
+ });
+ describe('transactionalMessagingApi getter', function () {
+ it('should return a TransactionalMessagingApi instance', () => {
+ let transactionalMessagingApi = client.transactionalMessagingApi;
+
+ expect(transactionalMessagingApi).to.be.a(SalesforceMarketingCloud.TransactionalMessagingApi);
+ });
+ it('should return the same TransactionalMessagingApi instance', function () {
+ let transactionalMessagingApi1 = client.transactionalMessagingApi;
+ let transactionalMessagingApi2 = client.transactionalMessagingApi;
+
+ expect(transactionalMessagingApi1).to.be(transactionalMessagingApi2);
+ });
+ });
+ describe('constructor', function () {
+ it('should set the config parameters from env. variables when called with no passed in parameter', function () {
+ let configBackup = getEnvVariables();
+ setEnvVariables(configMock);
+
+ client = new Client();
+
+ expect(client.getAuthBaseUrl()).to.eql(configMock.authBaseUrl);
+ expect(client.getClientId()).to.eql(configMock.clientId);
+ expect(client.getClientSecret()).to.eql(configMock.clientSecret);
+ expect(client.getAccountId()).to.eql(configMock.accountId);
+ expect(client.getScope()).to.eql(configMock.scope);
+
+ setEnvVariables(configBackup);
+ });
+ it('should set the config parameters from the passed in parameter when used', function () {
+ client = new Client(configMock);
+
+ expect(client.getAuthBaseUrl()).to.eql(configMock.authBaseUrl);
+ expect(client.getClientId()).to.eql(configMock.clientId);
+ expect(client.getClientSecret()).to.eql(configMock.clientSecret);
+ expect(client.getAccountId()).to.eql(configMock.accountId);
+ expect(client.getScope()).to.eql(configMock.scope);
+ });
+ })
+ });
+
+ function setEnvVariables(config) {
+ process.env.SFMC_AUTH_BASE_URL = config.authBaseUrl;
+ process.env.SFMC_CLIENT_ID = config.clientId;
+ process.env.SFMC_CLIENT_SECRET = config.clientSecret;
+ process.env.SFMC_ACCOUNT_ID = config.accountId;
+ process.env.SFMC_SCOPE = config.scope;
+ }
+
+ function getEnvVariables() {
+ return{
+ authBaseUrl: process.env.SFMC_AUTH_BASE_URL,
+ clientId: process.env.SFMC_CLIENT_ID,
+ clientSecret: process.env.SFMC_CLIENT_SECRET,
+ accountId: process.env.SFMC_ACCOUNT_ID,
+ scope: process.env.SFMC_SCOPE
+ }
+ }
+}));
diff --git a/test/unit/ClientSideValidation.spec.js b/test/unit/ClientSideValidation.spec.js
new file mode 100644
index 0000000..651a1f8
--- /dev/null
+++ b/test/unit/ClientSideValidation.spec.js
@@ -0,0 +1,81 @@
+const Campaign = require('../../src/Model/Campaign');
+const InvalidModelException = require('../../src/Exception/InvalidModelException');
+
+const expect = require('expect.js');
+
+describe('Campaign', function () {
+ describe('constructor', function () {
+
+ let properties;
+ const exceptionReasons = [undefined, null];
+ const requiredProperties = ['name', 'description', 'campaignCode', 'color', 'favorite'];
+
+ beforeEach(() => {
+ properties = {
+ name: 'validName',
+ description: 'validDescription',
+ campaignCode: 'validCampaignCode',
+ color: '0000ff', // valid color value
+ favorite: true // valid favorite value
+ };
+ });
+
+ exceptionReasons.forEach((exceptionReason) => {
+ requiredProperties.forEach((requiredProperty) => {
+ it(`should return InvalidModelException for ${exceptionReason} ${requiredProperty}`, function () {
+
+ properties[requiredProperty] = exceptionReason;
+
+ try {
+ new Campaign(properties.name, properties.description, properties.campaignCode, properties.color, properties.favorite);
+ } catch (e) {
+ expect(e).to.be.an(InvalidModelException);
+ expect(e.message).to.eql(`"${requiredProperty}" is a required property for Campaign and cannot be undefined or null`);
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ })
+ })
+ });
+ it('should return InvalidModelException for Campaign name longer than 128 characters', function () {
+ let invalidCampaignName = '#'.repeat(129);
+
+ try {
+ new Campaign(invalidCampaignName, properties.description, properties.campaignCode, properties.color, properties.favorite);
+ } catch (e) {
+ expect(e).to.be.an(InvalidModelException);
+ expect(e.message).to.eql('invalid length for "name". It must be smaller than or equal to 128.');
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return InvalidModelException for Campaign description longer than 512 characters', function () {
+ let invalidCampaignDescription = '#'.repeat(513);
+
+ try {
+ new Campaign(properties.name, invalidCampaignDescription, properties.campaignCode, properties.color, properties.favorite);
+ } catch (e) {
+ expect(e).to.be.an(InvalidModelException);
+ expect(e.message).to.eql('invalid length for "description". It must be smaller than or equal to 512.');
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return InvalidModelException for Campaign campaignCode longer than 36 characters', function () {
+ let invalidCampaignCampaignCode = '#'.repeat(37);
+
+ try {
+ new Campaign(properties.name, properties.description, invalidCampaignCampaignCode, properties.color, properties.favorite);
+ } catch (e) {
+ expect(e).to.be.an(InvalidModelException);
+ expect(e.message).to.eql('invalid length for "campaignCode". It must be smaller than or equal to 36.');
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ });
+});
\ No newline at end of file
diff --git a/test/unit/EnvironmentConfigProvider.spec.js b/test/unit/EnvironmentConfigProvider.spec.js
new file mode 100644
index 0000000..b1d4d65
--- /dev/null
+++ b/test/unit/EnvironmentConfigProvider.spec.js
@@ -0,0 +1,41 @@
+const expect = require('expect.js');
+const EnvironmentConfigProvider = require('../../src/EnvironmentConfigProvider');
+const EnvironmentVariableNotSetException = require('../../src/Exception/EnvironmentVariableNotSetException');
+
+describe('EnvironmentConfigProvider', function () {
+
+ let environmentConfigProvider;
+
+ before(() => {
+ environmentConfigProvider = new EnvironmentConfigProvider();
+ });
+
+ describe('get', function () {
+ it('should return a environment variable if set', function () {
+ let authBaseUrlEnvVariableBackup = process.env.SFMC_AUTH_BASE_URL;
+ process.env.SFMC_AUTH_BASE_URL = 'authBaseUrl';
+
+ let authBaseUrlEnvVariable = environmentConfigProvider.get('SFMC_AUTH_BASE_URL');
+
+ expect(authBaseUrlEnvVariable).to.eql('authBaseUrl');
+
+ process.env.SFMC_AUTH_BASE_URL = authBaseUrlEnvVariableBackup;
+ });
+ it('should throw a EnvironmentVariableNotSetException for an unset, mandatory variable', function () {
+ try {
+ environmentConfigProvider.get('notExistingEnvironmentVariable');
+ } catch (e) {
+ expect(e).to.be.an(EnvironmentVariableNotSetException);
+ expect(e.message).to.eql('Environment variable notExistingEnvironmentVariable is not set');
+
+ return
+ }
+ expect().fail('Exception was not thrown');
+ });
+ it('should return null for an unset, not mandatory variable', function () {
+ let authBaseUrlEnvVariable = environmentConfigProvider.get('notExistingEnvironmentVariable', false);
+
+ expect(authBaseUrlEnvVariable).to.eql(null);
+ });
+ })
+});
\ No newline at end of file
diff --git a/test/unit/auth/AuthServiceUnitTests.spec.js b/test/unit/auth/AuthServiceUnitTests.spec.js
new file mode 100644
index 0000000..6af9ac8
--- /dev/null
+++ b/test/unit/auth/AuthServiceUnitTests.spec.js
@@ -0,0 +1,67 @@
+const CacheService = require('../../../src/Auth/CacheService');
+const TestHelper = require('../../TestHelper');
+const ApiClient = require('../../../src/ApiClient');
+const AuthService = require('../../../src/Auth/AuthService');
+
+const expect = require('expect.js');
+const sinon = require('sinon');
+
+const date = new Date(2000, 1, 1).getTime();
+
+let cacheService;
+let clientConfiguration;
+let tokenResponseData;
+let apiClientStub;
+let clock;
+
+describe('AuthService', function () {
+ before(() => {
+ clientConfiguration = TestHelper.createClientConfiguration();
+ tokenResponseData = TestHelper.createTokenResponseData();
+ cacheService = new CacheService();
+ });
+
+ beforeEach(() => {
+ apiClientStub = sinon.createStubInstance(ApiClient, {
+ callApi: tokenResponseData
+ });
+ clock = sinon.useFakeTimers(date);
+ });
+
+ afterEach(() => {
+ CacheService.cachedData = {};
+ apiClientStub.callApi.restore();
+ clock.restore();
+ });
+
+ describe('getTokenResponse', function () {
+ it('should execute the callApi method when there is no cached value for a cache key', async () => {
+ let authService = new AuthService(clientConfiguration, apiClientStub, cacheService);
+
+ await authService.getTokenResponse();
+
+ expect(apiClientStub.callApi.calledOnce).to.eql(true);
+ });
+ it('should execute the callApi method when the cached value for a cache key is expired', async () => {
+ let authService = new AuthService(clientConfiguration, apiClientStub, cacheService);
+
+ await authService.getTokenResponse();
+ let invalidCacheWindowInSeconds = 30;
+ let validCacheWindowInMs = (tokenResponseData.expires_in - invalidCacheWindowInSeconds) * 1000;
+ // making the cached data corresponding to cacheKey to have the expirationTime equal to the current time, thus invalid
+ clock.tick(validCacheWindowInMs);
+ await authService.getTokenResponse();
+
+ expect(apiClientStub.callApi.calledTwice).to.eql(true);
+ });
+ it('should execute exactly one time the callApi method when multiple instances are used', async () => {
+ let authService1 = new AuthService(clientConfiguration, apiClientStub, cacheService);
+ let authService2 = new AuthService(clientConfiguration, apiClientStub, cacheService);
+
+ await authService1.getTokenResponse();
+ await authService2.getTokenResponse();
+
+ expect(apiClientStub.callApi.calledOnce).to.eql(true);
+ })
+ });
+});
diff --git a/test/unit/auth/CacheServiceUnitTests.spec.js b/test/unit/auth/CacheServiceUnitTests.spec.js
new file mode 100644
index 0000000..7c616d7
--- /dev/null
+++ b/test/unit/auth/CacheServiceUnitTests.spec.js
@@ -0,0 +1,67 @@
+const CacheService = require('../../../src/Auth/CacheService');
+const TestHelper = require('../../TestHelper');
+
+const expect = require('expect.js');
+const sinon = require('sinon');
+
+describe('CacheService', function () {
+ const cacheKey = 'cacheKey';
+ const date = new Date(2000, 1, 1).getTime();
+
+ let cacheService;
+ let clock;
+ let tokenResponseData;
+
+ before(() => {
+ cacheService = new CacheService();
+ tokenResponseData = TestHelper.createTokenResponseData();
+ });
+
+ beforeEach(() => {
+ clock = sinon.useFakeTimers(date);
+ });
+
+ afterEach(() => {
+ CacheService.cachedData = {};
+ clock.restore();
+ });
+
+ describe('get', function () {
+ it('should return null when passed parameter is not a key in the cache', function () {
+ expect(cacheService.get(cacheKey)).to.eql(null);
+ });
+ it('should return the cached value when the passed parameter is a cache key and the corresponding cache not expired', function () {
+ cacheService.addOrUpdate(cacheKey, tokenResponseData.data);
+
+ let cachedTokenResponseData = cacheService.get(cacheKey);
+
+ expect(cachedTokenResponseData.tokenResponse.access_token).to.eql('access_token');
+ expect(cachedTokenResponseData.tokenResponse.expires_in).to.be.greaterThan(0);
+ expect(cachedTokenResponseData.tokenResponse.rest_instance_url).to.eql('rest_instance_url');
+ expect(cachedTokenResponseData.tokenResponse.soap_instance_url).to.eql('soap_instance_url');
+ expect(cachedTokenResponseData.tokenResponse.scope).to.eql('scope');
+ expect(cachedTokenResponseData.tokenResponse.token_type).to.eql('Bearer');
+ });
+ it('should return null when the passed parameter is a cache key and the corresponding cache is expired', function () {
+ cacheService.addOrUpdate(cacheKey, tokenResponseData);
+ let invalidCacheWindowInSeconds = 30;
+ let validCacheWindowInMs = (tokenResponseData.expires_in - invalidCacheWindowInSeconds) * 1000;
+ // making the cached data corresponding to cacheKey to have the expirationTime equal to the current time, thus invalid
+ clock.tick(validCacheWindowInMs);
+
+ let cachedTokenResponseData = cacheService.get(cacheKey);
+
+ expect(cachedTokenResponseData).to.eql(null);
+ });
+ });
+ describe('addOrUpdate', function () {
+ it('should overwrite cached value when called two times for the same key', function () {
+ cacheService.addOrUpdate(cacheKey, tokenResponseData.data);
+ let firstCachedTokenResponseData = cacheService.get(cacheKey);
+ cacheService.addOrUpdate(cacheKey, tokenResponseData.data);
+ let secondCachedTokenResponseData = cacheService.get(cacheKey);
+
+ expect(secondCachedTokenResponseData).not.to.equal(firstCachedTokenResponseData);
+ });
+ });
+});
\ No newline at end of file
diff --git a/test/unit/exception/ApiExceptionFactoryUnitTests.spec.js b/test/unit/exception/ApiExceptionFactoryUnitTests.spec.js
new file mode 100644
index 0000000..87cf066
--- /dev/null
+++ b/test/unit/exception/ApiExceptionFactoryUnitTests.spec.js
@@ -0,0 +1,50 @@
+const TestHelper = require('../../TestHelper');
+const ApiExceptionFactory = require('../../../src/Exception/ApiExceptionFactory');
+
+const expect = require('expect.js');
+
+describe('ApiExceptionFactory', function () {
+
+ const callApiCallerMethod = 'callApiCallerMethod';
+ const exceptions = [
+ {BadRequestException: 400},
+ {AuthenticationFailureException: 401},
+ {UnauthorizedAccessException: 403},
+ {ResourceNotFoundException: 404},
+ {InternalServerErrorException: 500},
+ {BadGatewayException: 502},
+ {ServiceUnavailableException: 503},
+ {GatewayTimeoutException: 504},
+ {ApiException: 418}
+ ];
+
+ describe('createCustomException', function () {
+ exceptions.forEach((exception) => {
+
+ let exceptionObjKey = Object.keys(exception)[0];
+ let exceptionObjValue = exception[exceptionObjKey];
+
+ it(`should return ${exceptionObjKey} for a ${exceptionObjValue} status code in the request response`, function () {
+ let requestResponse = TestHelper.createRequestResponse(exceptionObjValue);
+ let expectedExceptionMessage = `Error calling ${callApiCallerMethod}: "${requestResponse.response.body}"`;
+ let expectedExceptionName = `Salesforce.MarketingCloud.Exceptions.${exceptionObjKey}`;
+
+ let returnedException = ApiExceptionFactory.createCustomException(callApiCallerMethod, requestResponse);
+
+ expect(returnedException.name).to.eql(expectedExceptionName);
+ expect(returnedException.message).to.eql(expectedExceptionMessage);
+ expect(returnedException.status).to.eql(exceptionObjValue);
+ });
+ });
+ it('should return ServerUnreachableException when status code is undefined', function () {
+ let serverUnreachableError = TestHelper.createServerUnreachableError();
+ let expectedExceptionMessage = `Error calling ${callApiCallerMethod}: ${JSON.stringify(serverUnreachableError)}`;
+ let expectedExceptionName = `Salesforce.MarketingCloud.Exceptions.ServerUnreachableException`;
+
+ let returnedException = ApiExceptionFactory.createCustomException(callApiCallerMethod, serverUnreachableError);
+
+ expect(returnedException.name).to.eql(expectedExceptionName);
+ expect(returnedException.message).to.eql(expectedExceptionMessage);
+ });
+ });
+});
\ No newline at end of file