cityworks 2.2.9 → 2.2.10

package/dist/briefcase.d.ts

@@ -198,11 +198,11 @@ export declare class Briefcase {
      *
      * @category Cases
      * @param {number} caObjectId - The case Object ID to get
-     * @param {number} configId - The configuration ID to get use
+     * @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, configId: number, tableName: string): Promise<Array<any>>;
+    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 };