cityworks 0.0.26 → 0.0.30

package/dist/request.d.ts

@@ -7,6 +7,10 @@ export declare class Request {
      * Request Administration methods
      */
     admin?: Object;
+    /**
+     * WorkOrder Comments methods
+     */
+    comment: Object;
     /**
      * @hidden
      */
@@ -93,15 +97,6 @@ export declare class Request {
      * @return {Object} Returns Promise that represents a collection of requests
      */
     changeCustomFieldCategory(requestIds: Array<number>, categoryId: number): Promise<unknown>;
-    /**
-     * Add a comment to a request
-     *
-     * @category Requests
-     * @param {number} requestId - The ID of the request to retrieve
-     * @param {string} comment - The comment text to add
-     * @return {Object} Returns Promise that represents an object describing the comment added
-     */
-    comment(requestId: number, comment: string): Promise<unknown>;
     /**
      * Cancel requests
      *

package/dist/search.d.ts

@@ -90,22 +90,22 @@ export declare class Search {
      */
     getDefinition(searchId: number, employeeSid?: number): Promise<unknown>;
     /**
-     * Get search definition names
+     * Get search definitions
      *
      * @category Search Definitions
      * @param {Array<number>} searchIds - SearchIds to get.
-     * @return {Object} Returns Promise object that represents a collection of SearchDefinitionNames
+     * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
+     * @return {Object} Returns Promise object that represents a collection of SearchDefinition objects
      */
-    getDefinitionNames(searchIds: Array<number>): Promise<unknown>;
+    getDefinitions(searchIds: Array<number>, employeeSid?: number): Promise<unknown>;
     /**
-     * Get search definitions
+     * Get search definition names
      *
      * @category Search Definitions
      * @param {Array<number>} searchIds - SearchIds to get.
-     * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
-     * @return {Object} Returns Promise object that represents a collection of SearchDefinition objects
+     * @return {Object} Returns Promise object that represents a collection of SearchDefinitionNames
      */
-    getDefinitions(searchIds: Array<number>, employeeSid?: number): Promise<unknown>;
+    getDefinitionNames(searchIds: Array<number>): Promise<unknown>;
     /**
      * Delete search definitions
      *

package/dist/workorder.d.ts

@@ -6,7 +6,11 @@ export declare class WorkOrder {
     /**
      * WorkOrder Administration methods
      */
-    admin?: Object;
+    admin: Object;
+    /**
+     * WorkOrder Comments methods
+     */
+    comment: Object;
     /**
      * @hidden
      */
@@ -101,15 +105,6 @@ export declare class WorkOrder {
      * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
      */
     getCustomFieldValues(workOrderSIds: Array<string | number>): Promise<unknown>;
-    /**
-     * Add a comment to a workorder
-     *
-     * @category WorkOrders
-     * @param {number} workOrderSId - The S/ID of the workorder to retrieve. SID is default.
-     * @param {string} comment - The comment text to add.
-     * @return {Object} Returns Promise that represents an object describing the comment added
-     */
-    comment(workOrderSId: string | number, comment: string): Promise<unknown>;
     /**
      * Get entities on an existing WorkOrder
      *

package/package.json

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

package/src/case.ts

@@ -5,6 +5,7 @@ import { CaseData } from './case_data'
 import { CaseFinancial } from './case_financial'
 import { CaseWorkflow} from './case_workflow'
 import { CaseAdmin } from './case_admin'
+import { Comments } from './comments'
 
 export class Case {
   /**
@@ -25,12 +26,15 @@ export class Case {
    * Payment, Receipt, & Fee methods
    */
   financial?: Object
+  /**
+   * Commenting methods
+   */
+  comment?: Object
   /**
    * PLL Administration methods
    */
   admin?: Object
 
-
   /**
    * @hidden
    */
@@ -39,6 +43,7 @@ export class Case {
     this.data = new CaseData(cw)
     this.workflow = new CaseWorkflow(cw)
     this.financial = new CaseFinancial(cw)
+    this.comment = new Comments(cw, 'CaObject')
     this.admin = new CaseAdmin(cw)
   }
 
@@ -207,7 +212,7 @@ export class Case {
       }).catch(e => {
         reject(e)
       })
-    });
+    })
   }
 
   /**
@@ -220,7 +225,7 @@ export class Case {
   delete(caObjectId: number) {
     return new Promise((resolve, reject) => {
       var data = {
-        CaObjectId: caObjectId,
+        CaObjectId: caObjectId
       }
       this.cw.runRequest('Pll/CaseObject/DeleteCase', data).then(r => {
         resolve(r.Value)

package/src/case_admin.ts

@@ -142,7 +142,7 @@ export class CaseAdmin {
    */
   searchCaseTypeIDs(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaseType', 'CaseTypeDesc', 'CaseTypeId']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaseType', 'CaseTypeDesc', 'CaseTypeId']).length==0) {
         reject(new CWError(2, 'At least one of the attributes (CaFeeId, CaObjectId, FeeCode, FeeDesc) must be defined.'))
       }
       var data = filters
@@ -163,7 +163,7 @@ export class CaseAdmin {
    */
   searchCaseTypeObjects(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaseType', 'CaseTypeDesc', 'CaseTypeId']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaseType', 'CaseTypeDesc', 'CaseTypeId']).length==0) {
         reject(new CWError(3, 'At least one of the attributes (CaseType, CaseTypeDesc, CaseTypeId) must be defined.'))
       }
       var data = filters
@@ -263,7 +263,7 @@ export class CaseAdmin {
    */
   searchFees(filters: {AccountCode?: string, FeeCode?: string, FeeDesc?: string, FeeSetupId?: number, FeeTypeId?: number}) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['AccountCode', 'FeeCode', 'FeeDesc', 'FeeSetupId', 'FeeTypeId']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['AccountCode', 'FeeCode', 'FeeDesc', 'FeeSetupId', 'FeeTypeId']).length==0) {
         reject(new CWError(4, 'At least one of the attributes (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId) must be defined.'))
       }
       var data = filters
@@ -338,7 +338,7 @@ export class CaseAdmin {
    */
   searchDeposits(filters: {AccountCode?: string, DepositCode?: string, DepositDesc?: string, DepositId?: number, DepositTypeId?: number}) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['AccountCode', 'DepositCode', 'DepositDesc', 'DepositId', 'DepositTypeId']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['AccountCode', 'DepositCode', 'DepositDesc', 'DepositId', 'DepositTypeId']).length==0) {
         reject(new CWError(4, 'At least one of the attributes (AccountCode, DepositCode, DepositDesc, DepositId, DepositTypeId) must be defined.'))
       }
       var data = filters

package/src/case_data.ts

@@ -143,7 +143,7 @@ export class CaseData {
    */
    searchForGroups(filters?: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaDataGroupId', 'CaseDataGroupId', 'GroupCode', 'GroupDesc', 'GroupSum', 'SumFlag']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaDataGroupId', 'CaseDataGroupId', 'GroupCode', 'GroupDesc', 'GroupSum', 'SumFlag']).length==0) {
         reject(new CWError(2, 'At least one of the attributes (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag) must be defined.'))
       }
       var data = filters
@@ -359,7 +359,7 @@ export class CaseData {
    */
    searchForListValueIds(filters?: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaDataDetailId', 'CaDataListId', 'ListValue']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaDataDetailId', 'CaDataListId', 'ListValue']).length==0) {
         reject(new CWError(3, 'At least one of the attributes (CaDataDetailId, CaDataListId, ListValue) must be defined.'))
       }
       var data = filters
@@ -380,7 +380,7 @@ export class CaseData {
    */
    searchForListValueObjects(filters?: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaDataDetailId', 'CaDataListId', 'ListValue']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaDataDetailId', 'CaDataListId', 'ListValue']).length==0) {
         reject(new CWError(3, 'At least one of the attributes (CaDataDetailId, CaDataListId, ListValue) must be defined.'))
       }
       var data = filters

package/src/case_financial.ts

@@ -521,7 +521,7 @@ export class CaseFinancial {
    */
   searchFees(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaFeeId', 'CaObjectId', 'FeeCode', 'FeeDesc']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaFeeId', 'CaObjectId', 'FeeCode', 'FeeDesc']).length==0) {
         reject(new CWError(4, 'At least one of the attributes (CaFeeId, CaObjectId, FeeCode, FeeDesc) must be defined.'))
       }
       var data = filters
@@ -542,7 +542,7 @@ export class CaseFinancial {
    */
   searchPayments(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaPaymentId', 'CommentText', 'FeeAmount', 'FeeCode', 'FeeDesc', 'PaymentAccount', 'PaymentAmount', 'TenderType']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaPaymentId', 'CommentText', 'FeeAmount', 'FeeCode', 'FeeDesc', 'PaymentAccount', 'PaymentAmount', 'TenderType']).length==0) {
         reject(new CWError(5, 'At least one of the attributes (CaPaymentId, CommentText, FeeAmount, FeeCode, FeeDesc, PaymentAccount, PaymentAmount, TenderType) must be defined.'))
       }
       var data = filters
@@ -563,7 +563,7 @@ export class CaseFinancial {
    */
   searchRefunds(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaPaymentId', 'CaPaymentRefundId', 'Comments', 'RefundAmount']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaPaymentId', 'CaPaymentRefundId', 'Comments', 'RefundAmount']).length==0) {
         reject(new CWError(6, 'At least one of the attributes (CaPaymentId, CaPaymentRefundId, Comments, RefundAmount) must be defined.'))
       }
       var data = filters
@@ -584,7 +584,7 @@ export class CaseFinancial {
    */
   searchDeposits(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['CaDepositId', 'CaObjectId', 'DepositCode', 'DepositDesc']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['CaDepositId', 'CaObjectId', 'DepositCode', 'DepositDesc']).length==0) {
         reject(new CWError(1, 'At least one of the arguments (CaDepositId, CaObjectId, DepositCode, DepositDesc) must be defined.'))
       }
       var data = filters
@@ -622,7 +622,7 @@ export class CaseFinancial {
    */
   searchFeeTemplates(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['FeeSetupId', 'FeeTypeId', 'FeeCode', 'FeeDesc', 'AccountCode']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['FeeSetupId', 'FeeTypeId', 'FeeCode', 'FeeDesc', 'AccountCode']).length==0) {
         reject(new CWError(7, 'At least one of the arguments (FeeSetupId, FeeTypeId, FeeCode, FeeDesc, AccountCode) must be defined.'))
       }
       var data = filters
@@ -643,7 +643,7 @@ export class CaseFinancial {
    */
   searchCaseInstruments(filters: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['AddressLine1', 'Amount', 'CaInstrumentId', 'CityName', 'CommentText', 'Company', 'ContactEmail', 'ContactName', 'ContactPhone', 'CountryCode', 'InstTypeId', 'SerialNumber', 'StateCode', 'ZipCode']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['AddressLine1', 'Amount', 'CaInstrumentId', 'CityName', 'CommentText', 'Company', 'ContactEmail', 'ContactName', 'ContactPhone', 'CountryCode', 'InstTypeId', 'SerialNumber', 'StateCode', 'ZipCode']).length==0) {
         reject(new CWError(9, 'At least one of the arguments (AddressLine1, Amount, CaInstrumentId, CityName, CommentText, Company, ContactEmail, ContactName, ContactPhone, CountryCode, InstTypeId, SerialNumber, StateCode, ZipCode) must be defined.'))
       }
       var data = filters
@@ -740,7 +740,7 @@ export class CaseFinancial {
   searchCaseInstrumentReleases(filters: Object) {
     return new Promise((resolve, reject) => {
       var data = filters
-      if(_.intersectionBy(filters, ['AmountReleased', 'CaInstReleasesId', 'CaInstrumentId', 'CommentText', 'PercentReleased', 'ReleasedBy']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['AmountReleased', 'CaInstReleasesId', 'CaInstrumentId', 'CommentText', 'PercentReleased', 'ReleasedBy']).length==0) {
         reject(new CWError(3, 'At least one of the attributes (AmountReleased, CaInstReleasesId, CaInstrumentId, CommentText, PercentReleased, ReleasedBy) must be defined.'))
       }
       this.cw.runRequest('Pll/CaseInstReleases/Search', data).then(r => {
@@ -776,7 +776,7 @@ export class CaseFinancial {
    */
   searchAvailableFees(filters: {AccountCode?: string, FeeCode?: string, FeeDesc?: string, FeeSetupId?: number, FeeTypeId?: number}) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['AccountCode', 'FeeCode', 'FeeDesc', 'FeeSetupId', 'FeeTypeId']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['AccountCode', 'FeeCode', 'FeeDesc', 'FeeSetupId', 'FeeTypeId']).length==0) {
         reject(new CWError(8, 'At least one of the attributes (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId) must be defined.'))
       }
       var data = filters

package/src/case_workflow.ts

@@ -1,5 +1,6 @@
 import { CWError } from './error'
 const _ = require('lodash')
+import { Comments } from './comments'
 
 export class CaseWorkflow {
   /**
@@ -7,11 +8,19 @@ export class CaseWorkflow {
    */
   cw: any
 
+  /**
+   * Task sub-methods
+   */
+  task: Object
+
   /**
    * @hidden
    */
   constructor(cw) {
     this.cw = cw
+    this.task = {
+      comment: new Comments(cw, 'CaTask')
+    }
   }
 
   /**
@@ -266,7 +275,7 @@ export class CaseWorkflow {
       var data = {
         CaTaskId: caTaskId
       }
-      if(_.intersectionBy(options, ['TaskCompleteDate', 'TaskCompletedBy']).length==0) {
+      if(_.intersectionBy(_.keysIn(options), ['TaskCompleteDate', 'TaskCompletedBy']).length==0) {
         reject(new CWError(2, 'At least one of the attributes (TaskCompletedBy, TaskCompleteDate) must be defined.'))
       }
       if(typeof(options)!='undefined') {
@@ -349,7 +358,7 @@ export class CaseWorkflow {
    */
    searchForTasks(filters?: Object) {
     return new Promise((resolve, reject) => {
-      if(_.intersectionBy(filters, ['ResponsibleUserId', 'TaskAvailable', 'TaskComplete', 'TaskType']).length==0) {
+      if(_.intersectionBy(_.keysIn(filters), ['ResponsibleUserId', 'TaskAvailable', 'TaskComplete', 'TaskType']).length==0) {
         reject(new CWError(1, 'At least one of the attributes (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType) must be defined.'))
       }
       var data = filters

package/src/cityworks.ts

@@ -34,10 +34,10 @@ interface Citywork {
   default_domain?: any
 
   general?: Object
+  search?: Object
   activity_link?: Object
   message_queue?: Object
   gis?: Object
-  // case?: Object
   inspection?: Object
   workorder?: Object
   request?: Object
@@ -87,10 +87,10 @@ module.exports = class Cityworks implements Citywork {
   }
   error?: Object
   general?: Object
+  search?: Object
   activity_link?: Object
   message_queue?: Object
   gis?: Object
-  search?: Object
   request?: Object
   inspection?: Object
   workorder?: Object
@@ -154,6 +154,7 @@ module.exports = class Cityworks implements Citywork {
       this.inspection = new Inspection(this)
       this.workorder = new WorkOrder(this)
       this.case = new Case(this)
+      this.search = new Search(this)
     } else {
       let _this = this
       _.forEach(this.potential_loads, function(v) {
@@ -248,7 +249,6 @@ 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') {
-                  // console.log(str, options, pd, obj)
                   resolve(obj)
                 } else {
                   reject(new CWError(3, "Unknown error.", {options: options, postedData: pd, api_returned_string: obj}))

package/src/comments.ts

@@ -0,0 +1,159 @@
+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, activityType) {
+    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, 'Activity type not found.', {'provided': activityType, 'options':this.activityTypes})
+    }
+    this.currentActivityType = activityType
+  }
+
+  /**
+   * Add a comment
+   *
+   * @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)
+      })
+    })
+  }
+
+  /**
+   * 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)
+      })
+    })
+  }
+
+  /**
+   * 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)
+      })
+    })
+  }
+
+  // /**
+  //  * 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)
+  //     })
+  //   })
+  // }
+
+}

package/src/message_queue.ts

@@ -13,7 +13,12 @@ export class MessageQueue {
    * Complete: 2,
    * Failed: 3
    */
-  status: Object
+  status: Object = {
+    Pending: 0,
+    Processing: 1,
+    Complete: 2,
+    Failed: 3
+  }
   /**
    * Hook Types -
    * Unknown: 0,
@@ -21,25 +26,18 @@ export class MessageQueue {
    * Email: 2,
    * WebHook: 3
    */
-  hook_types: Object
+  hook_types: Object = {
+    Unknown: 0,
+    ActivityUpdate: 1,
+    Email: 2,
+    WebHook: 3
+  }
 
   /**
    * @hidden
    */
   constructor(cw) {
     this.cw = cw
-    this.status = {
-      Pending: 0,
-      Processing: 1,
-      Complete: 2,
-      Failed: 3
-    }
-    this.hook_types = {
-      Unknown: 0,
-      ActivityUpdate: 1,
-      Email: 2,
-      WebHook: 3
-    }
   }
 
   /**

package/src/request.ts

@@ -1,6 +1,7 @@
 import { CWError } from './error'
 const _ = require('lodash')
 import { RequestAdmin } from './request_admin'
+import { Comments } from './comments'
 
 export class Request {
   /**
@@ -13,12 +14,18 @@ export class Request {
    */
   admin?: Object
 
+  /**
+   * WorkOrder Comments methods
+   */
+  comment: Object
+
   /**
    * @hidden
    */
   constructor(cw) {
     this.cw = cw
     this.admin = new RequestAdmin(cw)
+    this.comment = new Comments(cw, 'Request')
   }
 
   /**
@@ -219,28 +226,6 @@ export class Request {
     })
   }
 
-  /**
-   * Add a comment to a request
-   *
-   * @category Requests
-   * @param {number} requestId - The ID of the request to retrieve
-   * @param {string} comment - The comment text to add
-   * @return {Object} Returns Promise that represents an object describing the comment added
-   */
-  comment(requestId: number, comment: string) {
-    return new Promise((resolve, reject) => {
-      var data = {
-        RequestId: requestId,
-        Comments: comment
-      }
-      this.cw.runRequest('Ams/ServiceRequest/AddComments', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
   /**
    * Cancel requests
    *