@trakit/objects 0.0.14 → 0.0.16

package/objects/Companies/Company.d.ts

@@ -0,0 +1,167 @@
+import { Contact } from '../Accounts/Contact';
+import { BaseComponent } from '../API/BaseComponent';
+import { BaseCompound } from '../API/BaseCompound';
+import { IAmCompany } from '../API/Interfaces/IAmCompany';
+import { IBelongCompany } from '../API/Interfaces/IBelongCompany';
+import { IIdUlong } from '../API/Interfaces/IIdUlong';
+import { INamed } from '../API/Interfaces/INamed';
+import { JsonObject, codified, ulong } from '../API/Types';
+import { Picture } from '../Images/Picture';
+import { CompanyReseller } from './CompanyReseller';
+import { LabelStyle } from './LabelStyle';
+import { PasswordPolicy } from './PasswordPolicy';
+import { SessionPolicy } from './SessionPolicy';
+/**
+ * The full company object which contains all fields.
+ */
+export declare class Company extends BaseCompound implements IIdUlong, INamed, IAmCompany, IBelongCompany {
+    #private;
+    /**
+     *
+     */
+    get pieces(): BaseComponent[];
+    /**
+     * Unique identifier of this Company.
+     * {@link Asset.id}
+     */
+    get id(): ulong;
+    /**
+     * The parent organization for this {@link Company}.
+     */
+    get parent(): Company;
+    set parent(value: Company);
+    /**
+     * The unique identifier of the parent {@link Company}.
+     */
+    get parentId(): number;
+    set parentId(value: number);
+    /**
+     * The organizational name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Notes.
+     */
+    get notes(): string;
+    set notes(value: string);
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    get references(): Map<string, string>;
+    set references(value: Map<string, string>);
+    /**
+     * The list of Contacts from this and other companies broken down by contact role.
+     */
+    get employees(): Map<string, ulong[]>;
+    set employees(value: Map<string, ulong[]>);
+    /**
+     * The session lifetime policy.
+     */
+    get sessionPolicy(): SessionPolicy;
+    set sessionPolicy(value: SessionPolicy);
+    /**
+     * The password complexity and expiry policy.
+     */
+    get passwordPolicy(): PasswordPolicy;
+    set passwordPolicy(value: PasswordPolicy);
+    /**
+     * The styles for labels added to Assets, Places, and other things.
+     */
+    get labels(): Map<codified, LabelStyle>;
+    set labels(value: Map<codified, LabelStyle>);
+    /**
+     * The styles for status tags added to Assets.
+     */
+    get tags(): Map<codified, LabelStyle>;
+    set tags(value: Map<codified, LabelStyle>);
+    /**
+     * If this company is a reseller, then they have their own theme, support and billing information.
+     */
+    reseller: CompanyReseller | null;
+    /**
+     *
+     */
+    toJSON(): {
+        v: number[];
+        id: number | null;
+        parent: number;
+        contactInfo?: JsonObject | undefined;
+        serviceName?: string | undefined;
+        logo?: string | undefined;
+        icon?: string | undefined;
+        favourite?: string | undefined;
+        domain?: string | undefined;
+        website?: JsonObject | undefined;
+        graphics?: JsonObject | undefined;
+        languages?: string[] | undefined;
+        gamut?: JsonObject | undefined;
+        notifyEmail?: {
+            incomingType: import("./NotificationServerEmail").IncomingEmailServerType;
+            incomingAddress: string;
+            incomingPort: number | null;
+            incomingLogin: string;
+            incomingSecure: boolean;
+            incomingMessageNumber: number | null;
+            outgoingType: import("./NotificationServerEmail").OutgoingEmailServerType;
+            outgoingAddress: string;
+            outgoingPort: number | null;
+            outgoingLogin: string;
+            outgoingSecure: boolean;
+            outgoingReplyTo: string;
+        } | undefined;
+        notifySms?: {
+            notifyLimit: number | null;
+            phoneNumbers: JsonObject;
+        } | undefined;
+        termsPreamble?: string | undefined;
+        termsUpdated?: string | null | undefined;
+        recoverSubject?: string | undefined;
+        recoverBody?: string | undefined;
+        recoverIsHtml?: boolean | undefined;
+        sessionPolicy: {
+            applications: string[];
+            ipv4Ranges: string[];
+            multiUser: import("./SessionMultiUser").SessionMultiUser;
+            idleAllowed: boolean;
+            expireTimeout: number | null;
+            maxSessions: number | null;
+        };
+        passwordPolicy: {
+            minimumLength: number | null;
+            includeLetters: boolean;
+            includeNumbers: boolean;
+            includeUpperLower: boolean;
+            includeSpecial: boolean;
+            expireMode: import("./PasswordExpiryMode").PasswordExpiryMode;
+            expireThreshold: number | null;
+        };
+        labels: JsonObject;
+        tags: JsonObject;
+        directory: JsonObject;
+        name: string;
+        notes: string;
+        references: JsonObject;
+    };
+    /**
+     *
+     * @param json
+     */
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+    /**
+     *
+     */
+    get contacts(): Contact[];
+    /**
+     *
+     */
+    get pictures(): Picture[];
+}

package/objects/Companies/CompanyDirectory.d.ts

@@ -0,0 +1,52 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, codified, ulong } from "../API/Types";
+import { Company } from "./Company";
+/**
+ * The list of Contacts from this and other companies broken down by contact role.
+ */
+export declare class CompanyDirectory extends BaseComponent implements IIdUlong, IAmCompany, IBelongCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this {@link Company}'s parent organization.
+     */
+    get parent(): Company;
+    /**
+     * The list of {@link Contact}s from this and other companies broken down by contact role.
+     */
+    employees: Map<codified, ulong[]>;
+    /**
+     *
+     * @returns
+     */
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        directory: JsonObject;
+    };
+    /**
+     *
+     * @param json
+     */
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+}

package/objects/Companies/CompanyGeneral.d.ts

@@ -0,0 +1,55 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { JsonObject, ulong } from "../API/Types";
+import { Company } from "./Company";
+/**
+ * General details about a company.
+ */
+export declare class CompanyGeneral extends BaseComponent implements IIdUlong, INamed, IAmCompany, IBelongCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this {@link Company}'s parent organization.
+     */
+    get parent(): Company;
+    /**
+     * The organizational name.
+     */
+    name: string;
+    /**
+     * Notes.
+     */
+    notes: string;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        name: string;
+        notes: string;
+        references: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+}

package/objects/Companies/CompanyPolicy.d.ts

@@ -0,0 +1,66 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, ulong } from "../API/Types";
+import { Company } from "./Company";
+import { PasswordPolicy } from "./PasswordPolicy";
+import { SessionPolicy } from "./SessionPolicy";
+/**
+ * The password and session lifetime policies for this Company.
+ */
+export declare class CompanyPolicy extends BaseComponent implements IIdUlong, IAmCompany, IBelongCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this {@link Company}'s parent organization.
+     */
+    get parent(): Company;
+    /**
+     * The session lifetime policy.
+     */
+    sessionPolicy: SessionPolicy;
+    /**
+     * The password complexity and expiry policy.
+     */
+    passwordPolicy: PasswordPolicy;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        sessionPolicy: {
+            applications: string[];
+            ipv4Ranges: string[];
+            multiUser: import("./SessionMultiUser").SessionMultiUser;
+            idleAllowed: boolean;
+            expireTimeout: number | null;
+            maxSessions: number | null;
+        };
+        passwordPolicy: {
+            minimumLength: number | null;
+            includeLetters: boolean;
+            includeNumbers: boolean;
+            includeUpperLower: boolean;
+            includeSpecial: boolean;
+            expireMode: import("./PasswordExpiryMode").PasswordExpiryMode;
+            expireThreshold: number | null;
+        };
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+}

package/objects/Companies/CompanyReseller.d.ts

@@ -0,0 +1,166 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, codified, colour, ulong } from "../API/Types";
+import { ColourStyle } from "./ColourStyle";
+import { Company } from "./Company";
+import { NotificationServerEmail } from "./NotificationServerEmail";
+import { NotificationServerSms } from "./NotificationServerSms";
+/**
+ * Defines the seller company's details for white-labelling.
+ */
+export declare class CompanyReseller extends BaseComponent implements IIdUlong, IAmCompany, IBelongCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this {@link Company}'s parent organization.
+     */
+    get parent(): Company;
+    /**
+     * A list of {@link Contact}s for company specific things like Technical Support, Billing, etc...
+     */
+    contactInfo: Map<string, ulong>;
+    /**
+     * The name of the branded service being provided to the seller's customers.
+     */
+    serviceName: string;
+    /**
+     * The name of the image uploaded as the logo (used for regular view).
+     */
+    logo: string;
+    /**
+     * The name of the image uploaded as the logo (used for collapsed/mobile view).
+     */
+    icon: string;
+    /**
+     * The name of the icon file used for browser bookmarks.
+     */
+    favourite: string;
+    /**
+     * The URN and path to the instance of v4.
+     * It does not contain the protocol because all instances are required to be HTTPS.
+     */
+    domain: string;
+    /**
+     * Themed colours used in the web-based UI.
+     */
+    website: Map<string, colour>;
+    /**
+     * A list of symbol names and their corresponding FontAwesome icon names.
+     */
+    graphics: Map<string, codified>;
+    /**
+     * A list of supported languages for your customers.
+     */
+    languages: string[];
+    /**
+     * Colours used as templates for status tags, labels, and places.
+     */
+    gamut: Map<string, ColourStyle>;
+    /**
+     * The server used for notification and conversational email messages sent and received by the system.
+     */
+    notifyEmail: NotificationServerEmail;
+    /**
+     * Definition for load-balanced outbound SMS numbers for the reseller.
+     */
+    notifySms: NotificationServerSms;
+    /**
+     * A preamble to the general terms and conditions offered by Fleet Freedom.
+     */
+    termsPreamble: string;
+    /**
+     * The date and time when the terms were updated.
+     * This will promt users who are logging-in to re-agree to the new terms
+     */
+    termsUpdated: Date;
+    /**
+     * The subject of the email sent to a user requesting a password reset.
+     * @tutorial The following strings are replaced:
+     * - %SERVICE%   with {serviceName}
+     * - %URL%       with https://{URN}/recover
+     * - %NAME%      with user's nickname, contact name, or login
+     * - %GUID%      with the unique identifier of the reset request
+     * - %CLIENT%    with the client software's userAgent used to create the request
+     * - %IP%        with IP address used to create the request
+     * - %SERVER%    with the server software's userAgent or the software (Kraken, Medusa, Mindflayer)
+     */
+    recoverSubject: string;
+    /**
+     * The body of the email sent to a user requesting a password reset.
+     * @tutorial The following strings are replaced:
+     * - %SERVICE%   with {serviceName}
+     * - %URL%       with https://{URN}/recover
+     * - %NAME%      with user's nickname, contact name, or login
+     * - %GUID%      with the unique identifier of the reset request
+     * - %CLIENT%    with the client software's userAgent used to create the request
+     * - %IP%        with IP address used to create the request
+     * - %SERVER%    with the server software's userAgent or the software (Kraken, Medusa, Mindflayer)
+     */
+    recoverBody: string;
+    /**
+     * When true, sends the password reset email as an HTML email instead of plain text.
+     * @tutorial When false, the following strings are replaced:
+     * - &reg;    with char 0174
+     * - &trade;  with char 8482
+     * - &copy;   with char 0169
+     * - &amp;    with "&"
+     */
+    recoverIsHtml: boolean;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        contactInfo: JsonObject;
+        serviceName: string;
+        logo: string;
+        icon: string;
+        favourite: string;
+        domain: string;
+        website: JsonObject;
+        graphics: JsonObject;
+        languages: string[];
+        gamut: JsonObject;
+        notifyEmail: {
+            incomingType: import("./NotificationServerEmail").IncomingEmailServerType;
+            incomingAddress: string;
+            incomingPort: number | null;
+            incomingLogin: string;
+            incomingSecure: boolean;
+            incomingMessageNumber: number | null;
+            outgoingType: import("./NotificationServerEmail").OutgoingEmailServerType;
+            outgoingAddress: string;
+            outgoingPort: number | null;
+            outgoingLogin: string;
+            outgoingSecure: boolean;
+            outgoingReplyTo: string;
+        };
+        notifySms: {
+            notifyLimit: number | null;
+            phoneNumbers: JsonObject;
+        };
+        termsPreamble: string;
+        termsUpdated: string | null;
+        recoverSubject: string;
+        recoverBody: string;
+        recoverIsHtml: boolean;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+}

package/objects/Companies/CompanyStyle.d.ts

@@ -0,0 +1,50 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { JsonObject, codified, ulong } from "../API/Types";
+import { Company } from "./Company";
+import { LabelStyle } from "./LabelStyle";
+/**
+ * The colours and styles used by this company to tag and label Assets, Places, and other things.
+ */
+export declare class CompanyStyle extends BaseComponent implements IIdUlong, IAmCompany, IBelongCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this {@link Company}'s parent organization.
+     */
+    get parent(): Company;
+    /**
+     * The styles for labels added to Assets, Places, and other things.
+     */
+    labels: Map<codified, LabelStyle>;
+    /**
+     * The styles for status tags added to Assets.
+     */
+    tags: Map<codified, LabelStyle>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        labels: JsonObject;
+        tags: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    set companyId(value: number);
+    get companyId(): number;
+    set company(value: Company);
+    get company(): Company;
+}

package/objects/Companies/LabelStyle.d.ts

@@ -0,0 +1,46 @@
+import { INamed } from "../API/Interfaces/INamed";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { IVisual } from "../API/Interfaces/IVisual";
+import { codified, colour, JsonObject } from "../API/Types";
+/**
+ * Visual style identification helper.
+ */
+export declare class LabelStyle implements INamed, IVisual, ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): LabelStyle;
+    /**
+     * The name of this visual style.
+     */
+    name: string;
+    /**
+     * The background colour given to this style for easy visual identification.
+     */
+    fill: colour;
+    /**
+     * The text/graphic colour given to this style for easy visual identification.
+     */
+    stroke: colour;
+    /**
+     * The codified graphic name given to this script for easy visual identification.
+     */
+    graphic: codified;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The codified name of this style
+     */
+    get code(): codified;
+    constructor(name?: string, fill?: colour, stroke?: colour, graphic?: codified, notes?: string);
+    toJSON(): {
+        name: string;
+        notes: string;
+        fill: string;
+        stroke: string;
+        graphic: string;
+    };
+}