rebilly-js-sdk 62.246.2 → 62.247.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 +1 -1
- package/dist/rebilly-js-sdk.d.cts +102 -2
- package/dist/rebilly-js-sdk.d.mts +102 -2
- package/dist/rebilly-js-sdk.d.ts +102 -2
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
|
@@ -4647,7 +4647,13 @@ export interface corePaths {
|
|
|
4647
4647
|
};
|
|
4648
4648
|
};
|
|
4649
4649
|
"/api-keys": {
|
|
4650
|
-
/**
|
|
4650
|
+
/**
|
|
4651
|
+
* Retrieves a list of API keys.
|
|
4652
|
+
*
|
|
4653
|
+
* To retrieve secret API keys that are not expired and have no `allowedIps` restrictions,
|
|
4654
|
+
* so they can be used from any IP address, use `filter=usableFromAnyIp:true`.
|
|
4655
|
+
* To retrieve all other API keys, use `filter=usableFromAnyIp:false`.
|
|
4656
|
+
*/
|
|
4651
4657
|
get: operations["GetApiKeyCollection"];
|
|
4652
4658
|
/**
|
|
4653
4659
|
* Creates an API key for the authenticated user.
|
|
@@ -5639,13 +5645,16 @@ export interface corePaths {
|
|
|
5639
5645
|
* For `add`, `remove`, and `move`, the operation is atomic.
|
|
5640
5646
|
* If the operation cannot add, remove, or move a specified payout request,
|
|
5641
5647
|
* the operation returns a `409` response and changes no batch membership.
|
|
5648
|
+
*
|
|
5642
5649
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
5643
5650
|
* and a specified payout request is not associated with this batch,
|
|
5644
5651
|
* the operation returns a `409` response and changes no payout request.
|
|
5645
5652
|
* For the other types, each payout request is checked independently.
|
|
5646
5653
|
* Payout requests that do not qualify for the action are skipped.
|
|
5654
|
+
*
|
|
5647
5655
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
5648
5656
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
5657
|
+
*
|
|
5649
5658
|
* The operation completes before the response returns.
|
|
5650
5659
|
* If the batch does not exist, the operation returns a `422` response.
|
|
5651
5660
|
*/
|
|
@@ -5775,12 +5784,15 @@ export interface corePaths {
|
|
|
5775
5784
|
* If the session of a user has not passed MFA, other operations respond with `403` and `error` is `mfa_required`.
|
|
5776
5785
|
* Only owners and administrators who are signed in to the Rebilly UI can change this setting.
|
|
5777
5786
|
* This setting does not apply to API keys, and a request that uses an API key cannot change this setting.
|
|
5787
|
+
*
|
|
5778
5788
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
5779
5789
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
5780
5790
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
5791
|
+
*
|
|
5781
5792
|
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
5782
5793
|
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
5783
5794
|
* If the list does not include the IP address of the caller, the response is `422`.
|
|
5795
|
+
*
|
|
5784
5796
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
5785
5797
|
*/
|
|
5786
5798
|
put: operations["PutSecuritySettings"];
|
|
@@ -5874,6 +5886,12 @@ export interface corePaths {
|
|
|
5874
5886
|
* User objects of Rebilly staff do not include `mfaEnabled`.
|
|
5875
5887
|
* The totals are the same as those returned by the [Retrieve security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings) operation.
|
|
5876
5888
|
* If the MFA status is temporarily unavailable, the response is `503` and `error` is `mfa_status_unavailable`.
|
|
5889
|
+
*
|
|
5890
|
+
* To retrieve users of the organization who can sign in only from allowed IP addresses, with `allowedIps` configured for the user or one of their roles, use `filter=hasAllowedIps:true`.
|
|
5891
|
+
* To retrieve users who have no `allowedIps` configured for the user or any of their roles, use `filter=hasAllowedIps:false`.
|
|
5892
|
+
* The `hasAllowedIps` filter applies only when listing users of an organization.
|
|
5893
|
+
* It does not include allowed IP addresses configured in the [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings).
|
|
5894
|
+
* Inactive users and Rebilly staff are excluded from the `hasAllowedIps` filter.
|
|
5877
5895
|
*/
|
|
5878
5896
|
get: operations["GetUserCollection"];
|
|
5879
5897
|
/** Creates a user. */
|
|
@@ -12777,10 +12795,12 @@ export interface coreComponents {
|
|
|
12777
12795
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
12778
12796
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
12779
12797
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
12798
|
+
*
|
|
12780
12799
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
12781
12800
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
12782
12801
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
12783
12802
|
* The amount limit applies to the billed amount.
|
|
12803
|
+
*
|
|
12784
12804
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
12785
12805
|
* This field is useful for accounting and customer success purposes.
|
|
12786
12806
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -12797,6 +12817,7 @@ export interface coreComponents {
|
|
|
12797
12817
|
* When a soft limit is reached,
|
|
12798
12818
|
* a customer may receive a notification
|
|
12799
12819
|
* but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
|
|
12820
|
+
*
|
|
12800
12821
|
* When the reported usage reaches the configured limit,
|
|
12801
12822
|
* a specific event is triggered.
|
|
12802
12823
|
* To notify the customer in the merchant system,
|
|
@@ -12805,6 +12826,7 @@ export interface coreComponents {
|
|
|
12805
12826
|
* When the total usage reaches the hard limit quantity,
|
|
12806
12827
|
* or amount values,
|
|
12807
12828
|
* metered billing plan usages can no longer be reported.
|
|
12829
|
+
*
|
|
12808
12830
|
* Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
|
|
12809
12831
|
* A `quantity` value below the minimum billable quantity is invalid.
|
|
12810
12832
|
* An `amount` value below the minimum billable amount is invalid.
|
|
@@ -24172,6 +24194,11 @@ export interface coreComponents {
|
|
|
24172
24194
|
description?: string | null;
|
|
24173
24195
|
acl: coreComponents["schemas"]["Acl"];
|
|
24174
24196
|
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
24197
|
+
/**
|
|
24198
|
+
* IP addresses specified in `allowedIps` for this role and any roles included in it.
|
|
24199
|
+
* This value is `null` if no allowed IP addresses are configured for any of these roles.
|
|
24200
|
+
*/
|
|
24201
|
+
computedAllowedIps?: string[] | null;
|
|
24175
24202
|
/**
|
|
24176
24203
|
* List of role IDs where this role is used.
|
|
24177
24204
|
* For example, a role called `user` may be used in the `admin` and `manager` roles.
|
|
@@ -24466,6 +24493,14 @@ export interface coreComponents {
|
|
|
24466
24493
|
*/
|
|
24467
24494
|
roleIds?: string[];
|
|
24468
24495
|
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
24496
|
+
/**
|
|
24497
|
+
* IP addresses specified in `allowedIps` for the user,
|
|
24498
|
+
* the roles assigned to the user,
|
|
24499
|
+
* and any roles included in those roles.
|
|
24500
|
+
* This value is `null` if no allowed IP addresses are configured for any of them.
|
|
24501
|
+
* This value is also `null` when a Rebilly admin retrieves their own user.
|
|
24502
|
+
*/
|
|
24503
|
+
computedAllowedIps?: string[] | null;
|
|
24469
24504
|
/**
|
|
24470
24505
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
24471
24506
|
* This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
|
|
@@ -28820,10 +28855,12 @@ export interface coreComponents {
|
|
|
28820
28855
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
28821
28856
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
28822
28857
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
28858
|
+
*
|
|
28823
28859
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
28824
28860
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
28825
28861
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
28826
28862
|
* The amount limit applies to the billed amount.
|
|
28863
|
+
*
|
|
28827
28864
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
28828
28865
|
* This field is useful for accounting and customer success purposes.
|
|
28829
28866
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -30329,10 +30366,12 @@ export interface coreComponents {
|
|
|
30329
30366
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
30330
30367
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
30331
30368
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
30369
|
+
*
|
|
30332
30370
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
30333
30371
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
30334
30372
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
30335
30373
|
* The amount limit applies to the billed amount.
|
|
30374
|
+
*
|
|
30336
30375
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
30337
30376
|
* This field is useful for accounting and customer success purposes.
|
|
30338
30377
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -40344,7 +40383,13 @@ export interface operations {
|
|
|
40344
40383
|
};
|
|
40345
40384
|
};
|
|
40346
40385
|
};
|
|
40347
|
-
/**
|
|
40386
|
+
/**
|
|
40387
|
+
* Retrieves a list of API keys.
|
|
40388
|
+
*
|
|
40389
|
+
* To retrieve secret API keys that are not expired and have no `allowedIps` restrictions,
|
|
40390
|
+
* so they can be used from any IP address, use `filter=usableFromAnyIp:true`.
|
|
40391
|
+
* To retrieve all other API keys, use `filter=usableFromAnyIp:false`.
|
|
40392
|
+
*/
|
|
40348
40393
|
GetApiKeyCollection: {
|
|
40349
40394
|
parameters: {
|
|
40350
40395
|
query: {
|
|
@@ -44309,13 +44354,16 @@ export interface operations {
|
|
|
44309
44354
|
* For `add`, `remove`, and `move`, the operation is atomic.
|
|
44310
44355
|
* If the operation cannot add, remove, or move a specified payout request,
|
|
44311
44356
|
* the operation returns a `409` response and changes no batch membership.
|
|
44357
|
+
*
|
|
44312
44358
|
* For `block` and `unblock`, if the request includes `payoutRequestIds`
|
|
44313
44359
|
* and a specified payout request is not associated with this batch,
|
|
44314
44360
|
* the operation returns a `409` response and changes no payout request.
|
|
44315
44361
|
* For the other types, each payout request is checked independently.
|
|
44316
44362
|
* Payout requests that do not qualify for the action are skipped.
|
|
44363
|
+
*
|
|
44317
44364
|
* For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
|
|
44318
44365
|
* If queueing fails, no allocation is queued and the operation returns an error.
|
|
44366
|
+
*
|
|
44319
44367
|
* The operation completes before the response returns.
|
|
44320
44368
|
* If the batch does not exist, the operation returns a `422` response.
|
|
44321
44369
|
*/
|
|
@@ -44929,12 +44977,15 @@ export interface operations {
|
|
|
44929
44977
|
* If the session of a user has not passed MFA, other operations respond with `403` and `error` is `mfa_required`.
|
|
44930
44978
|
* Only owners and administrators who are signed in to the Rebilly UI can change this setting.
|
|
44931
44979
|
* This setting does not apply to API keys, and a request that uses an API key cannot change this setting.
|
|
44980
|
+
*
|
|
44932
44981
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
44933
44982
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
44934
44983
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
44984
|
+
*
|
|
44935
44985
|
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
44936
44986
|
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
44937
44987
|
* If the list does not include the IP address of the caller, the response is `422`.
|
|
44988
|
+
*
|
|
44938
44989
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
44939
44990
|
*/
|
|
44940
44991
|
PutSecuritySettings: {
|
|
@@ -45242,6 +45293,7 @@ export interface operations {
|
|
|
45242
45293
|
401: coreComponents["responses"]["Unauthorized"];
|
|
45243
45294
|
403: coreComponents["responses"]["Forbidden"];
|
|
45244
45295
|
404: coreComponents["responses"]["NotFound"];
|
|
45296
|
+
409: coreComponents["responses"]["Conflict"];
|
|
45245
45297
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
45246
45298
|
};
|
|
45247
45299
|
};
|
|
@@ -45257,6 +45309,12 @@ export interface operations {
|
|
|
45257
45309
|
* User objects of Rebilly staff do not include `mfaEnabled`.
|
|
45258
45310
|
* The totals are the same as those returned by the [Retrieve security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings) operation.
|
|
45259
45311
|
* If the MFA status is temporarily unavailable, the response is `503` and `error` is `mfa_status_unavailable`.
|
|
45312
|
+
*
|
|
45313
|
+
* To retrieve users of the organization who can sign in only from allowed IP addresses, with `allowedIps` configured for the user or one of their roles, use `filter=hasAllowedIps:true`.
|
|
45314
|
+
* To retrieve users who have no `allowedIps` configured for the user or any of their roles, use `filter=hasAllowedIps:false`.
|
|
45315
|
+
* The `hasAllowedIps` filter applies only when listing users of an organization.
|
|
45316
|
+
* It does not include allowed IP addresses configured in the [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings).
|
|
45317
|
+
* Inactive users and Rebilly staff are excluded from the `hasAllowedIps` filter.
|
|
45260
45318
|
*/
|
|
45261
45319
|
GetUserCollection: {
|
|
45262
45320
|
parameters: {
|
|
@@ -53463,10 +53521,12 @@ export interface storefrontComponents {
|
|
|
53463
53521
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
53464
53522
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
53465
53523
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
53524
|
+
*
|
|
53466
53525
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
53467
53526
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
53468
53527
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
53469
53528
|
* The amount limit applies to the billed amount.
|
|
53529
|
+
*
|
|
53470
53530
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
53471
53531
|
* This field is useful for accounting and customer success purposes.
|
|
53472
53532
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -53483,6 +53543,7 @@ export interface storefrontComponents {
|
|
|
53483
53543
|
* When a soft limit is reached,
|
|
53484
53544
|
* a customer may receive a notification
|
|
53485
53545
|
* but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
|
|
53546
|
+
*
|
|
53486
53547
|
* When the reported usage reaches the configured limit,
|
|
53487
53548
|
* a specific event is triggered.
|
|
53488
53549
|
* To notify the customer in the merchant system,
|
|
@@ -53491,6 +53552,7 @@ export interface storefrontComponents {
|
|
|
53491
53552
|
* When the total usage reaches the hard limit quantity,
|
|
53492
53553
|
* or amount values,
|
|
53493
53554
|
* metered billing plan usages can no longer be reported.
|
|
53555
|
+
*
|
|
53494
53556
|
* Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
|
|
53495
53557
|
* A `quantity` value below the minimum billable quantity is invalid.
|
|
53496
53558
|
* An `amount` value below the minimum billable amount is invalid.
|
|
@@ -64858,6 +64920,11 @@ export interface storefrontComponents {
|
|
|
64858
64920
|
description?: string | null;
|
|
64859
64921
|
acl: storefrontComponents["schemas"]["Acl"];
|
|
64860
64922
|
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
64923
|
+
/**
|
|
64924
|
+
* IP addresses specified in `allowedIps` for this role and any roles included in it.
|
|
64925
|
+
* This value is `null` if no allowed IP addresses are configured for any of these roles.
|
|
64926
|
+
*/
|
|
64927
|
+
computedAllowedIps?: string[] | null;
|
|
64861
64928
|
/**
|
|
64862
64929
|
* List of role IDs where this role is used.
|
|
64863
64930
|
* For example, a role called `user` may be used in the `admin` and `manager` roles.
|
|
@@ -65152,6 +65219,14 @@ export interface storefrontComponents {
|
|
|
65152
65219
|
*/
|
|
65153
65220
|
roleIds?: string[];
|
|
65154
65221
|
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
65222
|
+
/**
|
|
65223
|
+
* IP addresses specified in `allowedIps` for the user,
|
|
65224
|
+
* the roles assigned to the user,
|
|
65225
|
+
* and any roles included in those roles.
|
|
65226
|
+
* This value is `null` if no allowed IP addresses are configured for any of them.
|
|
65227
|
+
* This value is also `null` when a Rebilly admin retrieves their own user.
|
|
65228
|
+
*/
|
|
65229
|
+
computedAllowedIps?: string[] | null;
|
|
65155
65230
|
/**
|
|
65156
65231
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
65157
65232
|
* This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
|
|
@@ -69506,10 +69581,12 @@ export interface storefrontComponents {
|
|
|
69506
69581
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
69507
69582
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
69508
69583
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
69584
|
+
*
|
|
69509
69585
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
69510
69586
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
69511
69587
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
69512
69588
|
* The amount limit applies to the billed amount.
|
|
69589
|
+
*
|
|
69513
69590
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
69514
69591
|
* This field is useful for accounting and customer success purposes.
|
|
69515
69592
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -71015,10 +71092,12 @@ export interface storefrontComponents {
|
|
|
71015
71092
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
71016
71093
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
71017
71094
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
71095
|
+
*
|
|
71018
71096
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
71019
71097
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
71020
71098
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
71021
71099
|
* The amount limit applies to the billed amount.
|
|
71100
|
+
*
|
|
71022
71101
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
71023
71102
|
* This field is useful for accounting and customer success purposes.
|
|
71024
71103
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -81325,10 +81404,12 @@ export interface reportsComponents {
|
|
|
81325
81404
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
81326
81405
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
81327
81406
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
81407
|
+
*
|
|
81328
81408
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
81329
81409
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
81330
81410
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
81331
81411
|
* The amount limit applies to the billed amount.
|
|
81412
|
+
*
|
|
81332
81413
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
81333
81414
|
* This field is useful for accounting and customer success purposes.
|
|
81334
81415
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -81345,6 +81426,7 @@ export interface reportsComponents {
|
|
|
81345
81426
|
* When a soft limit is reached,
|
|
81346
81427
|
* a customer may receive a notification
|
|
81347
81428
|
* but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
|
|
81429
|
+
*
|
|
81348
81430
|
* When the reported usage reaches the configured limit,
|
|
81349
81431
|
* a specific event is triggered.
|
|
81350
81432
|
* To notify the customer in the merchant system,
|
|
@@ -81353,6 +81435,7 @@ export interface reportsComponents {
|
|
|
81353
81435
|
* When the total usage reaches the hard limit quantity,
|
|
81354
81436
|
* or amount values,
|
|
81355
81437
|
* metered billing plan usages can no longer be reported.
|
|
81438
|
+
*
|
|
81356
81439
|
* Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
|
|
81357
81440
|
* A `quantity` value below the minimum billable quantity is invalid.
|
|
81358
81441
|
* An `amount` value below the minimum billable amount is invalid.
|
|
@@ -92720,6 +92803,11 @@ export interface reportsComponents {
|
|
|
92720
92803
|
description?: string | null;
|
|
92721
92804
|
acl: reportsComponents["schemas"]["Acl"];
|
|
92722
92805
|
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
92806
|
+
/**
|
|
92807
|
+
* IP addresses specified in `allowedIps` for this role and any roles included in it.
|
|
92808
|
+
* This value is `null` if no allowed IP addresses are configured for any of these roles.
|
|
92809
|
+
*/
|
|
92810
|
+
computedAllowedIps?: string[] | null;
|
|
92723
92811
|
/**
|
|
92724
92812
|
* List of role IDs where this role is used.
|
|
92725
92813
|
* For example, a role called `user` may be used in the `admin` and `manager` roles.
|
|
@@ -93014,6 +93102,14 @@ export interface reportsComponents {
|
|
|
93014
93102
|
*/
|
|
93015
93103
|
roleIds?: string[];
|
|
93016
93104
|
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
93105
|
+
/**
|
|
93106
|
+
* IP addresses specified in `allowedIps` for the user,
|
|
93107
|
+
* the roles assigned to the user,
|
|
93108
|
+
* and any roles included in those roles.
|
|
93109
|
+
* This value is `null` if no allowed IP addresses are configured for any of them.
|
|
93110
|
+
* This value is also `null` when a Rebilly admin retrieves their own user.
|
|
93111
|
+
*/
|
|
93112
|
+
computedAllowedIps?: string[] | null;
|
|
93017
93113
|
/**
|
|
93018
93114
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
93019
93115
|
* This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
|
|
@@ -97368,10 +97464,12 @@ export interface reportsComponents {
|
|
|
97368
97464
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
97369
97465
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
97370
97466
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
97467
|
+
*
|
|
97371
97468
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
97372
97469
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
97373
97470
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
97374
97471
|
* The amount limit applies to the billed amount.
|
|
97472
|
+
*
|
|
97375
97473
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
97376
97474
|
* This field is useful for accounting and customer success purposes.
|
|
97377
97475
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -98877,10 +98975,12 @@ export interface reportsComponents {
|
|
|
98877
98975
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
98878
98976
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
98879
98977
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
98978
|
+
*
|
|
98880
98979
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
98881
98980
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
98882
98981
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
98883
98982
|
* The amount limit applies to the billed amount.
|
|
98983
|
+
*
|
|
98884
98984
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
98885
98985
|
* This field is useful for accounting and customer success purposes.
|
|
98886
98986
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|