@chrt-inc/typescript-sdk 1.448.0 → 1.449.2

package/dist/cjs/api/resources/billing/resources/rateSheets/client/Client.d.ts

@@ -31,32 +31,21 @@ export declare class RateSheets {
     protected readonly _options: RateSheets.Options;
     constructor(_options?: RateSheets.Options);
     /**
-     * Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)
-     *
-     * @param {string} rateSheetId
-     * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.billing.rateSheets.getV1("rate_sheet_id")
-     */
-    getV1(rateSheetId: string, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<Chrt.RateSheet1>;
-    private __getV1;
-    /**
-     * Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)
+     * Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
      *
      * @param {string} rateSheetId
-     * @param {Chrt.billing.RateSheetClientUpdate1} request
+     * @param {Chrt.billing.RateSheetsArchiveV1Request} request
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.updateV1("rate_sheet_id")
+     *     await client.billing.rateSheets.archiveV1("rate_sheet_id", {
+     *         archive: true
+     *     })
      */
-    updateV1(rateSheetId: string, request?: Chrt.billing.RateSheetClientUpdate1, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<Chrt.RateSheet1>;
-    private __updateV1;
+    archiveV1(rateSheetId: string, request: Chrt.billing.RateSheetsArchiveV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __archiveV1;
     /**
      * Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)
      *
@@ -81,38 +70,56 @@ export declare class RateSheets {
     listByOrgV1(request?: Chrt.billing.RateSheetsListByOrgV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<Chrt.RateSheetListResponse>;
     private __listByOrgV1;
     /**
-     * Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)
+     * Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
      *
-     * @param {Chrt.billing.RateSheetClientCreate1} request
+     * @param {Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request} request
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.createV1({
-     *         payment_vector_type: "shipper_pay_forwarder",
-     *         schema_version: 1,
-     *         service_type: "on_demand"
+     *     await client.billing.rateSheets.updateDefaultForConnectionV1({
+     *         connection_id: "connection_id",
+     *         service_type: "on_demand",
+     *         rate_sheet_id: "rate_sheet_id"
      *     })
      */
-    createV1(request: Chrt.billing.RateSheetClientCreate1, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
+    updateDefaultForConnectionV1(request: Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateDefaultForConnectionV1;
     /**
-     * Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
+     * Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
      *
-     * @param {string} rateSheetId
-     * @param {Chrt.billing.RateSheetsArchiveV1Request} request
+     * @param {Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request} request
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.archiveV1("rate_sheet_id", {
-     *         archive: true
+     *     await client.billing.rateSheets.updateDefaultForDriverV1({
+     *         driver_id: "driver_id",
+     *         service_type: "on_demand",
+     *         rate_sheet_id: "rate_sheet_id"
      *     })
      */
-    archiveV1(rateSheetId: string, request: Chrt.billing.RateSheetsArchiveV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __archiveV1;
+    updateDefaultForDriverV1(request: Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateDefaultForDriverV1;
+    /**
+     * Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)
+     *
+     * @param {Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request} request
+     * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
+     *         off_chrt_shipper_org_id: "off_chrt_shipper_org_id",
+     *         service_type: "on_demand",
+     *         rate_sheet_id: "rate_sheet_id"
+     *     })
+     */
+    updateDefaultForOffChrtShipperV1(request: Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateDefaultForOffChrtShipperV1;
     /**
      * Sets or clears the org's default rate sheet for a payment vector type and service type. Pass rate_sheet_id to set a default, or omit it to clear the default. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
      *
@@ -131,55 +138,48 @@ export declare class RateSheets {
     updateOrgDefaultForServiceTypeV1(request: Chrt.billing.RateSheetsUpdateOrgDefaultForServiceTypeV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateOrgDefaultForServiceTypeV1;
     /**
-     * Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
+     * Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)
      *
-     * @param {Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request} request
+     * @param {Chrt.billing.RateSheetClientCreate1} request
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.updateDefaultForConnectionV1({
-     *         connection_id: "connection_id",
-     *         service_type: "on_demand",
-     *         rate_sheet_id: "rate_sheet_id"
+     *     await client.billing.rateSheets.createV1({
+     *         payment_vector_type: "shipper_pay_forwarder",
+     *         schema_version: 1,
+     *         service_type: "on_demand"
      *     })
      */
-    updateDefaultForConnectionV1(request: Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateDefaultForConnectionV1;
+    createV1(request: Chrt.billing.RateSheetClientCreate1, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
     /**
-     * Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
+     * Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)
      *
-     * @param {Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request} request
+     * @param {string} rateSheetId
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.updateDefaultForDriverV1({
-     *         driver_id: "driver_id",
-     *         service_type: "on_demand",
-     *         rate_sheet_id: "rate_sheet_id"
-     *     })
+     *     await client.billing.rateSheets.getV1("rate_sheet_id")
      */
-    updateDefaultForDriverV1(request: Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateDefaultForDriverV1;
+    getV1(rateSheetId: string, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<Chrt.RateSheet1>;
+    private __getV1;
     /**
-     * Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)
+     * Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)
      *
-     * @param {Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request} request
+     * @param {string} rateSheetId
+     * @param {Chrt.billing.RateSheetClientUpdate1} request
      * @param {RateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
-     *         off_chrt_shipper_org_id: "off_chrt_shipper_org_id",
-     *         service_type: "on_demand",
-     *         rate_sheet_id: "rate_sheet_id"
-     *     })
+     *     await client.billing.rateSheets.updateV1("rate_sheet_id")
      */
-    updateDefaultForOffChrtShipperV1(request: Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateDefaultForOffChrtShipperV1;
+    updateV1(rateSheetId: string, request?: Chrt.billing.RateSheetClientUpdate1, requestOptions?: RateSheets.RequestOptions): core.HttpResponsePromise<Chrt.RateSheet1>;
+    private __updateV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }