cityworks 0.0.52 → 1.0.1

package/dist/case_assets.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseAssets = void 0;
+var error_1 = require("./error");
+var _ = require('lodash');
+var CaseAssets = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function CaseAssets(cw) {
+        this.cw = cw;
+    }
+    /**
+     * Attach asset to case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when attaching the asset. Defaults to true.
+     * @param {Object} [options] - Options for CaseDataGroup including Address, AddressId, AssetId, AssetObjectId, AssetType, CityName, CrossStreet, DateExpired, ExpiredFlag, Facility_Id, FeatureAssetId, FeatureClass, FeatureObjectId, LegacyId, Level_Id, LndObjectId, Location, MasterFlag, ObjectId, StateCode, StreetDirection, StreetFraction, StreetName, StreetNumber, StreetPostDir, StreetType, Suite, TileNo, UpdateCaseData, XCoord, YCoord, ZCoord, and ZipCode
+     * @return {Object} Returns Promise that represents an object describing CaAddress.
+     */
+    CaseAssets.prototype.attach = function (caObjectId, updateXY, options) {
+        var _this = this;
+        if (updateXY === void 0) { updateXY = true; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                UpdateXY: updateXY
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseAddress/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Detach specific asset from case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the assets. Defaults to true.
+     * @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
+     */
+    CaseAssets.prototype.detach = function (caAddressId, updateXY) {
+        var _this = this;
+        if (updateXY === void 0) { updateXY = true; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaAddressId: caAddressId,
+                UpdateXY: updateXY
+            };
+            _this.cw.runRequest('Pll/CaseAddress/Delete', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Detach all assets from case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object to detach the assets from.
+     * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the asset(s). Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of detached CaAddressIds.
+     */
+    CaseAssets.prototype.detachAll = function (caObjectId, updateXY) {
+        var _this = this;
+        if (updateXY === void 0) { updateXY = false; }
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                UpdateXY: updateXY
+            };
+            _this.cw.runRequest('Pll/CaseAddress/DeleteByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get assets attached to a specific case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object from which to get attached assets
+     * @return {Object} Returns Promise that represents a collection of the default CaAddresses.
+     */
+    CaseAssets.prototype.getForCase = function (caObjectId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId
+            };
+            _this.cw.runRequest('Pll/CaseAddress/ByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for Case Assets. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Case Assets
+     * @param {Object} filters - The parameters to search by. (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode)
+     * @return {Object} Returns Promise that represents an Array of resulting CaAddresses
+     */
+    CaseAssets.prototype.search = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['AssetType', 'CaAddressId', 'CaObjectId', 'CityName', 'ExpiredFlag', 'StateCode', 'StateName', 'StreetName', 'StreetNumber', 'Suite', 'ZipCode']).length == 0) {
+                reject(new error_1.CWError(3, 'At least one of the attributes (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseAddress/Search', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return CaseAssets;
+}());
+exports.CaseAssets = CaseAssets;

package/dist/case_data.js

@@ -0,0 +1,416 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseData = void 0;
+var error_1 = require("./error");
+var _ = require('lodash');
+var CaseData = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function CaseData(cw) {
+        this.cw = cw;
+    }
+    /**
+     * Add Case Data Group
+     *
+     * @category Data Groups
+     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @param {number} caseDataGroupId - CaseDataGroupId as defined in CaseDataGroup admin.
+     * @param {string} groupCode - The Group Code.
+     * @param {Object} [options] - Options for CaseDataGroup including GroupDesc, GroupSum, and SumFlag
+     * @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
+     */
+    CaseData.prototype.addGroup = function (caObjectId, caseDataGroupId, groupCode, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                CaseDataGroupId: caseDataGroupId,
+                GroupCode: groupCode
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseDataGroup/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Add Default Case Data Groups
+     *
+     * @category Data Groups
+     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @param {number} busCaseId - The business case ID
+     * @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
+     */
+    CaseData.prototype.addDefaultGroups = function (caObjectId, busCaseId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                BusCaseId: busCaseId
+            };
+            _this.cw.runRequest('Pll/CaseDataGroup/AddDefault', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Adds a data detail entry to the case data group specified by the CaDataGroupId. The CaDataGroupId is associated to a case.
+     *
+     * @category Data Groups
+     * @param {number} caseDataDetailId - The Data Detail template ID
+     * @param {number} caDataGroupId - The Case Instance Data Group ID
+     * @param {string} columnSequence - The column sequence
+     * @param {string} detailCode - The detail Code
+     * @param {number} detailSequence - The detail order number
+     * @param {Object} [options] - Other options for CaseDataDetail. See WIPAdd here: /{subdirectory}/apidocs/#/service-info/Pll/CaseDataDetail
+     * @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
+     */
+    CaseData.prototype.wipAddDetail = function (caseDataDetailId, caDataGroupId, columnSequence, detailCode, detailSequence, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data_init = {
+                CaseDataDetailId: caseDataDetailId,
+                CaDataGroupId: caDataGroupId,
+                ColumnSequence: columnSequence,
+                DetailCode: detailCode,
+                DetailSequence: detailSequence
+            };
+            var data = _.merge(data_init, options);
+            _this.cw.runRequest('Pll/CaseDataGroup/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get groups by CaObjectId
+     *
+     * @category Data Groups
+     * @param {number} caObjectId - The Case Object to get the attached data groups.
+     * @return {Object} Returns Promise that represents a collection of the CaDataGroupItemBases.
+     */
+    CaseData.prototype.getGroupsByCaseId = function (caObjectId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId
+            };
+            _this.cw.runRequest('Pll/CaseDataGroup/ByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Delete Case Data Groups by Case Object ID.
+     *
+     * @category Data Groups
+     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
+     */
+    CaseData.prototype.deleteGroupsByCaseId = function (caObjectId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId
+            };
+            _this.cw.runRequest('Pll/CaseDataGroup/DeleteByCaObjectId', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for Case Data Groups. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Data Groups
+     * @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
+     * @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
+     */
+    CaseData.prototype.searchForGroups = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['CaDataGroupId', 'CaseDataGroupId', 'GroupCode', 'GroupDesc', 'GroupSum', 'SumFlag']).length == 0) {
+                reject(new error_1.CWError(2, 'At least one of the attributes (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseDataGroup/Search', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get Case Data Groups by Case ObjectId
+     *
+     * @category Data Groups
+     * @param {string} entityType - The entity type to check
+     * @param {string} entityUid - The specific entityUID to check
+     * @param {Object} options - The other options for checkGIS. Either CaObjectId or CaseDataGroupId is required.
+     * @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
+     */
+    CaseData.prototype.checkGIS = function (entityType, entityUid, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                EntityType: entityType,
+                EntityUid: entityUid
+            };
+            if (_.has(options, 'CaObjectId')) {
+                _.set(data, 'CaObjectId', _.get(options, 'CaObjectId'));
+            }
+            else if (_.has(options, 'CaseDataGroupId')) {
+                _.set(data, 'CaseDataGroupId', _.get(options, 'CaseDataGroupId'));
+            }
+            else {
+                reject(new error_1.CWError(1, 'Either CaObjectId or CaseDataGroupId is required.', { 'provided': options }));
+            }
+            if (_.has(options, 'CaseDataDetailId')) {
+                _.set(data, 'CaseDataDetailId', _.get(options, 'CaseDataDetailId'));
+            }
+            _this.cw.runRequest('Pll/CaseDataGroup/CheckGISChanges', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Update data groups on a case based on asset value mappings.
+     *
+     * @category Data Groups
+     * @param {number} caObjectId - The case to update
+     * @param {string} entityType - The entity type to check
+     * @param {string} entityUid - The specific entityUID to check
+     * @param {number} [caDataGroupId] - The specific data group ID to limit updates to
+     * @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
+     */
+    CaseData.prototype.updateGroupsFromAsset = function (caObjectId, entityType, entityUid, caDataGroupId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaObjectId: caObjectId,
+                EntityType: entityType,
+                EntityUid: entityUid
+            };
+            if (typeof (caDataGroupId) != 'undefined') {
+                _.set(data, 'CaDataGroupId', caDataGroupId);
+            }
+            _this.cw.runRequest('Pll/CaseDataGroup/UpdateFromAsset', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Attach Case Data Detail
+     *
+     * @category Data Details
+     * @param {number} caDataGroupId - The Case Data Group ID to attach the data detail to.
+     * @param {number} caseDataDetailId - caseDataDetailId to attach.
+     * @param {Object} [options] - Options
+     * @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
+     */
+    CaseData.prototype.addDetail = function (caDataGroupId, caseDataDetailId, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataGroupId: caDataGroupId,
+                CaseDataDetailId: caseDataDetailId
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseDataDetail/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Update Case Data Detail
+     *
+     * @category Data Details
+     * @param {number} caDataDetailId - The Case Data Group ID to attach the data detail to.
+     * @param {Object} [options] - Options
+     * @return {Object} Returns Promise that represents an object describing CaDataGroupItemBase.
+     */
+    CaseData.prototype.updateDetail = function (caDataDetailId, options) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataDetailId: caDataDetailId
+            };
+            if (typeof (options) != 'undefined') {
+                data = _.merge(data, options);
+            }
+            _this.cw.runRequest('Pll/CaseDataDetail/Update', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Lock Case Data Detail
+     *
+     * @category Data Details
+     * @param {number} caDataDetailId - The Case Data Group ID to lock
+     * @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
+     */
+    CaseData.prototype.lockDetail = function (caDataDetailId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataDetailId: caDataDetailId,
+                Lock: true
+            };
+            _this.cw.runRequest('Pll/CaseDataDetail/UpdateLock', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Unlock Case Data Detail
+     *
+     * @category Data Details
+     * @param {number} caDataDetailId - The Case Data Group ID to unlock
+     * @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
+     */
+    CaseData.prototype.unlockDetail = function (caDataDetailId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataDetailId: caDataDetailId,
+                Lock: false
+            };
+            _this.cw.runRequest('Pll/CaseDataDetail/UpdateLock', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for Case Data Details. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Data Details
+     * @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
+     * @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
+     */
+    CaseData.prototype.searchForDetails = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['CaDataDetailId', 'CaDataGroupId', 'CalcRateFlag', 'CaseDataDetailId', 'CommentFlag', 'DateFlag', 'DetailCode', 'DetailDesc', 'ListValuesFlag', 'NumberFlag', 'TextFlag', 'ValueFlag', 'YesNoFlag']).length == 0) {
+                reject(new error_1.CWError(2, 'At least one of the attributes (CaDataDetailId, CaDataGroupId, CalcRateFlag, CaseDataDetailId, CommentFlag, DateFlag, DetailCode, DetailDesc, ListValuesFlag, NumberFlag, TextFlag, ValueFlag, YesNoFlag) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseDataDetail/SearchObject', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Adds a list of possible values to the data detail entry specified by the CaDataDetailId.
+     *
+     * @category Data List Values
+     * @param {number} caDataDetailId - The Case Object to attach the data group to.
+     * @param {string} listValue - The Group Code.
+     * @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
+     */
+    CaseData.prototype.addListValue = function (caDataDetailId, listValue) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataDetailId: caDataDetailId,
+                ListValue: listValue
+            };
+            _this.cw.runRequest('Pll/CaseDataListValues/Add', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Delete by Id (Ca Data List Id)
+     *
+     * @category Data List Values
+     * @param {number} CaDataListId - The Case Data List ID
+     * @return {Object} Returns Promise that represents an object describing CaDataListValuesItemBase.
+     */
+    CaseData.prototype.deleteListValue = function (caDataDetailId) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = {
+                CaDataDetailId: caDataDetailId
+            };
+            _this.cw.runRequest('Pll/CaseDataListValues/Delete', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for List Value IDs. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Data List Values
+     * @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)
+     * @return {Object} Returns Promise that represents an Array of resulting CaDataListIds
+     */
+    CaseData.prototype.searchForListValueIds = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['CaDataDetailId', 'CaDataListId', 'ListValue']).length == 0) {
+                reject(new error_1.CWError(3, 'At least one of the attributes (CaDataDetailId, CaDataListId, ListValue) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseDataGroup/Search', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Search for List Value Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Data List Values
+     * @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)
+     * @return {Object} Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
+     */
+    CaseData.prototype.searchForListValueObjects = function (filters) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            if (_.intersectionBy(_.keysIn(filters), ['CaDataDetailId', 'CaDataListId', 'ListValue', 'CaDataGroupId']).length == 0) {
+                reject(new error_1.CWError(4, 'At least one of the attributes (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId) must be defined.'));
+            }
+            var data = filters;
+            _this.cw.runRequest('Pll/CaseDataGroup/SearchObject', data).then(function (r) {
+                resolve(r.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return CaseData;
+}());
+exports.CaseData = CaseData;