@trakit/objects 0.0.1

package/Companies/CompanyReseller.d.ts

@@ -0,0 +1,163 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { codified, colour, ulong } from "../API/Types";
+import { ColourStyle } from "./ColourStyle";
+import { Company } from "./Company";
+import { NotificationServerEmail } from "./NotificationServerEmail";
+import { NotificationServerSms } from "./NotificationServerSms";
+/**
+ * Defines the seller company's details for white-labelling.
+ */
+export declare class CompanyReseller extends BaseComponent implements IIdUlong, IAmCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * A list of Contacts for company specific things like Technical Support, Billing, etc...
+     * {@link Contact.id}
+     */
+    contactInfo: Map<string, ulong>;
+    /**
+     * The name of the branded service being provided to the seller's customers.
+     */
+    serviceName: string;
+    /**
+     * The name of the image uploaded as the logo (used for regular view).
+     */
+    logo: string;
+    /**
+     * The name of the image uploaded as the logo (used for collapsed/mobile view).
+     */
+    icon: string;
+    /**
+     * The name of the icon file used for browser bookmarks.
+     */
+    favourite: string;
+    /**
+     * The URN and path to the instance of v4.
+     * It does not contain the protocol because all instances are required to be HTTPS.
+     */
+    domain: string;
+    /**
+     * Themed colours used in the web-based UI.
+     */
+    website: Map<string, colour>;
+    /**
+     * A list of symbol names and their corresponding FontAwesome icon names.
+     */
+    graphics: Map<string, codified>;
+    /**
+     * A list of supported languages for your customers.
+     */
+    languages: string[];
+    /**
+     * Colours used as templates for status tags, labels, and places.
+     */
+    gamut: Map<string, ColourStyle>;
+    /**
+     * The server used for notification and conversational email messages sent and received by the system.
+     */
+    notifyEmail: NotificationServerEmail;
+    /**
+     * Definition for load-balanced outbound SMS numbers for the reseller.
+     */
+    notifySms: NotificationServerSms;
+    /**
+     * A preamble to the general terms and conditions offered by Fleet Freedom.
+     */
+    termsPreamble: string;
+    /**
+     * The date and time when the terms were updated.
+     * This will promt users who are logging-in to re-agree to the new terms
+     */
+    termsUpdated: Date;
+    /**
+     * The subject of the email sent to a user requesting a password reset.
+     * @tutorial The following strings are replaced:
+     * - %SERVICE%   with {serviceName}
+     * - %URL%       with https://{URN}/recover
+     * - %NAME%      with user's nickname, contact name, or login
+     * - %GUID%      with the unique identifier of the reset request
+     * - %CLIENT%    with the client software's userAgent used to create the request
+     * - %IP%        with IP address used to create the request
+     * - %SERVER%    with the server software's userAgent or the software (Kraken, Medusa, Mindflayer)
+     */
+    recoverSubject: string;
+    /**
+     * The body of the email sent to a user requesting a password reset.
+     * @tutorial The following strings are replaced:
+     * - %SERVICE%   with {serviceName}
+     * - %URL%       with https://{URN}/recover
+     * - %NAME%      with user's nickname, contact name, or login
+     * - %GUID%      with the unique identifier of the reset request
+     * - %CLIENT%    with the client software's userAgent used to create the request
+     * - %IP%        with IP address used to create the request
+     * - %SERVER%    with the server software's userAgent or the software (Kraken, Medusa, Mindflayer)
+     */
+    recoverBody: string;
+    /**
+     * When true, sends the password reset email as an HTML email instead of plain text.
+     * @tutorial When false, the following strings are replaced:
+     * - &reg;    with char 0174
+     * - &trade;  with char 8482
+     * - &copy;   with char 0169
+     * - &amp;    with "&"
+     */
+    recoverIsHtml: boolean;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        contactInfo: object;
+        serviceName: string;
+        logo: string;
+        icon: string;
+        favourite: string;
+        domain: string;
+        website: object;
+        graphics: object;
+        languages: string[];
+        gamut: object;
+        notifyEmail: {
+            incomingType: import("./NotificationServerEmail").IncomingEmailServerType;
+            incomingAddress: string;
+            incomingPort: number | null;
+            incomingLogin: string;
+            incomingSecure: boolean;
+            incomingMessageNumber: number | null;
+            outgoingType: import("./NotificationServerEmail").OutgoingEmailServerType;
+            outgoingAddress: string;
+            outgoingPort: number | null;
+            outgoingLogin: string;
+            outgoingSecure: boolean;
+            outgoingReplyTo: string;
+        };
+        notifySms: {
+            notifyLimit: number | null;
+            phoneNumbers: object;
+        };
+        termsPreamble: string;
+        termsUpdated: string | null;
+        recoverSubject: string;
+        recoverBody: string;
+        recoverIsHtml: boolean;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Companies/CompanyStyles.d.ts

@@ -0,0 +1,46 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { codified, ulong } from "../API/Types";
+import { Company } from "./Company";
+import { LabelStyle } from "./LabelStyle";
+/**
+ * The colours and styles used by this company to tag and label Assets, Places, and other things.
+ */
+export declare class CompanyStyles extends BaseComponent implements IIdUlong, IAmCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * The styles for labels added to Assets, Places, and other things.
+     */
+    labels: Map<codified, LabelStyle>;
+    /**
+     * The styles for status tags added to Assets.
+     */
+    tags: Map<codified, LabelStyle>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        labels: object;
+        tags: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Companies/LabelStyle.d.ts

@@ -0,0 +1,46 @@
+import { INamed } from "../API/Interfaces/INamed";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { IVisual } from "../API/Interfaces/IVisual";
+import { codified, colour } from "../API/Types";
+/**
+ * Visual style identification helper.
+ */
+export declare class LabelStyle implements INamed, IVisual, ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): LabelStyle;
+    /**
+     * The name of this visual style.
+     */
+    name: string;
+    /**
+     * The background colour given to this style for easy visual identification.
+     */
+    fill: colour;
+    /**
+     * The text/graphic colour given to this style for easy visual identification.
+     */
+    stroke: colour;
+    /**
+     * The codified graphic name given to this script for easy visual identification.
+     */
+    graphic: codified;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The codified name of this style
+     */
+    get code(): codified;
+    constructor(name?: string, fill?: colour, stroke?: colour, graphic?: codified, notes?: string);
+    toJSON(): {
+        name: string;
+        notes: string;
+        fill: string;
+        stroke: string;
+        graphic: string;
+    };
+}

package/Companies/NotificationServerEmail.d.ts

@@ -0,0 +1,99 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { email, uint, ushort } from "../API/Types";
+/**
+ * The types of email protocols supported for incoming mail servers.
+ **/
+export declare enum IncomingEmailServerType {
+    /**
+     * Internet Message Access Protocol (default)
+     */
+    "IMAP" = "IMAP",
+    /**
+     * Post Office Protocol v3
+     */
+    "POP3" = "POP3"
+}
+/**
+ * The types of email protocols supported for sending messages.
+ **/
+export declare enum OutgoingEmailServerType {
+    /**
+     * Simple Mail Transfer Protocol
+     */
+    "SMTP" = "SMTP"
+}
+/**
+ * The server used for notification and conversational email messages sent and received by the system.
+ */
+export declare class NotificationServerEmail implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): NotificationServerEmail;
+    /**
+     * The type of incoming protocol to use (IMAP or POP3).
+     */
+    incomingType: IncomingEmailServerType;
+    /**
+     * The domain or IP address of the incoming email server.
+     */
+    incomingAddress: string;
+    /**
+     * The port number of the incoming email server.
+     */
+    incomingPort: ushort;
+    /**
+     * The username used to login to the incoming email server.
+     */
+    incomingLogin: string;
+    /**
+     * Is the incoming email server using a secure SSL/TLS connection (it should).
+     */
+    incomingSecure: boolean;
+    /**
+     * Is the incoming email server 		/**
+     * IMAP message sequence number so only recent messages are retrieved.
+     */
+    incomingMessageNumber: uint;
+    /**
+     * The type of outgoing protocol to use (only SMTP).
+     */
+    outgoingType: OutgoingEmailServerType;
+    /**
+     * The domain or IP address of the outgoing email server.
+     */
+    outgoingAddress: string;
+    /**
+     * The port number of the outgoing email server.
+     */
+    outgoingPort: ushort;
+    /**
+     * The username used to login to the outgoing email server.
+     */
+    outgoingLogin: string;
+    /**
+     * Is the outgoing email server using a secure SSL/TLS connection (it should).
+     */
+    outgoingSecure: boolean;
+    /**
+     * Is the outgoing email server 		/**
+     * An optional field which can be set as the "sent from" and/or "reply-to" address.
+     */
+    outgoingReplyTo: email;
+    constructor(incomingType?: IncomingEmailServerType, incomingAddress?: string, incomingPort?: ushort, incomingLogin?: string, incomingSecure?: boolean, incomingMessageNumber?: uint, outgoingType?: OutgoingEmailServerType, outgoingAddress?: string, outgoingPort?: ushort, outgoingLogin?: string, outgoingSecure?: boolean, outgoingReplyTo?: string);
+    toJSON(): {
+        incomingType: IncomingEmailServerType;
+        incomingAddress: string;
+        incomingPort: number | null;
+        incomingLogin: string;
+        incomingSecure: boolean;
+        incomingMessageNumber: number | null;
+        outgoingType: OutgoingEmailServerType;
+        outgoingAddress: string;
+        outgoingPort: number | null;
+        outgoingLogin: string;
+        outgoingSecure: boolean;
+        outgoingReplyTo: string;
+    };
+}

package/Companies/NotificationServerSms.d.ts

@@ -0,0 +1,25 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { ulong, ushort } from "../API/Types";
+/**
+ * Definition for load-balanced outbound SMS numbers for the White-labelling profile.
+ */
+export declare class NotificationServerSms implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): NotificationServerSms;
+    /**
+     * A per-number/per-day limit on the amount of Notifications sent.
+     */
+    notifyLimit: ushort;
+    /**
+     * All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
+     */
+    phoneNumbers: Map<string, ulong[]>;
+    constructor(notifyLimit?: ushort, phoneNumbers?: Map<string, ulong[]>);
+    toJSON(): {
+        notifyLimit: number | null;
+        phoneNumbers: object;
+    };
+}

package/Companies/PasswordExpiryMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Defines how User passwords expire.
+ */
+export declare enum PasswordExpiryMode {
+    /**
+     * Passwords never expire.
+     */
+    never = "never",
+    /**
+     * Passwords expire after a defined number of days.
+     */
+    days = "days",
+    /**
+     * Passwords expire after a defined number of successful logins.
+     */
+    sessions = "sessions"
+}

package/Companies/PasswordPolicy.d.ts

@@ -0,0 +1,51 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte } from "../API/Types";
+import { PasswordExpiryMode } from "./PasswordExpiryMode";
+/**
+ * The password complexity and expiry policy.
+ */
+export declare class PasswordPolicy implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): PasswordPolicy;
+    /**
+     * The minimum number of characters required.
+     */
+    minimumLength: byte;
+    /**
+     * Do passwords require alphabetical characters.
+     */
+    includeLetters: boolean;
+    /**
+     * Do passwords require numeric characters.
+     */
+    includeNumbers: boolean;
+    /**
+     * Do passwords require upper-case and lower-case letters.
+     */
+    includeUpperLower: boolean;
+    /**
+     * Do passwords require non-alphanumeric characters.
+     */
+    includeSpecial: boolean;
+    /**
+     * Defines how passwords expire.
+     */
+    expireMode: PasswordExpiryMode;
+    /**
+     * The threshold for expiry.
+     */
+    expireThreshold: byte;
+    constructor(minimumLength?: byte, includeLetters?: boolean, includeNumbers?: boolean, includeUpperLower?: boolean, includeSpecial?: boolean, expireMode?: PasswordExpiryMode, expireThreshold?: byte);
+    toJSON(): {
+        minimumLength: number | null;
+        includeLetters: boolean;
+        includeNumbers: boolean;
+        includeUpperLower: boolean;
+        includeSpecial: boolean;
+        expireMode: PasswordExpiryMode;
+        expireThreshold: number | null;
+    };
+}

package/Companies/SessionMultiUser.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Defines the behaviour of the system when a user creates multiple sessions.
+ */
+export declare enum SessionMultiUser {
+    /**
+     * Allow users to create multiple simultaneous sessions.
+     */
+    allow = "allow",
+    /**
+     * Deny users from creating new sessions if they already have an active session.
+     */
+    deny = "deny",
+    /**
+     * Allow users to create a new session, but automatically kill the previous session.
+     */
+    replace = "replace"
+}

package/Companies/SessionPolicy.d.ts

@@ -0,0 +1,47 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, ipv4, ushort } from "../API/Types";
+import { SessionMultiUser } from "./SessionMultiUser";
+/**
+ * The session lifetime policy.
+ */
+export declare class SessionPolicy implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): SessionPolicy;
+    /**
+     * The list of applications users are allowed to use to create sessions.
+     */
+    applications: string[];
+    /**
+     * Ranges of IPv4 addresses (using Cisco notation) to limit session creation to certain IPs.
+     */
+    ipv4Ranges: ipv4[];
+    /**
+     * Restrict session creation to only the provided IPv4 ranges (		/**
+     * Defines the behaviour of the system when a user creates multiple sessions.
+     */
+    multiUser: SessionMultiUser;
+    /**
+     * Defines whether a session should be automatically killed when the connection breaks.
+     */
+    idleAllowed: boolean;
+    /**
+     * The lifetime duration of a session in minutes.
+     */
+    expireTimeout: ushort;
+    /**
+     * The maximum number of sessions allowed per user.
+     */
+    maxSessions: byte;
+    constructor(applications?: string[], ipv4Ranges?: ipv4[], multiUser?: SessionMultiUser, idleAllowed?: boolean, expireTimeout?: ushort, maxSessions?: byte);
+    toJSON(): {
+        applications: string[];
+        ipv4Ranges: string[];
+        multiUser: SessionMultiUser;
+        idleAllowed: boolean;
+        expireTimeout: number | null;
+        maxSessions: number | null;
+    };
+}

package/Dispatch/DispatchDirection.d.ts

@@ -0,0 +1,53 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { TimeSpan } from "../API/TimeSpan";
+import { double, timespan, ulong } from "../API/Types";
+/**
+ * Driving directions and details like duration and distance.
+ */
+export declare class DispatchDirection implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): DispatchDirection;
+    /**
+     * The total distance of these directions (including sub-directions if applicable).
+     */
+    distance: double;
+    /**
+     * The total duration of these directions (including sub-directions if applicable).
+     */
+    duration: TimeSpan;
+    /**
+     * Text hint for the driver for the action to perform.
+     */
+    instructions: string;
+    /**
+     * A <format id="polyline">route path</format> to display on a map.
+     */
+    path: LatLng[];
+    /**
+     * For complex routes, the sub-directions provide a breakdown or additional details.
+     */
+    directions: DispatchDirection[];
+    /**
+     * Unique identifier of the {@link DispatchJob} or {@link DispatchTask}.
+     */
+    job: ulong;
+    /**
+     * The {@link DispatchStep.id}, if this direction is for {@link DispatchJob}s.
+     */
+    step: ulong;
+    constructor(distance?: double, duration?: TimeSpan | timespan | number, instructions?: string, path?: ILatLng[], directions?: DispatchDirection[], job?: ulong, step?: ulong);
+    toJSON(): {
+        distance: number;
+        duration: string | null;
+        instructions: string;
+        path: any[];
+        directions: any[];
+        job: number | null;
+        step: number | null;
+    };
+}

package/Dispatch/DispatchJob.d.ts

@@ -0,0 +1,109 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { codified, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { FormResult } from "../Hosting/FormResult";
+import { DispatchJobPriority } from "./DispatchJobPriority";
+import { DispatchStep } from "./DispatchStep";
+/**
+ * Some work that needs to be done by performing one or more {@link DispatchStep}s.
+ */
+export declare class DispatchJob extends BaseComponent implements IIdUlong, ILabelled, IBelongCompany, IBelongAsset {
+    /**
+     * Unique identifier of this job.
+     */
+    id: ulong;
+    /**
+     * The company to which this job belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this job belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The {@link Asset} to which this job belongs.
+     * This value is null when unassigned.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this job belongs.
+     * This value is null when unassigned.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * A name for the work needed to be performed.
+     */
+    name: string;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    /**
+     * Instructions (filled out by dispatcher) for the field-employee to help them complete the job.
+     */
+    instructions: string;
+    /**
+     * A list of hosted {@link FormResult.id} attached to this job.
+     */
+    formIds: ulong[];
+    /**
+     * A list of hosted {@link FormResult}s attached to this job.
+     */
+    get forms(): FormResult[];
+    set forms(value: FormResult[]);
+    /**
+     * The importance of this job when scheduling for an asset.
+     */
+    priority: DispatchJobPriority;
+    /**
+     * Codified label names used to relate (unassigned) jobs to {@link Asset}s.
+     */
+    labels: codified[];
+    /**
+     * The codified status tag names reflecting the conditions of this job.
+     */
+    tags: codified[];
+    /**
+     * A list of coordinates to visit in order to carry out the work for this job.
+     */
+    steps: DispatchStep[];
+    /**
+     * When this job was originally created.
+     */
+    created: Date;
+    /**
+     * Clocked-in driver name who made the update.
+     * Null if not clocked-in, or no changes have been made.
+     */
+    driver: string;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        v: number[];
+        driver: string;
+        created: string | null;
+        name: string;
+        instructions: string;
+        priority: DispatchJobPriority;
+        references: object;
+        labels: string[];
+        tags: string[];
+        forms: number[];
+        steps: any[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}