@trakit/objects 0.0.6 → 0.0.7

package/_publish/objects/Accounts/Session.d.ts

@@ -1,89 +0,0 @@
-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/_publish/objects/Accounts/SessionStatus.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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/_publish/objects/Accounts/SystemsOfUnits.d.ts

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

package/_publish/objects/Accounts/User.d.ts

@@ -1,167 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { BaseCompound } from "../API/BaseCompound";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IEnabled } from "../API/Interfaces/IEnabled";
-import { IHavePermissions } from "../API/Interfaces/IHavePermissions";
-import { IHavePreferences } from "../API/Interfaces/IHavePreferences";
-import { Timezone } from "../API/Timezone";
-import { codified, datetimetemplate, email, JsonObject, nothing, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { Contact } from "./Contact";
-import { Permission } from "./Permissions/Permission";
-import { SystemsOfUnits } from "./SystemsOfUnits";
-import { UserAdvanced } from "./UserAdvanced";
-import { UserAuthentication } from "./UserAuthentication";
-import { UserGeneral } from "./UserGeneral";
-import { UserGroup } from "./UserGroup";
-import { UserMFA } from "./UserMFA";
-import { UserNotifications } from "./UserNotifications";
-import { UserSSO } from "./UserSSO";
-/**
- * A grouping of credentials, information, preferences, and permissions for a person or machine to login to the system and access its resources.
- */
-export declare class User extends BaseCompound implements IEnabled, IBelongCompany, IHavePermissions, IHavePreferences {
-    #private;
-    /**
-     *
-     */
-    get pieces(): BaseComponent[];
-    /**
-     * The unique public email address used to access the system.
-     * {@link User.login}
-     */
-    get login(): email;
-    /**
-     * The company to which this user belongs.
-     * {@link Company.id}
-     */
-    get companyId(): ulong;
-    /**
-     * The {@link Company} to which this user belongs.
-     */
-    get company(): Company;
-    /**
-     *
-     */
-    get general(): UserGeneral;
-    /**
-     * Indicates whether system access is disabled.
-     */
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    /**
-     * Human friendly name for these credentials
-     */
-    get nickname(): string;
-    set nickname(value: string);
-    /**
-     * Contact information for this user.
-     * {@link Contact.id}
-     */
-    get contactId(): ulong;
-    set contactId(value: ulong | nothing);
-    /**
-     * {@link Contact} information for this user.
-     */
-    get contact(): Contact;
-    set contact(value: Contact | nothing);
-    /**
-     * The user's local timezone.
-     */
-    get timezone(): Timezone;
-    set timezone(value: Timezone);
-    /**
-     * Preferred region/language for the UI and notifications.
-     * Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
-     */
-    get language(): codified;
-    set language(value: codified);
-    /**
-     * The format strings defining the preferred way to display ambiguous values.
-     */
-    get formats(): Map<codified, datetimetemplate>;
-    set formats(value: Map<codified, datetimetemplate>);
-    /**
-     * Preferred way of displaying ambiguous numbers in the context of measurements.
-     */
-    get measurements(): Map<codified, SystemsOfUnits>;
-    set measurements(value: Map<codified, SystemsOfUnits>);
-    /**
-     * Additional options which do not fit in with the formats or measurements preferences.
-     */
-    get options(): Map<codified, string>;
-    set options(value: Map<codified, string>);
-    /**
-     * Definition of how and when to send alerts to the user.
-     */
-    get notify(): UserNotifications[];
-    set notify(value: UserNotifications[]);
-    /**
-     *
-     */
-    get advanced(): UserAdvanced;
-    /**
-     * A list of {@link UserGroup}s to which this user belongs.
-     * {@link UserGroup.id}
-     */
-    get groupIds(): ulong[];
-    set groupIds(value: ulong[]);
-    /**
-     * A list of groups to which this user belongs.
-     */
-    get groups(): UserGroup[];
-    set groups(value: UserGroup[]);
-    /**
-     * Individual permission rules which override the group rules.
-     */
-    get permissions(): Permission[];
-    set permissions(value: Permission[]);
-    /**
-     *
-     */
-    get authentication(): UserAuthentication;
-    /**
-     * Indicated whether the credentials have expired according to the company's policy.
-     */
-    get passwordExpired(): boolean;
-    set passwordExpired(value: boolean);
-    /**
-     * Multi-factor authentication details for the user.
-     */
-    get mfa(): UserMFA[];
-    set mfa(value: UserMFA[]);
-    /**
-     * Single Sign-On details for the user.
-     */
-    get sso(): UserSSO;
-    set sso(value: UserSSO);
-    toJSON(): {
-        v: number[];
-        login: string;
-        company: number;
-        passwordExpired: boolean;
-        mfa: any[];
-        sso: {
-            enabled: boolean;
-            provider: import("./SSOIdentityProvider").SSOIdentityProvider;
-            lastAuthentication: string | null;
-            externalId: string | null;
-        };
-        groups: number[];
-        permissions: any[];
-        nickname: string;
-        enabled: boolean;
-        contact: boolean;
-        timezone: string;
-        language: string;
-        formats: JsonObject;
-        measurements: JsonObject;
-        options: JsonObject;
-        notify: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link login} is the key.
-     */
-    getKey(): string;
-}

package/_publish/objects/Accounts/UserAdvanced.d.ts

@@ -1,53 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IHavePermissions } from "../API/Interfaces/IHavePermissions";
-import { email, JsonObject, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { Permission } from "./Permissions/Permission";
-import { UserGroup } from "./UserGroup";
-/**
- * Permissions and group membership defined for a user.
- */
-export declare class UserAdvanced extends BaseComponent implements IBelongCompany, IHavePermissions {
-    /**
-     * The unique public email address used to access the system.
-     * {@link User.login}
-     */
-    login: email;
-    /**
-     * The company to which this user belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this user belongs.
-     */
-    get company(): Company;
-    /**
-     * A list of groups to which this user belongs.
-     * {@link UserGroup.id}
-     */
-    groupIds: ulong[];
-    /**
-     * A list of groups to which this user belongs.
-     * {@link UserGroup.id}
-     */
-    get groups(): UserGroup[];
-    set groups(value: UserGroup[]);
-    /**
-     * Individual permission rules which override the group rules.
-     */
-    permissions: Permission[];
-    toJSON(): {
-        login: string;
-        v: number[];
-        company: number;
-        groups: number[];
-        permissions: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link login} is the key.
-     */
-    getKey(): string;
-}

package/_publish/objects/Accounts/UserGeneral.d.ts

@@ -1,98 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IEnabled } from "../API/Interfaces/IEnabled";
-import { IHavePreferences } from "../API/Interfaces/IHavePreferences";
-import { Timezone } from "../API/Timezone";
-import { JsonObject, codified, datetimetemplate, email, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { Contact } from "./Contact";
-import { SystemsOfUnits } from "./SystemsOfUnits";
-import { UserNotifications } from "./UserNotifications";
-/**
- * Credentials, information, and preferences about a user.
- */
-export declare class UserGeneral extends BaseComponent implements IEnabled, IBelongCompany, IHavePreferences {
-    /**
-     * The unique public email address used to access the system.
-     * {@link User.login}
-     */
-    login: email;
-    /**
-     * The company to which this user belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this user belongs.
-     */
-    get company(): Company;
-    /**
-     * Indicated whether the credentials have expired according to the company's policy.
-     */
-    passwordExpired: boolean;
-    /**
-     * Indicates whether system access is disabled.
-     */
-    enabled: boolean;
-    /**
-     * Human friendly name for these credentials
-     */
-    nickname: string;
-    /**
-     * Contact information for this user.
-     * {@link Contact.id}
-     */
-    contactId: ulong;
-    /**
-     * {@link Contact} information for this user.
-     */
-    get contact(): Contact;
-    set contact(value: Contact);
-    /**
-     * The user's local timezone.
-     * {@link Timezone.code}
-     */
-    timezone: Timezone;
-    /**
-     * Preferred region/language for the UI and notifications.
-     * Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
-     */
-    language: codified;
-    /**
-     * The format strings defining the preferred way to display ambiguous values.
-     */
-    formats: Map<codified, datetimetemplate>;
-    /**
-     * Preferred way of displaying ambiguous numbers in the context of measurements.
-     */
-    measurements: Map<codified, SystemsOfUnits>;
-    /**
-     * Additional options which do not fit in with the formats or measurements preferences.
-
-     */
-    options: Map<codified, string>;
-    /**
-     * Definition of how and when to send alerts to the user.
-     */
-    notify: UserNotifications[];
-    toJSON(): {
-        login: string;
-        v: number[];
-        company: number;
-        nickname: string;
-        enabled: boolean;
-        contact: boolean;
-        passwordExpired: boolean;
-        timezone: string;
-        language: string;
-        formats: JsonObject;
-        measurements: JsonObject;
-        options: JsonObject;
-        notify: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link login} is the key.
-     */
-    getKey(): string;
-}

package/_publish/objects/Accounts/UserGroup.d.ts

@@ -1,51 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-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 "../Companies/Company";
-import { Permission } from "./Permissions/Permission";
-/**
- * Members of a group (as set by a {@link User}'s {@link UserAdvanced.groups} or {@link Machine}'s {@link Machine.groups})
- * allow for easy administration of permissions and levels of access.
- */
-export declare class UserGroup extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
-    /**
-     * Unique identifier of this group.
-     */
-    id: ulong;
-    /**
-     * The company to which this group belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this group belongs.
-     */
-    get company(): Company;
-    /**
-     * A name given to this group.
-     */
-    name: string;
-    /**
-     * Notes about this group, and to whom this group should be applied.
-     */
-    notes: string;
-    /**
-     * Permissions for this group.
-     */
-    permissions: Permission[];
-    toJSON(): {
-        id: number;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        permissions: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Accounts/UserNotifications.d.ts

@@ -1,76 +0,0 @@
-import { IEnabled } from "../API/Interfaces/IEnabled";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { TimeSpan } from "../API/TimeSpan";
-import { email, JsonObject, timespan, ulong } from "../API/Types";
-import { NotificationMethod } from "./NotificationMethod";
-/**
- * Definition of how and when to send alerts to the user.
- */
-export declare class UserNotifications implements IEnabled, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): UserNotifications;
-    /**
-     * A common name like "Weekdays" or "Off Hours".
-     */
-    name: string;
-    /**
-     * A flag for whether or not this schedule is in use.
-     */
-    enabled: boolean;
-    /**
-     * A 7 item, boolean array, determines if the user should be notified on that day of the week.
-     * The days of the week are defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    weekdays: boolean[];
-    /**
-     * Start time portion of the schedule that defines a period of the day when the user wants to receive alerts.
-     * The time value is defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    start: TimeSpan;
-    /**
-     * End time portion of the schedule that defines a period of the day when the user wants to receive alerts.
-     * The time value is defined in local time, not UTC.
-     * {@link UserGeneral.timezone}
-     */
-    end: TimeSpan;
-    /**
-     * Email address where the sent is sent.
-     * If not specified, the email address from the User's {@link Contact} is taken.
-     * If the contact has no email address, the alert is sent to the user's login.
-     */
-    email: email;
-    /**
-     * SMS address where the alert is sent.
-     * If not specified, the mobile phone number from the User's {@link Contact} is taken.
-     * If the contact has no mobile phone number, the alert is not sent.
-     */
-    sms: ulong;
-    /**
-     * A list of the types of methods to use to notify the user when they have an active WebSocket connection.
-     */
-    online: NotificationMethod[];
-    /**
-     * A list of the types of methods to use to notify the user when they are not connected.
-     */
-    offline: NotificationMethod[];
-    constructor(name?: string, enabled?: boolean, weekdays?: string | boolean[], start?: TimeSpan | timespan | number, end?: TimeSpan | timespan | number, email?: email, sms?: ulong, online?: NotificationMethod[], offline?: NotificationMethod[]);
-    /**
-     *
-     */
-    toJSON(): {
-        name: string;
-        enabled: boolean;
-        weekdays: string;
-        start: string;
-        end: string;
-        email: string;
-        sms: number | null;
-        online: NotificationMethod[];
-        offline: NotificationMethod[];
-    };
-}