@chrt-inc/typescript-sdk 1.293.0 → 1.299.0

package/dist/cjs/Client.js

@@ -68,8 +68,8 @@ class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.293.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.293.0",
+                "X-Fern-SDK-Version": "1.299.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.299.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedReq.d.ts

@@ -14,4 +14,6 @@ export interface OrdersExpandedReq {
     expand_milestones?: boolean;
     expand_cargos?: boolean;
     expand_shipper_contact_infos?: boolean;
+    expand_courier_org_company_name?: boolean;
+    expand_courier_org_company_handle?: boolean;
 }

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

@@ -4,8 +4,8 @@
 import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
 import * as Chrt from "../../../index.js";
-import { Full } from "../resources/full/client/Client.js";
-import { TogglePause } from "../resources/togglePause/client/Client.js";
+import { Expanded } from "../resources/expanded/client/Client.js";
+import { ExpandedList } from "../resources/expandedList/client/Client.js";
 export declare namespace TaskGroups {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -31,34 +31,11 @@ export declare namespace TaskGroups {
 }
 export declare class TaskGroups {
     protected readonly _options: TaskGroups.Options;
-    protected _full: Full | undefined;
-    protected _togglePause: TogglePause | undefined;
+    protected _expanded: Expanded | undefined;
+    protected _expandedList: ExpandedList | undefined;
     constructor(_options?: TaskGroups.Options);
-    get full(): Full;
-    get togglePause(): TogglePause;
-    /**
-     * Lists all task groups assigned to the authenticated courier organization with their associated tasks.
-     *
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.taskGroups.listByCourierOrgIdV1()
-     */
-    listByCourierOrgIdV1(requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.MultipleTaskGroupsWithTasks>;
-    private __listByCourierOrgIdV1;
-    /**
-     * Retrieves a specific task group by ID with its associated tasks.
-     *
-     * @param {string} id
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.getByIdV1("id")
-     */
-    getByIdV1(id: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupWithTasks>;
-    private __getByIdV1;
+    get expanded(): Expanded;
+    get expandedList(): ExpandedList;
     /**
      * Updates task group driver assignments by adding or removing drivers.
      *
@@ -74,19 +51,6 @@ export declare class TaskGroups {
      */
     updateV1(request: Chrt.UpdateTaskGroupReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.UpdateTaskGroupRes>;
     private __updateV1;
-    /**
-     * Lists all task groups assigned to a specific driver.
-     *
-     * @param {string} driverId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.listByDriverIdV1("driver_id")
-     */
-    listByDriverIdV1(driverId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroup1[]>;
-    private __listByDriverIdV1;
     /**
      * Starts a task group by changing its status to in-progress and updating the order status.
      *
@@ -101,19 +65,21 @@ export declare class TaskGroups {
     startV1(id: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __startV1;
     /**
-     * Fetches task groups by driver with optional expanded data for tasks, milestones, cargo, and payment information.
+     * Toggles the pause status of an in-progress task group.
      *
-     * @param {Chrt.TaskGroupsExpandedReq} request
+     * @param {string} id
+     * @param {Chrt.SetTaskGroupPauseReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.postByDriverExpandedV1({
-     *         task_group_statuses: ["not_started"]
+     *     await client.taskGroups.togglePauseV1("id", {
+     *         task_group_id: "task_group_id",
+     *         paused: true
      *     })
      */
-    postByDriverExpandedV1(request: Chrt.TaskGroupsExpandedReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupsExpandedRes>;
-    private __postByDriverExpandedV1;
+    togglePauseV1(id: string, request: Chrt.SetTaskGroupPauseReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __togglePauseV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/taskGroups/client/Client.js

@@ -51,129 +51,19 @@ const core = __importStar(require("../../../../core/index.js"));
 const Chrt = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
-const Client_js_1 = require("../resources/full/client/Client.js");
-const Client_js_2 = require("../resources/togglePause/client/Client.js");
+const Client_js_1 = require("../resources/expanded/client/Client.js");
+const Client_js_2 = require("../resources/expandedList/client/Client.js");
 class TaskGroups {
     constructor(_options = {}) {
         this._options = _options;
     }
-    get full() {
+    get expanded() {
         var _a;
-        return ((_a = this._full) !== null && _a !== void 0 ? _a : (this._full = new Client_js_1.Full(this._options)));
+        return ((_a = this._expanded) !== null && _a !== void 0 ? _a : (this._expanded = new Client_js_1.Expanded(this._options)));
     }
-    get togglePause() {
+    get expandedList() {
         var _a;
-        return ((_a = this._togglePause) !== null && _a !== void 0 ? _a : (this._togglePause = new Client_js_2.TogglePause(this._options)));
-    }
-    /**
-     * Lists all task groups assigned to the authenticated courier organization with their associated tasks.
-     *
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.taskGroups.listByCourierOrgIdV1()
-     */
-    listByCourierOrgIdV1(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listByCourierOrgIdV1(requestOptions));
-    }
-    __listByCourierOrgIdV1(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "oort/task_groups/by_courier_org_id/list/v1"),
-                method: "GET",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                throw new errors.ChrtError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                    rawResponse: _response.rawResponse,
-                });
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_groups/by_courier_org_id/list/v1.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    /**
-     * Retrieves a specific task group by ID with its associated tasks.
-     *
-     * @param {string} id
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.getByIdV1("id")
-     */
-    getByIdV1(id, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getByIdV1(id, requestOptions));
-    }
-    __getByIdV1(id, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `oort/task_groups/v1/${encodeURIComponent(id)}`),
-                method: "GET",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_groups/v1/{id}.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
+        return ((_a = this._expandedList) !== null && _a !== void 0 ? _a : (this._expandedList = new Client_js_2.ExpandedList(this._options)));
     }
     /**
      * Updates task group driver assignments by adding or removing drivers.
@@ -239,65 +129,6 @@ class TaskGroups {
             }
         });
     }
-    /**
-     * Lists all task groups assigned to a specific driver.
-     *
-     * @param {string} driverId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.listByDriverIdV1("driver_id")
-     */
-    listByDriverIdV1(driverId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listByDriverIdV1(driverId, requestOptions));
-    }
-    __listByDriverIdV1(driverId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `oort/task_groups/list/v1/${encodeURIComponent(driverId)}`),
-                method: "GET",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_groups/list/v1/{driver_id}.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
     /**
      * Starts a task group by changing its status to in-progress and updating the order status.
      *
@@ -358,28 +189,30 @@ class TaskGroups {
         });
     }
     /**
-     * Fetches task groups by driver with optional expanded data for tasks, milestones, cargo, and payment information.
+     * Toggles the pause status of an in-progress task group.
      *
-     * @param {Chrt.TaskGroupsExpandedReq} request
+     * @param {string} id
+     * @param {Chrt.SetTaskGroupPauseReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.postByDriverExpandedV1({
-     *         task_group_statuses: ["not_started"]
+     *     await client.taskGroups.togglePauseV1("id", {
+     *         task_group_id: "task_group_id",
+     *         paused: true
      *     })
      */
-    postByDriverExpandedV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__postByDriverExpandedV1(request, requestOptions));
+    togglePauseV1(id, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__togglePauseV1(id, request, requestOptions));
     }
-    __postByDriverExpandedV1(request, requestOptions) {
+    __togglePauseV1(id, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "oort/task_groups/by_driver/expanded/v1"),
-                method: "POST",
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `oort/task_groups/toggle_pause/v1/${encodeURIComponent(id)}`),
+                method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -412,7 +245,7 @@ class TaskGroups {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/task_groups/by_driver/expanded/v1.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PUT /oort/task_groups/toggle_pause/v1/{id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts

@@ -1,2 +1,2 @@
 export { type UpdateTaskGroupReq } from "./UpdateTaskGroupReq.js";
-export { type TaskGroupsExpandedReq } from "./TaskGroupsExpandedReq.js";
+export { type SetTaskGroupPauseReq } from "./SetTaskGroupPauseReq.js";

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

@@ -0,0 +1,76 @@
+/**
+ * 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 Expanded {
+    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 Expanded {
+    protected readonly _options: Expanded.Options;
+    constructor(_options?: Expanded.Options);
+    /**
+     * Fetches an expanded task group for the courier org with expanded related data.
+     *
+     * @param {string} id
+     * @param {Chrt.TaskGroupExpandedForCourierAdministratorReq} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {})
+     */
+    forCourierAdministratorByIdV1(id: string, request: Chrt.TaskGroupExpandedForCourierAdministratorReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupExpandedForCourierAdministrator>;
+    private __forCourierAdministratorByIdV1;
+    /**
+     * Fetches an expanded task group assigned to a courier driver with optional expanded related data.
+     *
+     * @param {string} id
+     * @param {Chrt.TaskGroupExpandedForCourierDriverReq} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.expanded.forCourierDriverByIdV1("id", {})
+     */
+    forCourierDriverByIdV1(id: string, request: Chrt.TaskGroupExpandedForCourierDriverReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupExpandedForCourierDriver>;
+    private __forCourierDriverByIdV1;
+    /**
+     * Fetches an expanded task group for the shipper org with expanded related data.
+     *
+     * @param {string} id
+     * @param {Chrt.taskGroups.TaskGroupExpandedForShipperReq} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.expanded.forShipperByIdV1("id")
+     */
+    forShipperByIdV1(id: string, request?: Chrt.taskGroups.TaskGroupExpandedForShipperReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupExpandedForShipper>;
+    private __forShipperByIdV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}