@rebilly/api 0.8.0 → 0.9.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
|
@@ -10361,7 +10361,7 @@ export type PostRoleVariables = {
|
|
|
10361
10361
|
};
|
|
10362
10362
|
export type GetSecuritySettingsResult = SecuritySettings;
|
|
10363
10363
|
export type PutSecuritySettingsResult = SecuritySettings;
|
|
10364
|
-
export type PutSecuritySettingsBody = Omit<SecuritySettings, "mfaAdoption">;
|
|
10364
|
+
export type PutSecuritySettingsBody = Omit<SecuritySettings, "currentIpAddress" | "mfaAdoption">;
|
|
10365
10365
|
export type PutSecuritySettingsResponseHeaders = {
|
|
10366
10366
|
rateLimitLimit?: number;
|
|
10367
10367
|
rateLimitRemaining?: number;
|
|
@@ -497,6 +497,13 @@ export type Unauthorized = unknown & {
|
|
|
497
497
|
*/
|
|
498
498
|
status?: number;
|
|
499
499
|
} & BaseProblem;
|
|
500
|
+
/**
|
|
501
|
+
* Unique organization identifier.
|
|
502
|
+
* An organization is an entity that represents a company.
|
|
503
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
504
|
+
* @maxLength 50
|
|
505
|
+
*/
|
|
506
|
+
export type OrganizationId = string;
|
|
500
507
|
export type Forbidden = unknown & {
|
|
501
508
|
/**
|
|
502
509
|
* HTTP status code.
|
|
@@ -509,8 +516,15 @@ export type Forbidden = unknown & {
|
|
|
509
516
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
510
517
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
511
518
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
519
|
+
* 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`.
|
|
512
520
|
*/
|
|
513
521
|
error?: string;
|
|
522
|
+
/**
|
|
523
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
524
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
525
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
526
|
+
*/
|
|
527
|
+
organizationId?: OrganizationId;
|
|
514
528
|
} & BaseProblem;
|
|
515
529
|
export type NotFound = {
|
|
516
530
|
/**
|
|
@@ -2072,13 +2086,6 @@ export type CustomerLifetimeRevenue = {
|
|
|
2072
2086
|
*/
|
|
2073
2087
|
amountUsd?: number;
|
|
2074
2088
|
};
|
|
2075
|
-
/**
|
|
2076
|
-
* Unique organization identifier.
|
|
2077
|
-
* An organization is an entity that represents a company.
|
|
2078
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
2079
|
-
* @maxLength 50
|
|
2080
|
-
*/
|
|
2081
|
-
export type OrganizationId = string;
|
|
2082
2089
|
export type TaxNumber = {
|
|
2083
2090
|
/**
|
|
2084
2091
|
* Type of the tax number.
|
|
@@ -15196,8 +15203,14 @@ export type ApiKey = {
|
|
|
15196
15203
|
*/
|
|
15197
15204
|
type?: "secret" | "publishable";
|
|
15198
15205
|
/**
|
|
15199
|
-
*
|
|
15200
|
-
*
|
|
15206
|
+
* Permissions for this API key.
|
|
15207
|
+
*
|
|
15208
|
+
* A request is authorized only when these permissions include the permission for the operation,
|
|
15209
|
+
* and the associated user has that permission.
|
|
15210
|
+
* If these permissions include `*`, each operation is limited to the permissions of the associated user.
|
|
15211
|
+
* If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
|
|
15212
|
+
* If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
|
|
15213
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
15201
15214
|
*/
|
|
15202
15215
|
acl?: Acl;
|
|
15203
15216
|
allowedIps?: AllowedIps;
|
|
@@ -25419,6 +25432,22 @@ export type SecuritySettings = {
|
|
|
25419
25432
|
* Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI.
|
|
25420
25433
|
*/
|
|
25421
25434
|
requireMfa: boolean;
|
|
25435
|
+
/**
|
|
25436
|
+
* List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
|
|
25437
|
+
* This setting does not apply to API keys.
|
|
25438
|
+
* This setting applies to the current environment only: live and sandbox are configured separately.
|
|
25439
|
+
* If an IP address has no prefix length, only that address is allowed.
|
|
25440
|
+
* Wildcards, such as `198.51.*.*`, are not accepted.
|
|
25441
|
+
* To remove the restriction, set this value to `null` or an empty array.
|
|
25442
|
+
* To retain the current list, omit this property.
|
|
25443
|
+
*/
|
|
25444
|
+
allowedIps?: AllowedIps;
|
|
25445
|
+
/**
|
|
25446
|
+
* IP address of the client that sent the request.
|
|
25447
|
+
* This value is `null` if the IP address of the client cannot be determined.
|
|
25448
|
+
* @format ip
|
|
25449
|
+
*/
|
|
25450
|
+
readonly currentIpAddress?: string | null;
|
|
25422
25451
|
/**
|
|
25423
25452
|
* Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
|
|
25424
25453
|
* Pending invitations are counted as users without MFA.
|
|
@@ -428,6 +428,13 @@ export type Unauthorized = unknown & {
|
|
|
428
428
|
*/
|
|
429
429
|
status?: number;
|
|
430
430
|
} & BaseProblem;
|
|
431
|
+
/**
|
|
432
|
+
* Unique organization identifier.
|
|
433
|
+
* An organization is an entity that represents a company.
|
|
434
|
+
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
435
|
+
* @maxLength 50
|
|
436
|
+
*/
|
|
437
|
+
export type OrganizationId = string;
|
|
431
438
|
export type Forbidden = unknown & {
|
|
432
439
|
/**
|
|
433
440
|
* HTTP status code.
|
|
@@ -440,8 +447,15 @@ export type Forbidden = unknown & {
|
|
|
440
447
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
441
448
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
442
449
|
* If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
|
|
450
|
+
* 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`.
|
|
443
451
|
*/
|
|
444
452
|
error?: string;
|
|
453
|
+
/**
|
|
454
|
+
* ID of the organization that does not allow the IP address of the request.
|
|
455
|
+
* This property is present only if `error` is `ip_not_allowed`.
|
|
456
|
+
* The organization is the organization of the request or another organization that the request acts on.
|
|
457
|
+
*/
|
|
458
|
+
organizationId?: OrganizationId;
|
|
445
459
|
} & BaseProblem;
|
|
446
460
|
/**
|
|
447
461
|
* Invalid field details.
|
|
@@ -7349,13 +7363,6 @@ export type PostSubscription = {
|
|
|
7349
7363
|
*/
|
|
7350
7364
|
deliveryAddress?: ContactObject | null;
|
|
7351
7365
|
};
|
|
7352
|
-
/**
|
|
7353
|
-
* Unique organization identifier.
|
|
7354
|
-
* An organization is an entity that represents a company.
|
|
7355
|
-
* For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
|
|
7356
|
-
* @maxLength 50
|
|
7357
|
-
*/
|
|
7358
|
-
export type OrganizationId = string;
|
|
7359
7366
|
export type Website = {
|
|
7360
7367
|
readonly id?: WebsiteId;
|
|
7361
7368
|
/**
|