cityworks 2.0.0 → 2.1.1

package/dist/case_admin.d.ts

@@ -0,0 +1,349 @@
+export declare class CaseAdmin {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Add Business Case Template
+     *
+     * @category Case Templates
+     * @param {Object} data - The Business Case Template options.
+     * @return {Object} Returns Promise that represents an object describing the created case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
+     */
+    addBusinessCaseTemplate(data: Object): Promise<unknown>;
+    /**
+     * Update Business Case Template
+     *
+     * @category Case Templates
+     * @param {number} busCaseId - The Business Case ID to update
+     * @param {Object} data - The Business Case Template options.
+     * @return {Object} Returns Promise that represents an object describing the updated case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
+     */
+    updateBusinessCaseTemplate(busCaseId: number, options: Object): Promise<unknown>;
+    /**
+     * Get Business Case Templates
+     *
+     * @category Case Templates
+     * @return {Object} Returns Promise that represents a collection of Business Case Templates
+     */
+    getBusinessCaseTemplates(): Promise<unknown>;
+    /**
+     * Add Case Type
+     *
+     * @category Types & SubTypes
+     * @param {string} caseTypeName - The case type name
+     * @param {string} caseTypeDesciption - The case type description
+     * @param {Object} options - The other options for the Case Type
+     * @return {Object} Returns Promise that represents an object describing the added case type
+     */
+    addCaseType(caseTypeName: string, caseTypeDesciption: string, options: Object): Promise<unknown>;
+    /**
+     * Update Case Type
+     *
+     * @category Types & SubTypes
+     * @param {number} caseTypeId - The case Type ID
+     * @param {Object} options - The other options for the Case Type
+     * @return {Object} Returns Promise that represents an object describing the updated case type
+     */
+    updateCaseType(caseTypeId: number, options?: Object): Promise<unknown>;
+    /**
+     * Get Case Types
+     *
+     * @category Types & SubTypes
+     * @return {Object} Returns Promise that represents a collection of CaseTypeItems
+     */
+    getCaseTypes(): Promise<unknown>;
+    /**
+     * Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Types & SubTypes
+     * @param {Object} filters - The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
+     * @return {Object} Returns Promise that represents an Array of CaseTypeIDs
+     */
+    searchCaseTypeIDs(filters: Object): Promise<unknown>;
+    /**
+     * Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Types & SubTypes
+     * @param {Object} filters - The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
+     * @return {Object} Returns Promise that represents a collection of CaseTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CaseTypeItem
+     */
+    searchCaseTypeObjects(filters: Object): Promise<unknown>;
+    /**
+     * Add SubType
+     *
+     * @category Types & SubTypes
+     * @param {string} subTypeName - The SubTypeId
+     * @param {string} subTypeDescription - The SubTypeId
+     * @param {Object} options - Other SubType options.
+     * @return {Object} Returns Promise that represents an object describing the added SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
+     */
+    addSubtype(subTypeName: string, subTypeDescription: string, options?: Object): Promise<unknown>;
+    /**
+     * Update SubType
+     *
+     * @category Types & SubTypes
+     * @param {number} subTypeId - The SubTypeId
+     * @param {Object} options - The case Object ID
+     * @return {Object} Returns Promise that represents an object describing the updated SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
+     */
+    updateSubtype(subTypeId: number, options?: Object): Promise<unknown>;
+    /**
+     * Get SubTypes
+     *
+     * @category Types & SubTypes
+     * @return {Object} Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
+     */
+    getSubtypes(): Promise<unknown>;
+    /**
+     * Get all Fees
+     *
+     * @category Fees
+     * @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
+     */
+    getFees(): Promise<unknown>;
+    /**
+     * Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @param {Object} filters - The parameter(s) to search by (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId).
+     * @return {Object} Returns Promise that represents an Array of FeeSetupIDs
+     */
+    searchFees(filters: {
+        AccountCode?: string;
+        FeeCode?: string;
+        FeeDesc?: string;
+        FeeSetupId?: number;
+        FeeTypeId?: number;
+    }): Promise<unknown>;
+    /**
+     * Get all Expirations
+     *
+     * @category Expirations
+     * @return {Object} Returns Promise that represents a collection of ExpirationTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem
+     */
+    getExpirations(): Promise<unknown>;
+    /**
+     * Add an Expiration type
+     *
+     * @category Expirations
+     * @param {Object} options - Must specify OrgId and ExpirationDescType attributes. See: /{subdirectory}/apidocs/#/service-info/Pll/ExpirationType
+     * @return {Object} Returns Promise that represents an object describing the newly-added ExpirationTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem
+     */
+    addExpiration(options?: Object): Promise<unknown>;
+    /**
+     * Get all Deposits
+     *
+     * @category Deposits
+     * @return {Object} Returns Promise that represents a collection of DepositItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepositItemBase
+     */
+    getDeposits(): Promise<unknown>;
+    /**
+     * Search Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @param {Object} filters - The parameter(s) to search by (AccountCode, DepositCode, DepositDesc, DepositId, DepositTypeId).
+     * @return {Object} Returns Promise that represents an Array of FeeSetupIDs
+     */
+    searchDeposits(filters: {
+        AccountCode?: string;
+        DepositCode?: string;
+        DepositDesc?: string;
+        DepositId?: number;
+        DepositTypeId?: number;
+    }): Promise<unknown>;
+    /**
+     * Get all Disciplines
+     *
+     * @category Disciplines
+     * @return {Object} Returns Promise that represents a collection of DisciplineItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DisciplineItem
+     */
+    getDisciplines(): Promise<unknown>;
+    /**
+     * Add Department
+     *
+     * @category Departments & Divisions
+     * @param {string} departmentCode - The SubTypeId
+     * @param {string} departmentName - The SubTypeId
+     * @param {Object} options - Other SubType options.
+     * @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
+     */
+    addDepartment(departmentCode: string, departmentName: string, options?: Object): Promise<unknown>;
+    /**
+     * Get Departments
+     *
+     * @category Departments & Divisions
+     * @return {Object} Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
+     */
+    getDepartments(): Promise<unknown>;
+    /**
+     * Add Division
+     *
+     * @category Departments & Divisions
+     * @return {Object} Returns Promise that represents an object describing the newly-added DivisionItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem
+     */
+    addDivision(departmentId: number, divisionName: string, options?: Object): Promise<unknown>;
+    /**
+     * Get all Divisions
+     *
+     * @category Departments & Divisions
+     * @return {Object} Returns Promise that represents a collection of DivisionItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem
+     */
+    getDivisions(): Promise<unknown>;
+    /**
+     * Add Inspection Time Block
+     *
+     * @category Inspections
+     * @param {string} labelText - Label for the time block
+     * @param {string} startTime - Start time in 24 hour format (HH:mm)
+     * @param {string} endTime - End time in 24 hour format (HH:mm)
+     * @param {Object} inspTimeBlocksDetails - See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspTimeBlocksDetailItem
+     * @return {Object} Returns Promise that represents an object describing the newly-added InspectionTimeBlocksItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem
+     */
+    addInspectionTimeBlock(labelText: string, startTime: string, endTime: string, inspTimeBlocksDetails?: Object): Promise<unknown>;
+    /**
+     * Get all Inspection Time Blocks
+     *
+     * @category Inspections
+     * @return {Object} Returns Promise that represents a collection of InspectionTimeBlocksItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem
+     */
+    getInspectionTimeBlocks(): Promise<unknown>;
+    /**
+     * Get all NotificationCases
+     *
+     * @category Notifications
+     * @return {Object} Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationCaseItem
+     */
+    getNotificationCases(): Promise<unknown>;
+    /**
+     * Get all Notification Types
+     *
+     * @category Notifications
+     * @return {Object} Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationTypeItem
+     */
+    getNotificationTypes(): Promise<unknown>;
+    /**
+     * Add Numbering Group
+     *
+     * @category NumberingGroups
+     * @param {number} options - attributes or update
+     * @return {Object} Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
+     */
+    addNumberingGroup(options: Object): Promise<unknown>;
+    /**
+     * Update Numbering Group
+     *
+     * @category NumberingGroups
+     * @param {number} numberingGroupId - ID of NumberGroup to update
+     * @param {number} options - updates attributes
+     * @return {Object} Returns Promise that represents an object describing the newly-added HolidaysItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
+     */
+    updateNumberingGroup(numberingGroupId: number, options?: Object): Promise<unknown>;
+    /**
+     * Get all Numbering Groups
+     *
+     * @category NumberingGroups
+     * @return {Object} Returns Promise that represents a collection of NumberingGroupItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
+     */
+    getNumberingGroups(): Promise<unknown>;
+    /**
+     * Add Person
+     *
+     * @category People
+     * @param {string} name - Name of person
+     * @param {Object} options - attributes for new person
+     * @return {Object} Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
+     */
+    addPerson(name: string, options: Object): Promise<unknown>;
+    /**
+     * Get all People
+     *
+     * @category People
+     * @return {Object} Returns Promise that represents a collection of PeopleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleItem
+     */
+    getPeople(): Promise<unknown>;
+    /**
+     * Add People Role
+     *
+     * @category People
+     * @param {string} name - Name of person
+     * @param {Object} options - attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/PeopleRole
+     * @return {Object} Returns Promise that represents an object describing the newly-added PeopleRoleItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
+     */
+    addPeopleRole(roleCode: string, options: Object): Promise<unknown>;
+    /**
+     * Get all PeopleRoles
+     *
+     * @category People
+     * @return {Object} Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
+     */
+    getPeopleRoles(): Promise<unknown>;
+    /**
+     * Add TaskResultDetail
+     *
+     * @category TaskResults
+     * @param {Object} options - attributes for new TaskResultDetail. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
+     * @return {Object} Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
+     */
+    addTaskResultDetail(options: Object): Promise<unknown>;
+    /**
+     * Update TaskResultDetail
+     *
+     * @category TaskResults
+     * @param {string} resultDetailId - Result Detail ID
+     * @param {Object} options - attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
+     * @return {Object} Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
+     */
+    updateTaskResultDetail(resultDetailId: number, options: Object): Promise<unknown>;
+    /**
+     * Get all TaskResultDetails
+     *
+     * @category TaskResults
+     * @return {Object} Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
+     */
+    getTaskResultDetails(): Promise<unknown>;
+    /**
+     * Add TaskResultFeeInsert
+     *
+     * @category TaskResults
+     * @param {Object} options - attributes for new TaskResultFeeInsert. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultFeeInsert
+     * @return {Object} Returns Promise that represents an object describing the newly-added TaskResultFeeInsertItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem
+     */
+    addTaskResultFeeInsert(options: Object): Promise<unknown>;
+    /**
+     * Delete TaskResultFeeInsert
+     *
+     * @category TaskResults
+     * @param {number} taskResultFeeInsertId - ID for TaskResultFeeInsert to be deleted.
+     * @return {Object} Returns Promise that represents the ID Number of the deleted TaskResultFeeInsertItem.
+     */
+    deleteTaskResultFeeInsert(taskResultFeeInsertId: number): Promise<unknown>;
+    /**
+     * Delete TaskResultFeeInsert(s) by Task ID
+     *
+     * @category TaskResults
+     * @param {number} taskId - ID for Task parent of TaskResultFeeInsert(s) to be deleted.
+     * @return {Object} Returns Promise that represents the ID Number of the Task parent of the deleted TaskResultFeeInsertItem(s).
+     */
+    deleteTaskResultFeeInsertByTaskId(taskId: number): Promise<unknown>;
+    /**
+     * Update TaskResultFeeInsert
+     *
+     * @category TaskResults
+     * @param {number} taskResultFeeInsertId - ID for TaskResultFeeInsert to be updated.
+     * @param {number} taskId - Updated TaskID
+     * @param {number} taskResultId - Updated TaskResultId
+     * @param {number} [feeSetupId] - Fee setup ID update for TaskResultFeeInsert
+     * @return {Object} Returns Promise that represents the ID Number of the updated TaskResultFeeInsertItem.
+     */
+    updateTaskResultFeeInsert(taskResultFeeInsertId: number, taskId: number, taskResultId: number, feeSetupId?: number): Promise<unknown>;
+    /**
+     * Get all TaskResultFeeInsert
+     *
+     * @category TaskResults
+     * @return {Object} Returns Promise that represents a collection of TaskResultFeeInsertItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem
+     */
+    getTaskResultFeeInsert(): Promise<unknown>;
+}

package/dist/case_assets.d.ts

@@ -0,0 +1,89 @@
+export declare class CaseAssets {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * 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.
+     * // {"AddressId":OBJECTID,"AssetId":"GUID","AssetType":"ASSET_NAME","CaObjectId":CA_OBJECTID,"FeatureAssetId":"GUID","FeatureClass":"ASSET_NAME","FeatureObjectId":OBJECTID,"Location":"Address string","ObjectId":"OBJECTID","XCoord":,"YCoord":,"UpdateCaseData":false}
+     */
+    attach(caObjectId: number, updateXY?: boolean, options?: {
+        Address?: string;
+        AddressId?: number;
+        AssetId?: string;
+        AssetObjectId?: number;
+        AssetType?: string;
+        CityName?: string;
+        CrossStreet?: string;
+        DateExpired?: string;
+        ExpiredFlag?: string;
+        Facility_Id?: string;
+        FeatureAssetId?: string;
+        FeatureClass?: string;
+        FeatureObjectId?: number;
+        LegacyId?: string;
+        Level_Id?: string;
+        LndObjectId?: number;
+        Location?: string;
+        MasterFlag?: string;
+        ObjectId?: string;
+        StateCode?: string;
+        StreetDirection?: string;
+        StreetFraction?: string;
+        StreetName?: string;
+        StreetNumber?: number;
+        StreetPostDir?: string;
+        StreetType?: string;
+        Suite?: string;
+        TileNo?: string;
+        UpdateCaseData?: boolean;
+        XCoord?: number;
+        YCoord?: number;
+        ZCoord?: number;
+        ZipCode?: string;
+    }): Promise<unknown>;
+    /**
+     * 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.
+     */
+    detach(caAddressId: number, updateXY?: boolean): Promise<unknown>;
+    /**
+     * 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.
+     */
+    detachAll(caObjectId: number, updateXY?: boolean): Promise<unknown>;
+    /**
+     * 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.
+     */
+    getForCase(caObjectId: number): Promise<unknown>;
+    /**
+     * 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
+     */
+    search(filters?: Object): Promise<unknown>;
+}

package/dist/case_data.d.ts

@@ -0,0 +1,216 @@
+export declare class CaseData {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * 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.
+     */
+    addGroup(caObjectId: number, caseDataGroupId: number, groupCode: string, options?: {
+        GroupDesc?: string;
+        GroupSum?: number;
+        SumFlag?: string;
+    }): Promise<unknown>;
+    /**
+     * 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.
+     */
+    addDefaultGroups(caObjectId: number, busCaseId: number): Promise<unknown>;
+    /**
+     * 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.
+     */
+    wipAddDetail(caseDataDetailId: number, caDataGroupId: number, columnSequence: string, detailCode: string, detailSequence: number, options?: Object): Promise<unknown>;
+    /**
+     * Get groups by CaObjectId
+     *
+     * @category Data Groups
+     * @param {number} caseId - The Case Object to get the attached data groups.
+     * @return {Object} Returns Promise that represents a collection of the CaDataGroupItemBases.
+     */
+    getGroupsByCaseId(caseId: number): Promise<unknown>;
+    /**
+     * 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 (?)
+     */
+    deleteGroupsByCaseId(caObjectId: number): Promise<unknown>;
+    /**
+     * 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 (?)
+     */
+    searchForGroups(filters?: Object): Promise<Array<any>>;
+    /**
+     * 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.
+     */
+    checkGIS(entityType: string, entityUid: string, options: {
+        CaObjectId?: number;
+        CaseDataGroupId?: number;
+        CaseDataDetailId?: number;
+    }): Promise<unknown>;
+    /**
+     * 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.
+     */
+    updateGroupsFromAsset(caObjectId: number, entityType: string, entityUid: string, caDataGroupId?: number): Promise<unknown>;
+    /**
+     * 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.
+     */
+    addDetail(caDataGroupId: number, caseDataDetailId: number, options?: Object): Promise<unknown>;
+    /**
+     * 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.
+     */
+    updateDetail(caDataDetailId: number, options?: Object): Promise<unknown>;
+    /**
+     * Lock Case Data Detail
+     *
+     * @category Data Details
+     * @param {number} caDataDetailId - The Case Data Detail ID to lock
+     * @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
+     */
+    lockDetail(caDataDetailId: number): Promise<unknown>;
+    /**
+     * 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.
+     */
+    unlockDetail(caDataDetailId: number): Promise<unknown>;
+    /**
+     * 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 an object describing CaDataDetailItemBase.
+     */
+    searchForDetails(filters?: Object): Promise<Array<any>>;
+    /**
+     * 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.
+     */
+    addListValue(caDataDetailId: number, listValue: string): Promise<unknown>;
+    /**
+     * 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.
+     */
+    deleteListValue(caDataDetailId: number): Promise<unknown>;
+    /**
+     * 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
+     */
+    searchForListValueIds(filters?: Object): Promise<unknown>;
+    /**
+     * 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
+     */
+    searchForListValueObjects(filters?: Object): Promise<unknown>;
+    /**
+     * Set a data detail item's value without needing to find the type
+     *
+     * @category Data Details
+     * @param dataDetailId - The data detail item's ID
+     * @param {any} value - the value to set the data detail item to
+     * @param {number} rate - the rate to set the data detail item to
+     * @param {number} quantity - the quantitye to set the data detail item to
+     * @returns Promise that represents
+     */
+    updateDetailItemValue(dataDetailId: number, value: any, rate?: number, quantity?: number): Promise<unknown>;
+    /**
+     * Get the Case Data Details for a Case by Case ID
+     *
+     * @category Data Details
+     * @param {number} caseId - The case ID to get the details for
+     * @return {Object} Returns Promise that represents a collection of Case Data Detail Items
+     */
+    getAllDataDetails(caseId: number): Promise<Array<any>>;
+    /**
+     * Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference
+     *
+     * @category Data Details
+     * @param {number} caseId - The case ID to get the details for
+     * @param {Object} items - The parameters to search by. (DataGroup/Item string, Value) (e.g. {code: 'GroupCode.ItemCode', value: 'Value goes here'})
+     * @return {Object} Returns Promise that represents a collection
+     */
+    setCaseData(caseId: number, items: Array<{
+        code: string;
+        value: any;
+        rate?: number;
+        quantity?: number;
+    }>): Promise<unknown>;
+    /**
+     * Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference
+     * This is a convenience method that allows you to set a single detail item without needing to find the type. Reference it within {instance}.briefcase.data.setCaseDataItem.
+     *
+     * @category Data Details
+     * @param {number} caseId - The Case ID to set the detail for
+     * @param {string} detailGroupAndItemCode - The parameters to search (e.g. 'GroupCode.ItemCode')
+     * @param {any} value - The value to set the specified detail to
+     * @return {Object} Returns Promise
+     */
+    setCaseDataItem(caseId: number, detailGroupAndItemCode: string, value: any, rate?: number, quantity?: number): Promise<unknown>;
+}