@trakit/commands 0.0.5 → 0.0.6

package/commands/Accounts/Self/Requests/PaySelfLogout.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-import { Payload } from "../../../API/Requests/Payload";
-/**
- *
- **/
-export declare class PaySelfLogout extends Payload {
-    getAction(): {
-        kind: "Delete";
-        object: "Self";
-        filter: "Logout";
-        batch: false;
-    };
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Self/Requests/PaySelfPassword.d.ts

@@ -1,25 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Allows a {@link User} to change their own password.
- **/
-export declare class PaySelfPassword extends Payload {
-    /**
-     * Your current password, as verification that you are the proper account owner.
-     **/
-    current: string;
-    /**
-     * Your new password must conform to your company's {@link PasswordPolicy|password policy}.
-     **/
-    password: string;
-    constructor(json?: JsonObject);
-    getAction(): {
-        kind: "Merge";
-        object: "Self";
-        filter: "Password";
-        batch: false;
-    };
-    createReply(json: JsonObject): Reply;
-    toJSON(): any;
-}

package/commands/Accounts/Self/Requests/PaySelfPreferences.d.ts

@@ -1,46 +0,0 @@
-import { JsonObject, nothing, SystemsOfUnits, Timezone, UserNotifications } from "@trakit/objects";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Allows a session {@link User} to change their own preferences.
- **/
-export declare class PaySelfPreferences extends Payload {
-    /**
-     * 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: string | nothing;
-    /**
-     * Your local {@link Timezone} used to calculate times.
-     * @see {@link Timezone.code}
-     **/
-    timezone: Timezone | nothing;
-    /**
-     * List of {@link UserNotifications} preferences.
-     * Please note that active times cannot overlap.
-     **/
-    notify: UserNotifications[] | nothing;
-    /**
-     * Formatting help for dates, times, numbers.
-     **/
-    formats: Map<string, string | nothing> | nothing;
-    /**
-     * Preferred way of displaying ambiguous numbers in the context of measurements.
-     **/
-    measurements: Map<string, SystemsOfUnits | nothing> | nothing;
-    /**
-     * Additional options which do not fit in with the formats or measurements preferences.
-     * If a value of null is given, the option is removed.  To keep the option, you can use a blank string.
-     * For convenience, if the value of an option is given as JSON (instead of a string), they are automatically serialized with no white-space.
-     **/
-    options: Map<string, string | nothing> | nothing;
-    constructor(json?: JsonObject);
-    getAction(): {
-        kind: "Merge";
-        object: "Self";
-        filter: "Preferences";
-        batch: false;
-    };
-    createReply(json: JsonObject): Reply;
-    toJSON(): any;
-}

package/commands/Accounts/Self/Responses/RepSelfContact.d.ts

@@ -1,6 +0,0 @@
-import { Reply } from "../../../API/Responses/Reply";
-/**
- *
- **/
-export declare class RepSelfContact extends Reply {
-}

package/commands/Accounts/Self/Responses/RepSelfGet.d.ts

@@ -1,47 +0,0 @@
-import { email, guid, JsonObject, Machine, nothing, PasswordPolicy, SessionPolicy, User } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * A container for the {@link User} or {@link Machine} of the current session.
- **/
-export declare class RepSelfGet extends Reply {
-    /**
-     * Your session identifier.
-     **/
-    ghostId: guid;
-    /**
-     * The timestamp of when this session expires.
-     **/
-    expiry: Date;
-    /**
-     * This session's {@link User} details (if the service is being used by a {@link User}).
-     * If this value is not present, then the session is not yet authenticated.
-     **/
-    get user(): User | nothing;
-    /**
-     *
-     */
-    userLogin: email | nothing;
-    /**
-     * This {@link Machine}'s details (if the service is being used by a {@link Machine}).
-     * If this value is not present, then the session is not a machine account.
-     **/
-    get machine(): Machine | nothing;
-    /**
-     *
-     */
-    machineKey: string | nothing;
-    /**
-     * This {@link User}'s {@link CompanyPolicies.sessionPolicy}.
-     **/
-    sessionPolicy: SessionPolicy | nothing;
-    /**
-     * This {@link User}'s {@link CompanyPolicies.passwordPolicy}.
-     **/
-    passwordPolicy: PasswordPolicy | nothing;
-    /**
-     * The UTC date/time of the server hosting the connection.
-     **/
-    serverTime: Date;
-    constructor(json?: JsonObject);
-    toJSON(): JsonObject;
-}

package/commands/Accounts/Self/Responses/RepSelfLogout.d.ts

@@ -1,16 +0,0 @@
-import { guid, JsonObject, nothing } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * The response for a logout operation which is always successful.
- **/
-export declare class RepSelfLogout extends Reply {
-    /**
-     * Your old, no longer valid, session identifier.
-     **/
-    ghostId: guid | nothing;
-    /**
-     * The timestamp from when your session expired.
-     **/
-    expiry: Date;
-    constructor(json: JsonObject);
-}

package/commands/Accounts/Self/Responses/RepSelfPassword.d.ts

@@ -1,16 +0,0 @@
-import { JsonObject, nothing, PasswordPolicy } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- *
- **/
-export declare class RepSelfPassword extends Reply {
-    /**
-     * Specific date/time of when the password will expire.
-     **/
-    expires: Date;
-    /**
-     * Your {@link Company}'s {@link PasswordPolicy|password policy}.
-     **/
-    passwordPolicy: PasswordPolicy | nothing;
-    constructor(json: JsonObject);
-}

package/commands/Accounts/Self/Responses/RepSelfPreferences.d.ts

@@ -1,6 +0,0 @@
-import { Reply } from "../../../API/Responses/Reply";
-/**
- *
- **/
-export declare class RepSelfPreferences extends Reply {
-}

package/commands/Accounts/Sessions/Requests/Parameters/ParamHandle.d.ts

@@ -1,11 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-/**
- * A container class used to house the "handle" identifying a session.
- **/
-export declare class ParamHandle {
-    /**
-     * A "handle" identifying a session.
-     **/
-    handle: string;
-    constructor(json?: JsonObject);
-}

package/commands/Accounts/Sessions/Requests/PaySessionDelete.d.ts

@@ -1,9 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-import { PaySessionGet } from "./PaySessionGet";
-/**
- * Terminates a {@link Session} and forces the {@link User} to log back in.
- **/
-export declare class PaySessionDelete extends PaySessionGet {
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Sessions/Requests/PaySessionGet.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-import { ParamHandle } from "./Parameters/ParamHandle";
-/**
- * Gets details of the specified {@link Session}.
- **/
-export declare class PaySessionGet extends Payload {
-    /**
-     * An object to contain the "handle" of the {@link Session}.
-     **/
-    session: ParamHandle;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Sessions/Requests/PaySessionList.d.ts

@@ -1,29 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayListByCompany } from "../../../API/Requests/IPayListByCompany";
-import { IPayListByUser } from "../../../API/Requests/IPayListByUser";
-import { ParamId } from "../../../API/Requests/Parameters/ParamId";
-import { ParamLogin } from "../../../API/Requests/Parameters/ParamLogin";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Gets the list of {@link Session} for the specified {@link Company}.
- **/
-export declare class PaySessionListByCompany extends Payload implements IPayListByCompany {
-    /**
-     * An object to contain the "id" of the {@link Company}.
-     **/
-    company: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}
-/**
- * Gets the list of {@link Session}s for the specified {@link User}.
- **/
-export declare class PaySessionListByUser extends Payload implements IPayListByUser {
-    /**
-     * An object to contain the "login" of the {@link User}.
-     **/
-    user: ParamLogin;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Sessions/Responses/Content/SessionHandle.d.ts

@@ -1,25 +0,0 @@
-import { JsonObject, nothing, ulong } from "@trakit/objects";
-/**
- * A container class used to house the "handle" identifying a {@link Session}.
- **/
-export declare class SessionHandle {
-    /**
-     * A "handle" identifying a resource.
-     **/
-    handle: string;
-    /**
-     * Identifier of the {@link Company} to which this object belongs
-     * @see {@link Company.id}
-     **/
-    company: ulong | nothing;
-    /**
-     * The {@link User} to which the {@link Session} belongs.
-     * @see {@link User.login}
-     **/
-    login: string;
-    /**
-     * A timestamp for when the {@link Session} will expire.
-     **/
-    expiry: Date;
-    constructor(json: JsonObject);
-}

package/commands/Accounts/Sessions/Responses/RepSessionDelete.d.ts

@@ -1,14 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { ReplySyncDelete } from "../../../API/Responses/ReplySyncDelete";
-import { SessionHandle } from "./Content/SessionHandle";
-/**
- * A container for the {@link User} of the current session.
- **/
-export declare class RepSessionDelete extends ReplySyncDelete {
-    /**
-     * An object which contains the {@link Session.handle}, related {@link User.login}, and owning {@link User.company} id.
-     **/
-    session: SessionHandle;
-    constructor(json: JsonObject);
-    protected _getKey(): string;
-}

package/commands/Accounts/Sessions/Responses/RepSessionGet.d.ts

@@ -1,14 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Session } from "@trakit/objects";
-import { ReplySyncGet } from "../../../API/Responses/ReplySyncGet";
-/**
- * A container for the {@link User} of the current session.
- **/
-export declare class RepSessionGet extends ReplySyncGet<Session> {
-    /**
-     * The requested {@link Session} details.
-     **/
-    session: Session;
-    constructor(json: JsonObject);
-    getObject(): Session;
-}

package/commands/Accounts/Sessions/Responses/RepSessionList.d.ts

@@ -1,37 +0,0 @@
-import { codified, email, guid, JsonObject, Session, ulong } from "@trakit/objects";
-import { ContentId } from "../../../API/Responses/Content/ContentId";
-import { ContentLoginCompany } from "../../../API/Responses/Content/ContentLoginCompany";
-import { ReplySyncList } from "../../../API/Responses/ReplySyncList";
-/**
- * A container for the requested {@link sessions}.
- **/
-export declare abstract class RepSessionList extends ReplySyncList<Session> {
-    /**
-     * The list of requested {@link Session}.
-     **/
-    sessions: Session[];
-    constructor(json: JsonObject);
-    getCollection(): Session[];
-}
-/**
- * Contains the {@link Company.id} of the collection.
- **/
-export declare class RepSessionListByCompany extends RepSessionList {
-    /**
-     * An object to contain the "id" of the {@link Company} to which the array of {@link Session}s belong.
-     **/
-    company: ContentId;
-    constructor(json: JsonObject);
-    _filterCollection(pair: [ulong | guid | email | codified | string, Session], index: number): boolean;
-}
-/**
- * Contains the {@link User.login} of the collection.
- **/
-export declare class RepSessionListByUser extends RepSessionList {
-    /**
-     * An object to contain the "login" of the {@link User} to which the array of {@link Session}s belong.
-     **/
-    user: ContentLoginCompany;
-    constructor(json: JsonObject);
-    _filterCollection(pair: [ulong | guid | email | codified | string, Session], index: number): boolean;
-}

package/commands/Accounts/Users/Requests/Parameters/ParamUserMerge.d.ts

@@ -1,74 +0,0 @@
-import { JsonObject, nothing, SystemsOfUnits, Timezone, ulong, UserNotifications } from "@trakit/objects";
-import { ParamMergeSubscribable } from "../../../../API/Requests/Parameters/ParamMergeSubscribable";
-import { ParamPermission } from "../../../Permissions/ParamPermission";
-/**
- * Parameters used to create or update an {@link User}.
- **/
-export declare class ParamUserMerge extends ParamMergeSubscribable {
-    /**
-     * The unique identifier of the {@link User} you want to update.
-     **/
-    login: string;
-    /**
-     * The company to which this {@link User} belongs.
-     * After creation, this value is read-only.
-     **/
-    company: ulong | nothing;
-    /**
-     * Human friendly name for these credentials
-     **/
-    nickname: string | nothing;
-    /**
-     * This {@link User}'s password.
-     **/
-    password: string | nothing;
-    /**
-     * Indicated whether the credentials have expired according to the company's policy.
-     **/
-    passwordExpired: boolean | nothing;
-    /**
-     * Indicates whether system access is disable.
-     **/
-    enabled: boolean | nothing;
-    /**
-     * Contact information for this {@link User}.
-     * @see {@link Contact.id}
-     **/
-    contact: ulong | nothing;
-    /**
-     * The {@link User}'s local timezone.
-     * @see {@link Timezone.code}
-     **/
-    timezone: Timezone | nothing;
-    /**
-     * 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: string | nothing;
-    /**
-     * The format strings defining the preferred way to display ambiguous values.
-     **/
-    formats: Map<string, string> | nothing;
-    /**
-     * Preferred way of displaying ambiguous numbers in the context of measurements.
-     **/
-    measurements: Map<string, SystemsOfUnits | nothing> | nothing;
-    /**
-     * Additional options which do not fit in with the formats or measurements preferences.
-     **/
-    options: Map<string, string> | nothing;
-    /**
-     * Definition of how and when to send alerts to the {@link User}.
-     **/
-    notify: UserNotifications[] | nothing;
-    /**
-     * A list of {@link UserGroup}s to which this {@link User} is a member.
-     **/
-    groups: ulong[] | nothing;
-    /**
-     * Individual permission rules which override the {@link UserGroup} rules.
-     **/
-    permissions: ParamPermission[] | nothing;
-    constructor(json?: JsonObject);
-    toJSON(): any;
-}

package/commands/Accounts/Users/Requests/PayUser.d.ts

@@ -1,18 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPaySingle } from "../../../API/Requests/IPaySingle";
-import { ParamLogin } from "../../../API/Requests/Parameters/ParamLogin";
-import { Payload } from "../../../API/Requests/Payload";
-/**
- * A container for the {@link user} object.
- **/
-export declare abstract class PayUser extends Payload implements IPaySingle {
-    /**
-     * An object to contain the "id" of the {@link User}.
-     **/
-    user: ParamLogin;
-    constructor(json?: JsonObject);
-    /**
-     *
-     **/
-    getKey(): string;
-}

package/commands/Accounts/Users/Requests/PayUserAdvancedGet.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { Reply } from "../../../API/Responses/Reply";
-import { PayUser } from "./PayUser";
-/**
- * Gets details of the specified {@link UserAdvanced}.
- **/
-export declare class PayUserAdvancedGet extends PayUser implements IPayDeletable {
-    /**
-     * When true, the command will also return a deleted {@link UserAdvanced} (if it exists).
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserAdvancedList.d.ts

@@ -1,38 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { IPayListByCompany } from "../../../API/Requests/IPayListByCompany";
-import { ParamId } from "../../../API/Requests/Parameters/ParamId";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Gets a list of {@link UserAdvanced}s.
- **/
-export declare abstract class PayUserAdvancedList extends Payload implements IPayDeletable {
-    /**
-     * When true, the command will also return a deleted {@link UserAdvanced} (if it exists).
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-}
-/**
- * Gets the list of {@link UserAdvanced}s for the specified {@link Company}.
- **/
-export declare class PayUserAdvancedListByCompany extends PayUserAdvancedList implements IPayListByCompany {
-    /**
-     * Identifier of the {@link Company} to which this collection belongs.
-     **/
-    company: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}
-/**
- * Gets the list of {@link UserAdvanced}s for the specified {@link UserGroup}.
- **/
-export declare class PayUserAdvancedListByUserGroup extends PayUserAdvancedList {
-    /**
-     * Identifier of the {@link Group} to which this collection belongs.
-     **/
-    group: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserBatchDelete.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { ParamLogin } from "../../../API/Requests/Parameters/ParamLogin";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- *
- **/
-export declare class PayUserBatchDelete extends Payload {
-    /**
-     *
-     **/
-    users: ParamLogin[];
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserBatchMerge.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-import { ParamUserMerge } from "./Parameters/ParamUserMerge";
-/**
- *
- **/
-export declare class PayUserBatchMerge extends Payload {
-    /**
-     *
-     **/
-    users: ParamUserMerge[];
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserDelete.d.ts

@@ -1,9 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { Reply } from "../../../API/Responses/Reply";
-import { PayUser } from "./PayUser";
-/**
- * Deletes an existing {@link User}.
- **/
-export declare class PayUserDelete extends PayUser {
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserGeneralGet.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { Reply } from "../../../API/Responses/Reply";
-import { PayUser } from "./PayUser";
-/**
- * Gets details of the specified {@link UserGeneral}.
- **/
-export declare class PayUserGeneralGet extends PayUser implements IPayDeletable {
-    /**
-     * When true, the command will also return a deleted {@link UserGeneral} (if it exists).
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserGeneralList.d.ts

@@ -1,38 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { IPayListByCompany } from "../../../API/Requests/IPayListByCompany";
-import { ParamId } from "../../../API/Requests/Parameters/ParamId";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Gets a list of {@link UserGeneral}s.
- **/
-export declare abstract class PayUserGeneralList extends Payload implements IPayDeletable {
-    /**
-     * When true, the command will also return a deleted {@link UserGeneral} (if it exists).
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-}
-/**
- * Gets the list of {@link UserGeneral}s for the specified {@link Company}.
- **/
-export declare class PayUserGeneralListByCompany extends PayUserGeneralList implements IPayListByCompany {
-    /**
-     * Identifier of the {@link Company} to which this collection belongs.
-     **/
-    company: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}
-/**
- * Gets the list of {@link UserGeneral}s for the specified {@link Company}.
- **/
-export declare class PayUserGeneralListByUserGroup extends PayUserGeneralList {
-    /**
-     * Identifier of the {@link UserGroup} to which this collection belongs.
-     **/
-    group: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserGet.d.ts

@@ -1,15 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { Reply } from "../../../API/Responses/Reply";
-import { PayUser } from "./PayUser";
-/**
- * Gets details of the specified {@link User}.
- **/
-export declare class PayUserGet extends PayUser implements IPayDeletable {
-    /**
-     * When true, the command will also return a deleted {@link User} (if it exists).
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}

package/commands/Accounts/Users/Requests/PayUserList.d.ts

@@ -1,38 +0,0 @@
-import { JsonObject } from "@trakit/objects";
-import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
-import { IPayListByCompany } from "../../../API/Requests/IPayListByCompany";
-import { ParamId } from "../../../API/Requests/Parameters/ParamId";
-import { Payload } from "../../../API/Requests/Payload";
-import { Reply } from "../../../API/Responses/Reply";
-/**
- * Gets details of the specified {@link user}.
- **/
-export declare abstract class PayUserList extends Payload implements IPayDeletable {
-    /**
-     * When true, the command will also return  deleted {@link User}s.
-     **/
-    includeDeleted: boolean;
-    constructor(json?: JsonObject);
-}
-/**
- * Contains the {@link Company.id} of the collection.
- **/
-export declare class PayUserListByCompany extends PayUserList implements IPayListByCompany {
-    /**
-     * Identifier of the {@link Company} to which this collection belongs.
-     **/
-    company: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}
-/**
- *
- **/
-export declare class PayUserListByUserGroup extends PayUserList {
-    /**
-     * Identifier of the {@link UserGroup} to which this collection belongs.
-     **/
-    userGroup: ParamId;
-    constructor(json?: JsonObject);
-    createReply(json: JsonObject): Reply;
-}