@trakit/objects 0.0.1

package/Providers/ProviderCommandStatus.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Progress lifetime of command for the device/modem.
+ */
+export declare enum ProviderCommandStatus {
+    /**
+     * The new command has been created, but not yet sent to the provider.
+     */
+    created = "created",
+    /**
+     * Command was processed and sent to the provider.
+     */
+    pending = "pending",
+    /**
+     * Provider is taking some action related to this command. eg. Checking in for config update or getting tasks list.
+     */
+    inProgress = "inProgress",
+    /**
+     * Command was successfully processed by the provider.
+     */
+    completed = "completed",
+    /**
+     * Something went wrong while trying to send or process the command.
+     */
+    failed = "failed",
+    /**
+     * Sending of the new command was halted by a user.
+     */
+    cancelled = "cancelled"
+}

package/Providers/ProviderCommandType.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The kind of command for the device/modem.
+ */
+export declare enum ProviderCommandType {
+    /**
+     * If the type of command has not yet been determined, or there was an error determining its type.
+     */
+    unknown = "unknown",
+    /**
+     * Configuration
+     */
+    config = "config",
+    /**
+     * Geofence
+     */
+    geofence = "geofence",
+    /**
+     * Dispatch Job
+     */
+    dispatch = "dispatch",
+    /**
+     * GPS report
+     */
+    gps = "gps",
+    /**
+     * Status report
+     */
+    status = "status",
+    /**
+     * Control output wire
+     */
+    output = "output",
+    /**
+     * Custom (modem specific) message
+     */
+    custom = "custom"
+}

package/Providers/ProviderControl.d.ts

@@ -0,0 +1,42 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { ProviderCommand } from "./ProviderCommand";
+import { ProviderCommandType } from "./ProviderCommandType";
+/**
+ * Managing communication with Device/hardware.
+ */
+export declare class ProviderControl extends BaseComponent implements IBelongCompany {
+    /**
+     * Unique identifier of this device.
+     * {@link Provider.id}
+     */
+    id: string;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * Collection of commands for this provider.
+     */
+    commands: Map<ProviderCommandType, ProviderCommand>;
+    toJSON(): {
+        id: string | null;
+        v: number[];
+        company: number | null;
+        commands: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Providers/ProviderData.d.ts

@@ -0,0 +1,30 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime } from "../API/Types";
+/**
+ * A fragment of data given by a device.
+ */
+export declare class ProviderData implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): ProviderData;
+    /**
+     * The value of the data given like true, 17.3, "asdf", etc...
+     */
+    value: any;
+    /**
+     * Date/time stamp from when the device recorded (or reported) the data.
+     */
+    dts: Date;
+    /**
+     * The relevant unit for the data provided like Km/h, degrees, volts, RPM, etc...
+     */
+    unit: string;
+    constructor(value?: any, dts?: Date | number | datetime, unit?: string);
+    toJSON(): {
+        value: any;
+        dts: string | null;
+        unit: string;
+    };
+}

package/Providers/ProviderGeneral.d.ts

@@ -0,0 +1,117 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { INamed } from "../API/Interfaces/INamed";
+import { ISuspendable } from "../API/Interfaces/ISuspendable";
+import { phone, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { ProviderConfig } from "./Config/ProviderConfig";
+import { ProviderConfiguration } from "./Configuration/ProviderConfiguration";
+import { ProviderType } from "./ProviderType";
+/**
+ * Device/hardware information and configuration.
+ */
+export declare class ProviderGeneral extends BaseComponent implements INamed, IBelongCompany, ISuspendable {
+    /**
+     * Unique identifier of this device.
+     * {@link Provider.id}
+     */
+    id: string;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * A nickname given to the device/hardware.
+     */
+    name: string;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The kind of communication protocol this device uses.
+     */
+    kind: ProviderType;
+    /**
+     * The asset for which this device provides field data.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The asset for which this device provides field data.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * The provider's current (or pending) configuration profile.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    configurationId: ulong;
+    /**
+     * The provider's current (or pending) configuration profile.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    get configuration(): ProviderConfig | ProviderConfiguration;
+    set configuration(value: ProviderConfig | ProviderConfiguration);
+    /**
+     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
+     */
+    password: string;
+    /**
+     * The firmware/application version number.
+     */
+    firmware: string;
+    /**
+     * The phone number of this device.
+     */
+    phoneNumber: phone;
+    /**
+     * A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
+     */
+    information: Map<string, string>;
+    /**
+     * ICCID of the SIM card installed in this provider
+     */
+    sim: string;
+    toJSON(): {
+        asset?: number | null | undefined;
+        password?: string | undefined;
+        firmware?: string | undefined;
+        phoneNumber?: number | null | undefined;
+        information?: object | undefined;
+        sim?: string | undefined;
+        suspended?: boolean | undefined;
+        since?: string | null | undefined;
+        id: string | null;
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
+        v: number[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+    /**
+     * Indicates whether this object is suspended from event processing.
+     */
+    suspended: boolean;
+    /**
+     * Timestamp from the action that deleted or suspended this object.
+     */
+    since: Date;
+}

package/Providers/ProviderType.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Protocols supported by the system.
+ */
+export declare enum ProviderType {
+    /**
+     * Your guess is as good as mine.
+     * It should never be this.
+     */
+    unknown = "unknown",
+    /**
+     * Sierra Wireless AirLink RAP protocol
+     * @deprecated No longer supported
+     */
+    airlink = "airlink",
+    /**
+     * Sixnet BlueTree BEP protocol
+     * @deprecated No longer supported
+     */
+    bluetree = "bluetree",
+    /**
+     * Gen-X modem protocol
+     */
+    genx = "genx",
+    /**
+     * CalAmp LMU series protocol
+     * @deprecated Use calamp instead
+     */
+    lmu = "lmu",
+    /**
+     * CalAmp TTU series protocol
+     * @deprecated Use calamp instead
+     */
+    ttu = "ttu",
+    /**
+     * Novotel Enfora SpiderAT protocol
+     * @deprecated Use enfora instead
+     */
+    spiderAT = "spiderAT",
+    /**
+     * Novotel Enfora SpiderMT protocol
+     * @deprecated Use enfora instead
+     */
+    spiderMT = "spiderMT",
+    /**
+     * Trak iT Wireless Mobile App
+     */
+    mobile = "mobile",
+    /**
+     * TachWest DataTrans protocol
+     */
+    datatrans = "datatrans",
+    /**
+     * Xirgo modem protocol
+     * @deprecated No longer supported
+     */
+    xirgo = "xirgo",
+    /**
+     * Bell Mobility LBS
+     */
+    lbs = "lbs",
+    /**
+     * Certified Tracking protocol
+     * @deprecated No longer supported
+     */
+    titan = "titan",
+    /**
+     * Concox Tracker protocol
+     * @deprecated No longer supported
+     */
+    concox = "concox",
+    /**
+     * Aspenta Open API format
+     * @deprecated No longer supported
+     */
+    aspenta = "aspenta",
+    /**
+     * Fleet Freedom JSON protocol
+     * @deprecated No longer supported
+     */
+    json = "json",
+    /**
+     * SmartWitness dashcam formats
+     */
+    smartwitness = "smartwitness",
+    /**
+     * CalAmp LMU/TTU modem protocols
+     */
+    calamp = "calamp",
+    /**
+     * Enfora (Novotel) modem protocols
+     * @deprecated No longer supported
+     */
+    enfora = "enfora",
+    /**
+     * BeWhere beacon protocols
+     */
+    bewhere = "bewhere",
+    /**
+     * ATrack device protocols
+     */
+    atrack = "atrack",
+    /**
+     * Teltonika device protocols
+     */
+    teltonika = "teltonika"
+}

package/README.md

@@ -0,0 +1,13 @@
+# Trak-iT API Object Model
+
+All of the Trak-iT APIs use the same object definitions.
+Other Trak-iT API libraries are available on [GitHub](https://github.com/trakitwireless) and [npm](https://www.npmjs.com/org/trakit).
+
+### Prerequisites
+
+We do not require any other packages, however, we are targetting `ESNext`, so if your project uses CommonJS or another module manager, you will need to account for that yourself.
+
+## Questions and Feedback
+
+If you have any questions, please start for the project on GitHub
+https://github.com/trakitwireless/trakit-ts-objects/issues

package/Reports/ReportBreakdown.d.ts

@@ -0,0 +1,72 @@
+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

@@ -0,0 +1,62 @@
+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

@@ -0,0 +1,65 @@
+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;
+    };
+}

package/Reports/ReportBreakdownTask.d.ts

@@ -0,0 +1,71 @@
+import { uint, ulong } from "../API/Types";
+import { AssetAdvanced } from "../Assets/AssetAdvanced";
+import { AssetGeneral } from "../Assets/AssetGeneral";
+import { DispatchTask } from "../Dispatch/DispatchTask";
+import { ReportBreakdown } from "./ReportBreakdown";
+/**
+ * Dispatch Task information used in this report.
+ */
+export declare class ReportBreakdownTask extends ReportBreakdown {
+    /**
+     * The Task used.
+     */
+    task: DispatchTask;
+    constructor(task: DispatchTask, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
+    toJSON(): {
+        task: {
+            id: number | null;
+            company: number | null;
+            asset: number | null;
+            v: number[];
+            name: string;
+            references: object;
+            place: number | null;
+            address: string;
+            latlng: import("../API/Geography/Interfaces").ILatLng;
+            status: import("../Dispatch/DispatchTaskStatus").DispatchTaskStatus;
+            created: string | null;
+            eta: string | null;
+            duration: string;
+            arrived: string | null;
+            completed: string | null;
+            instructions: string;
+            signature: boolean;
+            signatory: string;
+            notes: string;
+            attachments: number[];
+            updatedBy: string;
+            updatedUtc: string | null;
+        };
+        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;
+    };
+}