@trakit/objects 0.0.6 → 0.0.8

package/_publish/objects/Accounts/UserNotifications.d.ts

@@ -1,76 +0,0 @@
-import { IEnabled } from "../API/Interfaces/IEnabled";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { TimeSpan } from "../API/TimeSpan";
-import { email, JsonObject, timespan, ulong } from "../API/Types";
-import { NotificationMethod } from "./NotificationMethod";
-/**
- * Definition of how and when to send alerts to the user.
- */
-export declare class UserNotifications implements IEnabled, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): UserNotifications;
-    /**
-     * A common name like "Weekdays" or "Off Hours".
-     */
-    name: string;
-    /**
-     * A flag for whether or not this schedule is in use.
-     */
-    enabled: boolean;
-    /**
-     * A 7 item, boolean array, determines if the user should be notified on that day of the week.
-     * The days of the week are defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    weekdays: boolean[];
-    /**
-     * Start time portion of the schedule that defines a period of the day when the user wants to receive alerts.
-     * The time value is defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    start: TimeSpan;
-    /**
-     * End time portion of the schedule that defines a period of the day when the user wants to receive alerts.
-     * The time value is defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    end: TimeSpan;
-    /**
-     * Email address where the sent is sent.
-     * If not specified, the email address from the User's {@link Contact} is taken.
-     * If the contact has no email address, the alert is sent to the user's login.
-     */
-    email: email;
-    /**
-     * SMS address where the alert is sent.
-     * If not specified, the mobile phone number from the User's {@link Contact} is taken.
-     * If the contact has no mobile phone number, the alert is not sent.
-     */
-    sms: ulong;
-    /**
-     * A list of the types of methods to use to notify the user when they have an active WebSocket connection.
-     */
-    online: NotificationMethod[];
-    /**
-     * A list of the types of methods to use to notify the user when they are not connected.
-     */
-    offline: NotificationMethod[];
-    constructor(name?: string, enabled?: boolean, weekdays?: string | boolean[], start?: TimeSpan | timespan | number, end?: TimeSpan | timespan | number, email?: email, sms?: ulong, online?: NotificationMethod[], offline?: NotificationMethod[]);
-    /**
-     *
-     */
-    toJSON(): {
-        name: string;
-        enabled: boolean;
-        weekdays: string;
-        start: string;
-        end: string;
-        email: string;
-        sms: number | null;
-        online: NotificationMethod[];
-        offline: NotificationMethod[];
-    };
-}

package/_publish/objects/Assets/AssetPlaceStatus.d.ts

@@ -1,31 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, JsonObject } from "../API/Types";
-import { AssetPlaceStatusType } from "./AssetPlaceStatusType";
-/**
- * A simple status for each place an Asset visits.
- */
-export declare class AssetPlaceStatus implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): AssetPlaceStatus;
-    /**
-     * The kind of interaction.
-     */
-    kind: AssetPlaceStatusType;
-    /**
-     * The date/time stamp for when the Asset first began interacting with the Place.
-     */
-    enter: Date;
-    /**
-     * The most recent date/time stamp for the interaction.
-     */
-    latest: Date;
-    constructor(kind?: AssetPlaceStatusType, enter?: Date | number | datetime, latest?: Date | number | datetime);
-    toJSON(): {
-        kind: AssetPlaceStatusType;
-        enter: string | null;
-        latest: string | null;
-    };
-}

package/_publish/objects/Assets/AssetPlaceStatusType.d.ts

@@ -1,17 +0,0 @@
-/**
- * The kinds of interactions had with a Place.
- */
-export declare enum AssetPlaceStatusType {
-    /**
-     * Occurs when an asset is outside a Place, then goes inside the boundary.
-     */
-    enter = "enter",
-    /**
-     * Occurs when the asset was inside the boundary before, and is still inside the boundary now.
-     */
-    inside = "inside",
-    /**
-     * Occurs when an asset was inside the boundary of a Place, but then moves outside the boundary.
-     */
-    exit = "exit"
-}

package/_publish/objects/Assets/AssetType.d.ts

@@ -1,21 +0,0 @@
-/**
- * The four supported types of trackable things.
- */
-export declare enum AssetType {
-    /**
-     * Generic thing.
-     */
-    asset = "asset",
-    /**
-     * Human (or alien) Person.
-     */
-    person = "person",
-    /**
-     * A towed vehicle without an engine.
-     */
-    trailer = "trailer",
-    /**
-     * A vehicle that moves with its own power.
-     */
-    vehicle = "vehicle"
-}

package/_publish/objects/Behaviours/BehaviourLogType.d.ts

@@ -1,21 +0,0 @@
-/**
- * The type of logged message.
- */
-export declare enum BehaviourLogType {
-    /**
-     * Used for general information messages.
-     */
-    log = "log",
-    /**
-     * Used for more important messages.
-     */
-    info = "info",
-    /**
-     * Used for warnings.
-     */
-    warn = "warn",
-    /**
-     * Used for errors.
-     */
-    err = "err"
-}

package/_publish/objects/Behaviours/BehaviourParameterType.d.ts

@@ -1,21 +0,0 @@
-/**
- * Possible data-types given to BehaviourParameters.
- */
-export declare enum BehaviourParameterType {
-    /**
-     * True or false.
-     */
-    boolean = "boolean",
-    /**
-     * Numeric value (signed double-precision floating point number).
-     */
-    number = "number",
-    /**
-     * Text.
-     */
-    text = "text",
-    /**
-     * Object or array literal.
-     */
-    json = "json"
-}

package/_publish/objects/Billing/BillableSmsProfile.d.ts

@@ -1,26 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { double, uint, JsonObject } from "../API/Types";
-/**
- * Description of a tiered SMS messaging limit
- */
-export declare class BillableSmsProfile implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): BillableSmsProfile;
-    /**
-     * The maximum number of messages sent per cycle
-     */
-    limit: uint;
-    /**
-     * Cost per SMS message sent.
-     * Received messages are free.
-     */
-    amount: double;
-    constructor(limit?: uint, amount?: double);
-    toJSON(): {
-        limit: number | null;
-        amount: number | null;
-    };
-}

package/_publish/objects/Billing/Hosting/BillableHostingBase.d.ts

@@ -1,41 +0,0 @@
-import { IBelongBillingProfile } from '../../API/Interfaces/IBelongBillingProfile';
-import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
-import { IIdUlong } from '../../API/Interfaces/IIdUlong';
-import { SearchPattern } from '../../API/SearchPattern';
-import { JsonObject, uint } from '../../API/Types';
-import { BillableBase } from '../BillableBase';
-/**
- * Hosted things share a lot of common attributes.
- */
-export declare abstract class BillableHostingBase extends BillableBase implements IIdUlong, IBelongBillingProfile, IBelongCompany {
-    /**
-     * The number of units to which this billing rule applies.
-     * Should be a non-zero value; NaN means unlimited.
-     */
-    limit: uint;
-    /**
-     * Which assets are targeted by this hosting rule.
-     */
-    targets: SearchPattern[] | null;
-    /**
-     * Does this hosting rule apply to suspended resources.
-     */
-    suspended: boolean;
-    toJSON(): {
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        id: number | null;
-        v: number[];
-        company: number;
-        profile: number;
-        name: string;
-        notes: string;
-        reference: string;
-        sku: string;
-        start: string | null;
-        end: string | null;
-        amount: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingLicense.d.ts

@@ -1,30 +0,0 @@
-import { JsonObject } from '../../API/Types';
-import { BillableHostingBase } from './BillableHostingBase';
-import { BillableHostingLicenseType } from './BillableHostingLicenseType';
-/**
- * A hardware license for providers
- */
-export declare class BillableHostingLicense extends BillableHostingBase {
-    /**
-     * The type of hardware license
-     */
-    kind: BillableHostingLicenseType;
-    toJSON(): {
-        kind: BillableHostingLicenseType;
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        id: number | null;
-        v: number[];
-        company: number;
-        profile: number;
-        name: string;
-        notes: string;
-        reference: string;
-        sku: string;
-        start: string | null;
-        end: string | null;
-        amount: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingLicenseType.d.ts

@@ -1,20 +0,0 @@
-/**
- * The kind of license being billed.
- */
-export declare enum BillableHostingLicenseType {
-    /**
-     * SmartWitness data hosting fee
-     * {@link ProviderType.smartwitness}
-     */
-    smartwitness = "smartwitness",
-    /**
-     * BeWhere license fee
-     * {@link ProviderType.bewhere}
-     */
-    bewhere = "bewhere",
-    /**
-     * CalAmp PULS fee
-     * {@link ProviderType.calamp}
-     */
-    calamp = "calamp"
-}

package/_publish/objects/Billing/Hosting/BillableHostingRule.d.ts

@@ -1,30 +0,0 @@
-import { JsonObject } from '../../API/Types';
-import { BillableHostingBase } from './BillableHostingBase';
-import { BillableHostingType } from './BillableHostingType';
-/**
- * A billing rule for assets
- */
-export declare class BillableHostingRule extends BillableHostingBase {
-    /**
-     * The type of service being billed.
-     */
-    service: BillableHostingType;
-    toJSON(): {
-        service: BillableHostingType;
-        limit: number | null;
-        targets: string | null;
-        suspended: boolean;
-        id: number | null;
-        v: number[];
-        company: number;
-        profile: number;
-        name: string;
-        notes: string;
-        reference: string;
-        sku: string;
-        start: string | null;
-        end: string | null;
-        amount: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/objects/Billing/Hosting/BillableHostingType.d.ts

@@ -1,41 +0,0 @@
-/**
- * The kind of service being billed.
- */
-export declare enum BillableHostingType {
-    /**
-     * Employee/driver tracking.
-     */
-    mobile = "mobile",
-    /**
-     * Vehicle tracking (includes VBus data, and engine hours).
-     */
-    vehicle = "vehicle",
-    /**
-     * Generic dot-on-a-map tracking.
-     */
-    asset = "asset",
-    /**
-     * Tasks assignable to vehicles or persons.
-     */
-    dispatch = "dispatch",
-    /**
-     * FMCSA compliant E-Logs and Hours of Service.
-     */
-    elogs = "elogs",
-    /**
-     * Inventory management.
-     */
-    inventory = "inventory",
-    /**
-     * Cargo and delivery audit.
-     */
-    cargo = "cargo",
-    /**
-     * Mobile forms.
-     */
-    forms = "forms",
-    /**
-     * Dashcam and live images hosting.
-     */
-    streetview = "streetview"
-}

package/_publish/objects/Billing/Report/BillingReport.d.ts

@@ -1,112 +0,0 @@
-import { BaseComponent } from '../../API/BaseComponent';
-import { IBelongBillingProfile } from '../../API/Interfaces/IBelongBillingProfile';
-import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
-import { IIdUlong } from '../../API/Interfaces/IIdUlong';
-import { INamed } from '../../API/Interfaces/INamed';
-import { double, JsonObject, ulong } from '../../API/Types';
-import { Company } from '../../Companies/Company';
-import { BillingCurrency } from '../BillingCurrency';
-import { BillingProfile } from '../BillingProfile';
-import { BillingReportBreakdown } from "./BillingReportBreakdown";
-import { BillingReportStatus } from "./BillingReportStatus";
-import { BillingReportSummary } from "./BillingReportSummary";
-/**
- * Report generated per billee company.
- */
-export declare class BillingReport extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongBillingProfile {
-    /**
-     * Unique identifier
-     */
-    id: ulong;
-    /**
-     * The company to which this report belongs and is sending the bill.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this report belongs and is sending the bill.
-     */
-    get company(): Company;
-    /**
-     * Unique identifier of the Company receiving the bill.
-     * {@link Company.id}
-     */
-    billeeId: ulong;
-    /**
-     * Unique identifier of the {@link Company} receiving the bill.
-     */
-    get billee(): Company;
-    /**
-     * The profile to which this report belongs
-     * {@link BillingProfile.id}
-     */
-    profileId: ulong;
-    /**
-     * The profile to which this report belongs
-     * {@link BillingProfile.id}
-     */
-    get profile(): BillingProfile;
-    /**
-     * Name of this report.
-     */
-    name: string;
-    /**
-     * Notes about this report.
-     */
-    notes: string;
-    /**
-     * First day of the billing cycle
-     */
-    startDate: Date;
-    /**
-     * Last day of the billing cycle
-     */
-    endDate: Date;
-    /**
-     * Total amount being billed.
-     */
-    total: double;
-    /**
-     * Currency being billed in
-     */
-    currency: BillingCurrency;
-    /**
-     * The processing status of this report.
-     */
-    status: BillingReportStatus;
-    /**
-     * A field which contains report error details if the {@link status} is {@link BillingReportStatus.failed}.
-     * {@link BillingReportStatus}
-     */
-    error: string;
-    /**
-     * Summary contains totals per target for this billee
-     */
-    summary: BillingReportSummary[];
-    /**
-     * Individual amounts per company, used to calculate the results of the report.
-     */
-    breakdown: BillingReportBreakdown[];
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        billee: number;
-        profile: number;
-        name: string;
-        notes: string;
-        startDate: string | null;
-        endDate: string | null;
-        total: number;
-        currency: BillingCurrency;
-        status: BillingReportStatus;
-        error: string;
-        summary: any[];
-        breakdown: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Billing/Report/BillingReportBreakdown.d.ts

@@ -1,34 +0,0 @@
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { JsonObject, ulong } from "../../API/Types";
-import { Company } from "../../Companies/Company";
-import { BillingReportLicenseBreakdown } from "./BillingReportLicenseBreakdown";
-import { BillingReportServiceBreakdown } from "./BillingReportServiceBreakdown";
-/**
- * Billing breakdown per target company.
- */
-export declare class BillingReportBreakdown implements ISerializable {
-    static fromJSON(json: JsonObject): BillingReportBreakdown;
-    /**
-     * The target company to which this breakdown instance belongs.
-     * {@link Company.id}
-     */
-    targetId: ulong;
-    /**
-     * The target {@link Company} to which this breakdown instance belongs.
-     */
-    get target(): Company;
-    /**
-     * Individual amounts billed per targeted assets.
-     */
-    services: BillingReportServiceBreakdown[];
-    /**
-     * Individual amounts for licensing per targeted providers.
-     */
-    licenses: BillingReportLicenseBreakdown[];
-    constructor(target?: ulong, services?: BillingReportServiceBreakdown[], licenses?: BillingReportLicenseBreakdown[]);
-    toJSON(): {
-        target: number | null;
-        services: BillingReportServiceBreakdown[];
-        licenses: BillingReportLicenseBreakdown[];
-    };
-}

package/_publish/objects/Billing/Report/BillingReportHostingSummary.d.ts

@@ -1,36 +0,0 @@
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { double, JsonObject } from "../../API/Types";
-/**
- * Amount billed for a type of hosting (service or license) per target company.
- */
-export declare class BillingReportHostingSummary implements ISerializable {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: JsonObject): BillingReportHostingSummary;
-    /**
-     * SKU being billed
-     */
-    sku: string;
-    /**
-     * Cost per billing cycle for this SKU.
-     */
-    cost: double;
-    /**
-     * Number of items for this SKU.
-     */
-    count: double;
-    /**
-     * Total amount being billed for this SKU.
-     */
-    total: double;
-    constructor(sku?: string, cost?: double, count?: double, total?: double);
-    toJSON(): {
-        sku: string;
-        cost: number | null;
-        count: number | null;
-        total: number | null;
-    };
-}

package/_publish/objects/Billing/Report/BillingReportLicenseBreakdown.d.ts

@@ -1,79 +0,0 @@
-import { INamed } from "../../API/Interfaces/INamed";
-import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { datetime, double, JsonObject, ulong } from "../../API/Types";
-import { Provider } from "../../Providers/Provider";
-import { ProviderType } from "../../Providers/ProviderType";
-/**
- * Full breakdown of licensing details per targeted provider.
- */
-export declare class BillingReportLicenseBreakdown implements INamed, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): BillingReportLicenseBreakdown;
-    /**
-     * The provider to which this breakdown instance belongs.
-     * {@link Provider.id}
-     */
-    providerId: string;
-    /**
-     * The {@link Provider} to which this breakdown instance belongs.
-     */
-    get provider(): Provider;
-    set provider(value: Provider);
-    /**
-     * Type of provider.
-     */
-    kind: ProviderType;
-    /**
-     * Provider name.
-     */
-    name: string;
-    /**
-     * Notes about the provider.
-     */
-    notes: string;
-    /**
-     * Indicates when this Provider was created.
-     */
-    created: Date;
-    /**
-     * Indicates when this Provider was deleted.
-     */
-    deleted: Date;
-    /**
-     * The phone number for this provider.
-     */
-    phoneNumber: ulong;
-    /**
-     * The firmware/application version number.
-     */
-    firmware: string;
-    /**
-     * Number of days this Provider is being billed for.
-     */
-    billableDays: double;
-    /**
-     * Licensing cost per billing cycle for this provider.
-     */
-    cost: double;
-    /**
-     * Total amount being billed for this provider.
-     */
-    total: double;
-    constructor(provider?: string, kind?: ProviderType, name?: string, notes?: string, created?: Date | number | datetime, deleted?: Date | number | datetime, phoneNumber?: ulong, firmware?: string, billableDays?: double, cost?: double, total?: double);
-    toJSON(): {
-        provider: string;
-        kind: ProviderType;
-        name: string;
-        notes: string;
-        created: string | null;
-        deleted: string | null;
-        phoneNumber: number | null;
-        firmware: string;
-        billableDays: number | null;
-        cost: number | null;
-        total: number | null;
-    };
-}