@trakit/objects 0.0.6 → 0.0.8

package/_publish/Providers/ProviderGeneral.d.ts

@@ -1,125 +0,0 @@
-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 company to which this device belongs.
-     * {@link Company.id}
-     */
-    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 asset for which this device provides field data.
-     * {@link Asset.id}
-     */
-    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) configuration profile.
-     * {@link ProviderConfig.id}
-     * {@link ProviderConfiguration.id}
-     */
-    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/_publish/Reports/ReportBreakdown.d.ts

@@ -1,49 +0,0 @@
-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/_publish/Reports/ReportBreakdown_fromJSON.d.ts

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

package/_publish/Reports/ReportParameter.d.ts

@@ -1,26 +0,0 @@
-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/Reports/ReportParameterType.d.ts

@@ -1,59 +0,0 @@
-/**
- * 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/Reports/ReportResult.d.ts

@@ -1,170 +0,0 @@
-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 company to which this report belongs.
-     * {@link Company.id}
-     */
-    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/Reports/ReportSchedule.d.ts

@@ -1,112 +0,0 @@
-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 company to which this schedule belongs.
-     * {@link Company.id}
-     */
-    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;
-}

package/_publish/Reports/ReportScorecard.d.ts

@@ -1,39 +0,0 @@
-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 asset to which this scorecard belongs.
-     * {@link Asset.id}
-     */
-    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/Reports/ReportScorecardParameter.d.ts

@@ -1,31 +0,0 @@
-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/Reports/ReportStatus.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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"
-}