cityworks 1.0.4 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cityworks",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A Cityworks API wrapper",
   "main": "dist/index.js",
   "umd:main": "dist/index.umd.js",

package/dist/activity_link.js

@@ -1,219 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActivityLinks = void 0;
-var error_1 = require("./error");
-var reversible_map_1 = require("reversible-map");
-var _ = require('lodash');
-/**
- * ActivityLinks implements the activity link functions via using the ActivityLink interface
- *
- */
-var ActivityLinks = /** @class */ (function () {
-    /**
-     * @hidden
-     */
-    function ActivityLinks(cw) {
-        this.cw = cw;
-        this.activityTypes = new reversible_map_1.default();
-        this.activityTypes.set("null", 0);
-        this.activityTypes.set("case", 1);
-        this.activityTypes.set("inspection", 2);
-        this.activityTypes.set("request", 3);
-        this.activityTypes.set("workorder", 4);
-        this.activityTypes.set("wipcase", 5);
-        this.linkTypes = new reversible_map_1.default();
-        this.linkTypes.set("null", 0);
-        this.linkTypes.set("parent", 1);
-        this.linkTypes.set("related", 2);
-    }
-    /**
-     * Create a new activity link between two items.
-     *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-     *
-     *      "null", "parent", "related"
-     *
-     * @return {Object} Returns Promise object that represents a
-     */
-    ActivityLinks.prototype.add = function (source_type, source_sid, destination_type, destination_sid, link_type) {
-        var _this_1 = this;
-        if (link_type === void 0) { link_type = 'related'; }
-        return new Promise(function (resolve, reject) {
-            if (!_this_1.activityTypes.has(source_type)) {
-                reject(new error_1.CWError(1, 'Source type not found.', { 'provided': source_type, 'options': _this_1.activityTypes }));
-            }
-            if (!_this_1.activityTypes.has(destination_type)) {
-                reject(new error_1.CWError(2, 'Destination type not found.', { 'provided': destination_type, 'options': _this_1.activityTypes }));
-            }
-            if (!_this_1.linkTypes.has(link_type)) {
-                reject(new error_1.CWError(3, 'Link type not found.', { 'provided': link_type, 'options': _this_1.linkTypes }));
-            }
-            var data = {
-                SourceType: _this_1.activityTypes.get(source_type),
-                SourceSid: source_sid,
-                DestType: _this_1.activityTypes.get(destination_type),
-                DestSid: destination_sid,
-                LinkType: _this_1.linkTypes.get(link_type)
-            };
-            var path = 'General/ActivityLink/Add';
-            _this_1.cw.runRequest(path, data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get the links for a particular node type by ID.
-     *
-     * @param {string} type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {Array<number>} sids - Array of numeric (S)IDs you wish to get of the specified type
-     * @return {Object} Returns Promise object that represents a collection
-     */
-    ActivityLinks.prototype.get = function (type, sids) {
-        var _this_1 = this;
-        return new Promise(function (resolve, reject) {
-            if (!_this_1.activityTypes.has(type)) {
-                reject(new error_1.CWError(4, 'Activity type not found.', { 'provided': type, 'options': _this_1.activityTypes }));
-            }
-            var data = {
-                ActivityType: _this_1.activityTypes.get(type),
-                ActivitySids: sids
-            };
-            var _this = _this_1;
-            var path = 'General/ActivityLink/ByActivitySids';
-            _this_1.cw.runRequest(path, data).then(function (response) {
-                var return_data = new Array();
-                _.forEach(response.Value, function (link, key) {
-                    link.DestType = _this.activityTypes.get(link.DestType);
-                    link.SourceType = _this.activityTypes.get(link.SourceType);
-                    link.LinkType = _this.linkTypes.get(link.LinkType);
-                    return_data.push(link);
-                });
-                resolve(return_data);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Clone a current activity link.
-     *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} source_sid - Source SID (numeric ID) one wishes to clone a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} destination_sid - Destination SID (numeric ID) one wishes to clone a link between SID as destination and a particular source
-     * @return {Object} Returns Promise object that represents a
-     */
-    ActivityLinks.prototype.clone = function (source_type, source_sid, destination_type, destination_sid) {
-        var _this_1 = this;
-        return new Promise(function (resolve, reject) {
-            if (!_this_1.activityTypes.has(source_type)) {
-                reject(new error_1.CWError(1, 'Source type not found.', { 'provided': source_type, 'options': _this_1.activityTypes }));
-            }
-            if (!_this_1.activityTypes.has(destination_type)) {
-                reject(new error_1.CWError(2, 'Destination type not found.', { 'provided': destination_type, 'options': _this_1.activityTypes }));
-            }
-            var data = {
-                SourceActivityType: _this_1.activityTypes.get(source_type),
-                SourceActivitySid: source_sid,
-                DestinationActivityType: _this_1.activityTypes.get(destination_type),
-                DestinationActivitySid: destination_sid
-            };
-            var path = 'General/ActivityLink/CloneByActivitySid';
-            _this_1.cw.runRequest(path, data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Delete an activity link by ID
-     *
-     * @param {number} activity_link_id - The ID of the activity link one wishes to delete
-     * @return {Object} Returns Promise object that represents a
-     */
-    ActivityLinks.prototype.delete = function (activity_link_id) {
-        var _this_1 = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                ActivityLinkId: activity_link_id
-            };
-            var path = 'General/ActivityLink/Delete';
-            _this_1.cw.runRequest(path, data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Remove a link by specifying everything.
-     *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
-     * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-     *
-     *      "null", "parent", "related"
-     *
-     * @return {Object} Returns Promise object that represents a
-     */
-    ActivityLinks.prototype.remove = function (source_type, source_sid, destination_type, destination_sid, link_type) {
-        var _this_1 = this;
-        if (link_type === void 0) { link_type = 'related'; }
-        return new Promise(function (resolve, reject) {
-            if (!_this_1.activityTypes.has(source_type)) {
-                reject(new error_1.CWError(1, 'Source type not found.', { 'provided': source_type, 'options': _this_1.activityTypes }));
-            }
-            if (!_this_1.activityTypes.has(destination_type)) {
-                reject(new error_1.CWError(1, 'Destination type not found.', { 'provided': destination_type, 'options': _this_1.activityTypes }));
-            }
-            if (!_this_1.linkTypes.has(link_type)) {
-                reject(new error_1.CWError(1, 'Link type not found.', { 'provided': link_type, 'options': _this_1.linkTypes }));
-            }
-            var data = {
-                SourceType: _this_1.activityTypes.get(source_type),
-                SourceSid: source_sid,
-                DestType: _this_1.activityTypes.get(destination_type),
-                DestSid: destination_sid,
-                LinkType: _this_1.linkTypes.get(link_type)
-            };
-            var path = 'General/ActivityLink/Remove';
-            _this_1.cw.runRequest(path, data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    return ActivityLinks;
-}());
-exports.ActivityLinks = ActivityLinks;

package/dist/briefcase.js

@@ -1,327 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Briefcase = void 0;
-var error_1 = require("./error");
-var _ = require('lodash');
-var Briefcase = /** @class */ (function () {
-    /**
-     * @hidden
-     */
-    function Briefcase(cw) {
-        this.cw = cw;
-    }
-    /**
-     * Create new case
-     *
-     * @category Cases
-     * @param {number} caseTypeId - The case Type ID
-     * @param {number} subTypeId - The case subType ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    Briefcase.prototype.create = function (caseTypeId, subTypeId, options) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data_init = {
-                CaseTypeId: caseTypeId,
-                SubTypeId: subTypeId
-            };
-            var data = _.merge(data_init, options);
-            _this.cw.runRequest('Pll/Case/Create', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Create a child case
-     *
-     * @category Cases
-     * @param {number} busCaseId - The case Type ID
-     * @param {number} parentCaObjectId - The case subType ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    Briefcase.prototype.createChild = function (busCaseId, parentCaObjectId, options) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data_init = {
-                BusCaseId: busCaseId,
-                ParentCaObjectId: parentCaObjectId
-            };
-            var data = _.merge(data_init, options);
-            _this.cw.runRequest('Pll/Case/CreateChild', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Create a case from a Service Request
-     *
-     * @category Cases
-     * @param {number} caseTypeId - The case Type ID
-     * @param {number} subTypeId - The case subType ID
-     * @param {number} requestId - The service request ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    Briefcase.prototype.createFromRequest = function (caseTypeId, subTypeId, requestId, options) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data_init = {
-                CaseTypeId: caseTypeId,
-                SubTypeId: subTypeId,
-                ServiceRequestId: requestId
-            };
-            var data = _.merge(data_init, options);
-            _this.cw.runRequest('Pll/CaseObject/CreateCaseFromServiceRequest', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Update a case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case Object ID to update
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the updated case
-     */
-    Briefcase.prototype.update = function (caObjectId, options) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data_init = {
-                CaObjectId: caObjectId
-            };
-            var data = _.merge(data_init, options);
-            _this.cw.runRequest('Pll/CaseObject/Update', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get cases by IDs
-     *
-     * @category Cases
-     * @param {Array<number>} caObjectIds - The case Object ID to update
-     * @return {Object} Returns Promise that represents a collection of objects describing the cases
-     */
-    Briefcase.prototype.getByIds = function (caObjectIds) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectIds: caObjectIds
-            };
-            _this.cw.runRequest('Pll/CaseObject/ByIds', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Cases
-     * @param {Object} filters - The parameter(s) to search by
-     * @return {Object} Returns Promise that represents an Array of case Object IDs
-     */
-    Briefcase.prototype.search = function (filters) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = filters;
-            _this.cw.runRequest('Pll/CaseObject/Search', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Move a Case point
-     *
-     * @category Cases
-     * @param {string} caObjectId
-     * @param {number} x
-     * @param {number} y
-     * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents an object describing the updated GISPoint
-     */
-    Briefcase.prototype.move = function (caObjectId, x, y, projection, z) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            if (!_.has(projection, 'WKID') && !_.has(projection, 'WKT')) {
-                // Throw error
-                reject(new error_1.CWError(1, 'You must provide either the WKID or WKT for the x/y coordinates.', { 'projection': projection }));
-            }
-            var data_init = {
-                CaObjectId: caObjectId,
-                X: x,
-                Y: y
-            };
-            if (typeof (z) != 'undefined') {
-                _.set(data_init, 'Z', z);
-            }
-            var data = _.merge(data_init, projection);
-            _this.cw.runRequest('Pll/CaseObject/Move', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Delete case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case Object ID
-     * @return {Object} Returns Promise that represents an object describing the deleted case
-     */
-    Briefcase.prototype.delete = function (caObjectId) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId
-            };
-            _this.cw.runRequest('Pll/CaseObject/DeleteCase', data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get Map Layer Fields
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case object ID to get the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields
-     */
-    Briefcase.prototype.getMLFs = function (caObjectId) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId
-            };
-            var path = 'Ams/TemplateMapLayer/CaseInstanceMapLayersByCaObjectId';
-            _this.cw.runRequest(path, data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Update Map Layer Fields
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case object ID to get the map layer fields for.
-     * @param {number} x
-     * @param {number} y
-     * @param {number} domainId - The domain ID for the case in question
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields
-     */
-    Briefcase.prototype.updateMLFs = function (caObjectId, x, y, domainId, z) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId
-            };
-            var path = 'Ams/TemplateMapLayer/UpdateCaseInstanceMapLayers';
-            if (_.isNumber(x)) {
-                _.set(data, 'X', x);
-            }
-            if (_.isNumber(y)) {
-                _.set(data, 'Y', y);
-            }
-            if (_.isNumber(z)) {
-                _.set(data, 'Z', z);
-            }
-            if (_.isNumber(domainId)) {
-                _.set(data, 'DomainId', domainId);
-            }
-            _this.cw.runRequest(path, data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Delete Map Layer Fields
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case object ID to delete the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields deleted
-     */
-    Briefcase.prototype.deleteMLFs = function (caObjectId) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId
-            };
-            var path = 'Ams/TemplateMapLayer/DeleteCaseInstanceMapLayersByCaObjectId';
-            _this.cw.runRequest(path, data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Reports available for Case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case object ID to get the report (print template) list for
-     * @return {Object} Returns Promise that represents a collection of Objects describing the reports (print templates) available for this case
-     */
-    Briefcase.prototype.getPrintTemplates = function (caObjectId) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId
-            };
-            var path = 'Pll/BusinessCaseReports/ByCaObjectId';
-            _this.cw.runRequest(path, data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Print Case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case object ID to delete the map layer fields for.
-     * @param {string} fileName - the filename of the report from the getPrintTemplates method, but w/out the extension
-     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields deleted
-     */
-    Briefcase.prototype.print = function (caObjectId, fileName) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                CaObjectId: caObjectId,
-                FileName: fileName
-            };
-            var path = 'Pll/BusinessCaseReports/Download';
-            // TODO: test the Filename to make sure it's in the File list from getPrintTemplates (or let the API just error?)
-            _this.cw.runRequest(path, data).then(function (r) {
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    return Briefcase;
-}());
-exports.Briefcase = Briefcase;

package/dist/case.d.ts

@@ -1,114 +0,0 @@
-export declare class Case {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Data Detail methods
-     */
-    data?: Object;
-    /**
-     * Asset (Address) methods
-     */
-    asset?: Object;
-    /**
-     * Workflow & task methods
-     */
-    workflow?: Object;
-    /**
-     * Payment, Receipt, & Fee methods
-     */
-    financial?: Object;
-    /**
-     * Commenting methods
-     */
-    comment?: Object;
-    /**
-     * PLL Administration methods
-     */
-    admin?: Object;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Create new case
-     *
-     * @category Cases
-     * @param {number} caseTypeId - The case Type ID
-     * @param {number} subTypeId - The case subType ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    create(caseTypeId: number, subTypeId: number, options?: Object): Promise<unknown>;
-    /**
-     * Create a child case
-     *
-     * @category Cases
-     * @param {number} busCaseId - The case Type ID
-     * @param {number} parentCaObjectId - The case subType ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    createChild(busCaseId: number, parentCaObjectId: number, options?: Object): Promise<unknown>;
-    /**
-     * Create a case from a Service Request
-     *
-     * @category Cases
-     * @param {number} caseTypeId - The case Type ID
-     * @param {number} subTypeId - The case subType ID
-     * @param {number} requestId - The service request ID
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the newly-created case
-     */
-    createFromRequest(caseTypeId: number, subTypeId: number, requestId: number, options?: Object): Promise<unknown>;
-    /**
-     * Update a case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case Object ID to update
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-     * @return {Object} Returns Promise that represents an object describing the updated case
-     */
-    update(caObjectId: number, options?: Object): Promise<unknown>;
-    /**
-     * Get cases by IDs
-     *
-     * @category Cases
-     * @param {Array<number>} caObjectIds - The case Object ID to update
-     * @return {Object} Returns Promise that represents a collection of objects describing the cases
-     */
-    getByIds(caObjectIds: Array<number>): Promise<unknown>;
-    /**
-     * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Cases
-     * @param {Object} filters - The parameter(s) to search by
-     * @return {Object} Returns Promise that represents an Array of case Object IDs
-     */
-    search(filters: Object): Promise<unknown>;
-    /**
-     * Move a Case point
-     *
-     * @category Cases
-     * @param {string} caObjectId
-     * @param {number} x
-     * @param {number} y
-     * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents an object describing the updated GISPoint
-     */
-    move(caObjectId: number, x: number, y: number, projection: {
-        WKID?: string;
-        WKT?: string;
-        VcsWKID?: string;
-    }, z?: number): Promise<unknown>;
-    /**
-     * Delete case
-     *
-     * @category Cases
-     * @param {number} caObjectId - The case Object ID
-     * @return {Object} Returns Promise that represents an object describing the deleted case
-     */
-    delete(caObjectId: number): Promise<unknown>;
-}