@trakit/objects 0.0.1 → 0.0.6

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

@@ -0,0 +1,38 @@
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { double, JsonObject, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+/**
+ * Scorecard generated from the results of this report.
+ */
+export declare class ReportScorecard implements ISerializable, IBelongAsset {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: JsonObject): ReportScorecard;
+    /**
+     * The asset to which this scorecard belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this scorecard belongs.
+     */
+    get asset(): Asset;
+    /**
+     * Final score calculated based on scorecard rules.
+     */
+    score: double;
+    /**
+     * Points per rule
+     */
+    rulePoints: Map<string, double>;
+    constructor(asset?: ulong, score?: double, rulePoints?: Map<string, double>);
+    toJSON(): {
+        asset: number | null;
+        score: number;
+        rulePoints: JsonObject;
+    };
+}

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

@@ -0,0 +1,31 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { TimeSpan } from "../API/TimeSpan";
+import { double, timespan, JsonObject } from "../API/Types";
+/**
+ * Infraction parameter used to generate scorecard
+ */
+export declare class ReportScorecardParameter implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportScorecardParameter;
+    /**
+     * Type of exception, example speeding, idling, etc.
+     */
+    condition: string;
+    /**
+     * Threshold per instance. If the threshold is 0, each instance is used in the calculation
+     */
+    duration: TimeSpan;
+    /**
+     * Points applied against the base score per instance
+     */
+    points: double;
+    constructor(condition?: string, duration?: TimeSpan | timespan | number, points?: double);
+    toJSON(): {
+        condition: string;
+        duration: string;
+        points: number | null;
+    };
+}

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

@@ -0,0 +1,26 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { double, JsonObject } from "../API/Types";
+import { ReportScorecardParameter } from "./ReportScorecardParameter";
+/**
+ * Rules used for generating a scorecard.
+ */
+export declare class ReportScorecardRules implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportScorecardRules;
+    /**
+     * Base score for the scorecard.
+     */
+    baseScore: double;
+    /**
+     * Infraction parameters used to generate the final score
+     */
+    parameters: ReportScorecardParameter[];
+    constructor(baseScore?: double, parameters?: ReportScorecardParameter[]);
+    toJSON(): {
+        baseScore: number | null;
+        parameters: any[];
+    };
+}

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

@@ -0,0 +1,29 @@
+/**
+ * The lifetime of building a {@link ReportResult}.
+ */
+export declare enum ReportStatus {
+    /**
+     * The {@link ReportResult} has been requested, but not yet begun processing.
+     */
+    created = "created",
+    /**
+     * The {@link ReportResult} is waiting for required resources to begin processing.
+     */
+    queued = "queued",
+    /**
+     * The {@link ReportResult} is currently being processed.
+     */
+    running = "running",
+    /**
+     * The {@link ReportResult} results have been calculated, and are being saved for review.
+     */
+    saving = "saving",
+    /**
+     * The {@link ReportResult} is available for retrieval.
+     */
+    completed = "completed",
+    /**
+     * There was an error processing the {@link ReportResult}; see the {@link ReportResult.error} for a description.
+     */
+    failed = "failed"
+}

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

@@ -0,0 +1,90 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { TimeSpan } from "../API/TimeSpan";
+import { datetime, double, nothing, uint, ulong, JsonObject } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { ReportSummaryReason } from './ReportSummaryReason';
+/**
+ * Summarized asset details.
+ */
+export declare class ReportSummary implements ISerializable, IBelongAsset {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ReportSummary;
+    /**
+     * The asset to which this summary instance belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this summary instance belongs.
+     */
+    get asset(): Asset;
+    /**
+     * Code given to this summary instance for an asset.
+     */
+    stateDetail: string;
+    /**
+     * Identifier of the summary instance in the report.
+     */
+    instance: uint;
+    /**
+     * The number of events included in calculating this summary instance.
+     */
+    instancesCount: uint;
+    /**
+     * Date/time stamp of the first event in this summary's sequence.
+     */
+    startingUtc: Date;
+    /**
+     * The reason code that this summary instance began.
+     */
+    startingReason: ReportSummaryReason;
+    /**
+     * Date/time stamp of the last event in this summary's sequence.
+     */
+    endingUtc: Date;
+    /**
+     * The reason code that this summary instance ended.
+     */
+    endingReason: ReportSummaryReason;
+    /**
+     * The distance travelled in kilometres by the asset during this summary instance.
+     */
+    distance: double;
+    /**
+     * The amount of time that passed.
+     */
+    get duration(): TimeSpan;
+    /**
+     * A simplified polyline of all the asset's positions in sequence.
+     */
+    polyline: LatLng[];
+    /**
+     * The first asset state which begins this summary instance.
+     */
+    firstState: Asset | null;
+    /**
+     * The asset state that ended this summary instance.
+     */
+    lastState: Asset | null;
+    constructor(asset: ulong, stateDetail: string, instance: uint, instancesCount: uint, startingUtc: Date | number | datetime, startingReason: ReportSummaryReason, endingUtc: Date | number | datetime, endingReason: ReportSummaryReason, distance?: double | nothing, polyline?: (ILatLng | JsonObject)[] | nothing, firstState?: Asset | nothing, lastState?: Asset | nothing);
+    toJSON(): {
+        asset: number | null;
+        stateDetail: string;
+        instance: number | null;
+        instancesCount: number | null;
+        startingUtc: string | null;
+        startingReason: ReportSummaryReason;
+        endingUtc: string | null;
+        endingReason: ReportSummaryReason;
+        distance: number | null;
+        polyline: any[];
+        firstState: JsonObject | null;
+        lastState: JsonObject | null;
+    };
+}

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

@@ -0,0 +1,27 @@
+/**
+ * The kind of reason associated with the range caps for a summary instance.
+ */
+export declare enum ReportSummaryReason {
+    /**
+     * If the report starting/ending date range overlaps the actual start of the state.
+     */
+    outsideRange = "outsideRange",
+    /**
+     * The targeting query starts or stops matching.  For example, the Asset's labels were changed.
+     */
+    targeted = "targeted",
+    /**
+     * The asset started/stopped matching the required state.  For example, a status tag was added or removed.
+     */
+    stateMatch = "stateMatch",
+    /**
+     * The summary instance elapsed a Rubicon or prolonged parameter, and was split into two summary instances.
+     * {@link ReportParameterType}
+     */
+    split = "split",
+    /**
+     * The asset started/stopped matching the report filter settings. For example, they left a province or entered a Place.
+     * {@link ReportFilterMode}
+     */
+    filterMatch = "filterMatch"
+}

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

@@ -0,0 +1,81 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+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 { ReportOptions } from "./ReportOptions";
+import { ReportType } from "./ReportType";
+/**
+ * A partially created report used to quickly build results.
+ */
+export declare class ReportTemplate extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IVisual {
+    /**
+     * Unique identifier
+     */
+    id: ulong;
+    /**
+     * The company to which this template belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this template 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 | null;
+    /**
+     * The fill/background colour of the icon.
+     */
+    fill: colour;
+    /**
+     * Outline and graphic colour.
+     */
+    stroke: colour;
+    /**
+     * The name of the symbol for this report.
+     */
+    graphic: codified;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        v: number[];
+        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;
+        } | null;
+        fill: string;
+        stroke: string;
+        graphic: string;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/{Reports/ReportDataTotal.d.ts → _publish/objects/Reports/ReportTotal.d.ts}

@@ -1,30 +1,27 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
 import { TimeSpan } from "../API/TimeSpan";
-import { double, timespan, uint, ulong } from "../API/Types";
+import { double, timespan, uint, ulong, JsonObject } from "../API/Types";
 import { Asset } from "../Assets/Asset";
 /**
  * Totalled information from all the results of the report.
- *  <override name="ReportTotal" />
  */
-export declare class ReportDataTotal implements ISerializable {
+export declare class ReportTotal implements ISerializable {
     /**
      *
      * @param json
      */
-    static fromJSON(json: any): ReportDataTotal;
+    static fromJSON(json: JsonObject): ReportTotal;
     /**
      * The asset to which this report total belongs.
      * {@link Asset.id}
      */
     assetId: ulong;
     /**
-     * The asset to which this report total belongs.
-     * {@link Asset.id}
+     * The {@link Asset} to which this report total belongs.
      */
     get asset(): Asset;
     /**
      * Unique code given to the report total.
-     *  <override max-length="100" />
      */
     stateDetail: string;
     /**

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

@@ -0,0 +1,42 @@
+/**
+ * The type of logic used by the report runner.
+ */
+export declare enum ReportType {
+    /**
+     * Processes all history for the assets.
+     */
+    full = "full",
+    /**
+     * Summarizes the timeline based on the given tags.
+     */
+    tags = "tags",
+    /**
+     * Summarizes the timeline based on places visited.
+     */
+    places = "places",
+    /**
+     * Processes the log of messages sent to and from the assets.
+     */
+    messages = "messages",
+    /**
+     * Summarizes the timeline based on the asset's task's lifetimes.
+     * @deprecated Use `ReportType.jobs` instead
+     */
+    tasks = "tasks",
+    /**
+     * Summarizes the timeline based on the given attributes and thresholds.
+     */
+    attributes = "attributes",
+    /**
+     * Summarizes the timeline based on the regions (cities, provinces/states, countries) through which the assets travelled.
+     */
+    regions = "regions",
+    /**
+     * Summarizes the timeline based on the asset's jobs's lifetimes.
+     */
+    jobs = "jobs",
+    /**
+     * Summarizes the timeline by day, week, and month based on the asset's positions.
+     */
+    positions = "positions"
+}

package/{Storage.d.ts → _publish/objects/storage.d.ts}

@@ -3,7 +3,7 @@ import { Machine } from './Accounts/Machine';
 import { Session } from './Accounts/Session';
 import { User } from './Accounts/User';
 import { UserGroup } from './Accounts/UserGroup';
-import { email, ulong } from './API/Types';
+import { email, guid, ulong } from './API/Types';
 import { Asset } from './Assets/Asset';
 import { Behaviour } from './Behaviours/Behaviour';
 import { BehaviourLog } from './Behaviours/BehaviourLog';
@@ -18,6 +18,7 @@ import { DispatchTask } from './Dispatch/DispatchTask';
 import { Document } from './Hosting/Document';
 import { FormResult } from './Hosting/FormResult';
 import { FormTemplate } from './Hosting/FormTemplate';
+import { Dashcam } from './Images/Dashcam';
 import { Icon } from './Images/Icon';
 import { Picture } from './Images/Picture';
 import { MaintenanceJob } from './Maintenance/MaintenanceJob';
@@ -25,6 +26,7 @@ import { MaintenanceSchedule } from './Maintenance/MaintenanceSchedule';
 import { AssetMessage } from './Messaging/AssetMessage';
 import { Place } from './Places/Place';
 import { ProviderConfig } from './Providers/Config/ProviderConfig';
+import { ProviderRegistration } from './Providers/Config/ProviderRegistration';
 import { ProviderScript } from './Providers/Config/ProviderScript';
 import { ProviderConfiguration } from './Providers/Configuration/ProviderConfiguration';
 import { ProviderConfigurationType } from './Providers/Configuration/ProviderConfigurationType';
@@ -120,6 +122,10 @@ export declare const PICTURES: Map<ulong, Picture>;
  *
  */
 export declare const ICONS: Map<ulong, Icon>;
+/**
+ *
+ */
+export declare const DASHCAMS: Map<guid, Dashcam>;
 /**
  *
  */
@@ -152,6 +158,10 @@ export declare const PROVIDER_CONFIGURATION_TYPES: Map<ulong, ProviderConfigurat
  *
  */
 export declare const PROVIDER_CONFIGURATIONS: Map<ulong, ProviderConfiguration>;
+/**
+ *
+ */
+export declare const PROVIDER_REGISTRATIONS: Map<string, ProviderRegistration>;
 /**
  *
  */

package/_publish/storage.d.ts

@@ -0,0 +1,176 @@
+import { Contact } from './Accounts/Contact';
+import { Machine } from './Accounts/Machine';
+import { Session } from './Accounts/Session';
+import { User } from './Accounts/User';
+import { UserGroup } from './Accounts/UserGroup';
+import { email, guid, ulong } from './API/Types';
+import { Asset } from './Assets/Asset';
+import { Behaviour } from './Behaviours/Behaviour';
+import { BehaviourLog } from './Behaviours/BehaviourLog';
+import { BehaviourScript } from './Behaviours/BehaviourScript';
+import { BillingProfile } from './Billing/BillingProfile';
+import { BillableHostingLicense } from './Billing/Hosting/BillableHostingLicense';
+import { BillableHostingRule } from './Billing/Hosting/BillableHostingRule';
+import { BillingReport } from './Billing/Report/BillingReport';
+import { Company } from './Companies/Company';
+import { DispatchJob } from './Dispatch/DispatchJob';
+import { DispatchTask } from './Dispatch/DispatchTask';
+import { Document } from './Hosting/Document';
+import { FormResult } from './Hosting/FormResult';
+import { FormTemplate } from './Hosting/FormTemplate';
+import { Dashcam } from './Images/Dashcam';
+import { Icon } from './Images/Icon';
+import { Picture } from './Images/Picture';
+import { MaintenanceJob } from './Maintenance/MaintenanceJob';
+import { MaintenanceSchedule } from './Maintenance/MaintenanceSchedule';
+import { AssetMessage } from './Messaging/AssetMessage';
+import { Place } from './Places/Place';
+import { ProviderConfig } from './Providers/Config/ProviderConfig';
+import { ProviderRegistration } from './Providers/Config/ProviderRegistration';
+import { ProviderScript } from './Providers/Config/ProviderScript';
+import { ProviderConfiguration } from './Providers/Configuration/ProviderConfiguration';
+import { ProviderConfigurationType } from './Providers/Configuration/ProviderConfigurationType';
+import { Provider } from './Providers/Provider';
+import { ReportResult } from './Reports/ReportResult';
+import { ReportSchedule } from './Reports/ReportSchedule';
+import { ReportTemplate } from './Reports/ReportTemplate';
+/**
+ *
+ */
+export declare const COMPANIES: Map<ulong, Company>;
+/**
+ *
+ */
+export declare const CONTACTS: Map<ulong, Contact>;
+/**
+ *
+ */
+export declare const MACHINES: Map<string, Machine>;
+/**
+ *
+ */
+export declare const USERS: Map<email, User>;
+/**
+ *
+ */
+export declare const GROUPS: Map<ulong, UserGroup>;
+/**
+ *
+ */
+export declare const SESSIONS: Map<string, Session>;
+/**
+ *
+ */
+export declare const ASSETS: Map<ulong, Asset>;
+/**
+ *
+ */
+export declare const MESSAGES: Map<ulong, AssetMessage>;
+/**
+ *
+ */
+export declare const BEHAVIOURS: Map<ulong, Behaviour>;
+/**
+ *
+ */
+export declare const BEHAVIOUR_SCRIPTS: Map<ulong, BehaviourScript>;
+/**
+ *
+ */
+export declare const BEHAVIOUR_LOGS: Map<ulong, BehaviourLog>;
+/**
+ *
+ */
+export declare const BILLING_PROFILES: Map<ulong, BillingProfile>;
+/**
+ *
+ */
+export declare const BILLING_REPORTS: Map<ulong, BillingReport>;
+/**
+ *
+ */
+export declare const BILLING_RULES: Map<ulong, BillableHostingRule>;
+/**
+ *
+ */
+export declare const BILLING_LICENSES: Map<ulong, BillableHostingLicense>;
+/**
+ *
+ */
+export declare const DISPATCH_TASKS: Map<ulong, DispatchTask>;
+/**
+ *
+ */
+export declare const DISPATCH_JOBS: Map<ulong, DispatchJob>;
+/**
+ *
+ */
+export declare const DOCUMENTS: Map<ulong, Document>;
+/**
+ *
+ */
+export declare const FORM_TEMPLATES: Map<ulong, FormTemplate>;
+/**
+ *
+ */
+export declare const FORM_RESULTS: Map<ulong, FormResult>;
+/**
+ *
+ */
+export declare const PICTURES: Map<ulong, Picture>;
+/**
+ *
+ */
+export declare const ICONS: Map<ulong, Icon>;
+/**
+ *
+ */
+export declare const DASHCAMS: Map<guid, Dashcam>;
+/**
+ *
+ */
+export declare const MAINTENANCE_SCHEDULES: Map<ulong, MaintenanceSchedule>;
+/**
+ *
+ */
+export declare const MAINTENANCE_JOBS: Map<ulong, MaintenanceJob>;
+/**
+ *
+ */
+export declare const PLACES: Map<ulong, Place>;
+/**
+ *
+ */
+export declare const PROVIDERS: Map<string, Provider>;
+/**
+ *
+ */
+export declare const PROVIDER_SCRIPTS: Map<ulong, ProviderScript>;
+/**
+ *
+ */
+export declare const PROVIDER_CONFIGS: Map<ulong, ProviderConfig>;
+/**
+ *
+ */
+export declare const PROVIDER_CONFIGURATION_TYPES: Map<ulong, ProviderConfigurationType>;
+/**
+ *
+ */
+export declare const PROVIDER_CONFIGURATIONS: Map<ulong, ProviderConfiguration>;
+/**
+ *
+ */
+export declare const PROVIDER_REGISTRATIONS: Map<string, ProviderRegistration>;
+/**
+ *
+ */
+export declare const REPORT_TEMPLATES: Map<ulong, ReportTemplate>;
+/**
+ *
+ */
+export declare const REPORT_SCHEDULES: Map<ulong, ReportSchedule>;
+/**
+ *
+ */
+export declare const REPORT_RESULTS: Map<ulong, ReportResult>;