connectwise-rest 0.25.1 → 1.0.2

package/src/FinanceAPI/WorkTypeExclusions.js

@@ -1,78 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} WorkTypeExclusion
- * @property {number} id
- * @property {WorkTypeHref} workType
- * @property {number} agreementId
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function WorkTypeExclusions(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(WorkTypeExclusions, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<WorkTypeExclusion[]>}
- */
-WorkTypeExclusions.prototype.getWorkTypeExclusions = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workTypeExclusions`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {WorkTypeExclusion} workTypeExclusion
- * @returns {Promise<WorkTypeExclusion>}
- */
-WorkTypeExclusions.prototype.createWorkTypeExclusion = function (agreementId, workTypeExclusion) {
-  return this.api(`/finance/agreements/${agreementId}/workTypeExclusions`, 'POST', workTypeExclusion);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-WorkTypeExclusions.prototype.getWorkTypeExclusionsCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workTypeExclusions/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param workTypeExclusionId
- * @returns {Promise<DeleteResponse>}
- */
-WorkTypeExclusions.prototype.deleteWorkTypeExclusionById = function (agreementId, workTypeExclusionId) {
-  return this.api(`/finance/agreements/${agreementId}/workTypeExclusions/${workTypeExclusionId}`, 'DELETE');
-};
-
-
-/**
- *
- * @type {WorkTypeExclusions}
- */
-module.exports = WorkTypeExclusions;
-

package/src/FinanceAPI/WorkTypes.js

@@ -1,124 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} WorkType
- * @property {number} id
- * @property {WorkTypeHref} workType
- * @property {number} locationId
- * @property {string} rateType ['AdjAmount', 'Custom', 'Multiplier']
- * @property {string} billTime ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {number} rate
- * @property {number} hoursMax
- * @property {number} hoursMin
- * @property {number} roundBillHours
- * @property {number} overageRate
- * @property {string} overageRateType ['AdjAmount', 'Custom', 'Multiplier']
- * @property {number} agreementLimit
- * @property {SiteHref} site
- * @property {string} effectiveDate
- * @property {string} endingDate
- * @property {number} agreementId
- * @property {CompanyHref} company
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function WorkTypes(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(WorkTypes, ConnectWise);
-
-/**
- * GET
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<WorkType[]>}
- */
-WorkTypes.prototype.getWorkTypes = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {WorkType} workType
- * @returns {Promise<WorkType>}
- */
-WorkTypes.prototype.createWorkType = function (agreementId, workType) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes`, 'POST', workType);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-WorkTypes.prototype.getWorkTypesCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param workTypeId
- * @returns {Promise<DeleteResponse>}
- */
-WorkTypes.prototype.deleteWorkTypeById = function (agreementId, workTypeId) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes/${workTypeId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param workTypeId
- * @returns {Promise<WorkType>}
- */
-WorkTypes.prototype.getWorkTypeById = function (agreementId, workTypeId) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes/${workTypeId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param workTypeId
- * @param {Operations[]} operations
- * @returns {Promise<WorkType>}
- */
-WorkTypes.prototype.updateWorkType = function (agreementId, workTypeId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes/${workTypeId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param workTypeId
- * @param {WorkType} workType
- * @returns {Promise<WorkType>}
- */
-WorkTypes.prototype.replaceWorkType = function (agreementId, workTypeId, workType) {
-  return this.api(`/finance/agreements/${agreementId}/workTypes/${workTypeId}`, 'PUT', workType);
-};
-
-/**
- *
- * @type {WorkTypes}
- */
-module.exports = WorkTypes;
-

package/src/FinanceAPI/index.js

@@ -1,50 +0,0 @@
-/**
- * Created by kgrube on 1/22/2015.
- * @author kgrube
- */
-
-/**
- * @typedef {object} FinanceAPI
- * @property {Additions} Additions
- * @property {Adjustments} Adjustments
- * @property {Agreements} Agreements
- * @property {AgreementSites} AgreementSites
- * @property {BoardDefaults} BoardDefaults
- * @property {WorkRoles} WorkRoles
- * @property {WorkTypeExclusions} WorkTypeExclusions
- * @property {WorkTypes} WorkTypes
- */
-
-/**
- *
- * @param options
- * @returns {FinanceAPI}
- * @constructor
- */
-function FinanceAPI(options) {
-  const _Additions = require('./Additions');
-  const _Adjustments = require('./Adjustments');
-  const _Agreements = require('./Agreements');
-  const _AgreementSites = require('./AgreementSites');
-  const _BoardDefaults = require('./BoardDefaults');
-  const _WorkRoles = require('./WorkRoles');
-  const _WorkTypeExclusions = require('./WorkTypeExclusions');
-  const _WorkTypes = require('./WorkTypes');
-
-  return {
-    Additions: new _Additions(options),
-    Adjustments: new _Adjustments(options),
-    Agreements: new _Agreements(options),
-    AgreementSites: new _AgreementSites(options),
-    BoardDefaults: new _BoardDefaults(options),
-    WorkRoles: new _WorkRoles(options),
-    WorkTypeExclusions: new _WorkTypeExclusions(options),
-    WorkTypes: new _WorkTypes(options)
-  }
-}
-
-/**
- *
- * @type {FinanceAPI}
- */
-module.exports = FinanceAPI;

package/src/ProcurementAPI/CatalogItems.js

@@ -1,94 +0,0 @@
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} CatalogItem
- * @property {number} id
- * @property {string} identifier
- * @property {string} description
- * @property {boolean} inactiveFlag
- * @property {ProductSubCategoryHref} subcategory
- * @property {ProductTypeHref} type
- * @property {string} productClass ['Agreement', 'Bundle', 'Inventory', 'NonInventory', 'Service']
- * @property {boolean} serializedFlag
- * @property {boolean} serializedCostFlag
- * @property {boolean} phaseProductFlag
- * @property {UnitOfMeasureHref} unitOfMeasure
- * @property {number} minStockLevel
- * @property {number} price
- * @property {number} cost
- * @property {string} priceAttribute ['FixedFee', 'NotToExceed', 'TimeAndMaterials', 'OverrideRate']
- * @property {boolean} taxableFlag
- * @property {boolean} dropshipFlag
- * @property {boolean} specialOrderFlag
- * @property {string} customerDescription
- * @property {ManufacturerHref} manufacturer
- * @property {CompanyHref} vendor
- * @property {string} vendorSku
- * @property {string} notes
- * @property {string} integrationXRef
- * @property {SLAHref} sla
- * @property {EntityTypeHref} entityType
- * @property {boolean} recurringFlag
- * @property {number} recurringRevenue
- * @property {number} recurringCost
- * @property {boolean} recurringOneTimeFlag
- * @property {BillingCycleHref} recurringBillCycle
- * @property {string} recurringCycleType ['CalendarYear', 'ContractYear']
- * @property {string} dateEntered
- * @property {boolean} calculatedPriceFlag
- * @property {boolean} calculatedCostFlag
- * @property {number} calculatedPrice
- * @property {number} calculatedCost
- */
-
-/**
- *
- * @param options
- * @constructor
- */
-function CatalogItems(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CatalogItems, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<CatalogItem>}
- */
-CatalogItems.prototype.getCatalog = function (params) {
-  return this.api('/procurement/catalog', 'GET', params);
-};
-
-/**
- * PATCH
- * @param {number} id
- * @param {Operations[]} operations
- * @param {string} operations.op the operation to perform, possible values: ['replace', ?]
- * @param {string} operations.path
- * @param {string|number} operations.value
- * @returns {Promise<CatalogItem>} The updated catalog item
- */
-CatalogItems.prototype.updateCatalog = function (id, operations) {
-  return this.api(`/procurement/catalog/${id}`, 'PATCH', operations);
-};
-
-/**
- * POST
- * @param {CatalogItem} CatalogItem
- * @returns {Promise<CatalogItem>} The created catalog item
- */
-CatalogItems.prototype.createCatalog = function(catalogItem) {
-  return this.api('/procurement/catalog', 'POST', catalogItem);
-};
-
-/**
- *
- * @type {CatalogItems}
- */
-module.exports = CatalogItems;

package/src/ProcurementAPI/index.js

@@ -1,22 +0,0 @@
-/**
- * @typedef {object} ProcurementAPI
- * @property CatalogItems
- */
-
-/**
- * @param options
- * @returns {{CatalogItems: CatalogItems}}
- * @constructor
- */
-function ProcurementAPI(options) {
-  const _CatalogItems = require('./CatalogItems');
-  return {
-    CatalogItems: new _CatalogItems(options)
-  }
-}
-
-/**
- *
- * @type {CatalogItems}
- */
-module.exports = ProcurementAPI;

package/src/ProjectAPI/Projects.js

@@ -1,142 +0,0 @@
-/**
- * Created by kgrube on 3/10/2016.
- */
-
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Project
- * @property {string} actualEnd
- * @property {number} actualHours
- * @property {string} actualStart
- * @property {AgreementHref} agreement
- * @property {string} billExpenses ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {string} billProducts ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {boolean} billProjectAfterClosedFlag
- * @property {string} billTime ['Billable', 'DoNotBill', 'NoCharge', 'NoDefault']
- * @property {boolean} billUnapprovedTimeAndExpense
- * @property {number} billingAmount
- * @property {string} billingAttention
- * @property {string} billingMethod ['ActualRates', 'FixedFee', 'NotToExceed', 'OverrideRate']
- * @property {string} billingRateType ['WorkRole', 'StaffMember']
- * @property {BoardHref} board
- * @property {string} budgetAnalysis ['ActualHours', 'BillableHours']
- * @property {boolean} budgetFlag
- * @property {number} budgetHours
- * @property {CompanyHref} company
- * @property {ContactHref} contact
- * @property {string} customerPO
- * @property {string} description
- * @property {number} downpayment note: as of CW2016.1, this is typo'd as 'downpayment' and not 'downPayment'
- * @property {string} estimatedEnd
- * @property {number} estimatedExpenseRevenue
- * @property {number} estimatedHours
- * @property {number} estimatedProductRevenue
- * @property {string} estimatedStart
- * @property {number} estimatedTimeRevenue
- * @property {MemberHref} expenseApprover
- * @property {number} id projectId
- * @property {MemberHref} manager
- * @property {string} name projectName
- * @property {OpportunityHref} opportunity
- * @property {number} projectTemplateId
- * @property {boolean} restrictDownPaymentFlag
- * @property {string} scheduledEnd
- * @property {number} scheduledHours
- * @property {string} scheduledStart
- * @property {SiteHref} site
- * @property {ProjectStatusHref} status
- * @property {MemberHref} timeApprover
- * @property {ProjectTypeHref} type
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Projects(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Projects, ConnectWise);
-
-/**
- *
- * @param {Params} params
- * @returns {Promise<Project[]>}
- */
-Projects.prototype.getProjects = function (params) {
-  return this.api('/project/projects', 'GET', params);
-};
-
-/**
- *
- * @param {Project} project
- * @returns {Promise<Project>}
- */
-Projects.prototype.createProject = function (project) {
-  return this.api('/project/projects', 'POST', project);
-};
-
-/**
- *
- * @param {ParamsConditions} conditions
- * @returns {Promise<Count>}
- */
-Projects.prototype.getProjectsCount = function (conditions) {
-  return this.api('/project/projects', 'GET', conditions);
-};
-
-/**
- *
- * @param {string|number} projectId
- * @returns {Promise<DeleteResponse>}
- */
-Projects.prototype.deleteProjectById = function (projectId) {
-  return this.api(`/project/projects/${projectId}`, 'DELETE');
-};
-
-/**
- *
- * @param {string|number} projectId
- * @returns {Promise<Project>}
- */
-Projects.prototype.getProjectById = function (projectId) {
-  return this.api(`/project/projects/${projectId}`, 'GET');
-};
-
-/**
- *
- * @param {string|number} projectId
- * @param {Operations[]} operations
- * @returns {Promise<Project>}
- */
-Projects.prototype.updateProject = function (projectId, operations) {
-  return this.api(`/project/projects/${projectId}`, 'PATCH', operations);
-};
-
-/**
- *
- * @param {string|number} projectId
- * @param {Project} project
- * @returns {Promise<Project>}
- */
-Projects.prototype.replaceProject = function (projectId, project) {
-  return this.api(`/project/projects/${projectId}`, 'PUT', project);
-};
-
-/**
- * @type {Projects}
- */
-module.exports = Projects;

package/src/ProjectAPI/index.js

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

package/src/SalesAPI/Activities.js

@@ -1,149 +0,0 @@
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Activity
- * @property id
- * @property name
- * @property {object} type
- * @property type.id
- * @property type.name
- * @property {TypeHref} type._info
- * @property {object} company
- * @property company.id
- * @property company.identifier
- * @property company.name
- * @property {CompanyHref} company._info
- * @property {object} contact
- * @property contact.id
- * @property contact.name
- * @property {CompanyHref} company._info
- * @property email
- * @property {object} status
- * @property status.id
- * @property status.name
- * @property {StatusHref} status._info
- * @property {object} opportunity
- * @property opportunity.id
- * @property opportunity.name
- * @property {OpportunityHref} opportunity._info
- * @property notes
- * @property dateStart
- * @property {object} assignedBy
- * @property assignedBy.id
- * @property assignedBy.identifier
- * @property assignedBy.name
- * @property {MemberHref} assignedBy._info
- * @property {object} assignTo
- * @property assignTo.id
- * @property assignTo.identifier
- * @property assignTo.name
- * @property {MemberHref} assignTo._info
- * @property notifyFlag
- * @property mobileGuid
- * @property {object} currency
- * @property currency.id
- * @property currency.symbol
- * @property currency.isoCode
- * @property currency.name
- * @property {CurrencyHref} currency._info
- * @property {InfoHref} _info
- */
-
-/**
- * @typedef {object} ActivityType
- * @property id
- * @property name
- * @property points
- * @property defaultFlag
- * @property inactiveFlag
- * @property emailFlag
- * @property memoFlag
- * @property _info
- * @property _info.lastUpdated
- * @property _info.updatedBy
- */
-
-
-/**
- * @property {object} ActivityStatus
- * @property id
- * @property name
- * @property defaultFlag
- * @property inactiveFlag
- * @property spawnFollowupFlag
- * @property closedFlag
- * @property _info
- * @property _info.lastUpdated
- */
-
-/**
- *
- * @constructor
- */
-function Activities(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Activities, ConnectWise);
-
-Activities.prototype.createActivity = function (activity) {
-  return this.api('/sales/activities', 'POST', activity);
-};
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<Activity[]>}
- */
-Activities.prototype.getActivities = function (params) {
-  return this.api('/sales/activities', 'GET', params);
-};
-
-/**
- * GET
- * @returns {Promise<ActivityType[]>}
- */
-Activities.prototype.getActivityTypes = function (params) {
-  return this.api('/sales/activities/types', 'GET', params);
-};
-
-/**
- *
- * @returns {Promise<ActivityStatus[]>}
- */
-Activities.prototype.getActivityStatuses = function () {
-  return this.api('/sales/activities/statuses', 'GET');
-};
-
-/**
- *
- * @param id
- * @returns {Promise<{DeleteResponse}>}
- */
-Activities.prototype.deleteActivityById = function (id) {
-  return this.api(`/sales/activities/${id}`, 'DELETE');
-};
-
-/**
- *
- * @param id
- * @param {Operations[]} ops
- * @returns {Promise<Activity>}
- */
-Activities.prototype.updateActivity = function (id, ops) {
-  return this.api(`/sales/activities/${id}`, 'PATCH', ops);
-};
-
-/**
- *
- * @param id
- * @returns {Promise<Activity>}
- */
-Activities.prototype.getActivityById = function (id) {
-  return this.api(`/sales/activities/${id}`, 'GET');
-};
-
-module.exports = Activities;
-
-

package/src/SalesAPI/index.js

@@ -1,14 +0,0 @@
-/**
- * @typedef {object} SalesAPI
- * @property {Activities} Activities
- **/
-
-function SalesAPI(options) {
-  const _Activities = require('./Activities');
-
-  return {
-    Activities: new _Activities(options),
-  };
-}
-
-module.exports = SalesAPI;