@trakit/objects 0.0.16 → 0.0.17

package/objects/Companies/SessionPolicy.d.ts

@@ -1,47 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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

@@ -1,107 +0,0 @@
-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

@@ -1,25 +0,0 @@
-/**
- * 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

@@ -1,99 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

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

package/objects/Dispatch/DispatchTask.d.ts

@@ -1,154 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { LatLng } from "../API/Geography/LatLng";
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { TimeSpan } from "../API/TimeSpan";
-import { JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { Document } from "../Hosting/Document";
-import { Place } from "../Places/Place";
-import { DispatchTaskStatus } from "./DispatchTaskStatus";
-/**
- * A task assigned to an asset which represents a coordinate on the map which must be visited.
- * @deprecated Use DispatchJob instead
- */
-export declare class DispatchTask extends BaseComponent implements IIdUlong, IBelongCompany, IBelongAsset {
-    /**
-     * Unique identifier of this task.
-     */
-    id: ulong;
-    /**
-     * The company to which this task belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this task belongs.
-     */
-    get company(): Company;
-    /**
-     * The asset to which this task belongs.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The {@link Asset} to which this task belongs.
-     */
-    get asset(): Asset;
-    set asset(value: Asset);
-    /**
-     * The name of this task or the work needed to be performed.
-     */
-    name: string;
-    /**
-     * Name/value collections of custom fields used to refer to external systems.
-     */
-    references: Map<string, string>;
-    /**
-     * 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 task must be completed.
-     */
-    address: string;
-    /**
-     * The lat/long coordinates of where the task must be completed.
-     */
-    latlng: LatLng;
-    /**
-     * The progress of this task.
-     */
-    status: DispatchTaskStatus;
-    /**
-     * When this task was created.
-     */
-    created: Date;
-    /**
-     * The optional estimated time of arrival for the asset.
-     */
-    eta: Date;
-    /**
-     * The optional expected duration of the work for this task.
-     */
-    duration: TimeSpan;
-    /**
-     * The date/time stamp of when the asset arrived at this task.
-     */
-    arrived: Date;
-    /**
-     * The date/time stamp of when this task was completed.
-     */
-    completed: Date;
-    /**
-     * Instructions (filled out by dispatcher) for the field-employee to help them completed the task.
-     */
-    instructions: string;
-    /**
-     * Indicates whether the task has a signature.
-     */
-    signature: boolean;
-    /**
-     * The name of the person who signed the task's completion.
-     */
-    signatory: string;
-    /**
-     * Notes about the status of the work filled in by field-employee.
-     */
-    notes: string;
-    /**
-     * A list of hosted {@link Document} identifiers attached to this task.
-     */
-    attachmentIds: ulong[];
-    /**
-     * A list of hosted {@link Document} identifiers attached to this task.
-     */
-    get attachments(): Document[];
-    set attachments(value: Document[]);
-    /**
-     * Either the user's login, or provider's identifier that changed this task
-     */
-    updatedBy: string;
-    /**
-     * Timestamp from the last change made to this task
-     */
-    updatedUtc: Date;
-    toJSON(): {
-        id: number | null;
-        company: number | null;
-        asset: number | null;
-        v: number[];
-        name: string;
-        references: JsonObject;
-        place: number | null;
-        address: string;
-        latlng: import("../API/Geography/Interfaces").ILatLng;
-        status: DispatchTaskStatus;
-        created: string | null;
-        eta: string | null;
-        duration: string;
-        arrived: string | null;
-        completed: string | null;
-        instructions: string;
-        signature: boolean;
-        signatory: string;
-        notes: string;
-        attachments: number[];
-        updatedBy: string;
-        updatedUtc: string | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/objects/Dispatch/DispatchTaskStatus.d.ts

@@ -1,50 +0,0 @@
-/**
- * Tasks have a lifetime and each status represents a task's progress through it's life.
- * @deprecated Use {@link DispatchStepStatus} instead
- */
-export declare enum DispatchTaskStatus {
-    /**
-     * The task has been created, but not yet assigned to an asset.
-     */
-    created = "created",
-    /**
-     * The task has been given to an asset (and delivered to the asset's primary device).
-     */
-    queued = "queued",
-    /**
-     * The asset is on the way to the task's location next.
-     */
-    onRoute = "onRoute",
-    /**
-     * The asset has arrived at the task's location.
-     */
-    arrived = "arrived",
-    /**
-     * The task is done.
-     */
-    completed = "completed",
-    /**
-     * The task was cancelled by either the asset or a user.
-     */
-    cancelled = "cancelled",
-    /**
-     * An item was picked-up for this task.
-     */
-    pickedUp = "pickedUp",
-    /**
-     * An item was dropped-off for this task.
-     */
-    droppedOff = "droppedOff",
-    /**
-     * The asset is waiting and can't complete the task.
-     */
-    waiting = "waiting",
-    /**
-     * An item associated with this task is damaged.
-     */
-    damaged = "damaged",
-    /**
-     * The task couldn't be completed by the asset.
-     */
-    unsuccessful = "unsuccessful"
-}

package/objects/Hosting/Document.d.ts

@@ -1,70 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-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 { ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-/**
- * A file stored temporarily by the system.
- */
-export declare class Document extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IFileSize {
-    /**
-     * Unique identifier of this file.
-     */
-    id: ulong;
-    /**
-     * The company to which this file belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this file belongs.
-     */
-    get company(): Company;
-    /**
-     * The file name of this file.
-     */
-    name: string;
-    /**
-     * Notes about this file.
-     */
-    notes: string;
-    /**
-     * The URL/path to find this file.
-     */
-    src: string;
-    /**
-     * The file-size on the disk.
-     */
-    bytes: ulong;
-    /**
-     * The MIME type of the file.
-     */
-    mime: string;
-    /**
-     * The date and time this fill will be automatically purged from our system.
-     */
-    expiry: Date;
-    /**
-     * Name/value collections of custom fields used to refer to external systems.
-     */
-    references: Map<string, string>;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        src: string;
-        mime: string;
-        bytes: number;
-        expiry: string | null;
-        references: Map<string, any>;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/objects/Hosting/Fields/FormFieldAttachments.d.ts

@@ -1,31 +0,0 @@
-import { byte, nothing, ulong } from '../../API/Types';
-import { FormFieldType } from '../FormFieldType';
-import { FormFieldBase } from './FormFieldBase';
-/**
- * A control to allow the user to attach {@link Picture}s or {@link Document}s.
-*/
-export declare class FormFieldAttachments extends FormFieldBase {
-    /**
-     * Takes a string as input and returns an array split by comma with trimmed items.
-     * @param values
-     */
-    static split(values: string): string[];
-    /**
-     * These are the attachment types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * Minimum number of {@link Document}s and/or {@link Picture}s that must be attached.
-     */
-    minimum: byte;
-    /**
-     * Maximum number of {@link Document}s and/or {@link Picture}s that must be attached.
-     */
-    maximum: byte;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: byte | nothing, maximum?: byte | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}