@chrt-inc/typescript-sdk 1.441.0 → 1.441.2

package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         task_id: "task_id",
+ *         task_artifact_type: "image"
+ *     }
+ */
+export interface OrderDraftAddTaskArtifactReq {
+    task_id: string;
+    task_artifact_type: Chrt.TaskArtifactTypeEnum1;
+}

package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.ts

@@ -0,0 +1,152 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../../../environments.js";
+import * as core from "../../../../../../../../core/index.js";
+import * as Chrt from "../../../../../../../index.js";
+export declare namespace TaskGroup {
+    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 TaskGroup {
+    protected readonly _options: TaskGroup.Options;
+    constructor(_options?: TaskGroup.Options);
+    /**
+     * Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
+     *
+     * @param {Chrt.shipping.orderDrafts.OrderDraftAddTaskGroupReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.addV1({
+     *         task_group_type: "chrt_ground_courier",
+     *         order_id: "order_id"
+     *     })
+     */
+    addV1(request: Chrt.shipping.orderDrafts.OrderDraftAddTaskGroupReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<string>;
+    private __addV1;
+    /**
+     * Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightInfoReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.SetFlightInfoReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {})
+     */
+    setFlightInfoV1(taskGroupId: string, request: Chrt.SetFlightInfoReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setFlightInfoV1;
+    /**
+     * Updates the courier organization assigned to a draft task group. | (UpdateCourierOrgDraftReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orderDrafts.UpdateCourierOrgDraftReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.updateCourierOrgV1("task_group_id", {
+     *         courier_org_id: "courier_org_id"
+     *     })
+     */
+    updateCourierOrgV1(taskGroupId: string, request: Chrt.shipping.orderDrafts.UpdateCourierOrgDraftReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateCourierOrgV1;
+    /**
+     * Removes the courier organization from a draft task group (sets courier_org_id to null). | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.removeCourierOrgV1("task_group_id")
+     */
+    removeCourierOrgV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeCourierOrgV1;
+    /**
+     * Sets the ordering of tasks within a draft task group. Must provide all task IDs with no duplicates. | (SetTaskOrderingDraftReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orderDrafts.SetTaskOrderingDraftReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.setTaskOrderingV1("task_group_id", {
+     *         task_ids: ["task_ids"]
+     *     })
+     */
+    setTaskOrderingV1(taskGroupId: string, request: Chrt.shipping.orderDrafts.SetTaskOrderingDraftReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setTaskOrderingV1;
+    /**
+     * Sets rate sheet IDs on a draft task group. Forwarder mode (SPF/FPC) and direct shipper mode (SPC) are mutually exclusive. CPD is independent. | (SetRateSheetsReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orderDrafts.SetRateSheetsReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.setRateSheetsV1("task_group_id")
+     */
+    setRateSheetsV1(taskGroupId: string, request?: Chrt.shipping.orderDrafts.SetRateSheetsReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setRateSheetsV1;
+    /**
+     * Sets the service type on a draft task group. Can only be set when task group is in DRAFT status. | (SetServiceTypeReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orderDrafts.SetServiceTypeReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.setServiceTypeV1("task_group_id", {
+     *         service_type: "on_demand"
+     *     })
+     */
+    setServiceTypeV1(taskGroupId: string, request: Chrt.shipping.orderDrafts.SetServiceTypeReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setServiceTypeV1;
+    /**
+     * Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.taskGroup.deleteV1("task_group_id")
+     */
+    deleteV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}