@trakit/objects 0.0.6 → 0.0.8

package/_publish/objects/Hosting/Fields/FormFieldText.d.ts

@@ -1,32 +0,0 @@
-import { byte, nothing, ulong, ushort } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A text input control.
- */
-export declare class FormFieldText extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.text} control type.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The number of rows of text to display.
-     * @tutorial The control should grow to display all entered text even if the UI must add more rows.
-     */
-    rows: byte;
-    /**
-     * Minimum length of entered text to make it a valid entry.
-     */
-    minimum: ushort;
-    /**
-     * Maximum length of entered text to make it a valid entry.
-     */
-    maximum: ushort;
-    constructor(id?: ulong | nothing, name?: string | nothing, rows?: byte | nothing, minimum?: ushort | nothing, maximum?: ushort | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        rows: number | null;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldTime.d.ts

@@ -1,37 +0,0 @@
-import { TimeSpan } from "../../API/TimeSpan";
-import { nothing, timespan, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A control to choose a time or duration longer than 24 hours.
- */
-export declare class FormFieldTime extends FormFieldBase {
-    /**
-     * For a 24 hour day, anything negative span would be considered invalid.
-     * As such, the minimum time for a {@link FormFieldType.time} is midnight (zero).
-     */
-    static readonly MINIMUM_TIME_OF_DAY: TimeSpan;
-    /**
-     * For a 24 hour day, anything over a 24 hour span would be considered invalid.
-     * As such, the maximum time for a {@link FormFieldType.time} is midnight the next day.
-     */
-    static readonly MAXIMUM_TIME_OF_DAY: TimeSpan;
-    /**
-     * These are the clock control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The minimum duration or earliest time-of-day.
-     */
-    minimum: TimeSpan | null;
-    /**
-     * The maximum duration or latest time-of-day.
-     */
-    maximum: TimeSpan | null;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: TimeSpan | timespan | number | nothing, maximum?: TimeSpan | timespan | number | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        minimum: string | null;
-        maximum: string | null;
-    };
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/Fields/FormFieldTimezone.d.ts

@@ -1,14 +0,0 @@
-import { nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A {@link Timezone} selection control.
- */
-export declare class FormFieldTimezone extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.timezone} control type.
-     */
-    protected get supported(): FormFieldType[];
-    constructor(id?: ulong | nothing, name?: string | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    isValid(value: string): boolean;
-}

package/_publish/objects/Hosting/FormFieldType.d.ts

@@ -1,127 +0,0 @@
-/**
- * The supported types of user interface modules for a {@link FormTemplate}.
- */
-export declare enum FormFieldType {
-    /**
-     * Any text input.
-     * {@link FormFieldText}
-     */
-    text = "text",
-    /**
-     * A choice of one (or more) values defined.
-     * {@link FormFieldChoice}
-     */
-    choice = "choice",
-    /**
-     * A drop-down or fly-out UI for choosing a single value.
-     * Works better than {@link choice} when there are a lot of values. ie; country or province list.
-     * {@link FormFieldChoice}
-     */
-    dropdown = "dropdown",
-    /**
-     * A check mark to represent a boolean value.
-     * {@link FormFieldBoolean}
-     */
-    checkbox = "checkbox",
-    /**
-     * A toggle box to represent one of two possible values (optionally defined).
-     * {@link FormFieldBoolean}
-     */
-    toggle = "toggle",
-    /**
-     * Numeric (optionally decimal) input.
-     * {@link FormFieldNumeric}
-     */
-    numeric = "numeric",
-    /**
-     * A slider bar to choose a numeric value between a given high and low value.
-     * {@link FormFieldNumeric}
-     */
-    range = "range",
-    /**
-     * A numeric value of distance (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    distance = "distance",
-    /**
-     * A numeric value of area (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    area = "area",
-    /**
-     * A numeric value of temperature (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    temperature = "temperature",
-    /**
-     * A numeric value of weight (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    weight = "weight",
-    /**
-     * A numeric value of volume (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    volume = "volume",
-    /**
-     * A numeric value of pressure (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    pressure = "pressure",
-    /**
-     * A numeric value of speed (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    speed = "speed",
-    /**
-     * A numeric value of fuel economy (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
-     * {@link FormFieldNumeric}
-     */
-    fuelEconomy = "fuelEconomy",
-    /**
-     * A numeric value representing an amount of money.
-     * {@link FormFieldNumeric}
-     */
-    currency = "currency",
-    /**
-     * A date and time picker.
-     * {@link FormFieldDate}
-     */
-    datetime = "datetime",
-    /**
-     * A calendar/date picker.
-     * {@link FormFieldDate}
-     */
-    date = "date",
-    /**
-     * A clock/time picker.
-     * {@link FormFieldTime}
-     */
-    time = "time",
-    /**
-     * A duration picker.
-     * Different than {@link time} because a duration can be negative, or longer than 24 hours.
-     * {@link FormFieldTime}
-     */
-    duration = "duration",
-    /**
-     * Area to capture a signature bitmap.
-     * {@link FormFieldSignature}
-     */
-    signature = "signature",
-    /**
-     * A browser of {@link Picture}s that can be attached.
-     * {@link FormFieldAttachments}
-     */
-    pictures = "pictures",
-    /**
-     * A browser of {@link Document}s that can be attached.
-     * {@link FormFieldAttachments}
-     */
-    files = "files",
-    /**
-     * A list of {@link Timezone}s.
-     * {@link FormFieldTimezone}
-     */
-    timezone = "timezone"
-}

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

@@ -1,48 +0,0 @@
-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/_publish/objects/Maintenance/MaintenanceJobStatus.d.ts

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

package/_publish/objects/Providers/Config/ProviderRegistration.d.ts

@@ -1,119 +0,0 @@
-import { Base } from "../../API/Base";
-import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
-import { INamed } from "../../API/Interfaces/INamed";
-import { IRequestable } from "../../API/Interfaces/IRequestable";
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { email, phone, ulong, JsonObject } from "../../API/Types";
-import { User } from "../../Accounts/User";
-import { Asset } from "../../Assets/Asset";
-import { Company } from "../../Companies/Company";
-import { ProviderConfiguration } from "../Configuration/ProviderConfiguration";
-import { ProviderType } from "../ProviderType";
-import { ProviderConfig } from "./ProviderConfig";
-/**
- * The temporary reference to a device whose ownership is pending.
- */
-export declare class ProviderRegistration extends Base implements IRequestable, INamed, IBelongCompany, IBelongAsset, ISerializable {
-    /**
-     * A unique six digit code.
-     */
-    code: string;
-    /**
-     * The company to which the device will belong.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which the device will belong.
-     */
-    get company(): Company;
-    /**
-     * A nickname given to the device once it has been provisioned.
-     */
-    name: string;
-    /**
-     * Notes!
-     */
-    notes: string;
-    /**
-     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
-     */
-    password: string;
-    /**
-     * The unique identifier the user who generated this registration.
-     * {@link User.login}
-     */
-    userLogin: email;
-    /**
-     * The unique identifier the user who generated this registration.
-     * {@link User.login}
-     */
-    get user(): User;
-    /**
-     * The predefined configuration this device will use.
-     * {@link ProviderConfig.id}
-     * {@link ProviderConfiguration.id}
-     */
-    configId: ulong;
-    /**
-     * The predefined {@link ProviderConfig} (or {@link ProviderConfiguration}) this device will use.
-     */
-    get config(): ProviderConfig | ProviderConfiguration;
-    /**
-     * The kind of protocol this device supports.
-     */
-    kind: ProviderType;
-    /**
-     * Date/time stamp of when this registration began.
-     */
-    since: Date;
-    /**
-     * Date/time stamp of when this registration ended successfully.
-     */
-    completed: Date;
-    /**
-     * The expiry date for this registration.
-     */
-    expires: Date;
-    /**
-     * The unique identifier of the device that completed this registration.
-     * {@link Provider.id}
-     */
-    identifier: string;
-    /**
-     * The Asset for which this device will provide data.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The {@link Asset} for which this device will provide data.
-     */
-    get asset(): Asset;
-    /**
-     * The phone number of the device being provisioned.
-     * This is set by the user for long-term registrations, or by the client during serial port setup.
-     */
-    phoneNumber: phone;
-    toJSON(): {
-        code: string | null;
-        company: number | null;
-        name: string;
-        notes: string;
-        password: string;
-        user: string;
-        config: number | null;
-        kind: ProviderType;
-        since: string | null;
-        completed: string | null;
-        expires: string | null;
-        identifier: string;
-        asset: number | null;
-        phoneNumber: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link code} is the key.
-     */
-    getKey(): string;
-}

package/_publish/objects/Providers/Config/ProviderScript.d.ts

@@ -1,86 +0,0 @@
-import { BaseComponent } from "../../API/BaseComponent";
-import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
-import { IGlobal } from "../../API/Interfaces/IGlobal";
-import { IIdUlong } from "../../API/Interfaces/IIdUlong";
-import { INamed } from "../../API/Interfaces/INamed";
-import { IVisual } from "../../API/Interfaces/IVisual";
-import { JsonObject, codified, colour, ulong } from "../../API/Types";
-import { Company } from "../../Companies/Company";
-import { ProviderType } from "../ProviderType";
-import { ProviderScriptBlock } from "./ProviderScriptBlock";
-import { ProviderScriptParameter } from "./ProviderScriptParameter";
-/**
- * This class describes a type of logic applied to a provider.
- * A script will generate a file which is loaded onto a provider in the field.
- */
-export declare class ProviderScript extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal, IVisual {
-    /**
-     * 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 nickname given to this configuration
-     */
-    name: string;
-    /**
-     * Simple details about how the providers are expected to behave.
-     */
-    notes: string;
-    /**
-     * The fill/background colour of the icon.
-     */
-    fill: colour;
-    /**
-     * Outline and graphic colour.
-     */
-    stroke: colour;
-    /**
-     * The name of the symbol for this script.
-     */
-    graphic: codified;
-    /**
-     * Indicates whether this script is available to child companies.
-     */
-    global: boolean;
-    /**
-     * The type of provider for which this script can be used.
-     * Limiting to a specific model from a manufacturer is accomplished through the block conditions.
-     */
-    kind: ProviderType;
-    /**
-     * Blocks of file data which are (optionally) included in the script data file.
-     */
-    blocks: ProviderScriptBlock[];
-    /**
-     * Parameter definitions for this script, including type-hints and default values.
-     */
-    parameters: Map<string, ProviderScriptParameter>;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        fill: string;
-        stroke: string;
-        graphic: string;
-        global: boolean;
-        kind: ProviderType;
-        blocks: any[];
-        parameters: JsonObject;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}