@chrt-inc/typescript-sdk 1.341.19 → 1.344.0

package/dist/esm/api/resources/billing/resources/rateSheets/client/requests/RateSheetsListByOrgV1Request.d.mts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         sort_by: "id",
+ *         sort_order: "ascending",
+ *         page: 1,
+ *         page_size: 1,
+ *         filter_archived: true,
+ *         filter_payment_vector_type: "shipper_pay_forwarder",
+ *         filter_service_type: "on_demand",
+ *         filter_cargo_type: "spare_parts",
+ *         filter_vehicle_type: "sedan"
+ *     }
+ */
+export interface RateSheetsListByOrgV1Request {
+    sort_by?: Chrt.RateSheetSortByEnum | null;
+    sort_order?: Chrt.billing.RateSheetsListByOrgV1RequestSortOrder | null;
+    page?: number | null;
+    page_size?: number | null;
+    filter_archived?: boolean | null;
+    filter_payment_vector_type?: Chrt.PaymentVectorTypeEnum1 | null;
+    /** Filter by service type (exact match) */
+    filter_service_type?: Chrt.ServiceTypeEnum1 | null;
+    /** Filter by cargo type (checks if value is in cargo_types array) */
+    filter_cargo_type?: Chrt.CargoTypeEnum1 | null;
+    /** Filter by vehicle type (checks if value is in vehicle_types array) */
+    filter_vehicle_type?: Chrt.VehicleTypeEnum | null;
+}

package/dist/esm/api/resources/billing/resources/rateSheets/client/requests/RateSheetsUpdateDefaultForConnectionV1Request.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         connection_id: "connection_id",
+ *         service_type: "on_demand",
+ *         rate_sheet_id: "rate_sheet_id"
+ *     }
+ */
+export interface RateSheetsUpdateDefaultForConnectionV1Request {
+    connection_id: string;
+    service_type: Chrt.ServiceTypeEnum1;
+    rate_sheet_id?: string | null;
+}

package/dist/esm/api/resources/billing/resources/rateSheets/client/requests/RateSheetsUpdateDefaultForDriverV1Request.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         driver_id: "driver_id",
+ *         service_type: "on_demand",
+ *         rate_sheet_id: "rate_sheet_id"
+ *     }
+ */
+export interface RateSheetsUpdateDefaultForDriverV1Request {
+    driver_id: string;
+    service_type: Chrt.ServiceTypeEnum1;
+    rate_sheet_id?: string | null;
+}

package/dist/esm/api/resources/billing/resources/rateSheets/client/requests/RateSheetsUpdateOrgDefaultForServiceTypeV1Request.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         payment_vector_type: "shipper_pay_forwarder",
+ *         service_type: "on_demand",
+ *         rate_sheet_id: "rate_sheet_id"
+ *     }
+ */
+export interface RateSheetsUpdateOrgDefaultForServiceTypeV1Request {
+    payment_vector_type: Chrt.PaymentVectorTypeEnum1;
+    service_type: Chrt.ServiceTypeEnum1;
+    rate_sheet_id?: string | null;
+}

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

@@ -0,0 +1,7 @@
+export { type RateSheetClientUpdate1 } from "./RateSheetClientUpdate1.mjs";
+export { type RateSheetsListByOrgV1Request } from "./RateSheetsListByOrgV1Request.mjs";
+export { type RateSheetClientCreate1 } from "./RateSheetClientCreate1.mjs";
+export { type RateSheetsArchiveV1Request } from "./RateSheetsArchiveV1Request.mjs";
+export { type RateSheetsUpdateOrgDefaultForServiceTypeV1Request } from "./RateSheetsUpdateOrgDefaultForServiceTypeV1Request.mjs";
+export { type RateSheetsUpdateDefaultForConnectionV1Request } from "./RateSheetsUpdateDefaultForConnectionV1Request.mjs";
+export { type RateSheetsUpdateDefaultForDriverV1Request } from "./RateSheetsUpdateDefaultForDriverV1Request.mjs";

package/dist/esm/api/resources/billing/resources/rateSheets/index.d.mts

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

package/dist/esm/api/resources/billing/resources/rateSheets/index.mjs

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

package/dist/esm/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.d.mts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RateSheetsListByOrgV1RequestSortOrder = "ascending" | "descending";
+export declare const RateSheetsListByOrgV1RequestSortOrder: {
+    readonly Ascending: "ascending";
+    readonly Descending: "descending";
+};

package/dist/esm/api/resources/billing/resources/rateSheets/types/RateSheetsListByOrgV1RequestSortOrder.mjs

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const RateSheetsListByOrgV1RequestSortOrder = {
+    Ascending: "ascending",
+    Descending: "descending",
+};

package/dist/esm/api/resources/billing/resources/rateSheets/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./RateSheetsListByOrgV1RequestSortOrder.mjs";

package/dist/esm/api/resources/billing/resources/rateSheets/types/index.mjs

@@ -0,0 +1 @@
+export * from "./RateSheetsListByOrgV1RequestSortOrder.mjs";

package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts

@@ -0,0 +1,206 @@
+/**
+ * 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 Statements {
+    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 Statements {
+    protected readonly _options: Statements.Options;
+    constructor(_options?: Statements.Options);
+    /**
+     * Gets a statement by ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.getV1("statement_id")
+     */
+    getV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __getV1;
+    /**
+     * Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
+     *
+     * @param {string} lineItemGroupId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.getByLigIdV1("line_item_group_id")
+     */
+    getByLigIdV1(lineItemGroupId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __getByLigIdV1;
+    /**
+     * Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)
+     *
+     * @param {Chrt.billing.StatementExpandedRetrieveReq} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.expandedRetrieveV1({
+     *         statement_id: "statement_id"
+     *     })
+     */
+    expandedRetrieveV1(request: Chrt.billing.StatementExpandedRetrieveReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.StatementExpandedRes>;
+    private __expandedRetrieveV1;
+    /**
+     * Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)
+     *
+     * @param {Chrt.billing.StatementsListV1Request} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.listV1({
+     *         sort_by: "amount",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_settlement_type: "stripe_connect",
+     *         filter_payment_origin_org_id: "filter_payment_origin_org_id",
+     *         filter_payment_destination_org_id: "filter_payment_destination_org_id",
+     *         filter_owned_by_org_id: "filter_owned_by_org_id",
+     *         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_voided_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_voided_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.billing.StatementsListV1Request, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.StatementsListRes>;
+    private __listV1;
+    /**
+     * Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)
+     *
+     * @param {Chrt.billing.CreateStatementReq} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.createV1({
+     *         payment_vector_type: "shipper_pay_forwarder",
+     *         settlement_type: "stripe_connect"
+     *     })
+     */
+    createV1(request: Chrt.billing.CreateStatementReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __createV1;
+    /**
+     * Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.deleteV1("statement_id")
+     */
+    deleteV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.updateSettlementTypeV1("statement_id", {
+     *         settlement_type: "stripe_connect"
+     *     })
+     */
+    updateSettlementTypeV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __updateSettlementTypeV1;
+    /**
+     * Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
+     *         new_status: "staged"
+     *     })
+     */
+    updateOffChrtSettlementStateV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __updateOffChrtSettlementStateV1;
+    /**
+     * Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Chrt.billing.OpenInvoiceReq} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.openInvoiceV1("statement_id")
+     */
+    openInvoiceV1(statementId: string, request?: Chrt.billing.OpenInvoiceReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __openInvoiceV1;
+    /**
+     * Syncs invoice state from Stripe to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: min_org_role=operator | () -> (SyncInvoiceRes)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.syncInvoiceV1("statement_id")
+     */
+    syncInvoiceV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.SyncInvoiceRes>;
+    private __syncInvoiceV1;
+    /**
+     * Cancels/voids a Stripe Connect invoice. Statement must be OPEN or VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN, VOID | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.cancelInvoiceV1("statement_id")
+     */
+    cancelInvoiceV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __cancelInvoiceV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}