cityworks 0.0.30 → 0.0.35

package/src/event_layer.ts

@@ -1,40 +1,231 @@
+import { CWError } from './error'
+const _ = require('lodash')
 
+/**
+ * A plugin that contains "event layer" methods for a Cityworks install
+ */
+export class EventLayer {
+  /**
+   * @hidden
+   */
+  cw: any
 
-// ams/EventLayer/Update
-// {number} EventLayerId
-// {boolean} Enabled
+  /**
+   * @hidden
+   */
+  constructor(cw) {
+    this.cw = cw
+  }
 
-// EurlQuery/idnames
-// {Array<number>} CreateBySids
-// {Array<string>} QueryTypes
+  /**
+   * Update (enable/disable) an event layer
+   *
+   * @param {string} eventLayerId - which event layer to update
+   * @param {boolean} enabled - true to enable, false to disable
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   update(eventLayerId: number, enabled: boolean) {
+     return new Promise((resolve, reject) => {
+       let data = {"EventLayerId": eventLayerId, "Enabled": enabled}
+       this.cw.runRequest('Ams/EventLayer/Update', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/Preferences/UserSave
-// {string} Element - "VisibleQeIds"
-// {string} Category - "qe-map"
-// {Object} DefaultValue - {all: [3]}
+  /**
+   * Enable an event layer
+   *
+   * @param {string} eventLayerId - which event layer to update
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   enable(eventLayerId: number) {
+     return this.update(eventLayerId, true);
+   }
 
-// ams/EventLayer/All
-// data = {}
+   /**
+    * Disable an event layer
+    *
+    * @param {string} eventLayerId - which event layer to update
+    * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+    */
+    disable(eventLayerId: number) {
+      return this.update(eventLayerId, false);
+    }
 
-// general/eurlquery/QueryTypes
-// data = {}
+  /**
+   * ??
+   *
+   * @param {Array<number>} createBySids -
+   * @param {Array<string>} queryTypes -
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   createByID(createBySids: Array<number>, queryTypes: Array<number>) {
+     return new Promise((resolve, reject) => {
+       let data = {"CreateBySids": createBySids, "QueryTypes": queryTypes}
+       this.cw.runRequest('Ams/EurlQuery/IdNames', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/Preferences/User
-// data={}
+  /**
+   * Save user preferences
+   *
+   * @param {string} element - "VisibleQeIds"
+   * @param {string} category - "qe-map"
+   * @param {Object} defaultValue - {all: [3]}
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   updatePreferences(element: number, category: boolean, defaultValue: Object) {
+     return new Promise((resolve, reject) => {
+       let data = {"Element": element, "Category": category, "DefaultValue": defaultValue}
+       this.cw.runRequest('Ams/Preferences/UserSave', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/EventLayer/Styles
-// data={}
+  /**
+   * Get all event layers
+   *
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   all() {
+     return new Promise((resolve, reject) => {
+       let data = {}
+       this.cw.runRequest('Ams/EventLayer/All', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/Preferences/User
-// {Array[string]} PreferenceNames - ["VisibleQeIds"]
-// {Array<string>} Categories - ["qe-map"]
+  /**
+   * Get all EUrl Query Types
+   *
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   queryTypes() {
+     return new Promise((resolve, reject) => {
+       let data = {}
+       this.cw.runRequest('General/EurlQuery/QueryTypes', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/EventLayer/All
-// {boolean} IncludeDisabled
+  /**
+   * Get Preferences for User
+   *
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   preferences() {
+     return new Promise((resolve, reject) => {
+       let data = {}
+       this.cw.runRequest('Ams/Preferences/User', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// ams/EventLayer/Filters
-// {Array<number>} SearchIds
-// {Array<number>} EventLayerIds
+  /**
+   * Get Styles for event layers
+   *
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   styles() {
+     return new Promise((resolve, reject) => {
+       let data = {}
+       this.cw.runRequest('Ams/EventLayer/Styles', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 
-// eventLayer GIS endpoint
-// {path}/eventlayer/1/{EventLayerId}/rest/services/cw/FeatureServer/{#}?f=json
+  /**
+   * ??
+   *
+   * @param {Array<string>} preferenceNames - ["VisibleQeIds"]
+   * @param {Array<string>} categories - ["qe-map"]
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   xxxxxx(preferenceNames: Array<string>, categories: Array<string>) {
+     return new Promise((resolve, reject) => {
+       let data = {"PreferenceNames": preferenceNames, "Categories": categories}
+       this.cw.runRequest('Ams/Preferences/User', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e);
+       })
+     })
+   }
+
+  /**
+   * Get all event layers
+   *
+   * @param {boolean} includeDisabled - Defaults to false
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   getAllEventLayers(includeDisabled: boolean = false) {
+     return new Promise((resolve, reject) => {
+       let data = {"IncludeDisabled": includeDisabled}
+       this.cw.runRequest('Ams/EventLayer/All', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
+
+  /**
+   * Filter event layers by provided search definitions
+   *
+   * @param {Array<number>} searchIds - Defaults to false
+   * @param {Array<number>} eventLayerIds - Defaults to false
+   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
+   */
+   filterEventLayersBySearches(searchIds: Array<number>, eventLayerIds: Array<number>) {
+     return new Promise((resolve, reject) => {
+       let data = {"SearchIds": searchIds, "EventLayerIds": eventLayerIds}
+       this.cw.runRequest('Ams/EventLayer/Filters', data).then(r => {
+         // console.log(r, 'response')
+         resolve(r.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
+
+  /**
+   * eventLayer GIS endpoint, this may need to be a promise as well...
+   *
+   * @return {string} Returns string that is absolute URL for event layer GIS endpoint
+   */
+   getGISEndpoint(eventLayerId) {
+     return this.cw.base_url + '/' + this.cw.settings.path + '/eventlayer/1/' + eventLayerId + '/rest/services/cw/FeatureServer/{#}?f=json'; // 1 for SR, 2 for WorkOrders, 3 for Inspections, 5 for PLL Cases
+   }
+
+}

package/src/general.ts

@@ -26,6 +26,8 @@ export class General {
     return new Promise((resolve, reject) => {
       this.cw.runRequest('General/ActivityNotification/User', {}).then((response: any) => {
         resolve(response.Value)
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -50,7 +52,7 @@ export class General {
           // console.log(r, 'response')
           resolve(r.Value)
         }).catch(e => {
-          reject(new CWError(2, "Unknown error."))
+          reject(e)
         })
       }
     })
@@ -100,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
@@ -120,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

@@ -5,13 +5,13 @@ export class Gis {
   /**
    * @hidden
    */
-  cw: any;
+  cw: any
 
   /**
    * @hidden
    */
   constructor(cw) {
-    this.cw = cw;
+    this.cw = cw
   }
 
   /**
@@ -25,27 +25,29 @@ export class Gis {
    */
   getConfig(whichType, whichId, getGisData: boolean = true, context: Array<string> = []) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/Domain';
-      whichType = whichType.toLowerCase();
+      let path = 'Gis/MapService/Domain'
+      whichType = whichType.toLowerCase()
       let data: {DomainId?: any, GroupId?: any, MapServiceId?: any, UserId?: any, GetGisData: boolean, Security: Array<string>}
       switch(whichType) {
         case 'domain':
           data = {DomainId:whichId, GetGisData: getGisData, Security: context}
-          break;
+          break
         case 'group':
           data = {GroupId:whichId, GetGisData: getGisData, Security: context}
-          break;
+          break
         case 'mapservice':
           data = {MapServiceId:whichId, GetGisData: getGisData, Security: context}
-          break;
+          break
         case 'user':
           data = {UserId:whichId, GetGisData: getGisData, Security: context}
-          break;
+          break
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
@@ -56,14 +58,16 @@ export class Gis {
     */
   domain(domainId, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/Domain';
+      let path = 'Gis/MapService/Domain'
       let data = {
         DomainId: domainId
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
@@ -74,14 +78,16 @@ export class Gis {
      */
   downloadMobile(cacheId, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/DownloadMobileMapCache';
+      let path = 'Gis/MapService/DownloadMobileMapCache'
       let data = {
         MobileMapCacheId: cacheId
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
@@ -91,72 +97,80 @@ export class Gis {
    */
   initialExtent() {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/InitialExtent';
+      let path = 'Gis/MapService/InitialExtent'
       let data = {};
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
    * 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)
    */
   request(requestId, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/ServiceRequestConfiguration';
+      let path = 'Gis/MapService/ServiceRequestConfiguration'
       let data = {
         RequestId: requestId,
         GetGisData: getGisData
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
      * 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
      */
   inspection(inspectionId, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/InspectionConfiguration';
+      let path = 'Gis/MapService/InspectionConfiguration'
       let data = {
         InspectionId: inspectionId,
         GetGisData: getGisData
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
      * 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) => {
-      let path = 'Gis/MapService/WorkOrderConfiguration';
+      let path = 'Gis/MapService/WorkOrderConfiguration'
       let data = {
         WorkOrderSid: workOrderSid,
         GetGisData: getGisData
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
@@ -170,7 +184,7 @@ export class Gis {
      */
   user(context: Array<string> = [], allDomains: boolean = true, allGroups: boolean = true, getGisData: boolean = true) {
     return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/User';
+      let path = 'Gis/MapService/User'
       let data = {
         AllDomains: allDomains,
         AllGroups: allGroups,
@@ -178,23 +192,11 @@ export class Gis {
         Security: context
       }
       this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
-  }
-
-
-  /**
-     * Get currently selected entities from the Cityworks install's session for your user
-     * @return {Object} Returns Promise object that represents an Object with the currently-selected entities
-     */
-  selectedEntities() {
-    return new Promise((resolve, reject) => {
-      let path = 'General/AppData/SelectedEntities';
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value);
-      });
-    });
+        resolve(response.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
   /**
@@ -204,4 +206,37 @@ export class Gis {
    * @return {Object} Returns Promise object that represents an object describing the provided Geocoder service configuration
    */
    // Gis/GeoCode/GeocodeServer
+
+   /**
+      * Get currently selected entities from the Cityworks install's session for your user
+      * @return {Object} Returns Promise object that represents an Object with the currently-selected entities
+      */
+   selectedEntities() {
+     return new Promise((resolve, reject) => {
+       let path = 'General/AppData/SelectedEntities'
+       this.cw.runRequest(path, {}).then((response: any) => {
+         resolve(response.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
+
+   /**
+      * Get attributes available for provided entity
+      *
+      * @param {string} entityType - The entity type to describe
+      * @return {Object} Returns Promise object that represents a collection of attribute description objects
+      */
+   getEntityAttributes(entityType:string) {
+     return new Promise((resolve, reject) => {
+       let data = {EntityType: entityType}
+       let path = 'AMS/Entity/Attributes'
+       this.cw.runRequest(path, data).then((response: any) => {
+         resolve(response.Value)
+       }).catch(e => {
+         reject(e)
+       })
+     })
+   }
 }

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
@@ -644,7 +644,7 @@ export class Inspection {
    * @param {Array<string>} [entityTypes] - The Entity Type(s) to return potential inspections for
    * @param {boolean} [canCreate] - If true, only return templates the user can create, ignored if false or null, default is true
    * @param {Object} [options] - An object which can include: [IncludeInactive]: boolean, MaximumDateModified: Date, MinimumDateModified: Date, TemplateIds: Array<number>
-   * @return {Object} Returns Promise that represents a collection of all possible employees for an Inspection's SubmitTo
+   * @return {Object} Returns Promise that represents a collection of all Inspections matching the provided parameters
    */
   getTemplates(entityTypes?: Array<string>, canCreate?: boolean, options?: {IncludeInactive?: boolean, MaximumDateModified?: Date, MinimumDateModified?: Date, TemplateIds?: Array<number>}) {
     return new Promise((resolve, reject) => {

package/src/inspection_admin.ts

@@ -14,4 +14,32 @@ export class InspectionAdmin {
     this.cw = cw
   }
 
+  /**
+   * Get inspection templates
+   *
+   * @category Inspection Templates
+   * @param {Array<string>} [entityTypes] - The Entity Type(s) to return potential inspections for
+   * @param {boolean} [canCreate] - If true, only return templates the user can create, ignored if false or null, default is true
+   * @param {Object} [options] - An object which can include: [IncludeInactive]: boolean, MaximumDateModified: Date, MinimumDateModified: Date, TemplateIds: Array<number>
+   * @return {Object} Returns Promise that represents a collection of all Inspections matching the provided parameters
+   */
+  getTemplates(entityTypes?: Array<string>, canCreate?: boolean, options?: {IncludeInactive?: boolean, MaximumDateModified?: Date, MinimumDateModified?: Date, TemplateIds?: Array<number>}) {
+    return new Promise((resolve, reject) => {
+      var data: {EntityTypes?: Array<string>, CanCreate?: boolean, IncludeInactive?: boolean, MaximumDateModified?: Date, MinimumDateModified?: Date, TemplateIds?: Array<number>} = {}
+      if(typeof(entityTypes)!=='undefined') {
+        data.EntityTypes = entityTypes
+      }
+      data.CanCreate = typeof(canCreate)!=='undefined' ? canCreate : true
+      if(typeof(options)==='object') {
+        _.forIn(options, (v, k) => {
+          data[k] = v
+        })
+      }
+      this.cw.runRequest('Ams/InspectionTemplate/Templates', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
 }

package/src/message_queue.ts

@@ -53,6 +53,8 @@ export class MessageQueue {
       let path = 'General/WebHookEvent/ProcessMessages'
       this.cw.runRequest(path, data).then((response: any) => {
         // TODO
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -78,6 +80,8 @@ export class MessageQueue {
       let path = 'General/MessageQueue/ByIds'
       this.cw.runRequest(path, data).then((response: any) => {
         // TODO
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -103,6 +107,8 @@ export class MessageQueue {
       let path = 'General/MessageQueue/Delete'
       this.cw.runRequest(path, data).then((response: any) => {
         // TODO
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -117,6 +123,8 @@ export class MessageQueue {
       let path = 'General/MessageQueue/Preferences'
       this.cw.runRequest(path, data).then((response: any) => {
         // TODO
+      }).catch(e => {
+        reject(e)
       })
     })
   }
@@ -148,6 +156,8 @@ export class MessageQueue {
           response.Value = []
         }
         resolve(response.Value)
+      }).catch(e => {
+        reject(e)
       })
     })
   }