@trakit/objects 0.0.1

package/Billing/BillingCycle.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The type of repeating cycle used for generating bills.
+ */
+export declare enum BillingCycle {
+    /**
+     * Once a month
+     */
+    monthly = "monthly",
+    /**
+     * Every three months
+     */
+    quarterly = "quarterly",
+    /**
+     * Once per year
+     */
+    annually = "annually"
+}

package/Billing/BillingProfile.d.ts

@@ -0,0 +1,107 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { BillableSmsProfile } from "./BillableSmsProfile";
+import { BillingCurrency } from "./BillingCurrency";
+import { BillingCycle } from "./BillingCycle";
+/**
+ * A profile used to generate billable orders for a customer.
+ */
+export declare class BillingProfile extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier of this billing profile
+     */
+    id: ulong;
+    /**
+     * Unique identifier of the Company that owns this profile and is sending the bill.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * Unique identifier of the Company that owns this profile and is sending the bill.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * Unique identifier of the Company to which this rule pertains.
+     * {@link Company.id}
+     */
+    targetId: ulong;
+    /**
+     * Unique identifier of the Company to which this rule pertains.
+     * {@link Company.id}
+     */
+    get target(): Company;
+    /**
+     * Unique identifier of the Company receiving the bill.
+     * Most of the time, this value is the same as the target.
+     * {@link Company.id}
+     */
+    billeeId: ulong;
+    /**
+     * Unique identifier of the Company receiving the bill.
+     * Most of the time, this value is the same as the target.
+     * {@link Company.id}
+     */
+    get billee(): Company;
+    /**
+     * The name for this profile.
+     */
+    name: string;
+    /**
+     * Notes about the billing profile for the billee or target.
+     */
+    notes: string;
+    /**
+     * SMS messaging tiers
+     */
+    messages: BillableSmsProfile[];
+    /**
+     * Repeating cycle used for generating bills
+     */
+    cycle: BillingCycle;
+    /**
+     * When is the first day of the billing cycle
+     */
+    cycleStart: Date;
+    /**
+     * When should the cycle end (customer cancelled)
+     */
+    cycleEnd: Date;
+    /**
+     * Pro-rated, or post-dated.
+     */
+    cyclePostDated: boolean;
+    /**
+     * kind of money
+     */
+    currency: BillingCurrency;
+    /**
+     * Are the Google services available to be proxied by the service?
+     */
+    googleServicesEnabled: boolean;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        target: number;
+        billee: number;
+        name: string;
+        notes: string;
+        messages: any[];
+        cycle: BillingCycle;
+        currency: BillingCurrency;
+        cycleStart: string | null;
+        cycleEnd: string | null;
+        cyclePostDated: boolean;
+        googleServicesEnabled: boolean;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Billing/Hosting/BillableHostingBase.d.ts

@@ -0,0 +1,41 @@
+import { IBelongBillingProfile } from '../../API/Interfaces/IBelongBillingProfile';
+import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
+import { IIdUlong } from '../../API/Interfaces/IIdUlong';
+import { SearchPattern } from '../../API/SearchPattern';
+import { 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: any, force?: boolean): boolean;
+}

package/Billing/Hosting/BillableHostingDiscount.d.ts

@@ -0,0 +1,35 @@
+import { BillableHostingBase } from './BillableHostingBase';
+import { BillableHostingType } from './BillableHostingType';
+/**
+ * A discount rule for assets
+ * @deprecated Never implemented.
+ */
+export declare class BillableHostingDiscount extends BillableHostingBase {
+    /**
+     * The type of services being discounted.
+     */
+    services: BillableHostingType[];
+    /**
+     * When true, the amount is used as a percentage value instead of a currency values.
+     */
+    percentage: boolean;
+    toJSON(): {
+        services: BillableHostingType[];
+        percentage: boolean;
+        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: any, force?: boolean): boolean;
+}

package/Billing/Hosting/BillableHostingLicense.d.ts

@@ -0,0 +1,29 @@
+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: any, force?: boolean): boolean;
+}

package/Billing/Hosting/BillableHostingLicenseType.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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/Billing/Hosting/BillableHostingRule.d.ts

@@ -0,0 +1,29 @@
+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: any, force?: boolean): boolean;
+}

package/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/Billing/Report/BillingReport.d.ts

@@ -0,0 +1,114 @@
+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, 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 company to which this report belongs and is sending the bill.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * Unique identifier of the Company receiving the bill.
+     * {@link Company.id}
+     */
+    billeeId: ulong;
+    /**
+     * Unique identifier of the Company receiving the bill.
+     * {@link Company.id}
+     */
+    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: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Billing/Report/BillingReportBreakdown.d.ts

@@ -0,0 +1,35 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { 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: any): BillingReportBreakdown;
+    /**
+     * The target company to which this breakdown instance belongs.
+     * {@link Company.id}
+     */
+    targetId: ulong;
+    /**
+     * The target company to which this breakdown instance belongs.
+     * {@link Company.id}
+     */
+    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/Billing/Report/BillingReportHostingSummary.d.ts

@@ -0,0 +1,36 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { double } 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: any): 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/Billing/Report/BillingReportLicenseBreakdown.d.ts

@@ -0,0 +1,80 @@
+import { INamed } from "../../API/Interfaces/INamed";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { datetime, double, 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: any): BillingReportLicenseBreakdown;
+    /**
+     * The provider to which this breakdown instance belongs.
+     * {@link Provider.id}
+     */
+    providerId: string;
+    /**
+     * The provider to which this breakdown instance belongs.
+     * {@link Provider.id}
+     */
+    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;
+    };
+}