cityworks 2.2.14 → 2.2.16

package/dist/audit_logs.d.ts

@@ -0,0 +1,29 @@
+export interface CWMetaData {
+    CWId?: string;
+    CwSid?: number;
+    DateModified?: Date | string;
+    FieldName?: string;
+    LoginName?: string;
+    NewValue?: string;
+    ObjectId?: number;
+    OldValue?: string;
+    TableName?: string;
+}
+export declare class AuditLogs {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of the active table name context.
+     */
+    currentTableName: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any, tableName: string);
+    /**
+     * Get audit log metadata by current table name context and SIDs.
+     */
+    get(ids: number | Array<number>): Promise<unknown>;
+}

package/dist/contractor.d.ts

@@ -0,0 +1,85 @@
+export interface ContractorTypeSearch {
+    ContractorDesc?: string;
+    ContractorType?: string;
+    ContractorTypeId?: number;
+}
+export interface ContractorPLLSearch {
+    BusinessName?: string;
+    ContractorId?: number;
+}
+export declare class ContractorType {
+    cw: any;
+    constructor(cw: any);
+    all(): Promise<unknown>;
+    search(filters: ContractorTypeSearch): Promise<unknown>;
+    searchObject(filters: ContractorTypeSearch): Promise<unknown>;
+}
+export interface ContractorBase {
+    ContractorSid?: number;
+    ContractorName?: string;
+    ContractorNumber?: string;
+    RateType?: string;
+    EmergencyFactor?: number;
+    OverheadRate?: number;
+    Rate?: number;
+    Description?: string;
+    OverheadType?: string;
+    ProviderType?: string;
+    OvertimeFactor?: number;
+    ContactName?: string;
+    Address?: string;
+    City?: string;
+    State?: string;
+    Zip?: string;
+    CellPhone?: string;
+    OfficePhone?: string;
+    Email?: string;
+    LocallyBased?: boolean;
+    Comments?: string;
+    Licensed?: boolean;
+    LicenseExpDate?: Date;
+    LicensedWork?: string;
+    Viewable?: boolean;
+    FederalTaxId?: string;
+    FMSNo?: string;
+    PIN?: string;
+    OtherPhone?: string;
+    Fax?: string;
+    MWBE?: boolean;
+    RegistrationDate?: Date;
+    LiabilityInsCertificate?: string;
+    LiabilityInsEffectDate?: Date;
+    LiabilityInsExpireDate?: Date;
+    LiabilityInsAmount?: number;
+    WorkersCompCertificate?: string;
+    WorkersCompEffectDate?: Date;
+    WorkersCompExpireDate?: Date;
+    WorkersCompAmount?: number;
+    AutomobileInsCertificate?: string;
+    AutomobileInsEffectDate?: Date;
+    AutomobileInsExpireDate?: Date;
+    AutomobileInsAmount?: number;
+    GeneralLiabilityCertificate?: string;
+    GeneralLiabilityEffectDate?: Date;
+    GeneralLiabilityExpireDate?: Date;
+    GeneralLiabilityAmount?: number;
+    ProvidesLabor?: boolean;
+    ProvidesMaterial?: boolean;
+    ProvidesEquipment?: boolean;
+    CustomFieldValues?: Record<number, string>;
+}
+export declare class Contractor {
+    cw: any;
+    type: ContractorType;
+    constructor(cw: any);
+    add(contractor: ContractorBase): Promise<unknown>;
+    update(contractorSid: number, contractorProperties: ContractorBase): Promise<unknown>;
+    all(viewableOnly?: boolean): Promise<unknown>;
+    getById(contractorSid: number): Promise<unknown>;
+    search(contractorSids: Array<number> | ContractorPLLSearch): Promise<unknown>;
+    customDataFields(contractorSid: number, custFieldIds?: Array<number>): Promise<unknown>;
+    delete(contractorSids: Array<number>): Promise<unknown>;
+    keywords(contractorSids: Array<number>): Promise<unknown>;
+    addKeywords(contractorSids: Array<number>, keywords: Array<string>): Promise<unknown>;
+    deleteKeywords(contractorSids: Array<number>, keywords: Array<string>, all?: boolean): Promise<unknown>;
+}

package/dist/equipment.d.ts

@@ -0,0 +1,97 @@
+import { EquipmentChangeout } from './equipment_changeout';
+import { EquipmentCost } from './equipment_cost';
+import { EquipmentReservation } from './equipment_reservation';
+export interface EquipmentBase {
+    EquipmentUid?: string;
+    EquipmentSid?: number;
+    Category?: string;
+    DefaultImgPath?: string;
+    Description?: string;
+    Manufacturer?: string;
+    Model?: string;
+    ForCheckout?: boolean;
+    RateType?: string;
+    UnitCost?: number;
+    WarranteeDate?: Date;
+    Viewable?: boolean;
+    CustomFieldValues?: Record<number, string>;
+}
+export { EquipmentChangeout } from './equipment_changeout';
+export { EquipmentCost } from './equipment_cost';
+export { EquipmentReservation } from './equipment_reservation';
+export type { EquipmentReadData, EquipmentChangeoutOperation } from './equipment_changeout';
+export type { EquipmentCostOptions } from './equipment_cost';
+export type { EquipmentReservationOptions } from './equipment_reservation';
+/**
+ * A plugin that contains equipment methods for a Cityworks install
+ */
+export declare class Equipment {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Changeout operations for equipment
+     */
+    changeout: EquipmentChangeout;
+    /**
+     * Cost operations for equipment
+     */
+    cost: EquipmentCost;
+    /**
+     * Reservation operations for equipment
+     */
+    reservation: EquipmentReservation;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Add new equipment
+     *
+     * @param {EquipmentBase} equipment - The equipment information. `EquipmentUid` is a required field.
+     * @return {Object} Returns Promise object that represents an object that is the newly-added equipment
+     */
+    add(equipment: EquipmentBase): Promise<unknown>;
+    /**
+     * Update existing equipment
+     *
+     * @param {number | Array<number>} equipmentSids - The SIDs of the equipment to update.
+     * @param {EquipmentBase} equipmentProperties - The equipment information to update. `EquipmentSid` cannot be included in the equipmentProperties object, as those are used to identify which equipment 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 equipment
+     */
+    update(equipmentSids: number | Array<number>, equipmentProperties: EquipmentBase): Promise<unknown>;
+    /**
+     * Get equipment custom data fields by id
+     */
+    customDataFields(equipmentSid: number, custFieldIds?: Array<number>): Promise<unknown>;
+    /**
+     * Get all equipment
+     */
+    all(viewableOnly?: boolean): Promise<unknown>;
+    /**
+     * Get equipment by ID
+     */
+    getById(equipmentSid: number): Promise<unknown>;
+    /**
+     * Get equipment by IDs
+     */
+    getByIds(equipmentSids: Array<number>): Promise<unknown>;
+    /**
+     * Delete equipment by ID
+     */
+    delete(equipmentSids: Array<number>): Promise<unknown>;
+    /**
+     * Search for equipment
+     */
+    search(searchParameters: {
+        Description?: Array<string>;
+        EquipmentSid?: Array<number>;
+        EquipmentUid?: Array<string>;
+        ForCheckout?: boolean;
+        Manufacturer?: Array<string>;
+        Model?: Array<string>;
+        RateType?: Array<string>;
+        Viewable?: boolean;
+    }, maxResults?: number): Promise<unknown>;
+}

package/dist/equipment_changeout.d.ts

@@ -0,0 +1,127 @@
+export interface EquipmentReadData {
+    Id?: number;
+    Text1?: string;
+    Text2?: string;
+    Text3?: string;
+    Text4?: string;
+    Text5?: string;
+    Text6?: string;
+    Text7?: string;
+    Text8?: string;
+    Text9?: string;
+    Text10?: string;
+    Text11?: string;
+    Text12?: string;
+    Text13?: string;
+    Text14?: string;
+    Text15?: string;
+    Text16?: string;
+    Text17?: string;
+    Text18?: string;
+    Text19?: string;
+    Text20?: string;
+    Num1?: number;
+    Num2?: number;
+    Num3?: number;
+    Num4?: number;
+    Num5?: number;
+    Num6?: number;
+    Num7?: number;
+    Num8?: number;
+    Num9?: number;
+    Num10?: number;
+    Num11?: number;
+    Num12?: number;
+    Num13?: number;
+    Num14?: number;
+    Num15?: number;
+    Num16?: number;
+    Num17?: number;
+    Num18?: number;
+    Num19?: number;
+    Num20?: number;
+    Date1?: Date;
+    Date2?: Date;
+    Date3?: Date;
+    Date4?: Date;
+    Date5?: Date;
+}
+export interface EquipmentChangeoutOperation {
+    ChangeOutId: number;
+    Operation: number;
+    AssetType?: string;
+    NewUid?: string;
+    OldUid?: string;
+    RecordDate?: Date;
+    OperationComments?: string;
+    NewRead?: EquipmentReadData;
+    OldRead?: EquipmentReadData;
+}
+export declare class EquipmentChangeout {
+    cw: any;
+    constructor(cw: any);
+    addChangeOutRead(changeOutId: number, operationId: number, isNewRead: boolean, readData?: EquipmentReadData): Promise<unknown>;
+    addOperation(operation: EquipmentChangeoutOperation): Promise<unknown>;
+    attach(attachParams: {
+        ChangeOutId: number;
+        AssetType?: string;
+        NewUid: string;
+        NewRead?: EquipmentReadData;
+        OperationId?: number;
+        RecordDate?: Date;
+        OperationComments?: string;
+        FeatureType?: string;
+        FeatureUid?: string;
+        FeatureSid?: number;
+        Location?: string;
+        WorkOrderSid?: number;
+        WorkOrderId?: string;
+        InspectedBySid?: number;
+        ChangeDate?: Date;
+        ChangedById?: number;
+        UpdateMap?: boolean;
+        InspCustFieldCatId?: number;
+    }): Promise<unknown>;
+    detach(detachParams: {
+        ChangeOutId: number;
+        AssetType?: string;
+        OldUid: string;
+        OldRead?: EquipmentReadData;
+        OperationId?: number;
+        RecordDate?: Date;
+        OperationComments?: string;
+        FeatureType?: string;
+        FeatureUid?: string;
+        FeatureSid?: number;
+        Location?: string;
+        WorkOrderSid?: number;
+        WorkOrderId?: string;
+        InspectedBySid?: number;
+        ChangeDate?: Date;
+        ChangedById?: number;
+        UpdateMap?: boolean;
+        InspCustFieldCatId?: number;
+    }): Promise<unknown>;
+    replace(replaceParams: {
+        ChangeOutId: number;
+        AssetType?: string;
+        OldUid: string;
+        NewUid: string;
+        OldRead?: EquipmentReadData;
+        NewRead?: EquipmentReadData;
+        OperationId?: number;
+        RecordDate?: Date;
+        OperationComments?: string;
+        FeatureType?: string;
+        FeatureUid?: string;
+        FeatureSid?: number;
+        Location?: string;
+        WorkOrderSid?: number;
+        WorkOrderId?: string;
+        InspectedBySid?: number;
+        ChangeDate?: Date;
+        ChangedById?: number;
+        UpdateMap?: boolean;
+        InspCustFieldCatId?: number;
+    }): Promise<unknown>;
+}

package/dist/equipment_cost.d.ts

@@ -0,0 +1,31 @@
+export interface EquipmentCostOptions {
+    AcctNum?: string;
+    ContractorEquipmentCost?: number;
+    ContractorEquipmentDescription?: string;
+    ContractorEquipmentId?: string;
+    ContractorSids?: Array<number>;
+    EquipmentSids?: Array<number>;
+    Estimated?: boolean;
+    FinishDate?: Date;
+    Hours?: number;
+    OperatorId?: number;
+    StartDate?: Date;
+    Units?: number;
+}
+export declare class EquipmentCost {
+    cw: any;
+    constructor(cw: any);
+    addInspectionCosts(inspectionId: number, options?: EquipmentCostOptions): Promise<unknown>;
+    addRequestCosts(requestId: number, options?: EquipmentCostOptions): Promise<unknown>;
+    addWorkOrderCosts(workOrderSid: number, options?: EquipmentCostOptions & {
+        WorkOrderId?: string;
+        TaskIds?: Array<number>;
+        Entities?: Array<any>;
+    }): Promise<unknown>;
+    deleteInspectionCosts(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    deleteRequestCosts(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    deleteWorkOrderCosts(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    inspectionCostsByInspection(inspectionIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    requestCostsByRequest(requestIds: Array<number>, estimated?: boolean): Promise<unknown>;
+    workOrderCostsByWorkOrder(workOrderIds?: Array<string>, workOrderSids?: Array<number>, estimated?: boolean): Promise<unknown>;
+}

package/dist/equipment_reservation.d.ts

@@ -0,0 +1,25 @@
+export interface EquipmentReservationOptions {
+    WorkOrderId?: string;
+    WorkOrderSid?: number;
+    Comments?: string;
+}
+export declare class EquipmentReservation {
+    cw: any;
+    constructor(cw: any);
+    checkedOut(): Promise<unknown>;
+    checkIn(equipmentSid: number, employeeSid: number, options?: EquipmentReservationOptions): Promise<unknown>;
+    checkOut(equipmentSid: number, employeeSid: number, reservedToDate: Date, options?: EquipmentReservationOptions): Promise<unknown>;
+    checkOutHistory(equipmentSid?: number, employeeSid?: number): Promise<unknown>;
+    deleteReservation(transactionIds: Array<number>): Promise<unknown>;
+    reservations(equipmentSid: number, startDateTime?: Date, endDateTime?: Date): Promise<unknown>;
+    reserve(equipmentSid: number, employeeSid: number, transDateTime: Date, reservedToDate: Date, options?: EquipmentReservationOptions): Promise<unknown>;
+    status(equipmentSids: Array<number>): Promise<unknown>;
+    updateReservation(transactionId: number, updates: {
+        EmployeeSid?: number;
+        TransDateTime?: Date;
+        ReservedToDate?: Date;
+        WorkOrderId?: string;
+        WorkOrderSid?: number;
+        Comments?: string;
+    }): Promise<unknown>;
+}

package/dist/general_admin.d.ts

@@ -0,0 +1,42 @@
+export interface CwHoliday {
+    Holiday: Date | string;
+    Description?: string;
+}
+export interface EurlQueryFindReplaceOptions {
+    QueryDefinitionIds?: Array<number>;
+    DomainIds?: Array<number>;
+    IsPublic?: boolean;
+    QueryIds?: Array<number>;
+    CreatedBySids?: Array<number>;
+    Configuration?: string;
+}
+export declare class GeneralAdmin {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Add a new holiday.
+     */
+    addHoliday(holiday: Date | string, description: string): Promise<unknown>;
+    /**
+     * Get all defined holidays with optional date filtering.
+     */
+    getHolidays(startDate?: Date | string, endDate?: Date | string): Promise<unknown>;
+    /**
+     * Get a holiday definition by date.
+     */
+    getHolidayByDate(date: Date | string): Promise<unknown>;
+    /**
+     * Delete holidays by date.
+     */
+    deleteHolidays(holidays: Array<Date | string>): Promise<unknown>;
+    /**
+     * Update text in Eurl Query Definition Configuration.
+     */
+    findReplaceConfigurationText(oldText: string, newText: string, options?: EurlQueryFindReplaceOptions): Promise<unknown>;
+}