@trakit/commands 0.0.5

package/commands/API/Geography/Polyline.d.ts

@@ -0,0 +1,20 @@
+import { LatLng } from "@trakit/objects";
+/**
+ * Our implementation to encode a polyline using Google's Encoded Polyline algorithm.
+ * This version allows you to change the precision of the encoding.
+ * We use 6 decimal places by default. Google uses 5.
+ * https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+ * @param route		The array of coordinates representing a path.
+ * @param precision			Optional number of decimal places to use to calculate the results.  Default is 5.
+ * @returns
+ */
+export declare function ROUTE_ENCODE(route: LatLng[], precision?: number): string;
+/**
+ * Our implementation to decode a polyline using Google's Encoded Polyline algorithm.
+ * This version allows you to change the precision of the encoding.
+ * We use 6 decimal places by default. Google uses 5.
+ * @param encodedPoints
+ * @param precision
+ * @returns
+ */
+export declare function ROUTE_DECODE(route: string, precision?: number): LatLng[];

package/commands/API/Requests/IPayDeletable.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for requests that can include deleted objects.
+ **/
+export interface IPayDeletable {
+    /**
+     * When true, the command will also return deleted objects.
+     **/
+    includeDeleted: boolean;
+}

package/commands/API/Requests/IPayListByAsset.d.ts

@@ -0,0 +1,10 @@
+import { ParamId } from "./Parameters/ParamId";
+/**
+ *
+ **/
+export interface IPayListByAsset {
+    /**
+     * The asset to filter the list by.
+     **/
+    asset: ParamId;
+}

package/commands/API/Requests/IPayListByBillingProfile.d.ts

@@ -0,0 +1,10 @@
+import { ParamId } from "./Parameters/ParamId";
+/**
+ * Interface for requests on a list of objects by billing profile.
+ **/
+export interface IPayListByBillingProfile {
+    /**
+     * The billing profile to filter the list by.
+     **/
+    billingProfile: ParamId;
+}

package/commands/API/Requests/IPayListByCompany.d.ts

@@ -0,0 +1,10 @@
+import { ParamId } from "./Parameters/ParamId";
+/**
+ * Interface for requests that filter lists by company.
+ **/
+export interface IPayListByCompany {
+    /**
+     * The company to filter the list by.
+     **/
+    company: ParamId;
+}

package/commands/API/Requests/IPayListByLabels.d.ts

@@ -0,0 +1,10 @@
+import { codified } from "@trakit/objects";
+/**
+ * Interface for requests on a list of objects by labels.
+ **/
+export interface IPayListByLabels {
+    /**
+     * The labels to filter the list by.
+     **/
+    labels: codified[];
+}

package/commands/API/Requests/IPayListByReferences.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for requests on a list of objects by references.
+ **/
+export interface IPayListByReferences {
+    /**
+     * The references to filter the list by.
+     **/
+    references: Map<string, string>;
+}

package/commands/API/Requests/IPayListByUser.d.ts

@@ -0,0 +1,10 @@
+import { ParamLogin } from "./Parameters/ParamLogin";
+/**
+ * Interface for requests on a list of objects by user.
+ **/
+export interface IPayListByUser {
+    /**
+     * The user to filter the list by.
+     **/
+    user: ParamLogin;
+}

package/commands/API/Requests/IPaySingle.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for requests on a single object.
+ **/
+export interface IPaySingle {
+    /**
+     * The key of the object to retrieve.
+     **/
+    getKey(): string;
+}

package/commands/API/Requests/IPaySuspendable.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for requests on objects that can be suspended.
+ **/
+export interface IPaySuspendable {
+    /**
+     * When true, the command will also return suspended objects.
+     **/
+    includeSuspended: boolean;
+}

package/commands/API/Requests/Parameters/IParamAsset.d.ts

@@ -0,0 +1,8 @@
+import { ParamId } from "./ParamId";
+/**
+ * An interface that when implemented can be used with validator.byAsset.
+ * <category>Assets</category>
+ **/
+export interface IParamAsset {
+    asset: ParamId;
+}

package/commands/API/Requests/Parameters/IParamBillingProfile.d.ts

@@ -0,0 +1,8 @@
+import { ParamId } from "./ParamId";
+/**
+ * An interface that when implemented can be used with validator.byBillingProfile.
+ * <category>Billing</category>
+ **/
+export interface IParamBillingProfile {
+    billingProfile: ParamId;
+}

package/commands/API/Requests/Parameters/IParamCompany.d.ts

@@ -0,0 +1,8 @@
+import { ParamId } from "./ParamId";
+/**
+ * An interface that when implemented can be used with validator.byCompany.
+ * <category>Companies</category>
+ **/
+export interface IParamCompany {
+    company: ParamId;
+}

package/commands/API/Requests/Parameters/ParamCode.d.ts

@@ -0,0 +1,12 @@
+import { JsonObject } from "@trakit/objects";
+/**
+ * A container class used to house the "code" identifying a resource.
+ **/
+export declare class ParamCode {
+    /**
+     * A "code" identifying a resource.
+     * <override required="always" />
+     **/
+    code: string;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamGuid.d.ts

@@ -0,0 +1,11 @@
+import { guid, JsonObject } from "@trakit/objects";
+/**
+ * A container class used to house the guid identifying a resource.
+ **/
+export declare class ParamGuid {
+    /**
+     * The global unique identifier.
+     **/
+    guid: guid;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamId.d.ts

@@ -0,0 +1,11 @@
+import { JsonObject, ulong } from "@trakit/objects";
+/**
+ * A container class used to house the id of the object requested.
+ **/
+export declare class ParamId {
+    /**
+     * Identifier given as input for the command.
+     **/
+    id: ulong;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamIdentifier.d.ts

@@ -0,0 +1,11 @@
+import { JsonObject } from "@trakit/objects";
+/**
+ * A container class used to house the string identifying a {@link Provider}.
+ **/
+export declare class ParamIdentifier {
+    /**
+     * The {@link Provider}'s identifier.
+     **/
+    id: string;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamIdentifierVersion.d.ts

@@ -0,0 +1,12 @@
+import { int, JsonObject } from "@trakit/objects";
+import { ParamIdentifier } from "./ParamIdentifier";
+/**
+ * A container class used to house the string identifying a {@link Provider}.
+ **/
+export declare class ParamIdentifierVersion extends ParamIdentifier {
+    /**
+     * Requested version key(s).
+     **/
+    v: int[];
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamKey.d.ts

@@ -0,0 +1,11 @@
+import { JsonObject } from "@trakit/objects";
+/**
+ * A container class used to house the key identifying a {@link Machine}.
+ **/
+export declare class ParamKey {
+    /**
+     * The {@link Machine}'s login.
+     **/
+    key: string;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamLogin.d.ts

@@ -0,0 +1,12 @@
+import { email, JsonObject } from "@trakit/objects";
+/**
+ * A container class used to house the login identifying a {@link User}.
+ * Used specifically to get session details.
+ **/
+export declare class ParamLogin {
+    /**
+     * The {@link User}'s login.
+     **/
+    login: email;
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/Parameters/ParamMerge.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An abstract meant to help with validating "merge" operations.
+ * This class is the beginning of the chain for all {@link Payload} contents.
+ */
+export declare abstract class ParamMerge {
+    /**
+     * Converts the object to JSON.
+     */
+    abstract toJSON(): any;
+}

package/commands/API/Requests/Parameters/ParamMergeSubscribable.d.ts

@@ -0,0 +1,12 @@
+import { int, JsonObject } from "@trakit/objects";
+import { ParamMerge } from "./ParamMerge";
+/**
+ * An abstract meant to help with validating "merge" operations.
+ **/
+export declare abstract class ParamMergeSubscribable extends ParamMerge {
+    /**
+     * The version keys used to validate synchronization.
+     **/
+    v: int[];
+    constructor(json?: JsonObject);
+}

package/commands/API/Requests/PayListBy.d.ts

@@ -0,0 +1,14 @@
+import { JsonObject, ulong } from '@trakit/objects';
+import { Payload } from './Payload';
+/**
+ *
+ */
+export declare abstract class PayListBy extends Payload {
+    /**
+     * The maximum number of items to return.
+     * If not specified, the server will return all.
+     **/
+    limit?: ulong;
+    constructor(json?: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Requests/PayListByDate.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { PayListBy } from "./PayListBy";
+/**
+ * Interface for requests that filter by date.
+ **/
+export declare abstract class PayListByDate extends PayListBy {
+    /**
+     * The start date for the filter.
+     **/
+    after: Date | nothing;
+    /**
+     * The end date for the filter.
+     **/
+    before: Date | nothing;
+    constructor(json?: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Requests/PayListById.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { PayListBy } from "./PayListBy";
+/**
+ * For commands that list objects by an ulong value.
+ */
+export declare abstract class PayListById extends PayListBy {
+    /**
+     * The lowest ID in the range.
+     **/
+    lowest: ulong | nothing;
+    /**
+     * The highest ID in the range.
+     **/
+    highest: ulong | nothing;
+    constructor(json?: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Requests/PayListByKey.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { PayListBy } from "./PayListBy";
+/**
+ * Interface for requests on a list of objects by key.
+ **/
+export declare abstract class PayListByKey extends PayListBy {
+    /**
+     * The first key to filter the list by.
+     **/
+    first: string | nothing;
+    /**
+     * The last key to filter the list by.
+     **/
+    last: string | nothing;
+    constructor(json?: JsonObject);
+    toJSON(): JsonObject;
+}

package/commands/API/Requests/Payload.d.ts

@@ -0,0 +1,44 @@
+import { int, JsonObject, nothing } from '@trakit/objects';
+import { Reply } from '../Responses/Reply';
+export type ActionType = "Get" | "List" | "Merge" | "Delete" | "Restore" | "Suspend" | "Reactivate";
+/**
+ * Base class for all command parameters.
+ * All command parameter classes use this as the base.
+ * <remarks>
+ * This class exists solely to create an inheritance chain.
+ * Child classes should contain members required to execute a command.
+ * </remarks>
+ **/
+export declare abstract class Payload {
+    /**
+     * Identifier used by external system to correlate requests to responses.
+     */
+    reqId: int | nothing;
+    constructor(json?: JsonObject);
+    /**
+     * Splits this class' name into parts helpful to breaking down how the command request should be sent.
+     * The returned array contains:
+     * - [0]: The action being performed (ie: `Get`, `List`, `Merge`, `Delete`, etc.)
+     * - [1]: Name of the object being acted upon (ie: `Asset`, `ProviderGeneral`, `User`, etc.)
+     * - [2]: The filter type, if any (ie: `Asset`, `Company`, `CompanyAndLabels`, etc.). This will be an empty string if no filter is used.
+     * - [3]: True if this will be a batch operation, or false otherwise.
+     */
+    getAction(): {
+        kind: ActionType;
+        object: string;
+        filter: string;
+        batch: boolean;
+    };
+    /**
+     * Creates a reply object from the given JSON data.
+     * Each Payload will have a corresponding Reply type.
+     * @param json
+     * @returns
+     */
+    abstract createReply(json: JsonObject): Reply;
+    /**
+     * Payloads are serialized conditionally before being sent to the server.
+     * @returns
+     */
+    toJSON(): JsonObject;
+}

package/commands/API/Responses/Content/ContentCode.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing } from "@trakit/objects";
+/**
+ * A container for the id of the {@link ProviderRegistration} requested/created.
+ **/
+export declare class ContentCode {
+    /**
+     * Creates a {@link ContentCode} from a JSON object.
+     * @param json - JSON object to create the {@link ContentCode} from.
+     * @returns A {@link ContentCode} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentCode | nothing;
+    /**
+     * Identifier given as input for the command.
+     **/
+    code: string;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentCodeCompany.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentCode } from "./ContentCode";
+/**
+ * A container for the id and owning {@link Company} of the {@link ProviderRegistration} requested/created.
+ **/
+export declare class ContentCodeCompany extends ContentCode {
+    /**
+     * Creates a {@link ContentCodeCompany} from a JSON object.
+     * @param json - JSON object to create the {@link ContentCodeCompany} from.
+     * @returns A {@link ContentCodeCompany} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentCodeCompany | nothing;
+    /**
+     * Identifier of the {@link Company} to which this object belongs.
+     **/
+    company: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentCodeDeleted.d.ts

@@ -0,0 +1,19 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentCodeCompany } from "./ContentCodeCompany";
+/**
+ * A container for the id of the {@link ProviderRegistration} requested/created.
+ * For delete/restore commands, this contains the {@link ProviderRegistration.code}, owning {@link Company.id}, and deleted state.
+ **/
+export declare class ContentCodeDeleted extends ContentCodeCompany {
+    /**
+     * Creates a {@link ContentCodeDeleted} from a JSON object.
+     * @param json - JSON object to create the {@link ContentCodeDeleted} from.
+     * @returns A {@link ContentCodeDeleted} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentCodeDeleted | nothing;
+    /**
+     * Flag showing if the object is deleted.
+     **/
+    deleted: boolean;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentId.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+/**
+ * A container for the id of the object requested.
+ **/
+export declare class ContentId {
+    /**
+     * Creates a {@link ContentId} from a JSON object.
+     * @param json - JSON object to create the {@link ContentId} from.
+     * @returns A {@link ContentId} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentId | nothing;
+    /**
+     * Identifier given as input for the command.
+     **/
+    id: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdAsset.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * A container for the id, owning {@link Asset.id}, and owning {@link Company.id} of the object requested/created.
+ **/
+export declare class ContentIdAsset extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdAsset} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdAsset} from.
+     * @returns A {@link ContentIdAsset} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdAsset | nothing;
+    /**
+     * Identifier of the {@link Asset} to which this object belongs
+     **/
+    asset: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdBillingProfile.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * A container for the id, {@link BillingProfile.id}, and owning {@link Company.id} of the billing object requested/created.
+ **/
+export declare class ContentIdBillingProfile extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdBillingProfile} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdBillingProfile} from.
+     * @returns A {@link ContentIdBillingProfile} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdBillingProfile | nothing;
+    /**
+     * Identifier of the {@link BillingProfile} to which this object belongs
+     **/
+    profile: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdCompany.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentId } from "./ContentId";
+/**
+ * A container for the id and owning {@link Company.id} of the object requested/created.
+ **/
+export declare class ContentIdCompany extends ContentId {
+    /**
+     * Creates a {@link ContentIdCompany} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdCompany} from.
+     * @returns A {@link ContentIdCompany} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdCompany | nothing;
+    /**
+     * Identifier of the {@link Company} to which this object belongs.
+     **/
+    company: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdCompanyTemplate.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * A container for the id, owning {@link ReportTemplate} id, and owning {@link Company.id} of the report object requested/created.
+ **/
+export declare class ContentIdCompanyTemplate extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdCompanyTemplate} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdCompanyTemplate} from.
+     * @returns A {@link ContentIdCompanyTemplate} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdCompanyTemplate | nothing;
+    /**
+     * Identifier of the template to which this object belongs.
+     **/
+    template: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdDeleted.d.ts

@@ -0,0 +1,22 @@
+import { JsonObject, nothing, uint } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * For delete/restore commands, this contains the id, version keys, owning {@link Company.id}, and deleted state.
+ **/
+export declare class ContentIdDeleted extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdDeleted} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdDeleted} from.
+     * @returns A {@link ContentIdDeleted} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdDeleted | nothing;
+    /**
+     * Flag showing if the object is deleted.
+     **/
+    deleted: boolean;
+    /**
+     * Object version keys used to validate synchronization for all object properties.
+     **/
+    v: uint[];
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdParent.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentId } from "./ContentId";
+/**
+ * A container for the id and the requested/created {@link Company.parent}.
+ **/
+export declare class ContentIdParent extends ContentId {
+    /**
+     * Creates a {@link ContentIdParent} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdParent} from.
+     * @returns A {@link ContentIdParent} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdParent | nothing;
+    /**
+     * Identifier of the parent to which this company belongs
+     **/
+    parent: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdScript.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * A container for the id, script id, and owning {@link Company.id} of the object requested/created.
+ **/
+export declare class ContentIdScript extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdScript} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdScript} from.
+     * @returns A {@link ContentIdScript} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdScript | nothing;
+    /**
+     * Identifier of the script to which this object belongs.
+     **/
+    script: ulong | nothing;
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdSuspended.d.ts

@@ -0,0 +1,22 @@
+import { JsonObject, nothing, uint } from "@trakit/objects";
+import { ContentIdCompany } from "./ContentIdCompany";
+/**
+ * For suspend/revive commands, this contains the id, version keys, owning {@link Company.id}, and suspended state.
+ **/
+export declare class ContentIdSuspended extends ContentIdCompany {
+    /**
+     * Creates a {@link ContentIdSuspended} from a JSON object.
+     * @param json - JSON object to create the {@link ContentIdSuspended} from.
+     * @returns A {@link ContentIdSuspended} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdSuspended | nothing;
+    /**
+     * Flag showing if the object is suspended.
+     **/
+    suspended: boolean;
+    /**
+     * Object version keys used to validate synchronization for all object properties.
+     **/
+    v: uint[];
+    constructor(json: JsonObject);
+}

package/commands/API/Responses/Content/ContentIdendifier.d.ts

@@ -0,0 +1,18 @@
+import { JsonObject } from "@trakit/objects";
+import { nothing } from "@trakit/objects";
+/**
+ * A container for the id of the {@link Provider} requested/created.
+ **/
+export declare class ContentIdendifier {
+    /**
+     * Creates a {@link ContentId} from a JSON object.
+     * @param json - JSON object to create the {@link ContentId} from.
+     * @returns A {@link ContentId} instance or nothing.
+     */
+    static fromJSON(json: JsonObject): ContentIdendifier | nothing;
+    /**
+     * Identifier given as input for the command.
+     **/
+    id: string;
+    constructor(json: JsonObject);
+}