connectwise-rest 0.23.3 → 1.0.0

package/src/ServiceDeskAPI/Boards.js

@@ -1,100 +0,0 @@
-/**
- * Created by kgrube on 12/24/2015.
- * @author kgrube
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Board
- * @property {number} id
- * @property {string} name
- * @property {number} locationId
- * @property {number} businessUnitId
- * @property {boolean} inactive removed in 2019.1
- * @property {boolean} inactiveFlag added in 2019.1
- * @property {number} signOffTemplateId
- * @property {boolean} sendToContact
- * @property {number} contactTemplateId
- * @property {boolean} sendToResource
- * @property {number} resourceTemplateId
- * @property {object} _info
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @constructor
- */
-function Boards(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Boards, ConnectWise);
-
-/**
- * GET
- * @param {Params} params
- * @returns {Promise<Board[]>}
- */
-Boards.prototype.getBoards = function (params) {
-  return this.api('/service/boards', 'GET', params);
-};
-
-/**
- * POST
- * @param {Board} board
- * @returns {Promise<Board[]>}
- */
-Boards.prototype.createBoard = function (board) {
-  return this.api('/service/boards', 'POST', board);
-};
-
-/**
- * GET
- * @param id
- * @returns {Promise<Board[]>}
- */
-Boards.prototype.getBoardById = function (id) {
-  return this.api(`/service/boards/${id}`, 'GET');
-};
-
-/**
- * GET
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-Boards.prototype.getBoardsCount = function (params) {
-  return this.api('/service/boards/count', 'GET', params);
-};
-
-/**
- * PATCH
- * @param id
- * @param {Operations[]} ops
- * @returns {Promise<Board>}
- */
-Boards.prototype.updateBoard = function (id, ops) {
-  return this.api(`/service/boards/${id}`, 'PATCH', ops);
-};
-
-/**
- *
- * @param id
- * @param {Board} board
- * @returns {Promise<Board>}
- */
-Boards.prototype.replaceBoard = function (id, board) {
-  return this.api(`/service/boards/${id}`, 'PUT', board);
-};
-
-/**
- *
- * @type {Boards}
- */
-module.exports = Boards;

package/src/ServiceDeskAPI/Priorities.js

@@ -1,47 +0,0 @@
-/**
- * Created by kgrube on 12/24/2015.
- * @author kgrube
- * @TODO complete module
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-/**
- * @typedef {object} Priority
- * @property {number} id
- * @property {string} name
- * @property {string} color
- * @property {number} sortOrder
- * @property {boolean} defaultFlag
- * @property {string} imageLink
- * @property {object} _info
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @constructor
- */
-function Priorities(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(Priorities, ConnectWise);
-
-/**
- *
- * @param {Params} params
- * @returns {Promise<Priority[]>}
- */
-Priorities.prototype.getPriorities = function (params) {
-  return this.api('/service/priorities', 'GET', params);
-};
-
-/**
- *
- * @type {Priorities}
- */
-module.exports = Priorities;

package/src/ServiceDeskAPI/ServiceNotes.js

@@ -1,172 +0,0 @@
-/**
- * Created by kgrube on 1/18/2016.
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} ServiceNote
- * @property {number} id
- * @property {number} ticketId
- * @property {string} text the text of the particular note
- * @property {boolean} detailDescriptionFlag
- * @property {boolean} internalAnalysisFlag
- * @property {boolean} resolutionFlag
- * @property {MemberHref} member null if not applicable
- * @property {ContactHref} contact null if not applicable
- * @property {boolean} [customerUpdatedFlag]
- * @property {boolean} [processNotifications]
- * @property {string} dateCreated
- * @property {string} createdBy
- * @property {boolean} internalFlag
- * @property {boolean} externalFlag
- * @property {object} _info
- * @property {string} _info.lastUpdated
- * @property {string} _info.updatedBy
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @constructor
- */
-function ServiceNotes(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-inherits(ServiceNotes, ConnectWise);
-
-/**
- * GET
- * @param ticketId
- * @param {Params} params
- * @returns {Promise<ServiceNote[]>}
- */
-ServiceNotes.prototype.getServiceNotes = function (ticketId, params) {
-  return this.api(`/service/tickets/${ticketId}/notes`, 'GET', params);
-};
-
-/**
- * POST
- * @param {string|number} ticketId
- * @param {ServiceNote} note
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.createServiceNote = function (ticketId, note) {
-  return this.api(`/service/tickets/${ticketId}/notes`, 'POST', note);
-};
-
-/**
- * GET
- * @param ticketId
- * @param {ParamsConditions} params
- * @returns {Promise<Count>}
- */
-ServiceNotes.prototype.getServiceNotesCount = function (ticketId, params) {
-  return this.api(`/service/tickets/${ticketId}/notes/count`, 'GET', params);
-};
-
-/**
- *
- * @param ticketId
- * @param noteId
- * @returns {Promise<DeleteResponse>}
- */
-ServiceNotes.prototype.deleteServiceNoteById = function (ticketId, noteId) {
-  return this.api(`/service/tickets/${ticketId}/notes/${noteId}`, 'DELETE');
-};
-
-/**
- *
- * @param ticketId
- * @param noteId
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.getServiceNoteById = function (ticketId, noteId) {
-  return this.api(`/service/tickets/${ticketId}/notes/${noteId}`, 'GET', params);
-};
-
-/**
- *
- * @param ticketId
- * @param noteId
- * @param {ServiceNote} note
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.updateServiceNote = function (ticketId, noteId, note) {
-  return this.api(`/service/tickets/${ticketId}/notes/${noteId}`, 'PATCH', note);
-};
-
-/**
- *
- * @param ticketId
- * @param noteId
- * @param {ServiceNote} note
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.replaceServiceNote = function (ticketId, noteId, note) {
-  return this.api(`/service/tickets/${ticketId}/notes/${noteId}`, 'PUT', note);
-};
-
-/**
- *
- * @param {string|number} ticketId
- * @param {string} text
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.createServiceNoteInternal = function (ticketId, text) {
-  return this.createServiceNote(ticketId, {
-    text: text,
-    internalAnalysisFlag: true
-  });
-};
-
-/**
- *
- * @param {string|number} ticketId
- * @param {string} text
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.createServiceNoteDetail = function (ticketId, text) {
-  return this.createServiceNote(ticketId, {
-    text: text,
-    detailDescriptionFlag: true
-  });
-};
-
-/**
- *
- * @param {string|number} ticketId
- * @param {string} text
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.createServiceNoteResolution = function (ticketId, text) {
-  return this.createServiceNote(ticketId, {
-    text: text,
-    resolutionFlag: true
-  });
-};
-
-/**
- *
- * @param {string|number} ticketId
- * @param {string} text
- * @returns {Promise<ServiceNote>}
- */
-ServiceNotes.prototype.createServiceNoteDetailAndResolution = function (ticketId, text) {
-  return this.createServiceNote(ticketId, {
-    text: text,
-    detailDescriptionFlag: true,
-    resolutionFlag: true
-  });
-};
-
-/**
- *
- * @type {ServiceNotes}
- */
-module.exports = ServiceNotes;

package/src/ServiceDeskAPI/Statuses.js

@@ -1,116 +0,0 @@
-/**
- * Created by kgrube on 1/8/2016.
- * @author kgrube
- */
-
-/**
- * @private
- */
-const inherits = require('util').inherits;
-const ConnectWise = require('../ConnectWise.js');
-
-/**
- * @typedef {object} Status
- * @property {number} id
- * @property {string} name
- * @property {number} boardId
- * @property {number} sortOrder
- * @property {boolean} displayOnBoard
- * @property {boolean} inactive removed in 2019.1
- * @property {boolean} inactiveFlag added in 2019.1
- * @property {boolean} closedStatus
- * @property {boolean} timeEntryNotAllowed
- * @property {boolean} defaultFlag
- * @property {string} escalationStatus ['NotResponded', 'Responded', 'Plan', 'Resolved', 'NoEscalation']
- * @property {object} _info
- *
- */
-
-/**
- *
- * @param {CWOptions} options
- * @inherits {ConnectWise}
- * @constructor
- */
-function Statuses(options) {
-  ConnectWise.apply(this, Array.prototype.slice.call(arguments));
-}
-
-inherits(Statuses, ConnectWise);
-
-/**
- *
- * @param boardId
- * @param {Params} params
- * @returns {Promise<Status[]>}
- */
-Statuses.prototype.getStatusesByBoardId = function (boardId, params) {
-  return this.api(`/service/boards/${boardId}/statuses`, 'GET', params);
-};
-
-/**
- *
- * @param boardId
- * @param {Status} status
- * @returns {Promise<Status>}
- */
-Statuses.prototype.createStatuses = function (boardId, status) {
-  return this.api(`/service/boards/${boardId}/statuses`, 'POST', status);
-};
-
-/**
- *
- * @param boardId
- * @returns {Promise<Count>}
- */
-Statuses.prototype.getStatusesCount = function (boardId) {
-  return this.api(`/service/boards/${boardId}/statuses/count`, 'GET');
-};
-
-/**
- *
- * @param boardId
- * @param statusId
- * @returns {Promise<DeleteResponse>}
- */
-Statuses.prototype.deleteStatusById = function (boardId, statusId) {
-  return this.api(`/service/boards/${boardId}/statuses/${statusId}`, 'DELETE');
-};
-
-/**
- *
- * @param boardId
- * @param statusId
- * @returns {Promise<Status>}
- */
-Statuses.prototype.getStatusById = function (boardId, statusId) {
-  return this.api(`/service/boards/${boardId}/statuses/${statusId}`, 'GET');
-};
-
-/**
- *
- * @param boardId
- * @param statusId
- * @param {Operations[]} operations
- * @returns {Promise<Status>}
- */
-Statuses.prototype.updateStatus = function (boardId, statusId, operations) {
-  return this.api(`/service/boards/${boardId}/statuses/${statusId}`, 'PATCH', operations);
-};
-
-/**
- *
- * @param boardId
- * @param statusId
- * @param {Status} status
- * @returns {Promise<Status>}
- */
-Statuses.prototype.replaceStatuses = function (boardId, statusId, status) {
-  return this.api(`/service/boards/${boardId}/statuses/${statusId}`, 'PUT', status);
-};
-
-/**
- *
- * @type {Statuses}
- */
-module.exports = Statuses;