@trakit/objects 0.0.14 → 0.0.16

package/objects/Companies/NotificationServerEmail.d.ts

@@ -0,0 +1,99 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { email, JsonObject, 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: JsonObject): 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/objects/Companies/NotificationServerSms.d.ts

@@ -0,0 +1,25 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { JsonObject, 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: JsonObject): 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: JsonObject;
+    };
+}

package/objects/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/objects/Companies/PasswordPolicy.d.ts

@@ -0,0 +1,51 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, JsonObject } from "../API/Types";
+import { PasswordExpiryMode } from "./PasswordExpiryMode";
+/**
+ * The password complexity and expiry policy.
+ */
+export declare class PasswordPolicy implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): 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/objects/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/objects/Companies/SessionPolicy.d.ts

@@ -0,0 +1,47 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, ipv4, JsonObject, ushort } from "../API/Types";
+import { SessionMultiUser } from "./SessionMultiUser";
+/**
+ * The session lifetime policy.
+ */
+export declare class SessionPolicy implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): 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/objects/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, JsonObject } from "../API/Types";
+/**
+ * Driving directions and details like duration and distance.
+ */
+export declare class DispatchDirection implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): 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 | JsonObject)[], 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/objects/Dispatch/DispatchJob.d.ts

@@ -0,0 +1,107 @@
+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, JsonObject, 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 {@link Company} to which this job belongs.
+     */
+    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.
+     */
+    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: JsonObject;
+        labels: string[];
+        tags: string[];
+        forms: number[];
+        steps: any[];
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Dispatch/DispatchJobPriority.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A value assigned to {@link DispatchJob}s in order to weigh them when optimizing a route.
+ */
+export declare enum DispatchJobPriority {
+    /**
+     * Will be done last, after all others, if at all.
+     */
+    standby = "standby",
+    /**
+     * Low priority jobs are assigned towards the end of a dispatch, unless they are in very close proximity to another job.
+     */
+    low = "low",
+    /**
+     * A normal job that will be done at the first opportunity.
+     */
+    medium = "medium",
+    /**
+     * More important job that will be routed to first unless the next high importance job is much farther away.
+     */
+    high = "high",
+    /**
+     * Must be done first, before all others.
+     */
+    urgent = "urgent"
+}

package/objects/Dispatch/DispatchStep.d.ts

@@ -0,0 +1,99 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { TimeSpan } from "../API/TimeSpan";
+import { datetime, nothing, timespan, ulong, JsonObject } from "../API/Types";
+import { Place } from "../Places/Place";
+import { DispatchStepState } from "./DispatchStepState";
+import { DispatchStepStatus } from "./DispatchStepStatus";
+/**
+ * A portion of work for a {@link DispatchJob}.
+ */
+export declare class DispatchStep implements IIdUlong, INamed, ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): DispatchStep;
+    /**
+     * Identifier for this {@link DispatchStep}.
+     * This value is unique per {@link DispatchJob}, but is not unique system-wide.
+     */
+    id: ulong;
+    /**
+     * A name for the work needed to be performed.
+     */
+    name: string;
+    /**
+     * The most recently updated state for this step.
+     */
+    get status(): DispatchStepStatus;
+    /**
+     *
+     */
+    get updated(): Date;
+    /**
+     * The progress of this step.
+     */
+    states: Map<DispatchStepStatus, DispatchStepState>;
+    /**
+     * The optional estimated time of arrival for the asset.
+     */
+    eta: Date;
+    /**
+     * The optional expected duration of the work for this step.
+     */
+    duration: TimeSpan;
+    /**
+     * The total number of seconds in the {@link duration}.
+     */
+    get timeOnSite(): number;
+    set timeOnSite(value: number);
+    /**
+     * An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
+     * {@link Place.id}
+     */
+    placeId: ulong;
+    /**
+     * An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
+     * {@link Place.id}
+     */
+    get place(): Place;
+    set place(value: Place);
+    /**
+     * The street address of where the step must be completed.
+     */
+    address: string;
+    /**
+     * The lat/long coordinates of where the step must be {@link DispatchStepStatus.completed}.
+     */
+    latlng: LatLng | null;
+    /**
+     * Notes about the status of the work filled in by field-employee.
+     */
+    notes: string;
+    /**
+     * Indicates whether this step requires a signature.
+     */
+    signature: boolean;
+    /**
+     * The name of the person who signed the step's completion.
+     */
+    signatory: string;
+    constructor(id?: ulong | nothing, name?: string | nothing, states?: Map<DispatchStepStatus, DispatchStepState> | nothing, eta?: Date | number | datetime | nothing, duration?: TimeSpan | timespan | number | nothing, place?: ulong | nothing, address?: string | nothing, latlng?: ILatLng | JsonObject | nothing, notes?: string | nothing, signature?: boolean | nothing, signatory?: string | nothing);
+    toJSON(): {
+        id: number | null;
+        address: string;
+        duration: string;
+        eta: string;
+        latlng: ILatLng | null;
+        name: string;
+        notes: string;
+        place: number | null;
+        signature: boolean;
+        signatory: string;
+        states: JsonObject;
+    };
+}

package/objects/Dispatch/DispatchStepState.d.ts

@@ -0,0 +1,27 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime, JsonObject, nothing } from "../API/Types";
+/**
+ * Details about the lifetime of a {@link DispatchStep}.
+ */
+export declare class DispatchStepState implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): DispatchStepState;
+    /**
+     * A timestamp from when the lifetime was updated.
+     */
+    updated: Date;
+    /**
+     * The coordinates from the {@link Asset} when the update happened.
+     */
+    latlng: LatLng | null;
+    constructor(updated?: Date | number | datetime | nothing, latlng?: ILatLng | JsonObject | nothing);
+    toJSON(): {
+        updated: string | null;
+        latlng: ILatLng | null;
+    };
+}

package/objects/Dispatch/DispatchStepStatus.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The lifetime of all {@link DispatchStep}s (in order).
+ */
+export declare enum DispatchStepStatus {
+    /**
+     * The {@link DispatchStep} has not yet been started.
+     */
+    pending = "pending",
+    /**
+     * The asset is on the way to the {@link DispatchStep}'s location next.
+     */
+    onRoute = "onRoute",
+    /**
+     * The asset has arrived at the {@link DispatchStep}'s location.
+     */
+    arrived = "arrived",
+    /**
+     * The {@link DispatchStep} is done (or the asset has departed the location).
+     */
+    completed = "completed"
+}