cityworks 0.0.32 → 0.0.36

package/src/costs.ts

@@ -0,0 +1,289 @@
+import { CWError } from './error'
+import ReversibleMap from 'reversible-map'
+const _ = require('lodash')
+
+export class Costs {
+  /**
+   * @hidden
+   */
+  cw: any
+
+  /**
+   * Storage of all potential activity types which comments can be attached to: Unknown, Request, WorkOrder, CaTask, CaObject, CaCorrection, Project, Contract
+   */
+  activityTypes: ReversibleMap<string, number>
+
+  /**
+   * Storage of object's active activityType
+   */
+  currentActivityType: string
+
+  /**
+   * @hidden
+   */
+  constructor(cw:any, activityType:string) {
+    this.cw = cw
+    this.activityTypes = new ReversibleMap<string, number>()
+    this.activityTypes.set("Request", 1)
+    this.activityTypes.set("WorkOrder", 2)
+    this.activityTypes.set("Inspection", 3)
+
+    if(!this.activityTypes.has(activityType)) {
+      throw new CWError(1, 'Cost activity type not found.', {'provided': activityType, 'options':this.activityTypes})
+    }
+    this.currentActivityType = activityType
+  }
+
+  /**
+   * 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 = false) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        EmployeeSids: employeeSids,
+        CommonCodesOnly: commonOnly
+      }
+    this.cw.runRequest('Ams/LaborCost/CostCodes', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get Job Codes
+   *
+   * @category Labor Costs
+   * @return {Object} Returns Promise that represents an object describing
+   */
+   getJobCodes() {
+    return new Promise((resolve, reject) => {
+    this.cw.runRequest('Ams/LaborCost/JobCodes').then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * 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
+   */
+  addInspectionLabor(inspectionId: number, hours: number, options: object, estimated: boolean = false) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        Estimated: estimated,
+        InspectionIds: inspectionId,
+        Hours: hours
+      }
+      this.cw.runRequest('Ams/LaborCost/AddInspectionCosts', data).then((response: any) => {
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+   /**
+   * 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
+   */
+  getInspectionLabor(inspectionIds: Array<number>, estimated: boolean = false) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        Estimated: estimated,
+        InspectionIds: inspectionIds
+      }
+      this.cw.runRequest('Ams/LaborCost/InspectionCostsByInspection', data).then((response: any) => {
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * 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
+   */
+  deleteInspectionLabor(laborCostIds: Array<number>, estimated: boolean = false) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        Estimated: estimated,
+        reqLaborCostIds: laborCostIds
+      }
+      this.cw.runRequest('Ams/LaborCost/DeleteInspectionCosts', data).then((response: any) => {
+        resolve(response.Value)
+      }).catch(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
+   */
+  addRequestLabor(requestCosts: Array<Object>) {
+    return new Promise((resolve, reject) => {
+      var data = requestCosts
+      // ensure each object has Hours & InspectionId
+      this.cw.runRequest('Ams/LaborCost/AddRequestCosts', data).then((response: any) => {
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+   /**
+   * Get Labor Costs for Request(s)
+   *
+   * @category Request Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  //  RequestCostsByRequestList<RequestLaborCost>
+
+  /**
+   * Delete Request Labor Costs
+   *
+   * @category InspeRequestction Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // DeleteRequestCostsDictionary<Int32, Boolean>
+
+  /**
+   * Add WorkOrder Labor Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // AddWorkOrderCostsList<WorkOrderLaborCost>
+
+   /**
+   * Get Labor Costs for WorkOrder(s)
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  //  WorkOrderCostsByWorkOrderList<WorkOrderLaborCost>
+
+  /**
+   * Delete WorkOrder Labor Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // DeleteWorkOrderCostsDictionary<Int32, Boolean>
+
+  /**
+   * Add Inspection Equipment Costs
+   *
+   * @category Inspection Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // AddInspectionCostsList<InspectionEquipmentCost>
+
+   /**
+   * Get Equipment Costs for Inspection(s)
+   *
+   * @category Inspection Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // InspectionCostsByInspectionList<InspectionEquipmentCost>
+
+  /**
+   * Delete Inspection Equipment Costs
+   *
+   * @category Inspection Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  //  DeleteInspectionCostsDictionary<Int32, Boolean>
+
+  /**
+   * Add WorkOrder Equipment Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // AddWorkOrderCostsList<EquipmentCost>
+
+   /**
+   * Get Equipment Costs for WorkOrder(s)
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  //  WorkOrderCostsByWorkOrderList<EquipmentCost>
+
+  /**
+   * Delete WorkOrder Equipment Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // DeleteWorkOrderCostsDictionary<Int32, Boolean>
+
+  /**
+   * Add WorkOrder Material Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // AddWorkOrderCostsList<MaterialCost>
+
+   /**
+   * Get Material Costs for WorkOrder(s)
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  //  WorkOrderCostsByWorkOrderList<MaterialCost>
+
+  /**
+   * Delete WorkOrder Material Costs
+   *
+   * @category WorkOrder Costs
+   * @param {Object} 
+   * @return {Object} Returns Promise that represents an object describing
+   */
+  // DeleteWorkOrderCostsDictionary<Int32, Boolean>
+
+}

package/src/general.ts

@@ -102,7 +102,7 @@ export class General {
   }
 
   /**
-   * Get cost summary for work order entities
+   * Get cost summary for WorkOrder entities
    *
    * @param {Array<number>} ObjectIds
    * @return {Object} Returns Promise object that represents a
@@ -122,7 +122,7 @@ export class General {
   }
 
   /**
-   * Get cost summary for work order entities selected through a search definition
+   * Get cost summary for WorkOrder entities selected through a search definition
    *
    * @param {number} SearchId - Search Definition Id
    * @return {Object} Returns Promise object that represents a

package/src/gis.ts

@@ -110,7 +110,7 @@ export class Gis {
   /**
    * Get service request gis services
    *
-   * @param {number} requestId - The work order to check against.
+   * @param {number} requestId - The WorkOrder to check against.
    * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
    * @return {Object} Returns Promise object that represents an Object with the specified request's entit(y|ies)
    */
@@ -132,7 +132,7 @@ export class Gis {
   /**
      * Get inspection gis services
      *
-     * @param {number} inspectionId - The work order to check against.
+     * @param {number} inspectionId - The WorkOrder to check against.
      * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
      * @return {Object} Returns Promise object that represents an Object with the specified inspection's entity
      */
@@ -154,9 +154,9 @@ export class Gis {
   /**
      * Get workorder gis services
      *
-     * @param {number} workOrderSid - The work order to check against.
+     * @param {number} workOrderSid - The WorkOrder to check against.
      * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
-     * @return {Object} Returns Promise object that represents an Object with the specified work order's entit(y|ies)
+     * @return {Object} Returns Promise object that represents an Object with the specified WorkOrder's entit(y|ies)
      */
   workOrder(workOrderSid, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {

package/src/inspection.ts

@@ -107,7 +107,7 @@ export class Inspection {
   }
 
   /**
-   * Create an inspection from a work order
+   * Create an inspection from a WorkOrder
    *
    * @category Inspections
    * @param {object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance

package/src/request.ts

@@ -104,6 +104,26 @@ export class Request {
     })
   }
 
+  /**
+   * Update request's map layer fields
+   *
+   * @category Requests
+   * @param {number} requestId
+   * @return {Object} Returns Promise that represents an object describing the updated map layer fields
+   */
+  updateMLF = (requestId: number) => {
+    return new Promise((resolve, reject) => {
+      var data = {
+        ServiceRequestId: requestId
+      }
+      this.cw.runRequest('Ams/TemplateMapLayer/ServiceRequestInstanceMapLayersByRequestId', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    });
+  }
+
   /**
    * Change a request's problem code
    *
@@ -779,11 +799,11 @@ export class Request {
     }
 
     /**
-     * Get work order templates that are associated to this request template type
+     * Get WorkOrder templates that are associated to this request template type
      *
      * @category Request Templates
      * @param {Array<number>} problemSids - An array list of problemSids to retrieve Problem WO templates for
-     * @param {boolean} includeInactiveIf - Include inactive work order templates, default is false
+     * @param {boolean} includeInactiveIf - Include inactive WorkOrder templates, default is false
      * @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 = false) {

package/src/workorder.ts

@@ -112,8 +112,8 @@ export class WorkOrder {
    *
    * @category WorkOrders
    * @param {Array<string>} fromWorkOrderIds - The workorder IDs which should be combined.
-   * @param {string} toWorkOrderId - The work order ID for the single work order that should contain the info/entities from the other work orders
-   * @param {boolean} cancelCombinedWorkOrders - If the work orders combined into the single should then be canceled, default is true.
+   * @param {string} toWorkOrderId - The WorkOrder ID for the single WorkOrder that should contain the info/entities from the other WorkOrders
+   * @param {boolean} cancelCombinedWorkOrders - If the WorkOrders combined into the single should then be canceled, default is true.
    * @return {Object} Returns object that represents a collection of WorkOrders
    */
    combine(fromWorkOrderIds: Array<string>, toWorkOrderId: string, cancelCombinedWorkOrders: boolean = true) {
@@ -362,7 +362,7 @@ export class WorkOrder {
    * @category WorkOrders
    * @param {string|number} workOrderSId - The workorder S/ID which the entities should be added to. # for SID, string for ID.
    * @param {Object} entityInfo - Entity info object including: (req) EntityType: {string}, (req) EntityUids: {Array<string>}, Facility_Id: {string}, Level_Id: {string}
-   * @param {boolean} updateXY - Update work order xy after adding entit(y|ies), default is true.
+   * @param {boolean} updateXY - Update WorkOrder xy after adding entit(y|ies), default is true.
    * @return {Object} Returns object that represents a list of entities removed.
    */
    addEntities(workOrderSId: string|number, entityInfo: Object, updateXY: boolean = true) {
@@ -441,12 +441,12 @@ export class WorkOrder {
     }
 
   /**
-   * Remove entities from a work order. Provide WorkOrderId and either ObjectIds or EntityType and EntityUids
+   * Remove entities from a WorkOrder. Provide WorkOrderId and either ObjectIds or EntityType and EntityUids
    *
    * @category WorkOrders
    * @param {number} workOrderSId - The workorder S/ID which the entities should be removed from. # for SID, string for ID.
    * @param {Object} entityInfo - Remove entities by WorkOrderEntity.ObjectId (not gis objectId).
-   * @param {boolean} updateXY - Update work order xy after removing entities, default is true.
+   * @param {boolean} updateXY - Update WorkOrder xy after removing entities, default is true.
    * @return {Object} Returns object that represents a list of entities removed.
    */
    removeEntities(workOrderSId: string|number, entityInfo: Object, updateXY: boolean = true) {
@@ -597,10 +597,10 @@ export class WorkOrder {
     * Get WorkOrderS/IDs connected to provided entities
     *
     * @category WorkOrder Search
-    * @param {string} entityType - The entity type to find connected work orders
+    * @param {string} entityType - The entity type to find connected WorkOrders
     * @param {Array<string>} entityUIDs - The list of entities to search for connected WorkOrders
     * @param {boolean} s - Get WorkOrderSids. Defaults to true. When false, returned list is WorkOrderIds
-    * @param {Object} [search] - Any additional search properties of the work order (open/closed, etc)
+    * @param {Object} [search] - Any additional search properties of the WorkOrder (open/closed, etc)
     * @return {Object} Returns Promise that represents an array of WorkOrderS/IDs
     */
    getWOsByEntities(entityType: string, entityUids: Array<string>, search?: Array<string|number>, s: boolean = true) {

package/src/workorder_admin.ts

@@ -35,7 +35,7 @@ export class WorkOrderAdmin {
    * Get entity types
    *
    * @category WorkOrders Admin
-   * @return {Object} Returns Promise that represents a collection of all GIS Work Order entity types
+   * @return {Object} Returns Promise that represents a collection of all GIS WorkOrder entity types
    */
   getEntityTypes(entityGroups:Array<string>) {
     return new Promise((resolve, reject) => {
@@ -49,10 +49,10 @@ export class WorkOrderAdmin {
   }
 
   /**
-   * Get work order templates
+   * Get WorkOrder templates
    *
    * @category WorkOrders Admin
-   * @return {Object} Returns Promise that represents a collection of all Work Order templates
+   * @return {Object} Returns Promise that represents a collection of all WorkOrder templates
    */
   getTemplates(entityType:string, includeComments:boolean=true, includeInstructions:boolean=true) {
     return new Promise((resolve, reject) => {
@@ -66,10 +66,10 @@ export class WorkOrderAdmin {
   }
 
   /**
-   * Update Work Order template
+   * Update WorkOrder template
    *
    * @category WorkOrders Admin
-   * @param {Object} wOTemplate - Obect that describes the Work Order Template
+   * @param {Object} wOTemplate - Obect that describes the WorkOrder Template
    * @return {Object} Returns Promise that represents a collection of all
    */
   updateTemplate(wOTemplate:Object) {
@@ -193,7 +193,7 @@ export class WorkOrderAdmin {
   }
 
   /**
-   * Get map layer fields configured for provided work order template
+   * Get map layer fields configured for provided WorkOrder template
    *
    * @category WorkOrders Admin
    * @param {number} wOTemplateId - WorkOrder Template ID
@@ -211,11 +211,11 @@ export class WorkOrderAdmin {
   }
 
   /**
-   * Get tasks configured for provided work order template
+   * Get tasks configured for provided WorkOrder template
    *
    * @category WorkOrders Admin
    * @param {number} wOTemplateId - WorkOrder Template ID
-   * @return {Object} Returns Promise that represents a collection of all tasks on work order template
+   * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder template
    */
   getTemplateTasks(wOTemplateId:number) {
     return new Promise((resolve, reject) => {
@@ -229,11 +229,11 @@ export class WorkOrderAdmin {
   }
 
   /**
-   * Get inspections connected to provided work order template
+   * Get inspections connected to provided WorkOrder template
    *
    * @category WorkOrders Admin
    * @param {number} wOTemplateId - WorkOrder Template ID
-   * @return {Object} Returns Promise that represents a collection of all tasks on work order template
+   * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder template
    */
   getRelatedInspectionTemplates(wOTemplateId:number) {
     return new Promise((resolve, reject) => {

package/test/08.workOrderTest.js

@@ -34,7 +34,7 @@ describe('[WorkOrder (construct)] function test', () => {
 });
 
 describe('[WorkOrder::create] function test', () => {
-  it('should resolve collection of work orders', (done) => {
+  it('should resolve collection of WorkOrders', (done) => {
     cw8.workorder.create({WOTemplateId: 209, EntityType: 'MAINTENANCE_CATEGORIZATION'}).then(r => {
       assert.property(r[0], 'WorkOrderSid');
       done();

package/test/09.caseAssetsTest.js

@@ -0,0 +1,72 @@
+'use strict';
+require('dotenv').config();
+var expect = require('chai').expect;
+var assert = require('chai').assert;
+var Cityworks = require('../dist/index.js');
+var cw6 = new Cityworks(process.env.domain, {path: process.env.path});
+const _ = require('lodash')
+
+before(function(done) {
+  this.timeout(20000000);
+  cw6.authenticate(process.env.login, process.env.password).then(resp => {
+    done();
+  }).catch(e => {
+    console.log(e, 'unexpected error')
+    done();
+  });
+});
+
+describe('[CaseAssets (construct)] function test', () => {
+  it('should be a defined object', (done) => {
+    assert.isObject(cw6.case.financial, 'Request is an object');
+    done();
+  });
+});
+
+describe('[CaseAssets::attach] function test', () => {
+  it('should resolve a collection of case fees', (done) => {
+    cw6.case.financial.getFees(16086).then(r => {
+      assert.isArray(r);
+      done();
+    });
+  });
+});
+
+describe('[CaseAssets::detach] function test', () => {
+  it('should resolve a fee object', (done) => {
+    cw6.case.financial.addFee(16085, 183, {}).then(r => {
+      assert.isNumber(r.CaFeeId);
+      done();
+    });
+  });
+});
+
+describe('[CaseAssets::detachAll] function test', () => {
+  it('should resolve a fee object', (done) => {
+    cw6.case.financial.addFee(16085, 183, {AutoRecalculate: 'Y', Amount: 9}).then(r => { 
+      assert.isNumber(r.CaFeeId);
+      done();
+    });
+  });
+});
+
+describe('[CaseAssets::getForCase] function test', () => {
+  it('should resolve a ', (done) => {
+    cw6.case.assets.getForCase(42337).then(r => {
+      assert.isArray(r);
+      done();
+    }).catch(e => {
+      console.log(e, e)
+    })
+  });
+});
+
+describe('[CaseAssets::search] function test', () => {
+  it('should resolve a fee object with the updated amount', (done) => {
+    var newAmount = ((Math.random()*100)*8).toFixed(2);
+    cw6.case.assets.search(18480, {}).then(r => { // TODO: ?
+      // assert.equal(r.Amount, newAmount);
+      done();
+    });
+  });
+});