@trakit/objects 0.0.1 → 0.0.6

package/_publish/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/_publish/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/_publish/objects/Reports/ReportBreakdown_fromJSON.d.ts

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

package/_publish/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/_publish/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/_publish/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/_publish/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/_publish/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/_publish/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/_publish/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"
+}

package/_publish/objects/Reports/ReportResult.d.ts

@@ -0,0 +1,169 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { LatLngBounds } from "../API/Geography/LatLngBounds";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { Timezone } from "../API/Timezone";
+import { JsonObject, byte, email, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { ReportOptions } from './ReportOptions';
+import { ReportSchedule } from "./ReportSchedule";
+import { ReportScorecard } from './ReportScorecard';
+import { ReportStatus } from './ReportStatus';
+import { ReportTemplate } from "./ReportTemplate";
+import { ReportTotal } from './ReportTotal';
+import { ReportType } from './ReportType';
+/**
+ * Report results
+ */
+export declare class ReportResult extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier.
+     */
+    id: ulong;
+    /**
+     * The company to which this report belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this report belongs.
+     */
+    get company(): Company;
+    /**
+     * Refers to the type of logic used by this report.
+     */
+    kind: ReportType;
+    /**
+     * Name of this report.
+     */
+    name: string;
+    /**
+     * Notes about this report.
+     */
+    notes: string;
+    /**
+     * Specified parameters for the report logic, targeted Assets, and filtering Places.
+     */
+    options: ReportOptions;
+    /**
+     * A reference to the Template used to create this result.  This field is optional because templates are not necessarily required; they just make life a lot easier.
+     * {@link ReportTemplate.id}
+     */
+    templateId: ulong;
+    /**
+     * A reference to the Template used to create this result.  This field is optional because templates are not necessarily required; they just make life a lot easier.
+     * {@link ReportTemplate.id}
+     */
+    get template(): ReportTemplate;
+    /**
+     * A reference to the schedule used to create this result.
+     * This field is optional as not all results are created on a schedule.
+     * {@link ReportSchedule.id}
+     */
+    scheduleId: ulong;
+    /**
+     * A reference to the schedule used to create this result.
+     * This field is optional as not all results are created on a schedule.
+     * {@link ReportSchedule.id}
+     */
+    get schedule(): ReportSchedule;
+    /**
+     * Preserve these results for later review.  Results are regularly culled from the system.
+     */
+    archive: boolean;
+    /**
+     * The timezone code used to adjust dates/times used in processing and saving this report.
+     * {@link Timezone.code}
+     */
+    timezone: Timezone;
+    /**
+     * The login of the user that ran this report.
+     * {@link User.login}
+     */
+    runBy: email;
+    /**
+     * The date/time this result was requested.
+     */
+    created: Date;
+    /**
+     * The date/time this result was finished processing.
+     */
+    completed: Date;
+    /**
+     * The processing status of this report.
+     */
+    status: ReportStatus;
+    /**
+     * The progress in processing/saving this result is a number between 0 and 100.
+     */
+    progress: byte;
+    /**
+     * After processing, the boundary of the results are given so that a map can be focused on that area.
+     */
+    bounds: LatLngBounds | null;
+    /**
+     * When the report runs, a list of targeted assets is calculated based on the ReportOption's targeting expression.
+     */
+    targeted: ulong[];
+    /**
+     * When the report runs, a list of filtered places is calculated based on the ReportOption's place filtering expression.
+     */
+    filtered: ulong[];
+    /**
+     * After processing, the report totals the values from all summary instances for a quick overview of the kind of results generated.
+     */
+    totals: ReportTotal[];
+    /**
+     * Scorecards for all the targeted assets based on the scorecard rules.
+     */
+    scorecards: ReportScorecard[];
+    /**
+     * A field which contains report error details if the {@link status} is {@link ReportStatus.failed}.
+     * {@link ReportStatus}
+     */
+    error: string;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        kind: ReportType;
+        name: string;
+        notes: string;
+        options: {
+            parameters: any[];
+            targets: string | null;
+            filtering: import("./ReportFilterMode").ReportFilterMode;
+            places: string | null;
+            regions: string[];
+            scorecardRules: {
+                baseScore: number | null;
+                parameters: any[];
+            } | null;
+        };
+        template: number | null;
+        schedule: number | null;
+        archive: boolean;
+        timezone: string;
+        runBy: string;
+        created: string | null;
+        completed: string | null;
+        status: ReportStatus;
+        progress: number;
+        bounds: {
+            north: number;
+            east: number;
+            south: number;
+            west: number;
+        } | null;
+        targeted: number[];
+        filtered: number[];
+        totals: ReportTotal[];
+        scorecards: ReportScorecard[];
+        error: string;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/_publish/objects/Reports/ReportResultData.d.ts

@@ -0,0 +1,17 @@
+import { ulong } from '../API/Types';
+import { ReportBreakdown } from './ReportBreakdown';
+import { ReportResult } from './ReportResult';
+import { ReportSummary } from './ReportSummary';
+/**
+ * Report results which also include the computed summary and breakdown for the results.
+ */
+export declare class ReportResultData extends ReportResult {
+    /**
+     * Grouped events form a summary instance, and contain information about the starting, ending, and number of the grouped events.
+     */
+    summary: Map<ulong, ReportSummary[]>;
+    /**
+     * Individual events about the targeted assets used to calculate the results of the report.
+     */
+    breakdown: Map<ulong, ReportBreakdown[]>;
+}

package/_publish/objects/Reports/ReportSchedule.d.ts

@@ -0,0 +1,111 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IEnabled } from "../API/Interfaces/IEnabled";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { email, ulong, JsonObject } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { ReportNotifications } from "./ReportNotifications";
+import { ReportOptions } from "./ReportOptions";
+import { ReportRecurrence } from "./ReportRecurrence";
+import { ReportTemplate } from "./ReportTemplate";
+/**
+ * Determines when and how often a report schedule runs automatically.
+ */
+export declare class ReportSchedule extends BaseComponent implements IIdUlong, INamed, IEnabled, IBelongCompany {
+    /**
+     * Unique identifier
+     */
+    id: ulong;
+    /**
+     * The company to which this schedule belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this schedule belongs.
+     */
+    get company(): Company;
+    /**
+     * A reference to the Template used to create this result.
+     * {@link ReportTemplate.id}
+     */
+    templateId: ulong;
+    /**
+     * A reference to the Template used to create this result.
+     * {@link ReportTemplate.id}
+     */
+    get template(): ReportTemplate;
+    /**
+     * Login of the user who has ownership of this report schedule.
+     * {@link User.login}
+     */
+    owner: email;
+    /**
+     * Name of this report.
+     */
+    name: string;
+    /**
+     * Notes about this report.
+     */
+    notes: string;
+    /**
+     * Indicates whether this schedule is allowed to run.
+     */
+    enabled: boolean;
+    /**
+     * The recurring schedule to generate report results.
+     */
+    repetition: ReportRecurrence | null;
+    /**
+     * Specified parameters for the report logic, targeted Assets, and filtering Places.
+     */
+    options: ReportOptions | null;
+    /**
+     * A list of users and a targeting expression for assets which receive report results notifications.
+     */
+    notify: ReportNotifications | null;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        template: number | null;
+        v: number[];
+        name: string;
+        notes: string;
+        owner: string;
+        enabled: boolean;
+        repetition: {
+            kind: import("./ReportRecurrenceType").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;
+        } | null;
+        options: {
+            parameters: any[];
+            targets: string | null;
+            filtering: import("./ReportFilterMode").ReportFilterMode;
+            places: string | null;
+            regions: string[];
+            scorecardRules: {
+                baseScore: number | null;
+                parameters: any[];
+            } | null;
+        } | null;
+        notify: {
+            users: string[];
+            assets: string | null;
+        } | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}