@chrt-inc/typescript-sdk 1.929.0 → 1.932.0

package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.mjs

@@ -147,6 +147,65 @@ export class TaskGroup {
             }
         });
     }
+    /**
+     * Deletes a task group from an active order and synchronizes affected order, driver, cargo, and account state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.deleteV1("task_group_id")
+     */
+    deleteV1(taskGroupId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteV1(taskGroupId, requestOptions));
+    }
+    __deleteV1(taskGroupId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `shipping/orders/task_group/delete/v1/${encodeURIComponent(taskGroupId)}`),
+                method: "DELETE",
+                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 DELETE /shipping/orders/task_group/delete/v1/{task_group_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Clears the driver from an order task group. DRAFT task groups require executor_org_operators; operational task groups require executor_org_operators or driver_for_executor and STAGED or IN_PROGRESS status. | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
      *

package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts

@@ -87,6 +87,7 @@ export declare class Expanded {
      *         page: 1,
      *         page_size: 1,
      *         search: "search",
+     *         filter_status: ["draft"],
      *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
      *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
      *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -125,6 +126,7 @@ export declare class Expanded {
      *         page: 1,
      *         page_size: 1,
      *         search: "search",
+     *         filter_status: ["draft"],
      *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
      *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
      *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",

package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs

@@ -223,6 +223,7 @@ export class Expanded {
      *         page: 1,
      *         page_size: 1,
      *         search: "search",
+     *         filter_status: ["draft"],
      *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
      *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
      *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -386,6 +387,7 @@ export class Expanded {
      *         page: 1,
      *         page_size: 1,
      *         search: "search",
+     *         filter_status: ["draft"],
      *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
      *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
      *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",

package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverV1Request.d.mts

@@ -10,6 +10,7 @@ import * as Chrt from "../../../../../../../../index.mjs";
  *         page: 1,
  *         page_size: 1,
  *         search: "search",
+ *         filter_status: ["draft"],
  *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
  *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
  *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",

package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts

@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../../../index.mjs";
  *         page: 1,
  *         page_size: 1,
  *         search: "search",
+ *         filter_status: ["draft"],
  *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
  *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
  *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",

package/dist/esm/api/resources/shippingIntegrations/client/Client.d.mts

@@ -0,0 +1,29 @@
+/**
+ * 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 { Connections } from "../resources/connections/client/Client.mjs";
+import { Orders } from "../resources/orders/client/Client.mjs";
+import { Xcelerator } from "../resources/xcelerator/client/Client.mjs";
+export declare namespace ShippingIntegrations {
+    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;
+    }
+}
+export declare class ShippingIntegrations {
+    protected readonly _options: ShippingIntegrations.Options;
+    protected _connections: Connections | undefined;
+    protected _orders: Orders | undefined;
+    protected _xcelerator: Xcelerator | undefined;
+    constructor(_options?: ShippingIntegrations.Options);
+    get connections(): Connections;
+    get orders(): Orders;
+    get xcelerator(): Xcelerator;
+}

package/dist/esm/api/resources/shippingIntegrations/client/Client.mjs

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Connections } from "../resources/connections/client/Client.mjs";
+import { Orders } from "../resources/orders/client/Client.mjs";
+import { Xcelerator } from "../resources/xcelerator/client/Client.mjs";
+export class ShippingIntegrations {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get connections() {
+        var _a;
+        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Connections(this._options)));
+    }
+    get orders() {
+        var _a;
+        return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Orders(this._options)));
+    }
+    get xcelerator() {
+        var _a;
+        return ((_a = this._xcelerator) !== null && _a !== void 0 ? _a : (this._xcelerator = new Xcelerator(this._options)));
+    }
+}

package/dist/esm/api/resources/shippingIntegrations/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/api/resources/shippingIntegrations/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/api/resources/{shipping/resources/orders/resources/drafts/resources/cargo → shippingIntegrations/resources/connections}/client/Client.d.mts

@@ -1,9 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as environments from "../../../../../../../../../../environments.mjs";
-import * as core from "../../../../../../../../../../core/index.mjs";
-export declare namespace Cargo {
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../index.mjs";
+export declare namespace Connections {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
@@ -26,21 +27,18 @@ export declare namespace Cargo {
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
-export declare class Cargo {
-    protected readonly _options: Cargo.Options;
-    constructor(_options?: Cargo.Options);
+export declare class Connections {
+    protected readonly _options: Connections.Options;
+    constructor(_options?: Connections.Options);
     /**
-     * Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
+     * Lists every provider the caller's organization has credentials for, across all shipping integrations. | () -> (ShippingIntegrationConnectionListRes)
      *
-     * @param {string} cargoId
-     * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.shipping.orders.drafts.cargo.deleteV1("cargo_id")
+     *     await client.shippingIntegrations.connections.listV1()
      */
-    deleteV1(cargoId: string, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteV1;
+    listV1(requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationConnectionListRes>;
+    private __listV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/esm/api/resources/{shipping/resources/orders/resources/drafts/resources/cargo → shippingIntegrations/resources/connections}/client/Client.mjs

@@ -10,36 +10,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as environments from "../../../../../../../../../../environments.mjs";
-import * as core from "../../../../../../../../../../core/index.mjs";
-import * as Chrt from "../../../../../../../../../index.mjs";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../../../../../core/headers.mjs";
-import * as errors from "../../../../../../../../../../errors/index.mjs";
-export class Cargo {
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+export class Connections {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
+     * Lists every provider the caller's organization has credentials for, across all shipping integrations. | () -> (ShippingIntegrationConnectionListRes)
      *
-     * @param {string} cargoId
-     * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.shipping.orders.drafts.cargo.deleteV1("cargo_id")
+     *     await client.shippingIntegrations.connections.listV1()
      */
-    deleteV1(cargoId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteV1(cargoId, requestOptions));
+    listV1(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listV1(requestOptions));
     }
-    __deleteV1(cargoId, requestOptions) {
+    __listV1(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `shipping/orders/drafts/cargo/delete/v1/${encodeURIComponent(cargoId)}`),
-                method: "DELETE",
+                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, "shipping_integrations/connections/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,
@@ -47,19 +43,17 @@ export class Cargo {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
+                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,
-                        });
-                }
+                throw new errors.ChrtError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                    rawResponse: _response.rawResponse,
+                });
             }
             switch (_response.error.reason) {
                 case "non-json":
@@ -69,7 +63,7 @@ export class Cargo {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling DELETE /shipping/orders/drafts/cargo/delete/v1/{cargo_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping_integrations/connections/list/v1.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/esm/api/resources/shippingIntegrations/resources/connections/client/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/shippingIntegrations/resources/index.d.mts

@@ -0,0 +1,4 @@
+export * as connections from "./connections/index.mjs";
+export * as orders from "./orders/index.mjs";
+export * as xcelerator from "./xcelerator/index.mjs";
+export * from "./orders/client/requests/index.mjs";

package/dist/esm/api/resources/shippingIntegrations/resources/index.mjs

@@ -0,0 +1,4 @@
+export * as connections from "./connections/index.mjs";
+export * as orders from "./orders/index.mjs";
+export * as xcelerator from "./xcelerator/index.mjs";
+export * from "./orders/client/requests/index.mjs";

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

@@ -0,0 +1,101 @@
+/**
+ * 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";
+export declare namespace Orders {
+    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 Orders {
+    protected readonly _options: Orders.Options;
+    constructor(_options?: Orders.Options);
+    /**
+     * Returns one unified shipping integration order by its Mongo ObjectId. | () -> (ShippingIntegrationOrder1)
+     *
+     * @param {string} id - Mongo ObjectId of the unified order document. The provider's own order ID is the integration_order_id field on the returned order.
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.orders.detailV1("id")
+     */
+    detailV1(id: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationOrder1>;
+    private __detailV1;
+    /**
+     * Lists the caller's orders from every shipping integration with filtering, sorting, and pagination. | () -> (ShippingIntegrationOrderListRes)
+     *
+     * @param {Chrt.shippingIntegrations.OrdersListV1Request} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.orders.listV1({
+     *         sort_by: "ordered_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_shipping_integration: ["xcelerator"],
+     *         filter_provider_org_id: ["filter_provider_org_id"],
+     *         filter_status: ["staged"],
+     *         filter_integration_order_id: "filter_integration_order_id",
+     *         filter_reference_number: "filter_reference_number",
+     *         filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.shippingIntegrations.OrdersListV1Request, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationOrderListRes>;
+    private __listV1;
+    /**
+     * Counts the caller's shipping integration orders by unified status. | () -> (ShippingIntegrationOrderStatusSummaryRes)
+     *
+     * @param {Chrt.shippingIntegrations.OrdersStatusSummaryV1Request} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.orders.statusSummaryV1({
+     *         filter_shipping_integration: ["xcelerator"],
+     *         filter_provider_org_id: ["filter_provider_org_id"],
+     *         filter_status: ["staged"],
+     *         filter_integration_order_id: "filter_integration_order_id",
+     *         filter_reference_number: "filter_reference_number",
+     *         filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    statusSummaryV1(request?: Chrt.shippingIntegrations.OrdersStatusSummaryV1Request, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationOrderStatusSummaryRes>;
+    private __statusSummaryV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}