@trakit/objects 0.0.6 → 0.0.8

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

@@ -1,46 +0,0 @@
-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

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

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

@@ -1,17 +0,0 @@
-/**
- * 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

@@ -1,31 +0,0 @@
-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

@@ -1,52 +0,0 @@
-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/ReportRecurrence.d.ts

@@ -1,54 +0,0 @@
-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

@@ -1,34 +0,0 @@
-/**
- * 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/ReportResultData.d.ts

@@ -1,17 +0,0 @@
-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/ReportScorecardRules.d.ts

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

@@ -1,27 +0,0 @@
-/**
- * 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/storage.d.ts

@@ -1,176 +0,0 @@
-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>;