@trakit/objects 0.0.15 → 0.0.16

package/objects/Assets/Asset.d.ts

@@ -0,0 +1,218 @@
+import { Contact } from "../Accounts/Contact";
+import { BaseComponent } from "../API/BaseComponent";
+import { BaseCompound } from "../API/BaseCompound";
+import { Position } from "../API/Geography/Position";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIconic } from "../API/Interfaces/IIconic";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { INamed } from "../API/Interfaces/INamed";
+import { IPictured } from "../API/Interfaces/IPictured";
+import { ISuspendable } from "../API/Interfaces/ISuspendable";
+import { JsonObject, codified, colour, double, ulong, ushort } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { Icon } from "../Images/Icon";
+import { Picture } from "../Images/Picture";
+import { Provider } from "../Providers/Provider";
+import { AssetAdvanced } from "./AssetAdvanced";
+import { AssetAttribute } from "./AssetAttribute";
+import { AssetDispatch } from "./AssetDispatch";
+import { AssetGeneral } from "./AssetGeneral";
+import { AssetPlaceStatus } from "./AssetPlaceStatus";
+import { AssetType } from "./AssetType";
+/**
+ * The full details of an Asset, containing all the properties from the {@link AssetGeneral} and {@link AssetAdvanced} objects.
+ */
+export declare class Asset extends BaseCompound implements IIdUlong, INamed, IIconic, IBelongCompany, ILabelled, IPictured, ISuspendable {
+    #private;
+    /**
+     *
+     */
+    get pieces(): BaseComponent[];
+    /**
+     * Unique identifier of this asset.
+     */
+    get id(): ulong;
+    /**
+     * The company to which this asset belongs.
+     * {@link Company.id}
+     */
+    get companyId(): ulong;
+    /**
+     * The {@link Company} to which this asset belongs.
+     */
+    get company(): Company;
+    /**
+     * Type of asset.
+     */
+    get kind(): AssetType;
+    /**
+     *
+     */
+    get general(): AssetGeneral;
+    /**
+     * This thing's name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Notes about it.
+     */
+    get notes(): string;
+    set notes(value: string);
+    /**
+     * The icon that represents this asset on the map and in lists.
+     * {@link Icon.id}
+     */
+    get iconId(): ulong;
+    set iconId(value: ulong);
+    /**
+     * The {@link Icon} that represents this asset on the map and in lists.
+     */
+    get icon(): Icon;
+    set icon(value: Icon);
+    /**
+     * Codified label names.
+     * {@link LabelStyle.code}
+     */
+    get labels(): codified[];
+    set labels(value: codified[]);
+    /**
+     * A list of photos of this thing.
+     * {@link Picture.id}
+     */
+    get pictureIds(): ulong[];
+    set pictureIds(value: ulong[]);
+    /**
+     * A list of {@link Picture}s of this thing.
+     */
+    get pictures(): Picture[];
+    set pictures(value: Picture[]);
+    /**
+     * The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
+     */
+    get messagingAddress(): string;
+    set messagingAddress(value: string);
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    get references(): Map<string, string>;
+    set references(value: Map<string, string>);
+    /**
+     * Contact information for this user.
+     * {@link Contact.id}
+     */
+    get contactId(): ulong;
+    set contactId(value: ulong);
+    /**
+     * {@link Contact} information for this user.
+     */
+    get contact(): Contact;
+    set contact(value: Contact);
+    /**
+     * 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);
+    /**
+     * Manufacturer's unique identification number for this trailer.
+     */
+    get serial(): string;
+    set serial(value: string);
+    /**
+     *
+     */
+    get advanced(): AssetAdvanced;
+    /**
+     * The things GPS coordinates including speed, bearing, and street information.
+     */
+    get position(): Position | null;
+    set position(value: Position | null);
+    /**
+     * The cumulative distance travelled in kilometres.
+     */
+    get odometer(): double;
+    set odometer(value: double);
+    /**
+     * The codified status tag names.
+     */
+    get tags(): codified[];
+    set tags(value: codified[]);
+    /**
+     * A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
+     */
+    get attributes(): Map<codified, AssetAttribute>;
+    set attributes(value: Map<codified, AssetAttribute>);
+    /**
+     * The list of devices providing events for this asset.
+     */
+    get providerIds(): string[];
+    /**
+     * The list of devices providing events for this asset.
+     */
+    get providers(): Provider[];
+    /**
+     * A list of assets related to this one; like a Person for a Vehicle (driver).
+     * {@link Asset.id}
+     */
+    get relationshipIds(): ulong[];
+    set relationshipIds(value: ulong[]);
+    /**
+     * A list of {@link Asset}s related to this one; like a Person for a Vehicle (driver).
+     */
+    get relationships(): Asset[];
+    set relationships(value: Asset[]);
+    /**
+     * The current state of this asset's interaction with known Places.
+     * {@link Place.id}
+     */
+    get places(): Map<ulong, AssetPlaceStatus>;
+    set places(value: Map<ulong, AssetPlaceStatus>);
+    /**
+     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
+     */
+    get engineHours(): double;
+    set engineHours(value: double);
+    /**
+     *
+     */
+    get dispatch(): AssetDispatch;
+    toJSON(): JsonObject;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    /**
+     * Indicates whether this object is suspended from event processing.
+     */
+    get suspended(): boolean;
+    /**
+     * Timestamp from the action that deleted or suspended this object.
+     */
+    get since(): Date;
+}

package/objects/Assets/AssetAdvanced.d.ts

@@ -0,0 +1,77 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { Position } from "../API/Geography/Position";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, codified, double, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { Provider } from "../Providers/Provider";
+import { Asset } from "./Asset";
+import { AssetAttribute } from "./AssetAttribute";
+import { AssetPlaceStatus } from "./AssetPlaceStatus";
+/**
+ * Often changing details about a thing.
+ */
+export declare class AssetAdvanced extends BaseComponent implements IIdUlong, IBelongCompany {
+    /**
+     * Unique identifier of this asset.
+     * {@link Asset.id}
+     */
+    id: ulong;
+    /**
+     * The company to which this asset belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this asset belongs.
+     */
+    get company(): Company;
+    /**
+     * The things GPS coordinates including speed, bearing, and street information.
+     */
+    position: Position | null;
+    /**
+     * The cumulative distance travelled in kilometres.
+     */
+    odometer: double;
+    /**
+     * The codified status tag names.
+     */
+    tags: codified[];
+    /**
+     * A list of attributes given to this asset by the connection device such as wiring state, VBus, etc.
+     */
+    attributes: Map<codified, AssetAttribute>;
+    /**
+     * The list of {@link Provider.id|device identifiers} providing events for this asset.
+     */
+    providerIds: string[];
+    /**
+     * The list of {@link Provider|devices} providing events for this asset.
+     */
+    get providers(): Provider[];
+    set providers(value: Provider[]);
+    /**
+     * A list of {@link Asset.id}s related to this one; like a {@link Person} for a {@link Vehicle} (driver).
+     */
+    relationshipIds: ulong[];
+    /**
+     * A list of {@link Asset}s related to this one; like a {@link Person} for a {@link Vehicle} (driver).
+     */
+    get relationships(): Asset[];
+    set relationships(value: Asset[]);
+    /**
+     * The current state of this asset's interaction with known {@link Place}s.
+     */
+    places: Map<ulong, AssetPlaceStatus>;
+    /**
+     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
+     */
+    engineHours: double;
+    toJSON(): JsonObject;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Assets/AssetAttribute.d.ts

@@ -0,0 +1,71 @@
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, ulong, JsonObject } from "../API/Types";
+import { Provider } from "../Providers/Provider";
+import { Asset } from "./Asset";
+/**
+ * An attribute given to an asset by a behaviour script.
+ */
+export declare class AssetAttribute implements ISerializable, IBelongAsset {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): AssetAttribute;
+    /**
+     * Display name of the attribute.
+     */
+    name: string;
+    /**
+     * Computed/contextual value from the behaviour.  Like "3.76 volts" or "on".
+     */
+    simple: string;
+    /**
+     * Parse-able/formatted string for complex display.  May contain HTML.
+     */
+    complex: string;
+    /**
+     * Raw value like 3.76 (volts) or true (on).
+     */
+    raw: any;
+    /**
+     * Text representation of unit like "°C" or "Km".
+     * {@link Units}
+     */
+    unit: string;
+    /**
+     * The {@link Provider.id|device id} which provided this attribute.
+     */
+    providerId: string;
+    /**
+     * The {@link Provider|device} which provided this attribute.
+     */
+    get provider(): Provider;
+    /**
+     * The related {@link Asset.id} which provided this attribute.
+     */
+    assetId: ulong;
+    /**
+     * The related {@link Asset} which provided this attribute.
+     */
+    get asset(): Asset;
+    /**
+     * Date/time stamp from when this attribute was recorded (or reported) by the device.
+     */
+    dts: Date;
+    /**
+     * When false, indicates that this attribute is used by an internal system and should be left untouched.
+     */
+    global: boolean;
+    constructor(name?: string, simple?: string, complex?: string, raw?: any, unit?: string, provider?: string, asset?: ulong, dts?: Date | number | datetime, global?: boolean);
+    toJSON(): {
+        name: string;
+        simple: string;
+        complex: string;
+        raw: any;
+        provider: string;
+        asset: number | null;
+        dts: string | null;
+        global: boolean;
+    };
+}

package/objects/Assets/AssetDispatch.d.ts

@@ -0,0 +1,55 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { DispatchDirection } from "../Dispatch/DispatchDirection";
+import { DispatchJob } from "../Dispatch/DispatchJob";
+/**
+ * The current state of an asset's {@link DispatchJob} route progress.
+ */
+export declare class AssetDispatch extends BaseComponent implements IIdUlong, IBelongCompany {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): AssetDispatch;
+    /**
+     * Unique identifier of this asset.
+     * {@link Asset.id}
+     */
+    id: ulong;
+    /**
+     * The company to which this asset belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this asset belongs.
+     */
+    get company(): Company;
+    /**
+     * The current list of {@link DispatchJob}s assigned to the asset.
+     * {@link DispatchJob}
+     */
+    jobIds: ulong[];
+    /**
+     * A list of {@link Asset}s related to this one; like a {@link Person} for a {@link Vehicle} (driver).
+     */
+    get jobs(): DispatchJob[];
+    set jobs(value: DispatchJob[]);
+    /**
+     * Driving directions and route path details.
+     */
+    directions: DispatchDirection[];
+    /**
+     * Timestamp from the last update to this {@link AssetDispatch} by a {@link User}, {@link Machine}, {@link Asset}, or an assigned {@link DispatchJob}.
+     */
+    lastDispatched: Date;
+    toJSON(): JsonObject;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Assets/AssetGeneral.d.ts

@@ -0,0 +1,127 @@
+import { Contact } from "../Accounts/Contact";
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIconic } from "../API/Interfaces/IIconic";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { INamed } from "../API/Interfaces/INamed";
+import { IPictured } from "../API/Interfaces/IPictured";
+import { ISuspendable } from "../API/Interfaces/ISuspendable";
+import { JsonObject, codified, colour, ulong, ushort } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { Icon } from "../Images/Icon";
+import { Picture } from "../Images/Picture";
+import { AssetType } from "./AssetType";
+/**
+ * Seldom changing details about a thing.
+ */
+export declare class AssetGeneral extends BaseComponent implements IIdUlong, INamed, IIconic, IBelongCompany, ILabelled, IPictured, ISuspendable {
+    /**
+     * Unique identifier of this asset.
+     * {@link Asset.id}
+     */
+    id: ulong;
+    /**
+     * The company to which this asset belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this asset belongs.
+     */
+    get company(): Company;
+    /**
+     * Type of asset.
+     */
+    kind: AssetType;
+    /**
+     * This thing's name.
+     */
+    name: string;
+    /**
+     * The {@link Icon.id} that represents this asset on the map and in lists.
+     */
+    iconId: ulong;
+    /**
+     * The {@link Icon} that represents this asset on the map and in lists.
+     */
+    get icon(): Icon;
+    set icon(value: Icon);
+    /**
+     * Notes about it.
+     */
+    notes: string;
+    /**
+     * Codified label names.
+     */
+    labels: codified[];
+    /**
+     * {@link Picture.id}s of this asset.
+     */
+    pictureIds: ulong[];
+    /**
+     * {@link Picture}s of this asset.
+     */
+    get pictures(): Picture[];
+    set pictures(values: Picture[]);
+    /**
+     * The fall-back address which is used to send Messages if the asset is a Person and has no Contact phone or email.
+     */
+    messagingAddress: string;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    /**
+     * A reference to their Company's Contact information.
+     * {@link Contact.id}
+     */
+    contactId: ulong;
+    /**
+     * {@link Contact} information for this person.
+     */
+    get contact(): Contact;
+    set contact(value: Contact);
+    /**
+     * 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;
+    /**
+     * Manufacturer's unique identification number for this trailer.
+     */
+    serial: string;
+    toJSON(): JsonObject;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    /**
+     * Indicates whether this object is suspended from event processing.
+     */
+    suspended: boolean;
+    /**
+     * Timestamp from the action that deleted or suspended this object.
+     */
+    since: Date;
+}

package/objects/Assets/AssetPlaceStatus.d.ts

@@ -0,0 +1,31 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, JsonObject } from "../API/Types";
+import { AssetPlaceStatusType } from "./AssetPlaceStatusType";
+/**
+ * A simple status for each place an Asset visits.
+ */
+export declare class AssetPlaceStatus implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): AssetPlaceStatus;
+    /**
+     * The kind of interaction.
+     */
+    kind: AssetPlaceStatusType;
+    /**
+     * The date/time stamp for when the Asset first began interacting with the Place.
+     */
+    enter: Date;
+    /**
+     * The most recent date/time stamp for the interaction.
+     */
+    latest: Date;
+    constructor(kind?: AssetPlaceStatusType, enter?: Date | number | datetime, latest?: Date | number | datetime);
+    toJSON(): {
+        kind: AssetPlaceStatusType;
+        enter: string | null;
+        latest: string | null;
+    };
+}

package/objects/Assets/AssetPlaceStatusType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The kinds of interactions had with a Place.
+ */
+export declare enum AssetPlaceStatusType {
+    /**
+     * Occurs when an asset is outside a Place, then goes inside the boundary.
+     */
+    enter = "enter",
+    /**
+     * Occurs when the asset was inside the boundary before, and is still inside the boundary now.
+     */
+    inside = "inside",
+    /**
+     * Occurs when an asset was inside the boundary of a Place, but then moves outside the boundary.
+     */
+    exit = "exit"
+}

package/objects/Assets/AssetType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The four supported types of trackable things.
+ */
+export declare enum AssetType {
+    /**
+     * Generic thing.
+     */
+    asset = "asset",
+    /**
+     * Human (or alien) Person.
+     */
+    person = "person",
+    /**
+     * A towed vehicle without an engine.
+     */
+    trailer = "trailer",
+    /**
+     * A vehicle that moves with its own power.
+     */
+    vehicle = "vehicle"
+}

package/objects/Behaviours/Behaviour.d.ts

@@ -0,0 +1,78 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { SearchPattern } from "../API/SearchPattern";
+import { JsonObject, byte, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { BehaviourParameter } from "./BehaviourParameter";
+import { BehaviourScript } from "./BehaviourScript";
+/**
+ * The applied behaviour which includes all parameters and targets specific assets.
+*/
+export declare class Behaviour extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier of this behaviour.
+     */
+    id: ulong;
+    /**
+     * The company to which this behaviour belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this behaviour belongs.
+     */
+    get company(): Company;
+    /**
+     * The script which this behaviour implements.
+     * {@link BehaviourScript.id}
+     */
+    scriptId: ulong;
+    /**
+     * The script which this behaviour implements.
+     * {@link BehaviourScript.id}
+     */
+    get script(): BehaviourScript;
+    /**
+     * The name of this behaviour.
+     */
+    name: string;
+    /**
+     * Notes.
+     */
+    notes: string;
+    /**
+     * The priority flag allows you to define an execution order for all behaviours for a provider.
+     */
+    priority: byte;
+    /**
+     * The search pattern used to target the assets which will embed this behaviour in their execution context.
+     */
+    targets: SearchPattern[] | null;
+    /**
+     * A search pattern used to filter the providers which can implement this behaviour.
+     */
+    filters: SearchPattern[] | null;
+    /**
+     * The list of defined variable name/value pairs for the script requires.
+     */
+    parameters: Map<string, BehaviourParameter>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number | null;
+        script: number | null;
+        name: string;
+        notes: string;
+        targets: string | null;
+        filters: string | null;
+        priority: number;
+        parameters: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}