@trakit/objects 0.0.14 → 0.0.16

package/objects/Images/Picture.d.ts

@@ -0,0 +1,72 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { Rectangle } from "../API/Geometry/Rectangle";
+import { Size } from "../API/Geometry/Size";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IFileSize } from "../API/Interfaces/IFileSize";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { uint, ulong, JsonObject } from "../API/Types";
+import { Company } from "../Companies/Company";
+/**
+ * An image stored by the system.
+ */
+export declare class Picture extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IFileSize {
+    /**
+     * Unique identifier of this image.
+     */
+    id: ulong;
+    /**
+     * The company to which this image belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this image belongs.
+     */
+    get company(): Company;
+    /**
+     * The file name of this image.
+     */
+    name: string;
+    /**
+     * Notes about this image.
+     */
+    notes: string;
+    /**
+     * The URL/path to find this image.
+     */
+    src: string;
+    /**
+     * Resolution defined in pixels.
+     */
+    size: Size;
+    /**
+     * A list of focal points in the images like faces.
+     */
+    focals: Rectangle[];
+    /**
+     * The file-size on the disk.
+     */
+    bytes: ulong;
+    /**
+     * A count of the times this image was used for something (asset, contact, task, etc).
+     */
+    uses: uint;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        name: string;
+        notes: string;
+        src: string;
+        size: import("../API/Geometry/Interfaces").ISize;
+        focals: any[];
+        bytes: number | null;
+        uses: number | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Maintenance/MaintenanceInterval.d.ts

@@ -0,0 +1,48 @@
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, double, JsonObject, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { MaintenanceJob } from "./MaintenanceJob";
+/**
+ * The detail for calculating Maintenance Schedule recurrence.
+ */
+export declare class MaintenanceInterval implements IBelongAsset, ISerializable {
+    static fromJSON(json: JsonObject): MaintenanceInterval;
+    /**
+     * The Vehicle or Trailer to which this recurrence detail belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The Vehicle or Trailer to which this recurrence detail belongs.
+     */
+    get asset(): Asset;
+    /**
+     * The date of the last calculation.
+     */
+    date: Date;
+    /**
+     * The odometer at the time of the last calculation.
+     */
+    odometer: double;
+    /**
+     * The operating time at the time of the last calculation.
+     */
+    engineHours: double;
+    /**
+     * The last "completed" job related to this schedule interval.
+     */
+    lastJobId: ulong;
+    /**
+     * The last "completed" job related to this schedule interval.
+     */
+    get lastJob(): MaintenanceJob;
+    constructor(asset?: ulong, date?: Date | number | datetime, odometer?: double, engineHours?: double, lastJob?: ulong);
+    toJSON(): {
+        asset: number | null;
+        date: string | null;
+        odometer: number;
+        engineHours: number;
+        lastJob: number | null;
+    };
+}

package/objects/Maintenance/MaintenanceJob.d.ts

@@ -0,0 +1,134 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { IPictured } from "../API/Interfaces/IPictured";
+import { TimeSpan } from "../API/TimeSpan";
+import { double, JsonObject, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { Picture } from "../Images/Picture";
+import { MaintenanceJobStatus } from "./MaintenanceJobStatus";
+import { MaintenanceSchedule } from "./MaintenanceSchedule";
+/**
+ * Historical service work performed on a Vehicle or Trailer
+ */
+export declare class MaintenanceJob extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, IPictured {
+    /**
+     * Unique identifier
+     */
+    id: ulong;
+    /**
+     * The Vehicle or Trailer to which this job belongs
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The Vehicle or Trailer to which this job belongs
+     */
+    get asset(): Asset;
+    /**
+     * The company to which this Vehicle or Trailer belongs
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this Vehicle or Trailer belongs
+     */
+    get company(): Company;
+    /**
+     * The Maintenance Schedule from which this job was created
+     * {@link MaintenanceSchedule.id}
+     */
+    scheduleId: ulong;
+    /**
+     * The Maintenance Schedule from which this job was created
+     * {@link MaintenanceSchedule.id}
+     */
+    get schedule(): MaintenanceSchedule;
+    set schedule(value: MaintenanceSchedule);
+    /**
+     * The work being done. Like "oil change".
+     */
+    name: string;
+    /**
+     * Notes about the job.  Like "changed the oil and filter".
+     */
+    notes: string;
+    /**
+     * The status of this job.
+     */
+    status: MaintenanceJobStatus;
+    /**
+     * When was this job created.
+     */
+    created: Date;
+    /**
+     * When was this job created.
+     */
+    completed: Date;
+    /**
+     * The odometer at the time of the service.
+     */
+    odometer: double;
+    /**
+     * The operating time at the time of the service.
+     */
+    engineHours: double;
+    /**
+     * The name of the garage or service facility where the work is done.
+     */
+    garage: string;
+    /**
+     * Time it took to complete the job.
+     */
+    duration: TimeSpan;
+    /**
+     * How much the job cost in dollars.
+     */
+    cost: double;
+    /**
+     * A reference code used to track this job
+     */
+    reference: string;
+    /**
+     * The mechanic who performed the work.
+     */
+    technician: string;
+    /**
+     * Images taken while performing the work for reference.
+     * {@link Picture.id}
+     */
+    pictureIds: ulong[];
+    /**
+     * {@link Picture}s taken while performing the work for reference.
+     */
+    get pictures(): Picture[];
+    set pictures(values: Picture[]);
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        asset: number;
+        schedule: number;
+        name: string;
+        notes: string;
+        status: MaintenanceJobStatus;
+        created: string | null;
+        completed: string | null;
+        odometer: number;
+        engineHours: number;
+        garage: string;
+        cost: number;
+        duration: string;
+        reference: string;
+        technician: string;
+        pictures: number[];
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Maintenance/MaintenanceJobStatus.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The lifetime of a Maintenance Job
+ */
+export declare enum MaintenanceJobStatus {
+    /**
+     * The work will need to be performed soon.
+     */
+    pending = "pending",
+    /**
+     * The work was scheduled, but not yet done.
+     */
+    pastdue = "pastdue",
+    /**
+     * Work is completed.
+     */
+    completed = "completed",
+    /**
+     * The job was cancelled or was not necessary.
+     */
+    cancelled = "cancelled"
+}

package/objects/Maintenance/MaintenanceSchedule.d.ts

@@ -0,0 +1,118 @@
+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/objects/Messaging/AlertPriority.d.ts

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

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

@@ -0,0 +1,40 @@
+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/objects/Messaging/MessageBase.d.ts

@@ -0,0 +1,99 @@
+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/objects/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/objects/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/objects/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"
+}