rebilly-js-sdk 62.163.0 → 62.165.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [62.163.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.162.1...rebilly-js-sdk-v62.163.0) (2026-09-08)
+## [62.165.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.164.0...rebilly-js-sdk-v62.165.0) (2026-09-11)
 
 
 ### Features
 
-* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#25625](https://github.com/Rebilly/rebilly/issues/25625)) ([3dab1e5](https://github.com/Rebilly/rebilly/commit/3dab1e510875d337565e28497faede1e590e6845))
+* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#25803](https://github.com/Rebilly/rebilly/issues/25803)) ([7cabfd9](https://github.com/Rebilly/rebilly/commit/7cabfd9c2a6b8f5efc44b88fa0ab57468cc8cc62))

package/dist/rebilly-js-sdk.d.cts

@@ -16370,6 +16370,54 @@ export interface coreComponents {
        */
       status?: "draft" | "archived";
     };
+    /**
+     * Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
+     * For example, if `coinsPerFiatMinor` is `10`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
+     */
+    CoinPricingFlatRate: {
+      /** Flat-rate formula for converting the paid fiat amount into coins. */
+      formula: "flat-rate";
+      /**
+       * Number of coins credited for each minor unit of the paid currency.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+    };
+    /** Amount range and coin rate for volume pricing. */
+    CoinPricingVolumeBracket: {
+      /**
+       * Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+      /**
+       * Highest paid amount in this range, in major units of the currency for the deposit request.
+       * This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
+       * A `null` value means this range has no upper limit.
+       */
+      maxAmount?: number | null;
+    };
+    /**
+     * Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
+     * For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
+     */
+    CoinPricingVolume: {
+      /** Volume-based formula for converting the paid fiat amount into coins. */
+      formula: "volume";
+      /**
+       * Amount ranges that define the coin rate for a paid amount.
+       * The first range matches amounts less than or equal to `maxAmount`.
+       * Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
+       * A final range with a `null` `maxAmount` has no upper limit.
+       */
+      brackets: coreComponents["schemas"]["CoinPricingVolumeBracket"][];
+    };
+    /** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
+    CoinPricing:
+      | coreComponents["schemas"]["CoinPricingFlatRate"]
+      | coreComponents["schemas"]["CoinPricingVolume"];
     DepositRequest: {
       /** ID of the deposit request. */
       id?: string;
@@ -16393,8 +16441,14 @@ export interface coreComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase?: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
       currency: coreComponents["schemas"]["CurrencyCode"];
       /**
        * List of available deposit amounts.
@@ -16765,8 +16819,21 @@ export interface coreComponents {
       priority?: number;
       /** Specifies if the deposit amount strategy is active. */
       isActive?: boolean;
-      /** Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance. */
+      /**
+       * Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
+       * Use the `coinPricing` field instead.
+       */
       coinPurchase?: boolean;
+      /**
+       * Formula that converts the paid fiat amount into coins credited to the coin balance.
+       * A `null` value means deposits created from this strategy credit the cash balance.
+       * If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
+       * Setting a `coinPricing` object requires the Replay add-on.
+       * For `volume`, every configured deposit amount must match a bracket,
+       * and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
+       * For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
+       */
+      coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
       createdTime?: coreComponents["schemas"]["CreatedTime"];
       updatedTime?: coreComponents["schemas"]["UpdatedTime"];
       _links?: coreComponents["schemas"]["SelfLink"];
@@ -25545,8 +25612,14 @@ export interface coreComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing: coreComponents["schemas"]["CoinPricing"] | null;
       /** ID of the last deposit request that is made for this cashier. */
       lastDepositRequestId?: string;
       createdTime?: coreComponents["schemas"]["CreatedTime"];
@@ -28372,6 +28445,12 @@ export interface coreComponents {
      * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
      */
     organizationId: string;
+    /**
+     * Limit the number of invoices to return.
+     * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
+     * Cap values greater than `100` at `100`.
+     */
+    invoiceCollectionLimit: number;
     /** Type of response media. */
     mediaTypeJsonPdf: "application/json" | "application/pdf";
     /**
@@ -33053,10 +33132,11 @@ export interface operations {
          */
         sort?: coreComponents["parameters"]["collectionSort"];
         /**
-         * Limit the number of collection items to be returned.
+         * Limit the number of invoices to return.
          * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
+         * Cap values greater than `100` at `100`.
          */
-        limit?: coreComponents["parameters"]["collectionLimit"];
+        limit?: coreComponents["parameters"]["invoiceCollectionLimit"];
         /** Specifies the starting point within the collection of items to be returned. */
         offset?: coreComponents["parameters"]["collectionOffset"];
         /** Use this field to perform a partial search of text fields. */
@@ -55969,6 +56049,54 @@ export interface storefrontComponents {
        */
       status?: "draft" | "archived";
     };
+    /**
+     * Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
+     * For example, if `coinsPerFiatMinor` is `10`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
+     */
+    CoinPricingFlatRate: {
+      /** Flat-rate formula for converting the paid fiat amount into coins. */
+      formula: "flat-rate";
+      /**
+       * Number of coins credited for each minor unit of the paid currency.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+    };
+    /** Amount range and coin rate for volume pricing. */
+    CoinPricingVolumeBracket: {
+      /**
+       * Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+      /**
+       * Highest paid amount in this range, in major units of the currency for the deposit request.
+       * This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
+       * A `null` value means this range has no upper limit.
+       */
+      maxAmount?: number | null;
+    };
+    /**
+     * Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
+     * For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
+     */
+    CoinPricingVolume: {
+      /** Volume-based formula for converting the paid fiat amount into coins. */
+      formula: "volume";
+      /**
+       * Amount ranges that define the coin rate for a paid amount.
+       * The first range matches amounts less than or equal to `maxAmount`.
+       * Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
+       * A final range with a `null` `maxAmount` has no upper limit.
+       */
+      brackets: storefrontComponents["schemas"]["CoinPricingVolumeBracket"][];
+    };
+    /** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
+    CoinPricing:
+      | storefrontComponents["schemas"]["CoinPricingFlatRate"]
+      | storefrontComponents["schemas"]["CoinPricingVolume"];
     DepositRequest: {
       /** ID of the deposit request. */
       id?: string;
@@ -55992,8 +56120,14 @@ export interface storefrontComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase?: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
       currency: storefrontComponents["schemas"]["CurrencyCode"];
       /**
        * List of available deposit amounts.
@@ -56364,8 +56498,21 @@ export interface storefrontComponents {
       priority?: number;
       /** Specifies if the deposit amount strategy is active. */
       isActive?: boolean;
-      /** Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance. */
+      /**
+       * Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
+       * Use the `coinPricing` field instead.
+       */
       coinPurchase?: boolean;
+      /**
+       * Formula that converts the paid fiat amount into coins credited to the coin balance.
+       * A `null` value means deposits created from this strategy credit the cash balance.
+       * If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
+       * Setting a `coinPricing` object requires the Replay add-on.
+       * For `volume`, every configured deposit amount must match a bracket,
+       * and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
+       * For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
+       */
+      coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
       createdTime?: storefrontComponents["schemas"]["CreatedTime"];
       updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
       _links?: storefrontComponents["schemas"]["SelfLink"];
@@ -65144,8 +65291,14 @@ export interface storefrontComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing: storefrontComponents["schemas"]["CoinPricing"] | null;
       /** ID of the last deposit request that is made for this cashier. */
       lastDepositRequestId?: string;
       createdTime?: storefrontComponents["schemas"]["CreatedTime"];
@@ -67971,6 +68124,12 @@ export interface storefrontComponents {
      * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
      */
     organizationId: string;
+    /**
+     * Limit the number of invoices to return.
+     * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
+     * Cap values greater than `100` at `100`.
+     */
+    invoiceCollectionLimit: number;
     /** Type of response media. */
     mediaTypeJsonPdf: "application/json" | "application/pdf";
     /**
@@ -82599,6 +82758,54 @@ export interface reportsComponents {
        */
       status?: "draft" | "archived";
     };
+    /**
+     * Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
+     * For example, if `coinsPerFiatMinor` is `10`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
+     */
+    CoinPricingFlatRate: {
+      /** Flat-rate formula for converting the paid fiat amount into coins. */
+      formula: "flat-rate";
+      /**
+       * Number of coins credited for each minor unit of the paid currency.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+    };
+    /** Amount range and coin rate for volume pricing. */
+    CoinPricingVolumeBracket: {
+      /**
+       * Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
+       * For example, a value of `10` means 10 coins for each US cent.
+       */
+      coinsPerFiatMinor: number;
+      /**
+       * Highest paid amount in this range, in major units of the currency for the deposit request.
+       * This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
+       * A `null` value means this range has no upper limit.
+       */
+      maxAmount?: number | null;
+    };
+    /**
+     * Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
+     * For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
+     * a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
+     */
+    CoinPricingVolume: {
+      /** Volume-based formula for converting the paid fiat amount into coins. */
+      formula: "volume";
+      /**
+       * Amount ranges that define the coin rate for a paid amount.
+       * The first range matches amounts less than or equal to `maxAmount`.
+       * Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
+       * A final range with a `null` `maxAmount` has no upper limit.
+       */
+      brackets: reportsComponents["schemas"]["CoinPricingVolumeBracket"][];
+    };
+    /** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
+    CoinPricing:
+      | reportsComponents["schemas"]["CoinPricingFlatRate"]
+      | reportsComponents["schemas"]["CoinPricingVolume"];
     DepositRequest: {
       /** ID of the deposit request. */
       id?: string;
@@ -82622,8 +82829,14 @@ export interface reportsComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase?: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
       currency: reportsComponents["schemas"]["CurrencyCode"];
       /**
        * List of available deposit amounts.
@@ -82994,8 +83207,21 @@ export interface reportsComponents {
       priority?: number;
       /** Specifies if the deposit amount strategy is active. */
       isActive?: boolean;
-      /** Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance. */
+      /**
+       * Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
+       * Use the `coinPricing` field instead.
+       */
       coinPurchase?: boolean;
+      /**
+       * Formula that converts the paid fiat amount into coins credited to the coin balance.
+       * A `null` value means deposits created from this strategy credit the cash balance.
+       * If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
+       * Setting a `coinPricing` object requires the Replay add-on.
+       * For `volume`, every configured deposit amount must match a bracket,
+       * and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
+       * For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
+       */
+      coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
       createdTime?: reportsComponents["schemas"]["CreatedTime"];
       updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
       _links?: reportsComponents["schemas"]["SelfLink"];
@@ -91774,8 +92000,14 @@ export interface reportsComponents {
       /**
        * Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
        * Determined by the deposit amount strategy that is applied to the deposit request.
+       * Use the `coinPricing` field instead.
        */
       coinPurchase: boolean;
+      /**
+       * Formula copied from the deposit amount strategy when the deposit request is created.
+       * A `null` value means the deposit credits the cash balance instead of the coin balance.
+       */
+      coinPricing: reportsComponents["schemas"]["CoinPricing"] | null;
       /** ID of the last deposit request that is made for this cashier. */
       lastDepositRequestId?: string;
       createdTime?: reportsComponents["schemas"]["CreatedTime"];
@@ -94601,6 +94833,12 @@ export interface reportsComponents {
      * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
      */
     organizationId: string;
+    /**
+     * Limit the number of invoices to return.
+     * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
+     * Cap values greater than `100` at `100`.
+     */
+    invoiceCollectionLimit: number;
     /** Type of response media. */
     mediaTypeJsonPdf: "application/json" | "application/pdf";
     /**