connectwise-rest 0.23.3 → 1.0.0

package/src/FinanceAPI/Adjustments.js

@@ -1,109 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Adjustment
- * @property {number} agreementId
- * @property {number} amount
- * @property {string} description
- * @property {string} effectiveDate
- * @property {number} id
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- *
- */
-
-/**
- * @param {CWOptions} options
- * @constructor
- */
-function Adjustments(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(Adjustments, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<Adjustment[]>}
- */
-Adjustments.prototype.getAdjustments = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {Adjustment} addition
- * @returns {Promise<Adjustment>}
- */
-Adjustments.prototype.createAdjustments = function (agreementId, addition) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments`, 'POST', addition);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Adjustments.prototype.getAdjustmentsCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param additionId
- * @returns {Promise<DeleteResponse>}
- */
-Adjustments.prototype.deleteAdjustmentById = function (agreementId, additionId) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments/${additionId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param additionId
- * @returns {Promise<Adjustment>}
- */
-Adjustments.prototype.getAdjustmentById = function (agreementId, additionId) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments/${additionId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param additionId
- * @param {Operations operations
- * @returns {Promise<Adjustment>}
- */
-Adjustments.prototype.updateAdjustment = function (agreementId, additionId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments/${additionId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param additionId
- * @param {Adjustment} addition
- * @returns {Promise<Adjustment>}
- */
-Adjustments.prototype.replaceAdjustment = function (agreementId, additionId, addition) {
-  return this.api(`/finance/agreements/${agreementId}/adjustments/${additionId}`, 'PUT', addition);
-};
-
-/**
- *
- * @type {Adjustments}
- */
-module.exports = Adjustments;

package/src/FinanceAPI/AgreementSites.js

@@ -1,108 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} AgreementSite
- * @property {number} id
- * @property {CompanyHref} company
- * @property {SiteHref} site
- * @property {number} agreementId
- * @property {object} _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function AgreementSites(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(AgreementSites, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<AgreementSite[]>}
- */
-AgreementSites.prototype.getAgreementSites = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/sites`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {AgreementSite} site
- * @returns {Promise<AgreementSite>}
- */
-AgreementSites.prototype.createAgreementSite = function (agreementId, site) {
-  return this.api(`/finance/agreements/${agreementId}/sites`, 'POST', site);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-AgreementSites.prototype.getAgreementSitesCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/sites/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param siteId
- * @returns {Promise<DeleteResponse>}
- */
-AgreementSites.prototype.deleteAgreementSiteById = function (agreementId, siteId) {
-  return this.api(`/finance/agreements/${agreementId}/sites/${siteId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param siteId
- * @returns {Promise<AgreementSite>}
- */
-AgreementSites.prototype.getAgreementSiteById = function (agreementId, siteId) {
-  return this.api(`/finance/agreements/${agreementId}/sites/${siteId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param siteId
- * @param {Operations[]} operations
- * @returns {Promise<AgreementSite>}
- */
-AgreementSites.prototype.updateAgreementSite = function (agreementId, siteId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/sites/${siteId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param siteId
- * @param {AgreementSite} site
- * @returns {Promise<AgreementSite>}
- */
-AgreementSites.prototype.replaceAgreementSite = function (agreementId, siteId, site) {
-  return this.api(`/finance/agreements/${agreementId}/sites/${siteId}`, 'PUT', site);
-};
-
-/**
- *
- * @type {AgreementSites}
- */
-module.exports = AgreementSites;

package/src/FinanceAPI/Agreements.js

@@ -1,220 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Agreement
- * @property {boolean} allowOverruns
- * @property {string} applicationCycle ['CalendarMonth', 'Contract2Weeks', 'Contract4Weeks', 'CalendarQuarter', 'CalendarWeek', 'ContractQuarter', 'CalendarYear']
- * @property {number} applicationLimit
- * @property {string} applicationUnits ['Amount', 'Hours', 'Incidents']
- * @property {boolean} applicationUnlimitedFlag
- * @property {number} billAmount
- * @property {number} billCycleId
- * @property {string} billExpenses ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {boolean} billOneTimeFlag
- * @property {string} billProducts ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {string} billStartDate
- * @property {number} billTermsId
- * @property {string} billTime ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {object} billToCompany
- * @property {number} billToCompany.id
- * @property {string} billToCompany.identifier
- * @property {object} billToCompany._info
- * @property {object} billToSite
- * @property {number} billToSite.id
- * @property {string} billToSite.name
- * @property {object} billToSite._info
- * @property {boolean} billableExpenseInvoice
- * @property {boolean} billableProductInvoice
- * @property {boolean} billableTimeInvoice
- * @property {boolean} bottomComment
- * @property {number} businessUnitId
- * @property {boolean} cancelledFlag
- * @property {boolean} carryOverUnused
- * @property {boolean} chargeToFirm
- * @property {number} compHourlyRate
- * @property {number} compLimitAmount
- * @property {CompanyHref} company
- * @property {ContactHref} contact
- * @property {boolean} coverAgreementExpense
- * @property {boolean} coverAgreementProduct
- * @property {boolean} coverAgreementTime
- * @property {boolean} coverSalesTax
- * @property {string} customerPO
- * @property {string} dateCancelled
- * @property {string} employeeCompNotExceed ['Billing', 'Percent', 'Amount]
- * @property {string} employeeCompRate ['Actual', 'Hourly']
- * @property {string} endDate
- * @property {boolean} expireWhenZero
- * @property {number} expiredDays
- * @property {number} id agreementId
- * @property {string} internalNotes
- * @property {string} invoiceDescription
- * @property {number} invoiceTemplateId
- * @property {string} invoicingCycle ['CalendarMonth', 'Contract2Weeks', 'Contract4Weeks', 'CalendarQuarter', 'CalendarWeek', 'ContractQuarter', 'CalendarYear']
- * @property {number} limit
- * @property {number} locationId
- * @property {string} name agreementName
- * @property {boolean} noEndingDateFlag
- * @property {boolean} oneTimeFlag
- * @property {OpportunityHref} opportunity
- * @property {number} parentAgreementId
- * @property {string} periodType ['Current', 'Future', 'Both', 'Undefined']
- * @property {number} projectTypeId
- * @property {number} prorateFirstBill
- * @property {boolean} restrictDepartmentFlag
- * @property {boolean} restrictDownPayment
- * @property {boolean} restrictLocationFlag
- * @property {number} slaId
- * @property {string} startDate
- * @property {CompanyHref} subContractCompany
- * @property {ContactHref} subContractContact
- * @property {number} taxCodeId
- * @property {boolean} taxable
- * @property {boolean} topComment
- * @property {AgreementTypeHref} type
- * @property {string} workOrder
- * @property {WorkRoleHref} workRole
- * @property {WorkTypeHref} workType
- *
- */
-
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Agreements(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Agreements, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<Agreement[]>}
- */
-Agreements.prototype.getAgreements = function (params) {
-  return this.api('/finance/agreements', 'GET', params);
-};
-
-/**
- * POST
- * @param {Agreement} agreement
- * @returns {Promise<Agreement>}
- */
-Agreements.prototype.createAgreement = function (agreement) {
-  return this.api('/finance/agreements', 'POST', agreement);
-};
-
-/**
- * GET
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Agreements.prototype.getAgreementsCount = function (params) {
-  return this.api('/finance/agreements/count', 'GET', params);
-};
-
-/**
- * DELETE
- * @param {string|number} agreementId
- * @returns {Promise<DeleteResponse>}
- */
-Agreements.prototype.deleteAgreementById = function (agreementId) {
-  return this.api(`/finance/agreements/${agreementId}`, 'DELETE');
-};
-
-/**
- *
- * @param {string|number} agreementId
- * @returns {Promise<Agreement>}
- */
-Agreements.prototype.getAgreementById = function (agreementId) {
-  return this.api(`/finance/agreements/${agreementId}`, 'GET');
-};
-
-/**
- *
- * @param {string|number} agreementId
- * @param {Operations[]} operations
- * @returns {Promise<Agreement>}
- */
-Agreements.prototype.updateAgreement = function (agreementId, operations) {
-  return this.api(`/finance/agreements/${agreementId}`, 'PATCH', operations);
-};
-
-/**
- *
- * @param agreementId
- * @param {Agreement} agreement
- * @returns {Promise<Agreement>}
- */
-Agreements.prototype.replaceAgreement = function (agreementId, agreement) {
-  return this.api(`/finance/agreements/${agreementId}`, 'PUT', agreement);
-};
-
-/**
- *
- * @param agreementId
- * @param {ParamsPage} params
- * @returns {Promise<ConfigurationHref[]>}
- */
-Agreements.prototype.getAgreementConfigurations = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/configurations`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param configuration
- * @returns {Promise<ConfigurationHref>}
- */
-Agreements.prototype.createConfigurationAssociation = function (agreementId, configuration) {
-  return this.api(`/finance/agreements/${agreementId}/configurations`, 'POST', configuration);
-};
-
-/**
- * GET
- * @param agreementId
- * @returns {Promise<Count>}
- */
-Agreements.prototype.getAgreementConfigurationsCount = function (agreementId) {
-  return this.api(`/finance/agreements/${agreementId}/configurations/count`, 'GET');
-};
-
-/**
- *
- * @param agreementId
- * @param configurationId
- * @returns {Promise<DeleteResponse>}
- */
-Agreements.prototype.deleteConfigurationAssociation = function (agreementId, configurationId) {
-  return this.api(`/finance/agreements/${agreementId}/configurations/${configurationId}`, 'DELETE');
-};
-
-/**
- *
- * @param agreementId
- * @param configurationId
- * @returns {Promise<ConfigurationHref>}
- */
-Agreements.prototype.getConfigurationAssociation = function (agreementId, configurationId) {
-  return this.api(`/finance/agreements/${agreementId}/configurations/${configurationId}`, 'GET');
-};
-
-/**
- *
- * @type {Agreements}
- */
-module.exports = Agreements;

package/src/FinanceAPI/BoardDefaults.js

@@ -1,109 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} BoardDefault
- * @property {number} id
- * @property {BoardHref} board
- * @property {ServiceTypeHref} serviceType
- * @property {boolean} defaultFlag
- * @property {number} agreementId
- * @property {object} _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function BoardDefaults(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(BoardDefaults, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<BoardDefault[]>}
- */
-BoardDefaults.prototype.getBoardDefaults = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {BoardDefault} boardDefault
- * @returns {Promise<BoardDefault>}
- */
-BoardDefaults.prototype.createBoardDefault = function (agreementId, boardDefault) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults`, 'POST', boardDefault);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-BoardDefaults.prototype.getBoardDefaultsCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param boardDefaultId
- * @returns {Promise<DeleteResponse>}
- */
-BoardDefaults.prototype.deleteBoardDefaultById = function (agreementId, boardDefaultId) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults/${boardDefaultId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param boardDefaultId
- * @returns {Promise<BoardDefault>}
- */
-BoardDefaults.prototype.getBoardDefaultById = function (agreementId, boardDefaultId) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults/${boardDefaultId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param boardDefaultId
- * @param {Operations[]} operations
- * @returns {Promise<BoardDefault>}
- */
-BoardDefaults.prototype.updateBoardDefault = function (agreementId, boardDefaultId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults/${boardDefaultId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param boardDefaultId
- * @param {BoardDefault} boardDefault
- * @returns {Promise<BoardDefault>}
- */
-BoardDefaults.prototype.replaceBoardDefault = function (agreementId, boardDefaultId, boardDefault) {
-  return this.api(`/finance/agreements/${agreementId}/boardDefaults/${boardDefaultId}`, 'PUT', boardDefault);
-};
-
-/**
- *
- * @type {BoardDefaults}
- */
-module.exports = BoardDefaults;

package/src/FinanceAPI/WorkRoles.js

@@ -1,113 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} WorkRole
- * @property {number} id
- * @property {WorkRoleHref} workRole
- * @property {number} locationId
- * @property {string} rateType ['AdjAmount', 'Custom', 'Multiplier']
- * @property {number} rate
- * @property {number} limitTo
- * @property {string} effectiveDate
- * @property {string} endingDate
- * @property {number} agreementId
- * @property {object} _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function WorkRoles(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(WorkRoles, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<WorkRole[]>}
- */
-WorkRoles.prototype.getWorkRoles = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workroles`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {WorkRole} workRole
- * @returns {Promise<WorkRole>}
- */
-WorkRoles.prototype.createWorkRole = function (agreementId, workRole) {
-  return this.api(`/finance/agreements/${agreementId}/workroles`, 'POST', workRole);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-WorkRoles.prototype.getWorkRolesCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workroles/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param workRoleId
- * @returns {Promise<DeleteResponse>}
- */
-WorkRoles.prototype.deleteWorkRoleById = function (agreementId, workRoleId) {
-  return this.api(`/finance/agreements/${agreementId}/workroles/${workRoleId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param workRoleId
- * @returns {Promise<WorkRole>}
- */
-WorkRoles.prototype.getWorkRoleById = function (agreementId, workRoleId) {
-  return this.api(`/finance/agreements/${agreementId}/workroles/${workRoleId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param workRoleId
- * @param {Operations[]} operations
- * @returns {Promise<WorkRole>}
- */
-WorkRoles.prototype.updateWorkRole = function (agreementId, workRoleId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/workroles/${workRoleId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param workRoleId
- * @param {WorkRole} workRole
- * @returns {Promise<WorkRole>}
- */
-WorkRoles.prototype.replaceWorkRole = function (agreementId, workRoleId, workRole) {
-  return this.api(`/finance/agreements/${agreementId}/workroles/${workRoleId}`, 'PUT', workRole);
-};
-
-/**
- *
- * @type {WorkRoles}
- */
-module.exports = WorkRoles;