cityworks 0.0.51 → 0.0.53

package/dist/case_workflow.js

@@ -0,0 +1,455 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseWorkflow = void 0;
+var error_1 = require("./error");
+var _ = require('lodash');
+var comments_1 = require("./comments");
+var CaseWorkflow = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function CaseWorkflow(cw) {
+        this.cw = cw;
+        this.task = {
+            comment: new comments_1.Comments(cw, 'CaTask')
+        };
+    }
+    /**
+     * Adds a task to the case specified by the CaObectId.
+     *
+     * @category Tasks
+     * @param {number} caObjectId - The Case Object to attach the task to
+     * @param {number} taskId - The task ID to add to the case workflow
+     * @param {number} startPoint - The start point in the workflow for the task
+     * @param {number} endPoint - The end point in the workflow for the task
+     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    CaseWorkflow.prototype.addTask = function (caObjectId, taskId, startPoint, endPoint, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                TaskId: taskId,
+                StartPoint: startPoint,
+                EndPoint: endPoint
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseTask/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Add Task Result
+     *
+     * @category Task Results
+     * @param {number} caObjectId - The Case Object to attach the task to
+     * @param {number} caTaskId - The Case task ID to add the result to
+     * @param {number} resultCode - The result Code
+     * @param {number} resultID - The result ID
+     * @param {number} resultSetID - The result set ID
+     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
+     * @return {Object} Returns Promise that represents an object describing CaTaskResultsItem.
+     */
+    CaseWorkflow.prototype.addTaskResult = function (caObjectId, caTaskId, resultCode, resultID, resultSetID, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                CaTaskId: caTaskId,
+                ResultCode: resultCode,
+                ResultID: resultID,
+                ResultSetID: resultSetID
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseTaskResults/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Add Task Comment
+     *
+     * @category Comments
+     * @param {number} caTaskId - The Case task ID of the task to add the comment to
+     * @param {string} comment - The comment text
+     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
+     */
+    CaseWorkflow.prototype.addTaskComment = function (caTaskId, comment) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskId: caTaskId,
+                CommentText: comment
+            };
+            _this.cw.runRequest('Pll/CaseTaskComments/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get tasks by CaObjectId
+     *
+     * @category Tasks
+     * @param {number} caObjectId - The Case Object to get the attached tasks
+     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
+     */
+    CaseWorkflow.prototype.getTasksByCaseId = function (caObjectId, checkRelatedItems) {
+        var _this = this;
+        if (checkRelatedItems === void 0) { checkRelatedItems = false; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                CheckRelatedItems: checkRelatedItems
+            };
+            _this.cw.runRequest('Pll/CaseTask/ByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get tasks by TaskIds
+     *
+     * @category Tasks
+     * @param {Array<number>} caTaskIds - The IDs of the tasks to retrieve
+     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
+     */
+    CaseWorkflow.prototype.getTasksById = function (caTaskIds, checkRelatedItems) {
+        var _this = this;
+        if (checkRelatedItems === void 0) { checkRelatedItems = false; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskIds: caTaskIds,
+                CheckRelatedItems: checkRelatedItems
+            };
+            _this.cw.runRequest('Pll/CaseTask/ByIds', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get CaTaskResultsItem by CaTaskIds
+     *
+     * @category Task Results
+     * @param {Array<number>} caTaskIds - The IDs of the tasks for which to retrieve results
+     * @return {Object} Returns Promise that represents a collection of CaTaskResultsItems.
+     */
+    CaseWorkflow.prototype.getResultsByTaskId = function (caTaskIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskIds: caTaskIds
+            };
+            _this.cw.runRequest('Pll/CaseTaskResults/ByCaTaskIds', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for CaseTaskComments by CaTaskId
+     *
+     * @category Comments
+     * @param {number} caTaskId - The task ID for which to retrieve attached comments
+     * @return {Object} Returns Promise that represents a collection of CommentRecords.
+     */
+    CaseWorkflow.prototype.getCommentsForTask = function (caTaskId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                caTaskId: caTaskId
+            };
+            _this.cw.runRequest('Pll/CaseTaskComments/ByCaTaskId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for CaseTaskComments by CaTaskId
+     *
+     * @category Comments
+     * @param {Array<number>} caTaskIds - The task IDs for which to retrieve attached comments
+     * @return {Object} Returns Promise that represents a collection of CaTaskCommentsItemBase.
+     */
+    CaseWorkflow.prototype.getCommentsForTasks = function (caTaskIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                caTaskIds: caTaskIds
+            };
+            _this.cw.runRequest('Pll/CaseTaskComments/ByCaTaskIds', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Updates a task
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The Case Object to attach the task to
+     * @param {Object} [options] - Options for Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    CaseWorkflow.prototype.updateTask = function (caTaskId, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskId: caTaskId
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseTask/Update', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Update Task Comment
+     *
+     * @category Comments
+     * @param {number} caTaskCommentId - The Case task ID of the task to add the comment to
+     * @param {string} comment - The comment text
+     * @param {number} commentId - Probably unnecessary?
+     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
+     */
+    CaseWorkflow.prototype.updateTaskComment = function (caTaskCommentId, comment, commentId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskCommentId: caTaskCommentId,
+                CommentText: comment
+            };
+            if (typeof (commentId) != 'undefined') {
+                _.set(data, 'CommentId', commentId);
+            }
+            _this.cw.runRequest('Pll/CaseTaskComments/Update', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Updates a task
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The Case Object to attach the task to
+     * @param {string} resultCode - The result code to set for the specified Task
+     * @param {Object} [options] - Options for Task. Specify either or both TaskCompletedBy & TaskCompleteDate. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    CaseWorkflow.prototype.setTaskResult = function (caTaskId, resultCode, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskId: caTaskId
+            };
+            if (_.intersectionBy(_.keysIn(options), ['TaskCompleteDate', 'TaskCompletedBy']).length == 0) {
+                reject(new error_1.CWError(2, 'At least one of the attributes (TaskCompletedBy, TaskCompleteDate) must be defined.'));
+            }
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseTask/SetResult', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Deletes a task by TaskID
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The caTaskId for the task which should be deleted
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    CaseWorkflow.prototype.deleteTask = function (caTaskId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskId: caTaskId
+            };
+            _this.cw.runRequest('Pll/CaseTask/Delete', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Deletes a task by TaskID
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The caTaskId for the task which should be deleted
+     * @return {Object} Returns Promise that represents the number of the CaObjectID
+     */
+    CaseWorkflow.prototype.deleteTasksOnCase = function (caObjectId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId
+            };
+            _this.cw.runRequest('Pll/CaseTask/DeleteByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Deletes tasks by TaskID
+     *
+     * @category Comments
+     * @param {Array<number>} caTaskCommentIds - The comments to delete
+     * @return {Object} Returns Promise that represents a dictionary of comment IDs.
+     */
+    CaseWorkflow.prototype.deleteTaskComments = function (caTaskCommentIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskCommentIds: caTaskCommentIds
+            };
+            _this.cw.runRequest('Pll/CaseTaskComments/Delete', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for Case Tasks. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Tasks
+     * @param {Object} filters - The parameters to search by. (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType)
+     * @return {Object} Returns Promise that represents a collection of resulting CaTaskIDs
+     */
+    CaseWorkflow.prototype.searchForTasks = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['ResponsibleUserId', 'TaskAvailable', 'TaskComplete', 'TaskType']).length == 0) {
+                reject(new error_1.CWError(1, 'At least one of the attributes (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseTask/Search', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for CaseTaskResults Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Task Results
+     * @param {Object} filters - The parameters to search by. See: /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
+     * @return {Object} Returns Promise that represents a collection of resulting CaTaskResultsItem
+     */
+    CaseWorkflow.prototype.searchForTaskResults = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseTaskResults/Search', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+       * Adds a task to the case specified by the CaObectId.
+       *
+       * @category Task Attachments
+       * @param {number} caTaskId - The Task ID to attach the document to
+       * @param {number} caObjectId - The Case Object ID
+       * @param {string} docName - The file name as it should display in the system
+       * @param {string} locationType - The location of the file...leave blank
+       * @param {any} file - The binary string for the file
+       * @return {Object} Returns Promise that represents an object describing added Attachment
+       */
+    CaseWorkflow.prototype.addTaskAttachment = function (caTaskId, caObjectId, docName, file, locationType) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                CaTaskId: caTaskId,
+                DocName: docName
+            };
+            if (typeof (locationType) != 'undefined') {
+                _.set(data, 'LocationType', locationType);
+            }
+            _this.cw.runRequest('Pll/CaseRelDocs/AddTaskRelDoc', data, file).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+       * Gets each Document Attached to the specified Task
+       *
+       * @category Task Attachments
+       * @param {number} caTaskId - The Task ID to attach the document to
+       * @return {Object} Returns Promise that represents a collection of objects describing each Attachment on the provided task
+       */
+    CaseWorkflow.prototype.getTaskAttachments = function (caTaskId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaTaskId: caTaskId
+            };
+            _this.cw.runRequest('Pll/CaseRelDocs/ByCaTaskId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Deletes a task attachment by caRelDocId (Related Case Document ID). Same as RelDocs delete for case.
+     *
+     * @category Task Attachments
+     * @param {number} caRelDocId - The caRelDocId for the related document which should be deleted
+     * @return {Object} Returns Promise that represents the an object describing the deleted document.
+     */
+    CaseWorkflow.prototype.deleteTaskAttachment = function (caRelDocId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaRelDocId: caRelDocId
+            };
+            _this.cw.runRequest('PLL/CaseRelDocs/Delete', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return CaseWorkflow;
+}());
+exports.CaseWorkflow = CaseWorkflow;

package/dist/comments.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Comments = void 0;
+var error_1 = require("./error");
+var reversible_map_1 = require("reversible-map");
+var _ = require('lodash');
+/**
+ * A plugin that contains "comments" methods
+ */
+var Comments = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function Comments(cw, activityType) {
+        this.cw = cw;
+        this.activityTypes = new reversible_map_1.default();
+        this.activityTypes.set("Unknown", 0);
+        this.activityTypes.set("Request", 1);
+        this.activityTypes.set("WorkOrder", 2);
+        this.activityTypes.set("CaTask", 3);
+        this.activityTypes.set("CaObject", 4);
+        this.activityTypes.set("CaCorrection", 5);
+        this.activityTypes.set("Project", 6);
+        this.activityTypes.set("Contract", 7);
+        if (!this.activityTypes.has(activityType)) {
+            throw new error_1.CWError(1, 'Comment activity type not found.', { 'provided': activityType, 'options': this.activityTypes });
+        }
+        this.currentActivityType = activityType;
+    }
+    /**
+     * Add a comment - for adding a comment to an object when the object is already known. Always call comment.add from request, case, workorder, or inspection.
+     *
+     * @param {number} sid - The SID of the activity to which the comment should be attached
+     * @param {string} comment - The text for the comment
+     * @return {Object} Returns a Promise which represents a CommentRecord object
+     */
+    Comments.prototype.add = function (sid, comment) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                ActivityType: _this.activityTypes.get(_this.currentActivityType),
+                ActivitySid: sid,
+                Comments: comment
+            };
+            _this.cw.runRequest('Ams/Comment/Add', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Update a comment
+     *
+     * @param {number} id - The ID of the comment which should be updated
+     * @param {string} comment - The new text for the updated comment
+     * @return {Object} Returns a Promise which represents a CommentRecord object
+     */
+    Comments.prototype.update = function (id, comment) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                ActivityType: _this.activityTypes.get(_this.currentActivityType),
+                CommentId: id,
+                Comments: comment
+            };
+            _this.cw.runRequest('Ams/Comment/Update', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get comments for activity items
+     *
+     * @param {Array<number>} sids - The options SIDs to get comments for.
+     * @return {Object} Returns Promise object that represents a collection of available comments
+     */
+    Comments.prototype.get = function (sids) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (typeof (sids) != 'undefined' && sids != null) {
+                var data = {
+                    ActivitySids: sids,
+                    ActivityType: _this.activityTypes.get(_this.currentActivityType),
+                };
+                _this.cw.runRequest('Ams/Comment/ByActivitySids', data).then(function (response) {
+                    if (sids.length == 1) {
+                        resolve(response.Value[sids[0]]);
+                    }
+                    else {
+                        resolve(response.Value);
+                    }
+                });
+            }
+        });
+    };
+    /**
+     * Get pre-defined comments for activityTypes
+     *
+     * @param {number} problemSid - The ProblemSid if currentActivityType is (Service) Request
+     * @param {string} [category] - Only applies to WorkOrder and ServiceRequest category comments.
+     * @return {Object} Returns Promise object that represents a collection of available comment templates.
+     */
+    Comments.prototype.getPredefined = function (problemSid, category) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {};
+            if (_this.currentActivityType == 'Request') {
+                _.set(data, 'ProblemSid', problemSid);
+            }
+            if (typeof (category) != 'undefined' && (_this.currentActivityType == 'Request' || _this.currentActivityType == 'WorkOrder')) {
+                _.set(data, 'Category', category);
+            }
+            _.set(data, 'ActivityType', _this.activityTypes.get(_this.currentActivityType));
+            _this.cw.runRequest('Ams/Comment/PredefinedComments', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return Comments;
+}());
+exports.Comments = Comments;

package/dist/error.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CWError = void 0;
+var _ = require('lodash');
+/**
+ * CWError implements a custom error class for this codebase with additional information
+ *
+ */
+var CWError = /** @class */ (function () {
+    /**
+     * CWError implements a custom error class for this codebase with additional information
+     *
+     * @param {number} code - Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
+     * @param {string} message - The error message
+     * @param {Object} info - Object stuffed with any other information one wishes to include in the thrown error
+     * @return {Object} Returns instance of CWError object
+     */
+    function CWError(code, message, info) {
+        this.name = "Cityworks Exception";
+        this.code = code;
+        this.message = message;
+        if (typeof (info) !== 'undefined') {
+            if (_.has(info, 'Message'))
+                this.message = _.get(info, 'Message');
+            this.info = JSON.stringify(info);
+        }
+    }
+    return CWError;
+}());
+exports.CWError = CWError;