cityworks 0.0.46 → 0.0.48

package/dist/inspection.d.ts

@@ -7,6 +7,10 @@ export declare class Inspection {
      * Inspection Administration methods
      */
     admin?: Object;
+    /**
+     * Inspection Costing methods
+     */
+    costs: any;
     /**
      * @hidden
      */
@@ -342,4 +346,32 @@ export declare class Inspection {
      * @return {Object} Returns object that represents a collection of attachments from the matched inspections
      */
     getAttachments(inspectionIds: Array<number>): Promise<unknown>;
+    /**
+     * Get Map Layer Fields
+     *
+     * @category Inspections
+     * @param {number} requestId - The inspection ID to get the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the inspections
+     */
+    getMLFs(requestId: number): Promise<unknown>;
+    /**
+     * Update Map Layer Fields
+     *
+     * @category Inspections
+     * @param {number} requestId - The inspection ID to get the map layer fields for.
+     * @param {number} x
+     * @param {number} y
+     * @param {number} domainId - Domain ID
+     * @param {number} [z] - Optional Z coordinate
+     * @return {Object} Returns Promise that represents a ...
+     */
+    updateMLFs(requestId: number, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
+    /**
+     * Delete Map Layer Fields
+     *
+     * @category Inspections
+     * @param {number} inspectionId - The inspection ID to delete the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
+     */
+    deleteMLFs(inspectionId: number): Promise<unknown>;
 }

package/dist/inspection_costs.d.ts

@@ -0,0 +1,86 @@
+export declare class InspectionCosts {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of object's active activityType
+     */
+    currentActivityType: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * 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
+     */
+    getCodes(employeeSids: Object, commonOnly?: boolean): Promise<unknown>;
+    /**
+     * Get Job Codes
+     *
+     * @category Labor Costs
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    getJobCodes(): Promise<unknown>;
+    /**
+     * Add Inspection Labor Costs
+     *
+     * @category Inspection Costs
+     * @param {number} inspectionId - Inspection ID to add labor costs to
+     * @param {number} hours - The hours to add to the inspection
+     * @param {Object} options - Additional settings for hours setting
+     * @param {boolean} estimated - Boolean, get estimated or real costs, defaults to false (get real by default)
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    addLabor(inspectionId: number, hours: number, options?: object, estimated?: boolean): Promise<unknown>;
+    /**
+    * Get Labor Costs for a specific list of Inspections
+    *
+    * @category Inspection Costs
+    * @param {Array<int>} inspectionIds - An array of inspection IDs to get associated costs for.
+    * @param {boolean} estimated - Boolean, get estimated or real costs, defaults to false (get real by default)
+    * @return {Object} Returns Promise that represents an object describing
+    */
+    getLabor(inspectionIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    /**
+     * Delete Inspection Labor Costs
+     *
+     * @category Inspection Costs
+     * @param {Array<int>} laborCostIds - An array of inspection labor cost IDs to delete
+     * @param {boolean} estimated - Boolean, delete estimated or real costs, defaults to false (delete real by default)
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    deleteLabor(laborCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    /**
+   * Add Inspection Equipment Costs
+   *
+   * @category Inspection Costs
+   * @param {Object} inspectionId - the inspection to add the equipment costs to
+   * @param {Object} options - additional options
+   * @return {Object} Returns Promise that represents an object describing
+   */
+    addEquipment(inspectionId: number, options: Object): Promise<unknown>;
+    /**
+    * Get Equipment Costs for Inspection(s)
+    *
+    * @category Inspection Costs
+    * @param {Array<number>} inspectionIds - the inspection to get the equipment costs for.
+    * @param {Object} estimated - get estimated equipment costs. Defaults to false.
+    * @return {Object} Returns Promise that represents an object describing
+    */
+    getEquipment(inspectionIds: number, estimated?: boolean): Promise<unknown>;
+    /**
+     * Delete Inspection Equipment Costs
+     *
+     * @category Inspection Costs
+     * @param {Array<number>} equipmentCostIds - the equipment cost IDs to delete.
+     * @param {Object} estimated - delete estimated equipment costs. Defaults to false.
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    deleteEquipment(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+}

package/dist/request.d.ts

@@ -7,6 +7,10 @@ export declare class Request {
      * Request Administration methods
      */
     admin?: any;
+    /**
+     * Request Costing methods
+     */
+    costs: any;
     /**
      * WorkOrder Comments methods
      */
@@ -333,4 +337,32 @@ export declare class Request {
      * @return {Object} Returns Promise that represents a collection of Problem WO Templates. See /{subdirectory}/apidocs/#/data-type-info;dataType=ProblemWOTemplate
      */
     getWOTemplates(problemSids: Array<number>, includeInactive?: boolean): Promise<unknown>;
+    /**
+     * Get Map Layer Fields
+     *
+     * @category Requests
+     * @param {number} requestId - The request ID to get the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the request map layer fields
+     */
+    getMLFs(requestId: number): Promise<unknown>;
+    /**
+     * Update Map Layer Fields
+     *
+     * @category Requests
+     * @param {number} requestId - The service request ID to get the map layer fields for.
+     * @param {number} x
+     * @param {number} y
+     * @param {number} domainId - Domain ID
+     * @param {number} [z] - Optional Z coordinate
+     * @return {Object} Returns Promise that represents a ...
+     */
+    updateMLFs(requestId: number, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
+    /**
+     * Delete Map Layer Fields
+     *
+     * @category Requests
+     * @param {number} requestId - The request ID to delete the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the deleted map layer fields
+     */
+    deleteMLFs(requestId: number): Promise<unknown>;
 }

package/dist/request_costs.d.ts

@@ -0,0 +1,54 @@
+export declare class RequestCosts {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of object's active activityType
+     */
+    currentActivityType: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * 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
+     */
+    getCodes(employeeSids: Object, commonOnly?: boolean): Promise<unknown>;
+    /**
+     * Get Job Codes
+     *
+     * @category Labor Costs
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    getJobCodes(): Promise<unknown>;
+    /**
+     * Add Request Labor Costs
+     *
+     * @category Request Costs
+     * @param {Object} requestCosts - Array of inspection labor costings
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    addLabor(requestCosts: Array<Object>): Promise<unknown>;
+    /**
+    * 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
+    */
+    getLabor(requestIds: Array<number>): Promise<unknown>;
+    /**
+     * 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
+     */
+    deleteLabor(laborCostIds: Array<number>): Promise<unknown>;
+}

package/dist/workorder.d.ts

@@ -7,6 +7,10 @@ export declare class WorkOrder {
      * WorkOrder Administration methods
      */
     admin: any;
+    /**
+     * WorkOrder Costing methods
+     */
+    costs: any;
     /**
      * WorkOrder Comments methods
      */
@@ -289,4 +293,32 @@ export declare class WorkOrder {
      * @return {Object} Returns Promise that represents an array of string/string Expense Type options for workorders
      */
     getExpenseTypes(): Promise<unknown>;
+    /**
+     * Get Map Layer Fields
+     *
+     * @category WorkOrders
+     * @param {string} workOrderSId - The workorder S/ID to get the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
+     */
+    getMLFs(workOrderSId: string): Promise<unknown>;
+    /**
+     * Update Map Layer Fields
+     *
+     * @category WorkOrders
+     * @param {string} workOrderSId - The workorder S/ID to get the map layer fields for.
+     * @param {number} x
+     * @param {number} y
+     * @param {number} domainId - Should include WKT or WKID attribute. Can also include VcsWKID attribute.
+     * @param {number} [z] - Optional Z coordinate
+     * @return {Object} Returns Promise that represents a ...
+     */
+    updateMLFs(workOrderSId: string, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
+    /**
+     * Delete Map Layer Fields
+     *
+     * @category WorkOrders
+     * @param {string} workOrderSId - The workorder S/ID to delete the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
+     */
+    deleteMLFs(workOrderSId: string): Promise<unknown>;
 }

package/dist/workorder_costs.d.ts

@@ -0,0 +1,113 @@
+export declare class WorkOrderCosts {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of object's active activityType
+     */
+    currentActivityType: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * 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
+     */
+    getCodes(employeeSids: Object, commonOnly?: boolean): Promise<unknown>;
+    /**
+     * Get Job Codes
+     *
+     * @category Labor Costs
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    getJobCodes(): Promise<unknown>;
+    /**
+     * Add WorkOrder Labor Costs
+     *
+     * @category WorkOrder Costs
+     * @param {number} workOrderSid - Array of inspection labor costings
+     * @param {number} hours - Number of hours to add
+     * @param {Object} options - options for the work order
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    addLabor(workOrderSid: number, hours: number, options: Object): Promise<unknown>;
+    /**
+    * Get Labor Costs for WorkOrder(s)
+    *
+    * @category WorkOrder Costs
+    * @param {Array<number>} workOrderSids - Array of request Ids to get costs for
+    * @param {boolean} estimated - Whether to get estimates or actuals (defaults to false -- get actuals)
+    * @return {Object} Returns Promise that represents an object describing
+    */
+    getLabor(workOrderSids: Array<number>, estimated?: boolean): Promise<unknown>;
+    /**
+     * Delete WorkOrder Labor Costs
+     *
+     * @category WorkOrder Costs
+     * @param {Array<number>} laborCostIds - List of labor cost IDs to delete
+     * @param {boolean} estimated - Whether to delete estimates or actuals (defaults to false -- delete actuals)
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    deleteLabor(laborCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    /**
+     * Add WorkOrder Equipment Costs
+     *
+     * @category WorkOrder Costs
+     * @param {Object} workOrderSid - the work order to add the equipment costs to
+     * @param {Object} options - additional options
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    addEquipment(workOrderSid: number, options: Object): Promise<unknown>;
+    /**
+    * Get Equipment Costs for WorkOrder(s)
+    *
+    * @category WorkOrder Costs
+    * @param {number} workOrderSid - the work order to add the equipment costs to
+    * @param {boolean} estimated - true to get estimated costs. defaults to false
+    * @return {Object} Returns Promise that represents an object describing
+    */
+    getEquipment(workOrderSid: number, estimated?: boolean): Promise<unknown>;
+    /**
+     * Delete WorkOrder Equipment Costs
+     *
+     * @category WorkOrder Costs
+     * @param {Object}
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    deleteEquipment(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    /**
+     * Add WorkOrder Material Costs
+     *
+     * @category WorkOrder Costs
+     * @param {number} workOrderSid - Work Order SID number to add the material to
+     * @param {number} units - Decimal units for material
+     * @param {Object} options - Additional work order options
+     * @param {boolean} combineIssuesByMaterialSid - Combine issues with the same MaterialSid into a single commit, default is true
+     * @return {Object} Returns Promise that represents a collection describing the work order material costs
+     */
+    addMaterial(workOrderSid: number, units: number, options: Object, combineIssuesByMaterialSid?: boolean): Promise<unknown>;
+    /**
+     * Get Material Costs for WorkOrder(s)
+     *
+     * @category WorkOrder Costs
+     * @param {number} workOrderSid - the work order to add the equipment costs to
+     * @param {boolean} estimated - true to get estimated costs. defaults to false and gets actuals.
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    getMaterial(workOrderSid: number, estimated?: boolean): Promise<unknown>;
+    /**
+     * Delete WorkOrder Material Costs
+     *
+     * @category WorkOrder Costs
+     * @param {Array<number>} materialCostIds - list of material cost IDs to delete
+     * @param {boolean} estimated - true to delete the estimated costs. defaults to false and deletes actuals.
+     * @return {Object} Returns Promise that represents an object describing
+     */
+    deleteMaterial(materialCostIds: number, estimated?: boolean): Promise<unknown>;
+}

package/package.json

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