@trakit/objects 0.0.16 → 0.0.17

package/objects/Companies/CompanyDirectory.d.ts

@@ -1,52 +0,0 @@
-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

@@ -1,55 +0,0 @@
-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

@@ -1,66 +0,0 @@
-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

@@ -1,166 +0,0 @@
-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

@@ -1,50 +0,0 @@
-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

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

package/objects/Companies/NotificationServerEmail.d.ts

@@ -1,99 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { email, JsonObject, uint, ushort } from "../API/Types";
-/**
- * The types of email protocols supported for incoming mail servers.
- */
-export declare enum IncomingEmailServerType {
-    /**
-     * Internet Message Access Protocol (default)
-     */
-    "IMAP" = "IMAP",
-    /**
-     * Post Office Protocol v3
-     */
-    "POP3" = "POP3"
-}
-/**
- * The types of email protocols supported for sending messages.
- */
-export declare enum OutgoingEmailServerType {
-    /**
-     * Simple Mail Transfer Protocol
-     */
-    "SMTP" = "SMTP"
-}
-/**
- * The server used for notification and conversational email messages sent and received by the system.
- */
-export declare class NotificationServerEmail implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): NotificationServerEmail;
-    /**
-     * The type of incoming protocol to use (IMAP or POP3).
-     */
-    incomingType: IncomingEmailServerType;
-    /**
-     * The domain or IP address of the incoming email server.
-     */
-    incomingAddress: string;
-    /**
-     * The port number of the incoming email server.
-     */
-    incomingPort: ushort;
-    /**
-     * The username used to login to the incoming email server.
-     */
-    incomingLogin: string;
-    /**
-     * Is the incoming email server using a secure SSL/TLS connection (it should).
-     */
-    incomingSecure: boolean;
-    /**
-     * Is the incoming email server 		/**
-     * IMAP message sequence number so only recent messages are retrieved.
-     */
-    incomingMessageNumber: uint;
-    /**
-     * The type of outgoing protocol to use (only SMTP).
-     */
-    outgoingType: OutgoingEmailServerType;
-    /**
-     * The domain or IP address of the outgoing email server.
-     */
-    outgoingAddress: string;
-    /**
-     * The port number of the outgoing email server.
-     */
-    outgoingPort: ushort;
-    /**
-     * The username used to login to the outgoing email server.
-     */
-    outgoingLogin: string;
-    /**
-     * Is the outgoing email server using a secure SSL/TLS connection (it should).
-     */
-    outgoingSecure: boolean;
-    /**
-     * Is the outgoing email server 		/**
-     * An optional field which can be set as the "sent from" and/or "reply-to" address.
-     */
-    outgoingReplyTo: email;
-    constructor(incomingType?: IncomingEmailServerType, incomingAddress?: string, incomingPort?: ushort, incomingLogin?: string, incomingSecure?: boolean, incomingMessageNumber?: uint, outgoingType?: OutgoingEmailServerType, outgoingAddress?: string, outgoingPort?: ushort, outgoingLogin?: string, outgoingSecure?: boolean, outgoingReplyTo?: string);
-    toJSON(): {
-        incomingType: IncomingEmailServerType;
-        incomingAddress: string;
-        incomingPort: number | null;
-        incomingLogin: string;
-        incomingSecure: boolean;
-        incomingMessageNumber: number | null;
-        outgoingType: OutgoingEmailServerType;
-        outgoingAddress: string;
-        outgoingPort: number | null;
-        outgoingLogin: string;
-        outgoingSecure: boolean;
-        outgoingReplyTo: string;
-    };
-}

package/objects/Companies/NotificationServerSms.d.ts

@@ -1,25 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { JsonObject, ulong, ushort } from "../API/Types";
-/**
- * Definition for load-balanced outbound SMS numbers for the White-labelling profile.
- */
-export declare class NotificationServerSms implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): NotificationServerSms;
-    /**
-     * A per-number/per-day limit on the amount of Notifications sent.
-     */
-    notifyLimit: ushort;
-    /**
-     * All phone numbers listed by the country (using two-digit ISO 3166-1 alpha-2 country codes) they each serve.
-     */
-    phoneNumbers: Map<string, ulong[]>;
-    constructor(notifyLimit?: ushort, phoneNumbers?: Map<string, ulong[]>);
-    toJSON(): {
-        notifyLimit: number | null;
-        phoneNumbers: JsonObject;
-    };
-}

package/objects/Companies/PasswordExpiryMode.d.ts

@@ -1,17 +0,0 @@
-/**
- * Defines how User passwords expire.
- */
-export declare enum PasswordExpiryMode {
-    /**
-     * Passwords never expire.
-     */
-    never = "never",
-    /**
-     * Passwords expire after a defined number of days.
-     */
-    days = "days",
-    /**
-     * Passwords expire after a defined number of successful logins.
-     */
-    sessions = "sessions"
-}

package/objects/Companies/PasswordPolicy.d.ts

@@ -1,51 +0,0 @@
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { byte, JsonObject } from "../API/Types";
-import { PasswordExpiryMode } from "./PasswordExpiryMode";
-/**
- * The password complexity and expiry policy.
- */
-export declare class PasswordPolicy implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): PasswordPolicy;
-    /**
-     * The minimum number of characters required.
-     */
-    minimumLength: byte;
-    /**
-     * Do passwords require alphabetical characters.
-     */
-    includeLetters: boolean;
-    /**
-     * Do passwords require numeric characters.
-     */
-    includeNumbers: boolean;
-    /**
-     * Do passwords require upper-case and lower-case letters.
-     */
-    includeUpperLower: boolean;
-    /**
-     * Do passwords require non-alphanumeric characters.
-     */
-    includeSpecial: boolean;
-    /**
-     * Defines how passwords expire.
-     */
-    expireMode: PasswordExpiryMode;
-    /**
-     * The threshold for expiry.
-     */
-    expireThreshold: byte;
-    constructor(minimumLength?: byte, includeLetters?: boolean, includeNumbers?: boolean, includeUpperLower?: boolean, includeSpecial?: boolean, expireMode?: PasswordExpiryMode, expireThreshold?: byte);
-    toJSON(): {
-        minimumLength: number | null;
-        includeLetters: boolean;
-        includeNumbers: boolean;
-        includeUpperLower: boolean;
-        includeSpecial: boolean;
-        expireMode: PasswordExpiryMode;
-        expireThreshold: number | null;
-    };
-}

package/objects/Companies/SessionMultiUser.d.ts

@@ -1,17 +0,0 @@
-/**
- * Defines the behaviour of the system when a user creates multiple sessions.
- */
-export declare enum SessionMultiUser {
-    /**
-     * Allow users to create multiple simultaneous sessions.
-     */
-    allow = "allow",
-    /**
-     * Deny users from creating new sessions if they already have an active session.
-     */
-    deny = "deny",
-    /**
-     * Allow users to create a new session, but automatically kill the previous session.
-     */
-    replace = "replace"
-}