@rebilly/api 0.18.2 → 0.19.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
CHANGED
package/dist/core-client.d.ts
CHANGED
|
@@ -8832,7 +8832,7 @@ export type PutRolePath = {
|
|
|
8832
8832
|
*/
|
|
8833
8833
|
id: string;
|
|
8834
8834
|
};
|
|
8835
|
-
export type PutRoleBody = Omit<Role, "id" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
|
|
8835
|
+
export type PutRoleBody = Omit<Role, "id" | "computedAllowedIps" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
|
|
8836
8836
|
export type PutRoleResponseHeaders = {
|
|
8837
8837
|
rateLimitLimit?: number;
|
|
8838
8838
|
rateLimitRemaining?: number;
|
|
@@ -8942,7 +8942,7 @@ export type PutUserPath = {
|
|
|
8942
8942
|
*/
|
|
8943
8943
|
id: string;
|
|
8944
8944
|
};
|
|
8945
|
-
export type PutUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "mfaEnabled">;
|
|
8945
|
+
export type PutUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "computedAllowedIps" | "mfaEnabled">;
|
|
8946
8946
|
export type PutUserResponseHeaders = {
|
|
8947
8947
|
rateLimitLimit?: number;
|
|
8948
8948
|
rateLimitRemaining?: number;
|
|
@@ -10351,7 +10351,7 @@ export type GetRoleCollectionVariables = {
|
|
|
10351
10351
|
query?: GetRoleCollectionQuery;
|
|
10352
10352
|
};
|
|
10353
10353
|
export type PostRoleResult = Role;
|
|
10354
|
-
export type PostRoleBody = Omit<Role, "id" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
|
|
10354
|
+
export type PostRoleBody = Omit<Role, "id" | "computedAllowedIps" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
|
|
10355
10355
|
export type PostRoleResponseHeaders = {
|
|
10356
10356
|
location?: string;
|
|
10357
10357
|
rateLimitLimit?: number;
|
|
@@ -10584,7 +10584,7 @@ export type GetUserCollectionVariables = {
|
|
|
10584
10584
|
query?: GetUserCollectionQuery;
|
|
10585
10585
|
};
|
|
10586
10586
|
export type PostUserResult = User;
|
|
10587
|
-
export type PostUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "mfaEnabled">;
|
|
10587
|
+
export type PostUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "computedAllowedIps" | "mfaEnabled">;
|
|
10588
10588
|
export type PostUserResponseHeaders = {
|
|
10589
10589
|
location?: string;
|
|
10590
10590
|
rateLimitLimit?: number;
|
|
@@ -8027,10 +8027,12 @@ export type UsageLimits = {
|
|
|
8027
8027
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
8028
8028
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
8029
8029
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
8030
|
+
*
|
|
8030
8031
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
8031
8032
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
8032
8033
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
8033
8034
|
* The amount limit applies to the billed amount.
|
|
8035
|
+
*
|
|
8034
8036
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
8035
8037
|
* This field is useful for accounting and customer success purposes.
|
|
8036
8038
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -8054,6 +8056,7 @@ export type UsageLimits = {
|
|
|
8054
8056
|
* When a soft limit is reached,
|
|
8055
8057
|
* a customer may receive a notification
|
|
8056
8058
|
* but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
|
|
8059
|
+
*
|
|
8057
8060
|
* When the reported usage reaches the configured limit,
|
|
8058
8061
|
* a specific event is triggered.
|
|
8059
8062
|
* To notify the customer in the merchant system,
|
|
@@ -8062,6 +8065,7 @@ export type UsageLimits = {
|
|
|
8062
8065
|
* When the total usage reaches the hard limit quantity,
|
|
8063
8066
|
* or amount values,
|
|
8064
8067
|
* metered billing plan usages can no longer be reported.
|
|
8068
|
+
*
|
|
8065
8069
|
* Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
|
|
8066
8070
|
* A `quantity` value below the minimum billable quantity is invalid.
|
|
8067
8071
|
* An `amount` value below the minimum billable amount is invalid.
|
|
@@ -25692,6 +25696,11 @@ export type Role = {
|
|
|
25692
25696
|
description?: string | null;
|
|
25693
25697
|
acl: Acl;
|
|
25694
25698
|
allowedIps?: AllowedIps;
|
|
25699
|
+
/**
|
|
25700
|
+
* IP addresses specified in `allowedIps` for this role and any roles included in it.
|
|
25701
|
+
* This value is `null` if no allowed IP addresses are configured for any of these roles.
|
|
25702
|
+
*/
|
|
25703
|
+
readonly computedAllowedIps?: string[] | null;
|
|
25695
25704
|
/**
|
|
25696
25705
|
* List of role IDs where this role is used.
|
|
25697
25706
|
* For example, a role called `user` may be used in the `admin` and `manager` roles.
|
|
@@ -26136,6 +26145,14 @@ export type User = {
|
|
|
26136
26145
|
*/
|
|
26137
26146
|
roleIds?: string[];
|
|
26138
26147
|
allowedIps?: AllowedIps;
|
|
26148
|
+
/**
|
|
26149
|
+
* IP addresses specified in `allowedIps` for the user,
|
|
26150
|
+
* the roles assigned to the user,
|
|
26151
|
+
* and any roles included in those roles.
|
|
26152
|
+
* This value is `null` if no allowed IP addresses are configured for any of them.
|
|
26153
|
+
* This value is also `null` when a Rebilly admin retrieves their own user.
|
|
26154
|
+
*/
|
|
26155
|
+
readonly computedAllowedIps?: string[] | null;
|
|
26139
26156
|
/**
|
|
26140
26157
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
26141
26158
|
* This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
|
|
@@ -625,10 +625,12 @@ export type StorefrontPatchOrderBody = {
|
|
|
625
625
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
626
626
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
627
627
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
628
|
+
*
|
|
628
629
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
629
630
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
630
631
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
631
632
|
* The amount limit applies to the billed amount.
|
|
633
|
+
*
|
|
632
634
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
633
635
|
* This field is useful for accounting and customer success purposes.
|
|
634
636
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -4416,10 +4416,12 @@ export type UsageLimits = {
|
|
|
4416
4416
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
4417
4417
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
4418
4418
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
4419
|
+
*
|
|
4419
4420
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
4420
4421
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
4421
4422
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
4422
4423
|
* The amount limit applies to the billed amount.
|
|
4424
|
+
*
|
|
4423
4425
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
4424
4426
|
* This field is useful for accounting and customer success purposes.
|
|
4425
4427
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|
|
@@ -4443,6 +4445,7 @@ export type UsageLimits = {
|
|
|
4443
4445
|
* When a soft limit is reached,
|
|
4444
4446
|
* a customer may receive a notification
|
|
4445
4447
|
* but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
|
|
4448
|
+
*
|
|
4446
4449
|
* When the reported usage reaches the configured limit,
|
|
4447
4450
|
* a specific event is triggered.
|
|
4448
4451
|
* To notify the customer in the merchant system,
|
|
@@ -4451,6 +4454,7 @@ export type UsageLimits = {
|
|
|
4451
4454
|
* When the total usage reaches the hard limit quantity,
|
|
4452
4455
|
* or amount values,
|
|
4453
4456
|
* metered billing plan usages can no longer be reported.
|
|
4457
|
+
*
|
|
4454
4458
|
* Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
|
|
4455
4459
|
* A `quantity` value below the minimum billable quantity is invalid.
|
|
4456
4460
|
* An `amount` value below the minimum billable amount is invalid.
|
|
@@ -7340,10 +7344,12 @@ export type PostSubscription = {
|
|
|
7340
7344
|
* For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
|
|
7341
7345
|
* This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
|
|
7342
7346
|
* When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
|
|
7347
|
+
*
|
|
7343
7348
|
* The quantity limit applies to the larger of the reported and billed quantity.
|
|
7344
7349
|
* If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
|
|
7345
7350
|
* If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
|
|
7346
7351
|
* The amount limit applies to the billed amount.
|
|
7352
|
+
*
|
|
7347
7353
|
* To notify the customer, a webhook and notification can be configured for this event.
|
|
7348
7354
|
* This field is useful for accounting and customer success purposes.
|
|
7349
7355
|
* The usage of metered billing plans can still be reported if the soft limit is reached.
|