@trakit/commands 0.0.5 → 0.0.6

package/_publish/WebSocket/Requests/Parameters/SubscriptionType.d.ts

@@ -0,0 +1,212 @@
+/**
+ * The types of subscriptions available using {@link subscribe}/{@link unsubscribe}.
+ * Each type has a different synchronization messages and objects.
+ */
+export declare enum SubscriptionType {
+    /**
+     * Assets' {@link AssetGeneral|general properties} such as name, icon, and labels.
+     * @see {@link AssetGeneral}
+     */
+    assetGeneral = "assetGeneral",
+    /**
+     * Assets' {@link AssetAdvanced|advanced properties} such as position, attributes, and status tags.
+     * @see {@link AssetAdvanced}
+     */
+    assetAdvanced = "assetAdvanced",
+    /**
+     * {@link AssetMessage}s between {@link Asset}s and {@link User}s.
+     * @see {@link AssetMessage}
+     */
+    assetMessage = "assetMessage",
+    /**
+     * Assets' {@link AssetDispatch|current dispatch} such as  {@link DispatchJob}s and route progress.
+     * @see {@link AssetDispatch}
+     */
+    assetDispatch = "assetDispatch",
+    /**
+     * Assets' {@link DispatchTask} information.
+     * @see {@link DispatchTask}
+     */
+    dispatchTask = "dispatchTask",
+    /**
+     * Some work that needs to be done by performing one or more {@link DispatchStep}s.
+     * @see {@link DispatchJob}
+     */
+    dispatchJob = "dispatchJob",
+    /**
+     * Customized {@link FormTemplate|forms} to be filled.
+     * @see {@link FormTemplate}
+     */
+    formTemplate = "formTemplate",
+    /**
+     * {@link FormResult|Forms} that are completed and fully filled out.
+     * @see {@link FormResult}
+     */
+    formResult = "formResult",
+    /**
+     * {@link Place} information.
+     * @see {@link PlaceGeneral}
+     */
+    placeGeneral = "placeGeneral",
+    /**
+     * Providers' (device) {@link ProviderGeneral|general properties} such as name, notes, and selected {@link Asset}.
+     * @see {@link ProviderGeneral}
+     */
+    providerGeneral = "providerGeneral",
+    /**
+     * Raw provider (device) {@link ProviderAdvanced|data} like GPS coordinates and parsed ODB-II values.
+     * @see {@link ProviderAdvanced}
+     */
+    providerAdvanced = "providerAdvanced",
+    /**
+     * Provider (device) configurations.
+     * @see {@link ProviderConfiguration}
+     * @deprecated Use {@link providerConfig} instead.
+     */
+    providerConfiguration = "providerConfiguration",
+    /**
+     * Provider (device) script logic.
+     * @see {@link ProviderScript}
+     */
+    providerScript = "providerScript",
+    /**
+     * Provider (device) configurations.
+     * @see {@link ProviderConfig}
+     */
+    providerConfig = "providerConfig",
+    /**
+     * Provider (device) comamnds.
+     * @see {@link ProviderControl}
+     */
+    providerControl = "providerControl",
+    /**
+     * Pending Providers (devices) that have not yet been configured or provisioned.
+     * @see {@link ProviderRegistration}
+     */
+    providerRegistration = "providerRegistration",
+    /**
+     * Recurring maintenance work for {@link Vehicle}s and {@link Trailer}s.
+     * @see {@link MaintenanceSchedule}
+     */
+    maintenanceSchedule = "maintenanceSchedule",
+    /**
+     * Historical {@link Vehicle} and {@link Trailer} maintenance work.
+     * @see {@link MaintenanceJob}
+     */
+    maintenanceJob = "maintenanceJob",
+    /**
+     * Behaviour script logic.
+     * @see {@link BehaviourScript}
+     */
+    behaviourScript = "behaviourScript",
+    /**
+     * Configured behaviours.
+     * @see {@link Behaviour}
+     */
+    behaviour = "behaviour",
+    /**
+     * Behaviour log messages to help developers debug their {@link BehaviourScript}.
+     * @see {@link BehaviourLog}
+     */
+    behaviourLog = "behaviourLog",
+    /**
+     * Renaming and changing the nodes of a company.
+     * @see {@link CompanyGeneral}
+     */
+    companyGeneral = "companyGeneral",
+    /**
+     * Company's label and tag styles.
+     * @see {@link CompanyStyles}
+     */
+    companyLabels = "companyLabels",
+    /**
+     * Company's {@link SessionPolicy} and {@link PasswordPolicy}.
+     * @see {@link CompanyPolicies}
+     */
+    companyPolicies = "companyPolicies",
+    /**
+     * A {@link Company}'s white-labelling details.
+     * @see {@link CompanyReseller}
+     */
+    companyReseller = "companyReseller",
+    /**
+     * Profiles used to generate {@link BillingReport} for a customer.
+     * @see {@link BillingProfile}
+     */
+    billingProfile = "billingProfile",
+    /**
+     * Billing rules for {@link Asset}s.
+     * @see {@link BillableHostingRule}
+     */
+    billingHosting = "billingHosting",
+    /**
+     * Discount rules for {@link Asset}s.
+     * @see {@link BillableHostingDiscount}
+     */
+    billingDiscount = "billingDiscount",
+    /**
+     * Hardware licenses for {@link Provider}s.
+     * @see {@link BillableHostingLicense}
+     */
+    billingLicense = "billingLicense",
+    /**
+     * Reports generated for a billee {@link Company}.
+     * @see {@link BillingReport}
+     */
+    billingReport = "billingReport",
+    /**
+     * Contact information used by {@link Asset}s and {@link User}s.
+     * @see {@link Contact}
+     */
+    contact = "contact",
+    /**
+     * Synchronizes icon information.
+     * @see {@link Icon}
+     */
+    icon = "icon",
+    /**
+     * Synchronizes picture information.
+     * @see {@link Picture}
+     */
+    picture = "picture",
+    /**
+     * Hosted document information.
+     * @see {@link Document}
+     */
+    document = "document",
+    /**
+     * Report configurations.
+     * @see {@link ReportTemplate}
+     */
+    reportTemplate = "reportTemplate",
+    /**
+     * Schedules for reports that run automatically.
+     * @see {@link ReportSchedule}
+     */
+    reportSchedule = "reportSchedule",
+    /**
+     * Historical asset details like breadcrumb trails.
+     * @see {@link ReportResult}
+     */
+    reportResult = "reportResult",
+    /**
+     * General user information such as name, contact information, and preferences.
+     * @see {@link UserGeneral}
+     */
+    userGeneral = "userGeneral",
+    /**
+     * User information such as permissions and group membership.
+     * @see {@link UserAdvanced}
+     */
+    userAdvanced = "userAdvanced",
+    /**
+     * Group information for easy access control.
+     * @see {@link UserGroup}
+     */
+    userGroup = "userGroup",
+    /**
+     * API Credentials information and permissions.
+     * @see {@link Machine}
+     */
+    machine = "machine"
+}

package/_publish/WebSocket/Requests/PaySubscriptionDelete.d.ts

@@ -0,0 +1,10 @@
+import { JsonObject } from "@trakit/objects";
+import { Reply } from "../../API/Responses/Reply";
+import { PaySubscriptionMerge } from "./PaySubscriptionMerge";
+/**
+ * The types of subscriptions available using {@link ReqSubscriptionMerge}.
+ * Each type has a different synchronization messages and objects.
+ */
+export declare class PaySubscriptionDelete extends PaySubscriptionMerge {
+    createReply(json: JsonObject): Reply;
+}

package/_publish/WebSocket/Requests/PaySubscriptionList.d.ts

@@ -0,0 +1,10 @@
+import { JsonObject } from "@trakit/objects";
+import { Payload } from "../../API/Requests/Payload";
+import { Reply } from "../../API/Responses/Reply";
+/**
+ * The types of subscriptions available using {@link subscribe}/{@link unsubscribe}.
+ * Each type has a different synchronization messages and objects.
+ */
+export declare class PaySubscriptionList extends Payload {
+    createReply(json: JsonObject): Reply;
+}

package/_publish/WebSocket/Requests/PaySubscriptionMerge.d.ts

@@ -0,0 +1,23 @@
+import { JsonObject } from "@trakit/objects";
+import { Reply } from "../../API/Responses/Reply";
+import { ParamId } from "../../API/Requests/Parameters/ParamId";
+import { Payload } from "../../API/Requests/Payload";
+import { SubscriptionType } from "./Parameters/SubscriptionType";
+/**
+ * The types of subscriptions available using {@link subscribe}/{@link unsubscribe}.
+ * Each type has a different synchronization messages and objects.
+ */
+export declare class PaySubscriptionMerge extends Payload {
+    /**
+     * An object to contain the "id" key.
+     * @see {@link Company.id}
+     */
+    company: ParamId;
+    /**
+     * The list of subscription types you want to receive.
+     * @see {@link SubscriptionType}
+     */
+    subscriptionTypes: SubscriptionType[];
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+}

package/_publish/WebSocket/Responses/Content/Subscription.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject, nothing, ulong } from "@trakit/objects";
+import { SubscriptionType } from "../../Requests/Parameters/SubscriptionType";
+/**
+ * Contains a {@link Company.id} and an array of {@link SubscriptionType}s for each {@link Company}.
+ */
+export declare class Subscription {
+    /**
+     * The company relevant to the subscription types you want to receive.
+     * @see {@link Company.id}
+     */
+    company: ulong | nothing;
+    /**
+     * List of subscription types for the company.
+     */
+    subscriptionTypes: SubscriptionType[] | nothing;
+    constructor(json: JsonObject);
+}

package/_publish/WebSocket/Responses/RepSubscription.d.ts

@@ -0,0 +1,29 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { ContentId } from "../../API/Responses/Content/ContentId";
+import { Reply } from "../../API/Responses/Reply";
+import { SubscriptionType } from "../Requests/Parameters/SubscriptionType";
+/**
+ * The types of subscriptions available using {@link TrakitSocket.subscribe}/{@link TrakitSocket.unsubscribe}.
+ * Each type has a different synchronization messages and objects.
+ */
+export declare class RepSubscription extends Reply {
+    /**
+     * An object which contains only one key "id" when there is no error.
+     * The "id" key is the unique identifier of the company to which the array of objects relate.
+     * @see {@link Company.id}
+     */
+    company: ContentId | nothing;
+    /**
+     * Subscription types added/removed (or were not applicable) to your socket's subscription list.
+     */
+    merged: SubscriptionType[] | nothing;
+    /**
+     * Subscription types not added to your socket due to insufficient permissions.
+     */
+    denied: SubscriptionType[] | nothing;
+    /**
+     * A returned list of nonsense you sent to my beautiful service.
+     */
+    invalid: string[] | nothing;
+    constructor(json: JsonObject);
+}

package/_publish/WebSocket/Responses/RepSubscriptionList.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject, nothing } from "@trakit/objects";
+import { Reply } from "../../API/Responses/Reply";
+import { Subscription } from "./Content/Subscription";
+/**
+ * Gets the list of current subscriptions for your current session.
+ */
+export declare class RepSubscriptionList extends Reply {
+    /**
+     * The list of your current subscription types.
+     */
+    subscriptions: Subscription[] | nothing;
+    constructor(json: JsonObject);
+}