@trakit/commands 0.0.5

package/commands/API/Responses/ReplySyncList.d.ts

@@ -0,0 +1,52 @@
+import { BaseComponent, BaseCompound, SyncName, email, guid, IRequestable, JsonObject, ulong, codified } from '@trakit/objects';
+import { ReplySync } from './ReplySync';
+/**
+ * Base class for all responses from commands.
+ * All command response classes use this as the base.
+ **/
+export declare abstract class ReplySyncList<TRequestable extends IRequestable> extends ReplySync {
+    /**
+     * Returns the constructed collection of objects.
+     */
+    abstract getCollection(): TRequestable[];
+    /**
+     * Filters the existing stored collection to determine which objects are a part of this synchronization operation.
+     * For listing commands, this will filter out only those objects that match the company or asset to which these objects belong.
+     * @param pair
+     * @param index
+     */
+    abstract _filterCollection(pair: [ulong | guid | email | codified | string, TRequestable], index: number): boolean;
+    /**
+     * Returns the key for the given pair.
+     */
+    _keyCollection(pair: [ulong | guid | email | codified | string, TRequestable], index: number): string | number;
+    /**
+     * Adds or updates the constructed objects to storage (and maybe IndexedDB).
+     * @param map
+     * @param key
+     * @param obj
+     */
+    _store(map: Map<ulong | guid | email | codified | string, TRequestable>, obj: TRequestable): ulong | guid | email | codified | string;
+    /**
+     * Adds or updates the constructed objects to storage (and maybe IndexedDB).
+     */
+    store(): void;
+}
+/**
+ * Base class for all responses from commands that deal with compound objects.
+ */
+export declare abstract class ReplySyncListPiece<TRequestable extends BaseComponent> extends ReplySyncList<TRequestable> {
+    /**
+     * Returns the index of the piece in the {@link BaseCompound} to sync.
+     */
+    readonly _pieceIndex: number;
+    constructor(json: JsonObject, type: SyncName, index: number);
+    /**
+     * Creates a blank instance of the compound object.
+     */
+    protected abstract _createBlank(): BaseCompound;
+    /**
+     * This override synchronizes only the piece of the compound object, and creates a blank object if it does not exist.
+     */
+    _store(map: Map<ulong | guid | email | codified | string, TRequestable>, obj: TRequestable): ulong | guid | email | codified | string;
+}

package/commands/Accounts/Contacts/Requests/Parameters/ParamContactMerge.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ParamSelfContactMerge } from "../../../../Accounts/Self/Requests/Parameters/ParamSelfContactMerge";
+/**
+ * Parameters used to create or update an {@link Contact}.
+ **/
+export declare class ParamContactMerge extends ParamSelfContactMerge {
+    /**
+     * The unique identifier of the {@link Contact} you want to update.
+     * Leave this as `null` when creating a new {@link Contact}.
+     **/
+    id: ulong | nothing;
+    /**
+     * The {@link Company} to which this {@link Contact} belongs.
+     * After creation, this value is read-only.
+     **/
+    company: ulong | nothing;
+    constructor(json?: JsonObject);
+    toJSON(): any;
+}

package/commands/Accounts/Contacts/Requests/PayContact.d.ts

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

package/commands/Accounts/Contacts/Requests/PayContactBatchDelete.d.ts

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

package/commands/Accounts/Contacts/Requests/PayContactBatchMerge.d.ts

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

package/commands/Accounts/Contacts/Requests/PayContactDelete.d.ts

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

package/commands/Accounts/Contacts/Requests/PayContactGet.d.ts

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

package/commands/Accounts/Contacts/Requests/PayContactList.d.ts

@@ -0,0 +1,27 @@
+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 contact}.
+ **/
+export declare abstract class PayContactList extends Payload implements IPayDeletable {
+    /**
+     * When true, the command will also return  deleted {@link Contact}s.
+     **/
+    includeDeleted: boolean;
+    constructor(json?: JsonObject);
+}
+/**
+ * Contains the {@link Company.id} of the collection.
+ **/
+export declare class PayContactListByCompany extends PayContactList implements IPayListByCompany {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     **/
+    company: ParamId;
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Contacts/Requests/PayContactMerge.d.ts

@@ -0,0 +1,20 @@
+import { JsonObject } from "@trakit/objects";
+import { IPaySingle } from "../../../API/Requests/IPaySingle";
+import { Payload } from "../../../API/Requests/Payload";
+import { Reply } from "../../../API/Responses/Reply";
+import { ParamContactMerge } from "./Parameters/ParamContactMerge";
+/**
+ * Creates a new or updates an existing {@link Contact}.
+ **/
+export declare class PayContactMerge extends Payload implements IPaySingle {
+    /**
+     * Parameters given to create or update a {@link Contact}.
+     **/
+    contact: ParamContactMerge;
+    constructor(json?: JsonObject);
+    /**
+     *
+     **/
+    getKey(): string;
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Contacts/Requests/PayContactRestore.d.ts

@@ -0,0 +1,9 @@
+import { JsonObject } from "@trakit/objects";
+import { Reply } from "../../../API/Responses/Reply";
+import { PayContact } from "./PayContact";
+/**
+ * Restores a deleted {@link Contact}.
+ **/
+export declare class PayContactRestore extends PayContact {
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Contacts/Responses/RepContactBatchDelete.d.ts

@@ -0,0 +1,14 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdDeleted } from "../../../API/Responses/Content/ContentIdDeleted";
+import { ReplySyncBatchDelete } from "../../../API/Responses/ReplySyncBatchDelete";
+/**
+ * A container for the {@link contact}.
+ **/
+export declare class RepContactBatchDelete extends ReplySyncBatchDelete {
+    /**
+     * Details about deleting/restoring the requested {@link Contact}.
+     **/
+    contacts: ContentIdDeleted[] | nothing;
+    constructor(json: JsonObject);
+    protected _getKeys(): ulong[];
+}

package/commands/Accounts/Contacts/Responses/RepContactBatchMerge.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentIdCompany } from "../../../API/Responses/Content/ContentIdCompany";
+import { Reply } from "../../../API/Responses/Reply";
+/**
+ *
+ **/
+export declare class RepContactBatchMerge extends Reply {
+    /**
+     *
+     **/
+    contacts: ContentIdCompany[] | nothing;
+    constructor(json: JsonObject);
+}

package/commands/Accounts/Contacts/Responses/RepContactDelete.d.ts

@@ -0,0 +1,14 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdDeleted } from "../../../API/Responses/Content/ContentIdDeleted";
+import { ReplySyncDelete } from "../../../API/Responses/ReplySyncDelete";
+/**
+ * A container for the {@link contact}.
+ **/
+export declare class RepContactDelete extends ReplySyncDelete {
+    /**
+     * Details about deleting/restoring the requested {@link Contact}.
+     **/
+    contact: ContentIdDeleted | nothing;
+    constructor(json: JsonObject);
+    protected _getKey(): ulong;
+}

package/commands/Accounts/Contacts/Responses/RepContactGet.d.ts

@@ -0,0 +1,13 @@
+import { Contact, JsonObject, nothing } from "@trakit/objects";
+import { ReplySyncGet } from "../../../API/Responses/ReplySyncGet";
+/**
+ * A container for the {@link contact}.
+ **/
+export declare class RepContactGet extends ReplySyncGet<Contact> {
+    /**
+     * The requested {@link Contact}.
+     **/
+    contact: Contact | nothing;
+    constructor(json: JsonObject);
+    getObject(): Contact;
+}

package/commands/Accounts/Contacts/Responses/RepContactList.d.ts

@@ -0,0 +1,25 @@
+import { codified, Contact, email, guid, JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentId } from "../../../API/Responses/Content/ContentId";
+import { ReplySyncList } from "../../../API/Responses/ReplySyncList";
+/**
+ * A container for the requested {@link contacts}.
+ **/
+export declare abstract class RepContactList extends ReplySyncList<Contact> {
+    /**
+     * The list of requested {@link Contact}s.
+     **/
+    contacts: Contact[] | nothing;
+    constructor(json: JsonObject);
+    getCollection(): Contact[];
+}
+/**
+ * Contains the {@link Company.id} of the collection.
+ **/
+export declare class RepContactListByCompany extends RepContactList {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     **/
+    company: ContentId | nothing;
+    constructor(json: JsonObject);
+    _filterCollection(pair: [ulong | guid | email | codified | string, Contact], index: number): boolean;
+}

package/commands/Accounts/Contacts/Responses/RepContactMerge.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentIdCompany } from "../../../API/Responses/Content/ContentIdCompany";
+import { Reply } from "../../../API/Responses/Reply";
+/**
+ * A container for the {@link contact}.
+ **/
+export declare class RepContactMerge extends Reply {
+    /**
+     * An object which contains the `id` and `company` keys when there is no error.
+     **/
+    contact: ContentIdCompany | nothing;
+    constructor(json: JsonObject);
+}

package/commands/Accounts/Groups/Requests/Parameters/ParamUserGroupMerge.d.ts

@@ -0,0 +1,31 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ParamMergeSubscribable } from "../../../../API/Requests/Parameters/ParamMergeSubscribable";
+import { ParamPermission } from "../../../Permissions/ParamPermission";
+/**
+ * Parameters used to create or update an {@link UserGroup}.
+ **/
+export declare class ParamUserGroupMerge extends ParamMergeSubscribable {
+    /**
+     * The unique identifier of the {@link UserGroup} you want to update.
+     **/
+    id: ulong | nothing;
+    /**
+     * The company to which this {@link UserGroup} belongs.
+     * After creation, this value is read-only.
+     **/
+    company: ulong | nothing;
+    /**
+     * Name for the {@link UserGroup}.
+     **/
+    name: string | nothing;
+    /**
+     * Notes for the {@link UserGroup}.
+     **/
+    notes: string | nothing;
+    /**
+     * List of permissions assigned to members of this {@link UserGroup}.
+     **/
+    permissions: ParamPermission[] | nothing;
+    constructor(json?: JsonObject);
+    toJSON(): any;
+}

package/commands/Accounts/Groups/Requests/PayUserGroup.d.ts

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

package/commands/Accounts/Groups/Requests/PayUserGroupBatchDelete.d.ts

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

package/commands/Accounts/Groups/Requests/PayUserGroupBatchMerge.d.ts

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

package/commands/Accounts/Groups/Requests/PayUserGroupDelete.d.ts

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

package/commands/Accounts/Groups/Requests/PayUserGroupGet.d.ts

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

package/commands/Accounts/Groups/Requests/PayUserGroupList.d.ts

@@ -0,0 +1,27 @@
+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 userGroup}.
+ **/
+export declare abstract class PayUserGroupList extends Payload implements IPayDeletable {
+    /**
+     * When true, the command will also return  deleted {@link UserGroup}s.
+     **/
+    includeDeleted: boolean;
+    constructor(json?: JsonObject);
+}
+/**
+ * Contains the {@link Company.id} of the collection.
+ **/
+export declare class PayUserGroupListByCompany extends PayUserGroupList implements IPayListByCompany {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     **/
+    company: ParamId;
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Groups/Requests/PayUserGroupMerge.d.ts

@@ -0,0 +1,20 @@
+import { JsonObject } from "@trakit/objects";
+import { IPaySingle } from "../../../API/Requests/IPaySingle";
+import { Payload } from "../../../API/Requests/Payload";
+import { Reply } from "../../../API/Responses/Reply";
+import { ParamUserGroupMerge } from "./Parameters/ParamUserGroupMerge";
+/**
+ * Creates a new or updates an existing {@link UserGroup}.
+ **/
+export declare class PayUserGroupMerge extends Payload implements IPaySingle {
+    /**
+     * Parameters given to create or update a {@link UserGroup}.
+     **/
+    userGroup: ParamUserGroupMerge;
+    constructor(json?: JsonObject);
+    /**
+     *
+     **/
+    getKey(): string;
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Groups/Requests/PayUserGroupRestore.d.ts

@@ -0,0 +1,9 @@
+import { JsonObject } from "@trakit/objects";
+import { Reply } from "../../../API/Responses/Reply";
+import { PayUserGroup } from "./PayUserGroup";
+/**
+ * Restores a deleted {@link UserGroup}.
+ **/
+export declare class PayUserGroupRestore extends PayUserGroup {
+    createReply(json: JsonObject): Reply;
+}

package/commands/Accounts/Groups/Responses/RepUserGroupBatchDelete.d.ts

@@ -0,0 +1,14 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdDeleted } from "../../../API/Responses/Content/ContentIdDeleted";
+import { ReplySyncBatchDelete } from "../../../API/Responses/ReplySyncBatchDelete";
+/**
+ * A container for the {@link userGroup}.
+ **/
+export declare class RepUserGroupBatchDelete extends ReplySyncBatchDelete {
+    /**
+     * Details about deleting/restoring the requested {@link UserGroup}.
+     **/
+    userGroups: ContentIdDeleted[] | nothing;
+    constructor(json: JsonObject);
+    protected _getKeys(): ulong[];
+}

package/commands/Accounts/Groups/Responses/RepUserGroupBatchMerge.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentIdCompany } from "../../../API/Responses/Content/ContentIdCompany";
+import { Reply } from "../../../API/Responses/Reply";
+/**
+ * A container for the batch merge of user groups.
+ **/
+export declare class RepUserGroupBatchMerge extends Reply {
+    /**
+     * The list of user groups to be merged.
+     **/
+    userGroups: ContentIdCompany[] | nothing;
+    constructor(json: JsonObject);
+}

package/commands/Accounts/Groups/Responses/RepUserGroupDelete.d.ts

@@ -0,0 +1,14 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdDeleted } from "../../../API/Responses/Content/ContentIdDeleted";
+import { ReplySyncDelete } from "../../../API/Responses/ReplySyncDelete";
+/**
+ * A container for the {@link userGroup}.
+ **/
+export declare class RepUserGroupDelete extends ReplySyncDelete {
+    /**
+     * Details about deleting/restoring the requested {@link UserGroup}.
+     **/
+    userGroup: ContentIdDeleted | nothing;
+    constructor(json: JsonObject);
+    protected _getKey(): ulong;
+}

package/commands/Accounts/Groups/Responses/RepUserGroupGet.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing, UserGroup } from "@trakit/objects";
+import { ReplySyncGet } from "../../../API/Responses/ReplySyncGet";
+/**
+ * A container for the {@link userGroup}.
+ **/
+export declare class RepUserGroupGet extends ReplySyncGet<UserGroup> {
+    /**
+     * The requested {@link UserGroup}.
+     **/
+    userGroup: UserGroup | nothing;
+    constructor(json: JsonObject);
+    getObject(): UserGroup;
+}

package/commands/Accounts/Groups/Responses/RepUserGroupList.d.ts

@@ -0,0 +1,25 @@
+import { codified, email, guid, JsonObject, nothing, ulong, UserGroup } from "@trakit/objects";
+import { ContentId } from "../../../API/Responses/Content/ContentId";
+import { ReplySyncList } from "../../../API/Responses/ReplySyncList";
+/**
+ * A container for the requested {@link userGroups}.
+ **/
+export declare abstract class RepUserGroupList extends ReplySyncList<UserGroup> {
+    /**
+     * The list of requested {@link UserGroup}s.
+     **/
+    userGroups: UserGroup[] | nothing;
+    constructor(json: JsonObject);
+    getCollection(): UserGroup[];
+}
+/**
+ * Contains the {@link Company.id} of the collection.
+ **/
+export declare class RepUserGroupListByCompany extends RepUserGroupList {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     **/
+    company: ContentId | nothing;
+    constructor(json: JsonObject);
+    _filterCollection(pair: [ulong | guid | email | codified | string, UserGroup], index: number): boolean;
+}

package/commands/Accounts/Groups/Responses/RepUserGroupMerge.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentIdCompany } from "../../../API/Responses/Content/ContentIdCompany";
+import { Reply } from "../../../API/Responses/Reply";
+/**
+ * A container for the {@link userGroup}.
+ **/
+export declare class RepUserGroupMerge extends Reply {
+    /**
+     * An object which contains the `id` and `company` keys when there is no error.
+     **/
+    userGroup: ContentIdCompany | nothing;
+    constructor(json: JsonObject);
+}