cityworks 0.0.15 → 0.0.20

package/dist/inspection.d.ts

@@ -3,6 +3,10 @@ export declare class Inspection {
      * @hidden
      */
     cw: any;
+    /**
+     * Inspection Administration methods
+     */
+    admin?: Object;
     /**
      * @hidden
      */
@@ -220,6 +224,25 @@ export declare class Inspection {
      * @return {Object} Returns Promise that represents an Array of the districts
      */
     getDistricts(): Promise<unknown>;
+    /**
+     * Get Inspection Employee lists. Abstraction done here, though only one employee list field, AFAIK.
+     *
+     * @category Inspection Options
+     * @param {string} listType - Which list (endpoint) to get. Includes only SubmitTos.
+     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
+     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
+     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
+     */
+    getEmployeeLists(listType: string, includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
+    /**
+     * Get SubmitTo list
+     *
+     * @category WorkOrder Options
+     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
+     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
+     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
+     */
+    getSubmitTos(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
     /**
      * Move inspection by InspectionId. Must provide well known id (WKID) or well known text (WKT)
      *
@@ -227,11 +250,15 @@ export declare class Inspection {
      * @param {number} inspectionId - The ID of the inspection that should be moved
      * @param {number} x - The X coordinate for the move
      * @param {number} y - The Y coordinate for the move
-     * @param {Object} projection_info - An object which must include either WKID: Int32 or WKT: String. Can also include VcsWKID.
-     * @param {number} [z] - the optional z coordinate for the move
-     * @return {Object} Returns Promise which represents a GISPoint object
-     */
-    move(inspectionId: number, x: number, y: number, projection_info?: Object, z?: number): Promise<unknown>;
+     * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
+     * @param {number} [z] - the optional Z coordinate for the move
+     * @return {Object} Returns Promise that represents an object describing the updated GISPoint
+     */
+    move(inspectionId: number, x: number, y: number, projection: {
+        WKID?: string;
+        WKT?: string;
+        VcsWKID?: string;
+    }, z?: number): Promise<unknown>;
     /**
      * Get inspection templates
      *

package/dist/inspection_admin.d.ts

@@ -0,0 +1,10 @@
+export declare class InspectionAdmin {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+}

package/dist/request.d.ts

@@ -3,6 +3,10 @@ export declare class Request {
      * @hidden
      */
     cw: any;
+    /**
+     * Request Administration methods
+     */
+    admin?: Object;
     /**
      * @hidden
      */
@@ -30,11 +34,15 @@ export declare class Request {
      * @param {number} requestId
      * @param {number} x
      * @param {number} y
-     * @param {Object} projection - Should include WKT or WKID attribute. Can also include VcsWKID attribute.
+     * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
      * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents an object describing the updated request
+     * @return {Object} Returns Promise that represents an object describing the updated GISPoint
      */
-    move(requestId: number, x: number, y: number, projection: Object, z?: number): Promise<unknown>;
+    move(requestId: number, x: number, y: number, projection: {
+        WKID?: string;
+        WKT?: string;
+        VcsWKID?: string;
+    }, z?: number): Promise<unknown>;
     /**
      * Change a request's problem code
      *
@@ -232,22 +240,31 @@ export declare class Request {
      * @return {Object} Returns Promise that represents an Array of statuses.
      */
     getStatuses(domainIds: Array<number>): Promise<unknown>;
+    /**
+     * Get a list of possible Employee values
+     *
+     * @category Request Options
+     * @param {string} listType - Which list (endpoint) to get. Includes only DispatchTo & SubmitTo.
+     * @param {number} domainId - Domain to return possible dispatchTo values for
+     * @return {Object} Returns Promise that represents an Array of Employee options.
+     */
+    getEmployeeLists(listType: string, domainId: number): Promise<unknown>;
     /**
      * Get a list of possible DispatchTo values
      *
      * @category Request Options
-     * @param {Array<number>} domainId - Domain to return possible dispatchTo values for
+     * @param {number} domainId - Domain to return possible dispatchTo values for
      * @return {Object} Returns Promise that represents an Array of dispatchTo options.
      */
-    getDispatchTo(domainId: Array<number>): Promise<unknown>;
+    getDispatchTos(domainId: number): Promise<unknown>;
     /**
      * Get a list of possible SubmitTo values
      *
      * @category Request Options
-     * @param {Array<number>} domainId - Domain to return possible submitTo values for
+     * @param {number} domainId - Domain to return possible submitTo values for
      * @return {Object} Returns Promise that represents an Array of submitTo options.
      */
-    getSubmitTo(domainId: Array<number>): Promise<unknown>;
+    getSubmitTos(domainId: number): Promise<unknown>;
     /**
      * Get street codes
      *

package/dist/request_admin.d.ts

@@ -0,0 +1,10 @@
+export declare class RequestAdmin {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+}

package/dist/workorder.d.ts

@@ -3,6 +3,10 @@ export declare class WorkOrder {
      * @hidden
      */
     cw: any;
+    /**
+     * WorkOrder Administration methods
+     */
+    admin?: Object;
     /**
      * @hidden
      */
@@ -125,6 +129,16 @@ export declare class WorkOrder {
      * @return {Object} Returns object that represents a list of entities removed.
      */
     addEntities(workOrderSId: string | number, entityInfo: Object, updateXY?: boolean): Promise<unknown>;
+    /**
+     * Update a WorkOrder entity
+     *
+     * @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) EntityUid: {string}, Facility_Id: {string}, Level_Id: {string}
+     * @param {boolean} workComplete - Update WorkOrder completeness, default is true.
+     * @return {Object} Returns object that represents a list of entities removed.
+     */
+    updateEntity(workOrderSId: string | number, entityInfo: Object, workComplete?: boolean): Promise<unknown>;
     /**
      * Remove entities from a work order. Provide WorkOrderId and either ObjectIds or EntityType and EntityUids
      *
@@ -178,14 +192,68 @@ export declare class WorkOrder {
      */
     delete(workOrderIds: Array<number>): Promise<unknown>;
     /**
-     * Get categories
+     * Get WorkOrderS/IDs connected to provided entities
+     *
+     * @category WorkOrder Search
+     * @param {string} entityType - The entity type to find connected work orders
+     * @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)
+     * @return {Object} Returns Promise that represents an array of WorkOrderS/IDs
+     */
+    getWOsByEntities(entityType: string, entityUids: Array<string>, search?: Array<string | number>, s?: boolean): Promise<unknown>;
+    /**
+     * Get WorkOrderSid and description for provided WorkOrderId
+     *
+     * @category WorkOrder Search
+     * @param {string} workOrderId - The WorkOrderId for which to get the WorkOrderSid and description
+     * @return {Object} Returns Promise that represents an object with WorkOrderS/IDs & Description
+     */
+    getSearchList(workOrderId: string): Promise<unknown>;
+    /**
+     * Get WorkOrder Employee lists
+     *
+     * @category WorkOrder Options
+     * @param {string} listType - Which list (endpoint) to get. Includes Supervisors & SubmitTos.
+     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
+     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
+     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
+     */
+    getEmployeeLists(listType: string, includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
+    /**
+     * Get SubmitTo list
+     *
+     * @category WorkOrder Options
+     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
+     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
+     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
+     */
+    getSubmitTos(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
+    /**
+     * Get Supervisors list
+     *
+     * @category WorkOrder Options
+     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
+     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
+     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
+     */
+    getSupervisors(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
+    /**
+     * Get Status Options
+     *
+     * @category WorkOrder Options
+     * @return {Object} Returns Promise that represents a collection of codes. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CodeDesc
+     */
+    getStatuses(): Promise<unknown>;
+    /**
+     * Get Categories
      *
      * @category WorkOrder Options
      * @return {Object} Returns Promise that represents an array of configured workorder category code descriptions
      */
     getCategories(): Promise<unknown>;
     /**
-     * Get priorities
+     * Get Priorities
      *
      * @category WorkOrder Options
      * @return {Object} Returns Promise that represents an array of configured workorder priorities

package/dist/workorder_admin.d.ts

@@ -0,0 +1,10 @@
+export declare class WorkOrderAdmin {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+}

package/package.json

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

package/src/case.ts

@@ -4,6 +4,7 @@ const _ = require('lodash')
 import { CaseData } from './case_data'
 import { CaseFinancial } from './case_financial'
 import { CaseWorkflow} from './case_workflow'
+import { CaseAdmin } from './case_admin'
 
 export class Case {
   /**
@@ -24,6 +25,11 @@ export class Case {
    * Payment, Receipt, & Fee methods
    */
   financial?: Object
+  /**
+   * PLL Administration methods
+   */
+  admin?: Object
+
 
   /**
    * @hidden
@@ -33,6 +39,195 @@ export class Case {
     this.data = new CaseData(cw)
     this.workflow = new CaseWorkflow(cw)
     this.financial = new CaseFinancial(cw)
+    this.admin = new CaseAdmin(cw)
+  }
+
+  /**
+   * Create new case
+   *
+   * @category Cases
+   * @param {number} caseTypeId - The case Type ID
+   * @param {number} subTypeId - The case subType ID
+   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+   * @return {Object} Returns Promise that represents an object describing the newly-created case
+   */
+  create(caseTypeId: number, subTypeId: number, options?: Object) {
+    return new Promise((resolve, reject) => {
+      var data_init = {
+        CaseTypeId: caseTypeId,
+        SubTypeId: subTypeId
+      }
+      var data = _.merge(data_init, options)
+      this.cw.runRequest('Pll/Case/Create', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Create a child case
+   *
+   * @category Cases
+   * @param {number} busCaseId - The case Type ID
+   * @param {number} parentCaObjectId - The case subType ID
+   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+   * @return {Object} Returns Promise that represents an object describing the newly-created case
+   */
+  createChild(busCaseId: number, parentCaObjectId: number, options?: Object) {
+    return new Promise((resolve, reject) => {
+      var data_init = {
+        BusCaseId: busCaseId,
+        ParentCaObjectId: parentCaObjectId
+      }
+      var data = _.merge(data_init, options)
+      this.cw.runRequest('Pll/Case/CreateChild', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Create a case from a Service Request
+   *
+   * @category Cases
+   * @param {number} caseTypeId - The case Type ID
+   * @param {number} subTypeId - The case subType ID
+   * @param {number} requestId - The service request ID
+   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+   * @return {Object} Returns Promise that represents an object describing the newly-created case
+   */
+  createFromRequest(caseTypeId: number, subTypeId: number, requestId: number, options?: Object) {
+    return new Promise((resolve, reject) => {
+      var data_init = {
+        CaseTypeId: caseTypeId,
+        SubTypeId: subTypeId,
+        ServiceRequestId: requestId
+      }
+      var data = _.merge(data_init, options)
+      this.cw.runRequest('Pll/CaseObject/CreateCaseFromServiceRequest', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Update a case
+   *
+   * @category Cases
+   * @param {number} caObjectId - The case Object ID to update
+   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+   * @return {Object} Returns Promise that represents an object describing the updated case
+   */
+  update(caObjectId: number, options?: Object) {
+    return new Promise((resolve, reject) => {
+      var data_init = {
+        CaObjectId: caObjectId
+      }
+      var data = _.merge(data_init, options)
+      this.cw.runRequest('Pll/CaseObject/Update', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get cases by IDs
+   *
+   * @category Cases
+   * @param {Array<number>} caObjectIds - The case Object ID to update
+   * @return {Object} Returns Promise that represents a collection of objects describing the cases
+   */
+  getByIds(caObjectIds: Array<number>) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        CaObjectIds: caObjectIds
+      }
+      this.cw.runRequest('Pll/CaseObject/ByIds', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+   *
+   * @category Cases
+   * @param {Object} filters - The parameter(s) to search by
+   * @return {Object} Returns Promise that represents an Array of case Object IDs
+   */
+  search(filters: Object) {
+    return new Promise((resolve, reject) => {
+      var data = filters
+      this.cw.runRequest('Pll/CaseObject/Search', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Move a Case point
+   *
+   * @category Cases
+   * @param {string} caObjectId
+   * @param {number} x
+   * @param {number} y
+   * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
+   * @param {number} [z] - Optional Z coordinate
+   * @return {Object} Returns Promise that represents an object describing the updated GISPoint
+   */
+  move(caObjectId: number, x: number, y: number, projection: {WKID?: string, WKT?: string, VcsWKID?: string}, z?: number) {
+    return new Promise((resolve, reject) => {
+      if(!_.has(projection, 'WKID') && !_.has(projection, 'WKT')) {
+        // Throw error
+        reject(new CWError(1, 'You must provide either the WKID or WKT for the x/y coordinates.', {'projection': projection}))
+      }
+      var data_init = {
+        CaObjectId: caObjectId,
+        X: x,
+        Y: y
+      };
+      if(typeof(z)!='undefined') {
+        _.set(data_init, 'Z', z)
+      }
+      var data = _.merge(data_init, projection);
+      this.cw.runRequest('Pll/CaseObject/Move', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    });
+  }
+
+  /**
+   * Delete case
+   *
+   * @category Cases
+   * @param {number} caObjectId - The case Object ID
+   * @return {Object} Returns Promise that represents an object describing the deleted case
+   */
+  delete(caObjectId: number) {
+    return new Promise((resolve, reject) => {
+      var data = {
+        CaObjectId: caObjectId,
+      }
+      this.cw.runRequest('Pll/CaseObject/DeleteCase', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
   }
 
 }