cityworks 2.2.7 → 2.2.10

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Walker Hamilton <3987+walker@users.noreply.github.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Walker Hamilton <3987+walker@users.noreply.github.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,119 +1,119 @@
-# Cityworks node.js API wrapper
-
-This API wrapper for Cityworks follows the Cityworks release schedule as closely as possible. Functionality may be missing depending on necessity or use.
-
-Require the class:
-
-      const cw = require('cityworks')
-
-or
-
-      import * as cw from 'cityworks'
-
-Instantiate the Class for the instance of Cityworks available given a domain:
-
-      cw.Cityworks.configure('cwoffice.domain.tld', {path: 'cityworks', version: 15})
-
-or 
-
-      cw.Cityworks.configure('cw.domain.tld', {path: 'cityworks', version: 23});
-
-
-## Authentication
-
-Authenticate with the Cityworks install:
-
-      cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {}).catch(error => {
-        console.log(error.message)
-      })
-
-
-Get the currently valid token in order to store it in a session or cookie:
-
-      cw.Cityworks.getToken()
-
-Provide a saved token instead of the standard u/p auth:
-
-      cw.Cityworks.setToken('mytoken')
-
-## Main method calls
-
-Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [Service Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Briefcase.html) object libraries like so:
-
-      cw.inspection.methodHere().then(resp => {})
-      cw.workorder.methodHere().then(resp => {})
-      cw.request.methodHere().then(resp => {})
-      cw.briefcase.methodHere().then(resp => {})
-
-Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
-
-[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
-
-      cw.general.methodHere().then(resp => {})
-
-[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
-
-      cw.message_queue.methodHere().then(resp => {})
-
-[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
-
-      cw.activity_link.methodHere().then(resp => {})
-
-[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
-
-      cw.gis.methodHere().then(resp => {})
-
-[General query methods](https://walker.github.io/cityworks/classes/query.Query.html):
-
-      cw.query.methodHere().then(resp => {})
-
-[(Deprecated) General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
-
-      cw.search.methodHere().then(resp => {})
-
-## Case financials, data details, and admin
-
-For the sake of organizing some of the other methods needed by the primary and secondary libraries, there are also objects and methods accessed within those main libraries:
-
-For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
-
-      cw.briefcase.financial.methodHere().then(resp => {})
-
-For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
-
-      cw.briefcase.data.methodHere().then(resp => {})
-
-For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
-
-      cw.briefcase.workflow.methodHere().then(resp => {})
-
-For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
-
-      cw.briefcase.admin.methodHere().then(resp => {})
-
-## Commenting
-
-For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/comments.Comments.html) via the class the comment is to be made on:
-
-      cw.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {})
-
-      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {})
-
-      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {})
-
-## Attachments
-
-For any object in Cityworks which has attachments, (including cases as CaRelDocs), use the [Attachments class](https://walker.github.io/cityworks/modules/attachments.html) via the class the attachment is to be made on:
-
-      cw.briefcase.attachment.add(CaObjectIdGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.workorder.attachment.add(WorkOrderSIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.request.attachment.add(RequestIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.inspection.attachment.add(InspectionIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-
-## Activity Links
-
-      cw.activity_link.add(source_type, source_sid, destination_type, destination_sid)
+# Cityworks node.js API wrapper
+
+This API wrapper for Cityworks follows the Cityworks release schedule as closely as possible. Functionality may be missing depending on necessity or use.
+
+Require the class:
+
+      const cw = require('cityworks')
+
+or
+
+      import * as cw from 'cityworks'
+
+Instantiate the Class for the instance of Cityworks available given a domain:
+
+      cw.Cityworks.configure('cwoffice.domain.tld', {path: 'cityworks', version: 15})
+
+or 
+
+      cw.Cityworks.configure('cw.domain.tld', {path: 'cityworks', version: 23});
+
+
+## Authentication
+
+Authenticate with the Cityworks install:
+
+      cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {}).catch(error => {
+        console.log(error.message)
+      })
+
+
+Get the currently valid token in order to store it in a session or cookie:
+
+      cw.Cityworks.getToken()
+
+Provide a saved token instead of the standard u/p auth:
+
+      cw.Cityworks.setToken('mytoken')
+
+## Main method calls
+
+Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [Service Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Briefcase.html) object libraries like so:
+
+      cw.inspection.methodHere().then(resp => {})
+      cw.workorder.methodHere().then(resp => {})
+      cw.request.methodHere().then(resp => {})
+      cw.briefcase.methodHere().then(resp => {})
+
+Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
+
+[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
+
+      cw.general.methodHere().then(resp => {})
+
+[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
+
+      cw.message_queue.methodHere().then(resp => {})
+
+[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
+
+      cw.activity_link.methodHere().then(resp => {})
+
+[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
+
+      cw.gis.methodHere().then(resp => {})
+
+[General query methods](https://walker.github.io/cityworks/classes/query.Query.html):
+
+      cw.query.methodHere().then(resp => {})
+
+[(Deprecated) General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
+
+      cw.search.methodHere().then(resp => {})
+
+## Case financials, data details, and admin
+
+For the sake of organizing some of the other methods needed by the primary and secondary libraries, there are also objects and methods accessed within those main libraries:
+
+For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
+
+      cw.briefcase.financial.methodHere().then(resp => {})
+
+For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
+
+      cw.briefcase.data.methodHere().then(resp => {})
+
+For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
+
+      cw.briefcase.workflow.methodHere().then(resp => {})
+
+For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
+
+      cw.briefcase.admin.methodHere().then(resp => {})
+
+## Commenting
+
+For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/comments.Comments.html) via the class the comment is to be made on:
+
+      cw.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {})
+
+      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {})
+
+      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {})
+
+## Attachments
+
+For any object in Cityworks which has attachments, (including cases as CaRelDocs), use the [Attachments class](https://walker.github.io/cityworks/modules/attachments.html) via the class the attachment is to be made on:
+
+      cw.briefcase.attachment.add(CaObjectIdGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.workorder.attachment.add(WorkOrderSIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.request.attachment.add(RequestIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.inspection.attachment.add(InspectionIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+
+## Activity Links
+
+      cw.activity_link.add(source_type, source_sid, destination_type, destination_sid)

package/dist/briefcase.d.ts

@@ -193,6 +193,16 @@ export declare class Briefcase {
      * @return {Object} Returns Promise that represents an Array of case Object IDs
      */
     search(filters: Object): Promise<Array<number>>;
+    /**
+     * Get the configured custom data for the case, by template and table name
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case Object ID to get
+     * @param {number} busCaseId - The business case template ID for which to get the custom columns configuration and data
+     * @param {string} tableName - The name of the table to get custom data from
+     * @return {Object} Returns Promise that represents a collection of custom fields with data for the case instance
+     */
+    getCustomData(caObjectId: number, busCaseId: number, tableName: string): Promise<Array<any>>;
     /**
      * Move a Case point
      *

package/dist/employee.d.ts

@@ -0,0 +1,165 @@
+export interface EmployeeBase {
+    LastName: string;
+    FirstName?: string;
+    Email?: string;
+    Password?: string;
+    AdDomain?: string;
+    BenefitRate?: number;
+    BenefitType?: number;
+    DefaultImgPath?: string;
+    DomainId?: number;
+    EmailReq?: string;
+    EmployeeSid?: number;
+    EmployeeId?: string;
+    GroupIds?: Array<number>;
+    HolidayRate?: number;
+    HolidayType?: number;
+    HourlyRate?: number;
+    IsActive?: boolean;
+    IsDomain?: boolean;
+    LicenseCodes?: Array<string>;
+    LoginName?: string;
+    MapServiceId?: number;
+    MiddleInitial?: string;
+    MobileMapCacheId?: number;
+    Organization?: string;
+    OtherRate?: number;
+    OtherRateType?: number;
+    OverheadRate?: number;
+    OverheadType?: number;
+    OvertimeRate?: number;
+    OvertimeType?: number;
+    Pager?: string;
+    ShiftDiffRate?: number;
+    ShiftDiffType?: number;
+    StandbyRate?: number;
+    StandbyType?: number;
+    Title?: string;
+    UniqueName?: string;
+    WorkPhone?: string;
+}
+/**
+ * A plugin that contains "general" methods for a Cityworks install
+ */
+export declare class Employee {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Add a new employee
+     *
+     * @param {EmployeeBase} employee - The employee information. `LastName` is a required field.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    add(employee: EmployeeBase): Promise<unknown>;
+    /**
+     * Update existing employee(s)
+     *
+     * @param {number | Array<number>} employeeSids - The SIDs of the employees to update.
+     * @param {EmployeeBase} employee - The employee information to update. `LastName` is a required field. `EmployeeSid` and `EmployeeId` cannot be included in the employeeProperties object, as those are used to identify which employees to update and could cause unintended consequences if included in the update information.
+     * @return {Object} Returns Promise object that represents an object that is the updated user
+     */
+    update(employeeSids: number | Array<number>, employeeProperties: EmployeeBase): Promise<unknown>;
+    /**
+     * Get employee custom data fields by id
+     *
+     * @param {number} employeeSid - employeeSid with which the custom fields are associated
+     * @param {string} custFieldIds - which custom field IDs to retrieve.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    customDataFields(employeeSid: number, custFieldIds?: Array<string>): Promise<unknown>;
+    /**
+     * Get all employees
+     *
+     * @param {string} activityType - which activity type the following ID will be for.
+     * @param {number} activityId - activity Case or CaseTask (task instance) ID to check
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    all(inactive?: boolean): Promise<unknown>;
+    /**
+     * Get the employees in the group with the given group ID.
+     *
+     * @param {string} groupId - Which group to get employee list.
+     * @param {number} inactive - Whether to include inactive employees.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    byGroup(groupId: number, inactive?: boolean): Promise<unknown>;
+    /**
+     * Get employee by ID
+     *
+     * @param {string} employeeSid - The SID of the employee to retrieve.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    getById(employeeSid: number): Promise<unknown>;
+    /**
+     * Get employees by IDs
+     *
+     * @param {Array<number>} employeeSids - The SIDs of the employees to retrieve.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    getByIds(employeeSids: Array<number>): Promise<unknown>;
+    /**
+     * Delete by ID
+     *
+     * @param {Array<number>} employeeSids - The SIDs of the employees to delete.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    delete(employeeSids: Array<number>): Promise<unknown>;
+    /**
+     * Get groups that given employees are member of by employee sids.
+     *
+     * @param {Array<number>} employeeSids - The SIDs of the employees to retrieve groups for.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    getGroupsByEmployeeSid(employeeSids: Array<number>): Promise<unknown>;
+    /**
+     * Add a licenses to an employee
+     *
+     * @param {Array<number>} employeeIds - The IDs of the employees to whom to add licenses.
+     * @param {Array<string>} licenseCodes - The license codes to add.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    addLicenses(employeeIds: Array<Number>, licenseCodes: Array<string>): Promise<unknown>;
+    /**
+     * Delete licenses from an employee
+     *
+     * @param {Array<number>} employeeIds - The IDs of the employees from whom to delete licenses.
+     * @param {Array<string>} licenseCodes - The license codes to delete.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    deleteLicenses(employeeIds: Array<Number>, licenseCodes: Array<string>): Promise<unknown>;
+    /**
+     * Check names for uniqueness
+     *
+     * @param {Array<string>} namesToCheck - an array list of the names (strings) to check for uniqueness
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    checkNames(namesToCheck: Array<string>): Promise<unknown>;
+    /**
+     * Search for employees
+     *
+     * @param {Array<string>} searchParameters - an object of employee properties to search for. Support properties are: `AdDomain`, `DomainId`, `Email`, `EmployeeId`, `EmployeeSid`, `LoginName`, `UniqueName`, `FirstName`, `Lastname`, `FullName`, `IsUser`, `Organization`
+     * @param {boolean} active - search by active or all employees. Default is false (active only).
+     * @param {number} maxResults - the maximum number of results to return. Default is 20.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added user
+     */
+    search(searchParameters: {
+        AdDomain?: Array<string>;
+        DomainId?: Array<number>;
+        Email?: Array<string>;
+        EmployeeId?: Array<string>;
+        EmployeeSid?: Array<number>;
+        LoginName?: Array<string>;
+        UniqueName?: Array<string>;
+        FirstName?: Array<string>;
+        LastName?: Array<string>;
+        FullName?: Array<string>;
+        IsUser?: Boolean;
+        Organization?: Array<string>;
+    }, active?: boolean, maxResults?: number): Promise<unknown>;
+}

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { Request } from './request';
 import { Inspection } from './inspection';
 import { WorkOrder } from './workorder';
 import { Briefcase } from './briefcase';
+import { Employee } from './employee';
 interface Citywork {
 }
 /**
@@ -228,4 +229,5 @@ declare const inspection: Inspection;
 declare const workorder: WorkOrder;
 declare const briefcase: Briefcase;
 declare const report: Report;
-export { cw as Cityworks, general, activity_link, message_queue, search, query, gis, request, inspection, workorder, briefcase, report };
+declare const employee: Employee;
+export { cw as Cityworks, general, activity_link, message_queue, search, query, gis, request, inspection, workorder, briefcase, report, employee };