cityworks 0.0.30 → 0.0.35

package/src/case_workflow.ts

@@ -387,4 +387,76 @@ export class CaseWorkflow {
       })
     })
   }
+
+  /**
+     * Adds a task to the case specified by the CaObectId.
+     *
+     * @category Task Attachments
+     * @param {number} caTaskId - The Task ID to attach the document to
+     * @param {number} caObjectId - The Case Object ID
+     * @param {string} docName - The file name as it should display in the system
+     * @param {string} locationType - The location of the file...leave blank
+     * @param {any} file - The binary string for the file
+     * @return {Object} Returns Promise that represents an object describing added Attachment
+     */
+  addTaskAttachment(caTaskId: number, caObjectId: number, docName: number, file: any, locationType?: string) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        CaObjectId: caObjectId,
+        CaTaskId: caTaskId,
+        DocName: docName
+      }
+      if(typeof(locationType)!='undefined') {
+        _.set(data, 'LocationType', locationType)
+      }
+      this.cw.runRequest('Pll/CaseRelDocs/AddTaskRelDoc', data, file).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+     * Gets each Document Attached to the specified Task
+     *
+     * @category Task Attachments
+     * @param {number} caTaskId - The Task ID to attach the document to
+     * @return {Object} Returns Promise that represents a collection of objects describing each Attachment on the provided task
+     */
+  getTaskAttachments(caTaskId: number) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        CaTaskId: caTaskId
+      }
+      this.cw.runRequest('Pll/CaseRelDocs/ByCaTaskId', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Deletes a task attachment by caRelDocId (Related Case Document ID). Same as RelDocs delete for case.
+   *
+   * @category Task Attachments
+   * @param {number} caRelDocId - The caRelDocId for the related document which should be deleted
+   * @return {Object} Returns Promise that represents the an object describing the deleted document.
+   */
+  deleteTaskAttachment(caRelDocId: number) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        CaRelDocId: caRelDocId
+      }
+      this.cw.runRequest('PLL/CaseRelDocs/Delete', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
 }
+
+
+

package/src/cityworks.ts

@@ -17,6 +17,7 @@ const _ = require('lodash')
 interface postData {
   data?: string
   token?: string
+  file?: any
 }
 
 /**
@@ -51,7 +52,7 @@ interface Citywork {
 /**
  * Core class Cityworks with most of the authentication and install capabilities functions
  */
-module.exports = class Cityworks implements Citywork {
+export class Cityworks implements Citywork {
   /**
    * The domain of the cityworks install. Defaults to Cityworks Online
    */
@@ -200,20 +201,30 @@ module.exports = class Cityworks implements Citywork {
      *
      * @param {string} path - The path to the particular endpoint
      * @param {Object} data - The data object to be sent to the Cityworks API
+     * @param {any} file - The file to send in binary to the Cityworks API
      * @return {Object} Returns Promise object that represents the json object returned from the Cityworks API
      */
-  runRequest(path, data) {
+  runRequest(path, data?, file?: any) {
     return new Promise((resolve, reject) => {
       let pd = {} as postData
-      pd.data = JSON.stringify(data)
+
+      if(typeof(data) !== 'undefined') {
+        pd.data = JSON.stringify(data)
+      }
+      
+      if(typeof(file) !== 'undefined' && (path=='Pll/CaseRelDocs/AddTaskRelDoc' || path=='Pll/CaseRelDocs/Add')) {
+        pd.file = file
+      }
 
       if(typeof(this.Token) !== 'undefined' && this.Token != '' && path!='General/Authentication/CityworksOnlineAuthenticate' && path!='General/Authentication/Authenticate') {
         pd.token = this.Token
       }
+
       let obj: {
         Status: number,
         Message: string
       }
+
       let options = {
         hostname: this.base_url,
         port: 443,
@@ -225,7 +236,6 @@ module.exports = class Cityworks implements Citywork {
         },
         timeout: 10000000
       }
-
       let request = https.request(options, (response) => {
           let str=''
           response.on('error',function(e){
@@ -249,20 +259,34 @@ module.exports = class Cityworks implements Citywork {
                   // failed
                   reject(new CWError(10, 'No response received from Cityworks API.'))
                 } else if(typeof(obj)!='undefined' && typeof(obj.Value)!='undefined') { // && typeof(response.Value.Token)!='undefined') {
-                  resolve(obj)
+                  switch(obj.Status) {
+                    case 1:
+                      reject(new CWError(1, 'Error', obj))
+                      break;
+                    case 2:
+                      reject(new CWError(2, 'Unauthorized', obj))
+                      break;
+                    case 3:
+                      reject(new CWError(3, 'InvalidCredentials', obj))
+                      break;
+                    case 0:
+                    default:
+                      resolve(obj);
+                      break;
+                  }
                 } else {
-                  reject(new CWError(3, "Unknown error.", {options: options, postedData: pd, api_returned_string: obj}))
+                  reject(new CWError(4, "Unknown error.", {options: options, postedData: pd, api_returned_string: obj}))
                 }
               } else {
-                reject(new CWError(1, "Error parsing JSON. Cityworks returned HTML.", {response: str}))
+                reject(new CWError(5, "Error parsing JSON. Cityworks returned HTML.", {response: str}))
               }
             } catch (e) {
               if (e instanceof SyntaxError) {
                 console.log('try/catch error on JSON')
-                reject(new CWError(1, "Error parsing JSON.", {error: e}))
+                reject(new CWError(6, "Error parsing JSON.", {error: e}))
               } else {
-                console.log('try/catch error on JSON')
-                reject(new CWError(1, "Error parsing JSON."))
+                console.log('try/catch error on JSON - but not an instance of SyntaxError')
+                reject(new CWError(7, "Error parsing JSON."))
               }
             }
           })
@@ -286,20 +310,20 @@ module.exports = class Cityworks implements Citywork {
         path = 'General/Authentication/CityworksOnlineAuthenticate'
       }
       this.runRequest(path, data).then((response: any) => {
-        if(response.Status>0) {
-          // failed
-          reject(new CWError(10, response.Message))
-        } else if(typeof(response.Value)!='undefined' && typeof(response.Value.Token)!='undefined') {
+        // if(response.Status>0) {
+        //   // failed
+        //   reject(new CWError(100, response.Message))
+        // } else if(typeof(response.Value)!='undefined' && typeof(response.Value.Token)!='undefined') {
           this.login = login
           this.password = password
           this.Token = response.Value.Token
           resolve(true)
-        } else {
-          // failed
-          reject(new CWError(11, 'Unknown Error'))
-        }
+        // } else {
+        //   // failed
+        //   reject(new CWError(11, 'Unknown Error'))
+        // }
       }).catch(error => {
-        reject(error)
+        reject(error);
       })
     })
   }

package/src/comments.ts

@@ -25,7 +25,7 @@ export class Comments {
   /**
    * @hidden
    */
-  constructor(cw, activityType) {
+  constructor(cw: any, activityType: string) {
     this.cw = cw
     this.activityTypes = new ReversibleMap<string, number>()
     this.activityTypes.set("Unknown", 0)
@@ -38,14 +38,14 @@ export class Comments {
     this.activityTypes.set("Contract", 7)
 
     if(!this.activityTypes.has(activityType)) {
-      throw new CWError(1, 'Activity type not found.', {'provided': activityType, 'options':this.activityTypes})
+      throw new CWError(1, 'Comment activity type not found.', {'provided': activityType, 'options':this.activityTypes})
     }
     this.currentActivityType = activityType
   }
 
   /**
-   * Add a comment
-   *
+   * Add a comment - for adding a comment to an object when the object is already known. Always call comment.add from request, case, workorder, or inspection.
+   * 
    * @param {number} sid - The SID of the activity to which the comment should be attached
    * @param {string} comment - The text for the comment
    * @return {Object} Returns a Promise which represents a CommentRecord object
@@ -59,6 +59,8 @@ export class Comments {
       }
       this.cw.runRequest('Ams/Comment/Add', data).then((response: any) => {
         resolve(response.Value)
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -79,6 +81,8 @@ export class Comments {
       }
       this.cw.runRequest('Ams/Comment/Update', data).then((response: any) => {
         resolve(response.Value)
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -126,6 +130,8 @@ export class Comments {
       _.set(data, 'ActivityType', this.activityTypes.get(this.currentActivityType))
       this.cw.runRequest('Ams/Comment/PredefinedComments', data).then((response: any) => {
         resolve(response.Value)
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -152,7 +158,9 @@ export class Comments {
   //     console.log(data, 'data')
   //     this.cw.runRequest('Ams/Comment/ByActivityTypes', data).then((response: any) => {
   //       resolve(response.Value)
-  //     })
+  //     }).catch(e => {
+  //      reject(e)
+  //    })
   //   })
   // }
 

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/error.ts

@@ -1,4 +1,12 @@
-interface CWErrorInt {
+const _ = require('lodash')
+
+/**
+ * CWErrorInt interface definition for implementation by CWError
+ *
+ * `{name: string, code: number, message: string, info?: string}`
+ *
+ */
+export interface CWErrorInt {
   name: string
   code: number
   message: string
@@ -8,8 +16,6 @@ interface CWErrorInt {
 /**
  * CWError implements a custom error class for this codebase with additional information
  *
- * `{name: string, code:number, info: object}`
- *
  */
 export class CWError implements CWErrorInt {
   /**
@@ -42,6 +48,8 @@ export class CWError implements CWErrorInt {
     this.code = code
     this.message = message
     if(typeof(info) !== 'undefined') {
+      if(_.has(info, 'Message'))
+        this.message = _.get(info, 'Message')
       this.info = JSON.stringify(info)
     }
   }