@trakit/objects 0.0.6 → 0.0.7

package/_publish/objects/Behaviours/BehaviourLog.d.ts

@@ -1,95 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { JsonObject, 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 {@link Asset} to which this log message belongs.
-     */
-    get asset(): Asset;
-    /**
-     * The company to which this log message belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this log message belongs.
-     */
-    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: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Behaviours/BehaviourLogType.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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/_publish/objects/Behaviours/BehaviourParameter.d.ts

@@ -1,38 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { BehaviourParameterType } from "./BehaviourParameterType";
-import { JsonObject } from "../API/Types";
-/**
- * Definition of an argument passed to a Behaviour Script.
-*/
-export declare class BehaviourParameter implements ISerializable {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: JsonObject): 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/_publish/objects/Behaviours/BehaviourParameterType.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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/_publish/objects/Behaviours/BehaviourScript.d.ts

@@ -1,83 +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 { SearchPattern } from "../API/SearchPattern";
-import { JsonObject, 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 {@link Company} to which this script belongs.
-     */
-    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: JsonObject;
-        fill: string;
-        stroke: string;
-        graphic: string;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Billing/BillableBase.d.ts

@@ -1,83 +0,0 @@
-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 { JsonObject, 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 {@link Company} that owns this hosting rule.
-     */
-    get company(): Company;
-    /**
-     * Unique identifier of this rule's billing profile.
-     * {@link BillingProfile.id}
-     */
-    profileId: ulong;
-    /**
-     * Unique identifier of this rule's {@link BillingProfile}.
-     */
-    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: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Billing/BillableSmsProfile.d.ts

@@ -1,26 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { double, uint, JsonObject } from "../API/Types";
-/**
- * Description of a tiered SMS messaging limit
- */
-export declare class BillableSmsProfile implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): 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/_publish/objects/Billing/BillingCurrency.d.ts

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

package/_publish/objects/Billing/BillingCycle.d.ts

@@ -1,17 +0,0 @@
-/**
- * The type of repeating cycle used for generating bills.
- */
-export declare enum BillingCycle {
-    /**
-     * Once a month
-     */
-    monthly = "monthly",
-    /**
-     * Every three months
-     */
-    quarterly = "quarterly",
-    /**
-     * Once per year
-     */
-    annually = "annually"
-}

package/_publish/objects/Billing/BillingProfile.d.ts

@@ -1,104 +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 { ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { BillableSmsProfile } from "./BillableSmsProfile";
-import { BillingCurrency } from "./BillingCurrency";
-import { BillingCycle } from "./BillingCycle";
-/**
- * A profile used to generate billable orders for a customer.
- */
-export declare class BillingProfile extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
-    /**
-     * Unique identifier of this billing profile
-     */
-    id: ulong;
-    /**
-     * Unique identifier of the Company that owns this profile and is sending the bill.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} that owns this profile and is sending the bill.
-     */
-    get company(): Company;
-    /**
-     * Unique identifier of the Company to which this rule pertains.
-     * {@link Company.id}
-     */
-    targetId: ulong;
-    /**
-     * Unique identifier of the {@link Company} to which this rule pertains.
-     */
-    get target(): Company;
-    /**
-     * Unique identifier of the Company receiving the bill.
-     * Most of the time, this value is the same as the target.
-     * {@link Company.id}
-     */
-    billeeId: ulong;
-    /**
-     * Unique identifier of the {@link Company} receiving the bill.
-     * Most of the time, this value is the same as the {@link target}.
-     */
-    get billee(): Company;
-    /**
-     * The name for this profile.
-     */
-    name: string;
-    /**
-     * Notes about the billing profile for the billee or target.
-     */
-    notes: string;
-    /**
-     * SMS messaging tiers
-     */
-    messages: BillableSmsProfile[];
-    /**
-     * Repeating cycle used for generating bills
-     */
-    cycle: BillingCycle;
-    /**
-     * When is the first day of the billing cycle
-     */
-    cycleStart: Date;
-    /**
-     * When should the cycle end (customer cancelled)
-     */
-    cycleEnd: Date;
-    /**
-     * Pro-rated, or post-dated.
-     */
-    cyclePostDated: boolean;
-    /**
-     * kind of money
-     */
-    currency: BillingCurrency;
-    /**
-     * Are the Google services available to be proxied by the service?
-     */
-    googleServicesEnabled: boolean;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        target: number;
-        billee: number;
-        name: string;
-        notes: string;
-        messages: any[];
-        cycle: BillingCycle;
-        currency: BillingCurrency;
-        cycleStart: string | null;
-        cycleEnd: string | null;
-        cyclePostDated: boolean;
-        googleServicesEnabled: boolean;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Billing/Hosting/BillableHostingBase.d.ts

@@ -1,41 +0,0 @@
-import { IBelongBillingProfile } from '../../API/Interfaces/IBelongBillingProfile';
-import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
-import { IIdUlong } from '../../API/Interfaces/IIdUlong';
-import { SearchPattern } from '../../API/SearchPattern';
-import { JsonObject, uint } from '../../API/Types';
-import { BillableBase } from '../BillableBase';
-/**
- * Hosted things share a lot of common attributes.
- */
-export declare abstract class BillableHostingBase extends BillableBase implements IIdUlong, IBelongBillingProfile, IBelongCompany {
-    /**
-     * The number of units to which this billing rule applies.
-     * Should be a non-zero value; NaN means unlimited.
-     */
-    limit: uint;
-    /**
-     * Which assets are targeted by this hosting rule.
-     */
-    targets: SearchPattern[] | null;
-    /**
-     * Does this hosting rule apply to suspended resources.
-     */
-    suspended: boolean;
-    toJSON(): {
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        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: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingLicense.d.ts

@@ -1,30 +0,0 @@
-import { JsonObject } from '../../API/Types';
-import { BillableHostingBase } from './BillableHostingBase';
-import { BillableHostingLicenseType } from './BillableHostingLicenseType';
-/**
- * A hardware license for providers
- */
-export declare class BillableHostingLicense extends BillableHostingBase {
-    /**
-     * The type of hardware license
-     */
-    kind: BillableHostingLicenseType;
-    toJSON(): {
-        kind: BillableHostingLicenseType;
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        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: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingLicenseType.d.ts

@@ -1,20 +0,0 @@
-/**
- * The kind of license being billed.
- */
-export declare enum BillableHostingLicenseType {
-    /**
-     * SmartWitness data hosting fee
-     * {@link ProviderType.smartwitness}
-     */
-    smartwitness = "smartwitness",
-    /**
-     * BeWhere license fee
-     * {@link ProviderType.bewhere}
-     */
-    bewhere = "bewhere",
-    /**
-     * CalAmp PULS fee
-     * {@link ProviderType.calamp}
-     */
-    calamp = "calamp"
-}

package/_publish/objects/Billing/Hosting/BillableHostingRule.d.ts

@@ -1,30 +0,0 @@
-import { JsonObject } from '../../API/Types';
-import { BillableHostingBase } from './BillableHostingBase';
-import { BillableHostingType } from './BillableHostingType';
-/**
- * A billing rule for assets
- */
-export declare class BillableHostingRule extends BillableHostingBase {
-    /**
-     * The type of service being billed.
-     */
-    service: BillableHostingType;
-    toJSON(): {
-        service: BillableHostingType;
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        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: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingType.d.ts

@@ -1,41 +0,0 @@
-/**
- * The kind of service being billed.
- */
-export declare enum BillableHostingType {
-    /**
-     * Employee/driver tracking.
-     */
-    mobile = "mobile",
-    /**
-     * Vehicle tracking (includes VBus data, and engine hours).
-     */
-    vehicle = "vehicle",
-    /**
-     * Generic dot-on-a-map tracking.
-     */
-    asset = "asset",
-    /**
-     * Tasks assignable to vehicles or persons.
-     */
-    dispatch = "dispatch",
-    /**
-     * FMCSA compliant E-Logs and Hours of Service.
-     */
-    elogs = "elogs",
-    /**
-     * Inventory management.
-     */
-    inventory = "inventory",
-    /**
-     * Cargo and delivery audit.
-     */
-    cargo = "cargo",
-    /**
-     * Mobile forms.
-     */
-    forms = "forms",
-    /**
-     * Dashcam and live images hosting.
-     */
-    streetview = "streetview"
-}