@trakit/objects 0.0.1 → 0.0.5

package/Reports/ReportBreakdownTask.d.ts

@@ -1,4 +1,4 @@
-import { uint, ulong } from "../API/Types";
+import { nothing, uint, ulong } from "../API/Types";
 import { AssetAdvanced } from "../Assets/AssetAdvanced";
 import { AssetGeneral } from "../Assets/AssetGeneral";
 import { DispatchTask } from "../Dispatch/DispatchTask";
@@ -11,7 +11,7 @@ export declare class ReportBreakdownTask extends ReportBreakdown {
      * The Task used.
      */
     task: DispatchTask;
-    constructor(task: DispatchTask, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
+    constructor(task: DispatchTask, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
     toJSON(): {
         task: {
             id: number | null;
@@ -19,11 +19,11 @@ export declare class ReportBreakdownTask extends ReportBreakdown {
             asset: number | null;
             v: number[];
             name: string;
-            references: object;
+            references: import("..").JsonObject;
             place: number | null;
             address: string;
             latlng: import("../API/Geography/Interfaces").ILatLng;
-            status: import("../Dispatch/DispatchTaskStatus").DispatchTaskStatus;
+            status: import("..").DispatchTaskStatus;
             created: string | null;
             eta: string | null;
             duration: string;
@@ -40,32 +40,7 @@ export declare class ReportBreakdownTask extends ReportBreakdown {
         asset: number | null;
         instance: number | null;
         summaryInstances: number[];
-        general: {
-            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("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            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;
-        } | null;
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
     };
 }

package/Reports/ReportBreakdown_fromJSON.d.ts

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

package/Reports/ReportNotifications.d.ts

@@ -1,6 +1,6 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
 import { SearchPattern } from "../API/SearchPattern";
-import { email } from "../API/Types";
+import { email, nothing, JsonObject } from "../API/Types";
 /**
  * A group of users and targeted assets which receive report notifications.
  */
@@ -9,7 +9,7 @@ export declare class ReportNotifications implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportNotifications;
+    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.
@@ -23,7 +23,7 @@ export declare class ReportNotifications implements ISerializable {
      * or for a Person type asset, their {@link Contact.emails}["Email"].
      */
     assets: SearchPattern[] | null;
-    constructor(users?: email[], assets?: SearchPattern[] | null);
+    constructor(users?: email[] | nothing, assets?: SearchPattern[] | nothing);
     toJSON(): {
         users: string[];
         assets: string | null;

package/Reports/ReportOptions.d.ts

@@ -1,5 +1,6 @@
 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';
@@ -11,7 +12,7 @@ export declare class ReportOptions implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportOptions;
+    static fromJSON(json: JsonObject): ReportOptions;
     /**
      * A list of parameters to better shape the results.
      */
@@ -36,7 +37,7 @@ export declare class ReportOptions implements ISerializable {
      * Rules used to generate scorecard for this report.
      */
     scorecardRules: ReportScorecardRules | null;
-    constructor(parameters?: ReportParameter[], targets?: SearchPattern[] | null, filtering?: ReportFilterMode, places?: SearchPattern[] | null, regions?: string[], 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;

package/Reports/ReportParameter.d.ts

@@ -1,5 +1,6 @@
 import { ISerializable } from '../API/Interfaces/ISerializable';
 import { ReportParameterType } from './ReportParameterType';
+import { JsonObject } from '../API/Types';
 /**
  * An argument passed to the report runner.
  */
@@ -8,7 +9,7 @@ export declare class ReportParameter implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportParameter;
+    static fromJSON(json: JsonObject): ReportParameter;
     /**
      * The type of argument.
      */

package/Reports/ReportRecurrence.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { byte, datetime, ulong, ushort } from "../API/Types";
+import { byte, datetime, ulong, ushort, JsonObject } from "../API/Types";
 import { ReportRecurrenceType } from "./ReportRecurrenceType";
 /**
  * Determines when and how often a report schedule runs automatically.
@@ -10,7 +10,7 @@ export declare class ReportRecurrence implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportRecurrence;
+    static fromJSON(json: JsonObject): ReportRecurrence;
     /**
      * How often the report is automatically run.  Daily, weekly, monthly, etc...
      */

package/Reports/ReportResult.d.ts

@@ -3,16 +3,16 @@ 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 { byte, email, ulong } from "../API/Types";
-import { ReportStatus } from './ReportStatus';
-import { ReportTotal } from './ReportTotal';
-import { ReportType } from './ReportType';
-import { ReportOptions } from './ReportOptions';
-import { ReportScorecard } from './ReportScorecard';
-import { Company } from "../Companies/Company";
 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
  */
@@ -162,9 +162,9 @@ export declare class ReportResult extends BaseComponent implements IIdUlong, INa
         scorecards: ReportScorecard[];
         error: string;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Reports/ReportSchedule.d.ts

@@ -3,7 +3,7 @@ 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 } from "../API/Types";
+import { email, ulong, JsonObject } from "../API/Types";
 import { Company } from "../Companies/Company";
 import { ReportNotifications } from "./ReportNotifications";
 import { ReportOptions } from "./ReportOptions";
@@ -104,9 +104,9 @@ export declare class ReportSchedule extends BaseComponent implements IIdUlong, I
             assets: string | null;
         } | null;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Reports/ReportScorecard.d.ts

@@ -1,6 +1,6 @@
 import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { double, ulong } from "../API/Types";
+import { double, JsonObject, ulong } from "../API/Types";
 import { Asset } from "../Assets/Asset";
 /**
  * Scorecard generated from the results of this report.
@@ -11,7 +11,7 @@ export declare class ReportScorecard implements ISerializable, IBelongAsset {
      * @param json
      * @returns
      */
-    static fromJSON(json: any): ReportScorecard;
+    static fromJSON(json: JsonObject): ReportScorecard;
     /**
      * The asset to which this scorecard belongs.
      * {@link Asset.id}
@@ -34,6 +34,6 @@ export declare class ReportScorecard implements ISerializable, IBelongAsset {
     toJSON(): {
         asset: number | null;
         score: number;
-        rulePoints: object;
+        rulePoints: JsonObject;
     };
 }

package/Reports/ReportScorecardParameter.d.ts

@@ -1,6 +1,6 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
 import { TimeSpan } from "../API/TimeSpan";
-import { double, timespan } from "../API/Types";
+import { double, timespan, JsonObject } from "../API/Types";
 /**
  * Infraction parameter used to generate scorecard
  */
@@ -9,7 +9,7 @@ export declare class ReportScorecardParameter implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportScorecardParameter;
+    static fromJSON(json: JsonObject): ReportScorecardParameter;
     /**
      * Type of exception, example speeding, idling, etc.
      */

package/Reports/ReportScorecardRules.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { double } from "../API/Types";
+import { double, JsonObject } from "../API/Types";
 import { ReportScorecardParameter } from "./ReportScorecardParameter";
 /**
  * Rules used for generating a scorecard.
@@ -9,7 +9,7 @@ export declare class ReportScorecardRules implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportScorecardRules;
+    static fromJSON(json: JsonObject): ReportScorecardRules;
     /**
      * Base score for the scorecard.
      */

package/Reports/ReportSummary.d.ts

@@ -3,7 +3,7 @@ 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, uint, ulong } from "../API/Types";
+import { datetime, double, nothing, uint, ulong, JsonObject } from "../API/Types";
 import { Asset } from "../Assets/Asset";
 import { ReportSummaryReason } from './ReportSummaryReason';
 /**
@@ -14,7 +14,7 @@ export declare class ReportSummary implements ISerializable, IBelongAsset {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportSummary;
+    static fromJSON(json: JsonObject): ReportSummary;
     /**
      * The asset to which this summary instance belongs.
      * {@link Asset.id}
@@ -73,7 +73,7 @@ export declare class ReportSummary implements ISerializable, IBelongAsset {
      * 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, polyline?: ILatLng[], firstState?: Asset | null, 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;
@@ -85,35 +85,7 @@ export declare class ReportSummary implements ISerializable, IBelongAsset {
         endingReason: ReportSummaryReason;
         distance: number | null;
         polyline: any[];
-        firstState: {
-            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("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        lastState: {
-            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("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
+        firstState: JsonObject | null;
+        lastState: JsonObject | null;
     };
 }

package/Reports/ReportTemplate.d.ts

@@ -3,7 +3,7 @@ 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 { codified, colour, ulong } from "../API/Types";
+import { JsonObject, codified, colour, ulong } from "../API/Types";
 import { Company } from "../Companies/Company";
 import { ReportOptions } from "./ReportOptions";
 import { ReportType } from "./ReportType";
@@ -74,9 +74,9 @@ export declare class ReportTemplate extends BaseComponent implements IIdUlong, I
         stroke: string;
         graphic: string;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Reports/ReportTotal.d.ts

@@ -1,6 +1,6 @@
 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.
@@ -10,7 +10,7 @@ export declare class ReportTotal implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ReportTotal;
+    static fromJSON(json: JsonObject): ReportTotal;
     /**
      * The asset to which this report total belongs.
      * {@link Asset.id}