rebilly-js-sdk 62.163.0 → 62.164.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/dist/rebilly-js-sdk.d.cts +222 -3
- package/dist/rebilly-js-sdk.d.mts +222 -3
- package/dist/rebilly-js-sdk.d.ts +222 -3
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
## [62.
|
|
1
|
+
## [62.164.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.163.0...rebilly-js-sdk-v62.164.0) (2026-09-10)
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
### Features
|
|
5
5
|
|
|
6
|
-
* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#
|
|
6
|
+
* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#25794](https://github.com/Rebilly/rebilly/issues/25794)) ([9acfa6a](https://github.com/Rebilly/rebilly/commit/9acfa6ad417ba70d76f7e33b0b9fa4ebb0457b39))
|
|
@@ -16370,6 +16370,54 @@ export interface coreComponents {
|
|
|
16370
16370
|
*/
|
|
16371
16371
|
status?: "draft" | "archived";
|
|
16372
16372
|
};
|
|
16373
|
+
/**
|
|
16374
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
16375
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
16376
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
16377
|
+
*/
|
|
16378
|
+
CoinPricingFlatRate: {
|
|
16379
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
16380
|
+
formula: "flat-rate";
|
|
16381
|
+
/**
|
|
16382
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
16383
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
16384
|
+
*/
|
|
16385
|
+
coinsPerFiatMinor: number;
|
|
16386
|
+
};
|
|
16387
|
+
/** Amount range and coin rate for volume pricing. */
|
|
16388
|
+
CoinPricingVolumeBracket: {
|
|
16389
|
+
/**
|
|
16390
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
16391
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
16392
|
+
*/
|
|
16393
|
+
coinsPerFiatMinor: number;
|
|
16394
|
+
/**
|
|
16395
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
16396
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
16397
|
+
* A `null` value means this range has no upper limit.
|
|
16398
|
+
*/
|
|
16399
|
+
maxAmount?: number | null;
|
|
16400
|
+
};
|
|
16401
|
+
/**
|
|
16402
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
16403
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
16404
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
16405
|
+
*/
|
|
16406
|
+
CoinPricingVolume: {
|
|
16407
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
16408
|
+
formula: "volume";
|
|
16409
|
+
/**
|
|
16410
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
16411
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
16412
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
16413
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
16414
|
+
*/
|
|
16415
|
+
brackets: coreComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
16416
|
+
};
|
|
16417
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
16418
|
+
CoinPricing:
|
|
16419
|
+
| coreComponents["schemas"]["CoinPricingFlatRate"]
|
|
16420
|
+
| coreComponents["schemas"]["CoinPricingVolume"];
|
|
16373
16421
|
DepositRequest: {
|
|
16374
16422
|
/** ID of the deposit request. */
|
|
16375
16423
|
id?: string;
|
|
@@ -16393,8 +16441,14 @@ export interface coreComponents {
|
|
|
16393
16441
|
/**
|
|
16394
16442
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
16395
16443
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
16444
|
+
* Use the `coinPricing` field instead.
|
|
16396
16445
|
*/
|
|
16397
16446
|
coinPurchase?: boolean;
|
|
16447
|
+
/**
|
|
16448
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
16449
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
16450
|
+
*/
|
|
16451
|
+
coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
|
|
16398
16452
|
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
16399
16453
|
/**
|
|
16400
16454
|
* List of available deposit amounts.
|
|
@@ -16765,8 +16819,21 @@ export interface coreComponents {
|
|
|
16765
16819
|
priority?: number;
|
|
16766
16820
|
/** Specifies if the deposit amount strategy is active. */
|
|
16767
16821
|
isActive?: boolean;
|
|
16768
|
-
/**
|
|
16822
|
+
/**
|
|
16823
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
16824
|
+
* Use the `coinPricing` field instead.
|
|
16825
|
+
*/
|
|
16769
16826
|
coinPurchase?: boolean;
|
|
16827
|
+
/**
|
|
16828
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
16829
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
16830
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
16831
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
16832
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
16833
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
16834
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
16835
|
+
*/
|
|
16836
|
+
coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
|
|
16770
16837
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
16771
16838
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16772
16839
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
@@ -25545,8 +25612,14 @@ export interface coreComponents {
|
|
|
25545
25612
|
/**
|
|
25546
25613
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
25547
25614
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
25615
|
+
* Use the `coinPricing` field instead.
|
|
25548
25616
|
*/
|
|
25549
25617
|
coinPurchase: boolean;
|
|
25618
|
+
/**
|
|
25619
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
25620
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
25621
|
+
*/
|
|
25622
|
+
coinPricing: coreComponents["schemas"]["CoinPricing"] | null;
|
|
25550
25623
|
/** ID of the last deposit request that is made for this cashier. */
|
|
25551
25624
|
lastDepositRequestId?: string;
|
|
25552
25625
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -55969,6 +56042,54 @@ export interface storefrontComponents {
|
|
|
55969
56042
|
*/
|
|
55970
56043
|
status?: "draft" | "archived";
|
|
55971
56044
|
};
|
|
56045
|
+
/**
|
|
56046
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
56047
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
56048
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
56049
|
+
*/
|
|
56050
|
+
CoinPricingFlatRate: {
|
|
56051
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
56052
|
+
formula: "flat-rate";
|
|
56053
|
+
/**
|
|
56054
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
56055
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
56056
|
+
*/
|
|
56057
|
+
coinsPerFiatMinor: number;
|
|
56058
|
+
};
|
|
56059
|
+
/** Amount range and coin rate for volume pricing. */
|
|
56060
|
+
CoinPricingVolumeBracket: {
|
|
56061
|
+
/**
|
|
56062
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
56063
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
56064
|
+
*/
|
|
56065
|
+
coinsPerFiatMinor: number;
|
|
56066
|
+
/**
|
|
56067
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
56068
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
56069
|
+
* A `null` value means this range has no upper limit.
|
|
56070
|
+
*/
|
|
56071
|
+
maxAmount?: number | null;
|
|
56072
|
+
};
|
|
56073
|
+
/**
|
|
56074
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
56075
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
56076
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
56077
|
+
*/
|
|
56078
|
+
CoinPricingVolume: {
|
|
56079
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
56080
|
+
formula: "volume";
|
|
56081
|
+
/**
|
|
56082
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
56083
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
56084
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
56085
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
56086
|
+
*/
|
|
56087
|
+
brackets: storefrontComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
56088
|
+
};
|
|
56089
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
56090
|
+
CoinPricing:
|
|
56091
|
+
| storefrontComponents["schemas"]["CoinPricingFlatRate"]
|
|
56092
|
+
| storefrontComponents["schemas"]["CoinPricingVolume"];
|
|
55972
56093
|
DepositRequest: {
|
|
55973
56094
|
/** ID of the deposit request. */
|
|
55974
56095
|
id?: string;
|
|
@@ -55992,8 +56113,14 @@ export interface storefrontComponents {
|
|
|
55992
56113
|
/**
|
|
55993
56114
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
55994
56115
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
56116
|
+
* Use the `coinPricing` field instead.
|
|
55995
56117
|
*/
|
|
55996
56118
|
coinPurchase?: boolean;
|
|
56119
|
+
/**
|
|
56120
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
56121
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
56122
|
+
*/
|
|
56123
|
+
coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
55997
56124
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
55998
56125
|
/**
|
|
55999
56126
|
* List of available deposit amounts.
|
|
@@ -56364,8 +56491,21 @@ export interface storefrontComponents {
|
|
|
56364
56491
|
priority?: number;
|
|
56365
56492
|
/** Specifies if the deposit amount strategy is active. */
|
|
56366
56493
|
isActive?: boolean;
|
|
56367
|
-
/**
|
|
56494
|
+
/**
|
|
56495
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
56496
|
+
* Use the `coinPricing` field instead.
|
|
56497
|
+
*/
|
|
56368
56498
|
coinPurchase?: boolean;
|
|
56499
|
+
/**
|
|
56500
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
56501
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
56502
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
56503
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
56504
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
56505
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
56506
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
56507
|
+
*/
|
|
56508
|
+
coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
56369
56509
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
56370
56510
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
56371
56511
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
@@ -65144,8 +65284,14 @@ export interface storefrontComponents {
|
|
|
65144
65284
|
/**
|
|
65145
65285
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
65146
65286
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
65287
|
+
* Use the `coinPricing` field instead.
|
|
65147
65288
|
*/
|
|
65148
65289
|
coinPurchase: boolean;
|
|
65290
|
+
/**
|
|
65291
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
65292
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
65293
|
+
*/
|
|
65294
|
+
coinPricing: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
65149
65295
|
/** ID of the last deposit request that is made for this cashier. */
|
|
65150
65296
|
lastDepositRequestId?: string;
|
|
65151
65297
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -82599,6 +82745,54 @@ export interface reportsComponents {
|
|
|
82599
82745
|
*/
|
|
82600
82746
|
status?: "draft" | "archived";
|
|
82601
82747
|
};
|
|
82748
|
+
/**
|
|
82749
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
82750
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
82751
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
82752
|
+
*/
|
|
82753
|
+
CoinPricingFlatRate: {
|
|
82754
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
82755
|
+
formula: "flat-rate";
|
|
82756
|
+
/**
|
|
82757
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
82758
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
82759
|
+
*/
|
|
82760
|
+
coinsPerFiatMinor: number;
|
|
82761
|
+
};
|
|
82762
|
+
/** Amount range and coin rate for volume pricing. */
|
|
82763
|
+
CoinPricingVolumeBracket: {
|
|
82764
|
+
/**
|
|
82765
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
82766
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
82767
|
+
*/
|
|
82768
|
+
coinsPerFiatMinor: number;
|
|
82769
|
+
/**
|
|
82770
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
82771
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
82772
|
+
* A `null` value means this range has no upper limit.
|
|
82773
|
+
*/
|
|
82774
|
+
maxAmount?: number | null;
|
|
82775
|
+
};
|
|
82776
|
+
/**
|
|
82777
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
82778
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
82779
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
82780
|
+
*/
|
|
82781
|
+
CoinPricingVolume: {
|
|
82782
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
82783
|
+
formula: "volume";
|
|
82784
|
+
/**
|
|
82785
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
82786
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
82787
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
82788
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
82789
|
+
*/
|
|
82790
|
+
brackets: reportsComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
82791
|
+
};
|
|
82792
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
82793
|
+
CoinPricing:
|
|
82794
|
+
| reportsComponents["schemas"]["CoinPricingFlatRate"]
|
|
82795
|
+
| reportsComponents["schemas"]["CoinPricingVolume"];
|
|
82602
82796
|
DepositRequest: {
|
|
82603
82797
|
/** ID of the deposit request. */
|
|
82604
82798
|
id?: string;
|
|
@@ -82622,8 +82816,14 @@ export interface reportsComponents {
|
|
|
82622
82816
|
/**
|
|
82623
82817
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
82624
82818
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
82819
|
+
* Use the `coinPricing` field instead.
|
|
82625
82820
|
*/
|
|
82626
82821
|
coinPurchase?: boolean;
|
|
82822
|
+
/**
|
|
82823
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
82824
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
82825
|
+
*/
|
|
82826
|
+
coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
82627
82827
|
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
82628
82828
|
/**
|
|
82629
82829
|
* List of available deposit amounts.
|
|
@@ -82994,8 +83194,21 @@ export interface reportsComponents {
|
|
|
82994
83194
|
priority?: number;
|
|
82995
83195
|
/** Specifies if the deposit amount strategy is active. */
|
|
82996
83196
|
isActive?: boolean;
|
|
82997
|
-
/**
|
|
83197
|
+
/**
|
|
83198
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
83199
|
+
* Use the `coinPricing` field instead.
|
|
83200
|
+
*/
|
|
82998
83201
|
coinPurchase?: boolean;
|
|
83202
|
+
/**
|
|
83203
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
83204
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
83205
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
83206
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
83207
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
83208
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
83209
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
83210
|
+
*/
|
|
83211
|
+
coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
82999
83212
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
83000
83213
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
83001
83214
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
@@ -91774,8 +91987,14 @@ export interface reportsComponents {
|
|
|
91774
91987
|
/**
|
|
91775
91988
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
91776
91989
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
91990
|
+
* Use the `coinPricing` field instead.
|
|
91777
91991
|
*/
|
|
91778
91992
|
coinPurchase: boolean;
|
|
91993
|
+
/**
|
|
91994
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
91995
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
91996
|
+
*/
|
|
91997
|
+
coinPricing: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
91779
91998
|
/** ID of the last deposit request that is made for this cashier. */
|
|
91780
91999
|
lastDepositRequestId?: string;
|
|
91781
92000
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
@@ -16370,6 +16370,54 @@ export interface coreComponents {
|
|
|
16370
16370
|
*/
|
|
16371
16371
|
status?: "draft" | "archived";
|
|
16372
16372
|
};
|
|
16373
|
+
/**
|
|
16374
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
16375
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
16376
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
16377
|
+
*/
|
|
16378
|
+
CoinPricingFlatRate: {
|
|
16379
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
16380
|
+
formula: "flat-rate";
|
|
16381
|
+
/**
|
|
16382
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
16383
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
16384
|
+
*/
|
|
16385
|
+
coinsPerFiatMinor: number;
|
|
16386
|
+
};
|
|
16387
|
+
/** Amount range and coin rate for volume pricing. */
|
|
16388
|
+
CoinPricingVolumeBracket: {
|
|
16389
|
+
/**
|
|
16390
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
16391
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
16392
|
+
*/
|
|
16393
|
+
coinsPerFiatMinor: number;
|
|
16394
|
+
/**
|
|
16395
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
16396
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
16397
|
+
* A `null` value means this range has no upper limit.
|
|
16398
|
+
*/
|
|
16399
|
+
maxAmount?: number | null;
|
|
16400
|
+
};
|
|
16401
|
+
/**
|
|
16402
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
16403
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
16404
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
16405
|
+
*/
|
|
16406
|
+
CoinPricingVolume: {
|
|
16407
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
16408
|
+
formula: "volume";
|
|
16409
|
+
/**
|
|
16410
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
16411
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
16412
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
16413
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
16414
|
+
*/
|
|
16415
|
+
brackets: coreComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
16416
|
+
};
|
|
16417
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
16418
|
+
CoinPricing:
|
|
16419
|
+
| coreComponents["schemas"]["CoinPricingFlatRate"]
|
|
16420
|
+
| coreComponents["schemas"]["CoinPricingVolume"];
|
|
16373
16421
|
DepositRequest: {
|
|
16374
16422
|
/** ID of the deposit request. */
|
|
16375
16423
|
id?: string;
|
|
@@ -16393,8 +16441,14 @@ export interface coreComponents {
|
|
|
16393
16441
|
/**
|
|
16394
16442
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
16395
16443
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
16444
|
+
* Use the `coinPricing` field instead.
|
|
16396
16445
|
*/
|
|
16397
16446
|
coinPurchase?: boolean;
|
|
16447
|
+
/**
|
|
16448
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
16449
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
16450
|
+
*/
|
|
16451
|
+
coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
|
|
16398
16452
|
currency: coreComponents["schemas"]["CurrencyCode"];
|
|
16399
16453
|
/**
|
|
16400
16454
|
* List of available deposit amounts.
|
|
@@ -16765,8 +16819,21 @@ export interface coreComponents {
|
|
|
16765
16819
|
priority?: number;
|
|
16766
16820
|
/** Specifies if the deposit amount strategy is active. */
|
|
16767
16821
|
isActive?: boolean;
|
|
16768
|
-
/**
|
|
16822
|
+
/**
|
|
16823
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
16824
|
+
* Use the `coinPricing` field instead.
|
|
16825
|
+
*/
|
|
16769
16826
|
coinPurchase?: boolean;
|
|
16827
|
+
/**
|
|
16828
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
16829
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
16830
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
16831
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
16832
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
16833
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
16834
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
16835
|
+
*/
|
|
16836
|
+
coinPricing?: coreComponents["schemas"]["CoinPricing"] | null;
|
|
16770
16837
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
16771
16838
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16772
16839
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
@@ -25545,8 +25612,14 @@ export interface coreComponents {
|
|
|
25545
25612
|
/**
|
|
25546
25613
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
25547
25614
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
25615
|
+
* Use the `coinPricing` field instead.
|
|
25548
25616
|
*/
|
|
25549
25617
|
coinPurchase: boolean;
|
|
25618
|
+
/**
|
|
25619
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
25620
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
25621
|
+
*/
|
|
25622
|
+
coinPricing: coreComponents["schemas"]["CoinPricing"] | null;
|
|
25550
25623
|
/** ID of the last deposit request that is made for this cashier. */
|
|
25551
25624
|
lastDepositRequestId?: string;
|
|
25552
25625
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
@@ -55969,6 +56042,54 @@ export interface storefrontComponents {
|
|
|
55969
56042
|
*/
|
|
55970
56043
|
status?: "draft" | "archived";
|
|
55971
56044
|
};
|
|
56045
|
+
/**
|
|
56046
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
56047
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
56048
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
56049
|
+
*/
|
|
56050
|
+
CoinPricingFlatRate: {
|
|
56051
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
56052
|
+
formula: "flat-rate";
|
|
56053
|
+
/**
|
|
56054
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
56055
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
56056
|
+
*/
|
|
56057
|
+
coinsPerFiatMinor: number;
|
|
56058
|
+
};
|
|
56059
|
+
/** Amount range and coin rate for volume pricing. */
|
|
56060
|
+
CoinPricingVolumeBracket: {
|
|
56061
|
+
/**
|
|
56062
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
56063
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
56064
|
+
*/
|
|
56065
|
+
coinsPerFiatMinor: number;
|
|
56066
|
+
/**
|
|
56067
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
56068
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
56069
|
+
* A `null` value means this range has no upper limit.
|
|
56070
|
+
*/
|
|
56071
|
+
maxAmount?: number | null;
|
|
56072
|
+
};
|
|
56073
|
+
/**
|
|
56074
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
56075
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
56076
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
56077
|
+
*/
|
|
56078
|
+
CoinPricingVolume: {
|
|
56079
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
56080
|
+
formula: "volume";
|
|
56081
|
+
/**
|
|
56082
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
56083
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
56084
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
56085
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
56086
|
+
*/
|
|
56087
|
+
brackets: storefrontComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
56088
|
+
};
|
|
56089
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
56090
|
+
CoinPricing:
|
|
56091
|
+
| storefrontComponents["schemas"]["CoinPricingFlatRate"]
|
|
56092
|
+
| storefrontComponents["schemas"]["CoinPricingVolume"];
|
|
55972
56093
|
DepositRequest: {
|
|
55973
56094
|
/** ID of the deposit request. */
|
|
55974
56095
|
id?: string;
|
|
@@ -55992,8 +56113,14 @@ export interface storefrontComponents {
|
|
|
55992
56113
|
/**
|
|
55993
56114
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
55994
56115
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
56116
|
+
* Use the `coinPricing` field instead.
|
|
55995
56117
|
*/
|
|
55996
56118
|
coinPurchase?: boolean;
|
|
56119
|
+
/**
|
|
56120
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
56121
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
56122
|
+
*/
|
|
56123
|
+
coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
55997
56124
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
55998
56125
|
/**
|
|
55999
56126
|
* List of available deposit amounts.
|
|
@@ -56364,8 +56491,21 @@ export interface storefrontComponents {
|
|
|
56364
56491
|
priority?: number;
|
|
56365
56492
|
/** Specifies if the deposit amount strategy is active. */
|
|
56366
56493
|
isActive?: boolean;
|
|
56367
|
-
/**
|
|
56494
|
+
/**
|
|
56495
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
56496
|
+
* Use the `coinPricing` field instead.
|
|
56497
|
+
*/
|
|
56368
56498
|
coinPurchase?: boolean;
|
|
56499
|
+
/**
|
|
56500
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
56501
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
56502
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
56503
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
56504
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
56505
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
56506
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
56507
|
+
*/
|
|
56508
|
+
coinPricing?: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
56369
56509
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
56370
56510
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
56371
56511
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
@@ -65144,8 +65284,14 @@ export interface storefrontComponents {
|
|
|
65144
65284
|
/**
|
|
65145
65285
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
65146
65286
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
65287
|
+
* Use the `coinPricing` field instead.
|
|
65147
65288
|
*/
|
|
65148
65289
|
coinPurchase: boolean;
|
|
65290
|
+
/**
|
|
65291
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
65292
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
65293
|
+
*/
|
|
65294
|
+
coinPricing: storefrontComponents["schemas"]["CoinPricing"] | null;
|
|
65149
65295
|
/** ID of the last deposit request that is made for this cashier. */
|
|
65150
65296
|
lastDepositRequestId?: string;
|
|
65151
65297
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
@@ -82599,6 +82745,54 @@ export interface reportsComponents {
|
|
|
82599
82745
|
*/
|
|
82600
82746
|
status?: "draft" | "archived";
|
|
82601
82747
|
};
|
|
82748
|
+
/**
|
|
82749
|
+
* Flat-rate coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor`.
|
|
82750
|
+
* For example, if `coinsPerFiatMinor` is `10`,
|
|
82751
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `10,010` coins.
|
|
82752
|
+
*/
|
|
82753
|
+
CoinPricingFlatRate: {
|
|
82754
|
+
/** Flat-rate formula for converting the paid fiat amount into coins. */
|
|
82755
|
+
formula: "flat-rate";
|
|
82756
|
+
/**
|
|
82757
|
+
* Number of coins credited for each minor unit of the paid currency.
|
|
82758
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
82759
|
+
*/
|
|
82760
|
+
coinsPerFiatMinor: number;
|
|
82761
|
+
};
|
|
82762
|
+
/** Amount range and coin rate for volume pricing. */
|
|
82763
|
+
CoinPricingVolumeBracket: {
|
|
82764
|
+
/**
|
|
82765
|
+
* Number of coins credited for each minor unit of the paid currency when the paid amount falls in this range.
|
|
82766
|
+
* For example, a value of `10` means 10 coins for each US cent.
|
|
82767
|
+
*/
|
|
82768
|
+
coinsPerFiatMinor: number;
|
|
82769
|
+
/**
|
|
82770
|
+
* Highest paid amount in this range, in major units of the currency for the deposit request.
|
|
82771
|
+
* This value is inclusive and must be exact at that currency scale for the deposit amount strategy.
|
|
82772
|
+
* A `null` value means this range has no upper limit.
|
|
82773
|
+
*/
|
|
82774
|
+
maxAmount?: number | null;
|
|
82775
|
+
};
|
|
82776
|
+
/**
|
|
82777
|
+
* Volume-based coin pricing that multiplies the full paid amount in minor units by `coinsPerFiatMinor` from the matching bracket.
|
|
82778
|
+
* For example, if `coinsPerFiatMinor` is `10` for amounts up to `$10.00` and `12` for amounts from `$10.01` through `$50.00`,
|
|
82779
|
+
* a `$10.00` deposit credits `10,000` coins and a `$10.01` deposit credits `12,012` coins.
|
|
82780
|
+
*/
|
|
82781
|
+
CoinPricingVolume: {
|
|
82782
|
+
/** Volume-based formula for converting the paid fiat amount into coins. */
|
|
82783
|
+
formula: "volume";
|
|
82784
|
+
/**
|
|
82785
|
+
* Amount ranges that define the coin rate for a paid amount.
|
|
82786
|
+
* The first range matches amounts less than or equal to `maxAmount`.
|
|
82787
|
+
* Each subsequent range matches amounts greater than the previous `maxAmount` and less than or equal to the current `maxAmount`.
|
|
82788
|
+
* A final range with a `null` `maxAmount` has no upper limit.
|
|
82789
|
+
*/
|
|
82790
|
+
brackets: reportsComponents["schemas"]["CoinPricingVolumeBracket"][];
|
|
82791
|
+
};
|
|
82792
|
+
/** Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency. */
|
|
82793
|
+
CoinPricing:
|
|
82794
|
+
| reportsComponents["schemas"]["CoinPricingFlatRate"]
|
|
82795
|
+
| reportsComponents["schemas"]["CoinPricingVolume"];
|
|
82602
82796
|
DepositRequest: {
|
|
82603
82797
|
/** ID of the deposit request. */
|
|
82604
82798
|
id?: string;
|
|
@@ -82622,8 +82816,14 @@ export interface reportsComponents {
|
|
|
82622
82816
|
/**
|
|
82623
82817
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
82624
82818
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
82819
|
+
* Use the `coinPricing` field instead.
|
|
82625
82820
|
*/
|
|
82626
82821
|
coinPurchase?: boolean;
|
|
82822
|
+
/**
|
|
82823
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
82824
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
82825
|
+
*/
|
|
82826
|
+
coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
82627
82827
|
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
82628
82828
|
/**
|
|
82629
82829
|
* List of available deposit amounts.
|
|
@@ -82994,8 +83194,21 @@ export interface reportsComponents {
|
|
|
82994
83194
|
priority?: number;
|
|
82995
83195
|
/** Specifies if the deposit amount strategy is active. */
|
|
82996
83196
|
isActive?: boolean;
|
|
82997
|
-
/**
|
|
83197
|
+
/**
|
|
83198
|
+
* Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance.
|
|
83199
|
+
* Use the `coinPricing` field instead.
|
|
83200
|
+
*/
|
|
82998
83201
|
coinPurchase?: boolean;
|
|
83202
|
+
/**
|
|
83203
|
+
* Formula that converts the paid fiat amount into coins credited to the coin balance.
|
|
83204
|
+
* A `null` value means deposits created from this strategy credit the cash balance.
|
|
83205
|
+
* If both `coinPricing` and `coinPurchase` are provided, `coinPricing` takes precedence.
|
|
83206
|
+
* Setting a `coinPricing` object requires the Replay add-on.
|
|
83207
|
+
* For `volume`, every configured deposit amount must match a bracket,
|
|
83208
|
+
* and the last bracket has a `null` `maxAmount` when `customAmount` has a value or `adjustBaseToLastDeposit` is `true`.
|
|
83209
|
+
* For deposit amount strategies with `coinPurchase: true` and no `coinPricing`, responses include default flat-rate pricing with `coinsPerFiatMinor: 10`.
|
|
83210
|
+
*/
|
|
83211
|
+
coinPricing?: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
82999
83212
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
83000
83213
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
83001
83214
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
@@ -91774,8 +91987,14 @@ export interface reportsComponents {
|
|
|
91774
91987
|
/**
|
|
91775
91988
|
* Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance.
|
|
91776
91989
|
* Determined by the deposit amount strategy that is applied to the deposit request.
|
|
91990
|
+
* Use the `coinPricing` field instead.
|
|
91777
91991
|
*/
|
|
91778
91992
|
coinPurchase: boolean;
|
|
91993
|
+
/**
|
|
91994
|
+
* Formula copied from the deposit amount strategy when the deposit request is created.
|
|
91995
|
+
* A `null` value means the deposit credits the cash balance instead of the coin balance.
|
|
91996
|
+
*/
|
|
91997
|
+
coinPricing: reportsComponents["schemas"]["CoinPricing"] | null;
|
|
91779
91998
|
/** ID of the last deposit request that is made for this cashier. */
|
|
91780
91999
|
lastDepositRequestId?: string;
|
|
91781
92000
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|