@trakit/objects 0.0.15 → 0.0.16

package/objects/Accounts/Permissions/Permission.d.ts

@@ -0,0 +1,56 @@
+import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
+import { ISerializable } from '../../API/Interfaces/ISerializable';
+import { codified, JsonObject, nothing, ulong } from '../../API/Types';
+import { Company } from '../../Companies/Company';
+import { PermissionLevel } from './PermissionLevel';
+import { PermissionMethod } from './PermissionMethod';
+import { PermissionType } from './PermissionType';
+/**
+ * A defined permission for {@link User}s, {@link UserGroup}s, and {@link Machine}s.
+ */
+export declare class Permission implements IBelongCompany, ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: JsonObject): Permission;
+    /**
+     * The {@link Company.id} that this permission targets.
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} that this permission targets.
+     */
+    get company(): Company;
+    /**
+     * The type of permission.
+     */
+    kind: PermissionType;
+    /**
+     * The kind of permission.
+     * @deprecated Use {@link kind} instead.
+     */
+    get type(): string;
+    set type(value: string);
+    /**
+     * The level of access being defined.
+     */
+    level: PermissionLevel;
+    /**
+     * The way the access is used.
+     */
+    method: PermissionMethod;
+    /**
+     * Codified names of {@link LabelStyle}s.  If list is empty, this permission applies for all labels.
+     */
+    labels: codified[];
+    constructor(company?: ulong | nothing, kind?: PermissionType | nothing, level?: PermissionLevel | nothing, method?: PermissionMethod | nothing, labels?: codified[] | nothing);
+    toJSON(): {
+        company: number | null;
+        kind: PermissionType;
+        level: PermissionLevel;
+        method: PermissionMethod;
+        labels: string[];
+    };
+}

package/objects/Accounts/Permissions/PermissionEscalation.d.ts

@@ -0,0 +1,41 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, JsonObject, nothing, ulong } from "../../API/Types";
+import { PermissionEscalationState } from "./PermissionEscalationState";
+import { PermissionEscalationType } from "./PermissionEscalationType";
+import { PermissionLevel } from "./PermissionLevel";
+import { PermissionType } from "./PermissionType";
+/**
+ * Used to throw permission escalation exceptions, this is similar to a {@link Permission},
+ * but defines a {@link before} and {@link after} for a proposed change.
+ */
+export declare class PermissionEscalation implements ISerializable {
+    /**
+     * Parses a JSON object into a PermissionEscalation instance.
+     * @param json The JSON to parse.
+     * @returns A PermissionEscalation instance.
+     */
+    static fromJSON(json: JsonObject): PermissionEscalation;
+    /**
+     * Gets the direction of the escalation.
+     */
+    direction: PermissionEscalationType;
+    /**
+     * The {@link Company} that this permission targets.
+     * {@link Company.id}
+     */
+    company: ulong;
+    /**
+     * The type of permission.
+     */
+    kind: PermissionType;
+    /**
+     * Effective permission after the proposed change.
+     */
+    after: PermissionEscalationState;
+    /**
+     * Effective permission before the proposed change.
+     */
+    before: PermissionEscalationState;
+    constructor(direction: PermissionEscalationType, company: ulong, kind: PermissionType, levelAfter: PermissionLevel, labelsAfter?: codified[] | nothing, levelBefore?: PermissionLevel | nothing, labelsBefore?: codified[] | nothing);
+    toJSON(): JsonObject;
+}

package/objects/Accounts/Permissions/PermissionEscalationState.d.ts

@@ -0,0 +1,19 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, JsonObject, nothing } from "../../API/Types";
+import { PermissionLevel } from "./PermissionLevel";
+/**
+ * Describes the changes in state that raised the escalation.
+ */
+export declare class PermissionEscalationState implements ISerializable {
+    /**
+     * The level of access defined before the proposed change.
+     */
+    level: PermissionLevel | null;
+    /**
+     * Codified names of {@link LabelStyle}s.
+     * If list is empty, this permission applies for all labels.
+     */
+    labels: codified[] | null;
+    constructor(level?: PermissionLevel | nothing, labels?: codified[] | nothing);
+    toJSON(): JsonObject;
+}

package/objects/Accounts/Permissions/PermissionEscalationType.d.ts

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

package/objects/Accounts/Permissions/PermissionLevel.d.ts

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

package/objects/Accounts/Permissions/PermissionMethod.d.ts

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

package/objects/Accounts/Permissions/PermissionType.d.ts

@@ -0,0 +1,280 @@
+/**
+ * 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"
+}

package/objects/Accounts/SSOIdentityProvider.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Supported SSO Identity Providers.
+ */
+export declare enum SSOIdentityProvider {
+    /**
+     * Google Identity Provider.
+     */
+    google = "google",
+    /**
+     * Apple Identity Provider.
+     */
+    apple = "apple",
+    /**
+     * Facebook Identity Provider.
+     */
+    facebook = "facebook",
+    /**
+     * X Identity Provider, formerly known as Twitter.
+     */
+    twitter = "twitter",
+    /**
+     * Microsoft Identity Provider.
+     */
+    microsoft = "microsoft"
+}

package/objects/Accounts/Session.d.ts

@@ -0,0 +1,89 @@
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IDeserializable } from "../API/Interfaces/IDeserializable";
+import { IRequestable } from "../API/Interfaces/IRequestable";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { int, JsonObject, nothing, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { SessionStatus } from "./SessionStatus";
+/**
+ * Information about another {@link User}'s {@link Session}.
+ */
+export declare class Session implements IBelongCompany, IRequestable, ISerializable, IDeserializable {
+    /**
+     * A "handle" identifying a resource.
+     */
+    handle: string;
+    /**
+     * Getter shortcut for the {@link User}'s {@link Company.id}.
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this contact belongs
+     */
+    get company(): Company;
+    /**
+     * The IP address of the {@link User} last used to connect using this session.
+     */
+    ipAddress: string;
+    /**
+     * `UserAgent` identification string
+     */
+    userAgent: string;
+    /**
+     * The IP address the user last used to connect
+    /**
+     * The number of currently connected WebSocket clients.
+     */
+    sockets: int;
+    /**
+     * The {@link User} to which the {@link Session} belongs.
+     * {@link User.login}
+     */
+    login: string;
+    /**
+     * This {@link Session}'s current state.
+     */
+    status: SessionStatus;
+    /**
+     * The timestamp from the moment this {@link Session} was created.
+     */
+    created: Date;
+    /**
+     * A timestamp for when the {@link RespSession} will expire.
+     */
+    expiry: Date;
+    /**
+     * The name or path of the last command executed.
+     */
+    lastCommand: string;
+    /**
+     * A timestamp from the last command or call to the system.
+     */
+    lastActivity: Date;
+    /**
+     * Indicator that this {@link Session} is using at least one WebSocket connection.
+     */
+    get active(): boolean;
+    constructor(json?: JsonObject | nothing);
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     *
+     */
+    toJSON(): {
+        handle: string;
+        company: number | null;
+        login: string;
+        status: SessionStatus;
+        userAgent: string;
+        ipAddress: string;
+        created: string;
+        expires: string;
+        lastActivity: string;
+        lastCommand: string;
+        sockets: number;
+    };
+    /**
+     * The {@link handle} is the key.
+     */
+    getKey(): string;
+}

package/objects/Accounts/SessionStatus.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Current state of a session
+ */
+export declare enum SessionStatus {
+    /**
+     * Invalid session reference.
+     */
+    notFound = "notFound",
+    /**
+     * Session created but user hasn't logged-in yet.
+     */
+    created = "created",
+    /**
+     * User is logged-in and one or more WebSocket connections are open.
+     */
+    active = "active",
+    /**
+     * User is logged-in but no WebSocket connections are open.
+     */
+    idle = "idle",
+    /**
+     * User is logged-in and password is expired and needs to be changed before any commands can be processed.
+     */
+    passwordExpired = "passwordExpired",
+    /**
+     * Session is being killed because it has expired.
+     */
+    expired = "expired"
+}

package/objects/Accounts/SystemsOfUnits.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A type of measurement system
+ */
+export declare enum SystemsOfUnits {
+    /**
+     * Metric
+     */
+    metric = "metric",
+    /**
+     * US Standard.
+     */
+    standard = "standard"
+}