@trakit/objects 0.0.6 → 0.0.7

package/_publish/objects/Maintenance/MaintenanceSchedule.d.ts

@@ -1,118 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { IVisual } from "../API/Interfaces/IVisual";
-import { SearchPattern } from "../API/SearchPattern";
-import { TimeSpan } from "../API/TimeSpan";
-import { codified, colour, double, email, JsonObject, uint, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { MaintenanceInterval } from "./MaintenanceInterval";
-/**
- * Recurring service work
- */
-export declare class MaintenanceSchedule extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IVisual {
-    /**
-     * Unique identifier
-     */
-    id: ulong;
-    /**
-     * The company to which this schedule belongs
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this schedule belongs
-     */
-    get company(): Company;
-    /**
-     * The name of the work to be done.  Like "oil change".
-     */
-    name: string;
-    /**
-     * Notes about the work to be done.  Like "change the oil and oil filter".
-     */
-    notes: string;
-    /**
-     * The targeting expression to select which Vehicles and Trailers require this maintenance work.
-     */
-    targets: SearchPattern[] | null;
-    /**
-     * List of Users to send notifications.
-     */
-    notify: email[];
-    /**
-     * The fill/background colour of the icon.
-     */
-    fill: colour;
-    /**
-     * Outline and graphic colour.
-     */
-    stroke: colour;
-    /**
-     * The name of the symbol for this schedule.
-     */
-    graphic: codified;
-    /**
-     * The number of days in advance to predict a job will become pending.
-     */
-    predictionDays: uint;
-    /**
-     * The number of days between service visits.
-     */
-    recurDays: uint;
-    /**
-     * The amount of mileage between service visits.
-     */
-    recurDistance: double;
-    /**
-     * The number of operating hours between service visits.
-     */
-    recurEngineHours: double;
-    /**
-     * The per-asset details calculated by the system to help predict the creation of Maintenance Jobs.
-     */
-    intervals: Map<ulong, MaintenanceInterval>;
-    /**
-     * The name of the garage or service facility where the work is done.
-     */
-    garage: string;
-    /**
-     * The estimated time for the job.
-     */
-    duration: TimeSpan;
-    /**
-     * The estimated cost for the job cost in dollars.
-     */
-    cost: double;
-    /**
-     * A reference code used to track this job.
-     */
-    reference: string;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        notify: string[];
-        targets: string | null;
-        fill: string;
-        stroke: string;
-        graphic: string;
-        garage: string;
-        cost: number;
-        duration: string;
-        reference: string;
-        predictionDays: number;
-        recurDays: number | null;
-        recurDistance: number | null;
-        recurEngineHours: number | null;
-        intervals: JsonObject;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Messaging/AlertPriority.d.ts

@@ -1,17 +0,0 @@
-/**
- * The priority of the alert.
- */
-export declare enum AlertPriority {
-    /**
-     * Sends when no other alerts are pending in the queue.
-     */
-    low = "low",
-    /**
-     * Sends in when there are no high priority alerts in the queue.
-     */
-    normal = "normal",
-    /**
-     * Sends before low and normal priority alerts.
-     */
-    high = "high"
-}

package/_publish/objects/Messaging/AssetAlert.d.ts

@@ -1,29 +0,0 @@
-import { JsonObject } from '../API/Types';
-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: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Messaging/AssetMessage.d.ts

@@ -1,40 +0,0 @@
-import { email, JsonObject } 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: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Messaging/MessageBase.d.ts

@@ -1,99 +0,0 @@
-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, JsonObject, 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 {@link Company} to which this memo belongs.
-     */
-    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 {@link Asset} to which this message relates.
-     */
-    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: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Messaging/MessageFolder.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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/_publish/objects/Messaging/MessageStatus.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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/_publish/objects/Messaging/MessageType.d.ts

@@ -1,33 +0,0 @@
-/**
- * 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/_publish/objects/Places/Place.d.ts

@@ -1,114 +0,0 @@
-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 { JsonObject, 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 {@link Company} to which this POI belongs.
-     */
-    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 {@link Icon} used to display this POI in lists and on the map.
-     */
-    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: string | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Places/PlaceType.d.ts

@@ -1,25 +0,0 @@
-/**
- * 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/_publish/objects/Providers/Config/ProviderConfig.d.ts

@@ -1,70 +0,0 @@
-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, 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 {@link Company} to which this configuration belongs.
-     */
-    get company(): Company;
-    /**
-     * The script which this configuration implements.
-     * {@link ProviderScript.id}
-     */
-    scriptId: ulong;
-    /**
-     * The {@link ProviderScript} which this configuration implements.
-     */
-    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: JsonObject;
-        geofences: string | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}