@cityssm/faster-unofficial-api/index.d.ts

An unofficial API for the FASTER Web fleet management system relying on Puppeteer scripts, exported reports, and complex parsers.

import { FasterReportExporter, type FasterReportExporterOptions } from '@cityssm/faster-report-exporter';
import { csvReports, xlsxReports } from '@cityssm/faster-report-parser';
export type FasterUnofficialAPIOptions = Omit<FasterReportExporterOptions, 'downloadFolderPath'>;
export declare class FasterUnofficialAPI {
    #private;
    /**
     * Initialize the Faster Unofficial API
     * @param fasterTenantOrBaseUrl - The subdomain of the FASTER Web URL before ".fasterwebcloud.com"
     *                                or the full domain and path including "/FASTER"
     * @param fasterUserName - The username to log in with
     * @param fasterPassword - The password to log in with
     * @param options - Options
     */
    constructor(fasterTenantOrBaseUrl: string, fasterUserName: string, fasterPassword: string, options?: Partial<FasterUnofficialAPIOptions>);
    /**
     * Retrieves a list of assets using the W114 report.
     * @returns A list of assets
     */
    getAssets(): Promise<xlsxReports.W114AssetReportData[]>;
    /**
     * Retrieves a list of inventory items using the W200 report.
     * @returns A list of inventory items, grouped by storeroom
     */
    getInventory(): Promise<xlsxReports.W200StoreroomReportData[]>;
    /**
     * Updates an inventory item, truncating fields where necessary.
     * @see {@link https://github.com/cityssm/node-faster-constants/blob/main/inventory/items.ts|@cityssm/faster-constants - Inventory Item Constants} for truncate lengths.
     * @param itemNumber - The item number of the inventory item to update.
     * @param storeroom - The storeroom of the inventory item to update.
     * @param fieldsToUpdate - The fields to update.
     * @param fieldsToUpdate.itemName - The updated item name.
     * @param fieldsToUpdate.itemDescription - The updated item description.
     * @param fieldsToUpdate.binLocation - The updated bin location.
     * @param fieldsToUpdate.alternateLocation - The updated alternate location.
     * @returns `true` if the inventory item was updated, `false` if not.
     */
    updateInventoryItem(itemNumber: string, storeroom: string, fieldsToUpdate: {
        itemName?: string;
        itemDescription?: string;
        binLocation?: string;
        alternateLocation?: string;
    }): Promise<boolean>;
    /**
     * Retrieves the message log using the W603 report.
     * @param startDate - The start date of the message log to retrieve.
     * @param endDate - The end date of the message log to retrieve. Defaults to `startDate`.
     * @returns The message log.
     */
    getMessageLog(startDate: Date, endDate?: Date): Promise<csvReports.W603ReportRow[]>;
    /**
     * Executes an integration by name.
     * @param integrationName - The name of the integration to execute.
     * @returns `true` if the integration was executed, `false` if not.
     */
    executeIntegration(integrationName: string): Promise<boolean>;
}
export declare const integrationNames: {
    inventoryImportUtility: string;
};
export declare const parser: {
    csvReports: typeof csvReports;
    xlsxReports: typeof xlsxReports;
};
export declare const exporter: {
    FasterReportExporter: typeof FasterReportExporter;
};