@trakit/objects 0.0.9 → 0.0.11

package/Accounts/Permissions/PermissionEscalationType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Definition for the kinds of permission escalations.
+ */
+export declare enum PermissionEscalationType {
+    /**
+     * Increase in privileges.
+     */
+    vertical = "vertical",
+    /**
+     * Increase in access to an object.
+     */
+    horizontal = "horizontal"
+}
+//# sourceMappingURL=PermissionEscalationType.d.ts.map

package/Accounts/Permissions/PermissionLevel.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The levels of permission available.
+ */
+export declare enum PermissionLevel {
+    /**
+     * Read-only access, no changes allowed.
+     */
+    read = "read",
+    /**
+     * Read and write access, but things cannot be deleted or new things created.
+     */
+    update = "update",
+    /**
+     * Full control to read, write, delete and create things.
+     */
+    full = "full"
+}
+//# sourceMappingURL=PermissionLevel.d.ts.map

package/Accounts/Permissions/PermissionMethod.d.ts

@@ -0,0 +1,14 @@
+/**
+ * How a permission is applied.
+ */
+export declare enum PermissionMethod {
+    /**
+     * Permission is given.
+     */
+    grant = "grant",
+    /**
+     * Permission is taken away.
+     */
+    revoke = "revoke"
+}
+//# sourceMappingURL=PermissionMethod.d.ts.map

package/Accounts/Permissions/PermissionType.d.ts

@@ -0,0 +1,281 @@
+/**
+ * The kinds of permissions available for a UserPermission.
+ */
+export declare enum PermissionType {
+    /**
+    * Basic information about a {@link Company}.
+    * This permissions is required to have access to other aspects of the company.
+    * {@link Company}
+    * {@link CompanyGeneral}
+    */
+    companyGeneral = "companyGeneral",
+    /**
+    * Updating the company's {@link CompanyDirectory|directory} of {@link Contact}s.  Not the same as {@link PermissionType.contact}.
+    * {@link CompanyDirectory}
+    */
+    companyDirectory = "companyDirectory",
+    /**
+    * Company's {@link CompanyStyles|label and tag styles}.
+    * {@link CompanyStyles}
+    */
+    companyLabels = "companyLabels",
+    /**
+    * Company's {@link SessionPolicy} and {@link PasswordPolicy}.
+    * {@link CompanyPolicies}
+    */
+    companyPolicies = "companyPolicies",
+    /**
+    *  {@link CompanyReseller|White-labeler} specific settings.
+    * {@link CompanyReseller}
+    */
+    companyReseller = "companyReseller",
+    /**
+    * Access to add a new child {@link Company}.
+    * {@link CompanyGeneral}
+    */
+    companyCreate = "companyCreate",
+    /**
+    * Assets' {@link AssetGeneral|general properties} such as name = "* Assets' {@link AssetGeneral|general properties} such as name", icon, and labels.
+    * {@link Asset}
+    * {@link AssetGeneral}
+    * {@link Person}
+    * {@link PersonGeneral}
+    * {@link Vehicle}
+    * {@link VehicleGeneral}
+    * {@link Trailer}
+    * {@link TrailerGeneral}
+    */
+    assetGeneral = "assetGeneral",
+    /**
+    * Assets' {@link AssetAdvanced|advanced properties} such as position = "* Assets' {@link AssetAdvanced|advanced properties} such as position", attributes, and status tags.
+    * {@link AssetAdvanced}
+    * {@link VehicleAdvanced}
+    */
+    assetAdvanced = "assetAdvanced",
+    /**
+    *  {@link AssetMessage}s from assets and {@link AssetAlert}s.
+    * {@link AssetMessage}
+    * {@link PndMessage}
+    */
+    assetMessage = "assetMessage",
+    /**
+    *  {@link Asset}'s {@link DispatchTask} order = "*  {@link Asset}'s {@link DispatchTask} order", turn by turn directions, and required route.
+    * {@link AssetDispatch}
+    */
+    assetDispatch = "assetDispatch",
+    /**
+    *  {@link Place} information.
+    * {@link Place}
+    * {@link Place}
+    */
+    placeGeneral = "placeGeneral",
+    /**
+    *  {@link Provider} information like name = "*  {@link Provider} information like name", notes, and selected asset.
+    * {@link Provider}
+    * {@link ProviderGeneral}
+    */
+    providerGeneral = "providerGeneral",
+    /**
+    * Raw {@link Provider} data like GPS coordinates and parsed ODB-II values.
+    * {@link ProviderAdvanced}
+    */
+    providerAdvanced = "providerAdvanced",
+    /**
+    * Sending and reading {@link Provider} commands.
+    * {@link ProviderControl}
+    */
+    providerControl = "providerControl",
+    /**
+    *  {@link Provider} configurations.
+    * {@link ProviderConfig}
+    * {@link ProviderConfiguration}
+    * {@link ProviderConfigurationType}
+    */
+    providerConfiguration = "providerConfiguration",
+    /**
+    * Legacy {@link Provider} configuration types.
+    * {@link ProviderConfigurationType}
+    * @deprecated Use {@link providerConfiguration} instead
+    */
+    providerConfigType = "providerConfigType",
+    /**
+    * Allows access to {@link Provider} logic scripts.
+    * {@link ProviderScript}
+    */
+    providerScript = "providerScript",
+    /**
+    * Sending and reading {@link Provider} commands.
+    * {@link ProviderCommand}
+    * @deprecated Use {@link providerControl} instead
+    */
+    providerCommand = "providerCommand",
+    /**
+    * Historical {@link Asset} details like breadcrumb trails.
+    * {@link ReportResult}
+    */
+    reportResult = "reportResult",
+    /**
+    *  {@link ReportTemplate} configurations.
+    * {@link ReportTemplate}
+    */
+    reportTemplate = "reportTemplate",
+    /**
+    *  {@link ReportSchedule}s used to automatically create {@link ReportResult}s overnight.
+    * {@link ReportSchedule}
+    */
+    reportSchedule = "reportSchedule",
+    /**
+    * General {@link UserGeneral|user information} such as name = "* General {@link UserGeneral|user information} such as name", contact information, and preferences.
+    * {@link UserGeneral}
+    */
+    userGeneral = "userGeneral",
+    /**
+    *  {@link UserAdvanced|User information} such as permissions and group membership.
+    * {@link UserAdvanced}
+    */
+    userAdvanced = "userAdvanced",
+    /**
+    *  {@link UserGroup} information for easy access control.
+    * {@link UserGroup}
+    */
+    userGroup = "userGroup",
+    /**
+    *  {@link Machine} information and permissions.
+    * {@link Machine}
+    */
+    machine = "machine",
+    /**
+    * Access to retrieve a list of active sessions and kill sessions.
+    * {@link Tentacles.RespSession}
+    * {@link Tentacles.RespSessionFull}
+    */
+    session = "session",
+    /**
+    * Configured {@link Behaviour}.
+    * {@link Behaviour}
+    */
+    behaviour = "behaviour",
+    /**
+    * View and clear the log of debug messages for a {@link BehaviourScript} or {@link Behaviour}.
+    * {@link BehaviourLog}
+    */
+    behaviourLog = "behaviourLog",
+    /**
+    *  {@link BehaviourScript} logic.
+    * {@link BehaviourScript}
+    */
+    behaviourScript = "behaviourScript",
+    /**
+    *  {@link Asset}'s tasks information.
+    * {@link DispatchTask}
+    */
+    dispatchTask = "dispatchTask",
+    /**
+    * Pre-set routes = "* Pre-set routes", lists of {@link DispatchJob}s, and driving directions.
+    * {@link DispatchTemplate}
+    */
+    dispatchTemplate = "dispatchTemplate",
+    /**
+    *  {@link Contact} information.
+    * {@link Contact}
+    */
+    contact = "contact",
+    /**
+    * Hours of Service {@link HosCarrier|Carrier}s.
+    * {@link HosCarrier}
+    * @deprecated Feature retired
+    */
+    hosCarrier = "hosCarrier",
+    /**
+    * Driver's {@link HosEvent|E-log event} records.
+    * {@link HosEvent}
+    * @deprecated Feature retired
+    */
+    hosEvent = "hosEvent",
+    /**
+    * Driver {@link HosInspection|vehicle inspection} reports.
+    * {@link HosInspection}
+    * @deprecated Feature retired
+    */
+    hosInspection = "hosInspection",
+    /**
+    * Historical {@link Vehicle} and {@link Trailer} maintenance work.
+    * {@link MaintenanceJob}
+    */
+    maintenanceJob = "maintenanceJob",
+    /**
+    * Recurring {@link MaintenanceJob}s for {@link Vehicle} and {@link Trailer}.
+    * {@link MaintenanceSchedule}
+    */
+    maintenanceSchedule = "maintenanceSchedule",
+    /**
+    * Rules definiting real-time analytic calculations.
+    * {@link AnalyticRule}
+    * @deprecated Feature retired
+    */
+    analyticRule = "analyticRule",
+    /**
+    * Updates to the calculations of real-time analytics.
+    * {@link AnalyticSummary}
+    * @deprecated Feature retired
+    */
+    analyticSummary = "analyticSummary",
+    /**
+    *  {@link Icon} information.
+    * {@link Icon}
+    */
+    icon = "icon",
+    /**
+    *  {@link Picture} information.
+    * {@link Picture}
+    */
+    picture = "picture",
+    /**
+    * Hosted {@link Document} information.
+    * {@link Document}
+    */
+    document = "document",
+    /**
+    * Profile used to generate {@link BillingReport} for a customer.
+    * {@link BillingProfile}
+    */
+    billingProfile = "billingProfile",
+    /**
+    * Billing rule for {@link Asset}s.
+    * {@link BillableHostingRule}
+    */
+    billingHosting = "billingHosting",
+    /**
+    * Discount rule for {@link Asset}s.
+    * {@link BillableHostingDiscount}
+    * @deprecated Feature retired
+    */
+    billingDiscount = "billingDiscount",
+    /**
+    * Hardware License for {@link Provider}s.
+    * {@link BillableHostingLicense}
+    */
+    billingLicense = "billingLicense",
+    /**
+    * Generated bill for a {@link Company|customer}.
+    * {@link BillingReport}
+    */
+    billingReport = "billingReport",
+    /**
+    * Custom {@link FormTemplate|forms} to be filled.
+    * {@link FormTemplate}
+    */
+    formTemplate = "formTemplate",
+    /**
+    * Filled out {@link FormResult|forms}.
+    * {@link FormResult}
+    */
+    formResult = "formResult",
+    /**
+    * Some work that needs to be completed by an {@link Asset}.
+    * Like a multi-step {@link DispatchTask}.
+    * {@link DispatchJob}
+    */
+    dispatchJob = "dispatchJob"
+}
+//# sourceMappingURL=PermissionType.d.ts.map

package/Billing/Hosting/BillableHostingBase.d.ts

@@ -0,0 +1,42 @@
+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;
+}
+//# sourceMappingURL=BillableHostingBase.d.ts.map

package/Billing/Hosting/BillableHostingLicense.d.ts

@@ -0,0 +1,31 @@
+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;
+}
+//# sourceMappingURL=BillableHostingLicense.d.ts.map

package/Billing/Hosting/BillableHostingLicenseType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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"
+}
+//# sourceMappingURL=BillableHostingLicenseType.d.ts.map

package/Billing/Hosting/BillableHostingRule.d.ts

@@ -0,0 +1,31 @@
+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;
+}
+//# sourceMappingURL=BillableHostingRule.d.ts.map

package/Billing/Hosting/BillableHostingType.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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"
+}
+//# sourceMappingURL=BillableHostingType.d.ts.map

package/Billing/Report/BillingReport.d.ts

@@ -0,0 +1,113 @@
+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;
+}
+//# sourceMappingURL=BillingReport.d.ts.map

package/Billing/Report/BillingReportBreakdown.d.ts

@@ -0,0 +1,35 @@
+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[];
+    };
+}
+//# sourceMappingURL=BillingReportBreakdown.d.ts.map

package/Billing/Report/BillingReportHostingSummary.d.ts

@@ -0,0 +1,37 @@
+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;
+    };
+}
+//# sourceMappingURL=BillingReportHostingSummary.d.ts.map