connectwise-rest 0.25.1 → 1.0.2

package/src/ServiceDeskAPI/Tickets.js

@@ -1,588 +0,0 @@
-/**
- * Created by kgrube on 12/15/2015.
- * @author kgrube
- */
-
-/**
- *
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Ticket
- * @property {string} actualHours
- * @property {string} addressLine1
- * @property {string} addressLine2
- * @property {AgreementHref} agreement
- * @property {boolean} allowAllClientsPortalView
- * @property {boolean} approved
- * @property automaticEmailCc
- * @property automaticEmailCcFlag
- * @property automaticEmailContactFlag
- * @property automaticEmailResourceFlag
- * @property {BoardHref} board
- * @property {number} budgetHours
- * @property {string} city
- * @property closedBy
- * @property closedDate
- * @property closedFlag
- * @property {CompanyHref} company
- * @property {ContactHref} contact
- * @property {string} contactEmailAddress
- * @property contactEmailLookup
- * @property contactPhoneExtension
- * @property {string} contactPhoneNumber
- * @property {CountryHref} country
- * @property {boolean} customerUpdatedFlag
- * @property {CustomField[]} customFields
- * @property {string} dateEntered
- * @property {string} dateResolved
- * @property {string} dateResplan
- * @property {string} dateResponded
- * @property {string} enteredBy
- * @property externalXRef
- * @property {boolean} hasChildTicket
- * @property {number} id TicketNbr
- * @property {string} impact
- * @property initialDescription
- * @property initialInternalAnalysis
- * @property initialResolution
- * @property {boolean} isInSla
- * @property {ItemHref} item
- * @property knowledgeBaseCategoryId
- * @property knowledgeBaseLinkId
- * @property knowledgeBaseLinkType
- * @property knowledgeBaseSubCategoryId
- * @property opportunity
- * @property {OwnerHref} owner
- * @property parentTicketId
- * @property phase
- * @property poNumber
- * @property {PriorityHref} priority
- * @property processNotifications
- * @property project
- * @property {string} recordType
- * @property {string} requiredDate
- * @property {number} resPlanMinutes
- * @property {number} resolveMinutes
- * @property {string} resources
- * @property {number} respondMinutes
- * @property {ServiceLocationHref} serviceLocation
- * @property {string} severity
- * @property {SiteHref} site
- * @property {string} siteName
- * @property skipCallback
- * @property {SourceHref} source
- * @property {string} stateIdentifier
- * @property {StatusHref} status
- * @property subBillingAmount
- * @property {string} subBillingMethod
- * @property subDateAccepted
- * @property {SubTypeHref} subType
- * @property {string} summary
- * @property {TeamHref} team
- * @property {TypeHref} type
- * @property wbsCode
- * @property {string} zip
- * @property {object} _info
- * @property {string} _info.activities_href
- * @property {string} _info.childtasks_href
- * @property {string} _info.configurations_href
- * @property {string} _info.documents_href
- * @property {string} _info.lastUpdated
- * @property {string} _info.notes_href
- * @property {string} _info.products_href
- * @property {string} _info.scheduleentries_href
- * @property {string} _info.tasks_href
- * @property {string} _info.timeentries_href
- * @property {string} _info.updatedBy
- */
-
-/**
- *
- * @param {CWOptions} options
- * @constructor
- */
-function Tickets(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(Tickets, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<Ticket[]>}
- */
-Tickets.prototype.getTickets = function (params) {
-  return this.api('/service/tickets', 'GET', params);
-};
-
-/**
- * GET
- * @param {string|number} id ticketNbr
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.getTicketById = function (id) {
-  return this.api(`/service/tickets/${id}`, 'GET');
-};
-
-/**
- * POST
- * @param {object|Ticket} ticket the new ticket data
- * @param {object} ticket.board
- * @param {string} ticket.board.name
- * @param {object} ticket.company
- * @param {string} ticket.company.identifier The CompanyID in ConnectWise
- * @param {string} ticket.summary
- * @param {string} [ticket.initialDescription]
- * @returns {Promise<Ticket>} The created ticket, or errors if any occured
- */
-Tickets.prototype.createTicket = function (ticket) {
-  return this.api('/service/tickets', 'POST', ticket);
-};
-
-/**
- * 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<Ticket>} The updated ticket
- */
-Tickets.prototype.updateTicket = function (id, operations) {
-  return this.api(`/service/tickets/${id}`, 'PATCH', operations);
-};
-
-/**
- * GET
- * @param {ParamsConditions} params
- * @param {string} [params.conditions] Conditions string, e.g. 'Summary like "%blah%" AND board/name = "Service Board"'
- * @returns {Promise<Count>} The number of tickets matching the conditions
- */
-Tickets.prototype.getTicketsCount = function (params) {
-  return this.api('/service/tickets/count', 'GET', params);
-};
-
-/**
- * DELETE
- * @param {string|number} id
- * @returns {Promise<DeleteResponse>}
- */
-Tickets.prototype.deleteTicketsById = function (id) {
-  return this.api(`/service/tickets/${id}`, 'DELETE');
-};
-
-/**
- * PUT
- * @param id
- * @param {Ticket} ticket
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.replaceTicket = function (id, ticket) {
-  return this.api(`/service/tickets/${id}`, 'PUT', ticket);
-};
-
-/**
- * GET
- * @param id
- * @param {Params} [params]
- * @returns {Promise<Activity[]>}
- */
-Tickets.prototype.getTicketActivities = function (id, params) {
-  return this.api(`/service/tickets/${id}/activities`, 'GET', params);
-};
-
-/**
- * GET
- * @param {number|string} id
- * @returns {Promise<Count>} The number of activities associated with ticket number id
- */
-Tickets.prototype.getTicketActivitiesCount = function (id) {
-  return this.api(`/service/tickets/${id}/activities/count`, 'GET');
-};
-
-/**
- * GET
- * @param {number|string} id
- * @param {Params} params
- * @returns {Promise<TimeEntry[]>}
- */
-Tickets.prototype.getTicketTimeEntries = function (id, params) {
-  return this.api(`/service/tickets/${id}/timeentries`, 'GET', params);
-};
-
-/**
- * GET
- * @param {number|string} id
- * @returns {Promise<Count>} The count of time entries attached to ticket id
- */
-Tickets.prototype.getTicketTimeEntriesCount = function (id) {
-  return this.api(`/service/tickets/${id}/timeentries/count`, 'GET');
-};
-
-/**
- * POST
- * @param {number|string} id ticketNbr
- * @param {number|string} configId
- * @returns {Promise<ConfigurationHref>}
- */
-Tickets.prototype.createConfigurationAssociation = function (id, configId) {
-  return this.api(`/service/tickets/${id}/configurations`, 'POST', {
-    id: configId
-  });
-};
-
-/**
- * GET
- * @param id ticketNbr
- * @returns {Promise<ConfigurationHref[]>}
- */
-Tickets.prototype.getTicketConfigurations = function (id) {
-  return this.api(`/service/tickets/${id}/configurations`, 'GET');
-};
-
-/**
- * GET
- * @param id ticketNbr
- * @returns {Promise<Count>}
- */
-Tickets.prototype.getTicketConfigurationsCount = function (id) {
-  return this.api(`/service/tickets/${id}/configurations/count`, 'GET');
-};
-
-/**
- * DELETE
- * @param id
- * @param configId
- * @throws {ErrorResponse}
- * @returns {Promise<DeleteResponse>}
- */
-Tickets.prototype.deleteConfigurationAssociation = function (id, configId) {
-  return this.api(`/service/tickets/${id}/configurations/${configId}`, 'DELETE');
-};
-
-/**
- * GET
- * @param id
- * @param configId
- * @returns {Promise<ConfigurationHref>}
- */
-Tickets.prototype.getConfigurationAssociation = function (id, configId) {
-  return this.api(`/service/tickets/${id}/configurations/${configId}`, 'GET');
-};
-
-/**
- * GET
- * @param {string|number} id
- * @param {ParamsPage} [params]
- * @returns {Promise<ScheduleEntryHref[]>}
- */
-Tickets.prototype.getTicketScheduleEntries = function (id, params) {
-  return this.api(`/service/tickets/${id}/scheduleentries`, 'GET', params);
-};
-
-/**
- * GET
- * @param id
- * @returns {Promise<Count>}
- */
-Tickets.prototype.getTicketScheduleEntriesCount = function (id) {
-  return this.api(`/service/tickets/${id}/scheduleentries/count`, 'GET');
-};
-
-/**
- * GET
- * @param {string|number} id
- * @param {ParamsPage} [params]
- * @returns {Promise<DocumentHref[]>}
- */
-Tickets.prototype.getTicketDocuments = function (id, params) {
-  return this.api(`/service/tickets/${id}/documents`, 'GET', params);
-};
-
-/**
- * GET
- * @param id
- * @returns {Promise<Count>}
- */
-Tickets.prototype.getTicketDocumentsCount = function (id) {
-  return this.api(`/service/tickets/${id}/documents/count`, 'GET');
-};
-
-/**
- * GET
- * @param id
- * @returns {Promise<ProductHref[]>}
- */
-Tickets.prototype.getTicketProducts = function (id) {
-  return this.api(`/service/tickets/${id}/products`, 'GET');
-};
-
-/**
- * GET
- * @param id
- * @returns {Promise<Count>}
- */
-Tickets.prototype.getTicketProductsCount = function (id) {
-  return this.api(`/service/tickets/${id}/products/count`, 'GET');
-};
-
-/**
- *
- * @param {string|number} id
- * @param {string} status
- * @returns {Promise<Ticket[]>}
- */
-Tickets.prototype.updateTicketStatusByName = function (id, status) {
-  const self = this;
-
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      const boardId = ticket.board.id;
-      return self.api(`/service/boards/${boardId}/statuses`, 'GET', {conditions: `name = "${status}"`})
-        .then(function (statuses) {
-          if (statuses.length > 0) {
-            const statusId = statuses[0].id;
-            return self.updateTicket(id, [{
-              op: 'replace',
-              path: 'status',
-              value: {id: statusId}
-            }])
-          } else {
-            throw {
-              code: 'NotFound',
-              errors: null,
-              message: `Status ${status} not found`
-            };
-          }
-        })
-    });
-};
-
-/**
- *
- * @param id
- * @param {string} priority - do a %like% match on priority
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketPriority = function (id, priority) {
-  const self = this;
-  return self.api('/service/priorities', 'GET', {
-    conditions: `name like "%${priority}%"`
-  }).then(function (res) {
-    if (res.length > 0) {
-      const priorityId = res[0].id;
-      return self.updateTicket(id, [{
-        op: 'replace',
-        path: 'priority',
-        value: {id: priorityId}
-      }]);
-    } else {
-      throw {
-        code: 'NotFound',
-        message: 'Could not find any matching priority.',
-        errors: null
-      };
-    }
-  });
-};
-
-/**
- *
- * @param id
- * @param {string} serviceType
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketServiceType = function (id, serviceType) {
-  const self = this;
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      const boardId = ticket.board.id;
-      return self.api(`/service/boards/${boardId}/types`, 'GET', {
-        conditions: `name = "${serviceType}"`
-      }).then(function (types) {
-        if (types.length > 0) {
-          const serviceTypeId = types[0].id;
-          return self.updateTicket(id, [{
-            op: 'replace',
-            path: 'type',
-            value: {id: serviceTypeId}
-          }]);
-        } else {
-          throw {
-            code: 'NotFound',
-            message: 'Could not find any matching service types.',
-            errors: null
-          };
-        }
-      });
-    });
-};
-
-/**
- *
- * @param id
- * @param {string} serviceSubType
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketServiceSubType = function (id, serviceSubType) {
-  const self = this;
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      const boardId = ticket.board.id;
-      return self.api(`/service/boards/${boardId}/subtypes`, 'GET', {
-        conditions: `name = "${serviceSubType}"`
-      }).then(function (types) {
-        if (types.length > 0) {
-          const serviceSubTypeId = types[0].id;
-          return self.updateTicket(id, [{
-            op: 'replace',
-            path: 'subType',
-            value: {id: serviceSubTypeId}
-          }]);
-        } else {
-          throw {
-            code: 'NotFound',
-            message: 'Could not find any matching service subtypes.',
-            errors: null
-          };
-        }
-      });
-    });
-};
-
-/**
- *
- * @param id
- * @param {string} type
- * @param {string} subtype
- * @param {string} item
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketTypeSubTypeItem = function (id, type, subtype, item) {
-  const self = this;
-  return self.updateTicketServiceType(id, type)
-    .then(function () {
-      return self.updateTicketServiceSubType(id, subtype)
-        .then(function () {
-          return self.updateTicketServiceItem(id, item);
-        })
-    })
-};
-
-/**
- *
- * @param id
- * @param {string} serviceItem
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketServiceItem = function (id, serviceItem) {
-  const self = this;
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      const boardId = ticket.board.id;
-      return self.api(`/service/boards/${boardId}/items`, 'GET', {
-        conditions: `name = "${serviceItem}"`
-      }).then(function (items) {
-        if (items.length > 0) {
-          const serviceItemId = items[0].id;
-          return self.updateTicket(id, [{
-            op: 'replace',
-            path: 'item',
-            value: {id: serviceItemId}
-          }]);
-        } else {
-          throw {
-            code: 'NotFound',
-            message: 'Could not find any matching service items.',
-            errors: null
-          };
-        }
-      });
-    });
-};
-
-/**
- *
- * @param {string|number} id ticketNbr
- * @param {string|number} index
- * @param {string|number|boolean} value
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketCustomFieldByIndex = function (id, index, value) {
-  return this.updateTicket(id, [{
-    op: 'replace',
-    path: `customFields/${index}/value`,
-    value: value
-  }]);
-};
-
-/**
- *
- * @param {string|number} id ticketNbr
- * @param {string|number} customFieldId
- * @param {string|number|boolean} value
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketCustomFieldById = function (id, customFieldId, value) {
-  if (typeof customFieldId === 'string') {
-    customFieldId = parseInt(customFieldId);
-  }
-  const self = this;
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      let fieldIdx = -1;
-      ticket.customFields.forEach(function (elem, idx) {
-        if (elem.id === customFieldId) {
-          return fieldIdx = idx;
-        }
-      });
-      if (fieldIdx === -1) {
-        throw {
-          code: 'InvalidCustomFieldId',
-          message: 'No custom field found with id specified',
-          errors: null
-        };
-      }
-      return self.updateTicketCustomFieldByIndex(id, fieldIdx, value);
-    });
-};
-
-/**
- *
- * @param {string|number} id ticketNbr
- * @param {string|number} caption
- * @param {string|number|boolean} value
- * @returns {Promise<Ticket>}
- */
-Tickets.prototype.updateTicketCustomFieldByCaption = function (id, caption, value) {
-  const self = this;
-  return self.getTicketById(id)
-    .then(function (ticket) {
-      let customFieldId;
-      ticket.customFields.forEach(function (elem, idx) {
-        if (elem.caption === caption) {
-          customFieldId = elem.id;
-        }
-      });
-
-      if (customFieldId === undefined) {
-        throw {
-          code: 'InvalidCustomFieldName',
-          message: 'No custom field found with caption specified',
-          errors: null
-        };
-      }
-
-      return self.updateTicketCustomFieldById(id, customFieldId, value);
-    });
-};
-
-/**
- *
- * @type {Tickets}
- */
-module.exports = Tickets;

package/src/ServiceDeskAPI/index.js

@@ -1,53 +0,0 @@
-/**
- * Created by kgrube on 12/15/2015.
- * @author kgrube
- */
-
-/**
- * @typedef {object} ServiceDeskAPI
- * @property {Tickets} Tickets
- * @property {Boards} Boards
- * @property {BoardTeams} BoardTeams
- * @property {Priorities} Priorities
- * @property {Statuses} Statuses
- * @property {ServiceNotes} ServiceNotes
- * @property {BoardItems} BoardItems
- * @property {BoardTypes} BoardTypes
- * @property {BoardSubTypes} BoardSubTypes
- */
-
-/**
- *
- * @param {CWOptions} options
- * @returns {ServiceDeskAPI}
- * @constructor
- */
-function ServiceDeskAPI(options) {
-  const _Tickets = require('./Tickets');
-  const _Boards = require('./Boards');
-  const _Priorities = require('./Priorities');
-  const _BoardTeams = require('./BoardTeams');
-  const _Statuses = require('./Statuses');
-  const _ServiceNotes = require('./ServiceNotes');
-  const _BoardItems = require('./BoardItems');
-  const _BoardTypes = require('./BoardTypes');
-  const _BoardSubTypes = require('./BoardSubTypes');
-
-  return {
-    Tickets: new _Tickets(options),
-    Boards: new _Boards(options),
-    BoardTeams: new _BoardTeams(options),
-    Priorities: new _Priorities(options),
-    Statuses: new _Statuses(options),
-    ServiceNotes: new _ServiceNotes(options),
-    BoardItems: new _BoardItems(options),
-    BoardTypes: new _BoardTypes(options),
-    BoardSubTypes: new _BoardSubTypes(options),
-  };
-}
-
-/**
- *
- * @type {ServiceDeskAPI}
- */
-module.exports = ServiceDeskAPI;