connectwise-rest 0.23.3 → 1.0.0

package/src/CompanyAPI/Configurations.js

@@ -1,152 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Configuration
- * @property {number} id
- * @property {string} name
- * @property {TypeHref} type
- * @property {StatusHref} status
- * @property {CompanyHref} company
- * @property {ContactHref} contact
- * @property {SiteHref} site
- * @property activeFlag
- * @property id
- * @property name
- * @property locationId
- * @property businessUnitId
- * @property deviceIdentifier
- * @property serialNumber
- * @property modelNumber
- * @property tagNumber
- * @property purchaseDate
- * @property installationDate
- * @property installedBy
- * @property warrantyExpirationDate
- * @property vendorNotes
- * @property notes
- * @property macAddress
- * @property lastLoginName
- * @property billFlag
- * @property backupSuccesses
- * @property backupIncomplete
- * @property backupFailed
- * @property backupRestores
- * @property lastBackupDate
- * @property backupServerName
- * @property backupBillableSpaceGb
- * @property backupProtectedDeviceList
- * @property backupYear
- * @property backupMonth
- * @property ipAddress
- * @property defaultGateway
- * @property osType
- * @property osInfo
- * @property cpuSpeed
- * @property ram
- * @property localHardDrives
- * @property parentConfigurationId
- * @property vendor
- * @property manufacturer
- * @property activeFlag
- * @property managementLink
- * @property remoteLink
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- * @typedef {object} ConfigurationQuestion
- * @property {number} answerId
- * @property {number} questionId
- * @property {string} question
- * @property {null|boolean|number|string} answer
- * @property {number} sequenceNumber
- * @property {number} numberOfDecimals
- * @property {string} fieldType ['Text', 'Button', 'Currency', 'Date', 'Hyperlink', 'IPAddress', 'Checkbox', 'Number', 'Percent', 'TextArea', 'Password']
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Configurations(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Configurations, ConnectWise);
-
-/**
- * @param {Params} params
- * @returns {Promise<Configuration[]>}
- */
-Configurations.prototype.getConfigurations = function (params) {
-  return this.api('/company/configurations', 'GET', params);
-};
-/**
- *
- * @param {Configuration} configuration
- * @returns {Promise<Configuration>}
- */
-Configurations.prototype.createConfiguration = function (configuration) {
-  return this.api('/company/configurations', 'POST', configuration);
-};
-
-/**
- * @param {ParamsConfig} params
- * @returns {Promise<Count>}
- */
-Configurations.prototype.getConfigurationsCount = function (params) {
-  return this.api('/company/configurations/count', 'GET', params);
-};
-
-/**
- * @param {string|number} id
- * @returns {Promise<DeleteResponse>}
- */
-Configurations.prototype.deleteConfigurationById = function (id) {
-  return this.api(`/company/configurations/${id}`, 'DELETE');
-};
-
-/**
- * @param {string|number} id
- * @returns {Promise<Configuration>}
- */
-Configurations.prototype.getConfigurationById = function (id) {
-  return this.api(`/company/configurations/${id}`, 'GET');
-};
-
-/**
- * @param {string|number} id
- * @param {Operations[]} ops
- * @param {ParamsConfigUpdate} [params] unused currently @todo figure this out
- * @returns {Promise<Configuration>}
- */
-Configurations.prototype.updateConfiguration = function (id, ops, params) {
-  return this.api(`/company/configurations/${id}`, 'PATCH', ops);
-};
-
-/**
- * @param {string|number} id
- * @param {Configuration} config
- * @returns {Promise<Configuration>}
- */
-Configurations.prototype.replaceConfiguration = function (id, config) {
-  return this.api(`/company/configurations/${id}`, 'PUT', config);
-};
-
-/**
- *
- * @type {Configurations}
- */
-module.exports = Configurations;

package/src/CompanyAPI/ContactContactTypeAssociations.js

@@ -1,55 +0,0 @@
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * Company > ContactContactTypeAssociations
- * @pilot
- */
-
-/**
- * @typedef {object} ContactTypeAssociation
- * @property id
- * @property type {ContactType}
- * @property contact {ContactHref}
- * @property _info
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function ContactContactTypeAssociations(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(ContactContactTypeAssociations, ConnectWise);
-
-/**
- * @param contactId
- * @param {Params} params
- * @returns {Promise<ContactTypeAssociation[]>}
- */
-ContactContactTypeAssociations.prototype.get = function (contactId, params) {
-  const path = `/company/contacts/${contactId}/typeAssociations`;
-
-  return this.api(path, 'GET', params);
-};
-
-ContactContactTypeAssociations.prototype.update = function (contactId, associationId, params) {
-  const path = `/company/contacts/${contactId}/typeAssociations/${associationId}`;
-
-  return this.api(path, 'PUT', params);
-};
-
-ContactContactTypeAssociations.prototype.create = function (contactId, params) {
-  const path = `/company/contacts/${contactId}/typeAssociations`;
-
-  return this.api(path, 'POST', params);
-};
-
-/**
- * @type {ContactContactTypeAssociations}
- */
-module.exports = ContactContactTypeAssociations;

package/src/CompanyAPI/ContactRelationships.js

@@ -1,36 +0,0 @@
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Relationship
- * @property {number} id
- * @property {string} name
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function ContactRelationships(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(ContactRelationships, ConnectWise);
-
-/**
- * @param {Params} params
- * @returns {Promise<Relationship[]>}
- */
-ContactRelationships.prototype.getRelationships = function (params) {
-  return this.api('/company/contacts/relationships', 'GET', params);
-};
-
-/**
- * @type {ContactRelationships}
- */
-module.exports = ContactRelationships;

package/src/CompanyAPI/Contacts.js

@@ -1,199 +0,0 @@
-/**
- * Created by kgrube on 1/22/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Contact
- * @property {string} addressLine1
- * @property {string} addressLine2
- * @property {string} anniversary
- * @property assistantContactId
- * @property {boolean} childrenFlag
- * @property city
- * @property {CommunicationItemHref[]} communicationItems
- * @property {CompanyHref} company
- * @property {CountryHref} country
- * @property {CustomField[]} customFields
- * @property {DepartmentHref} department
- * @property {boolean} disablePortalLoginFlag
- * @property {string} firstName
- * @property gender
- * @property {number} id numeric identifier
- * @property {boolean} inactiveFlag
- * @property {string} lastName
- * @property managerContactId
- * @property {boolean} marriedFlag
- * @property {string} nickName
- * @property portalPassword
- * @property {number} portalSecurityLevel
- * @property presence
- * @property {RelationshipHref} relationship
- * @property school
- * @property securityIdentifier
- * @property significantOther
- * @property {SiteHref} site
- * @property state
- * @property {string} title
- * @property {TypeHref} type
- * @property {boolean} unsubscribeFlag
- * @property zip
- * @property {object} _info
- * @property {string} _info.communications_href
- * @property {string} _info.image_href
- * @property {string} _info.notes_href
- * @property {string} _info.lastUpdated
- * @property {string} _info.portalSecurity_href
- * @property {string} _info.tracks_href
- * @property {string} _info.updatedBy
- */
-
-/**
- * @typedef {object} ContactType
- * @property {number} id
- * @property {string} description
- * @property {boolean} defaultFlag
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- */
-
-/**
- * @typedef {object} PortalSecurity
- * @property {string} identifier
- * @property {boolean} enabled
- */
-
-/**
- * @typedef {object} ValidatePortalResponse
- * @property {boolean} success
- * @property {number} contactId
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Contacts(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Contacts, ConnectWise);
-
-/**
- * @param {Params} params
- * @returns {Promise<Contact[]>}
- */
-Contacts.prototype.getContacts = function (params) {
-  return this.api('/company/contacts', 'GET', params);
-};
-
-/**
- * @param {Contact} contact
- * @returns {Promise<Contact>}
- */
-Contacts.prototype.createContact = function (contact) {
-  return this.api('/company/contacts', 'POST', contact);
-};
-
-/**
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Contacts.prototype.getContactsCount = function (params) {
-  return this.api('/company/contacts/count', 'GET', params);
-};
-
-/**
- * @param {ParamsConditions} params
- * @returns {Promise<ContactType>}
- */
-Contacts.prototype.getContactTypes = function (params) {
-  return this.api('/company/contacts/types', 'GET', params);
-};
-
-/**
- * @param {number|string} id
- * @param {number|string} transferContactId
- * @returns {Promise<DeleteResponse>}
- */
-Contacts.prototype.deleteContactById = function (id, transferContactId) {
-  return this.api(`/company/contacts/${id}`, 'DELETE', {transferContactId: transferContactId});
-};
-
-/**
- * @param {string|number} id
- * @returns {Promise<Contact>}
- */
-Contacts.prototype.getContactById = function (id) {
-  return this.api(`/company/contacts/${id}`, 'GET');
-};
-
-/**
- * @param {string|number} id
- * @param {Operations[]} operations
- * @returns {Promise<Contact>}
- */
-Contacts.prototype.updateContact = function (id, operations) {
-  return this.api(`/company/contacts/${id}`, 'PATCH', operations);
-};
-
-/**
- * @param {string|number} id
- * @param {Contact} contact
- * @returns {Promise<Contact>}
- */
-Contacts.prototype.replaceContact = function (id, contact) {
-  return this.api(`/company/contacts/${id}`, 'PUT', contact);
-};
-
-/**
- * @param {string|number} id
- * @returns {Promise<PortalSecurity[]>}
- */
-Contacts.prototype.getPortalSecurity = function (id) {
-  return this.api(`/company/contacts/${id}/portalSecurity`, 'GET');
-};
-
-
-/**
- * @param {string} email
- * @returns {Promise<PostResponse>}
- */
-Contacts.prototype.requestPassword = function (email) {
-  return this.api('/company/contacts/requestPassword', 'POST', {email: email});
-};
-
-/**
- *
- * @param {string} email
- * @param {string} password
- * @returns {Promise<ValidatePortalResponse>}
- */
-Contacts.prototype.validatePortalCredentials = function (email, password) {
-  return this.api('/company/contacts/validatePortalCredentials', 'POST', {email: email, password: password});
-};
-
-/**
- *
- * @param {string|number} id
- * @param {boolean} useDefaultFlag
- * @param {string} lastModified
- * @returns {Promise<*>} @TODO check return type
- */
-Contacts.prototype.getContactImage = function (id, useDefaultFlag, lastModified) {
-  return this.api(`/company/contacts/${id}/image`, 'GET', params);
-};
-
-/**
- *
- * @type {Contacts}
- */
-module.exports = Contacts;

package/src/CompanyAPI/index.js

@@ -1,53 +0,0 @@
-/**
- * Created by kgrube on 1/22/2015.
- * @author kgrube
- */
-
-/**
- * @typedef {object} CompanyAPI
- * @property {Companies} Companies
- * @property {Contacts} Contacts
- * @property {Configurations} Configurations
- * @property {ContactRelationships} ContactRelationships
- * @property {ContactContactTypeAssociations} ContactContactTypeAssociations
- * @property {CompanyCompanyTypeAssociations} CompanyCompanyTypeAssociations
- * @property {CompanyTypes} CompanyTypes
- * @property {CompanyTypeInfos} CompanyTypeInfos
- * @property {CompanySites} CompanySites
- */
-
-/**
- *
- * @param options
- * @returns {CompanyAPI}
- * @constructor
- */
-function CompanyAPI(options) {
-  const _Companies = require('./Companies');
-  const _Contacts = require('./Contacts');
-  const _Configurations = require('./Configurations');
-  const _ContactRelationships = require('./ContactRelationships');
-  const _ContactContactTypeAssociations = require('./ContactContactTypeAssociations');
-  const _CompanyCompanyTypeAssociations = require('./CompanyCompanyTypeAssociations');
-  const _CompanyTypes = require('./CompanyTypes');
-  const _CompanyTypeInfos = require('./CompanyTypeInfos');
-  const _CompanySites = require('./CompanySites');
-
-  return {
-    Companies: new _Companies(options),
-    Contacts: new _Contacts(options),
-    Configurations: new _Configurations(options),
-    ContactRelationships: new _ContactRelationships(options),
-    ContactContactTypeAssociations: new _ContactContactTypeAssociations(options),
-    CompanyCompanyTypeAssociations: new _CompanyCompanyTypeAssociations(options),
-    CompanyTypes: new _CompanyTypes(options),
-    CompanyTypeInfos: new _CompanyTypeInfos(options),
-    CompanySites: new _CompanySites(options),
-  };
-}
-
-/**
- *
- * @type {CompanyAPI}
- */
-module.exports = CompanyAPI;