@trakit/objects 0.0.14 → 0.0.16

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

@@ -0,0 +1,30 @@
+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/objects/Billing/Hosting/BillableHostingType.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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/objects/Billing/Report/BillingReport.d.ts

@@ -0,0 +1,112 @@
+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/objects/Billing/Report/BillingReportBreakdown.d.ts

@@ -0,0 +1,34 @@
+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/objects/Billing/Report/BillingReportHostingSummary.d.ts

@@ -0,0 +1,36 @@
+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/objects/Billing/Report/BillingReportLicenseBreakdown.d.ts

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

package/objects/Billing/Report/BillingReportServiceBreakdown.d.ts

@@ -0,0 +1,124 @@
+import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
+import { INamed } from "../../API/Interfaces/INamed";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, datetime, double, JsonObject, phone, ulong } from "../../API/Types";
+import { Asset } from "../../Assets/Asset";
+import { AssetType } from "../../Assets/AssetType";
+import { Provider } from "../../Providers/Provider";
+/**
+ * Full breakdown of billable details per targeted asset.
+ */
+export declare class BillingReportServiceBreakdown implements INamed, IBelongAsset, ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: JsonObject): BillingReportServiceBreakdown;
+    /**
+     * The asset to which this breakdown instance belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this breakdown instance belongs.
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * Type of asset.
+     */
+    kind: AssetType;
+    /**
+     * Asset's name.
+     */
+    name: string;
+    /**
+     * Notes about the asset.
+     */
+    notes: string;
+    /**
+     * Indicates when this Asset was created.
+     */
+    created: Date;
+    /**
+     * Indicates when this Asset was deleted.
+     */
+    deleted: Date;
+    /**
+     * Indicates when this Asset wass suspended from event processing.
+     */
+    suspended: Date;
+    /**
+     * Indicates when this Asset was restored after being deleted.
+     */
+    restored: Date;
+    /**
+     * Indicates when this Asset was revived after being suspended.
+     */
+    revived: Date;
+    /**
+     * Codified label names.
+     * {@link LabelStyle.code}
+     */
+    labels: codified[];
+    /**
+     * The list of devices providing events for this asset.
+     * {@link Provider.id}
+     */
+    providerIds: string[];
+    /**
+     * The list of {@link Provider}s providing events for this asset.
+     */
+    get providers(): Provider[];
+    set providers(value: Provider[]);
+    /**
+     * The list of phone numbers for this asset.
+     */
+    phoneNumbers: phone[];
+    /**
+     * Indicates when this Asset was last updated.
+     */
+    updatedDts: Date;
+    /**
+     * Number of days this Asset is being billed for.
+     */
+    billableDays: double;
+    /**
+     * Cost per billing cycle for this asset.
+     */
+    cost: double;
+    /**
+     * Number of days this Asset was suspended.
+     */
+    suspendedDays: double;
+    /**
+     * Cost per billing cycle for suspended asset.
+     */
+    suspendedCost: double;
+    /**
+     * Total amount being billed for this asset.
+     */
+    total: double;
+    constructor(asset?: ulong, kind?: AssetType, name?: string, notes?: string, created?: Date | number | datetime, deleted?: Date | number | datetime, suspended?: Date | number | datetime, restored?: Date | number | datetime, revived?: Date | number | datetime, labels?: codified[], providers?: string[], phoneNumbers?: phone[], updatedDts?: Date | number | datetime, billableDays?: double, cost?: double, suspendedDays?: double, suspendedCost?: double, total?: double);
+    toJSON(): {
+        asset: number | null;
+        kind: AssetType;
+        name: string;
+        notes: string;
+        created: string | null;
+        deleted: string | null;
+        suspended: string | null;
+        restored: string | null;
+        revived: string | null;
+        labels: string[];
+        providers: string[];
+        phoneNumbers: number[];
+        revupdatedDtsived: string | null;
+        billableDays: number;
+        cost: number;
+        suspendedDays: number;
+        suspendedCost: number;
+        total: number;
+    };
+}

package/objects/Billing/Report/BillingReportStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The lifetime of building a {@link BillingReport}.
+ */
+export declare enum BillingReportStatus {
+    /**
+     * The {@link BillingReport} has been requested, but not yet begun processing.
+     */
+    created = "created",
+    /**
+     * The {@link BillingReport} is waiting for required resources to begin processing.
+     */
+    queued = "queued",
+    /**
+     * The {@link BillingReport} is currently being processed.
+     */
+    running = "running",
+    /**
+     * The {@link BillingReport} is available for retrieval.
+     */
+    completed = "completed",
+    /**
+     * There was an error processing the {@link BillingReport}; see the {@link BillingReport.error} for a description.
+     */
+    failed = "failed"
+}

package/objects/Billing/Report/BillingReportSummary.d.ts

@@ -0,0 +1,49 @@
+import { INamed } from "../../API/Interfaces/INamed";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { JsonObject, ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { BillingReportHostingSummary } from "./BillingReportHostingSummary";
+/**
+ * Summarized bill per target.
+ */
+export declare class BillingReportSummary implements INamed, ISerializable {
+    static fromJSON(json: JsonObject): BillingReportSummary;
+    /**
+     * The target company to which this summary instance belongs.
+     * {@link Company.id}
+     */
+    targetId: ulong;
+    /**
+     * The target {@link Company} to which this summary instance belongs.
+     */
+    get target(): Company;
+    /**
+     * The target company's parent.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The target {@link Company}'s parent.
+     */
+    get parent(): Company;
+    /**
+     * Target's name.
+     */
+    name: string;
+    /**
+     * Notes about the target.
+     */
+    notes: string;
+    /**
+     * Summary contains totals per type of hosting (services and licenses) for this target
+     */
+    hosting: BillingReportHostingSummary[];
+    constructor(target?: ulong, parent?: ulong, name?: string, notes?: string, hosting?: BillingReportHostingSummary[]);
+    toJSON(): {
+        target: number | null;
+        parent: number | null;
+        name: string;
+        notes: string;
+        hosting: any[];
+    };
+}

package/objects/Companies/ColourStyle.d.ts

@@ -0,0 +1,25 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { colour, JsonObject } from "../API/Types";
+/**
+ * Part of the White-labelling profile definitions.
+ */
+export declare class ColourStyle implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): ColourStyle;
+    /**
+     * The colour of the background.
+     */
+    fill: colour;
+    /**
+     * The colour of the text or outline.
+     */
+    stroke: colour;
+    constructor(fill?: colour, stroke?: colour);
+    toJSON(): {
+        fill: string;
+        stroke: string;
+    };
+}