@trakit/objects 0.0.6 → 0.0.8

package/_publish/objects/Billing/Report/BillingReportServiceBreakdown.d.ts

@@ -1,124 +0,0 @@
-import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
-import { INamed } from "../../API/Interfaces/INamed";
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { codified, datetime, double, JsonObject, phone, ulong } from "../../API/Types";
-import { Asset } from "../../Assets/Asset";
-import { AssetType } from "../../Assets/AssetType";
-import { Provider } from "../../Providers/Provider";
-/**
- * Full breakdown of billable details per targeted asset.
- */
-export declare class BillingReportServiceBreakdown implements INamed, IBelongAsset, ISerializable {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: JsonObject): BillingReportServiceBreakdown;
-    /**
-     * The asset to which this breakdown instance belongs.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The {@link Asset} to which this breakdown instance belongs.
-     */
-    get asset(): Asset;
-    set asset(value: Asset);
-    /**
-     * Type of asset.
-     */
-    kind: AssetType;
-    /**
-     * Asset's name.
-     */
-    name: string;
-    /**
-     * Notes about the asset.
-     */
-    notes: string;
-    /**
-     * Indicates when this Asset was created.
-     */
-    created: Date;
-    /**
-     * Indicates when this Asset was deleted.
-     */
-    deleted: Date;
-    /**
-     * Indicates when this Asset wass suspended from event processing.
-     */
-    suspended: Date;
-    /**
-     * Indicates when this Asset was restored after being deleted.
-     */
-    restored: Date;
-    /**
-     * Indicates when this Asset was revived after being suspended.
-     */
-    revived: Date;
-    /**
-     * Codified label names.
-     * {@link LabelStyle.code}
-     */
-    labels: codified[];
-    /**
-     * The list of devices providing events for this asset.
-     * {@link Provider.id}
-     */
-    providerIds: string[];
-    /**
-     * The list of {@link Provider}s providing events for this asset.
-     */
-    get providers(): Provider[];
-    set providers(value: Provider[]);
-    /**
-     * The list of phone numbers for this asset.
-     */
-    phoneNumbers: phone[];
-    /**
-     * Indicates when this Asset was last updated.
-     */
-    updatedDts: Date;
-    /**
-     * Number of days this Asset is being billed for.
-     */
-    billableDays: double;
-    /**
-     * Cost per billing cycle for this asset.
-     */
-    cost: double;
-    /**
-     * Number of days this Asset was suspended.
-     */
-    suspendedDays: double;
-    /**
-     * Cost per billing cycle for suspended asset.
-     */
-    suspendedCost: double;
-    /**
-     * Total amount being billed for this asset.
-     */
-    total: double;
-    constructor(asset?: ulong, kind?: AssetType, name?: string, notes?: string, created?: Date | number | datetime, deleted?: Date | number | datetime, suspended?: Date | number | datetime, restored?: Date | number | datetime, revived?: Date | number | datetime, labels?: codified[], providers?: string[], phoneNumbers?: phone[], updatedDts?: Date | number | datetime, billableDays?: double, cost?: double, suspendedDays?: double, suspendedCost?: double, total?: double);
-    toJSON(): {
-        asset: number | null;
-        kind: AssetType;
-        name: string;
-        notes: string;
-        created: string | null;
-        deleted: string | null;
-        suspended: string | null;
-        restored: string | null;
-        revived: string | null;
-        labels: string[];
-        providers: string[];
-        phoneNumbers: number[];
-        revupdatedDtsived: string | null;
-        billableDays: number;
-        cost: number;
-        suspendedDays: number;
-        suspendedCost: number;
-        total: number;
-    };
-}

package/_publish/objects/Billing/Report/BillingReportStatus.d.ts

@@ -1,25 +0,0 @@
-/**
- * The lifetime of building a {@link BillingReport}.
- */
-export declare enum BillingReportStatus {
-    /**
-     * The {@link BillingReport} has been requested, but not yet begun processing.
-     */
-    created = "created",
-    /**
-     * The {@link BillingReport} is waiting for required resources to begin processing.
-     */
-    queued = "queued",
-    /**
-     * The {@link BillingReport} is currently being processed.
-     */
-    running = "running",
-    /**
-     * The {@link BillingReport} is available for retrieval.
-     */
-    completed = "completed",
-    /**
-     * There was an error processing the {@link BillingReport}; see the {@link BillingReport.error} for a description.
-     */
-    failed = "failed"
-}

package/_publish/objects/Billing/Report/BillingReportSummary.d.ts

@@ -1,49 +0,0 @@
-import { INamed } from "../../API/Interfaces/INamed";
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { JsonObject, ulong } from "../../API/Types";
-import { Company } from "../../Companies/Company";
-import { BillingReportHostingSummary } from "./BillingReportHostingSummary";
-/**
- * Summarized bill per target.
- */
-export declare class BillingReportSummary implements INamed, ISerializable {
-    static fromJSON(json: JsonObject): BillingReportSummary;
-    /**
-     * The target company to which this summary instance belongs.
-     * {@link Company.id}
-     */
-    targetId: ulong;
-    /**
-     * The target {@link Company} to which this summary instance belongs.
-     */
-    get target(): Company;
-    /**
-     * The target company's parent.
-     * {@link Company.id}
-     */
-    parentId: ulong;
-    /**
-     * The target {@link Company}'s parent.
-     */
-    get parent(): Company;
-    /**
-     * Target's name.
-     */
-    name: string;
-    /**
-     * Notes about the target.
-     */
-    notes: string;
-    /**
-     * Summary contains totals per type of hosting (services and licenses) for this target
-     */
-    hosting: BillingReportHostingSummary[];
-    constructor(target?: ulong, parent?: ulong, name?: string, notes?: string, hosting?: BillingReportHostingSummary[]);
-    toJSON(): {
-        target: number | null;
-        parent: number | null;
-        name: string;
-        notes: string;
-        hosting: any[];
-    };
-}

package/_publish/objects/Companies/NotificationServerSms.d.ts

@@ -1,25 +0,0 @@
-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/_publish/objects/Companies/PasswordExpiryMode.d.ts

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

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

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

@@ -1,56 +0,0 @@
-import { IIdUlong } from '../../API/Interfaces/IIdUlong';
-import { INamed } from '../../API/Interfaces/INamed';
-import { ISerializable } from '../../API/Interfaces/ISerializable';
-import { JsonObject, nothing, ulong } from '../../API/Types';
-import { FormFieldType } from '../FormFieldType';
-/**
- * A base class for the common form field UI members.
- */
-export declare abstract class FormFieldBase implements IIdUlong, INamed, ISerializable {
-    /**
-     * Instantiates a form field subclass based on the `kind` property in the JSON.
-     * Implementation is in {@link FormFieldBase_fromJSON.ts}
-     * @param json	The JSON to parse.
-     * @returns		An instance of a form field subclass, or null if the JSON is null or does not contain a recognized "kind" property.
-     */
-    static fromJSON: (json: JsonObject) => FormFieldBase;
-    /**
-     * A list of supported {@link FormFieldType}s that this class supports.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The type of interface control that should be presented to the user.
-     */
-    kind: FormFieldType;
-    /**
-     * Identifier for this field.
-     * This value is unique per {@link FormTemplate}, but is not unique system-wide.
-     */
-    id: ulong;
-    /**
-     * Name of the field.
-     */
-    name: string;
-    /**
-     * Notes or special instructions for this control.
-     */
-    notes: string;
-    /**
-     * When true, a valid value must be given for this field.
-     */
-    required: boolean;
-    /**
-     * The default value for the field in the template.
-     */
-    value: string | null;
-    /**
-     * When false, this field's value is treated as read-only.
-     */
-    editable: boolean;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): JsonObject;
-    /**
-     * Returns true if the value can be parsed by the field type.
-     */
-    abstract isValid(value: string): boolean;
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,38 +0,0 @@
-import { nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A true/false (or either-or) input control.
- * @tutorial
- * For choices, the field definition will be an array of three values.
- * The first value is the "true", second is the "false", and third is "indeterminate".
- * For example:
- * - "true", "false", ""
- * - "on", "off", "unknown"
- * - "yes", "no", "maybe"
- */
-export declare class FormFieldBoolean extends FormFieldBase {
-    /**
-     * If no choices are given, then these choices are used.
-     */
-    static readonly DEFAULT_CHOICES: [string, string, string];
-    /**
-     * Returns an array of 3 strings representing the checked, unchecked, and indeterminate values.
-     * @param choices
-     */
-    static normalize(choices?: (string | nothing)[] | nothing): [string, string, string];
-    /**
-     * These are the boolean control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * These three values are the values of the choices presented.
-     * The first value is the "checked" value, second is the "unchecked" value, and third is "indeterminate" value.
-     */
-    choices: [string, string, string];
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: (string | nothing)[] | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        choices: string[];
-    };
-    isValid(value: string): boolean;
-}

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

@@ -1,46 +0,0 @@
-import { byte, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A single- or multiple-choice input control.
- */
-export declare class FormFieldChoice extends FormFieldBase {
-    /**
-     * Splits the given value using commas (so long as the comma did not get escaped).
-     * @param values
-     */
-    static split(values: string): string[];
-    /**
-     * Replaces all the commas in a given value with backslash-comma.
-     * @param value
-     */
-    static escape(value: string): string;
-    /**
-     * Replaces all the commas in a given value with backslash-comma.
-     * @param value
-     */
-    static unescape(value: string): string;
-    /**
-     * Just {@link FormFieldType.choice} control type.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The list of choices available and their values.
-     */
-    choices: Map<string, string>;
-    /**
-     * Minimum number of choices that must be selected.
-     */
-    minimum: byte;
-    /**
-     * Maximum number of choices that must be selected.
-     */
-    maximum: byte;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: Map<string, string> | nothing, minimum?: byte | nothing, maximum?: byte | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        choices: import("../../..").JsonObject;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

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

@@ -1,26 +0,0 @@
-import { datetime, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-/**
- * A control to choose a date and (optionally) a time.
- */
-export declare class FormFieldDate extends FormFieldBase {
-    /**
-     * These are the calendar control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * The earliest date or date/time.
-     */
-    minimum: Date;
-    /**
-     * The latest date or date/time.
-     */
-    maximum: Date;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: Date | number | datetime | nothing, maximum?: Date | number | datetime | 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/FormFieldNumeric.d.ts

@@ -1,54 +0,0 @@
-import { byte, double, nothing, ulong } from "../../API/Types";
-import { FormFieldType } from "../FormFieldType";
-import { FormFieldBase } from "./FormFieldBase";
-import { FormFieldNumericSize } from "./FormFieldNumericSize";
-/**
- * A numeric value input control with multiple contexts available.
- * @tutorial
- * For this field, the {@link FormFieldBase.kind} is just a helper for the UI, and does not affect input validation.
- */
-export declare class FormFieldNumeric extends FormFieldBase {
-    /**
-     * These are the numeric control types.
-     */
-    protected get supported(): FormFieldType[];
-    /**
-     * A context hint for the kind of numeric size for this field.
-     * Used only for {@link FormFieldType.distance}, {@link FormFieldType.weight}, {@link FormFieldType.volume},
-     * and {@link FormFieldType.speed}.
-     */
-    size: FormFieldNumericSize;
-    /**
-     * Number of decimal places of accuracy are required.
-     */
-    precision: byte;
-    /**
-     * The numeric value increments by this amount.
-     */
-    step: double;
-    /**
-     * An optional suffix for this numeric value, like "%" or "ppm".
-     * This value is ignored for {@link FormFieldType.distance}, {@link FormFieldType.weight},
-     *  {@link FormFieldType.volume}, {@link FormFieldType.speed}, and {@link FormFieldType.area} field types.
-     * And for {@link FormFieldType.currency} fields it acts as a prefix, like "$" or "USD".
-     */
-    units: string;
-    /**
-     * The (optional) minimum value.
-     */
-    minimum: double;
-    /**
-     * The (optional) maximum value.
-     */
-    maximum: double;
-    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, size?: FormFieldNumericSize | nothing, precision?: byte | nothing, step?: double | nothing, units?: string | nothing, minimum?: double | nothing, maximum?: double | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
-    toJSON(): {
-        size: FormFieldNumericSize;
-        precision: number | null;
-        step: number | null;
-        units: string;
-        minimum: number | null;
-        maximum: number | null;
-    };
-    isValid(value: string): boolean;
-}

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

@@ -1,32 +0,0 @@
-/**
- * A context hint for the size of a measurements.
- */
-export declare enum FormFieldNumericSize {
-    /**
-     * A small measurement.
-     * For {@link FormFieldType.distance}: {@link Units.CENTIMETER}/{@link Units.INCH}
-     * For {@link FormFieldType.weight}: {@link Units.GRAM}/{@link Units.OUNCE}
-     * For {@link FormFieldType.volume}: {@link Units.MILLILITER}/{@link Units.OUNCE}
-     * For {@link FormFieldType.speed}: {@link Units.CENTIMETER_PER_SECOND}/{@link Units.INCH_PER_SECOND}
-     * For {@link FormFieldType.area}: {@link Units.SQUARE_METRE}/{@link Units.SQUARE_FOOT}
-     */
-    small = "small",
-    /**
-     * A medium measurement.
-     * For {@link FormFieldType.distance}: {@link Units.METER}/{@link Units.FOOT}
-     * For {@link FormFieldType.weight}: {@link Units.KILOGRAM}/{@link Units.POUND}
-     * For {@link FormFieldType.volume}: same as {@link FormFieldNumericSize.small}
-     * For {@link FormFieldType.speed}: {@link Units.METER_PER_SECOND}/{@link Units.FOOT_PER_SECOND}
-     * For {@link FormFieldType.area}: {@link Units.SQUARE_KILOMETRE}/{@link Units.SQUARE_MILE}
-     */
-    medium = "medium",
-    /**
-     * A large measurement.
-     * For {@link FormFieldType.distance}: {@link Units.KILOMETER}/{@link Units.MILE}
-     * For {@link FormFieldType.weight}: {@link Units.TONNE}/{@link Units.TON}
-     * For {@link FormFieldType.volume}: {@link Units.LITER}/{@link Units.GALLON}
-     * For {@link FormFieldType.speed}: {@link Units.KILOMETER_PER_HOUR}/{@link Units.MILE_PER_HOUR}
-     * For {@link FormFieldType.area}: {@link Units.HECTARE}/{@link Units.ACRE}
-     */
-    large = "large"
-}

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

@@ -1,17 +0,0 @@
-import { nothing, ulong } from '../../API/Types';
-import { FormFieldType } from '../FormFieldType';
-import { FormFieldBase } from './FormFieldBase';
-/**
- * A control to capture a signature from the user.
- * @tutorial
- * The device making the capture must save the image to the server some other way.
- * When submitting the {@link FormResult}, the value must be a path to the signature file.
- */
-export declare class FormFieldSignature extends FormFieldBase {
-    /**
-     * Just {@link FormFieldType.signature} 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;
-}