@trakit/objects 0.0.1

package/Messaging/AssetAlert.d.ts

@@ -0,0 +1,28 @@
+import { AlertPriority } from './AlertPriority';
+import { MessageBase } from './MessageBase';
+/**
+ * An automatically generated notification sent to a user by the system.
+ */
+export declare class AssetAlert extends MessageBase {
+    /**
+     * The priority for which this message must send.
+     */
+    priority: AlertPriority;
+    toJSON(): {
+        priority: AlertPriority;
+        id: number | null;
+        v: number[];
+        company: number;
+        status: import("./MessageStatus").MessageStatus;
+        kind: import("./MessageType").MessageType;
+        to: string;
+        from: string;
+        body: string;
+        processed: string | null;
+        delivered: string | null;
+        subject: string;
+        asset: number;
+        user: string;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Messaging/AssetMessage.d.ts

@@ -0,0 +1,40 @@
+import { email } from '../API/Types';
+import { MessageBase } from './MessageBase';
+import { MessageFolder } from './MessageFolder';
+/**
+ * A conversational message between users and assets.
+ */
+export declare class AssetMessage extends MessageBase {
+    /**
+     * The folder under which this message is stored.
+     */
+    folder: MessageFolder;
+    /**
+     * Indicates that this is a received message instead of a sent message.
+     */
+    incoming: boolean;
+    /**
+     * The user that read this message.  This field is blank/null when unread.
+     * {@link User.login}
+     */
+    readBy: email;
+    toJSON(): {
+        folder: MessageFolder;
+        incoming: boolean;
+        readBy: string;
+        id: number | null;
+        v: number[];
+        company: number;
+        status: import("./MessageStatus").MessageStatus;
+        kind: import("./MessageType").MessageType;
+        to: string;
+        from: string;
+        body: string;
+        processed: string | null;
+        delivered: string | null;
+        subject: string;
+        asset: number;
+        user: string;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Messaging/MessageBase.d.ts

@@ -0,0 +1,101 @@
+import { User } from "../Accounts/User";
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { email, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { MessageStatus } from './MessageStatus';
+import { MessageType } from './MessageType';
+/**
+ * A base class for Alerts and Messages.
+ */
+export declare abstract class MessageBase extends BaseComponent implements IIdUlong, IBelongCompany, IBelongAsset {
+    /**
+     * Unique identifier of this memo.
+     */
+    id: ulong;
+    /**
+     * The company to which this memo belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this memo belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * Lifetime status
+     */
+    status: MessageStatus;
+    /**
+     * Protocol type
+     */
+    kind: MessageType;
+    /**
+     * Recipient address.
+     */
+    to: email;
+    /**
+     * Sender address.
+     */
+    from: email;
+    /**
+     * The main contents of the memo.
+     */
+    body: string;
+    /**
+     * Date/time stamp of when the memo was processed.
+     */
+    processed: Date;
+    /**
+     * Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
+     */
+    delivered: Date;
+    /**
+     * The subject of this message.
+     */
+    subject: string;
+    /**
+     * The asset to which this message relates.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The asset to which this message relates.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    /**
+     * The user who sent/received this message.
+     * {@link User.login}
+     */
+    userLogin: email;
+    /**
+     * The user who sent/received this message.
+     * {@link User.login}
+     */
+    get user(): User;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        status: MessageStatus;
+        kind: MessageType;
+        to: string;
+        from: string;
+        body: string;
+        processed: string | null;
+        delivered: string | null;
+        subject: string;
+        asset: number;
+        user: string;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Messaging/MessageFolder.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The name of folder where the message is stored.
+ */
+export declare enum MessageFolder {
+    /**
+     * The inbox is loaded quickly from memory, but messages regularly move to the archive.
+     */
+    inbox = "inbox",
+    /**
+     * The archive contains all previous messages, but must be queried from disk for retrieval.
+     */
+    archive = "archive"
+}

package/Messaging/MessageStatus.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Memos have a lifetime and each status represents a memos's progress through it's life.
+ */
+export declare enum MessageStatus {
+    /**
+     * Waiting to be sent.
+     */
+    created = "created",
+    /**
+     * Sent or received.
+     */
+    processed = "processed",
+    /**
+     * Failed to send.
+     */
+    failed = "failed",
+    /**
+     * Failed to send because too many memos were sent.
+     */
+    throttled = "throttled",
+    /**
+     * Memo sent, but returned with error from receiving server.
+     */
+    bounceback = "bounceback",
+    /**
+     * Memo has been responded to or acknowledged by the recipient.
+     */
+    acknowledged = "acknowledged"
+}

package/Messaging/MessageType.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The kind of protocol used for this memo.
+ */
+export declare enum MessageType {
+    /**
+     * If the type of memo has not yet been determined, or there was an error determining its type.
+     */
+    unknown = "unknown",
+    /**
+     * Short Message Service (text message)
+     */
+    sms = "sms",
+    /**
+     * Email
+     */
+    email = "email",
+    /**
+     * Garmin/Magellan/etc (Personal Navigation Device)
+     */
+    pnd = "pnd",
+    /**
+     * Google Cloud Message
+     */
+    gcm = "gcm",
+    /**
+     * Apple Push Notification Service
+     */
+    apn = "apn",
+    /**
+     * WebSocket alert message
+     */
+    socket = "socket"
+}

package/Places/Place.d.ts

@@ -0,0 +1,116 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { LatLng } from "../API/Geography/LatLng";
+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 { codified, colour, double, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { Icon } from "../Images/Icon";
+import { Picture } from "../Images/Picture";
+import { PlaceType } from "./PlaceType";
+/**
+ * A POI (point-of-interest) saved to the system to help determine an asset's real-world position.
+ */
+export declare class Place extends BaseComponent implements IIdUlong, INamed, IIconic, IBelongCompany, ILabelled, IPictured {
+    /**
+     * Unique identifier of this POI.
+     */
+    id: ulong;
+    /**
+     * The company to which this POI belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this POI belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The kind of geography represented by this POI.
+     */
+    kind: PlaceType;
+    /**
+     * POI's common name instead of street address.
+     */
+    name: string;
+    /**
+     * Full street address including province/state, country, and postal/zip code.
+     */
+    address: string;
+    /**
+     * The icon used to display this POI in lists and on the map.
+     * {@link Icon.id}
+     */
+    iconId: ulong;
+    /**
+     * The icon used to display this POI in lists and on the map.
+     * {@link Icon.id}
+     */
+    get icon(): Icon;
+    set icon(value: Icon);
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The codified names of labels
+     */
+    labels: codified[];
+    /**
+     * The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB)
+     */
+    colour: colour;
+    /**
+     * {@link Picture.id}s of this POI.
+     */
+    pictureIds: ulong[];
+    /**
+     * {@link Picture}s of this POI.
+     */
+    get pictures(): Picture[];
+    set pictures(values: Picture[]);
+    /**
+     * A custom field used to refer to an external system.
+     */
+    reference: string;
+    /**
+     * A central point of the shape.
+     * This is the exact centre of a {@link PlaceType.radial} and {@link PlaceType.point} shaped places, and the location of the pin on the map for all types.
+     * When routing, {@link PlaceType.polygon} and {@link PlaceType.rectangle} shapes use the anchor as the location within the place for deliveries.
+     */
+    anchor: LatLng | null;
+    /**
+     * This member is only present for {@link PlaceType.radial} shapes, and is the radius in meters from the centre anchor.
+     */
+    radius: double;
+    /**
+     * A list of points forming a non-self-intersecting polygon.
+     */
+    points: LatLng[] | null;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        icon: number;
+        name: string;
+        notes: string;
+        address: string;
+        kind: PlaceType;
+        labels: string[];
+        colour: string;
+        pictures: number[];
+        reference: string;
+        anchor: import("../API/Geography/Interfaces").ILatLng | null;
+        radius: number | null;
+        shape: any[] | null;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Places/PlaceType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The types of geography the system supports
+ */
+export declare enum PlaceType {
+    /**
+     * A lat/long coordinate pair.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} or {@link Vorgon.PlaceGeneral.shape} keys.
+     */
+    point = "point",
+    /**
+     * Defined as a radius around a lat/long pair used to create a circular boundary.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.shape} key.
+     */
+    radial = "radial",
+    /**
+     * The {@link Vorgon.PlaceGeneral.shape} is an array of lat/long coordinates used to create a boundary.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} key.
+     */
+    polygon = "polygon",
+    /**
+     * The {@link Vorgon.PlaceGeneral.shape} is an array of two lat/long coordinates defined as north-east and south-west corners.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} key.
+     */
+    rectangle = "rectangle"
+}

package/Providers/Config/ProviderConfig.d.ts

@@ -0,0 +1,72 @@
+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 { ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { ProviderScript } from "./ProviderScript";
+/**
+ * The configured script loaded onto the provider over-the-air to control it's reporting schedule and behaviour.
+ */
+export declare class ProviderConfig extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier of this configuration.
+     */
+    id: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The script which this configuration implements.
+     * {@link ProviderScript.id}
+     */
+    scriptId: ulong;
+    /**
+     * The script which this configuration implements.
+     * {@link ProviderScript.id}
+     */
+    get script(): ProviderScript;
+    set script(value: ProviderScript);
+    /**
+     * The nickname given to this configuration
+     */
+    name: string;
+    /**
+     * Simple details about how the providers are expected to behave.
+     */
+    notes: string;
+    /**
+     * The list of defined variable name/value pairs that the script requires.
+     */
+    parameters: Map<string, string>;
+    /**
+     * A search pattern used to filter which Places' geometry are used as geofences.
+     * Use null to disable.
+     * Use "*" to match all the Places the Provider's Asset can match.
+     * Or use "#123456" or "label:term" like other Place search patterns.
+     */
+    geofences: SearchPattern[] | null;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number | null;
+        script: number | null;
+        name: string;
+        notes: string;
+        parameters: object;
+        geofences: string | null;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Providers/Config/ProviderRegistration.d.ts

@@ -0,0 +1,123 @@
+import { Base } from "../../API/Base";
+import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
+import { INamed } from "../../API/Interfaces/INamed";
+import { IRequestable } from "../../API/Interfaces/IRequestable";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { email, phone, ulong } from "../../API/Types";
+import { User } from "../../Accounts/User";
+import { Asset } from "../../Assets/Asset";
+import { Company } from "../../Companies/Company";
+import { ProviderConfiguration } from "../Configuration/ProviderConfiguration";
+import { ProviderType } from "../ProviderType";
+import { ProviderConfig } from "./ProviderConfig";
+/**
+ * The temporary reference to a device whose ownership is pending.
+ */
+export declare class ProviderRegistration extends Base implements IRequestable, INamed, IBelongCompany, IBelongAsset, ISerializable {
+    /**
+     * A unique six digit code.
+     */
+    code: string;
+    /**
+     * The company to which the device will belong.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which the device will belong.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * A nickname given to the device once it has been provisioned.
+     */
+    name: string;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
+     */
+    password: string;
+    /**
+     * The unique identifier the user who generated this registration.
+     * {@link User.login}
+     */
+    userLogin: email;
+    /**
+     * The unique identifier the user who generated this registration.
+     * {@link User.login}
+     */
+    get user(): User;
+    /**
+     * The predefined configuration this device will use.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    configId: ulong;
+    /**
+     * The predefined configuration this device will use.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    get config(): ProviderConfig | ProviderConfiguration;
+    /**
+     * The kind of protocol this device supports.
+     */
+    kind: ProviderType;
+    /**
+     * Date/time stamp of when this registration began.
+     */
+    since: Date;
+    /**
+     * Date/time stamp of when this registration ended successfully.
+     */
+    completed: Date;
+    /**
+     * The expiry date for this registration.
+     */
+    expires: Date;
+    /**
+     * The unique identifier of the device that completed this registration.
+     * {@link Provider.id}
+     */
+    identifier: string;
+    /**
+     * The Asset for which this device will provide data.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The Asset for which this device will provide data.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    /**
+     * The phone number of the device being provisioned.
+     * This is set by the user for long-term registrations, or by the client during serial port setup.
+     */
+    phoneNumber: phone;
+    toJSON(): {
+        code: string | null;
+        company: number | null;
+        name: string;
+        notes: string;
+        password: string;
+        user: string;
+        config: number | null;
+        kind: ProviderType;
+        since: string | null;
+        completed: string | null;
+        expires: string | null;
+        identifier: string;
+        asset: number | null;
+        phoneNumber: number | null;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link code} is the key.
+     */
+    getKey(): string;
+}

package/Providers/Config/ProviderScript.d.ts

@@ -0,0 +1,87 @@
+import { BaseComponent } from "../../API/BaseComponent";
+import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
+import { IGlobal } from "../../API/Interfaces/IGlobal";
+import { IIdUlong } from "../../API/Interfaces/IIdUlong";
+import { INamed } from "../../API/Interfaces/INamed";
+import { IVisual } from "../../API/Interfaces/IVisual";
+import { codified, colour, ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { ProviderType } from "../ProviderType";
+import { ProviderScriptBlock } from "./ProviderScriptBlock";
+import { ProviderScriptParameter } from "./ProviderScriptParameter";
+/**
+ * This class describes a type of logic applied to a provider.
+ * A script will generate a file which is loaded onto a provider in the field.
+ */
+export declare class ProviderScript extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal, IVisual {
+    /**
+     * Unique identifier of this configuration.
+     */
+    id: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The nickname given to this configuration
+     */
+    name: string;
+    /**
+     * Simple details about how the providers are expected to behave.
+     */
+    notes: string;
+    /**
+     * The fill/background colour of the icon.
+     */
+    fill: colour;
+    /**
+     * Outline and graphic colour.
+     */
+    stroke: colour;
+    /**
+     * The name of the symbol for this script.
+     */
+    graphic: codified;
+    /**
+     * Indicates whether this script is available to child companies.
+     */
+    global: boolean;
+    /**
+     * The type of provider for which this script can be used.
+     * Limiting to a specific model from a manufacturer is accomplished through the block conditions.
+     */
+    kind: ProviderType;
+    /**
+     * Blocks of file data which are (optionally) included in the script data file.
+     */
+    blocks: ProviderScriptBlock[];
+    /**
+     * Parameter definitions for this script, including type-hints and default values.
+     */
+    parameters: Map<string, ProviderScriptParameter>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        name: string;
+        notes: string;
+        fill: string;
+        stroke: string;
+        graphic: string;
+        global: boolean;
+        kind: ProviderType;
+        blocks: any[];
+        parameters: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}