@chrt-inc/typescript-sdk 1.319.0 → 1.321.0

package/dist/cjs/api/resources/taskGroups/client/Client.d.ts

@@ -4,6 +4,9 @@
 import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
 import * as Chrt from "../../../index.js";
+import { TaskGroupId } from "../resources/taskGroupId/client/Client.js";
+import { S3ObjectMetadata } from "../resources/s3ObjectMetadata/client/Client.js";
+import { S3Object } from "../resources/s3Object/client/Client.js";
 import { Expanded } from "../resources/expanded/client/Client.js";
 export declare namespace TaskGroups {
     interface Options {
@@ -30,37 +33,30 @@ export declare namespace TaskGroups {
 }
 export declare class TaskGroups {
     protected readonly _options: TaskGroups.Options;
+    protected _taskGroupId: TaskGroupId | undefined;
+    protected _s3ObjectMetadata: S3ObjectMetadata | undefined;
+    protected _s3Object: S3Object | undefined;
     protected _expanded: Expanded | undefined;
     constructor(_options?: TaskGroups.Options);
+    get taskGroupId(): TaskGroupId;
+    get s3ObjectMetadata(): S3ObjectMetadata;
+    get s3Object(): S3Object;
     get expanded(): Expanded;
     /**
-     * Retrieves the task group ID for the courier organization assigned to an order. | authz_personas=[courier_org_operators] | () -> (PydanticObjectId)
+     * Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
      *
-     * @param {string} byOrderIdOrShortId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_short_id")
-     */
-    getTaskGroupIdForCourierOperatorsV1(byOrderIdOrShortId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<string>;
-    private __getTaskGroupIdForCourierOperatorsV1;
-    /**
-     * Retrieves the task group ID for the courier driver assigned to an order. | authz_personas=[courier_driver] | () -> (PydanticObjectId)
-     *
-     * @param {string} byOrderIdOrShortId
+     * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_id")
+     *     await client.taskGroups.startV1("task_group_id")
      */
-    getTaskGroupIdForCourierDriverV1(byOrderIdOrShortId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<string>;
-    private __getTaskGroupIdForCourierDriverV1;
+    startV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __startV1;
     /**
-     * Updates the ordering of tasks in a task group. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
+     * Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.SetTaskOrderingReq} request
@@ -70,13 +66,13 @@ export declare class TaskGroups {
      *
      * @example
      *     await client.taskGroups.setTaskOrderingV1("task_group_id", {
-     *         task_ordering: ["task_ordering"]
+     *         task_ids: ["task_ids"]
      *     })
      */
     setTaskOrderingV1(taskGroupId: string, request: Chrt.SetTaskOrderingReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setTaskOrderingV1;
     /**
-     * Updates the flight number on both task group and all its tasks. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
+     * Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the immediately preceding task group and RECOVER_FROM_AIRLINE tasks in the immediately following task group. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.SetFlightNumberReq} request
@@ -92,45 +88,95 @@ export declare class TaskGroups {
     setFlightNumberV1(taskGroupId: string, request: Chrt.SetFlightNumberReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setFlightNumberV1;
     /**
-     * Sets or removes the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateTaskGroupDriverReq) -> (bool)
+     * Updates the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateDriverReq) -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.UpdateTaskGroupDriverReq} request
+     * @param {Chrt.UpdateDriverReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.updateDriverV1("task_group_id")
+     *     await client.taskGroups.updateDriverV1("task_group_id", {
+     *         driver_id: "driver_id"
+     *     })
      */
-    updateDriverV1(taskGroupId: string, request?: Chrt.UpdateTaskGroupDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateDriverV1(taskGroupId: string, request: Chrt.UpdateDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateDriverV1;
     /**
-     * Sets or removes the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateTaskGroupCourierOrgReq) -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.UpdateTaskGroupCourierOrgReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.updateCourierOrgV1("task_group_id")
+     *     await client.taskGroups.removeDriverV1("task_group_id")
+     */
+    removeDriverV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeDriverV1;
+    /**
+     * Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.UpdateCourierOrgReq} request
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.updateCourierOrgV1("task_group_id", {
+     *         courier_org_id: "courier_org_id"
+     *     })
      */
-    updateCourierOrgV1(taskGroupId: string, request?: Chrt.UpdateTaskGroupCourierOrgReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateCourierOrgV1(taskGroupId: string, request: Chrt.UpdateCourierOrgReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateCourierOrgV1;
     /**
-     * Starts a task group by changing its status to in-progress and updating the order status. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
+     * Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
      *
      * @param {string} taskGroupId
+     * @param {Chrt.AddMessageReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.startV1("task_group_id")
+     *     await client.taskGroups.addMessageV1("task_group_id", {
+     *         message: "message"
+     *     })
      */
-    startV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __startV1;
+    addMessageV1(taskGroupId: string, request: Chrt.AddMessageReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addMessageV1;
+    /**
+     * Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost} request
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.taskGroups.addS3ObjectV1("task_group_id", {
+     *         image: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    addS3ObjectV1(taskGroupId: string, request: Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addS3ObjectV1;
+    /**
+     * Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
+     *
+     * @param {string} taskGroupS3ObjectMetadataId
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id")
+     */
+    deleteS3ObjectV1(taskGroupS3ObjectMetadataId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteS3ObjectV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }