rebilly-js-sdk 62.235.1 → 62.236.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 +3 -3
- package/dist/rebilly-js-sdk.d.cts +130 -26
- package/dist/rebilly-js-sdk.d.mts +130 -26
- package/dist/rebilly-js-sdk.d.ts +130 -26
- package/dist/rebilly-js-sdk.es.mjs +222 -217
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/api-handler.spec.js +7 -3
- package/src/create-api-handler.js +3 -0
- package/src/errors/errors.js +12 -0
- package/src/errors/errors.spec.js +8 -5
package/CHANGELOG.md
CHANGED
|
@@ -4627,7 +4627,12 @@ export interface corePaths {
|
|
|
4627
4627
|
"/api-keys": {
|
|
4628
4628
|
/** Retrieve a list of API keys. */
|
|
4629
4629
|
get: operations["GetApiKeyCollection"];
|
|
4630
|
-
/**
|
|
4630
|
+
/**
|
|
4631
|
+
* Creates an API key for the authenticated user.
|
|
4632
|
+
* The key is not assigned to another user.
|
|
4633
|
+
* If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
|
|
4634
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
4635
|
+
*/
|
|
4631
4636
|
post: operations["PostApiKey"];
|
|
4632
4637
|
};
|
|
4633
4638
|
"/api-keys/{id}": {
|
|
@@ -5746,6 +5751,9 @@ export interface corePaths {
|
|
|
5746
5751
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
5747
5752
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
5748
5753
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
5754
|
+
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
5755
|
+
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
5756
|
+
* If the list does not include the IP address of the caller, the response is `422`.
|
|
5749
5757
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
5750
5758
|
*/
|
|
5751
5759
|
put: operations["PutSecuritySettings"];
|
|
@@ -6278,6 +6286,12 @@ export interface coreComponents {
|
|
|
6278
6286
|
/** HTTP status code. */
|
|
6279
6287
|
status?: number;
|
|
6280
6288
|
} & coreComponents["schemas"]["BaseProblem"];
|
|
6289
|
+
/**
|
|
6290
|
+
* Unique organization identifier.
|
|
6291
|
+
* An organization is an entity that represents a company.
|
|
6292
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
6293
|
+
*/
|
|
6294
|
+
OrganizationId: string;
|
|
6281
6295
|
Forbidden: { [key: string]: any } & {
|
|
6282
6296
|
/** HTTP status code. */
|
|
6283
6297
|
status?: number;
|
|
@@ -6286,8 +6300,15 @@ export interface coreComponents {
|
|
|
6286
6300
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
6287
6301
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
6288
6302
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
6303
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
6289
6304
|
*/
|
|
6290
6305
|
error?: string;
|
|
6306
|
+
/**
|
|
6307
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
6308
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
6309
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
6310
|
+
*/
|
|
6311
|
+
organizationId?: coreComponents["schemas"]["OrganizationId"];
|
|
6291
6312
|
} & coreComponents["schemas"]["BaseProblem"];
|
|
6292
6313
|
NotFound: {
|
|
6293
6314
|
/** HTTP status code. */
|
|
@@ -7543,12 +7564,6 @@ export interface coreComponents {
|
|
|
7543
7564
|
/** Revenue amount in USD. */
|
|
7544
7565
|
amountUsd?: number;
|
|
7545
7566
|
};
|
|
7546
|
-
/**
|
|
7547
|
-
* Unique organization identifier.
|
|
7548
|
-
* An organization is an entity that represents a company.
|
|
7549
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
7550
|
-
*/
|
|
7551
|
-
OrganizationId: string;
|
|
7552
7567
|
TaxNumber: {
|
|
7553
7568
|
/** Type of the tax number. */
|
|
7554
7569
|
type: "eu-vat" | "other";
|
|
@@ -16008,8 +16023,14 @@ export interface coreComponents {
|
|
|
16008
16023
|
/** Type of API key. */
|
|
16009
16024
|
type?: "secret" | "publishable";
|
|
16010
16025
|
/**
|
|
16011
|
-
*
|
|
16012
|
-
*
|
|
16026
|
+
* Permissions for this API key.
|
|
16027
|
+
*
|
|
16028
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
16029
|
+
* and the associated user has that permission.
|
|
16030
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
16031
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
16032
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
16033
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
16013
16034
|
*/
|
|
16014
16035
|
acl?: coreComponents["schemas"]["Acl"];
|
|
16015
16036
|
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
@@ -23900,6 +23921,21 @@ export interface coreComponents {
|
|
|
23900
23921
|
SecuritySettings: {
|
|
23901
23922
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
23902
23923
|
requireMfa: boolean;
|
|
23924
|
+
/**
|
|
23925
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
23926
|
+
* This setting does not apply to API keys.
|
|
23927
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
23928
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
23929
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
23930
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
23931
|
+
* To retain the current list, omit this property.
|
|
23932
|
+
*/
|
|
23933
|
+
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
23934
|
+
/**
|
|
23935
|
+
* IP address of the client that sent the request.
|
|
23936
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
23937
|
+
*/
|
|
23938
|
+
currentIpAddress?: string | null;
|
|
23903
23939
|
/**
|
|
23904
23940
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
23905
23941
|
* Pending invitations are counted as users without MFA.
|
|
@@ -39999,7 +40035,12 @@ export interface operations {
|
|
|
39999
40035
|
403: coreComponents["responses"]["Forbidden"];
|
|
40000
40036
|
};
|
|
40001
40037
|
};
|
|
40002
|
-
/**
|
|
40038
|
+
/**
|
|
40039
|
+
* Creates an API key for the authenticated user.
|
|
40040
|
+
* The key is not assigned to another user.
|
|
40041
|
+
* If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
|
|
40042
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
40043
|
+
*/
|
|
40003
40044
|
PostApiKey: {
|
|
40004
40045
|
responses: {
|
|
40005
40046
|
/** API key created. */
|
|
@@ -44538,6 +44579,9 @@ export interface operations {
|
|
|
44538
44579
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
44539
44580
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
44540
44581
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
44582
|
+
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
44583
|
+
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
44584
|
+
* If the list does not include the IP address of the caller, the response is `422`.
|
|
44541
44585
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
44542
44586
|
*/
|
|
44543
44587
|
PutSecuritySettings: {
|
|
@@ -46602,6 +46646,12 @@ export interface storefrontComponents {
|
|
|
46602
46646
|
/** HTTP status code. */
|
|
46603
46647
|
status?: number;
|
|
46604
46648
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
46649
|
+
/**
|
|
46650
|
+
* Unique organization identifier.
|
|
46651
|
+
* An organization is an entity that represents a company.
|
|
46652
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
46653
|
+
*/
|
|
46654
|
+
OrganizationId: string;
|
|
46605
46655
|
Forbidden: { [key: string]: any } & {
|
|
46606
46656
|
/** HTTP status code. */
|
|
46607
46657
|
status?: number;
|
|
@@ -46610,8 +46660,15 @@ export interface storefrontComponents {
|
|
|
46610
46660
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
46611
46661
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
46612
46662
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
46663
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
46613
46664
|
*/
|
|
46614
46665
|
error?: string;
|
|
46666
|
+
/**
|
|
46667
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
46668
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
46669
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
46670
|
+
*/
|
|
46671
|
+
organizationId?: storefrontComponents["schemas"]["OrganizationId"];
|
|
46615
46672
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
46616
46673
|
NotFound: {
|
|
46617
46674
|
/** HTTP status code. */
|
|
@@ -47867,12 +47924,6 @@ export interface storefrontComponents {
|
|
|
47867
47924
|
/** Revenue amount in USD. */
|
|
47868
47925
|
amountUsd?: number;
|
|
47869
47926
|
};
|
|
47870
|
-
/**
|
|
47871
|
-
* Unique organization identifier.
|
|
47872
|
-
* An organization is an entity that represents a company.
|
|
47873
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
47874
|
-
*/
|
|
47875
|
-
OrganizationId: string;
|
|
47876
47927
|
TaxNumber: {
|
|
47877
47928
|
/** Type of the tax number. */
|
|
47878
47929
|
type: "eu-vat" | "other";
|
|
@@ -56332,8 +56383,14 @@ export interface storefrontComponents {
|
|
|
56332
56383
|
/** Type of API key. */
|
|
56333
56384
|
type?: "secret" | "publishable";
|
|
56334
56385
|
/**
|
|
56335
|
-
*
|
|
56336
|
-
*
|
|
56386
|
+
* Permissions for this API key.
|
|
56387
|
+
*
|
|
56388
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
56389
|
+
* and the associated user has that permission.
|
|
56390
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
56391
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
56392
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
56393
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
56337
56394
|
*/
|
|
56338
56395
|
acl?: storefrontComponents["schemas"]["Acl"];
|
|
56339
56396
|
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
@@ -64224,6 +64281,21 @@ export interface storefrontComponents {
|
|
|
64224
64281
|
SecuritySettings: {
|
|
64225
64282
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
64226
64283
|
requireMfa: boolean;
|
|
64284
|
+
/**
|
|
64285
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
64286
|
+
* This setting does not apply to API keys.
|
|
64287
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
64288
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
64289
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
64290
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
64291
|
+
* To retain the current list, omit this property.
|
|
64292
|
+
*/
|
|
64293
|
+
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
64294
|
+
/**
|
|
64295
|
+
* IP address of the client that sent the request.
|
|
64296
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
64297
|
+
*/
|
|
64298
|
+
currentIpAddress?: string | null;
|
|
64227
64299
|
/**
|
|
64228
64300
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
64229
64301
|
* Pending invitations are counted as users without MFA.
|
|
@@ -74166,6 +74238,12 @@ export interface reportsComponents {
|
|
|
74166
74238
|
/** HTTP status code. */
|
|
74167
74239
|
status?: number;
|
|
74168
74240
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
74241
|
+
/**
|
|
74242
|
+
* Unique organization identifier.
|
|
74243
|
+
* An organization is an entity that represents a company.
|
|
74244
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
74245
|
+
*/
|
|
74246
|
+
OrganizationId: string;
|
|
74169
74247
|
Forbidden: { [key: string]: any } & {
|
|
74170
74248
|
/** HTTP status code. */
|
|
74171
74249
|
status?: number;
|
|
@@ -74174,8 +74252,15 @@ export interface reportsComponents {
|
|
|
74174
74252
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
74175
74253
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
74176
74254
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
74255
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
74177
74256
|
*/
|
|
74178
74257
|
error?: string;
|
|
74258
|
+
/**
|
|
74259
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
74260
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
74261
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
74262
|
+
*/
|
|
74263
|
+
organizationId?: reportsComponents["schemas"]["OrganizationId"];
|
|
74179
74264
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
74180
74265
|
NotFound: {
|
|
74181
74266
|
/** HTTP status code. */
|
|
@@ -75431,12 +75516,6 @@ export interface reportsComponents {
|
|
|
75431
75516
|
/** Revenue amount in USD. */
|
|
75432
75517
|
amountUsd?: number;
|
|
75433
75518
|
};
|
|
75434
|
-
/**
|
|
75435
|
-
* Unique organization identifier.
|
|
75436
|
-
* An organization is an entity that represents a company.
|
|
75437
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
75438
|
-
*/
|
|
75439
|
-
OrganizationId: string;
|
|
75440
75519
|
TaxNumber: {
|
|
75441
75520
|
/** Type of the tax number. */
|
|
75442
75521
|
type: "eu-vat" | "other";
|
|
@@ -83896,8 +83975,14 @@ export interface reportsComponents {
|
|
|
83896
83975
|
/** Type of API key. */
|
|
83897
83976
|
type?: "secret" | "publishable";
|
|
83898
83977
|
/**
|
|
83899
|
-
*
|
|
83900
|
-
*
|
|
83978
|
+
* Permissions for this API key.
|
|
83979
|
+
*
|
|
83980
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
83981
|
+
* and the associated user has that permission.
|
|
83982
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
83983
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
83984
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
83985
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
83901
83986
|
*/
|
|
83902
83987
|
acl?: reportsComponents["schemas"]["Acl"];
|
|
83903
83988
|
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
@@ -91788,6 +91873,21 @@ export interface reportsComponents {
|
|
|
91788
91873
|
SecuritySettings: {
|
|
91789
91874
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
91790
91875
|
requireMfa: boolean;
|
|
91876
|
+
/**
|
|
91877
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
91878
|
+
* This setting does not apply to API keys.
|
|
91879
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
91880
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
91881
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
91882
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
91883
|
+
* To retain the current list, omit this property.
|
|
91884
|
+
*/
|
|
91885
|
+
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
91886
|
+
/**
|
|
91887
|
+
* IP address of the client that sent the request.
|
|
91888
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
91889
|
+
*/
|
|
91890
|
+
currentIpAddress?: string | null;
|
|
91791
91891
|
/**
|
|
91792
91892
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
91793
91893
|
* Pending invitations are counted as users without MFA.
|
|
@@ -103092,6 +103192,7 @@ declare module "errors/errors" {
|
|
|
103092
103192
|
export { RebillyError };
|
|
103093
103193
|
export { RebillyRequestError };
|
|
103094
103194
|
export { RebillyMfaRequiredError };
|
|
103195
|
+
export { RebillyIpNotAllowedError };
|
|
103095
103196
|
export { RebillyValidationError };
|
|
103096
103197
|
export { RebillyNotFoundError };
|
|
103097
103198
|
export { RebillyConflictError };
|
|
@@ -103107,6 +103208,9 @@ declare module "errors/errors" {
|
|
|
103107
103208
|
class RebillyMfaRequiredError extends RebillyRequestError {
|
|
103108
103209
|
name: string;
|
|
103109
103210
|
}
|
|
103211
|
+
class RebillyIpNotAllowedError extends RebillyRequestError {
|
|
103212
|
+
name: string;
|
|
103213
|
+
}
|
|
103110
103214
|
class RebillyValidationError extends RebillyError {
|
|
103111
103215
|
constructor(error: any);
|
|
103112
103216
|
}
|
|
@@ -4627,7 +4627,12 @@ export interface corePaths {
|
|
|
4627
4627
|
"/api-keys": {
|
|
4628
4628
|
/** Retrieve a list of API keys. */
|
|
4629
4629
|
get: operations["GetApiKeyCollection"];
|
|
4630
|
-
/**
|
|
4630
|
+
/**
|
|
4631
|
+
* Creates an API key for the authenticated user.
|
|
4632
|
+
* The key is not assigned to another user.
|
|
4633
|
+
* If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
|
|
4634
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
4635
|
+
*/
|
|
4631
4636
|
post: operations["PostApiKey"];
|
|
4632
4637
|
};
|
|
4633
4638
|
"/api-keys/{id}": {
|
|
@@ -5746,6 +5751,9 @@ export interface corePaths {
|
|
|
5746
5751
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
5747
5752
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
5748
5753
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
5754
|
+
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
5755
|
+
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
5756
|
+
* If the list does not include the IP address of the caller, the response is `422`.
|
|
5749
5757
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
5750
5758
|
*/
|
|
5751
5759
|
put: operations["PutSecuritySettings"];
|
|
@@ -6278,6 +6286,12 @@ export interface coreComponents {
|
|
|
6278
6286
|
/** HTTP status code. */
|
|
6279
6287
|
status?: number;
|
|
6280
6288
|
} & coreComponents["schemas"]["BaseProblem"];
|
|
6289
|
+
/**
|
|
6290
|
+
* Unique organization identifier.
|
|
6291
|
+
* An organization is an entity that represents a company.
|
|
6292
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
6293
|
+
*/
|
|
6294
|
+
OrganizationId: string;
|
|
6281
6295
|
Forbidden: { [key: string]: any } & {
|
|
6282
6296
|
/** HTTP status code. */
|
|
6283
6297
|
status?: number;
|
|
@@ -6286,8 +6300,15 @@ export interface coreComponents {
|
|
|
6286
6300
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
6287
6301
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
6288
6302
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
6303
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
6289
6304
|
*/
|
|
6290
6305
|
error?: string;
|
|
6306
|
+
/**
|
|
6307
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
6308
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
6309
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
6310
|
+
*/
|
|
6311
|
+
organizationId?: coreComponents["schemas"]["OrganizationId"];
|
|
6291
6312
|
} & coreComponents["schemas"]["BaseProblem"];
|
|
6292
6313
|
NotFound: {
|
|
6293
6314
|
/** HTTP status code. */
|
|
@@ -7543,12 +7564,6 @@ export interface coreComponents {
|
|
|
7543
7564
|
/** Revenue amount in USD. */
|
|
7544
7565
|
amountUsd?: number;
|
|
7545
7566
|
};
|
|
7546
|
-
/**
|
|
7547
|
-
* Unique organization identifier.
|
|
7548
|
-
* An organization is an entity that represents a company.
|
|
7549
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
7550
|
-
*/
|
|
7551
|
-
OrganizationId: string;
|
|
7552
7567
|
TaxNumber: {
|
|
7553
7568
|
/** Type of the tax number. */
|
|
7554
7569
|
type: "eu-vat" | "other";
|
|
@@ -16008,8 +16023,14 @@ export interface coreComponents {
|
|
|
16008
16023
|
/** Type of API key. */
|
|
16009
16024
|
type?: "secret" | "publishable";
|
|
16010
16025
|
/**
|
|
16011
|
-
*
|
|
16012
|
-
*
|
|
16026
|
+
* Permissions for this API key.
|
|
16027
|
+
*
|
|
16028
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
16029
|
+
* and the associated user has that permission.
|
|
16030
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
16031
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
16032
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
16033
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
16013
16034
|
*/
|
|
16014
16035
|
acl?: coreComponents["schemas"]["Acl"];
|
|
16015
16036
|
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
@@ -23900,6 +23921,21 @@ export interface coreComponents {
|
|
|
23900
23921
|
SecuritySettings: {
|
|
23901
23922
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
23902
23923
|
requireMfa: boolean;
|
|
23924
|
+
/**
|
|
23925
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
23926
|
+
* This setting does not apply to API keys.
|
|
23927
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
23928
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
23929
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
23930
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
23931
|
+
* To retain the current list, omit this property.
|
|
23932
|
+
*/
|
|
23933
|
+
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
23934
|
+
/**
|
|
23935
|
+
* IP address of the client that sent the request.
|
|
23936
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
23937
|
+
*/
|
|
23938
|
+
currentIpAddress?: string | null;
|
|
23903
23939
|
/**
|
|
23904
23940
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
23905
23941
|
* Pending invitations are counted as users without MFA.
|
|
@@ -39999,7 +40035,12 @@ export interface operations {
|
|
|
39999
40035
|
403: coreComponents["responses"]["Forbidden"];
|
|
40000
40036
|
};
|
|
40001
40037
|
};
|
|
40002
|
-
/**
|
|
40038
|
+
/**
|
|
40039
|
+
* Creates an API key for the authenticated user.
|
|
40040
|
+
* The key is not assigned to another user.
|
|
40041
|
+
* If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
|
|
40042
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
40043
|
+
*/
|
|
40003
40044
|
PostApiKey: {
|
|
40004
40045
|
responses: {
|
|
40005
40046
|
/** API key created. */
|
|
@@ -44538,6 +44579,9 @@ export interface operations {
|
|
|
44538
44579
|
* To turn on `requireMfa`, the session must have passed MFA.
|
|
44539
44580
|
* If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
44540
44581
|
* If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
|
|
44582
|
+
* If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
|
|
44583
|
+
* If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
|
|
44584
|
+
* If the list does not include the IP address of the caller, the response is `422`.
|
|
44541
44585
|
* Settings apply to the current environment only: live and sandbox are configured separately.
|
|
44542
44586
|
*/
|
|
44543
44587
|
PutSecuritySettings: {
|
|
@@ -46602,6 +46646,12 @@ export interface storefrontComponents {
|
|
|
46602
46646
|
/** HTTP status code. */
|
|
46603
46647
|
status?: number;
|
|
46604
46648
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
46649
|
+
/**
|
|
46650
|
+
* Unique organization identifier.
|
|
46651
|
+
* An organization is an entity that represents a company.
|
|
46652
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
46653
|
+
*/
|
|
46654
|
+
OrganizationId: string;
|
|
46605
46655
|
Forbidden: { [key: string]: any } & {
|
|
46606
46656
|
/** HTTP status code. */
|
|
46607
46657
|
status?: number;
|
|
@@ -46610,8 +46660,15 @@ export interface storefrontComponents {
|
|
|
46610
46660
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
46611
46661
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
46612
46662
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
46663
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
46613
46664
|
*/
|
|
46614
46665
|
error?: string;
|
|
46666
|
+
/**
|
|
46667
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
46668
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
46669
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
46670
|
+
*/
|
|
46671
|
+
organizationId?: storefrontComponents["schemas"]["OrganizationId"];
|
|
46615
46672
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
46616
46673
|
NotFound: {
|
|
46617
46674
|
/** HTTP status code. */
|
|
@@ -47867,12 +47924,6 @@ export interface storefrontComponents {
|
|
|
47867
47924
|
/** Revenue amount in USD. */
|
|
47868
47925
|
amountUsd?: number;
|
|
47869
47926
|
};
|
|
47870
|
-
/**
|
|
47871
|
-
* Unique organization identifier.
|
|
47872
|
-
* An organization is an entity that represents a company.
|
|
47873
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
47874
|
-
*/
|
|
47875
|
-
OrganizationId: string;
|
|
47876
47927
|
TaxNumber: {
|
|
47877
47928
|
/** Type of the tax number. */
|
|
47878
47929
|
type: "eu-vat" | "other";
|
|
@@ -56332,8 +56383,14 @@ export interface storefrontComponents {
|
|
|
56332
56383
|
/** Type of API key. */
|
|
56333
56384
|
type?: "secret" | "publishable";
|
|
56334
56385
|
/**
|
|
56335
|
-
*
|
|
56336
|
-
*
|
|
56386
|
+
* Permissions for this API key.
|
|
56387
|
+
*
|
|
56388
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
56389
|
+
* and the associated user has that permission.
|
|
56390
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
56391
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
56392
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
56393
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
56337
56394
|
*/
|
|
56338
56395
|
acl?: storefrontComponents["schemas"]["Acl"];
|
|
56339
56396
|
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
@@ -64224,6 +64281,21 @@ export interface storefrontComponents {
|
|
|
64224
64281
|
SecuritySettings: {
|
|
64225
64282
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
64226
64283
|
requireMfa: boolean;
|
|
64284
|
+
/**
|
|
64285
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
64286
|
+
* This setting does not apply to API keys.
|
|
64287
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
64288
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
64289
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
64290
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
64291
|
+
* To retain the current list, omit this property.
|
|
64292
|
+
*/
|
|
64293
|
+
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
64294
|
+
/**
|
|
64295
|
+
* IP address of the client that sent the request.
|
|
64296
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
64297
|
+
*/
|
|
64298
|
+
currentIpAddress?: string | null;
|
|
64227
64299
|
/**
|
|
64228
64300
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
64229
64301
|
* Pending invitations are counted as users without MFA.
|
|
@@ -74166,6 +74238,12 @@ export interface reportsComponents {
|
|
|
74166
74238
|
/** HTTP status code. */
|
|
74167
74239
|
status?: number;
|
|
74168
74240
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
74241
|
+
/**
|
|
74242
|
+
* Unique organization identifier.
|
|
74243
|
+
* An organization is an entity that represents a company.
|
|
74244
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
74245
|
+
*/
|
|
74246
|
+
OrganizationId: string;
|
|
74169
74247
|
Forbidden: { [key: string]: any } & {
|
|
74170
74248
|
/** HTTP status code. */
|
|
74171
74249
|
status?: number;
|
|
@@ -74174,8 +74252,15 @@ export interface reportsComponents {
|
|
|
74174
74252
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
74175
74253
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
74176
74254
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
74255
|
+
* If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
|
|
74177
74256
|
*/
|
|
74178
74257
|
error?: string;
|
|
74258
|
+
/**
|
|
74259
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
74260
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
74261
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
74262
|
+
*/
|
|
74263
|
+
organizationId?: reportsComponents["schemas"]["OrganizationId"];
|
|
74179
74264
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
74180
74265
|
NotFound: {
|
|
74181
74266
|
/** HTTP status code. */
|
|
@@ -75431,12 +75516,6 @@ export interface reportsComponents {
|
|
|
75431
75516
|
/** Revenue amount in USD. */
|
|
75432
75517
|
amountUsd?: number;
|
|
75433
75518
|
};
|
|
75434
|
-
/**
|
|
75435
|
-
* Unique organization identifier.
|
|
75436
|
-
* An organization is an entity that represents a company.
|
|
75437
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
75438
|
-
*/
|
|
75439
|
-
OrganizationId: string;
|
|
75440
75519
|
TaxNumber: {
|
|
75441
75520
|
/** Type of the tax number. */
|
|
75442
75521
|
type: "eu-vat" | "other";
|
|
@@ -83896,8 +83975,14 @@ export interface reportsComponents {
|
|
|
83896
83975
|
/** Type of API key. */
|
|
83897
83976
|
type?: "secret" | "publishable";
|
|
83898
83977
|
/**
|
|
83899
|
-
*
|
|
83900
|
-
*
|
|
83978
|
+
* Permissions for this API key.
|
|
83979
|
+
*
|
|
83980
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
83981
|
+
* and the associated user has that permission.
|
|
83982
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
83983
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
83984
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
83985
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
83901
83986
|
*/
|
|
83902
83987
|
acl?: reportsComponents["schemas"]["Acl"];
|
|
83903
83988
|
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
@@ -91788,6 +91873,21 @@ export interface reportsComponents {
|
|
|
91788
91873
|
SecuritySettings: {
|
|
91789
91874
|
/** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
|
|
91790
91875
|
requireMfa: boolean;
|
|
91876
|
+
/**
|
|
91877
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
91878
|
+
* This setting does not apply to API keys.
|
|
91879
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
91880
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
91881
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
91882
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
91883
|
+
* To retain the current list, omit this property.
|
|
91884
|
+
*/
|
|
91885
|
+
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
91886
|
+
/**
|
|
91887
|
+
* IP address of the client that sent the request.
|
|
91888
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
91889
|
+
*/
|
|
91890
|
+
currentIpAddress?: string | null;
|
|
91791
91891
|
/**
|
|
91792
91892
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
91793
91893
|
* Pending invitations are counted as users without MFA.
|
|
@@ -103092,6 +103192,7 @@ declare module "errors/errors" {
|
|
|
103092
103192
|
export { RebillyError };
|
|
103093
103193
|
export { RebillyRequestError };
|
|
103094
103194
|
export { RebillyMfaRequiredError };
|
|
103195
|
+
export { RebillyIpNotAllowedError };
|
|
103095
103196
|
export { RebillyValidationError };
|
|
103096
103197
|
export { RebillyNotFoundError };
|
|
103097
103198
|
export { RebillyConflictError };
|
|
@@ -103107,6 +103208,9 @@ declare module "errors/errors" {
|
|
|
103107
103208
|
class RebillyMfaRequiredError extends RebillyRequestError {
|
|
103108
103209
|
name: string;
|
|
103109
103210
|
}
|
|
103211
|
+
class RebillyIpNotAllowedError extends RebillyRequestError {
|
|
103212
|
+
name: string;
|
|
103213
|
+
}
|
|
103110
103214
|
class RebillyValidationError extends RebillyError {
|
|
103111
103215
|
constructor(error: any);
|
|
103112
103216
|
}
|