@trakit/objects 0.0.1 → 0.0.6

package/Assets/Trailer.d.ts

@@ -1,42 +0,0 @@
-import { ushort } from '../API/Types';
-import { Asset } from './Asset';
-import { TrailerGeneral } from './TrailerGeneral';
-/**
- * The full details of a Trailer, containing all the properties from the {@link TrailerGeneral} and {@link AssetAdvanced} objects.
- */
-export declare class Trailer extends Asset {
-    /**
-     * General details about this vehicle.
-     */
-    get general(): TrailerGeneral;
-    /**
-     * Manufacturer's unique identification number for this trailer.
-     */
-    get serial(): string;
-    set serial(value: string);
-    /**
-     * The license plate.
-     */
-    get plate(): string;
-    set plate(value: string);
-    /**
-     * Manufacturer's name.
-     */
-    get make(): string;
-    set make(value: string);
-    /**
-     * Manufacturer's model name/number.
-     */
-    get model(): string;
-    set model(value: string);
-    /**
-     * Year of manufacturing.
-     */
-    get year(): ushort;
-    set year(value: ushort);
-    /**
-     * Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
-     */
-    get colour(): string;
-    set colour(value: string);
-}

package/Assets/TrailerGeneral.d.ts

@@ -1,47 +0,0 @@
-import { colour, ushort } from "../API/Types";
-import { AssetGeneral } from "./AssetGeneral";
-/**
- * Seldom changing details about a trailer.
- */
-export declare class TrailerGeneral extends AssetGeneral {
-    /**
-     * The license plate.
-     */
-    plate: string;
-    /**
-     * Manufacturer's unique identification number for this trailer.
-     */
-    serial: string;
-    /**
-     * Manufacturer's name.
-     */
-    make: string;
-    /**
-     * Manufacturer's model name/number.
-     */
-    model: string;
-    /**
-     * Year of manufacturing.
-     */
-    year: ushort;
-    /**
-     * Primary colour of the trailer (given in 24bit hex; #RRGGBB)
-     */
-    colour: colour;
-    toJSON(): {
-        suspended?: boolean | undefined;
-        since?: string | null | undefined;
-        references?: object | undefined;
-        messagingAddress?: string | undefined;
-        pictures?: number[] | undefined;
-        id: number | null;
-        v: number[];
-        company: number;
-        kind: import("./AssetType").AssetType;
-        name: string;
-        notes: string;
-        icon: number;
-        labels: string[];
-    };
-    fromJSON(json: any, force?: boolean): boolean;
-}

package/Assets/Vehicle.d.ts

@@ -1,73 +0,0 @@
-import { colour, double, ushort } from "../API/Types";
-import { Asset } from "./Asset";
-import { VehicleGeneral } from "./VehicleGeneral";
-import { VehicleAdvanced } from "./VehicleAdvanced";
-/**
- * The full details of a Vehicle, containing all the properties from the {@link VehicleGeneral} and {@link VehicleAdvanced} objects.
- */
-export declare class Vehicle extends Asset {
-    /**
-     * General details about this vehicle.
-     */
-    get general(): VehicleGeneral;
-    /**
-     * Advanced details about this vehicle.
-     */
-    get advanced(): VehicleAdvanced;
-    /**
-     * The license plate.
-     */
-    get plate(): string;
-    /**
-     * Manufacturer's unique identification number (Vehicle Identification Number).
-     */
-    get vin(): string;
-    set vin(value: string);
-    /**
-     * Manufacturer's name.
-     */
-    get make(): string;
-    set make(value: string);
-    /**
-     * Manufacturer's model name/number.
-     */
-    get model(): string;
-    set model(value: string);
-    /**
-     * Year of manufacturing.
-     */
-    get year(): ushort;
-    set year(value: ushort);
-    /**
-     * Primary colour of the trailer (given in 24bit hex; #RRGGBB)
-     */
-    get colour(): colour;
-    set colour(value: colour);
-    /**
-     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
-     */
-    get engineHours(): double;
-    set engineHours(value: double);
-    toJSON(): {
-        engineHours: number;
-        plate: string;
-        vin: string;
-        make: string;
-        model: string;
-        year: number;
-        colour: string;
-        id: number | null;
-        v: number[];
-        company: number;
-        kind: import("./AssetType").AssetType;
-        name: string;
-        notes: string;
-        icon: number;
-        labels: string[];
-        suspended?: boolean | undefined;
-        since?: string | null | undefined;
-        references?: object | undefined;
-        messagingAddress?: string | undefined;
-        pictures?: number[] | undefined;
-    };
-}

package/Assets/VehicleAdvanced.d.ts

@@ -1,25 +0,0 @@
-import { double } from "../API/Types";
-import { AssetAdvanced } from "./AssetAdvanced";
-/**
- * Often changing details about a vehicle.
- */
-export declare class VehicleAdvanced extends AssetAdvanced {
-    /**
-     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
-     */
-    engineHours: double;
-    toJSON(): {
-        engineHours: number | null;
-        id: number | null;
-        v: number[];
-        company: number;
-        position: import("../API/Geography/Interfaces").IPosition | null;
-        odometer: number;
-        tags: string[];
-        attributes: object;
-        providers: string[];
-        relationships: number[];
-        places: object;
-    };
-    fromJSON(json: any, force?: boolean): boolean;
-}

package/Assets/VehicleGeneral.d.ts

@@ -1,33 +0,0 @@
-import { colour, ushort } from "../API/Types";
-import { AssetGeneral } from "./AssetGeneral";
-/**
- * Seldom changing details about a vehicle.
- */
-export declare class VehicleGeneral extends AssetGeneral {
-    /**
-     * Manufacturer's unique identification number (Vehicle Identification Number).
-     */
-    vin: string;
-    /**
-     * The license plate.
-     */
-    plate: string;
-    /**
-     * Manufacturer's name.
-     */
-    make: string;
-    /**
-     * Manufacturer's model name/number.
-     */
-    model: string;
-    /**
-     * Year of manufacturing.
-     */
-    year: ushort;
-    /**
-     * Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
-     */
-    colour: colour;
-    toJSON(): any;
-    fromJSON(json: any, force?: boolean): boolean;
-}

package/Hosting/Fields/FormFieldTime.d.ts

@@ -1,34 +0,0 @@
-import { TimeSpan } from "../../API/TimeSpan";
-import { timespan, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A control to choose a time or duration longer than 24 hours.
- */
-export declare class FormFieldTime extends FormFieldBase {
-    /**
-     * These are the clock control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The minimum duration or earliest time-of-day.
-     */
-    minimum: TimeSpan | null;
-    /**
-     * The maximum duration or latest time-of-day.
-     */
-    maximum: TimeSpan | null;
-    constructor(id?: ulong, name?: string, kind?: FormFieldType, minimum?: TimeSpan | timespan | number, maximum?: TimeSpan | timespan | number, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
-    toJSON(): {
-        minimum: string | null;
-        maximum: string | null;
-        id: number | null;
-        kind: FormFieldType;
-        name: string;
-        notes: string;
-        required: boolean;
-        value: string | null;
-        editable: boolean;
-    };
-    isValid(value: string): boolean;
-}

package/Reports/ReportBreakdown.d.ts

@@ -1,72 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { uint, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { AssetAdvanced } from "../Assets/AssetAdvanced";
-import { AssetGeneral } from "../Assets/AssetGeneral";
-/**
- * Asset information used in calculating a summary instance.
- */
-export declare class ReportBreakdown implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: any): ReportBreakdown;
-    /**
-     * The asset to which this event data belongs.
-     */
-    assetId: ulong;
-    /**
-     * The asset to which this event data belongs.
-     */
-    get asset(): Asset;
-    /**
-     * Report specific identifier of the event data.
-     */
-    instance: uint;
-    /**
-     * Identifiers of the summary instances that used this event.
-     */
-    summaryInstances: uint[];
-    /**
-     * General Asset information.
-     */
-    general: AssetGeneral | null;
-    /**
-     * Advanced/detailed information used.
-     */
-    advanced: AssetAdvanced | null;
-    constructor(asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
-    toJSON(): {
-        asset: number | null;
-        instance: number | null;
-        summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
-    };
-}

package/Reports/ReportBreakdownJob.d.ts

@@ -1,62 +0,0 @@
-import { uint, ulong } from "../API/Types";
-import { AssetAdvanced } from "../Assets/AssetAdvanced";
-import { AssetGeneral } from "../Assets/AssetGeneral";
-import { DispatchJob } from "../Dispatch/DispatchJob";
-import { ReportBreakdown } from "./ReportBreakdown";
-/**
- * Dispatch Job information used in this report.
- */
-export declare class ReportBreakdownJob extends ReportBreakdown {
-    /**
-     * The Job used.
-     */
-    job: DispatchJob;
-    constructor(job: DispatchJob, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
-    toJSON(): {
-        job: {
-            id: number | null;
-            company: number | null;
-            v: number[];
-            driver: string;
-            created: string | null;
-            name: string;
-            instructions: string;
-            priority: import("../Dispatch/DispatchJobPriority").DispatchJobPriority;
-            references: object;
-            labels: string[];
-            tags: string[];
-            forms: number[];
-            steps: any[];
-        };
-        asset: number | null;
-        instance: number | null;
-        summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
-    };
-}

package/Reports/ReportBreakdownMessage.d.ts

@@ -1,65 +0,0 @@
-import { uint, ulong } from "../API/Types";
-import { AssetAdvanced } from "../Assets/AssetAdvanced";
-import { AssetGeneral } from "../Assets/AssetGeneral";
-import { AssetMessage } from "../Messaging/AssetMessage";
-import { ReportBreakdown } from "./ReportBreakdown";
-/**
- * Message information used in this report.
- */
-export declare class ReportBreakdownMessage extends ReportBreakdown {
-    /**
-     * The Message used.
-     */
-    message: AssetMessage;
-    constructor(message: AssetMessage, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
-    toJSON(): {
-        message: {
-            folder: import("../Messaging/MessageFolder").MessageFolder;
-            incoming: boolean;
-            readBy: string;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Messaging/MessageType").MessageType;
-            status: import("../Messaging/MessageStatus").MessageStatus;
-            to: string;
-            from: string;
-            body: string;
-            processed: string | null;
-            delivered: string | null;
-            subject: string;
-            asset: number;
-            user: string;
-        };
-        asset: number | null;
-        instance: number | null;
-        summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
-    };
-}