@trakit/objects 0.0.14 → 0.0.16

package/objects/Providers/ProviderGeneral.d.ts

@@ -0,0 +1,121 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { INamed } from "../API/Interfaces/INamed";
+import { ISuspendable } from "../API/Interfaces/ISuspendable";
+import { JsonObject, 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 { ProviderType } from "./ProviderType";
+/**
+ * Device/hardware information and configuration.
+ */
+export declare class ProviderGeneral extends BaseComponent implements INamed, IBelongCompany, ISuspendable {
+    /**
+     * Unique identifier of this device.
+     * {@link Provider.id}
+     */
+    id: string;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this device belongs.
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * A nickname given to the device/hardware.
+     */
+    name: string;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The kind of communication protocol this device uses.
+     */
+    kind: ProviderType;
+    /**
+     * The asset for which this device provides field data.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} for which this device provides field data.
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * The provider's current (or pending) configuration profile.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    configurationId: ulong;
+    /**
+     * The provider's current (or pending) {@link ProviderConfig} (or {@link ProviderConfiguration}).
+     */
+    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.
+     */
+    password: string;
+    /**
+     * The firmware/application version number.
+     */
+    firmware: string;
+    /**
+     * The phone number of this device.
+     */
+    phoneNumber: phone;
+    /**
+     * A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
+     */
+    information: Map<string, string>;
+    /**
+     * ICCID of the SIM card installed in this provider
+     */
+    sim: string;
+    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;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+    /**
+     * Indicates whether this object is suspended from event processing.
+     */
+    suspended: boolean;
+    /**
+     * Timestamp from the action that deleted or suspended this object.
+     */
+    since: Date;
+}

package/objects/Providers/ProviderType.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Protocols supported by the system.
+ */
+export declare enum ProviderType {
+    /**
+     * Your guess is as good as mine.
+     * It should never be this.
+     */
+    unknown = "unknown",
+    /**
+     * Sierra Wireless AirLink RAP protocol
+     * @deprecated No longer supported
+     */
+    airlink = "airlink",
+    /**
+     * Sixnet BlueTree BEP protocol
+     * @deprecated No longer supported
+     */
+    bluetree = "bluetree",
+    /**
+     * Gen-X modem protocol
+     */
+    genx = "genx",
+    /**
+     * CalAmp LMU series protocol
+     * @deprecated Use calamp instead
+     */
+    lmu = "lmu",
+    /**
+     * CalAmp TTU series protocol
+     * @deprecated Use calamp instead
+     */
+    ttu = "ttu",
+    /**
+     * Novotel Enfora SpiderAT protocol
+     * @deprecated Use enfora instead
+     */
+    spiderAT = "spiderAT",
+    /**
+     * Novotel Enfora SpiderMT protocol
+     * @deprecated Use enfora instead
+     */
+    spiderMT = "spiderMT",
+    /**
+     * Trak iT Wireless Mobile App
+     */
+    mobile = "mobile",
+    /**
+     * TachWest DataTrans protocol
+     */
+    datatrans = "datatrans",
+    /**
+     * Xirgo modem protocol
+     * @deprecated No longer supported
+     */
+    xirgo = "xirgo",
+    /**
+     * Bell Mobility LBS
+     */
+    lbs = "lbs",
+    /**
+     * Certified Tracking protocol
+     * @deprecated No longer supported
+     */
+    titan = "titan",
+    /**
+     * Concox Tracker protocol
+     * @deprecated No longer supported
+     */
+    concox = "concox",
+    /**
+     * Aspenta Open API format
+     * @deprecated No longer supported
+     */
+    aspenta = "aspenta",
+    /**
+     * Fleet Freedom JSON protocol
+     * @deprecated No longer supported
+     */
+    json = "json",
+    /**
+     * SmartWitness dashcam formats
+     */
+    smartwitness = "smartwitness",
+    /**
+     * CalAmp LMU/TTU modem protocols
+     */
+    calamp = "calamp",
+    /**
+     * Enfora (Novotel) modem protocols
+     * @deprecated No longer supported
+     */
+    enfora = "enfora",
+    /**
+     * BeWhere beacon protocols
+     */
+    bewhere = "bewhere",
+    /**
+     * ATrack device protocols
+     */
+    atrack = "atrack",
+    /**
+     * Teltonika device protocols
+     */
+    teltonika = "teltonika"
+}

package/objects/Reports/ReportBreakdown.d.ts

@@ -0,0 +1,49 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { JsonObject, nothing, uint, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { AssetAdvanced } from "../Assets/AssetAdvanced";
+import { AssetGeneral } from "../Assets/AssetGeneral";
+/**
+ * Asset information used in calculating a summary instance.
+ */
+export declare class ReportBreakdown implements ISerializable {
+    /**
+     * Instantiates a {@link ReportBreakdown} or one of its subclasses based on the shape of the JSON.
+     * Implementation is in {@link ReportBreakdown_fromJSON.ts}
+     * @param json	The JSON to parse.
+     * @returns		An instance of a {@link ReportBreakdown} or one of its subclasses.
+     */
+    static fromJSON: (json: JsonObject) => ReportBreakdown;
+    /**
+     * The asset to which this event data belongs.
+     */
+    assetId: ulong;
+    /**
+     * The asset to which this event data belongs.
+     */
+    get asset(): Asset;
+    /**
+     * Report specific identifier of the event data.
+     */
+    instance: uint;
+    /**
+     * Identifiers of the summary instances that used this event.
+     */
+    summaryInstances: uint[];
+    /**
+     * General Asset information.
+     */
+    general: AssetGeneral | null;
+    /**
+     * Advanced/detailed information used.
+     */
+    advanced: AssetAdvanced | null;
+    constructor(asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: JsonObject | null;
+        advanced: JsonObject | null;
+    };
+}

package/objects/Reports/ReportBreakdownJob.d.ts

@@ -0,0 +1,37 @@
+import { nothing, uint, ulong } from "../API/Types";
+import { AssetAdvanced } from "../Assets/AssetAdvanced";
+import { AssetGeneral } from "../Assets/AssetGeneral";
+import { DispatchJob } from "../Dispatch/DispatchJob";
+import { ReportBreakdown } from "./ReportBreakdown";
+/**
+ * Dispatch Job information used in this report.
+ */
+export declare class ReportBreakdownJob extends ReportBreakdown {
+    /**
+     * The Job used.
+     */
+    job: DispatchJob;
+    constructor(job: DispatchJob, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        job: {
+            id: number | null;
+            company: number | null;
+            v: number[];
+            driver: string;
+            created: string | null;
+            name: string;
+            instructions: string;
+            priority: import("..").DispatchJobPriority;
+            references: import("..").JsonObject;
+            labels: string[];
+            tags: string[];
+            forms: number[];
+            steps: any[];
+        };
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
+    };
+}

package/objects/Reports/ReportBreakdownMessage.d.ts

@@ -0,0 +1,40 @@
+import { nothing, uint, ulong } from "../API/Types";
+import { AssetAdvanced } from "../Assets/AssetAdvanced";
+import { AssetGeneral } from "../Assets/AssetGeneral";
+import { AssetMessage } from "../Messaging/AssetMessage";
+import { ReportBreakdown } from "./ReportBreakdown";
+/**
+ * Message information used in this report.
+ */
+export declare class ReportBreakdownMessage extends ReportBreakdown {
+    /**
+     * The Message used.
+     */
+    message: AssetMessage;
+    constructor(message: AssetMessage, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        message: {
+            folder: import("..").MessageFolder;
+            incoming: boolean;
+            readBy: string;
+            id: number | null;
+            v: number[];
+            company: number;
+            status: import("..").MessageStatus;
+            kind: import("..").MessageType;
+            to: string;
+            from: string;
+            body: string;
+            processed: string | null;
+            delivered: string | null;
+            subject: string;
+            asset: number;
+            user: string;
+        };
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
+    };
+}

package/objects/Reports/ReportBreakdownTask.d.ts

@@ -0,0 +1,46 @@
+import { nothing, uint, ulong } from "../API/Types";
+import { AssetAdvanced } from "../Assets/AssetAdvanced";
+import { AssetGeneral } from "../Assets/AssetGeneral";
+import { DispatchTask } from "../Dispatch/DispatchTask";
+import { ReportBreakdown } from "./ReportBreakdown";
+/**
+ * Dispatch Task information used in this report.
+ */
+export declare class ReportBreakdownTask extends ReportBreakdown {
+    /**
+     * The Task used.
+     */
+    task: DispatchTask;
+    constructor(task: DispatchTask, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
+    toJSON(): {
+        task: {
+            id: number | null;
+            company: number | null;
+            asset: number | null;
+            v: number[];
+            name: string;
+            references: import("..").JsonObject;
+            place: number | null;
+            address: string;
+            latlng: import("../API/Geography/Interfaces").ILatLng;
+            status: import("..").DispatchTaskStatus;
+            created: string | null;
+            eta: string | null;
+            duration: string;
+            arrived: string | null;
+            completed: string | null;
+            instructions: string;
+            signature: boolean;
+            signatory: string;
+            notes: string;
+            attachments: number[];
+            updatedBy: string;
+            updatedUtc: string | null;
+        };
+        asset: number | null;
+        instance: number | null;
+        summaryInstances: number[];
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
+    };
+}

package/objects/Reports/ReportBreakdown_fromJSON.d.ts

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

package/objects/Reports/ReportFilterMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Drill-down mechanism for highlighting only those places and regions desired in report results.
+ */
+export declare enum ReportFilterMode {
+    /**
+     * Filtering is not enabled for the report.
+     */
+    none = "none",
+    /**
+     * Include any results for those whose filters match.
+     */
+    inclusive = "inclusive",
+    /**
+     * Exclude all results except those whose filters match.
+     */
+    exclusive = "exclusive"
+}

package/objects/Reports/ReportNotifications.d.ts

@@ -0,0 +1,31 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { SearchPattern } from "../API/SearchPattern";
+import { email, nothing, JsonObject } from "../API/Types";
+/**
+ * A group of users and targeted assets which receive report notifications.
+ */
+export declare class ReportNotifications implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportNotifications;
+    /**
+     * List of users to send emailed report.
+     * Each email will only contain the results for the assets each user is allowed to view.
+     * {@link UserGeneral.login}
+     */
+    users: email[];
+    /**
+     * A targeting expression to identify which assets receive the report results.
+     * The results emailed to each asset will only be for themselves, not all assets.
+     * To receive the emailed results, the Asset must have a {@link AssetGeneral.messagingAddress},
+     * or for a Person type asset, their {@link Contact.emails}["Email"].
+     */
+    assets: SearchPattern[] | null;
+    constructor(users?: email[] | nothing, assets?: SearchPattern[] | nothing);
+    toJSON(): {
+        users: string[];
+        assets: string | null;
+    };
+}

package/objects/Reports/ReportOptions.d.ts

@@ -0,0 +1,52 @@
+import { ISerializable } from '../API/Interfaces/ISerializable';
+import { SearchPattern } from '../API/SearchPattern';
+import { JsonObject, nothing } from '../API/Types';
+import { ReportFilterMode } from './ReportFilterMode';
+import { ReportParameter } from './ReportParameter';
+import { ReportScorecardRules } from './ReportScorecardRules';
+/**
+ * The options used by the report runner to process results.
+ */
+export declare class ReportOptions implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportOptions;
+    /**
+     * A list of parameters to better shape the results.
+     */
+    parameters: ReportParameter[];
+    /**
+     * A targeting expression for including/excluding Assets.
+     */
+    targets: SearchPattern[] | null;
+    /**
+     * The mechanism to use for filtering based on places and regions.
+     */
+    filtering: ReportFilterMode;
+    /**
+     * A targeting expression for limiting results which only include data from Assets interacting with the targeted Places.
+     */
+    places: SearchPattern[] | null;
+    /**
+     * A list of provinces and states, where only assets within those regions will be included in the results.
+     */
+    regions: string[];
+    /**
+     * Rules used to generate scorecard for this report.
+     */
+    scorecardRules: ReportScorecardRules | null;
+    constructor(parameters?: ReportParameter[] | nothing, targets?: SearchPattern[] | nothing, filtering?: ReportFilterMode | nothing, places?: SearchPattern[] | nothing, regions?: string[] | nothing, scorecardRules?: ReportScorecardRules | nothing);
+    toJSON(): {
+        parameters: any[];
+        targets: string | null;
+        filtering: ReportFilterMode;
+        places: string | null;
+        regions: string[];
+        scorecardRules: {
+            baseScore: number | null;
+            parameters: any[];
+        } | null;
+    };
+}

package/objects/Reports/ReportParameter.d.ts

@@ -0,0 +1,26 @@
+import { ISerializable } from '../API/Interfaces/ISerializable';
+import { ReportParameterType } from './ReportParameterType';
+import { JsonObject } from '../API/Types';
+/**
+ * An argument passed to the report runner.
+ */
+export declare class ReportParameter implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportParameter;
+    /**
+     * The type of argument.
+     */
+    kind: ReportParameterType;
+    /**
+     * The parsed value of the argument.  Each type of argument has a different parsing.
+     */
+    value: string;
+    constructor(kind?: ReportParameterType, value?: string);
+    toJSON(): {
+        kind: ReportParameterType;
+        value: string;
+    };
+}

package/objects/Reports/ReportParameterType.d.ts

@@ -0,0 +1,59 @@
+/**
+ * The kinds of parameters required and optional to build Report Results
+ */
+export declare enum ReportParameterType {
+    /**
+     * The staring date/time range for events to be included in the results.
+     * The date should be a valid ISO-8601 string.
+     */
+    startDate = "startDate",
+    /**
+     * The ending date/time range for events to be included in the results.
+     * The date should be a valid ISO-8601 string.
+     */
+    endDate = "endDate",
+    /**
+     * Time-span processed on each day.
+     * Only data within the time-span is included in the results.
+     * The times should be 2 space separated duration strings.
+     */
+    timeOfDay = "timeOfDay",
+    /**
+     * A list of status tags an Asset must have to be included in the results.
+     * Should be a comma separated string of codified tag names.
+     */
+    tags = "tags",
+    /**
+     * The minimum amount of time for a Summary nice before it is included in the results.
+     * Supplied as a <format id="timespan">duration string</format>.
+     */
+    duration = "duration",
+    /**
+     * The maximum amount of time in a Summary Instance before it is split into two and the latter marked as an exception in the results.
+     * Supplied as a <format id="timespan">duration string</format>.
+     */
+    prolonged = "prolonged",
+    /**
+     * The minimum distance travelled in a Summary Instance before it is included in the results.
+     * Supplied as a number of meters.
+     */
+    distance = "distance",
+    /**
+     * The maximum distance travelled in a Summary Instance before it is split into two and the latter marked as an exception in the results.
+     * Supplied as a number of meters.
+     */
+    rubicon = "rubicon",
+    /**
+     * A choice in the method used to calculate a Summary Instance's values.
+     * For an attribute report, the possible values are "instance" where if the attribute is present it is included,
+     * and "value" where each attribute's simple value becomes it's own summary instance.
+     * For a Tag Summary report, the possible values are "inclusive" where any of the given tags must match, and
+     * "exclusive" where all the given tags must match.
+     */
+    collate = "collate",
+    /**
+     * A list of attribute names an Asset must have to be included in the results.
+     * Should be a comma separated string of codified tag names.
+     */
+    attributes = "attributes"
+}

package/objects/Reports/ReportRecurrence.d.ts

@@ -0,0 +1,54 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, datetime, ulong, ushort, JsonObject } from "../API/Types";
+import { ReportRecurrenceType } from "./ReportRecurrenceType";
+/**
+ * Determines when and how often a report schedule runs automatically.
+ */
+export declare class ReportRecurrence implements ISerializable {
+    #private;
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportRecurrence;
+    /**
+     * How often the report is automatically run.  Daily, weekly, monthly, etc...
+     */
+    kind: ReportRecurrenceType;
+    /**
+     * Used only for daily schedules, this 7 item, boolean array, determines if the schedule should recur on that day of the week.
+     */
+    weekdays: boolean[];
+    /**
+     * Used only for weekly schedules, it's a number between 0 and 6 representing the day of the week, with Sunday being the first day of the week.
+     */
+    weekday: byte;
+    /**
+     * When the schedule is to begin recurring in local-time (not UTC).
+     */
+    start: Date;
+    /**
+     * The optional time when the schedule stops recurring in local-time (not UTC).
+     */
+    end: Date;
+    get iterations(): ushort;
+    get lastResult(): ulong;
+    get nextStartDate(): Date;
+    get nextEndDate(): Date;
+    get lastStartDate(): Date;
+    get lastEndDate(): Date;
+    constructor(kind?: ReportRecurrenceType, weekdays?: boolean[] | string, weekday?: byte, start?: Date | number | datetime, end?: Date | number | datetime, iterations?: ushort, lastResult?: ulong, nextStartDate?: Date | number | datetime, nextEndDate?: Date | number | datetime, lastStartDate?: Date | number | datetime, lastEndDate?: Date | number | datetime);
+    toJSON(): {
+        kind: ReportRecurrenceType;
+        weekdays: string;
+        weekday: number | null;
+        start: string | null;
+        end: string | null;
+        iterations: number | null;
+        lastResult: number | null;
+        nextStartDate: string | null;
+        nextEndDate: string | null;
+        lastStartDate: string | null;
+        lastEndDate: string | null;
+    };
+}

package/objects/Reports/ReportRecurrenceType.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Specifies how often a Report Template is automatically generates a Report Result.
+ */
+export declare enum ReportRecurrenceType {
+    /**
+     * Runs only once.  This type is used for large reports which need to run overnight.
+     */
+    once = "once",
+    /**
+     * Daily at midnight in the local timezone for the previous day based on the ReportRecurrence.weekdays.
+     * {@link ReportRecurrence.weekdays}
+     */
+    daily = "daily",
+    /**
+     * Weekly at midnight in the local timezone for the previous 7 days based on the ReportRecurrence.weekday.
+     * {@link ReportRecurrence.weekday}
+     */
+    weekly = "weekly",
+    /**
+     * Monthly at midnight in the local timezone for the previous month based on the ReportRecurrence.start date.
+     * {@link ReportRecurrence.start}
+     */
+    monthly = "monthly",
+    /**
+     * Runs once every three months at midnight in the local timezone for the previous 3 months based on the ReportRecurrence.start date.
+     * {@link ReportRecurrence.start}
+     */
+    quarterly = "quarterly",
+    /**
+     * Yearly at midnight in the local timezone based on the ReportRecurrence.start date.
+     * {@link ReportRecurrence.start}
+     */
+    annually = "annually"
+}