@trakit/objects 0.0.6 → 0.0.8

package/_publish/Providers/Configuration/ProviderConfigurationType.d.ts

@@ -1,62 +0,0 @@
-import { BaseComponent } from "../../API/BaseComponent";
-import { IIdUlong } from "../../API/Interfaces/IIdUlong";
-import { INamed } from "../../API/Interfaces/INamed";
-import { JsonObject, uint, ulong } from "../../API/Types";
-import { PlaceType } from "../../Places/PlaceType";
-import { ProviderType } from "../ProviderType";
-import { ProviderConfigurationNode } from "./ProviderConfigurationNode";
-/**
- * This read-only class describes a type of logic applied to a provider.
- * ProviderConfigurationTypes are used to help define a ProviderConfiguration.
- * @deprecated Use ProviderScript instead
- */
-export declare class ProviderConfigurationType extends BaseComponent implements IIdUlong, INamed {
-    /**
-     * Unique identifier.
-     */
-    id: ulong;
-    /**
-     * Name of the configuration type.
-     */
-    name: string;
-    /**
-     * Notes regarding the use of this configuration.
-     */
-    notes: string;
-    /**
-     * The applicable type of provider for which this configuration type can be created.
-     */
-    providerType: ProviderType;
-    /**
-     * The maximum number of geofences that can be programmed onto a device. This number changes based on device make and model, and can also change based on the supported geofence types.
-     */
-    maxGeofenceCount: uint;
-    /**
-     * The minimum number of geofences that need to be programmed onto the device. This value is almost always zero.
-     */
-    minGeofenceCount: uint;
-    /**
-     * A tree-structure of configurations required (or optionally available) for programming a device.
-     */
-    scriptOptions: Map<string, ProviderConfigurationNode>;
-    /**
-     * A list of supported types of geofences which can be programmed directly onto the device.
-     */
-    geofenceTypes: PlaceType[];
-    toJSON(): {
-        id: number;
-        v: number[];
-        name: string;
-        notes: string;
-        providerType: ProviderType;
-        maxGeofenceCount: number | null;
-        minGeofenceCount: number | null;
-        scriptOptions: JsonObject;
-        geofenceTypes: PlaceType[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Providers/Configuration/ProviderGeofenceBase.d.ts

@@ -1,29 +0,0 @@
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { JsonObject, uint } from "../../API/Types";
-import { PlaceType } from "../../Places/PlaceType";
-/**
- * An abstract class used as a base for all Geofence type classes.
- * @deprecated
- */
-export declare abstract class ProviderGeofenceBase implements ISerializable {
-    /**
-     * Instantiates a geofence based on the `type` property in the given JSON.
-     * Implementation is in {@link ProviderGeofenceBase_fromJSON.ts}
-     * @param json	The JSON to parse.
-     * @returns		An instance of a {@link ProviderGeofenceBase} subclass.
-     */
-    static fromJSON: (json: JsonObject) => ProviderGeofenceBase;
-    /**
-     * The supported shape of geofence.
-     */
-    abstract get type(): PlaceType;
-    /**
-     * The maximum number of unique geofences supported by the device.
-     */
-    maxGeofenceCount: uint;
-    constructor(maxGeofenceCount?: uint);
-    toJSON(): {
-        type: PlaceType;
-        maxGeofenceCount: number;
-    };
-}

package/_publish/Providers/Configuration/ProviderGeofenceBase_fromJSON.d.ts

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

package/_publish/Providers/Configuration/ProviderGeofenceCircular.d.ts

@@ -1,28 +0,0 @@
-import { uint } from "../../API/Types";
-import { PlaceType } from "../../Places/PlaceType";
-import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
-/**
- * A geofence defined by a centre coordinate and a threshold value to indicate the boundary around that point.
- * @deprecated
- */
-export declare class ProviderGeofenceCircular extends ProviderGeofenceBase {
-    /**
-     * Distance from a central point.
-     */
-    get type(): PlaceType;
-    /**
-     * The smallest possible radius for this geofence.
-     */
-    minRadius: uint;
-    /**
-     * The largest possible radius for this geofence.
-     */
-    maxRadius: uint;
-    constructor(maxGeofenceCount?: uint, minRadius?: uint, maxRadius?: uint);
-    toJSON(): {
-        minRadius: number | null;
-        maxRadius: number | null;
-        type: PlaceType;
-        maxGeofenceCount: number;
-    };
-}

package/_publish/Providers/Configuration/ProviderGeofencePoint.d.ts

@@ -1,12 +0,0 @@
-import { PlaceType } from "../../Places/PlaceType";
-import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
-/**
- * This is a point and not a geofence, so I don't know why this is defined.
- * @deprecated
- */
-export declare class ProviderGeofencePoint extends ProviderGeofenceBase {
-    /**
-     * Not a boundary, so the modem must use its own internal threshold.
-     */
-    get type(): PlaceType;
-}

package/_publish/Providers/Configuration/ProviderGeofencePolygon.d.ts

@@ -1,23 +0,0 @@
-import { uint } from "../../API/Types";
-import { PlaceType } from "../../Places/PlaceType";
-import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
-/**
- * A geofence whose boundary is defined by a non-overlapping series of coordinates.
- * @deprecated
- */
-export declare class ProviderGeofencePolygon extends ProviderGeofenceBase {
-    /**
-     * Complex geofence.
-     */
-    get type(): PlaceType;
-    /**
-     * The maximum number of vertices supported by the device.
-     */
-    maxVertices: uint;
-    constructor(maxGeofenceCount?: uint, maxVertices?: uint);
-    toJSON(): {
-        maxVertices: number | null;
-        type: PlaceType;
-        maxGeofenceCount: number;
-    };
-}

package/_publish/Providers/Configuration/ProviderGeofenceRectangle.d.ts

@@ -1,28 +0,0 @@
-import { int, uint } from "../../API/Types";
-import { PlaceType } from "../../Places/PlaceType";
-import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
-/**
- * A geofence whose boundary is a "rectangle" defined by corner coordinates.
- * @deprecated
- */
-export declare class ProviderGeofenceRectangle extends ProviderGeofenceBase {
-    /**
-     * Boundaries defined with only two coordinates.
-     */
-    get type(): PlaceType;
-    /**
-     * The smallest possible diameter for this geofence.
-     */
-    maxLength: uint;
-    /**
-     * The smallest possible diameter for this geofence.
-     */
-    maxWidth: uint;
-    constructor(maxGeofenceCount?: uint, maxLength?: int, maxWidth?: int);
-    toJSON(): {
-        maxLength: number | null;
-        maxWidth: number | null;
-        type: PlaceType;
-        maxGeofenceCount: number;
-    };
-}

package/_publish/Providers/Provider.d.ts

@@ -1,211 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { BaseCompound } from "../API/BaseCompound";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { INamed } from "../API/Interfaces/INamed";
-import { ISuspendable } from "../API/Interfaces/ISuspendable";
-import { JsonObject, ipv4, phone, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { ProviderConfig } from "./Config/ProviderConfig";
-import { ProviderConfiguration } from "./Configuration/ProviderConfiguration";
-import { ProviderAdvanced } from "./ProviderAdvanced";
-import { ProviderCommand } from "./ProviderCommand";
-import { ProviderCommandType } from "./ProviderCommandType";
-import { ProviderControl } from "./ProviderControl";
-import { ProviderData } from "./ProviderData";
-import { ProviderGeneral } from "./ProviderGeneral";
-import { ProviderType } from "./ProviderType";
-/**
- * A device, modem, or service which provides events from the field.
- */
-export declare class Provider extends BaseCompound implements INamed, IBelongCompany, ISuspendable {
-    #private;
-    /**
-     *
-     */
-    get pieces(): BaseComponent[];
-    /**
-     * Unique identifier of this device.
-     * {@link Asset.id}
-     */
-    get id(): string;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    get companyId(): ulong;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    set company(value: Company);
-    /**
-     * The kind of communication protocol this device uses.
-     */
-    get kind(): ProviderType;
-    get general(): ProviderGeneral;
-    /**
-     * This thing's name.
-     */
-    get name(): string;
-    set name(value: string);
-    /**
-     * Notes about it.
-     */
-    get notes(): string;
-    set notes(value: string);
-    /**
-     * The asset for which this device provides field data.
-     * {@link Asset.id}
-     */
-    get assetId(): ulong;
-    set assetId(value: ulong);
-    /**
-     * The asset for which this device provides field data.
-     * {@link Asset.id}
-     */
-    get asset(): Asset;
-    set asset(value: Asset);
-    /**
-     * The provider's current (or pending) configuration profile.
-     * {@link ProviderConfig.id}
-     * {@link ProviderConfiguration.id}
-     */
-    get configurationId(): ulong;
-    set configurationId(value: ulong);
-    /**
-     * The provider's current (or pending) configuration profile.
-     * {@link ProviderConfig.id}
-     * {@link ProviderConfiguration.id}
-     */
-    get configuration(): ProviderConfig | ProviderConfiguration;
-    set configuration(value: ProviderConfig | ProviderConfiguration);
-    /**
-     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
-     */
-    get password(): string;
-    set password(value: string);
-    /**
-     * The firmware/application version number.
-     */
-    get firmware(): string;
-    set firmware(value: string);
-    /**
-     * The phone number of this device.
-     */
-    get phoneNumber(): phone;
-    set phoneNumber(value: phone);
-    /**
-     * A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
-     */
-    get information(): Map<string, string>;
-    set information(value: Map<string, string>);
-    /**
-     * ICCID of the SIM card installed in this provider
-     */
-    get sim(): string;
-    set sim(value: string);
-    get advanced(): ProviderAdvanced;
-    /**
-     * The last IP address of the device.
-     */
-    get lastIP(): ipv4;
-    set lastIP(value: ipv4);
-    /**
-     * Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
-     */
-    get attributes(): Map<string, Map<string, ProviderData>>;
-    set attributes(value: Map<string, Map<string, ProviderData>>);
-    /**
-     * Store-and-forward information like last sequence number of SnF window
-     */
-    get snf(): Map<string, string>;
-    set snf(value: Map<string, string>);
-    get control(): ProviderControl;
-    /**
-     * Collection of commands for this provider.
-     */
-    get commands(): Map<ProviderCommandType, ProviderCommand>;
-    set commands(value: Map<ProviderCommandType, ProviderCommand>);
-    toJSON(): {
-        suspended: boolean;
-        since: string | null;
-        id: string | null;
-        v: number[];
-        company: number | null;
-        name: string;
-        notes: string;
-        kind: ProviderType;
-        configuration: number | null;
-    } | {
-        asset: number | null;
-        password: string;
-        firmware: string;
-        phoneNumber: number | null;
-        information: JsonObject;
-        sim: string;
-        id: string | null;
-        v: number[];
-        company: number | null;
-        name: string;
-        notes: string;
-        kind: ProviderType;
-        configuration: number | null;
-    } | {
-        control: {
-            id: string | null;
-            v: number[];
-            company: number | null;
-            commands: JsonObject;
-        };
-        v: number[];
-        id: string | null;
-        company: number;
-        lastIP: string;
-        attributes: JsonObject;
-        snf: JsonObject;
-        suspended: boolean;
-        since: string | null;
-        name: string;
-        notes: string;
-        kind: ProviderType;
-        configuration: number | null;
-    } | {
-        control: {
-            id: string | null;
-            v: number[];
-            company: number | null;
-            commands: JsonObject;
-        };
-        v: number[];
-        id: string | null;
-        company: number;
-        lastIP: string;
-        attributes: JsonObject;
-        snf: JsonObject;
-        asset: number | null;
-        password: string;
-        firmware: string;
-        phoneNumber: number | null;
-        information: JsonObject;
-        sim: string;
-        name: string;
-        notes: string;
-        kind: ProviderType;
-        configuration: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): string;
-    /**
-     * Indicates whether this object is suspended from event processing.
-     */
-    get suspended(): boolean;
-    /**
-     * Timestamp from the action that deleted or suspended this object.
-     */
-    get since(): Date;
-}

package/_publish/Providers/ProviderAdvanced.d.ts

@@ -1,51 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { JsonObject, ipv4, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { ProviderData } from "./ProviderData";
-/**
- * Device/hardware information reported from the field.
- */
-export declare class ProviderAdvanced extends BaseComponent implements IBelongCompany {
-    /**
-     * Unique identifier of this device.
-     * {@link Provider.id}
-     */
-    id: string;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    set company(value: Company);
-    /**
-     * The last IP address of the device.
-     */
-    lastIP: ipv4;
-    /**
-     * Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
-     */
-    attributes: Map<string, Map<string, ProviderData>>;
-    /**
-     * Store-and-forward information like last sequence number of SnF window
-     */
-    snf: Map<string, string>;
-    toJSON(): {
-        id: string | null;
-        v: number[];
-        company: number;
-        lastIP: string;
-        attributes: JsonObject;
-        snf: JsonObject;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): string;
-}

package/_publish/Providers/ProviderCommand.d.ts

@@ -1,36 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, JsonObject } from "../API/Types";
-import { ProviderCommandStatus } from "./ProviderCommandStatus";
-/**
- * Details regarding a provider command
- */
-export declare class ProviderCommand implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): ProviderCommand;
-    /**
-     * Current status of this command.
-     */
-    status: ProviderCommandStatus;
-    /**
-     * Command message body.
-     */
-    parameters: string[];
-    /**
-     * Date/time stamp of when the command was created.
-     */
-    created: Date;
-    /**
-     * Date/time stamp of when the command was processed.
-     */
-    processed: Date;
-    constructor(status?: ProviderCommandStatus, parameters?: string[], created?: Date | number | datetime, processed?: Date | number | datetime);
-    toJSON(): {
-        status: ProviderCommandStatus;
-        parameters: string[];
-        created: string | null;
-        processed: string | null;
-    };
-}

package/_publish/Providers/ProviderCommandStatus.d.ts

@@ -1,29 +0,0 @@
-/**
- * Progress lifetime of command for the device/modem.
- */
-export declare enum ProviderCommandStatus {
-    /**
-     * The new command has been created, but not yet sent to the provider.
-     */
-    created = "created",
-    /**
-     * Command was processed and sent to the provider.
-     */
-    pending = "pending",
-    /**
-     * Provider is taking some action related to this command. eg. Checking in for config update or getting tasks list.
-     */
-    inProgress = "inProgress",
-    /**
-     * Command was successfully processed by the provider.
-     */
-    completed = "completed",
-    /**
-     * Something went wrong while trying to send or process the command.
-     */
-    failed = "failed",
-    /**
-     * Sending of the new command was halted by a user.
-     */
-    cancelled = "cancelled"
-}

package/_publish/Providers/ProviderControl.d.ts

@@ -1,42 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { JsonObject, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { ProviderCommand } from "./ProviderCommand";
-import { ProviderCommandType } from "./ProviderCommandType";
-/**
- * Managing communication with Device/hardware.
- */
-export declare class ProviderControl extends BaseComponent implements IBelongCompany {
-    /**
-     * Unique identifier of this device.
-     * {@link Provider.id}
-     */
-    id: string;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this device belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    set company(value: Company);
-    /**
-     * Collection of commands for this provider.
-     */
-    commands: Map<ProviderCommandType, ProviderCommand>;
-    toJSON(): {
-        id: string | null;
-        v: number[];
-        company: number | null;
-        commands: JsonObject;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): string;
-}

package/_publish/Providers/ProviderData.d.ts

@@ -1,30 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, JsonObject } from "../API/Types";
-/**
- * A fragment of data given by a device.
- */
-export declare class ProviderData implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): ProviderData;
-    /**
-     * The value of the data given like true, 17.3, "asdf", etc...
-     */
-    value: any;
-    /**
-     * Date/time stamp from when the device recorded (or reported) the data.
-     */
-    dts: Date;
-    /**
-     * The relevant unit for the data provided like Km/h, degrees, volts, RPM, etc...
-     */
-    unit: string;
-    constructor(value?: any, dts?: Date | number | datetime, unit?: string);
-    toJSON(): {
-        value: any;
-        dts: string | null;
-        unit: string;
-    };
-}