@chrt-inc/typescript-sdk 1.302.0 → 1.303.0

package/README.md

@@ -7,6 +7,25 @@ The Chrt TypeScript library provides convenient access to the Chrt APIs from Typ
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Request and Response Types](#request-and-response-types)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+    - [Additional Headers](#additional-headers)
+    - [Additional Query String Parameters](#additional-query-string-parameters)
+    - [Retries](#retries)
+    - [Timeouts](#timeouts)
+    - [Aborting Requests](#aborting-requests)
+    - [Access Raw Response Data](#access-raw-response-data)
+    - [Runtime Compatibility](#runtime-compatibility)
+- [Contributing](#contributing)
+- [Binary Response](#binary-response)
+
+## Table of Contents
+
 - [Installation](#installation)
 - [Reference](#reference)
 - [Usage](#usage)
@@ -41,7 +60,9 @@ Instantiate and use the client with the following:
 import { ChrtClient } from "@chrt-inc/typescript-sdk";
 
 const client = new ChrtClient({ token: "YOUR_TOKEN" });
-await client.payments.createConnectAccountV1();
+await client.payments.generateInvoiceV1({
+    shipper_pay_courier_statement_id: "shipper_pay_courier_statement_id",
+});
 ```
 
 ## Request and Response Types
@@ -66,7 +87,7 @@ will be thrown.
 import { ChrtError } from "@chrt-inc/typescript-sdk";
 
 try {
-    await client.payments.createConnectAccountV1(...);
+    await client.payments.generateInvoiceV1(...);
 } catch (err) {
     if (err instanceof ChrtError) {
         console.log(err.statusCode);
@@ -84,7 +105,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.payments.createConnectAccountV1(..., {
+const response = await client.payments.generateInvoiceV1(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -96,7 +117,7 @@ const response = await client.payments.createConnectAccountV1(..., {
 If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
 
 ```typescript
-const response = await client.payments.createConnectAccountV1(..., {
+const response = await client.payments.generateInvoiceV1(..., {
     queryParams: {
         'customQueryParamKey': 'custom query param value'
     }
@@ -118,7 +139,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.payments.createConnectAccountV1(..., {
+const response = await client.payments.generateInvoiceV1(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -128,7 +149,7 @@ const response = await client.payments.createConnectAccountV1(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.payments.createConnectAccountV1(..., {
+const response = await client.payments.generateInvoiceV1(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -139,7 +160,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.payments.createConnectAccountV1(..., {
+const response = await client.payments.generateInvoiceV1(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -151,7 +172,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.payments.createConnectAccountV1(...).withRawResponse();
+const { data, rawResponse } = await client.payments.generateInvoiceV1(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

package/dist/cjs/Client.d.ts

@@ -20,6 +20,7 @@ import { Drivers } from "./api/resources/drivers/client/Client.js";
 import { TaskArtifacts } from "./api/resources/taskArtifacts/client/Client.js";
 import { OffChrtShipperOrg } from "./api/resources/offChrtShipperOrg/client/Client.js";
 import { Orders } from "./api/resources/orders/client/Client.js";
+import { OrderDrafts } from "./api/resources/orderDrafts/client/Client.js";
 import { TaskGroups } from "./api/resources/taskGroups/client/Client.js";
 import { ShipperContactInfo } from "./api/resources/shipperContactInfo/client/Client.js";
 import { Orgs } from "./api/resources/orgs/client/Client.js";
@@ -71,6 +72,7 @@ export declare class ChrtClient {
     protected _taskArtifacts: TaskArtifacts | undefined;
     protected _offChrtShipperOrg: OffChrtShipperOrg | undefined;
     protected _orders: Orders | undefined;
+    protected _orderDrafts: OrderDrafts | undefined;
     protected _taskGroups: TaskGroups | undefined;
     protected _shipperContactInfo: ShipperContactInfo | undefined;
     protected _orgs: Orgs | undefined;
@@ -98,6 +100,7 @@ export declare class ChrtClient {
     get taskArtifacts(): TaskArtifacts;
     get offChrtShipperOrg(): OffChrtShipperOrg;
     get orders(): Orders;
+    get orderDrafts(): OrderDrafts;
     get taskGroups(): TaskGroups;
     get shipperContactInfo(): ShipperContactInfo;
     get orgs(): Orgs;

package/dist/cjs/Client.js

@@ -56,22 +56,23 @@ const Client_js_14 = require("./api/resources/drivers/client/Client.js");
 const Client_js_15 = require("./api/resources/taskArtifacts/client/Client.js");
 const Client_js_16 = require("./api/resources/offChrtShipperOrg/client/Client.js");
 const Client_js_17 = require("./api/resources/orders/client/Client.js");
-const Client_js_18 = require("./api/resources/taskGroups/client/Client.js");
-const Client_js_19 = require("./api/resources/shipperContactInfo/client/Client.js");
-const Client_js_20 = require("./api/resources/orgs/client/Client.js");
-const Client_js_21 = require("./api/resources/root/client/Client.js");
-const Client_js_22 = require("./api/resources/users/client/Client.js");
-const Client_js_23 = require("./api/resources/utils/client/Client.js");
-const Client_js_24 = require("./api/resources/notifications/client/Client.js");
-const Client_js_25 = require("./api/resources/orgConnectionInfos/client/Client.js");
-const Client_js_26 = require("./api/resources/tracking/client/Client.js");
+const Client_js_18 = require("./api/resources/orderDrafts/client/Client.js");
+const Client_js_19 = require("./api/resources/taskGroups/client/Client.js");
+const Client_js_20 = require("./api/resources/shipperContactInfo/client/Client.js");
+const Client_js_21 = require("./api/resources/orgs/client/Client.js");
+const Client_js_22 = require("./api/resources/root/client/Client.js");
+const Client_js_23 = require("./api/resources/users/client/Client.js");
+const Client_js_24 = require("./api/resources/utils/client/Client.js");
+const Client_js_25 = require("./api/resources/notifications/client/Client.js");
+const Client_js_26 = require("./api/resources/orgConnectionInfos/client/Client.js");
+const Client_js_27 = require("./api/resources/tracking/client/Client.js");
 class ChrtClient {
     constructor(_options = {}) {
         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.302.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.302.0",
+                "X-Fern-SDK-Version": "1.303.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.303.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -144,41 +145,45 @@ class ChrtClient {
         var _a;
         return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Client_js_17.Orders(this._options)));
     }
+    get orderDrafts() {
+        var _a;
+        return ((_a = this._orderDrafts) !== null && _a !== void 0 ? _a : (this._orderDrafts = new Client_js_18.OrderDrafts(this._options)));
+    }
     get taskGroups() {
         var _a;
-        return ((_a = this._taskGroups) !== null && _a !== void 0 ? _a : (this._taskGroups = new Client_js_18.TaskGroups(this._options)));
+        return ((_a = this._taskGroups) !== null && _a !== void 0 ? _a : (this._taskGroups = new Client_js_19.TaskGroups(this._options)));
     }
     get shipperContactInfo() {
         var _a;
-        return ((_a = this._shipperContactInfo) !== null && _a !== void 0 ? _a : (this._shipperContactInfo = new Client_js_19.ShipperContactInfo(this._options)));
+        return ((_a = this._shipperContactInfo) !== null && _a !== void 0 ? _a : (this._shipperContactInfo = new Client_js_20.ShipperContactInfo(this._options)));
     }
     get orgs() {
         var _a;
-        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_js_20.Orgs(this._options)));
+        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_js_21.Orgs(this._options)));
     }
     get root() {
         var _a;
-        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_js_21.Root(this._options)));
+        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_js_22.Root(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_22.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_23.Users(this._options)));
     }
     get utils() {
         var _a;
-        return ((_a = this._utils) !== null && _a !== void 0 ? _a : (this._utils = new Client_js_23.Utils(this._options)));
+        return ((_a = this._utils) !== null && _a !== void 0 ? _a : (this._utils = new Client_js_24.Utils(this._options)));
     }
     get notifications() {
         var _a;
-        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_24.Notifications(this._options)));
+        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_25.Notifications(this._options)));
     }
     get orgConnectionInfos() {
         var _a;
-        return ((_a = this._orgConnectionInfos) !== null && _a !== void 0 ? _a : (this._orgConnectionInfos = new Client_js_25.OrgConnectionInfos(this._options)));
+        return ((_a = this._orgConnectionInfos) !== null && _a !== void 0 ? _a : (this._orgConnectionInfos = new Client_js_26.OrgConnectionInfos(this._options)));
     }
     get tracking() {
         var _a;
-        return ((_a = this._tracking) !== null && _a !== void 0 ? _a : (this._tracking = new Client_js_26.Tracking(this._options)));
+        return ((_a = this._tracking) !== null && _a !== void 0 ? _a : (this._tracking = new Client_js_27.Tracking(this._options)));
     }
 }
 exports.ChrtClient = ChrtClient;

package/dist/cjs/api/resources/index.d.ts

@@ -15,6 +15,7 @@ export * as drivers from "./drivers/index.js";
 export * as taskArtifacts from "./taskArtifacts/index.js";
 export * as offChrtShipperOrg from "./offChrtShipperOrg/index.js";
 export * as orders from "./orders/index.js";
+export * as orderDrafts from "./orderDrafts/index.js";
 export * as taskGroups from "./taskGroups/index.js";
 export * as shipperContactInfo from "./shipperContactInfo/index.js";
 export * as orgs from "./orgs/index.js";
@@ -35,6 +36,7 @@ export * from "./taskArtifactNotifications/client/requests/index.js";
 export * from "./drivers/client/requests/index.js";
 export * from "./taskArtifacts/client/requests/index.js";
 export * from "./offChrtShipperOrg/client/requests/index.js";
+export * from "./orderDrafts/client/requests/index.js";
 export * from "./taskGroups/client/requests/index.js";
 export * from "./shipperContactInfo/client/requests/index.js";
 export * from "./orgs/client/requests/index.js";

package/dist/cjs/api/resources/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tracking = exports.orgConnectionInfos = exports.notifications = exports.utils = exports.users = exports.root = exports.orgs = exports.shipperContactInfo = exports.taskGroups = exports.orders = exports.offChrtShipperOrg = exports.taskArtifacts = exports.drivers = exports.taskArtifactNotifications = exports.dev = exports.orgProfiles = exports.connections = exports.shipperPayCourierStatements = exports.shipperPayCourierRateSheets = exports.shipperPayCourierPayments = exports.shipperPayCourierLineItemGroups = exports.courierPayDriverStatements = exports.courierPayDriverRateSheets = exports.courierPayDriverPayouts = exports.courierPayDriverLineItemGroups = exports.payments = void 0;
+exports.tracking = exports.orgConnectionInfos = exports.notifications = exports.utils = exports.users = exports.root = exports.orgs = exports.shipperContactInfo = exports.taskGroups = exports.orderDrafts = exports.orders = exports.offChrtShipperOrg = exports.taskArtifacts = exports.drivers = exports.taskArtifactNotifications = exports.dev = exports.orgProfiles = exports.connections = exports.shipperPayCourierStatements = exports.shipperPayCourierRateSheets = exports.shipperPayCourierPayments = exports.shipperPayCourierLineItemGroups = exports.courierPayDriverStatements = exports.courierPayDriverRateSheets = exports.courierPayDriverPayouts = exports.courierPayDriverLineItemGroups = exports.payments = void 0;
 exports.payments = __importStar(require("./payments/index.js"));
 exports.courierPayDriverLineItemGroups = __importStar(require("./courierPayDriverLineItemGroups/index.js"));
 exports.courierPayDriverPayouts = __importStar(require("./courierPayDriverPayouts/index.js"));
@@ -54,6 +54,7 @@ exports.drivers = __importStar(require("./drivers/index.js"));
 exports.taskArtifacts = __importStar(require("./taskArtifacts/index.js"));
 exports.offChrtShipperOrg = __importStar(require("./offChrtShipperOrg/index.js"));
 exports.orders = __importStar(require("./orders/index.js"));
+exports.orderDrafts = __importStar(require("./orderDrafts/index.js"));
 exports.taskGroups = __importStar(require("./taskGroups/index.js"));
 exports.shipperContactInfo = __importStar(require("./shipperContactInfo/index.js"));
 exports.orgs = __importStar(require("./orgs/index.js"));
@@ -74,6 +75,7 @@ __exportStar(require("./taskArtifactNotifications/client/requests/index.js"), ex
 __exportStar(require("./drivers/client/requests/index.js"), exports);
 __exportStar(require("./taskArtifacts/client/requests/index.js"), exports);
 __exportStar(require("./offChrtShipperOrg/client/requests/index.js"), exports);
+__exportStar(require("./orderDrafts/client/requests/index.js"), exports);
 __exportStar(require("./taskGroups/client/requests/index.js"), exports);
 __exportStar(require("./shipperContactInfo/client/requests/index.js"), exports);
 __exportStar(require("./orgs/client/requests/index.js"), exports);

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

@@ -0,0 +1,100 @@
+/**
+ * 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";
+import { TaskGroup } from "../resources/taskGroup/client/Client.js";
+import { Task } from "../resources/task/client/Client.js";
+import { TaskArtifact } from "../resources/taskArtifact/client/Client.js";
+import { Cargo } from "../resources/cargo/client/Client.js";
+export declare namespace OrderDrafts {
+    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 OrderDrafts {
+    protected readonly _options: OrderDrafts.Options;
+    protected _taskGroup: TaskGroup | undefined;
+    protected _task: Task | undefined;
+    protected _taskArtifact: TaskArtifact | undefined;
+    protected _cargo: Cargo | undefined;
+    constructor(_options?: OrderDrafts.Options);
+    get taskGroup(): TaskGroup;
+    get task(): Task;
+    get taskArtifact(): TaskArtifact;
+    get cargo(): Cargo;
+    /**
+     * Creates a new draft order with org assignments based on caller's organization type.
+     *
+     * @param {Chrt.OrdersNewDraftReq} request
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orderDrafts.newV1()
+     */
+    newV1(request?: Chrt.OrdersNewDraftReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersNewDraftRes>;
+    private __newV1;
+    /**
+     * Updates forwarder and/or shipper org assignments for a draft order
+     *
+     * @param {Chrt.OrdersDraftUpdateReq} request
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orderDrafts.updateV1({
+     *         order_id: "order_id"
+     *     })
+     */
+    updateV1(request: Chrt.OrdersDraftUpdateReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftUpdateRes>;
+    private __updateV1;
+    /**
+     * Deletes a draft order and all associated entities
+     *
+     * @param {string} orderId
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orderDrafts.deleteV1("order_id")
+     */
+    deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Checks whether the draft order satisfies all requirements to move into staging.
+     *
+     * @param {string} orderId
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orderDrafts.validateV1("order_id")
+     */
+    validateV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __validateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}