@trakit/objects 0.0.6 → 0.0.7

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;
-}

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

@@ -1,41 +0,0 @@
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { JsonObject } from "../../API/Types";
-/**
- * A chunk of script and variables used to assemble a working ProviderScript.
- */
-export declare class ProviderScriptBlock implements ISerializable {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: JsonObject): ProviderScriptBlock;
-    /**
-     * A chunk of the file loaded onto a provider with it's variables replaced with configurable variables.
-     * Trailing or leading whitespace should be included here, so when blocks are merged, so too is the newline characters.
-     */
-    content: string;
-    /**
-     * A regular expression used to match variables in the content.
-     * The regex must contain at least one match-group.
-     * The value fom the last group is what's used as a parameter name.
-     * @example {{([a-z]+)}}
-     * @example <(var[a-z]+)>
-     */
-    replace: string;
-    /**
-     * When defined, this condition matches a {@link ProviderScriptParameter} defined in the {@link ProviderConfig} to include or exclude this chunk from the script.
-     */
-    condition: string;
-    /**
-     * Used in conjunction with condition, this value must match the given ProviderScriptParameter value to have the chunk included.
-     */
-    validate: string;
-    constructor(content?: string, replace?: string, condition?: string, validate?: string);
-    toJSON(): {
-        content: string;
-        replace: string;
-        condition: string;
-        validate: string;
-    };
-}

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

@@ -1,49 +0,0 @@
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { uint, JsonObject } from "../../API/Types";
-import { ProviderScriptParameterType } from "./ProviderScriptParameterType";
-/**
- * Definition of an argument passed to a ProviderScript.
- */
-export declare class ProviderScriptParameter implements ISerializable {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: JsonObject): ProviderScriptParameter;
-    /**
-     * Simple type information for the gateway to process.
-     */
-    kind: ProviderScriptParameterType;
-    /**
-     * The value is given as a string, but parsed into native type when used by the gateway.
-     */
-    value: string;
-    /**
-     * Usage notes.
-     */
-    notes: string;
-    /**
-     * Gives a hint to the client on the best UI to use for editing.
-     * For example, "checkbox" is a good UI hint for boolean parameter types.
-     */
-    context: string;
-    /**
-     * The order in which this parameter is displayed compared to other parameters.
-     * The value has no effect on how this parameter is inserted into the ProviderScriptBlocks.
-     */
-    order: uint;
-    /**
-     * Used as a hint that this parameter controls an advanced script option and should only be set if you really know what you're doing.
-     */
-    advanced: boolean;
-    constructor(kind?: ProviderScriptParameterType, value?: string, notes?: string, context?: string, order?: uint, advanced?: boolean);
-    toJSON(): {
-        kind: ProviderScriptParameterType;
-        value: string;
-        notes: string;
-        context: string;
-        order: number;
-        advanced: boolean;
-    };
-}

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

@@ -1,17 +0,0 @@
-/**
- * Possible data-types given to ProviderScriptParameter.
- */
-export declare enum ProviderScriptParameterType {
-    /**
-     * True or false.
-     */
-    boolean = "boolean",
-    /**
-     * Numeric value (double-precision floating point number).
-     */
-    number = "number",
-    /**
-     * Text.
-     */
-    text = "text"
-}

package/_publish/objects/Providers/Configuration/ProviderConfiguration.d.ts

@@ -1,66 +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 { JsonObject, ulong } from "../../API/Types";
-import { Company } from "../../Companies/Company";
-import { ProviderConfigurationType } from "./ProviderConfigurationType";
-/**
- * The configured logic loaded onto the provider over-the-air to control it's reporting schedule and behaviour.
- * @deprecated Use {@link ProviderConfig} instead.
- */
-export declare class ProviderConfiguration 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 nickname given to this configuration
-     */
-    name: string;
-    /**
-     * Simple details about how the providers are expected to behave.
-     */
-    notes: string;
-    /**
-     * The logic type which this configuration implements.
-     * {@link ProviderConfigurationType.id}
-     */
-    typeId: ulong;
-    /**
-     * The {@link ProviderConfigurationType} which this configuration implements.
-     */
-    get type(): ProviderConfigurationType;
-    /**
-     * The list of defined variables given to the {@link ProviderConfigurationType.scriptOptions|logic type's options} pairs for the logic type requires.
-     */
-    scriptParameters: Map<string, any>;
-    /**
-     * List of Places loaded directly onto the provider.
-     */
-    geofences: ulong[];
-    toJSON(): {
-        id: number;
-        company: number;
-        v: number[];
-        name: string;
-        notes: string;
-        type: number | null;
-        scriptParameters: JsonObject;
-        geofences: number[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Providers/Configuration/ProviderConfigurationNode.d.ts

@@ -1,66 +0,0 @@
-import { ISerializable } from '../../API/Interfaces/ISerializable';
-import { JsonObject } from '../../API/Types';
-/**
- * This tree-like structure is given to the script processor for the device type so that the device can follow a program.
- * @deprecated Use ProviderScriptBlock instead
- */
-export declare class ProviderConfigurationNode implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static nodesFromJSON(json: JsonObject): Map<string, ProviderConfigurationNode>;
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): ProviderConfigurationNode;
-    /**
-     * Indicates that this configuration is an advanced property and should only be set by someone who knows what they're doing.
-     */
-    isAdvanced: boolean;
-    /**
-     * Unique identifier of the value being mapped.
-     */
-    id: string;
-    /**
-     * The value being set.
-     */
-    value: any;
-    /**
-     * The minimum possible value for this confugration node.
-     */
-    min: any;
-    /**
-     * The maximum possible value for this confugration node.
-     */
-    max: any;
-    /**
-     * Type hint used by the script processor to help format the value.
-     */
-    type: string;
-    /**
-     * Unit hint used to help the script processor format the value.
-     */
-    unit: string;
-    /**
-     * Description of what this configuration does when mapped to a device.
-     */
-    notes: string;
-    /**
-     * Child configuration nodes.
-     */
-    nodes: Map<string, ProviderConfigurationNode>;
-    constructor(id?: string, notes?: string, isAdvanced?: boolean, type?: string, min?: any, max?: any, value?: any, unit?: string, nodes?: Map<string, ProviderConfigurationNode>);
-    toJSON(): {
-        id: string;
-        value: any;
-        min: any;
-        max: any;
-        type: string;
-        unit: string;
-        notes: string;
-        isAdvanced: boolean;
-        nodes: JsonObject;
-    };
-}

package/_publish/objects/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/objects/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/objects/Providers/Configuration/ProviderGeofenceBase_fromJSON.d.ts

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

package/_publish/objects/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/objects/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/objects/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/objects/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;
-    };
-}