@trakit/commands 0.0.5

package/commands/API/Responses/Errors/ErrorDetailEscalation.d.ts

@@ -0,0 +1,15 @@
+import { JsonObject, PermissionEscalation } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details of a permission escallation error thrown when modifying a resource or user that would grant the following extra permissions.
+ **/
+export declare class ErrorDetailEscalation extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * A list of escallated permission details.
+     **/
+    escalations: PermissionEscalation[];
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailExternals.d.ts

@@ -0,0 +1,23 @@
+import { JsonObject } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * These are the errors/warnings taken from the output of some other system.
+ **/
+export declare class ErrorDetailExternals extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * List of errors.
+     **/
+    errors: string[];
+    /**
+     * List of warnings.
+     **/
+    warnings: string[];
+    /**
+     * List of messages.
+     **/
+    messages: string[];
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailFormTemplateInUse.d.ts

@@ -0,0 +1,15 @@
+import { JsonObject, ulong } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details for how many and which {@link FormResult}s are still using this {@link FormTemplate}.
+ **/
+export declare class ErrorDetailFormTemplateInUse extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * A list of {@link FormResult.id}s currently being referenced.
+     **/
+    formResults: ulong[];
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailInput.d.ts

@@ -0,0 +1,15 @@
+import { JsonObject } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * These are the details of an input or format exception.
+ **/
+export declare class ErrorDetailInput extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * The given input which caused the error.
+     **/
+    input: string;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailLocked.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, TimeSpan } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details for how long a resource is locked, or if a command cannot be executed right away, how long until it can be executed.
+ **/
+export declare class ErrorDetailLocked extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * The amount of time the resource is locked, or you are prevented from issuing the command.
+     **/
+    timeout: TimeSpan;
+    /**
+     * This timestamp represents the moment the resource becomes available again.
+     **/
+    until: Date;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailMinMax.d.ts

@@ -0,0 +1,19 @@
+import { double, JsonObject, nothing } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * These are the details of when a value needed to be within a certain range, and was not.
+ **/
+export declare class ErrorDetailMinMax extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * Minimum possible value.
+     **/
+    min: Date | double | nothing;
+    /**
+     * Maximum possible value.
+     **/
+    max: Date | double | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailParent.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details for how a circular company tree would have been created.
+ **/
+export declare class ErrorDetailParent extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * The {@link Company.parent} specified in the parameters.
+     **/
+    parent: ulong | nothing;
+    /**
+     * ID of the child {@link Company} that would cause a circular reference.
+     **/
+    descendant: ulong | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailParse.d.ts

@@ -0,0 +1,23 @@
+import { int, JsonObject, nothing } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * These are the details of an exception while trying to parse the JSON input.
+ **/
+export declare class ErrorDetailParse extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * The line number in the input string.
+     **/
+    line: int | nothing;
+    /**
+     * The character on which the failure occurred.
+     **/
+    column: int | nothing;
+    /**
+     * The last sucessfully parsed object.
+     **/
+    after: string | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailPhone.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ErrorDetailInput } from "./ErrorDetailInput";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * These are the details of a phone number input that failed to parse.
+ **/
+export declare class ErrorDetailPhone extends ErrorDetailInput {
+    get kind(): ErrorDetailType;
+    /**
+     * The number that was parsed from the input.
+     **/
+    number: ulong | nothing;
+    /**
+     * The digital characters used to try to parse the number.
+     **/
+    usable: string | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailSecret.d.ts

@@ -0,0 +1,54 @@
+import { JsonObject, long, nothing } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details about why the request failed an authentication process when a {@link Machine.secret} is used.
+ * <remarks>
+ * Only available for {@link Machine} accounts using the beta services.
+ * </remarks>
+ **/
+export declare class ErrorDetailSecret extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * A listing of all the request headers as given.
+     **/
+    headers: Map<string, string[]>;
+    /**
+     * The time of the server from when the HTTP request was accepted.
+     **/
+    accepted: Date;
+    /**
+     * The unique identifier given for the {@link Machine} to access the system.
+     **/
+    key: string;
+    /**
+     * The signature calculated for this request based on all the inputs.
+     **/
+    signature: string;
+    /**
+     * The parsed Date header timestamp.
+     **/
+    date: string;
+    /**
+     * The parsed {@link HttpMethod} (should be upper-case).
+     **/
+    method: string;
+    /**
+     * Sanitized absolute URL of the request including query-string and fragment, but with any session or api-keys stripped out.
+     **/
+    uri: string;
+    /**
+     * The length of the content body (or the Content-Length header value).
+     **/
+    length: long | nothing;
+    /**
+     * The input for creating a signature.
+     **/
+    input: string;
+    /**
+     * The signature expected.
+     **/
+    output: string;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailStack.d.ts

@@ -0,0 +1,26 @@
+import { JsonObject } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * For unhandled exceptions, a full stack trace may be given.
+ * <remarks>
+ * Only available for some of the beta services.
+ * </remarks>
+ **/
+export declare class ErrorDetailStack extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * Exception message.
+     **/
+    message: string;
+    /**
+     * The full stack trace if available.
+     **/
+    stack: string;
+    /**
+     * The value associated with the error, if any.
+     */
+    value: any;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailThrottled.d.ts

@@ -0,0 +1,37 @@
+import { int, JsonObject, TimeSpan } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details of a command or session being throttled.
+ **/
+export declare class ErrorDetailThrottled extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * The session identifier being throttled.
+     **/
+    ghostId: string;
+    /**
+     * The {@link User} being throttled.
+     **/
+    login: string;
+    /**
+     * The client IP address.
+     **/
+    ip: string;
+    /**
+     * The name of the WebSocket command, or the RESTful route.
+     **/
+    command: string;
+    /**
+     * How many times this command was invoked during the window.
+     * Alternatively, can be the maximum number of times this command can be invoked (like creating a session).
+     **/
+    count: int;
+    /**
+     * The size of the window.
+     * If this throttled command has no window (ie; creating too many sessions) this value is null.
+     **/
+    timeout: TimeSpan;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetailType.d.ts

@@ -0,0 +1,89 @@
+/**
+ * {@link ErrorDetail}s are identified for deserialization using {@link ErrorDetail.kind}.
+ **/
+export declare enum ErrorDetailType {
+    /**
+     * These are the details of an exception while trying to parse the JSON input.
+     **/
+    parse = "parse",
+    /**
+     * For unhandled exceptions, a full stack trace may be given.
+     **/
+    stack = "stack",
+    /**
+     * Details for how long a resource is locked, or if a command cannot be executed right away, how long until it can be executed.
+     **/
+    locked = "locked",
+    /**
+     * Details of a command or session being throttled.
+     **/
+    throttled = "throttled",
+    /**
+     * These are the details when a number of things create the exception.
+     **/
+    count = "count",
+    /**
+     * These are the details of when a value needed to be within a certain range, and was not.
+     **/
+    minMax = "minMax",
+    /**
+     * These are the details of an input or format exception.
+     **/
+    input = "input",
+    /**
+     * These are the details of an enum input that failed to parse.
+     **/
+    enum = "enum",
+    /**
+     * These are the details of a phone number input that failed to parse.
+     **/
+    phone = "phone",
+    /**
+     * These details contain a list of bad keys, labels or tags, or parameter names that caused the failure.
+     **/
+    badKeys = "badKeys",
+    /**
+     * These details contain unique identifiers that caused the failure.
+     **/
+    badIds = "badIds",
+    /**
+     * These details contain array indexes that caused the failure.
+     **/
+    badIndexes = "badIndexes",
+    /**
+     * Details of a permission escallation error thrown when modifying a resource or user that would grant the following extra permissions.
+     **/
+    escalation = "escalation",
+    /**
+     * These are the errors/warnings taken from the output of some other system.
+     **/
+    externals = "externals",
+    /**
+     * Details for how a circular {@link Company} tree would have been created.
+     **/
+    parent = "parent",
+    /**
+     * Details for how many and which {@link User}s are still in the {@link UserGroup}.
+     **/
+    userGroupInUse = "userGroupInUse",
+    /**
+     * Details for how many and which {@link Asset}s and {@link User}s are still using this {@link Contact}.
+     **/
+    contactInUse = "contactInUse",
+    /**
+     * Details for how many and which {@link FormResult}s are still using this {@link FormTemplate}.
+     **/
+    formTemplateInUse = "formTemplateInUse",
+    /**
+     * For batch commands, these are the errors thrown by the sub-command.
+     **/
+    batch = "batch",
+    /**
+     * Details about why the request failed an authentication process when a {@link Machine.secret} is used.
+     **/
+    secret = "secret",
+    /**
+     * Details about WebSocket disconnection events, or command errors sent while the WebSocket is in an invalid state.
+     */
+    connection = "connection"
+}

package/commands/API/Responses/Errors/ErrorDetailUserGroupInUse.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ErrorDetail } from "./ErrorDetail";
+import { ErrorDetailType } from "./ErrorDetailType";
+/**
+ * Details for how many and which {@link User}s are still in the {@link UserGroup}.
+ **/
+export declare class ErrorDetailUserGroupInUse extends ErrorDetail {
+    get kind(): ErrorDetailType;
+    /**
+     * A list of {@link User}s currently being referenced.
+     **/
+    users: string[] | nothing;
+    /**
+     * A list of {@link User}s currently being referenced.
+     **/
+    machines: string[] | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Errors/ErrorDetail_fromJSON.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,10 @@
+import { Base } from '@trakit/objects';
+/**
+ * Interface for responses that return a list or loaded objects.
+ **/
+export interface IRepList<TBase extends Base> {
+    /**
+     * The collection of objects.
+     **/
+    getCollection(): TBase[];
+}

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

@@ -0,0 +1,11 @@
+import { nothing } from "@trakit/objects";
+import { ContentId } from "./Content/ContentId";
+/**
+ * Interface for responses that return a list by asset.
+ **/
+export interface IRepListByAsset {
+    /**
+     * The asset to filter the list by.
+     **/
+    asset: ContentId | nothing;
+}

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

@@ -0,0 +1,11 @@
+import { nothing } from "@trakit/objects";
+import { ContentId } from "./Content/ContentId";
+/**
+ * Interface for responses that return a list of objects by company.
+ **/
+export interface IRepListByCompany {
+    /**
+     * The unique identifier of the company.
+     **/
+    company: ContentId | nothing;
+}

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

@@ -0,0 +1,14 @@
+import { nothing } from "@trakit/objects";
+/**
+ * Interface for responses that return a list of objects by date.
+ **/
+export interface IRepListByDate {
+    /**
+     * The date to start the list from.
+     **/
+    after: Date | nothing;
+    /**
+     * The date to end the list at.
+     **/
+    before: Date | nothing;
+}

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

@@ -0,0 +1,14 @@
+import { nothing, ulong } from '@trakit/objects';
+/**
+ * Interface for responses that return a list of objects by ID.
+ **/
+export interface IRepListById {
+    /**
+     * The lowest unique identifier in the list.
+     **/
+    lowest: ulong | nothing;
+    /**
+     * The highest unique identifier in the list.
+     **/
+    highest: ulong | nothing;
+}

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

@@ -0,0 +1,14 @@
+import { nothing } from '@trakit/objects';
+/**
+ * Interface for responses that return a list by key.
+ **/
+export interface IRepListByKey {
+    /**
+     * The first key to filter the list by.
+     **/
+    first: string | nothing;
+    /**
+     * The last key to filter the list by.
+     **/
+    last: string | nothing;
+}

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

@@ -0,0 +1,10 @@
+import { codified, nothing } from '@trakit/objects';
+/**
+ * Interface for responses that return a list by labels.
+ **/
+export interface IRepListByLabels {
+    /**
+     * The labels to filter the list by.
+     **/
+    labels: codified[] | nothing;
+}

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

@@ -0,0 +1,10 @@
+import { nothing } from '@trakit/objects';
+/**
+ * Interface for responses that return a list by references.
+ **/
+export interface IRepListByReferences {
+    /**
+     * The references to filter the list by.
+     **/
+    references: Map<string, string> | nothing;
+}

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

@@ -0,0 +1,11 @@
+import { nothing } from "@trakit/objects";
+import { ContentLogin } from "./Content/ContentLogin";
+/**
+ * Interface for responses that return a list by user.
+ **/
+export interface IRepListByUser {
+    /**
+     * The user to filter the list by.
+     **/
+    user: ContentLogin | nothing;
+}

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

@@ -0,0 +1,29 @@
+import { int, ISerializable, JsonObject, nothing } from '@trakit/objects';
+import { ErrorCode } from "./Errors/ErrorCode";
+import { ErrorDetail } from "./Errors/ErrorDetail";
+/**
+ * Base class for all responses from commands.
+ * All command response classes use this as the base.
+ **/
+export declare class Reply implements ISerializable {
+    /**
+     * Identifier used by external system to correlate requests to responses.
+     * This is only used with the Trak-iT WebSocket API service.
+     **/
+    reqId: int | undefined;
+    /**
+     * The unique, numeric error code when processing this request.
+     **/
+    errorCode: ErrorCode;
+    /**
+     * An English description of the error.
+     **/
+    message: string;
+    /**
+     * An object to provide developers with a hint about the nature of the error.
+     * The key is not always present, and only available for some errors.
+     **/
+    errorDetails: ErrorDetail | nothing;
+    constructor(json: JsonObject);
+    toJSON(): JsonObject;
+}

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

@@ -0,0 +1,17 @@
+import { SyncName, JsonObject } from '@trakit/objects';
+import { Reply } from './Reply';
+/**
+ * Base class for all responses from commands.
+ * All command response classes use this as the base.
+ **/
+export declare abstract class ReplySync extends Reply {
+    /**
+     * Returns the type name of the object so we know how to construct it.
+     */
+    readonly _typeName: SyncName;
+    constructor(json: JsonObject, type: SyncName);
+    /**
+     * Adds or updates the constructed object to storage (and maybe IndexedDB).
+     */
+    abstract store(): void;
+}

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

@@ -0,0 +1,16 @@
+import { codified, email, guid, ulong } 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 ReplySyncBatchDelete extends ReplySync {
+    /**
+     * Returns the constructed object.
+     */
+    protected abstract _getKeys(): string[] | guid[] | email[] | codified[] | ulong[];
+    /**
+     * Adds or updates the constructed object to storage (and maybe IndexedDB).
+     */
+    store(): void;
+}

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

@@ -0,0 +1,16 @@
+import { codified, email, guid, ulong } 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 ReplySyncDelete extends ReplySync {
+    /**
+     * Returns the constructed object.
+     */
+    protected abstract _getKey(): string | guid | email | codified | ulong;
+    /**
+     * Adds or updates the constructed object to storage (and maybe IndexedDB).
+     */
+    store(): void;
+}

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

@@ -0,0 +1,34 @@
+import { BaseComponent, BaseCompound, SyncName, IRequestable, JsonObject } 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 ReplySyncGet<TRequestable extends IRequestable> extends ReplySync {
+    /**
+     * Returns the constructed object.
+     */
+    abstract getObject(): TRequestable;
+    /**
+     * Adds or updates the constructed object to storage (and maybe IndexedDB).
+     */
+    store(): void;
+}
+/**
+ * Base class for all responses from commands that deal with compound objects.
+ */
+export declare abstract class ReplySyncGetPiece<TRequestable extends BaseComponent> extends ReplySyncGet<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;
+    /**
+     * Adds or updates the constructed object to storage (and maybe IndexedDB).
+     */
+    store(): void;
+}