connectwise-rest 0.23.3 → 1.0.0

package/docs/jsdoc.json

@@ -1,15 +0,0 @@
-{
-  "tags": {
-    "allowUnknownTags": true,
-    "dictionaries": ["jsdoc","closure"]
-  },
-  "source": {
-    "includePattern": ".+\\.js(doc)?$",
-    "excludePattern": "(^|\\/|\\\\)_"
-  },
-  "plugins": ["plugins/markdown"],
-  "templates": {
-    "cleverLinks": false,
-    "monospaceLinks": false
-  }
-}

package/index.js

@@ -1,10 +0,0 @@
-/**
- * Created by kgrube on 12/15/2015.
- * @author kgrube
- */
-
-/**
- *
- * @type {ConnectWiseRest}
- */
-module.exports = require('./src/ConnectWiseRest.js');

package/src/CompanyAPI/Companies.js

@@ -1,149 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Company
- * @property {string} accountNumber
- * @property {string} addressLine1
- * @property {string} addressLine2
- * @property {number} annualRevenue
- * @property calendarId
- * @property {CountryHref} country
- * @property {CustomField[]} customFields
- * @property {string} dateAcquired
- * @property {string} dateDeleted
- * @property {number} defaultContactId
- * @property deletedBy
- * @property {boolean} deletedFlag
- * @property faxNumber
- * @property {number} id numeric identifier
- * @property {string} identifier short name of Company
- * @property {boolean} leadFlag
- * @property leadSource
- * @property {number} marketId
- * @property {string} name full name of Company
- * @property numberOfEmployees
- * @property ownershipType
- * @property parentCompany
- * @property {string} phoneNumber
- * @property sicCode
- * @property {string} state state's abbreviation
- * @property {StatusHref} status
- * @property {number} territoryId
- * @property timeZone
- * @property {TypeHref} type removed in 2019.1
- * @property typeIds added in 2019.1
- * @property {boolean} unsubscribeFlag
- * @property {string} website
- * @property {string} zip
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-
-/**
- * @typedef {object} CompanyNote
- * @property {number} id
- * @property {string} text
- * @property {TypeHref} type @TODO check if this is the same as regular {Type}
- * @property {boolean} flagged
- * @property {string} enteredBy
- * @property {CompanyHref} company
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Companies(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Companies, ConnectWise);
-
-/**
- * @param {Params} params
- * @returns {Promise<Company[]>}
- */
-Companies.prototype.getCompanies = function (params) {
-  return this.api('/company/companies', 'GET', params);
-};
-
-/**
- *
- * @param {Company} company
- * @returns {Promise<Company>}
- */
-Companies.prototype.createCompany = function (company) {
-  return this.api('/company/companies', 'POST', company);
-};
-
-/**
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Companies.prototype.getCompaniesCount = function (params) {
-  return this.api('/company/companies/count', 'GET', params);
-};
-
-/**
- * @param {string|number} id numeric ID of company, not the company ID in ConnectWise.
- * @returns {Promise<Company>}
- */
-Companies.prototype.getCompanyById = function (id) {
-  return this.api(`/company/companies/${id}`, 'GET');
-};
-
-/**
- * @param {string|number} id
- * @param {Company} company
- * @returns {Promise<Company>}
- */
-Companies.prototype.replaceCompany = function (id, company) {
-  return this.api(`/company/companies/${id}`, 'PUT', company);
-};
-
-/**
- * @param {string|number} id
- * @returns {Promise<DeleteResponse>}
- */
-Companies.prototype.deleteCompanyById = function (id) {
-  return this.api(`/company/companies/${id}`, 'DELETE');
-};
-
-/**
- * @param {string|number} id
- * @param {Operations[]} ops
- * @returns {Promise<Company>}
- */
-Companies.prototype.updateCompany = function (id, ops) {
-  return this.api(`/company/companies/${id}`, 'PATCH', ops);
-};
-
-
-/**
- * @TODO finish this one
- * @returns {Promise<*>}
- */
-Companies.prototype.mergeCompany = function () {
-  return this.api(`/company/companies/${id}/merge`, 'POST', params);
-};
-
-/**
- *
- * @type {Companies}
- */
-module.exports = Companies;

package/src/CompanyAPI/CompanyCompanyTypeAssociations.js

@@ -1,111 +0,0 @@
-/**
- * Created by kgrube on 1/29/2019
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {Object} CompanyTypeAssociation
- * @property {number} id
- * @property {CompanyTypeHref} type
- * @property {CompanyHref} company
- * @property _info
- */
-
-/**
- * @typedef {Object} CompanyTypeHref
- * @property id
- * @property identifier
- * @property name
- * @property _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function CompanyCompanyTypeAssociations(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CompanyCompanyTypeAssociations, ConnectWise);
-
-/**
- *
- * @param id
- * @param {Params} params
- * @returns {Promise<CompanyTypeAssociation[]>}
- */
-CompanyCompanyTypeAssociations.prototype.getCompanyTypeAssociations = function (id, params) {
-  return this.api(`/company/companies/${id}/typeAssociations`, 'GET', params);
-};
-
-/**
- *
- * @param id
- * @param {CompanyTypeAssociation} companyTypeAssociation
- * @returns {Promise<CompanyTypeAssociation>}
- */
-CompanyCompanyTypeAssociations.prototype.createCompanyTypeAssociation = function (id, companyTypeAssociation) {
-  return this.api(`/company/companies/${id}/typeAssociations`, 'POST', companyTypeAssociation);
-};
-
-/**
- *
- * @param id
- * @param params
- * @returns {Promise<Count>}
- */
-CompanyCompanyTypeAssociations.prototype.getCompanyTypeAssociationsCount = function (id, params) {
-  return this.api(`/company/companies/${id}/typeAssociations/count`, 'GET', params);
-};
-
-/**
- *
- * @param id
- * @param typeAssociationId
- * @returns {Promise<CompanyTypeAssociation>}
- */
-CompanyCompanyTypeAssociations.prototype.getCompanyTypeAssociationById = function (id, typeAssociationId) {
-  return this.api(`/company/companies/${id}/typeAssociations/${typeAssociationId}`, 'GET');
-};
-
-/**
- *
- * @param id
- * @param typeAssociationId
- * @returns {Promise<DeleteResponse>}
- */
-CompanyCompanyTypeAssociations.prototype.deleteCompanyTypeAssociationById = function (id, typeAssociationId) {
-  return this.api(`/company/companies/${id}/typeAssociations/${typeAssociationId}`, 'DELETE');
-};
-
-/**
- * @param id
- * @param typeAssociationId
- * @param newTypeAssociation
- * @returns {Promise<CompanyTypeAssociation>}
- */
-CompanyCompanyTypeAssociations.prototype.replaceCompanyTypeAssociation = function (id, typeAssociationId, newTypeAssociation) {
-  return this.api(`/company/companies/${id}/typeAssociations/${typeAssociationId}`, 'PUT', newTypeAssociation);
-};
-
-/**
- *
- * @param id
- * @param typeAssociationId
- * @param {Operations[]} operations
- * @returns {Promise<*>}
- */
-CompanyCompanyTypeAssociations.prototype.updateCompanyTypeAssociation = function (id, typeAssociationId, operations) {
-  return this.api(`/company/companies/${id}/typeAssociations/${typeAssociationId}`, 'PATCH', operations);
-};
-
-
-module.exports = CompanyCompanyTypeAssociations;

package/src/CompanyAPI/CompanySites.js

@@ -1,70 +0,0 @@
-/**
- * Created by jvohwinkel on 2/25/2019
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {Object} CompanySite
- * @property {number} id
- * @property {string} name
- * @property {string} addressLine1
- * @property {string} addressLine2
- * @property {string} city
- * @property {string} state
- * @property {string} zip
- * @property {CountryHref} country
- * @property {string} addressFormat
- * @property {string} phoneNumber
- * @property {string} faxNumber
- * @property {number} taxCodeId
- * @property entityType
- * @property {number} expenseReimbursement
- * @property {boolean} primaryAddressFlag
- * @property {boolean} defaultShippingFlag
- * @property {boolean} defaultBillingFlag
- * @property {boolean} defaultMailingFlag
- * @property {boolean} inactiveFlag
- * @property {string} mobileGuid
- * @property calendar
- * @property timeZone
- * @property {CompanyHref} company
- * @property {InfoHref} _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function CompanySites(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CompanySites, ConnectWise);
-
-/**
- *
- * @param companyId
- * @returns {Promise<CompanySite[]>}
- */
-CompanySites.prototype.getCompanySites = function (companyId) {
-  return this.api(`/company/companies/${companyId}/sites`, 'GET');
-};
-
-/**
- *
- * @param companyId
- * @param id
- * @returns {Promise<CompanySite>}
- */
-CompanySites.prototype.getCompanySiteById = function (companyId, id) {
-  return this.api(`/company/companies/${companyId}/sites/${id}`, 'GET');
-};
-
-module.exports = CompanySites;

package/src/CompanyAPI/CompanyTeams.js

@@ -1,108 +0,0 @@
-/**
- * Created by kgrube on 1/23/2017.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} CompanyTeam
- * @property id
- * @property {CompanyHref} company
- * @property {TeamHref} teamRole
- * @property locationId
- * @property businessUnitId
- * @property {ContactHref} contact
- * @property {MemberHref} member
- * @property accountManagerFlag
- * @property techFlag
- * @property salesFlag
- * @property {InfoHref} _info
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function CompanyTeams(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CompanyTeams, ConnectWise);
-
-/**
- * @param id companyId
- * @param {Params} params
- * @returns {Promise<CompanyTeam[]>}
- */
-CompanyTeams.prototype.getCompanyTeams = function (id, params) {
-  return this.api(`/company/companies/${id}/teams`, 'GET', params);
-};
-
-/**
- * @param id companyId
- * @param {CompanyTeam} companyTeam
- * @returns {Promise<CompanyTeam>}
- */
-CompanyTeams.prototype.createCompanyTeam = function (id, companyTeam) {
-  return this.api(`/company/companies/${id}/teams`, 'POST', companyTeam);
-};
-
-/**
- * @param id companyId
- * @param {Params} params
- * @returns {Promise<Count[]>}
- */
-CompanyTeams.prototype.getCompanyTeamsCount = function (id, params) {
-  return this.api(`/company/companies/${id}/teams/count`, 'GET', params);
-};
-
-/**
- * @param id companyId
- * @param teamId
- * @returns {Promise<CompanyTeam>}
- */
-CompanyTeams.prototype.getCompanyTeamById = function (id, teamId) {
-  return this.api(`/company/companies/${id}/teams/${teamId}`, 'GET', params);
-};
-
-/**
- * @param id companyId
- * @param teamId
- * @returns {Promise<DeleteResponse>}
- */
-CompanyTeams.prototype.deleteCompanyTeamById = function (id, teamId) {
-  return this.api(`/company/companies/${id}/teams/${teamId}`, 'DELETE', params);
-};
-
-/**
- * @param id companyId
- * @param teamId
- * @param {CompanyTeam} companyTeam
- * @returns {Promise<CompanyTeam>}
- */
-CompanyTeams.prototype.replaceCompanyTeam = function (id, teamId, companyTeam) {
-  return this.api(`/company/companies/${id}/teams/${teamId}`, 'PUT', companyTeam);
-};
-
-/**
- * @param id companyId
- * @param teamId
- * @param {Operations[]} ops
- * @returns {Promise<CompanyTeam>}
- */
-CompanyTeams.prototype.updateCompanyTeam = function (id, teamId, ops) {
-  return this.api(`/company/companies/${id}/teams/${teamId}`, 'PATCH', ops);
-};
-
-/**
- *
- * @type {CompanyTeams}
- */
-module.exports = CompanyTeams;

package/src/CompanyAPI/CompanyTypeInfos.js

@@ -1,58 +0,0 @@
-/**
- * Created by kgrube on 1/29/2019
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {Object} CompanyTypeInfo
- * @property {number} id
- * @property  name
- * @property _info
- */
-
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function CompanyTypeInfos(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CompanyTypeInfos, ConnectWise);
-
-/**
- *
- * @param {Params} params
- * @returns {Promise<CompanyTypeInfo[]>}
- */
-CompanyTypeInfos.prototype.getCompanyTypeInfos = function (params) {
-  return this.api('/company/companies/info/types', 'GET', params);
-};
-
-/**
- *
- * @param {Params} params
- * @returns {Promise<CompanyTypeInfo[]>}
- */
-CompanyTypeInfos.prototype.getCompanyTypeInfosCount = function (params) {
-  return this.api('/company/companies/info/types/count', 'GET', params);
-};
-
-/**
- *
- * @param id
- * @returns {Promise<CompanyTypeInfo>}
- */
-CompanyTypeInfos.prototype.getCompanyTypeInfoById = function (id) {
-  return this.api(`/company/companies/info/types/${id}`, 'GET', params);
-};
-
-module.exports = CompanyTypeInfos;

package/src/CompanyAPI/CompanyTypes.js

@@ -1,52 +0,0 @@
-/**
- * Created by kgrube on 1/29/2019
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {Object} CompanyType
- * @property {boolean} defaultFlag
- * @property id
- * @property name
- * @property {boolean} serviceAlertFlag
- * @property {boolean} vendorFlag
- * @property _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function CompanyTypes(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(CompanyTypes, ConnectWise);
-
-/**
- *
- * @param {Params} params
- * @returns {Promise<CompanyType[]>}
- */
-CompanyTypes.prototype.getCompanyTypes = function (params) {
-  return this.api('/company/companies/types', 'GET', params);
-};
-
-/**
- *
- * @param id
- * @returns {Promise<CompanyType>}
- */
-CompanyTypes.prototype.getCompanyTypeById = function (id) {
-  return this.api(`/company/companies/types/${id}`, 'GET');
-};
-
-
-module.exports = CompanyTypes;