@chrt-inc/typescript-sdk 1.863.0 → 1.866.0

package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.mts

@@ -0,0 +1,212 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../../../environments.mjs";
+import * as core from "../../../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../../../index.mjs";
+import { Cargo } from "../resources/cargo/client/Client.mjs";
+import { Expanded } from "../resources/expanded/client/Client.mjs";
+import { Task } from "../resources/task/client/Client.mjs";
+import { TaskArtifact } from "../resources/taskArtifact/client/Client.mjs";
+import { TaskGroup } from "../resources/taskGroup/client/Client.mjs";
+export declare namespace Drafts {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Drafts {
+    protected readonly _options: Drafts.Options;
+    protected _cargo: Cargo | undefined;
+    protected _expanded: Expanded | undefined;
+    protected _task: Task | undefined;
+    protected _taskArtifact: TaskArtifact | undefined;
+    protected _taskGroup: TaskGroup | undefined;
+    constructor(_options?: Drafts.Options);
+    get cargo(): Cargo;
+    get expanded(): Expanded;
+    get task(): Task;
+    get taskArtifact(): TaskArtifact;
+    get taskGroup(): TaskGroup;
+    /**
+     * Creates a draft order, populating cargo, task groups, and tasks parsed from natural language or a template. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderRes)
+     *
+     * @param {Chrt.OrderBuilderReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.buildV1({})
+     */
+    buildV1(request: Chrt.OrderBuilderReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderBuilderRes>;
+    private __buildV1;
+    /**
+     * Reports whether an order builder request's references resolve. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderTemplateResolvabilityRes)
+     *
+     * @param {Chrt.OrderBuilderReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.buildPrecheckV1({})
+     */
+    buildPrecheckV1(request: Chrt.OrderBuilderReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateResolvabilityRes>;
+    private __buildPrecheckV1;
+    /**
+     * Creates a draft order from natural language or a template and streams progress events via SSE. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderStreamEvent)
+     */
+    buildWithStreamingV1(request: Chrt.OrderBuilderReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<core.Stream<Chrt.shipping.orders.OrderBuilderStreamEvent>>;
+    private __buildWithStreamingV1;
+    /**
+     * Adds a coordinator task list with an optional department override to apply when the draft order is staged. | authz_personas=[coordinator_org_operators] | (UTCDatetime | None) -> (bool)
+     *
+     * @param {string} orderId
+     * @param {string} taskListId
+     * @param {Chrt.shipping.orders.DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id", {
+     *         department_id: "department_id",
+     *         body: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    addCoordinatorTaskListToApplyAtOrderStagingV1(orderId: string, taskListId: string, request?: Chrt.shipping.orders.DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addCoordinatorTaskListToApplyAtOrderStagingV1;
+    /**
+     * Removes a pending coordinator staging task list from a draft order. | authz_personas=[coordinator_org_operators] | () -> (bool)
+     *
+     * @param {string} orderId
+     * @param {string} taskListId
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id")
+     */
+    removeCoordinatorTaskListToApplyAtOrderStagingV1(orderId: string, taskListId: string, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeCoordinatorTaskListToApplyAtOrderStagingV1;
+    /**
+     * Deletes a draft order and all associated entities. | authz_personas=[draft_creator_org_operator] | () -> (bool)
+     *
+     * @param {string} orderId
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.deleteV1("order_id")
+     */
+    deleteV1(orderId: string, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Deletes multiple draft orders and associated entities, skipping drafts with billing links. | authz_personas=[draft_creator_org_operator] | (OrdersDraftDeleteManyReq) -> (OrdersDraftDeleteManyRes)
+     *
+     * @param {Chrt.shipping.orders.OrdersDraftDeleteManyReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.deleteManyV1({
+     *         order_ids: ["order_ids"]
+     *     })
+     */
+    deleteManyV1(request: Chrt.shipping.orders.OrdersDraftDeleteManyReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftDeleteManyRes>;
+    private __deleteManyV1;
+    /**
+     * Converts an order screenshot into lightly structured text for the AI order builder. | authz: min_org_role=operator | (UploadFile) -> (str)
+     *
+     * @param {Chrt.shipping.orders.BodyPostShippingOrdersDraftsImageToTextV1} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.shipping.orders.drafts.imageToTextV1({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    imageToTextV1(request: Chrt.shipping.orders.BodyPostShippingOrdersDraftsImageToTextV1, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<string>;
+    private __imageToTextV1;
+    /**
+     * Opens a new draft order shell with org assignments based on caller's organization type. | authz: min_org_role=operator | (OrdersOpenDraftReq) -> (OrdersOpenDraftRes)
+     *
+     * @param {Chrt.shipping.orders.OrdersOpenDraftReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.openV1()
+     */
+    openV1(request?: Chrt.shipping.orders.OrdersOpenDraftReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersOpenDraftRes>;
+    private __openV1;
+    /**
+     * Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)
+     *
+     * @param {string} orderId
+     * @param {Chrt.shipping.orders.SetTaskGroupOrderingDraftReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
+     *         task_group_ids: ["task_group_ids"]
+     *     })
+     */
+    setTaskGroupOrderingV1(orderId: string, request: Chrt.shipping.orders.SetTaskGroupOrderingDraftReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setTaskGroupOrderingV1;
+    /**
+     * Updates coordinator and/or shipper org assignments for a draft order. | authz_personas=[draft_creator_org_operator] | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
+     *
+     * @param {string} orderId
+     * @param {Chrt.shipping.orders.OrdersDraftUpdateReq} request
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.updateV1("order_id")
+     */
+    updateV1(orderId: string, request?: Chrt.shipping.orders.OrdersDraftUpdateReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftUpdateRes>;
+    private __updateV1;
+    /**
+     * Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
+     *
+     * @param {string} orderId
+     * @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.drafts.validateV1("order_id")
+     */
+    validateV1(orderId: string, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftValidationResult>;
+    private __validateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}