connectwise-rest 0.23.3 → 1.0.0

package/src/ConnectWiseRest.js

@@ -1,512 +0,0 @@
-/**
- * Created by kgrube on 12/15/2015.
- * @author kgrube
- */
-
-/**
- * @type {CWUtils}
- * @private
- */
-const _utils = require('./utils');
-
-
-/**
- * @typedef {object} CWOptions
- * @property companyId
- * @property publicKey
- * @property privateKey
- * @property clientId register for a clientId at https://developer.connectwise.com/ClientID
- * @property companyUrl
- * @property {string} [entryPoint=v4_6_release] defaults to 'v4_6_release'
- * @property {number} [timeout=20000] defaults to 20000 (20 seconds)
- * @property {boolean} [retry=false] enable automatic retries
- * @property {object} [retryOptions] configure retry options
- * @property {number} [retryOptions.minTimeout=50] minimum time between retries
- * @property {number} [retryOptions.maxTimeout=20000] maximum time to wait for a timeout
- * @property {boolean} [retryOptions.randomize=true] randomize delay between retires
- * @property {boolean} [debug=false] enable debug output
- * @property {function} [logger=console] function(String:level, String:text, *:Object) defaults to console
- */
-
-/**
- * @typedef {object} ConnectWiseRest
- * @property {ConnectWise} API
- * @property {CompanyAPI} CompanyAPI
- * @property {FinanceAPI} FinanceAPI
- * @property {ServiceDeskAPI} ServiceDeskAPI
- * @property {TimeAPI} TimeAPI
- * @property {ProjectAPI} ProjectAPI
- * @property {ScheduleAPI} ScheduleAPI
- * @property {SystemAPI} SystemAPI
- * @property {SalesAPI} SalesAPI
- * @property {CWUtils} utils
- */
-
-/**
- * @class ConnectWiseRest
- * @param {CWOptions} options
- * @type {ConnectWiseRest}
- * @constructor
- */
-function ConnectWiseRest(options) {
-  const _ConnectWise = require('./ConnectWise');
-  const _CompanyAPI = require('./CompanyAPI');
-  const _FinanceAPI = require('./FinanceAPI');
-  const _TimeAPI = require('./TimeAPI');
-  const _ServiceDeskAPI = require('./ServiceDeskAPI');
-  const _ProjectAPI = require('./ProjectAPI');
-  const _ScheduleAPI = require('./ScheduleAPI');
-  const _SystemAPI = require('./SystemAPI');
-  const _SalesAPI = require('./SalesAPI');
-
-  this.API = new _ConnectWise(options);
-  this.CompanyAPI = new _CompanyAPI(options);
-  this.FinanceAPI = new _FinanceAPI(options);
-  this.TimeAPI = new _TimeAPI(options);
-  this.ServiceDeskAPI = new _ServiceDeskAPI(options);
-  this.ProjectAPI = new _ProjectAPI(options);
-  this.ScheduleAPI = new _ScheduleAPI(options);
-  this.SystemAPI = new _SystemAPI(options);
-  this.SalesAPI = new _SalesAPI(options);
-  this.utils = _utils;
-}
-
-ConnectWiseRest.utils = _utils;
-
-/**
- *
- * @type {ConnectWiseRest}
- */
-module.exports = ConnectWiseRest;
-
-/**
- * @typedef {object} InfoHref
- * @property lastUpdated
- * @property updatedBy
- */
-
-/**
- * @typedef {object} AgreementHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.agreement_href
- */
-
-/**
- * @typedef {object} AgreementTypeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.type_href
- */
-
-/**
- * @typedef {object} BoardHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.board_href
- */
-
-/**
- * @typedef {object} CompanyHref
- * @property {number} id
- * @property {string} identifier The company ID in ConnectWise
- * @property {object} _info
- * @property {string} _info.company_href
- */
-
-/**
- * @typedef {object} ContactHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.contact_href
- */
-
-/**
- * @typedef {object} CountryHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- */
-
-/**
- * @typedef {object} DocumentHref
- * @property {number} id
- * @property {object} _info
- * @property {string} _info.filename
- */
-
-/**
- * @typedef {object} ItemHref Service Item
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.item_href
- */
-
-/**
- * @typedef {object} PriorityHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.image_href
- * @property {string} _info.priority_href
- */
-
-/**
- * @typedef {object} ProductHref
- * @property {number} id
- * @property {string} identifier
- * @property {object} _info
- * @property {string} _info.identifier
- */
-
-/**
- * @typedef {object} ServiceLocationHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.location_href
- */
-
-/**
- * @typedef {object} ServiceTypeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- */
-
-/**
- * @typedef {object} ScheduleEntryHref
- * @property {number} id
- * @property {object} _info
- * @property {string} _info.description
- * @property {string} _info.schedule_href
- */
-
-/**
- * @typedef {object} SiteHref
- * @property {number} id
- * @property {object} _info
- * @property {string} _info.name
- * @property {string} _info.site_href
- */
-
-/**
- * @typedef {object} SourceHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.source_href
- */
-
-/**
- * @typedef {object} StatusHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.status_href
- */
-
-/**
- * @typedef {object} SubTypeHref Service Subtype
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.subType_href
- */
-
-/**
- * @typedef {object} TeamHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.team_href
- */
-
-/**
- * @typedef {object} TypeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.type_href
- */
-
-/**
- * @typedef {object} OpportunityHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} opportunity_href
- */
-
-/**
- * @typedef {object} Params
- * @property {string} [conditions] Search results based on the fields returned in a GET, board/name="Integration" and summary="xyz" or board/id in (3, 2, 4) and lastUpdated > [2016-08-20T18:04:26Z]
- * @property {string} [orderBy] Choose which field to sort the results by, 'contact/name asc'
- * @property {string|number} [page] Used in pagination to cycle through results
- * @property {string|number} [pageSize] Number of results returned per page (Defaults to 25) (Max page size was increased to 1,000 in 2016.2.)
- * @property {string} [childConditions] Allows searching arrays on endpoints that list childConditions under parameters
- * @property {string} [customFieldConditions] Allows searching custom fields when customFieldConditions is listed in the parameters
- * @property {string} [fields] Limits which information is returned in the response - Not available on the reporting endpoints
- * @property {string} [columns] Limits which information is returned in the response - Only used for the Reporting Endpoints
- */
-
-/**
- * @typedef {object} ParamsPage
- * @property {string|number} [page]
- * @property {string|number} [pageSize]
- */
-
-/**
- * @typedef {object} ParamsConditions
- * @property {string} [conditions]
- * @property {string} [orderBy]
- */
-
-/**
- * @typedef {object} ParamsImage
- * @property {boolean} [useDefaultFlag]
- * @property {string} [lastmodifier] note the lower case M (not a typo)
- */
-
-/**
- * @typedef {object} ParamsConfig
- * @property {string} [conditions]
- * @property {string} [managedIdentifier]
- */
-
-/**
- * @typedef {object} ParamsConfigUpdate
- * @property {string} [managementSolutionName]
- * @property {string} [managedIdentifier]
- * @property {string} [type]
- * @property {string} [level]
- * @property {string} [childConfigurationsMatchingOn]
- * @property {string} [inactivateConfigurationsMatchingOn]
- * @property {number} [inactiveConfigurationStatusId]
- */
-
-/**
- * @typedef {object} ProductHref
- * @property {number} id
- * @property {object} _info
- * @property {string} _info.description
- */
-
-/**
- * @typedef {object} WorkRoleHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.role_href
- */
-
-/**
- * @typedef {object} WorkTypeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.type_href
- */
-
-/**
- * @typedef {object} Operations
- * @property {string} op ['replace','remove']
- * @property {string} path the relative path to the variable to be updated, e.g. status
- * @property {string|boolean|object|number} value the value of the object property to replace, e.g. { id: 123 }
- */
-
-/**
- * @typedef {object} Count
- * @property {number} count the number of matched records.
- */
-
-/**
- * @typedef {object} ConfigurationHref
- * @property {number} id
- * @property {string} deviceIdentifier
- * @property {object} _info
- * @property {string} _info.name
- * @property {string} _info.configuration_href
- *
- */
-
-/**
- * @typedef {object} CurrencyHref
- * @property {string} currency_href
- */
-
-/**
- * @typedef {object} MemberHref
- * @property {number} id
- * @property {string} identifier the member's ID in CW
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- * @typedef {object} DeleteResponse
- * @property {string} error null if no error
- */
-
-/**
- * @typedef {object} PostResponse
- * @property {string} error null if no error
- */
-
-
-/**
- * @typedef {object} ErrorResponse
- * @property {string} code
- * @property {string} message
- * @property {object[]} errors
- */
-
-/**
- * @typedef {object} CustomField
- * @property {string} caption
- * @property {string} entryMethod
- * @property {number} id
- * @property {number} numberOfDecimals
- * @property {string} type
- * @property {string} value
- *
- */
-
-/**
- * @typedef {object} ProjectStatusHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- *
- */
-
-/**
- * @typedef {object} ProjectTypeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- *
- */
-
-/**
- * @typedef {object} OwnerHref
- * @property {number} id
- * @property {string} identifier
- * @property {object} _info
- * @property {string} image_href
- * @property {string} member_href
- */
-
-/**
- * @typedef {object} CountryHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- */
-
-/**
- * @typedef {object} CustomField
- * @property {string} caption
- * @property {string} entryMethod
- * @property {number} id
- * @property {number} numberOfDecimals
- * @property {string} type
- * @property {string} value
- *
- */
-
-/**
- * @typedef {object} CommunicationItemHref
- * @property {string} communicationType
- * @property {boolean} defaultFlag
- * @property extension
- * @property {number} id
- * @property {TypeHref} type
- * @property {string} value
- *
- */
-
-/**
- * @typedef {object} DepartmentHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.department_href
- *
- */
-
-/**
- * @typedef {object} RelationshipHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} relationship_href
- *
- */
-
-/**
- * @typedef {object} ScheduleTypeHref
- * @property id
- * @property identifier
- * @property {object} _info
- * @property _info.type_href
- */
-
-/**
- * @typedef {object} ScheduleStatusHref
- * @property id
- * @property name
- * @property {object} _info
- * @property _info.status_href
- */
-
-/**
- * @typedef {object} ScheduleSpanHref
- * @property id
- * @property name
- * @property _info
- */
-
-/**
- * @typedef {object} ReminderHref
- * @property id
- * @property name
- * @property _info
- *
- */
-
-/**
- * @typedef {object} ServiceLocationHref
- * @property id
- * @property name
- * @property _info
- * @property _info.location_href
- */
-
-/**
- * @typedef {object} ChargeCodeHref
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- */
-
-/**
- * @typedef {Object} Usage
- * @property type
- * @property count
- * @property id
- * @property description
- * @property hyperlink
- */
-
-/**
- * @typedef {Object} UsageCount
- * @property type
- * @property count
- */

package/src/FinanceAPI/Additions.js

@@ -1,127 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Addition
- * @property {number} agreementId
- * @property {string} billCustomer
- * @property {string} cancelledDate
- * @property {string} description
- * @property {string} effectiveDate
- * @property {number} extCost
- * @property {number} extPrice
- * @property {number} id
- * @property {string} invoiceDescription
- * @property {number} lessIncluded
- * @property {number} margin
- * @property {ProductHref} product
- * @property {boolean} purchaseItemFlag
- * @property {number} quantity
- * @property serialNumber
- * @property {boolean} specialOrderFlag
- * @property {boolean} taxableFlag
- * @property {number} unitCost
- * @property {number} unitPrice
- * @property {string} uom unit of measurement ['each', 'monthly', 'yearly', 'quarterly']
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Additions(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Additions, ConnectWise);
-
-/**
- * GET
- * Returns non-cancelled active additions to an agreement
- * @param agreementId
- * @param {Params} params
- * @returns {Promise<Addition[]>}
- */
-Additions.prototype.getAdditions = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/additions`, 'GET', params);
-};
-
-/**
- * POST
- * @param agreementId
- * @param {Addition} addition
- * @returns {Promise<Addition>}
- */
-Additions.prototype.createAddition = function (agreementId, addition) {
-  return this.api(`/finance/agreements/${agreementId}/additions`, 'POST', addition);
-};
-
-/**
- * GET
- * @param agreementId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Additions.prototype.getAdditionsCount = function (agreementId, params) {
-  return this.api(`/finance/agreements/${agreementId}/additions/count`, 'GET', params);
-};
-
-/**
- * DELETE
- * @param agreementId
- * @param additionId
- * @returns {Promise<DeleteResponse>}
- */
-Additions.prototype.deleteAdditionById = function (agreementId, additionId) {
-  return this.api(`/finance/agreements/${agreementId}/additions/${additionId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param agreementId
- * @param additionId
- * @returns {Promise<Addition>}
- */
-Additions.prototype.getAdditionById = function (agreementId, additionId) {
-  return this.api(`/finance/agreements/${agreementId}/additions/${additionId}`, 'GET');
-};
-
-/**
- * PATCH
- * @param agreementId
- * @param additionId
- * @param {Operations[]} operations
- * @returns {Promise<Addition>}
- */
-Additions.prototype.updateAddition = function (agreementId, additionId, operations) {
-  return this.api(`/finance/agreements/${agreementId}/additions/${additionId}`, 'PATCH', operations);
-};
-
-/**
- * PUT
- * @param agreementId
- * @param additionId
- * @param {Addition} addition
- * @returns {Promise<Addition>}
- */
-Additions.prototype.replaceAddition = function (agreementId, additionId, addition) {
-  return this.api(`/finance/agreements/${agreementId}/additions/${additionId}`, 'PUT', addition);
-};
-
-/**
- *
- * @type {Additions}
- */
-module.exports = Additions;