@trakit/objects 0.0.1 → 0.0.6

package/{Providers → _publish/objects/Providers}/Provider.d.ts

@@ -3,8 +3,11 @@ import { BaseCompound } from "../API/BaseCompound";
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
 import { INamed } from "../API/Interfaces/INamed";
 import { ISuspendable } from "../API/Interfaces/ISuspendable";
-import { ipv4, phone, ulong } from "../API/Types";
+import { JsonObject, ipv4, 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 { ProviderAdvanced } from "./ProviderAdvanced";
 import { ProviderCommand } from "./ProviderCommand";
 import { ProviderCommandType } from "./ProviderCommandType";
@@ -23,17 +26,14 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
     get pieces(): BaseComponent[];
     /**
      * Unique identifier of this device.
-     * {@link Asset.id}
      */
     get id(): string;
     /**
      * The company to which this device belongs.
-     * {@link Company.id}
      */
     get companyId(): ulong;
     /**
      * The company to which this device belongs.
-     * {@link Company.id}
      */
     get company(): Company;
     set company(value: Company);
@@ -56,15 +56,25 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
      * The asset for which this device provides field data.
      * {@link Asset.id}
      */
-    get asset(): ulong;
-    set asset(value: ulong);
+    get assetId(): ulong;
+    set assetId(value: ulong);
+    /**
+     * The {@link Asset} for which this device provides field data.
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
     /**
      * The provider's current (or pending) configuration profile.
      * {@link ProviderConfig.id}
      * {@link ProviderConfiguration.id}
      */
-    get configuration(): ulong;
-    set configuration(value: ulong);
+    get configurationId(): ulong;
+    set configurationId(value: ulong);
+    /**
+     * The provider's current (or pending) {@link ProviderConfig} (or {@link ProviderConfiguration}).
+     */
+    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.
      */
@@ -113,23 +123,73 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
     get commands(): Map<ProviderCommandType, ProviderCommand>;
     set commands(value: Map<ProviderCommandType, ProviderCommand>);
     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;
+        suspended: boolean;
+        since: string | null;
+        id: string | null;
+        v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
+    } | {
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
         id: string | null;
+        v: number[];
         company: number | null;
+        name: string;
+        notes: string;
         kind: ProviderType;
+        configuration: number | null;
+    } | {
+        control: {
+            id: string | null;
+            v: number[];
+            company: number | null;
+            commands: JsonObject;
+        };
+        v: number[];
+        id: string | null;
+        company: number;
+        lastIP: string;
+        attributes: JsonObject;
+        snf: JsonObject;
+        suspended: boolean;
+        since: string | null;
         name: string;
         notes: string;
+        kind: ProviderType;
         configuration: number | null;
+    } | {
+        control: {
+            id: string | null;
+            v: number[];
+            company: number | null;
+            commands: JsonObject;
+        };
         v: number[];
+        id: string | null;
+        company: number;
+        lastIP: string;
+        attributes: JsonObject;
+        snf: JsonObject;
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */

package/_publish/objects/Providers/ProviderAdvanced.d.ts

@@ -0,0 +1,50 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { JsonObject, ipv4, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { ProviderData } from "./ProviderData";
+/**
+ * Device/hardware information reported from the field.
+ */
+export declare class ProviderAdvanced 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 {@link Company} to which this device belongs.
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * The last IP address of the device.
+     */
+    lastIP: ipv4;
+    /**
+     * Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
+     */
+    attributes: Map<string, Map<string, ProviderData>>;
+    /**
+     * Store-and-forward information like last sequence number of SnF window
+     */
+    snf: Map<string, string>;
+    toJSON(): {
+        id: string | null;
+        v: number[];
+        company: number;
+        lastIP: string;
+        attributes: JsonObject;
+        snf: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/_publish/objects/Providers/ProviderCommand.d.ts

@@ -0,0 +1,36 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, JsonObject } from "../API/Types";
+import { ProviderCommandStatus } from "./ProviderCommandStatus";
+/**
+ * Details regarding a provider command
+ */
+export declare class ProviderCommand implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ProviderCommand;
+    /**
+     * Current status of this command.
+     */
+    status: ProviderCommandStatus;
+    /**
+     * Command message body.
+     */
+    parameters: string[];
+    /**
+     * Date/time stamp of when the command was created.
+     */
+    created: Date;
+    /**
+     * Date/time stamp of when the command was processed.
+     */
+    processed: Date;
+    constructor(status?: ProviderCommandStatus, parameters?: string[], created?: Date | number | datetime, processed?: Date | number | datetime);
+    toJSON(): {
+        status: ProviderCommandStatus;
+        parameters: string[];
+        created: string | null;
+        processed: string | null;
+    };
+}

package/_publish/objects/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/_publish/objects/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/_publish/objects/Providers/ProviderControl.d.ts

@@ -0,0 +1,41 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { JsonObject, 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 {@link Company} to which this device belongs.
+     */
+    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: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/_publish/objects/Providers/ProviderData.d.ts

@@ -0,0 +1,30 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, JsonObject } from "../API/Types";
+/**
+ * A fragment of data given by a device.
+ */
+export declare class ProviderData implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): 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/_publish/objects/Providers/ProviderGeneral.d.ts

@@ -0,0 +1,121 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { INamed } from "../API/Interfaces/INamed";
+import { ISuspendable } from "../API/Interfaces/ISuspendable";
+import { JsonObject, 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 {@link Company} to which this device belongs.
+     */
+    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 {@link Asset} for which this device provides field data.
+     */
+    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) {@link ProviderConfig} (or {@link ProviderConfiguration}).
+     */
+    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(): {
+        suspended: boolean;
+        since: string | null;
+        id: string | null;
+        v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
+    } | {
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
+        id: string | null;
+        v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
+    };
+    fromJSON(json: JsonObject, 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/_publish/objects/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/_publish/objects/Reports/ReportBreakdown.d.ts

@@ -0,0 +1,49 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { JsonObject, nothing, 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 {
+    /**
+     * Instantiates a {@link ReportBreakdown} or one of its subclasses based on the shape of the JSON.
+     * Implementation is in {@link ReportBreakdown_fromJSON.ts}
+     * @param json	The JSON to parse.
+     * @returns		An instance of a {@link ReportBreakdown} or one of its subclasses.
+     */
+    static fromJSON: (json: JsonObject) => 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[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: JsonObject | null;
+        advanced: JsonObject | null;
+    };
+}

package/_publish/objects/Reports/ReportBreakdownJob.d.ts

@@ -0,0 +1,37 @@
+import { nothing, 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[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        job: {
+            id: number | null;
+            company: number | null;
+            v: number[];
+            driver: string;
+            created: string | null;
+            name: string;
+            instructions: string;
+            priority: import("../..").DispatchJobPriority;
+            references: import("../..").JsonObject;
+            labels: string[];
+            tags: string[];
+            forms: number[];
+            steps: any[];
+        };
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: import("../..").JsonObject | null;
+        advanced: import("../..").JsonObject | null;
+    };
+}