@trakit/objects 0.0.1

package/Assets/Trailer.d.ts

@@ -0,0 +1,42 @@
+import { ushort } from '../API/Types';
+import { Asset } from './Asset';
+import { TrailerGeneral } from './TrailerGeneral';
+/**
+ * The full details of a Trailer, containing all the properties from the {@link TrailerGeneral} and {@link AssetAdvanced} objects.
+ */
+export declare class Trailer extends Asset {
+    /**
+     * General details about this vehicle.
+     */
+    get general(): TrailerGeneral;
+    /**
+     * Manufacturer's unique identification number for this trailer.
+     */
+    get serial(): string;
+    set serial(value: string);
+    /**
+     * The license plate.
+     */
+    get plate(): string;
+    set plate(value: string);
+    /**
+     * Manufacturer's name.
+     */
+    get make(): string;
+    set make(value: string);
+    /**
+     * Manufacturer's model name/number.
+     */
+    get model(): string;
+    set model(value: string);
+    /**
+     * Year of manufacturing.
+     */
+    get year(): ushort;
+    set year(value: ushort);
+    /**
+     * Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
+     */
+    get colour(): string;
+    set colour(value: string);
+}

package/Assets/TrailerGeneral.d.ts

@@ -0,0 +1,47 @@
+import { colour, ushort } from "../API/Types";
+import { AssetGeneral } from "./AssetGeneral";
+/**
+ * Seldom changing details about a trailer.
+ */
+export declare class TrailerGeneral extends AssetGeneral {
+    /**
+     * The license plate.
+     */
+    plate: string;
+    /**
+     * Manufacturer's unique identification number for this trailer.
+     */
+    serial: string;
+    /**
+     * Manufacturer's name.
+     */
+    make: string;
+    /**
+     * Manufacturer's model name/number.
+     */
+    model: string;
+    /**
+     * Year of manufacturing.
+     */
+    year: ushort;
+    /**
+     * Primary colour of the trailer (given in 24bit hex; #RRGGBB)
+     */
+    colour: colour;
+    toJSON(): {
+        suspended?: boolean | undefined;
+        since?: string | null | undefined;
+        references?: object | undefined;
+        messagingAddress?: string | undefined;
+        pictures?: number[] | undefined;
+        id: number | null;
+        v: number[];
+        company: number;
+        kind: import("./AssetType").AssetType;
+        name: string;
+        notes: string;
+        icon: number;
+        labels: string[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Assets/Vehicle.d.ts

@@ -0,0 +1,73 @@
+import { colour, double, ushort } from "../API/Types";
+import { Asset } from "./Asset";
+import { VehicleGeneral } from "./VehicleGeneral";
+import { VehicleAdvanced } from "./VehicleAdvanced";
+/**
+ * The full details of a Vehicle, containing all the properties from the {@link VehicleGeneral} and {@link VehicleAdvanced} objects.
+ */
+export declare class Vehicle extends Asset {
+    /**
+     * General details about this vehicle.
+     */
+    get general(): VehicleGeneral;
+    /**
+     * Advanced details about this vehicle.
+     */
+    get advanced(): VehicleAdvanced;
+    /**
+     * The license plate.
+     */
+    get plate(): string;
+    /**
+     * Manufacturer's unique identification number (Vehicle Identification Number).
+     */
+    get vin(): string;
+    set vin(value: string);
+    /**
+     * Manufacturer's name.
+     */
+    get make(): string;
+    set make(value: string);
+    /**
+     * Manufacturer's model name/number.
+     */
+    get model(): string;
+    set model(value: string);
+    /**
+     * Year of manufacturing.
+     */
+    get year(): ushort;
+    set year(value: ushort);
+    /**
+     * Primary colour of the trailer (given in 24bit hex; #RRGGBB)
+     */
+    get colour(): colour;
+    set colour(value: colour);
+    /**
+     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
+     */
+    get engineHours(): double;
+    set engineHours(value: double);
+    toJSON(): {
+        engineHours: number;
+        plate: string;
+        vin: string;
+        make: string;
+        model: string;
+        year: number;
+        colour: string;
+        id: number | null;
+        v: number[];
+        company: number;
+        kind: import("./AssetType").AssetType;
+        name: string;
+        notes: string;
+        icon: number;
+        labels: string[];
+        suspended?: boolean | undefined;
+        since?: string | null | undefined;
+        references?: object | undefined;
+        messagingAddress?: string | undefined;
+        pictures?: number[] | undefined;
+    };
+}

package/Assets/VehicleAdvanced.d.ts

@@ -0,0 +1,25 @@
+import { double } from "../API/Types";
+import { AssetAdvanced } from "./AssetAdvanced";
+/**
+ * Often changing details about a vehicle.
+ */
+export declare class VehicleAdvanced extends AssetAdvanced {
+    /**
+     * The cumulative duration that the vehicle's engine has been running (in decimal hours).
+     */
+    engineHours: double;
+    toJSON(): {
+        engineHours: number | null;
+        id: number | null;
+        v: number[];
+        company: number;
+        position: import("../API/Geography/Interfaces").IPosition | null;
+        odometer: number;
+        tags: string[];
+        attributes: object;
+        providers: string[];
+        relationships: number[];
+        places: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Assets/VehicleGeneral.d.ts

@@ -0,0 +1,33 @@
+import { colour, ushort } from "../API/Types";
+import { AssetGeneral } from "./AssetGeneral";
+/**
+ * Seldom changing details about a vehicle.
+ */
+export declare class VehicleGeneral extends AssetGeneral {
+    /**
+     * Manufacturer's unique identification number (Vehicle Identification Number).
+     */
+    vin: string;
+    /**
+     * The license plate.
+     */
+    plate: string;
+    /**
+     * Manufacturer's name.
+     */
+    make: string;
+    /**
+     * Manufacturer's model name/number.
+     */
+    model: string;
+    /**
+     * Year of manufacturing.
+     */
+    year: ushort;
+    /**
+     * Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
+     */
+    colour: colour;
+    toJSON(): any;
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Behaviours/Behaviour.d.ts

@@ -0,0 +1,79 @@
+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 { byte, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { BehaviourParameter } from "./BehaviourParameter";
+import { BehaviourScript } from "./BehaviourScript";
+/**
+ * The applied behaviour which includes all parameters and targets specific assets.
+*/
+export declare class Behaviour extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier of this behaviour.
+     */
+    id: ulong;
+    /**
+     * The company to which this behaviour belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this behaviour belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The script which this behaviour implements.
+     * {@link BehaviourScript.id}
+     */
+    scriptId: ulong;
+    /**
+     * The script which this behaviour implements.
+     * {@link BehaviourScript.id}
+     */
+    get script(): BehaviourScript;
+    /**
+     * The name of this behaviour.
+     */
+    name: string;
+    /**
+     * Notes.
+     */
+    notes: string;
+    /**
+     * The priority flag allows you to define an execution order for all behaviours for a provider.
+     */
+    priority: byte;
+    /**
+     * The search pattern used to target the assets which will embed this behaviour in their execution context.
+     */
+    targets: SearchPattern[] | null;
+    /**
+     * A search pattern used to filter the providers which can implement this behaviour.
+     */
+    filters: SearchPattern[] | null;
+    /**
+     * The list of defined variable name/value pairs for the script requires.
+     */
+    parameters: Map<string, BehaviourParameter>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number | null;
+        script: number | null;
+        name: string;
+        notes: string;
+        targets: string | null;
+        filters: string | null;
+        priority: number;
+        parameters: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Behaviours/BehaviourLog.d.ts

@@ -0,0 +1,97 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { uint, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { Behaviour } from "./Behaviour";
+import { BehaviourLogType } from "./BehaviourLogType";
+import { BehaviourScript } from "./BehaviourScript";
+/**
+ * A debug message available to script writers to help debug and trace output from a BehaviourScript.
+*/
+export declare class BehaviourLog extends BaseComponent implements IIdUlong, IBelongCompany, IBelongAsset {
+    /**
+     * Unique identifier of this log message.
+     */
+    id: ulong;
+    /**
+     * The asset which whose behaviours created this log entry.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The company to which this log message belongs.
+     * {@link Company.id}
+     */
+    get asset(): Asset;
+    /**
+     * The company to which this log message belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this log message belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The behaviour to which this log message belongs.
+     * {@link Behaviour.id}
+     */
+    behaviourId: ulong;
+    /**
+     * The behaviour to which this log message belongs.
+     * {@link Behaviour.id}
+     */
+    get behaviour(): Behaviour;
+    /**
+     * The script which generated this log message.
+     * {@link BehaviourScript.id}
+     */
+    scriptId: ulong;
+    /**
+     * The script which generated this log message.
+     * {@link BehaviourScript.id}
+     */
+    get script(): BehaviourScript;
+    /**
+     * The category of message.
+     */
+    kind: BehaviourLogType;
+    /**
+     * When the log entry was generated by the script.
+     */
+    dts: Date;
+    /**
+     * The body of the message.
+     */
+    message: string;
+    /**
+     * The line number of the script which generated this message.
+     */
+    line: uint;
+    /**
+     * The character column where the error was generated.
+     */
+    character: uint;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        asset: number | null;
+        company: number | null;
+        behaviour: number | null;
+        script: number | null;
+        kind: BehaviourLogType;
+        dts: string | null;
+        message: string;
+        line: number;
+        character: number;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Behaviours/BehaviourLogType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The type of logged message.
+ */
+export declare enum BehaviourLogType {
+    /**
+     * Used for general information messages.
+     */
+    log = "log",
+    /**
+     * Used for more important messages.
+     */
+    info = "info",
+    /**
+     * Used for warnings.
+     */
+    warn = "warn",
+    /**
+     * Used for errors.
+     */
+    err = "err"
+}

package/Behaviours/BehaviourParameter.d.ts

@@ -0,0 +1,37 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { BehaviourParameterType } from "./BehaviourParameterType";
+/**
+ * Definition of an argument passed to a Behaviour Script.
+*/
+export declare class BehaviourParameter implements ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: any): BehaviourParameter;
+    /**
+     * Simple type information for the compiler.
+     */
+    kind: BehaviourParameterType;
+    /**
+     * The value is given as a string, but parsed into native type when compiled.
+     */
+    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;
+    constructor(kind?: BehaviourParameterType, value?: string, notes?: string, context?: string);
+    toJSON(): {
+        kind: BehaviourParameterType;
+        value: string;
+        notes: string;
+        context: string;
+    };
+}

package/Behaviours/BehaviourParameterType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Possible data-types given to BehaviourParameters.
+ */
+export declare enum BehaviourParameterType {
+    /**
+     * True or false.
+     */
+    boolean = "boolean",
+    /**
+     * Numeric value (signed double-precision floating point number).
+     */
+    number = "number",
+    /**
+     * Text.
+     */
+    text = "text",
+    /**
+     * Object or array literal.
+     */
+    json = "json"
+}

package/Behaviours/BehaviourScript.d.ts

@@ -0,0 +1,84 @@
+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 { SearchPattern } from "../API/SearchPattern";
+import { codified, colour, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { BehaviourParameter } from "./BehaviourParameter";
+/**
+ * Business logic run by the system to react to GPS events and device information.
+ */
+export declare class BehaviourScript extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal, IVisual {
+    /**
+     * Unique identifier of this script.
+     */
+    id: ulong;
+    /**
+     * The company to which this script belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this script belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The nickname given to this script.
+     */
+    name: string;
+    /**
+     * Usage notes and instructions for users on how best to setup this script.
+     */
+    notes: string;
+    /**
+     * Indicates whether this script is available to child companies.
+     */
+    global: boolean;
+    /**
+     * The source code.
+     */
+    source: string;
+    /**
+     * A list of targeting expressions.  These expressions are defaults for derived Behaviours.
+     */
+    filters: SearchPattern[] | null;
+    /**
+     * Listed parameters for the Behaviour function.
+     */
+    parameters: Map<string, BehaviourParameter>;
+    /**
+     * The background colour given to this script for easy visual identification.
+     */
+    fill: colour;
+    /**
+     * The text/graphic colour given to this script for easy visual identification.
+     */
+    stroke: colour;
+    /**
+     * The codified graphic name given to this script for easy visual identification.
+     */
+    graphic: codified;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        global: boolean;
+        source: string;
+        filters: string | null;
+        parameters: object;
+        fill: string;
+        stroke: string;
+        graphic: string;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Billing/BillableBase.d.ts

@@ -0,0 +1,85 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongBillingProfile } from "../API/Interfaces/IBelongBillingProfile";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { double, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { BillingProfile } from "./BillingProfile";
+/**
+ * Most billable things share common attibutes.
+ */
+export declare abstract class BillableBase extends BaseComponent implements IIdUlong, INamed, IBelongBillingProfile, IBelongCompany {
+    /**
+     * Unique identifier of this hosting rule.
+     */
+    id: ulong;
+    /**
+     * Unique identifier of the Company that owns this hosting rule.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * Unique identifier of the Company that owns this hosting rule.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * Unique identifier of this rule's billing profile.
+     * {@link BillingProfile.id}
+     */
+    profileId: ulong;
+    /**
+     * Unique identifier of this rule's billing profile.
+     * {@link BillingProfile.id}
+     */
+    get profile(): BillingProfile;
+    /**
+     * The name of this billing rule.
+     */
+    name: string;
+    /**
+     * Notes about billing this rule.
+     */
+    notes: string;
+    /**
+     * A custom field used to refer to an external system.  Examples are a cost codes, SOCs, discount plans...
+     */
+    reference: string;
+    /**
+     * SKU or SOC code.
+     */
+    sku: string;
+    /**
+     * Date this billing rule takes effect.
+     * These dates are used to determine how much of the cycle is billed.
+     */
+    start: Date;
+    /**
+     * Date this billing rule is applied until; null means it never ends.
+     * These dates are used to determine how much of the cycle is billed.
+     */
+    end: Date;
+    /**
+     * Cost per cycle for this plan
+     */
+    amount: double;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        profile: number;
+        name: string;
+        notes: string;
+        reference: string;
+        sku: string;
+        start: string | null;
+        end: string | null;
+        amount: number | null;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Billing/BillableSmsProfile.d.ts

@@ -0,0 +1,26 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { double, uint } from "../API/Types";
+/**
+ * Description of a tiered SMS messaging limit
+ */
+export declare class BillableSmsProfile implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): BillableSmsProfile;
+    /**
+     * The maximum number of messages sent per cycle
+     */
+    limit: uint;
+    /**
+     * Cost per SMS message sent.
+     * Received messages are free.
+     */
+    amount: double;
+    constructor(limit?: uint, amount?: double);
+    toJSON(): {
+        limit: number | null;
+        amount: number | null;
+    };
+}

package/Billing/BillingCurrency.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Used for invoices.
+ */
+export declare enum BillingCurrency {
+    /**
+     * Canadian dollars
+     */
+    CAD = "CAD",
+    /**
+     * American dollars
+     */
+    USD = "USD",
+    /**
+     * Eurozone currency
+     */
+    EURO = "EURO"
+}