connectwise-rest 0.25.1 → 1.0.2

package/src/SystemAPI/Members.js

@@ -1,139 +0,0 @@
-/**
- * Created by kgrube on 12/15/2015.
- * @author kgrube
- */
-
-/**
- *
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Member
- * @property id
- * @property {boolean} adminFlag
- * @property billableForecast
- * @property {CalendarHref} calendar
- * @property {CountryHref} country
- * @property dailyCapacity
- * @property defaultEmail
- * @property {ProjectBoardHref} defaultProjectBoard
- * @property defaultProjectDepartmentId
- * @property defaultProjectLocationId
- * @property defaultSalesLocationId
- * @property defaultScheduleDepartmentId
- * @property defaultScheduleLocationId
- * @property {ServiceBoardHref} defaultServiceBoard
- * @property defaultServiceDepartmentId
- * @property defaultServiceLocationId
- * @property defaultSystemDepartmentId
- * @property defaultSystemLocationId
- * @property {boolean} disableOnlineFlag
- * @property emailAddress
- * @property enableGpsFlag
- * @property enableLdapAuthenticationFlag
- * @property enableMobileFlag
- * @property {MemberHref} expenseApprover
- * @property {string} firstName
- * @property {boolean} hideFromDispatchFlag
- * @property {string} hireDate
- * @property homeEmail
- * @property homeExtension
- * @property homePhone
- * @property identifier
- * @property inactiveDate
- * @property {boolean} inactiveFlag
- * @property lastName
- * @property {string} licenseClass
- * @property middleInitial
- * @property mobileEmail
- * @property mobileExtension
- * @property mobilePhone
- * @property notes
- * @property officeEmail
- * @property officeExtension
- * @property officePhone
- * @property {MemberHref} reportsTo
- * @property restrictDefaultSalesTerritoryFlag
- * @property restrictDefaultWarehouseBinFlag
- * @property restrictDefaultWarehouseFlag
- * @property restrictProjectDefaultDepartmentFlag
- * @property restrictProjectDefaultLocationFlag
- * @property restrictScheduleFlag
- * @property restrictServiceDefaultDepartmentFlag
- * @property restrictServiceDefaultLocationFlag
- * @property scheduleCapacity
- * @property {SecurityRoleHref} securityRole
- * @property securityLevel
- * @property securityLocationId
- * @property serviceLocation
- * @property serviceTeams
- * @property systemRestrictToDefaultDepartmentFlag
- * @property systemRestrictToDefaultLocationFlag
- * @property {MemberHref} timeApprover
- * @property {TimeZoneHref} timeZone
- * @property title
- * @property {MemberTypeHref} type
- * @property vendorNumber
- * @property warehouse
- * @property warehouseBin
- * @property {WorkRoleHref} workRole
- * @property {WorkTypeHref} workType
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- * @property {string} _info.image_href
- */
-
-/**
- *
- * @param {CWOptions} options
- * @constructor
- */
-function Members(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(Members, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<Member[]>}
- */
-Members.prototype.getMembers = function (params) {
-  return this.api('/system/members', 'GET', params);
-};
-
-
-/**
- * GET
- * @param {string} identifier
- * @returns {Promise<Member>}
- */
-Members.prototype.getMemberByIdentifier = function (identifier) {
-  return this.api(`/system/members/${identifier}`, 'GET');
-};
-/**
- * Alias for getMemberByIdentifier because I keep spelling it wrong
- * @param identifier
- * @returns {Promise<Member>}
- */
-Members.prototype.getMemberByIdentifer = Members.prototype.getMemberByIdentifier;
-
-/**
- *
- * @param identifier
- * @param {ParamsImage} params
- * @returns {Promise<*>}
- */
-Members.prototype.getMemberImage = function (identifier, params) {
-  return this.api(`/system/members/${identifier}/image`, 'GET', params)
-};
-
-/**
- *
- * @type {Members}
- */
-module.exports = Members;

package/src/SystemAPI/Reports.js

@@ -1,116 +0,0 @@
-/**
- * Created by kgrube on 12/28/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise');
-
-/**
- * @typedef {object} ReportNames
- * @property {string} name
- */
-
-/**
- * row_values is not a keyed array
- * @typedef {object} ReportData
- * @property {object[]} column_definitions
- * @property {Array} row_values mixed types, may be null, string, numeric, etc
- */
-
-/**
- * Key-Vals interpolated into one object per row
- * @typedef {object} ReportDataInterpolated
- */
-
-/**
- *
- * @typedef {object} ReportColumn
- * @property {object} ColumnName the key of the object is the name of the column (not ColumnName)
- * @property {boolean} ColumnName.isNullable
- * @property {string} ColumnName.type ['Numeric', 'Text', 'DateTime', 'Boolean']
- */
-
-/**
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Reports(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(Reports, ConnectWise);
-
-function reportInterpolate() {
-  const data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {column_definitions: [], row_values: []};
-
-  /* report data comes in like this:
-   *  {
-   *    column_definitions: [{ ColumnName: { DataType: 'number', IsNullable: true/false } } ... { ... } ],
-   *    row_values: [ [1, 2, 'some string', '1900-01-01etc', null, null, false, ... ], [ ... ] ]
-   *  }
-   */
-
-  const column_definitions = data.column_definitions;
-  const row_values = data.row_values;
-
-  return row_values.map(function (rowArray) {
-    const rowObj = {};
-    rowArray.forEach(function (value, idx) {
-      const key = Object.keys(column_definitions[idx])[0];
-      rowObj[key] = value;
-    });
-    return rowObj;
-  });
-  // return an array like: [ { key: value, key2: value2 ... }, ... ]
-}
-
-/**
- * @param {ParamsConditions} [params]
- * @returns {Promise<ReportNames[]>}
- */
-Reports.prototype.getReports = function (params) {
-  return this.api('/system/reports', 'GET', params);
-};
-
-/**
- *
- * @param {string} reportName
- * @param {Params} [params]
- * @param {boolean} [disableInterpolate]
- * @returns {Promise<ReportData[]|ReportDataInterpolated[]>}
- */
-Reports.prototype.getReport = function (reportName, params, disableInterpolate) {
-  return this.api(`/system/reports/${reportName}/`, 'GET', params)
-    .then(function (data) {
-      if (disableInterpolate) return data;
-      return reportInterpolate(data);
-    });
-};
-
-/**
- *
- * @param {string} reportName
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Reports.prototype.getReportResultsCount = function (reportName, params) {
-  return this.api(`/system/reports/${reportName}/count`, 'GET', params);
-};
-
-/**
- *
- * @param reportName
- * @returns {Promise<ReportColumn[]>}
- */
-Reports.prototype.getColumnDefinitions = function (reportName) {
-  return this.api(`/system/reports/${reportName}/columns`, 'GET');
-};
-
-/**
- *
- * @type {Reports}
- */
-module.exports = Reports;

package/src/SystemAPI/index.js

@@ -1,32 +0,0 @@
-/**
- * Created by kgrube on 7/14/2016.
- * @author kgrube
- */
-
-/**
- * @typedef {object} SystemAPI
- * @property {Members} Members
- * @property {Reports} Reports
- */
-
-/**
- *
- * @param {CWOptions} options
- * @returns {SystemAPI}
- * @constructor
- */
-function SystemAPI(options) {
-  const _Members = require('./Members');
-  const _Reports = require('./Reports');
-
-  return {
-    Members: new _Members(options),
-    Reports: new _Reports(options)
-  }
-}
-
-/**
- *
- * @type {SystemAPI}
- */
-module.exports = SystemAPI;

package/src/TimeAPI/TimeEntries.js

@@ -1,121 +0,0 @@
-/**
- * Created by kgrube on 12/20/2015.
- * @author kgrube
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} TimeEntry
- * @property {number} id
- * @property {CompanyHref} company
- * @property {number} chargeToId
- * @property {string} chargeToType ['ServiceTicket', 'ProjectTicket', 'ChargeCode', 'Activity']
- * @property {MemberHref} member
- * @property {number} locationId
- * @property {number} businessUnitId
- * @property {WorkTypeHref} workType
- * @property {WorkRoleHref} workRole
- * @property {AgreementHref} agreement
- * @property {string} timeStart
- * @property {string} timeEnd
- * @property {number} hoursDeduct
- * @property {number} actualHours
- * @property {string} billableOption ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {string} notes
- * @property {string} internalNotes
- * @property {boolean} addToDetailDescriptionFlag
- * @property {boolean} addToInternalAnalysisFlag
- * @property {boolean} addToResolutionFlag
- * @property {boolean} emailResourceFlag
- * @property {boolean} emailContactFlag
- * @property {boolean} emailCcFlag
- * @property {string} emailCc
- * @property {number} hoursBilled
- */
-
-/**
- *
- * @param options
- * @constructor
- */
-function TimeEntries(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(TimeEntries, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<TimeEntry>}
- */
-TimeEntries.prototype.getTimeEntries = function (params) {
-  return this.api('/time/entries', 'GET', params);
-};
-
-/**
- *
- * @param {TimeEntry} timeEntry
- * @returns {Promise<TimeEntry>}
- */
-TimeEntries.prototype.createTimeEntry = function (timeEntry) {
-  return this.api('/time/entries', 'POST', timeEntry);
-};
-
-/**
- *
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-TimeEntries.prototype.getTimeEntriesCount = function (params) {
-  return this.api('/time/entries/count', 'GET', params);
-};
-
-/**
- *
- * @param {number} id
- * @returns {Promise<DeleteResponse>}
- */
-TimeEntries.prototype.deleteTimeEntryById = function (id) {
-  return this.api(`/time/entries/${id}`, 'DELETE');
-};
-
-/**
- *
- * @param id
- * @returns {Promise<TimeEntry>}
- */
-TimeEntries.prototype.getTimeEntryById = function (id) {
-  return this.api(`/time/entries/${id}`, 'GET');
-};
-
-/**
- *
- * @param id
- * @param {Operations[]} operations
- * @returns {Promise<TimeEntry>}
- */
-TimeEntries.prototype.updateTimeEntry = function (id, operations) {
-  return this.api(`/time/entries/${id}`, 'PATCH', operations);
-};
-
-/**
- *
- * @param id
- * @param {TimeEntry} timeEntry
- * @returns {Promise<TimeEntry>}
- */
-TimeEntries.prototype.replaceTimeEntry = function (id, timeEntry) {
-  return this.api(`/time/entries/${id}`, 'PUT', timeEntry);
-};
-
-/**
- *
- * @type {TimeEntries}
- */
-module.exports = TimeEntries;

package/src/TimeAPI/index.js

@@ -1,27 +0,0 @@
-/**
- * Created by kgrube on 12/20/2015.
- * @author kgrube
- */
-
-/**
- * @typedef {object} TimeAPI
- * @property TimeEntries
- */
-
-/**
- * @param options
- * @returns {{TimeEntries: TimeEntries}}
- * @constructor
- */
-function TimeAPI(options) {
-  const _TimeEntries = require('./TimeEntries');
-  return {
-    TimeEntries: new _TimeEntries(options)
-  }
-}
-
-/**
- *
- * @type {TimeAPI}
- */
-module.exports = TimeAPI;

package/src/utils/Callback.js

@@ -1,124 +0,0 @@
-/**
- * Created by kgrube on 4/3/2019
- * @private
- */
-const request = require('request');
-const crypto = require('crypto');
-
-/**
- * @typedef {Object} CallbackPayload
- * @property Action
- * @property CompanyId
- * @property Entity json string
- * @property FromUrl
- * @property ID
- * @property MemberId
- * @property {object} Metadata
- * @property Metadata.key_url
- * @property Type
- */
-
-/**
- * @typedef {object} CWCallback
- * @property verifyCallback
- * @property verifyMessage
- * @property middleware
- *
- */
-
-/**
- * Load signing key and verify the message
- * @param {CallbackPayload} callbackBody
- * @param {string} contentSignature base64 content signature req.headers[x-content-signature]
- * @return {Promise<boolean>}
- */
-function verifyCallback(callbackBody, contentSignature) {
-  return new Promise((resolve, reject) => {
-    if (!callbackBody || !contentSignature) {
-      throw new Error('callbackBody and contentSignature must be defined.');
-    }
-
-    const key_url = callbackBody.Metadata && callbackBody.Metadata.key_url;
-
-    request(key_url, (err, res, body) => {
-      if (err) throw err;
-      try {
-        const parsed = JSON.parse(body);
-        const signingKey = parsed.signing_key;
-
-        return resolve(verifyMessage(callbackBody, contentSignature, signingKey));
-      } catch (parseErr) {
-        throw parseErr;
-      }
-    });
-  });
-}
-
-/**
- * Validate a callback body against signed key
- * @param {CallbackPayload} callbackBody
- * @param {string} contentSignature
- * @param {string} signingKey
- * @returns {boolean}
- */
-function verifyMessage(callbackBody, contentSignature, signingKey) {
-  const hash = crypto.createHash('sha256').update(signingKey).digest();
-  const hmac = crypto.createHmac('sha256', hash);
-
-  return contentSignature === hmac.update(JSON.stringify(callbackBody)).digest('base64');
-}
-
-/**
- * Express style middleware
- * @example
- * app.post('/your/api', cw.utils.middleware((err, req, res, verified, payload) => {
- *  if (err) {
- *    //handle error
- *    res.status(500).end();
- *  } else if (!verified) {
- *    // send 403 on verification failure
- *    res.status(403).end();
- *  } else {
- *    res.status(200).end()
- *  }
- *  const {action, id} = req.query;
- *  // do something with the payload
- * }));
- *
- * @param {function} cb callback(err, req, res, verified, payload)
- */
-function middleware(cb) {
-  if (!cb || typeof cb !== 'function') {
-    throw new Error('callback must be a function.');
-  }
-
-  return (req, res) => {
-    if (!req || !req.body || !req.body.Metadata) {
-      return cb(new Error('callback payload is invalid.'), req, res, false);
-    }
-
-    const contentSignature = req.headers['x-content-signature'];
-    const callbackBody = req.body;
-
-    let parsedEntity;
-    try {
-      parsedEntity = JSON.parse(callbackBody.Entity);
-    } catch (parseErr) {
-      return cb(parseErr, req, res, false);
-    }
-
-    verifyCallback(callbackBody, contentSignature)
-      .then(verified => {
-        return cb(null, req, res, verified, Object.assign(callbackBody, {Entity: parsedEntity}));
-      })
-      .catch(err => {
-        return cb(err, req, res, false);
-      });
-  };
-}
-
-module.exports = {
-  verifyMessage,
-  verifyCallback,
-  middleware,
-};

package/src/utils/Series.js

@@ -1,63 +0,0 @@
-/**
- * Created by kgrube on 4/3/2019
- */
-
-/**
- * @typedef {Object} CWSeries
- * @property {function} all
- */
-
-/**
- *
- * @param {array<Function|Promise>} series
- * @param {number} concurrent number of concurrent requests
- * @param {number} delay number of ms between request groups
- * @returns {Promise<*>}
- */
-function all({series, concurrent = 1, delay = 0}) {
-  const promises = series.slice();
-  const concurrency = concurrent;
-  let results = null;
-
-  return new Promise((resolve, reject) => {
-    function next(result) {
-      const concurrentPromises = [];
-
-      if (!results) {
-        results = [];
-      } else {
-        results = results.concat(result);
-      }
-
-      if (promises.length) {
-        while (concurrentPromises.length < concurrency && promises.length) {
-          let promise = promises.shift();
-
-          if (typeof promise === 'function') {
-            promise = promise();
-          }
-
-          if (!promise || typeof promise.then !== 'function') {
-            promise = Promise.resolve(promise);
-          }
-
-          concurrentPromises.push(promise);
-        }
-
-        setTimeout(() => {
-          Promise.all(concurrentPromises)
-            .then(next)
-            .catch(reject);
-        }, delay);
-      } else {
-        resolve(results);
-      }
-    }
-
-    next();
-  });
-}
-
-module.exports = {
-  all,
-};

package/src/utils/index.js

@@ -1,21 +0,0 @@
-/**
- * Created by kgrube on 4/3/2019
- * @private
- */
-const Series = require('./Series');
-const Callback = require('./Callback');
-
-/**
- * @typedef {Object} CWUtils
- * @property {CWCallback} Series
- * @property {CWCallback} Callback
- */
-
-/**
- *
- * @type {CWUtils}
- */
-module.exports = {
-  Series,
-  Callback,
-};