@chrt-inc/typescript-sdk 1.299.0 → 1.303.0

package/dist/esm/api/resources/payments/client/requests/index.d.mts

@@ -1,2 +1,2 @@
-export { type CreateCheckoutSessionReq } from "./CreateCheckoutSessionReq.mjs";
 export { type GenerateInvoiceReq } from "./GenerateInvoiceReq.mjs";
+export { type CreateCheckoutSessionReq } from "./CreateCheckoutSessionReq.mjs";

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

@@ -38,7 +38,7 @@ export declare class ShipperContactInfo {
      * @example
      *     await client.shipperContactInfo.getByJwtUserIdV1()
      */
-    getByJwtUserIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
+    getByJwtUserIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1>;
     private __getByJwtUserIdV1;
     /**
      * Lists all shipper contacts created by the authenticated organization.
@@ -48,7 +48,7 @@ export declare class ShipperContactInfo {
      * @example
      *     await client.shipperContactInfo.listByJwtOrgIdV1()
      */
-    listByJwtOrgIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    listByJwtOrgIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
     private __listByJwtOrgIdV1;
     /**
      * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
@@ -61,21 +61,21 @@ export declare class ShipperContactInfo {
      * @example
      *     await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org_id")
      */
-    listCourierContactsByShipperOrgIdV1(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    listCourierContactsByShipperOrgIdV1(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
     private __listCourierContactsByShipperOrgIdV1;
     /**
      * Lists all shipper contacts for a specific off-platform shipper connection.
      *
-     * @param {string} offChrtShipperOrgInfoId
+     * @param {string} offChrtShipperOrgId
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.listByOffChrtShipperOrgInfoIdV1("off_chrt_shipper_org_info_id")
+     *     await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_org_id")
      */
-    listByOffChrtShipperOrgInfoIdV1(offChrtShipperOrgInfoId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __listByOffChrtShipperOrgInfoIdV1;
+    listByOffChrtShipperOrgIdV1(offChrtShipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
+    private __listByOffChrtShipperOrgIdV1;
     /**
      * Retrieves a specific shipper contact by ID if authorized to access it.
      *
@@ -87,12 +87,12 @@ export declare class ShipperContactInfo {
      * @example
      *     await client.shipperContactInfo.getByIdV1("id")
      */
-    getByIdV1(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
+    getByIdV1(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1>;
     private __getByIdV1;
     /**
      * Creates contact information for an on-platform shipper organization or user.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {Chrt.ShipperContactClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -102,12 +102,12 @@ export declare class ShipperContactInfo {
      *         schema_version: 1
      *     })
      */
-    createOnPlatformV1(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    createOnPlatformV1(request: Chrt.ShipperContactClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
     private __createOnPlatformV1;
     /**
      * Creates contact information for an off-platform shipper using connection info.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {Chrt.ShipperContactClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -117,13 +117,13 @@ export declare class ShipperContactInfo {
      *         schema_version: 1
      *     })
      */
-    createOffPlatformV1(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    createOffPlatformV1(request: Chrt.ShipperContactClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
     private __createOffPlatformV1;
     /**
      * Updates existing shipper contact information owned by the authenticated organization.
      *
      * @param {string} shipperContactInfoId
-     * @param {Chrt.ShipperContactInfoClientUpdate1} request
+     * @param {Chrt.ShipperContactClientUpdate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -131,7 +131,7 @@ export declare class ShipperContactInfo {
      * @example
      *     await client.shipperContactInfo.updateV1("shipper_contact_info_id")
      */
-    updateV1(shipperContactInfoId: string, request?: Chrt.ShipperContactInfoClientUpdate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateV1(shipperContactInfoId: string, request?: Chrt.ShipperContactClientUpdate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateV1;
     /**
      * Deletes shipper contact information owned by the authenticated organization.

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

@@ -183,23 +183,23 @@ export class ShipperContactInfo {
     /**
      * Lists all shipper contacts for a specific off-platform shipper connection.
      *
-     * @param {string} offChrtShipperOrgInfoId
+     * @param {string} offChrtShipperOrgId
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.listByOffChrtShipperOrgInfoIdV1("off_chrt_shipper_org_info_id")
+     *     await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_org_id")
      */
-    listByOffChrtShipperOrgInfoIdV1(offChrtShipperOrgInfoId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listByOffChrtShipperOrgInfoIdV1(offChrtShipperOrgInfoId, requestOptions));
+    listByOffChrtShipperOrgIdV1(offChrtShipperOrgId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listByOffChrtShipperOrgIdV1(offChrtShipperOrgId, requestOptions));
     }
-    __listByOffChrtShipperOrgInfoIdV1(offChrtShipperOrgInfoId, requestOptions) {
+    __listByOffChrtShipperOrgIdV1(offChrtShipperOrgId, 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, `oort/shipper_contact_info/list/v1/${encodeURIComponent(offChrtShipperOrgInfoId)}`),
+                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/shipper_contact_info/list/v1/${encodeURIComponent(offChrtShipperOrgId)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -230,7 +230,7 @@ export class ShipperContactInfo {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_contact_info/list/v1/{off_chrt_shipper_org_info_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_contact_info/list/v1/{off_chrt_shipper_org_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -301,7 +301,7 @@ export class ShipperContactInfo {
     /**
      * Creates contact information for an on-platform shipper organization or user.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {Chrt.ShipperContactClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -365,7 +365,7 @@ export class ShipperContactInfo {
     /**
      * Creates contact information for an off-platform shipper using connection info.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {Chrt.ShipperContactClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -430,7 +430,7 @@ export class ShipperContactInfo {
      * Updates existing shipper contact information owned by the authenticated organization.
      *
      * @param {string} shipperContactInfoId
-     * @param {Chrt.ShipperContactInfoClientUpdate1} request
+     * @param {Chrt.ShipperContactClientUpdate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}

package/dist/esm/api/resources/shipperContactInfo/client/requests/{ShipperContactInfoClientUpdate1.d.mts → ShipperContactClientUpdate1.d.mts}

@@ -6,7 +6,7 @@ import * as Chrt from "../../../../index.mjs";
  * @example
  *     {}
  */
-export interface ShipperContactInfoClientUpdate1 {
+export interface ShipperContactClientUpdate1 {
     company_name?: string | null;
     industry?: string | null;
     street_address?: Chrt.LocationFeature | null;

package/dist/esm/api/resources/shipperContactInfo/client/requests/index.d.mts

@@ -1 +1 @@
-export { type ShipperContactInfoClientUpdate1 } from "./ShipperContactInfoClientUpdate1.mjs";
+export { type ShipperContactClientUpdate1 } from "./ShipperContactClientUpdate1.mjs";

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

@@ -41,7 +41,7 @@ export declare class ShipperPayCourierPayments {
      * @example
      *     await client.shipperPayCourierPayments.getByIdV1("shipper_pay_courier_payment_id")
      */
-    getByIdV1(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierPayment1>;
+    getByIdV1(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
     private __getByIdV1;
     /**
      * Deletes a shipper-to-courier payment record if invoice not yet created.
@@ -67,7 +67,7 @@ export declare class ShipperPayCourierPayments {
      * @example
      *     await client.shipperPayCourierPayments.getByOrderIdOrShortIdV1("order_id_or_short_id")
      */
-    getByOrderIdOrShortIdV1(orderIdOrShortId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierPayment1>;
+    getByOrderIdOrShortIdV1(orderIdOrShortId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
     private __getByOrderIdOrShortIdV1;
     /**
      * Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.

package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByCourierReq.d.mts

@@ -12,5 +12,5 @@ export interface ListPaymentsByCourierReq {
     statuses: Chrt.StripeConnectInvoiceStatusEnum[];
     /** Must be a string starting with `org_` */
     shipper_org_id?: string | null;
-    off_chrt_shipper_org_info_id?: string | null;
+    off_chrt_shipper_org_id?: string | null;
 }

package/dist/esm/api/resources/shipperPayCourierRateSheets/client/requests/ShipperPayCourierRateSheetClientCreate1.d.mts

@@ -29,7 +29,7 @@ export interface ShipperPayCourierRateSheetClientCreate1 {
     route_types?: Chrt.RouteTypeEnum1[] | null;
     /** Must be a string starting with `org_` */
     shipper_org_id?: string | null;
-    off_chrt_shipper_org_info_id?: string | null;
+    off_chrt_shipper_org_id?: string | null;
     comments?: string | null;
     base_mileage_distance_miles: number;
     base_mileage_rate_usd_per_instance: number;

package/dist/esm/api/resources/shipperPayCourierRateSheets/client/requests/ShipperPayCourierRateSheetClientUpdate1.d.mts

@@ -13,7 +13,7 @@ export interface ShipperPayCourierRateSheetClientUpdate1 {
     route_types?: Chrt.RouteTypeEnum1[] | null;
     /** Must be a string starting with `org_` */
     shipper_org_id?: string | null;
-    off_chrt_shipper_org_info_id?: string | null;
+    off_chrt_shipper_org_id?: string | null;
     comments?: string | null;
     base_mileage_distance_miles?: number | null;
     base_mileage_rate_usd_per_instance?: number | null;

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

@@ -0,0 +1,133 @@
+/**
+ * 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 ShipperPayCourierStatements {
+    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 ShipperPayCourierStatements {
+    protected readonly _options: ShipperPayCourierStatements.Options;
+    constructor(_options?: ShipperPayCourierStatements.Options);
+    /**
+     * Retrieves a shipper pay courier statement by its ID with Stripe invoice sync.
+     *
+     * @param {string} shipperPayCourierStatementId
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.getByIdV1("shipper_pay_courier_statement_id")
+     */
+    getByIdV1(shipperPayCourierStatementId: string, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
+    private __getByIdV1;
+    /**
+     * Deletes a shipper-to-courier statement record if invoice not yet created.
+     *
+     * @param {string} shipperPayCourierStatementId
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.deleteV1("shipper_pay_courier_statement_id")
+     */
+    deleteV1(shipperPayCourierStatementId: string, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Retrieves a shipper pay courier statement by order ID or short ID with Stripe invoice sync.
+     *
+     * @param {string} orderIdOrShortId
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.getByOrderIdOrShortIdV1("order_id_or_short_id")
+     */
+    getByOrderIdOrShortIdV1(orderIdOrShortId: string, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
+    private __getByOrderIdOrShortIdV1;
+    /**
+     * Lists shipper pay courier statements by shipper org ID with status filtering and Stripe sync.
+     *
+     * @param {Chrt.ListStatementsByShipperReq} request
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.listByShipperOrgIdV1({
+     *         statuses: ["invoice_not_yet_created"]
+     *     })
+     */
+    listByShipperOrgIdV1(request: Chrt.ListStatementsByShipperReq, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierStatementsForShipperRes>;
+    private __listByShipperOrgIdV1;
+    /**
+     * Lists shipper pay courier statements by courier org ID with status filtering and Stripe sync.
+     *
+     * @param {Chrt.ListStatementsByCourierReq} request
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.listByCourierOrgIdV1({
+     *         statuses: ["invoice_not_yet_created"]
+     *     })
+     */
+    listByCourierOrgIdV1(request: Chrt.ListStatementsByCourierReq, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierStatementsForShipperRes>;
+    private __listByCourierOrgIdV1;
+    /**
+     * Creates a shipper-to-courier statement record based on all task groups in an order.
+     *
+     * @param {Chrt.CreateShipperPayCourierStatementReq} request
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.createV1({
+     *         order_id_or_short_id: "order_id_or_short_id"
+     *     })
+     */
+    createV1(request: Chrt.CreateShipperPayCourierStatementReq, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status.
+     *
+     * @param {Chrt.CreateShipperPayCourierStatementReq} request
+     * @param {ShipperPayCourierStatements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperPayCourierStatements.previewV1({
+     *         order_id_or_short_id: "order_id_or_short_id"
+     *     })
+     */
+    previewV1(request: Chrt.CreateShipperPayCourierStatementReq, requestOptions?: ShipperPayCourierStatements.RequestOptions): core.HttpResponsePromise<Chrt.StatementPreviewResponse>;
+    private __previewV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}