cityworks 0.0.36 → 0.0.38

package/src/comments.ts

@@ -1,167 +0,0 @@
-import { CWError } from './error'
-import ReversibleMap from 'reversible-map'
-const _ = require('lodash')
-
-
-/**
- * A plugin that contains "comments" methods
- */
-export class Comments {
-  /**
-   * @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("Unknown", 0)
-    this.activityTypes.set("Request", 1)
-    this.activityTypes.set("WorkOrder", 2)
-    this.activityTypes.set("CaTask", 3)
-    this.activityTypes.set("CaObject", 4)
-    this.activityTypes.set("CaCorrection", 5)
-    this.activityTypes.set("Project", 6)
-    this.activityTypes.set("Contract", 7)
-
-    if(!this.activityTypes.has(activityType)) {
-      throw new CWError(1, 'Comment activity type not found.', {'provided': activityType, 'options':this.activityTypes})
-    }
-    this.currentActivityType = activityType
-  }
-
-  /**
-   * 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
-   */
-  add(sid: number, comment: string) {
-    return new Promise((resolve, reject) => {
-      var data = {
-        ActivityType: this.activityTypes.get(this.currentActivityType),
-        ActivitySid: sid,
-        Comments: comment
-      }
-      this.cw.runRequest('Ams/Comment/Add', data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Update a comment
-   *
-   * @param {number} id - The ID of the comment which should be updated
-   * @param {string} comment - The new text for the updated comment
-   * @return {Object} Returns a Promise which represents a CommentRecord object
-   */
-  update(id: number, comment: string) {
-    return new Promise((resolve, reject) => {
-      var data = {
-        ActivityType: this.activityTypes.get(this.currentActivityType),
-        CommentId: id,
-        Comments: comment
-      }
-      this.cw.runRequest('Ams/Comment/Update', data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get comments for activity items
-   *
-   * @param {Array<number>} sids - The options SIDs to get comments for.
-   * @return {Object} Returns Promise object that represents a collection of available comments
-   */
-  get(sids: Array<number>) {
-    return new Promise((resolve, reject) => {
-      if(typeof(sids)!='undefined' && sids !=null) {
-        var data = {
-          ActivitySids: sids,
-          ActivityType: this.activityTypes.get(this.currentActivityType),
-        }
-        this.cw.runRequest('Ams/Comment/ByActivitySids', data).then((response: any) => {
-          if(sids.length==1) {
-            resolve(response.Value[sids[0]])
-          } else {
-            resolve(response.Value)
-          }
-        })
-      }
-    })
-  }
-
-  /**
-   * Get pre-defined comments for activityTypes
-   *
-   * @param {number} problemSid - The ProblemSid if currentActivityType is (Service) Request
-   * @param {string} [category] - Only applies to WorkOrder and ServiceRequest category comments.
-   * @return {Object} Returns Promise object that represents a collection of available comment templates.
-   */
-  getPredefined(problemSid?: number, category?: string) {
-    return new Promise((resolve, reject) => {
-      var data = {}
-      if(this.currentActivityType=='Request') {
-        _.set(data, 'ProblemSid', problemSid)
-      }
-      if(typeof(category)!='undefined' && (this.currentActivityType=='Request' || this.currentActivityType=='WorkOrder')) {
-        _.set(data, 'Category', category)
-      }
-      _.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)
-      })
-    })
-  }
-
-  // /**
-  //  * Get pre-set comments for activityTypes
-  //  *
-  //  * @param {Array<string>} [activityTypes] - Provide a list of activity types. Defaults to current activity type.
-  //  * @param {Array<string>} [categories] - Only applies to WorkOrder and ServiceRequest category comments.
-  //  * @return {Object} Returns Promise object that represents a collection of available comment templates.
-  //  */
-  // getForActivityList(activityTypes?: Array<string>, categories?: Array<string>) {
-  //   return new Promise((resolve, reject) => {
-  //     var data = {}
-  //     if(typeof(activityTypes)!='undefined') {
-  //       // TODO: iterate through it and output numeric types
-  //       _.set(data, 'ActivityTypes', activityTypes)
-  //     } else {
-  //       _.set(data, 'ActivityTypes', [this.activityTypes.get(this.currentActivityType)])
-  //     }
-  //     if(typeof(categories)!='undefined') {
-  //       _.set(data, 'Categories', categories)
-  //     }
-  //     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

@@ -1,289 +0,0 @@
-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,56 +0,0 @@
-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
-  info?: string
-}
-
-/**
- * CWError implements a custom error class for this codebase with additional information
- *
- */
-export class CWError implements CWErrorInt {
-  /**
-   * Just statically set to "Cityworks Exception" for now
-   */
-  name: string
-  /**
-   * Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
-   */
-  code: number
-  /**
-   * The error message
-   */
-  message: string
-  /**
-   * Object stuffed with any other information one wishes to include in the thrown error
-   */
-  info?: string
-
-  /**
-   * CWError implements a custom error class for this codebase with additional information
-   *
-   * @param {number} code - Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
-   * @param {string} message - The error message
-   * @param {Object} info - Object stuffed with any other information one wishes to include in the thrown error
-   * @return {Object} Returns instance of CWError object
-   */
-  constructor(code:number, message:string, info?:object) {
-    this.name = "Cityworks Exception"
-    this.code = code
-    this.message = message
-    if(typeof(info) !== 'undefined') {
-      if(_.has(info, 'Message'))
-        this.message = _.get(info, 'Message')
-      this.info = JSON.stringify(info)
-    }
-  }
-}