cityworks 0.0.52 → 1.0.1

package/dist/request_admin.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestAdmin = void 0;
+var _ = require('lodash');
+var RequestAdmin = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function RequestAdmin(cw) {
+        this.cw = cw;
+    }
+    /**
+     * Get service request templates
+     *
+     * @category Requests Admin
+     * @param {Object} searchData - search data
+     * @return {Object} Returns Promise that represents a collection of all Service Request Templates
+     */
+    RequestAdmin.prototype.getTemplates = function (searchData) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = searchData;
+            _this.cw.runRequest('Ams/ServiceRequestTemplate/Templates', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return RequestAdmin;
+}());
+exports.RequestAdmin = RequestAdmin;

package/dist/request_costs.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestCosts = void 0;
+var _ = require('lodash');
+var RequestCosts = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function RequestCosts(cw) {
+        this.cw = cw;
+        this.currentActivityType = "Request";
+    }
+    /**
+     * Get Cost Codes
+     *
+     * @category Labor Costs
+     * @param {Array<number>} employeeSids - A list of Employee IDs for which to get the job codes.
+     * @param {boolean} commonOnly - Set to true to get the Cost Codes that are common to ALL employees in the list, otherwise get all job codes that apply to at least one employee in the list.
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    RequestCosts.prototype.getCodes = function (employeeSids, commonOnly) {
+        var _this = this;
+        if (commonOnly === void 0) { commonOnly = false; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                EmployeeSids: employeeSids,
+                CommonCodesOnly: commonOnly
+            };
+            _this.cw.runRequest('Ams/LaborCost/CostCodes', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get Job Codes
+     *
+     * @category Labor Costs
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    RequestCosts.prototype.getJobCodes = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            _this.cw.runRequest('Ams/LaborCost/JobCodes').then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Add Request Labor Costs
+     *
+     * @category Request Costs
+     * @param {Object} requestCosts - Array of inspection labor costings
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    RequestCosts.prototype.addLabor = function (requestCosts) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = requestCosts;
+            // TODO: ensure each object has Hours & InspectionId
+            _this.cw.runRequest('Ams/LaborCost/AddRequestCosts', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+    * Get Labor Costs for Request(s)
+    *
+    * @category Request Costs
+    * @param {Array<number>} requestIds - Array of request Ids to get costs for
+    * @return {Object} Returns Promise that represents an object describing
+    */
+    RequestCosts.prototype.getLabor = function (requestIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                RequestIds: requestIds
+            };
+            _this.cw.runRequest('Ams/LaborCost/RequestCostsByRequest', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Delete Request Labor Costs
+     *
+     * @category Request Costs
+     * @param {Array<number>} laborCostIds - Array of request labor cost Ids to delete
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    RequestCosts.prototype.deleteLabor = function (laborCostIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                LaborCostIds: laborCostIds
+            };
+            _this.cw.runRequest('Ams/LaborCost/DeleteRequestCosts', data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return RequestCosts;
+}());
+exports.RequestCosts = RequestCosts;

package/dist/search.d.ts

@@ -12,7 +12,7 @@ export declare class Search {
      */
     constructor(cw: any);
     /**
-     * Do a "quick" search for any string (an ID is best)
+     * Do a "quick" search for an ID or Case Number
      *
      * @category Quick Search
      * @param {string} text - text to search the system for
@@ -124,4 +124,15 @@ export declare class Search {
      * @return {Object} Returns Promise object that represents a SearchDefinitionName object
      */
     saveDefinition(searchFor: string, options?: Object, searchId?: number): Promise<unknown>;
+    /**
+     * Convert a search definition to a query
+     *
+     * @category Search Definitions
+     * @param {Array<number>} searchIds - searchIds to convert
+     * @param {boolean} saveQuery - Automatically save a query which converts with no errors, default is false
+     * @param {boolean} allowMultipleBooleanValues - Use all values for boolean fields even though a boolean should only have one value, default is false and will only use the first boolean value
+     * @param {boolean} allowEmptyQuery - Create default filter when no filter is found, default is false
+     * @return {Object} Returns Promise object that represents a SearchToQueryResult list
+     */
+    convertToQuery(searchIds: Array<number>, saveQuery?: boolean, addEurl?: boolean, allowMultipleBooleanValues?: boolean, allowEmptyQuery?: boolean): Promise<unknown>;
 }

package/dist/search.js

@@ -0,0 +1,371 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Search = void 0;
+var error_1 = require("./error");
+var _ = require('lodash');
+var Search = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function Search(cw) {
+        /**
+         * Search Types: Null, Request, WorkOrder, Inspection, Contract, Permit, GIS, PermitTask, PermitAddress, InspCommon, Case, WorkOrderEntity, StoreTransaction, Requisition, Material, WorkActivity, MaterialLeaf, WoTemplate, Unknown, Employee, MessageQueue, Analytics, TokenState, AssetCalculationResult, Equipment, CustomerAccount, InspTemplate, ProblemLeaf, AssetSplitRecord, PavementInsp, TvInspection, Projects
+         */
+        this.searchTypes = {
+            "Null": 0,
+            "Request": 1,
+            "WorkOrder": 2,
+            "Inspection": 3,
+            "Contract": 4,
+            "Permit": 5,
+            "GIS": 6,
+            "PermitTask": 7,
+            "PermitAddress": 8,
+            "InspCommon": 9,
+            "Case": 10,
+            "WorkOrderEntity": 11,
+            "StoreTransaction": 12,
+            "Requisition": 13,
+            "Material": 14,
+            "WorkActivity": 15,
+            "MaterialLeaf": 16,
+            "WoTemplate": 17,
+            "Unknown": 18,
+            "Employee": 19,
+            "MessageQueue": 20,
+            "Analytics": 21,
+            "TokenState": 22,
+            "AssetCalculationResult": 23,
+            "Equipment": 24,
+            "CustomerAccount": 25,
+            "InspTemplate": 26,
+            "ProblemLeaf": 27,
+            "AssetSplitRecord": 28,
+            "PavementInsp": 29,
+            "TvInspection": 30,
+            "Projects": 31
+        };
+        this.cw = cw;
+    }
+    /**
+     * Do a "quick" search for an ID or Case Number
+     *
+     * @category Quick Search
+     * @param {string} text - text to search the system for
+     * @return {Object} Returns Promise object that represents a collection of the currently authenticated user's notifications
+     */
+    Search.prototype.quick = function (text) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                "QuickSearchText": text,
+            };
+            _this.cw.runRequest('General/QuickSearch/QuickSearch', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Execute a saved search
+     *
+     * @category Search
+     * @param {number} searchId - SearchId to execute
+     * @param {Object} options - Other options. See: /{subdirectory}/apidocs/#/service-info/Ams/Search
+     * @return {Object} Returns Promise object that represents a list of Objects
+     */
+    Search.prototype.execute = function (searchId, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                SearchId: searchId
+            };
+            data = _.merge(data, options);
+            _this.cw.runRequest('Ams/Search/Execute', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get a list of the saved searches by search type and specific entity types OR employeeSid/domainId. You cannot search for saved searches by both specific entity type AND employeeSid/domainId.
+     *
+     * @category Search
+     * @param {string} searchType - Get the saved searches for a particular type
+     * @param {Array<string>} [applyToEntities] - Restrict GIS searches to specified entity types
+     * @param {number} [employeeSid] - The employee SID to retrieve the searches as
+     * @param {number} [domainId] - The domain ID of the domain to search
+     * @return {Object} Returns Promise object that represents a collection of SearchDefinitionName
+     */
+    Search.prototype.getSaved = function (searchType, applyToEntities, employeeSid, domainId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (!_.has(_this.searchTypes, searchType)) {
+                reject(new error_1.CWError(2, 'SearchType provided does not exist or is mispelled.', { 'provided': searchType, 'available': _this.searchTypes }));
+            }
+            else if (typeof (applyToEntities) != 'undefined' && applyToEntities != null && applyToEntities.length > 0 && (typeof (employeeSid) != 'undefined' || typeof (domainId) != 'undefined')) {
+                reject(new error_1.CWError(3, 'You cannot specify both applyToEntities AND employeeSid/domainId'));
+            }
+            var data = {};
+            var savedEndpoint = '';
+            if (typeof (employeeSid) != 'undefined' || typeof (domainId) != 'undefined') {
+                savedEndpoint = 'SavedByType';
+                if (typeof (employeeSid) != 'undefined' && employeeSid != null) {
+                    _.set(data, 'EmployeeSid', employeeSid);
+                }
+                if (typeof (domainId) != 'undefined' && domainId != null) {
+                    _.set(data, 'DomainId', domainId);
+                }
+            }
+            else {
+                if (searchType == 'Case') {
+                    savedEndpoint = 'PllSavedSaved';
+                }
+                else {
+                    savedEndpoint = searchType + 'Saved';
+                }
+                if (typeof (applyToEntities) != 'undefined' && applyToEntities != null) {
+                    _.set(data, 'ApplyToEntities', applyToEntities);
+                }
+            }
+            _this.cw.runRequest('Ams/Search/' + savedEndpoint, data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get a list display fields for a Search Type
+     *
+     * @category Search Options
+     * @param {string} searchType - Restrict GIS searches to specified entity types
+     * @return {Object} Returns Promise object that represents a collection of SearchDisplayFields
+     */
+    Search.prototype.displayFields = function (searchType) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (!_.has(_this.searchTypes, searchType)) {
+                reject(new error_1.CWError(1, 'SearchType provided does not exist or is mispelled.', { 'provided': searchType, 'available': _this.searchTypes }));
+            }
+            var data = {
+                searchType: _.get(_this.searchTypes, searchType)
+            };
+            _this.cw.runRequest('Ams/Search/DisplayFields', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get a list search types
+     *
+     * @category Search Options
+     * @return {Object} Returns Promise object that represents a collection of SearchTypeInfo objects
+     */
+    Search.prototype.types = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {};
+            _this.cw.runRequest('Ams/Search/Types', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Enable Service URLs on Saved Searches
+     *
+     * @category Search Options
+     * @param {Array<number>} searchIds - Search IDs to enable eURL on
+     * @return {Object} Returns Promise object that represents a dictionary of SearchIds and EURL booleans
+     */
+    Search.prototype.enableServices = function (searchIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                Enable: true,
+                SearchIds: searchIds
+            };
+            _this.cw.runRequest('Ams/Search/UpdateEurl', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Disable Service URLs on Saved Searches
+     *
+     * @category Search Options
+     * @param {Array<number>} searchIds - Search IDs to enable eURL on
+     * @return {Object} Returns Promise object that represents a dictionary of SearchIds and EURL booleans
+     */
+    Search.prototype.disableServices = function (searchIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                Enable: false,
+                SearchIds: searchIds
+            };
+            _this.cw.runRequest('Ams/Search/UpdateEurl', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get a search definition
+     *
+     * @category Search Definitions
+     * @param {number} searchId - SearchId to get.
+     * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
+     * @return {Object} Returns Promise object that represents a SearchDefinition object
+     */
+    Search.prototype.getDefinition = function (searchId, employeeSid) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                SearchId: searchId
+            };
+            if (typeof (employeeSid) != 'undefined') {
+                _.set(data, 'EmployeeSid', employeeSid);
+            }
+            _this.cw.runRequest('Ams/Search/Definition', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get search definitions
+     *
+     * @category Search Definitions
+     * @param {Array<number>} searchIds - SearchIds to get.
+     * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
+     * @return {Object} Returns Promise object that represents a collection of SearchDefinition objects
+     */
+    Search.prototype.getDefinitions = function (searchIds, employeeSid) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                SearchIds: searchIds
+            };
+            if (typeof (employeeSid) != 'undefined') {
+                _.set(data, 'EmployeeSid', employeeSid);
+            }
+            _this.cw.runRequest('Ams/Search/Definitions', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get search definition names
+     *
+     * @category Search Definitions
+     * @param {Array<number>} searchIds - SearchIds to get.
+     * @return {Object} Returns Promise object that represents a collection of SearchDefinitionNames
+     */
+    Search.prototype.getDefinitionNames = function (searchIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                SearchIds: searchIds
+            };
+            _this.cw.runRequest('Ams/Search/DefinitionNames', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Delete search definitions
+     *
+     * @category Search Definitions
+     * @param {Array<number>} searchIds - SearchIds to get.
+     * @return {Object} Returns Promise object that represents a list (dictionary) of search IDs and deletion success boolean
+     */
+    Search.prototype.deleteDefinitions = function (searchIds) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                SearchIds: searchIds
+            };
+            _this.cw.runRequest('Ams/Search/DeleteDefinitions', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Save a search definition
+     *
+     * @category Search Definitions
+     * @param {string} searchFor - Name of type to search for from searchTypes
+     * @param {Object} options - Other options. See: /{subdirectory}/apidocs/#/service-info/Ams/Search
+     * @param {number} searchId - SearchId to update. Defaults to "0" which is "Create new saved search"
+     * @return {Object} Returns Promise object that represents a SearchDefinitionName object
+     */
+    Search.prototype.saveDefinition = function (searchFor, options, searchId) {
+        var _this = this;
+        if (searchId === void 0) { searchId = 0; }
+        return new Promise(function (resolve, reject) {
+            if (!_.has(_this.searchTypes, searchFor)) {
+                reject(new error_1.CWError(1, 'SearchType provided does not exist or is mispelled.', { 'provided': searchFor, 'available': _this.searchTypes }));
+            }
+            var data = {
+                SearchFor: _.get(_this.searchTypes, searchFor),
+                SearchId: searchId
+            };
+            data = _.merge(data, options);
+            _this.cw.runRequest('Ams/Search/SaveDefinition', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Convert a search definition to a query
+     *
+     * @category Search Definitions
+     * @param {Array<number>} searchIds - searchIds to convert
+     * @param {boolean} saveQuery - Automatically save a query which converts with no errors, default is false
+     * @param {boolean} allowMultipleBooleanValues - Use all values for boolean fields even though a boolean should only have one value, default is false and will only use the first boolean value
+     * @param {boolean} allowEmptyQuery - Create default filter when no filter is found, default is false
+     * @return {Object} Returns Promise object that represents a SearchToQueryResult list
+     */
+    Search.prototype.convertToQuery = function (searchIds, saveQuery, addEurl, allowMultipleBooleanValues, allowEmptyQuery) {
+        var _this = this;
+        if (saveQuery === void 0) { saveQuery = false; }
+        if (addEurl === void 0) { addEurl = false; }
+        if (allowMultipleBooleanValues === void 0) { allowMultipleBooleanValues = false; }
+        if (allowEmptyQuery === void 0) { allowEmptyQuery = false; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                "SearchIds": searchIds,
+                "SaveQuery": saveQuery,
+                "AddEurl": addEurl,
+                "AllowMultipleBooleanValues": allowMultipleBooleanValues,
+                "AllowEmptyQuery": allowEmptyQuery
+            };
+            _this.cw.runRequest('General/Query/SearchToQuery', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return Search;
+}());
+exports.Search = Search;

package/dist/workorder.d.ts

@@ -15,6 +15,10 @@ export declare class WorkOrder {
      * WorkOrder Comments methods
      */
     comment: any;
+    /**
+     * WorkOrder Comments methods
+     */
+    attachments: any;
     /**
      * @hidden
      */