rebilly-js-sdk 62.247.12 → 62.248.1
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 +326 -12
- package/dist/rebilly-js-sdk.d.mts +326 -12
- package/dist/rebilly-js-sdk.d.ts +326 -12
- package/dist/rebilly-js-sdk.es.mjs +130 -116
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
- package/src/resources/api-instance.js +2 -0
- package/src/resources/organization-api-keys-resource.js +17 -0
- package/src/resources/users-resource.js +3 -0
package/CHANGELOG.md
CHANGED
|
@@ -1195,6 +1195,11 @@ declare namespace rebilly {
|
|
|
1195
1195
|
type DeleteApiKeyResponse = operations['DeleteApiKey']['responses']['204']
|
|
1196
1196
|
type DeleteApiKeyResponsePromise = Promise<{fields: DeleteApiKeyResponse}>
|
|
1197
1197
|
|
|
1198
|
+
type GetOrganizationApiKeyCollectionRequest = operations['GetOrganizationApiKeyCollection']['parameters']["query"] & (operations['GetOrganizationApiKeyCollection']['parameters'] extends {path: {}} ? operations['GetOrganizationApiKeyCollection']['parameters']["path"] : {})
|
|
1199
|
+
|
|
1200
|
+
type GetOrganizationApiKeyCollectionResponse = operations['GetOrganizationApiKeyCollection']['responses']['200']['content']['application/json'][0]
|
|
1201
|
+
type GetOrganizationApiKeyCollectionResponsePromise = Promise<{ items: {fields: GetOrganizationApiKeyCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1202
|
+
|
|
1198
1203
|
type GetBalanceTransactionCollectionRequest = operations['GetBalanceTransactionCollection']['parameters']["query"] & (operations['GetBalanceTransactionCollection']['parameters'] extends {path: {}} ? operations['GetBalanceTransactionCollection']['parameters']["path"] : {})
|
|
1199
1204
|
|
|
1200
1205
|
type GetBalanceTransactionCollectionResponse = operations['GetBalanceTransactionCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -1886,6 +1891,9 @@ declare namespace rebilly {
|
|
|
1886
1891
|
type PutUserResponse = operations['PutUser']['responses']['201']['content']['application/json']
|
|
1887
1892
|
type PutUserResponsePromise = Promise<{fields: PutUserResponse}>
|
|
1888
1893
|
|
|
1894
|
+
type PostUserMfaResetResponse = operations['PostUserMfaReset']['responses']['204']
|
|
1895
|
+
type PostUserMfaResetResponsePromise = Promise<{fields: PostUserMfaResetResponse}>
|
|
1896
|
+
|
|
1889
1897
|
type GetWebhookCollectionRequest = operations['GetWebhookCollection']['parameters']["query"] & (operations['GetWebhookCollection']['parameters'] extends {path: {}} ? operations['GetWebhookCollection']['parameters']["path"] : {})
|
|
1890
1898
|
|
|
1891
1899
|
type GetWebhookCollectionResponse = operations['GetWebhookCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -4682,6 +4690,17 @@ export interface corePaths {
|
|
|
4682
4690
|
};
|
|
4683
4691
|
};
|
|
4684
4692
|
};
|
|
4693
|
+
"/organization-api-keys": {
|
|
4694
|
+
/**
|
|
4695
|
+
* Retrieves a list of API keys that members of the organization own.
|
|
4696
|
+
* API keys with permissions that grant access only to other organizations are not listed.
|
|
4697
|
+
* This operation is for organization administrators who audit API keys.
|
|
4698
|
+
* The `owner` property of each API key identifies the member who owns it.
|
|
4699
|
+
* For a secret key, `secretKey` is masked.
|
|
4700
|
+
* For a publishable key, `secretKey` contains the full value.
|
|
4701
|
+
*/
|
|
4702
|
+
get: operations["GetOrganizationApiKeyCollection"];
|
|
4703
|
+
};
|
|
4685
4704
|
"/balance-transactions": {
|
|
4686
4705
|
/**
|
|
4687
4706
|
* Retrieves a list of balance transactions.
|
|
@@ -5915,6 +5934,32 @@ export interface corePaths {
|
|
|
5915
5934
|
};
|
|
5916
5935
|
};
|
|
5917
5936
|
};
|
|
5937
|
+
"/users/{id}/mfa-reset": {
|
|
5938
|
+
/**
|
|
5939
|
+
* Removes the multi-factor authentication (MFA) authenticator of a user in the organization.
|
|
5940
|
+
* The user is signed out within 5 minutes and receives an email notification.
|
|
5941
|
+
* The user must set up MFA again the next time they sign in to an organization that requires MFA.
|
|
5942
|
+
* The reset applies to the user's account and includes both the live and sandbox environments.
|
|
5943
|
+
* Only organization owners and users with the administrator role who are signed in to the Rebilly app are permitted to reset MFA.
|
|
5944
|
+
* The session of the caller must be confirmed with MFA.
|
|
5945
|
+
* If the session is not confirmed with MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
5946
|
+
* The reset is refused in these cases:
|
|
5947
|
+
*
|
|
5948
|
+
* - Attempting to reset MFA for yourself.
|
|
5949
|
+
* - Attempting to reset MFA for Rebilly staff.
|
|
5950
|
+
* - User is deactivated.
|
|
5951
|
+
* - User has not accepted the invitation.
|
|
5952
|
+
* - User is a member of another organization in the current environment.
|
|
5953
|
+
* - User does not have MFA set up.
|
|
5954
|
+
*/
|
|
5955
|
+
post: operations["PostUserMfaReset"];
|
|
5956
|
+
parameters: {
|
|
5957
|
+
path: {
|
|
5958
|
+
/** ID of the resource. */
|
|
5959
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
5960
|
+
};
|
|
5961
|
+
};
|
|
5962
|
+
};
|
|
5918
5963
|
"/webhooks": {
|
|
5919
5964
|
/** Retrieves a list of webhooks. */
|
|
5920
5965
|
get: operations["GetWebhookCollection"];
|
|
@@ -6350,7 +6395,8 @@ export interface coreComponents {
|
|
|
6350
6395
|
* Message that describes why the request is forbidden.
|
|
6351
6396
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
6352
6397
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
6353
|
-
* If
|
|
6398
|
+
* If MFA verification has not been completed for the session and the operation requires a confirmed session, this value is `mfa_required_for_caller`.
|
|
6399
|
+
* This includes turning on `requireMfa` and resetting MFA for a user.
|
|
6354
6400
|
* 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`.
|
|
6355
6401
|
*/
|
|
6356
6402
|
error?: string;
|
|
@@ -16344,6 +16390,61 @@ export interface coreComponents {
|
|
|
16344
16390
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16345
16391
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
16346
16392
|
};
|
|
16393
|
+
/** API key that a member of the organization owns. */
|
|
16394
|
+
OrganizationApiKey: {
|
|
16395
|
+
/** ID of the API key. */
|
|
16396
|
+
id: string;
|
|
16397
|
+
/** API key description. */
|
|
16398
|
+
description: string;
|
|
16399
|
+
/** Type of API key. */
|
|
16400
|
+
type: "secret" | "publishable";
|
|
16401
|
+
/**
|
|
16402
|
+
* Permissions of the API key that apply to the organization.
|
|
16403
|
+
* Permissions that apply only to other organizations are not included,
|
|
16404
|
+
* and an `organizationId` scope lists only the ID of the organization.
|
|
16405
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
16406
|
+
*/
|
|
16407
|
+
acl?: coreComponents["schemas"]["Acl"];
|
|
16408
|
+
allowedIps?: coreComponents["schemas"]["AllowedIps"];
|
|
16409
|
+
/**
|
|
16410
|
+
* Date and time when the API key last authenticated a request.
|
|
16411
|
+
* This value is updated at most once every 5 minutes.
|
|
16412
|
+
* This value is `null` if the API key has no recorded use.
|
|
16413
|
+
*/
|
|
16414
|
+
lastUsedTime?: string | null;
|
|
16415
|
+
/**
|
|
16416
|
+
* IP address of the request that last updated `lastUsedTime`.
|
|
16417
|
+
* This value is `null` if the API key has no recorded use.
|
|
16418
|
+
*/
|
|
16419
|
+
lastUsedIp?: string | null;
|
|
16420
|
+
/**
|
|
16421
|
+
* Date and time when the API key expires.
|
|
16422
|
+
* From this time, a request that uses the API key gets a `401` response.
|
|
16423
|
+
* This value is `null` if the API key does not expire.
|
|
16424
|
+
*/
|
|
16425
|
+
expirationTime?: string | null;
|
|
16426
|
+
/** API user name. */
|
|
16427
|
+
apiUser: string;
|
|
16428
|
+
/**
|
|
16429
|
+
* Value of the API key.
|
|
16430
|
+
* For a secret key, this operation returns a masked value that keeps only the prefix and the `apiUser` value.
|
|
16431
|
+
* For a publishable key, the value is the full key.
|
|
16432
|
+
*/
|
|
16433
|
+
secretKey: string;
|
|
16434
|
+
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
16435
|
+
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16436
|
+
/** Member of the organization who owns the API key. */
|
|
16437
|
+
owner: {
|
|
16438
|
+
/** ID of the user. */
|
|
16439
|
+
id: string;
|
|
16440
|
+
/** Email address of the user. */
|
|
16441
|
+
email: string;
|
|
16442
|
+
/** First name of the user. */
|
|
16443
|
+
firstName: string;
|
|
16444
|
+
/** Last name of the user. */
|
|
16445
|
+
lastName: string;
|
|
16446
|
+
};
|
|
16447
|
+
};
|
|
16347
16448
|
ChargeTransaction: {
|
|
16348
16449
|
/** ID of the balance transaction. */
|
|
16349
16450
|
id?: string;
|
|
@@ -24540,9 +24641,7 @@ export interface coreComponents {
|
|
|
24540
24641
|
computedAllowedIps?: string[] | null;
|
|
24541
24642
|
/**
|
|
24542
24643
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
24543
|
-
* This
|
|
24544
|
-
* for an organization that has [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings),
|
|
24545
|
-
* and is omitted for Rebilly staff.
|
|
24644
|
+
* This field is included in the response for users in the current organization and omitted for Rebilly staff.
|
|
24546
24645
|
* This value is `null` when this information is temporarily unavailable.
|
|
24547
24646
|
*/
|
|
24548
24647
|
mfaEnabled?: boolean | null;
|
|
@@ -40567,6 +40666,52 @@ export interface operations {
|
|
|
40567
40666
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
40568
40667
|
};
|
|
40569
40668
|
};
|
|
40669
|
+
/**
|
|
40670
|
+
* Retrieves a list of API keys that members of the organization own.
|
|
40671
|
+
* API keys with permissions that grant access only to other organizations are not listed.
|
|
40672
|
+
* This operation is for organization administrators who audit API keys.
|
|
40673
|
+
* The `owner` property of each API key identifies the member who owns it.
|
|
40674
|
+
* For a secret key, `secretKey` is masked.
|
|
40675
|
+
* For a publishable key, `secretKey` contains the full value.
|
|
40676
|
+
*/
|
|
40677
|
+
GetOrganizationApiKeyCollection: {
|
|
40678
|
+
parameters: {
|
|
40679
|
+
query: {
|
|
40680
|
+
/**
|
|
40681
|
+
* Criteria for filtering collection items.
|
|
40682
|
+
* This field requires a special format.
|
|
40683
|
+
* Use `,` to specify multiple allowed values.
|
|
40684
|
+
* Use `;` to specify multiple fields.
|
|
40685
|
+
*
|
|
40686
|
+
* For more information, see [Search filters](https://www.rebilly.com/docs/dev-docs/search-filters).
|
|
40687
|
+
*/
|
|
40688
|
+
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
40689
|
+
/**
|
|
40690
|
+
* Sorts and orders the collection of items. To sort in descending
|
|
40691
|
+
* order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
|
|
40692
|
+
*/
|
|
40693
|
+
sort?: coreComponents["parameters"]["collectionSort"];
|
|
40694
|
+
/**
|
|
40695
|
+
* Limit the number of collection items to be returned.
|
|
40696
|
+
* Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
|
|
40697
|
+
*/
|
|
40698
|
+
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
40699
|
+
/** Specifies the starting point within the collection of items to be returned. */
|
|
40700
|
+
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
40701
|
+
};
|
|
40702
|
+
};
|
|
40703
|
+
responses: {
|
|
40704
|
+
/** List of API keys retrieved. */
|
|
40705
|
+
200: {
|
|
40706
|
+
headers: {};
|
|
40707
|
+
content: {
|
|
40708
|
+
"application/json": coreComponents["schemas"]["OrganizationApiKey"][];
|
|
40709
|
+
};
|
|
40710
|
+
};
|
|
40711
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
40712
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
40713
|
+
};
|
|
40714
|
+
};
|
|
40570
40715
|
/**
|
|
40571
40716
|
* Retrieves a list of balance transactions.
|
|
40572
40717
|
*
|
|
@@ -45480,6 +45625,46 @@ export interface operations {
|
|
|
45480
45625
|
};
|
|
45481
45626
|
requestBody: coreComponents["requestBodies"]["User"];
|
|
45482
45627
|
};
|
|
45628
|
+
/**
|
|
45629
|
+
* Removes the multi-factor authentication (MFA) authenticator of a user in the organization.
|
|
45630
|
+
* The user is signed out within 5 minutes and receives an email notification.
|
|
45631
|
+
* The user must set up MFA again the next time they sign in to an organization that requires MFA.
|
|
45632
|
+
* The reset applies to the user's account and includes both the live and sandbox environments.
|
|
45633
|
+
* Only organization owners and users with the administrator role who are signed in to the Rebilly app are permitted to reset MFA.
|
|
45634
|
+
* The session of the caller must be confirmed with MFA.
|
|
45635
|
+
* If the session is not confirmed with MFA, the response is `403` and `error` is `mfa_required_for_caller`.
|
|
45636
|
+
* The reset is refused in these cases:
|
|
45637
|
+
*
|
|
45638
|
+
* - Attempting to reset MFA for yourself.
|
|
45639
|
+
* - Attempting to reset MFA for Rebilly staff.
|
|
45640
|
+
* - User is deactivated.
|
|
45641
|
+
* - User has not accepted the invitation.
|
|
45642
|
+
* - User is a member of another organization in the current environment.
|
|
45643
|
+
* - User does not have MFA set up.
|
|
45644
|
+
*/
|
|
45645
|
+
PostUserMfaReset: {
|
|
45646
|
+
parameters: {
|
|
45647
|
+
path: {
|
|
45648
|
+
/** ID of the resource. */
|
|
45649
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
45650
|
+
};
|
|
45651
|
+
};
|
|
45652
|
+
responses: {
|
|
45653
|
+
/** MFA reset. */
|
|
45654
|
+
204: never;
|
|
45655
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
45656
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
45657
|
+
404: coreComponents["responses"]["NotFound"];
|
|
45658
|
+
409: coreComponents["responses"]["Conflict"];
|
|
45659
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
45660
|
+
/** MFA reset unavailable. */
|
|
45661
|
+
503: {
|
|
45662
|
+
content: {
|
|
45663
|
+
"application/json": coreComponents["schemas"]["Problem"];
|
|
45664
|
+
};
|
|
45665
|
+
};
|
|
45666
|
+
};
|
|
45667
|
+
};
|
|
45483
45668
|
/** Retrieves a list of webhooks. */
|
|
45484
45669
|
GetWebhookCollection: {
|
|
45485
45670
|
parameters: {
|
|
@@ -47120,7 +47305,8 @@ export interface storefrontComponents {
|
|
|
47120
47305
|
* Message that describes why the request is forbidden.
|
|
47121
47306
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
47122
47307
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
47123
|
-
* If
|
|
47308
|
+
* If MFA verification has not been completed for the session and the operation requires a confirmed session, this value is `mfa_required_for_caller`.
|
|
47309
|
+
* This includes turning on `requireMfa` and resetting MFA for a user.
|
|
47124
47310
|
* 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`.
|
|
47125
47311
|
*/
|
|
47126
47312
|
error?: string;
|
|
@@ -57114,6 +57300,61 @@ export interface storefrontComponents {
|
|
|
57114
57300
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
57115
57301
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
57116
57302
|
};
|
|
57303
|
+
/** API key that a member of the organization owns. */
|
|
57304
|
+
OrganizationApiKey: {
|
|
57305
|
+
/** ID of the API key. */
|
|
57306
|
+
id: string;
|
|
57307
|
+
/** API key description. */
|
|
57308
|
+
description: string;
|
|
57309
|
+
/** Type of API key. */
|
|
57310
|
+
type: "secret" | "publishable";
|
|
57311
|
+
/**
|
|
57312
|
+
* Permissions of the API key that apply to the organization.
|
|
57313
|
+
* Permissions that apply only to other organizations are not included,
|
|
57314
|
+
* and an `organizationId` scope lists only the ID of the organization.
|
|
57315
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
57316
|
+
*/
|
|
57317
|
+
acl?: storefrontComponents["schemas"]["Acl"];
|
|
57318
|
+
allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
|
|
57319
|
+
/**
|
|
57320
|
+
* Date and time when the API key last authenticated a request.
|
|
57321
|
+
* This value is updated at most once every 5 minutes.
|
|
57322
|
+
* This value is `null` if the API key has no recorded use.
|
|
57323
|
+
*/
|
|
57324
|
+
lastUsedTime?: string | null;
|
|
57325
|
+
/**
|
|
57326
|
+
* IP address of the request that last updated `lastUsedTime`.
|
|
57327
|
+
* This value is `null` if the API key has no recorded use.
|
|
57328
|
+
*/
|
|
57329
|
+
lastUsedIp?: string | null;
|
|
57330
|
+
/**
|
|
57331
|
+
* Date and time when the API key expires.
|
|
57332
|
+
* From this time, a request that uses the API key gets a `401` response.
|
|
57333
|
+
* This value is `null` if the API key does not expire.
|
|
57334
|
+
*/
|
|
57335
|
+
expirationTime?: string | null;
|
|
57336
|
+
/** API user name. */
|
|
57337
|
+
apiUser: string;
|
|
57338
|
+
/**
|
|
57339
|
+
* Value of the API key.
|
|
57340
|
+
* For a secret key, this operation returns a masked value that keeps only the prefix and the `apiUser` value.
|
|
57341
|
+
* For a publishable key, the value is the full key.
|
|
57342
|
+
*/
|
|
57343
|
+
secretKey: string;
|
|
57344
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
57345
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
57346
|
+
/** Member of the organization who owns the API key. */
|
|
57347
|
+
owner: {
|
|
57348
|
+
/** ID of the user. */
|
|
57349
|
+
id: string;
|
|
57350
|
+
/** Email address of the user. */
|
|
57351
|
+
email: string;
|
|
57352
|
+
/** First name of the user. */
|
|
57353
|
+
firstName: string;
|
|
57354
|
+
/** Last name of the user. */
|
|
57355
|
+
lastName: string;
|
|
57356
|
+
};
|
|
57357
|
+
};
|
|
57117
57358
|
ChargeTransaction: {
|
|
57118
57359
|
/** ID of the balance transaction. */
|
|
57119
57360
|
id?: string;
|
|
@@ -65310,9 +65551,7 @@ export interface storefrontComponents {
|
|
|
65310
65551
|
computedAllowedIps?: string[] | null;
|
|
65311
65552
|
/**
|
|
65312
65553
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
65313
|
-
* This
|
|
65314
|
-
* for an organization that has [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings),
|
|
65315
|
-
* and is omitted for Rebilly staff.
|
|
65554
|
+
* This field is included in the response for users in the current organization and omitted for Rebilly staff.
|
|
65316
65555
|
* This value is `null` when this information is temporarily unavailable.
|
|
65317
65556
|
*/
|
|
65318
65557
|
mfaEnabled?: boolean | null;
|
|
@@ -75034,7 +75273,8 @@ export interface reportsComponents {
|
|
|
75034
75273
|
* Message that describes why the request is forbidden.
|
|
75035
75274
|
* Most responses use a descriptive message, such as `Not allowed to change security settings`.
|
|
75036
75275
|
* If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
|
|
75037
|
-
* If
|
|
75276
|
+
* If MFA verification has not been completed for the session and the operation requires a confirmed session, this value is `mfa_required_for_caller`.
|
|
75277
|
+
* This includes turning on `requireMfa` and resetting MFA for a user.
|
|
75038
75278
|
* 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`.
|
|
75039
75279
|
*/
|
|
75040
75280
|
error?: string;
|
|
@@ -85028,6 +85268,61 @@ export interface reportsComponents {
|
|
|
85028
85268
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
85029
85269
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
85030
85270
|
};
|
|
85271
|
+
/** API key that a member of the organization owns. */
|
|
85272
|
+
OrganizationApiKey: {
|
|
85273
|
+
/** ID of the API key. */
|
|
85274
|
+
id: string;
|
|
85275
|
+
/** API key description. */
|
|
85276
|
+
description: string;
|
|
85277
|
+
/** Type of API key. */
|
|
85278
|
+
type: "secret" | "publishable";
|
|
85279
|
+
/**
|
|
85280
|
+
* Permissions of the API key that apply to the organization.
|
|
85281
|
+
* Permissions that apply only to other organizations are not included,
|
|
85282
|
+
* and an `organizationId` scope lists only the ID of the organization.
|
|
85283
|
+
* For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
|
|
85284
|
+
*/
|
|
85285
|
+
acl?: reportsComponents["schemas"]["Acl"];
|
|
85286
|
+
allowedIps?: reportsComponents["schemas"]["AllowedIps"];
|
|
85287
|
+
/**
|
|
85288
|
+
* Date and time when the API key last authenticated a request.
|
|
85289
|
+
* This value is updated at most once every 5 minutes.
|
|
85290
|
+
* This value is `null` if the API key has no recorded use.
|
|
85291
|
+
*/
|
|
85292
|
+
lastUsedTime?: string | null;
|
|
85293
|
+
/**
|
|
85294
|
+
* IP address of the request that last updated `lastUsedTime`.
|
|
85295
|
+
* This value is `null` if the API key has no recorded use.
|
|
85296
|
+
*/
|
|
85297
|
+
lastUsedIp?: string | null;
|
|
85298
|
+
/**
|
|
85299
|
+
* Date and time when the API key expires.
|
|
85300
|
+
* From this time, a request that uses the API key gets a `401` response.
|
|
85301
|
+
* This value is `null` if the API key does not expire.
|
|
85302
|
+
*/
|
|
85303
|
+
expirationTime?: string | null;
|
|
85304
|
+
/** API user name. */
|
|
85305
|
+
apiUser: string;
|
|
85306
|
+
/**
|
|
85307
|
+
* Value of the API key.
|
|
85308
|
+
* For a secret key, this operation returns a masked value that keeps only the prefix and the `apiUser` value.
|
|
85309
|
+
* For a publishable key, the value is the full key.
|
|
85310
|
+
*/
|
|
85311
|
+
secretKey: string;
|
|
85312
|
+
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
85313
|
+
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
85314
|
+
/** Member of the organization who owns the API key. */
|
|
85315
|
+
owner: {
|
|
85316
|
+
/** ID of the user. */
|
|
85317
|
+
id: string;
|
|
85318
|
+
/** Email address of the user. */
|
|
85319
|
+
email: string;
|
|
85320
|
+
/** First name of the user. */
|
|
85321
|
+
firstName: string;
|
|
85322
|
+
/** Last name of the user. */
|
|
85323
|
+
lastName: string;
|
|
85324
|
+
};
|
|
85325
|
+
};
|
|
85031
85326
|
ChargeTransaction: {
|
|
85032
85327
|
/** ID of the balance transaction. */
|
|
85033
85328
|
id?: string;
|
|
@@ -93224,9 +93519,7 @@ export interface reportsComponents {
|
|
|
93224
93519
|
computedAllowedIps?: string[] | null;
|
|
93225
93520
|
/**
|
|
93226
93521
|
* Specifies if the user has multi-factor authentication (MFA) set up.
|
|
93227
|
-
* This
|
|
93228
|
-
* for an organization that has [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings),
|
|
93229
|
-
* and is omitted for Rebilly staff.
|
|
93522
|
+
* This field is included in the response for users in the current organization and omitted for Rebilly staff.
|
|
93230
93523
|
* This value is `null` when this information is temporarily unavailable.
|
|
93231
93524
|
*/
|
|
93232
93525
|
mfaEnabled?: boolean | null;
|
|
@@ -103234,6 +103527,9 @@ declare module "rebilly-js-sdk" {
|
|
|
103234
103527
|
export type PutApiKeyResponsePromise = rebilly.PutApiKeyResponsePromise;
|
|
103235
103528
|
export type DeleteApiKeyResponse = rebilly.DeleteApiKeyResponse;
|
|
103236
103529
|
export type DeleteApiKeyResponsePromise = rebilly.DeleteApiKeyResponsePromise;
|
|
103530
|
+
export type GetOrganizationApiKeyCollectionRequest = rebilly.GetOrganizationApiKeyCollectionRequest;
|
|
103531
|
+
export type GetOrganizationApiKeyCollectionResponse = rebilly.GetOrganizationApiKeyCollectionResponse;
|
|
103532
|
+
export type GetOrganizationApiKeyCollectionResponsePromise = rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
103237
103533
|
export type GetBalanceTransactionCollectionRequest = rebilly.GetBalanceTransactionCollectionRequest;
|
|
103238
103534
|
export type GetBalanceTransactionCollectionResponse = rebilly.GetBalanceTransactionCollectionResponse;
|
|
103239
103535
|
export type GetBalanceTransactionCollectionResponsePromise = rebilly.GetBalanceTransactionCollectionResponsePromise;
|
|
@@ -103743,6 +104039,8 @@ declare module "rebilly-js-sdk" {
|
|
|
103743
104039
|
export type PutUserRequest = rebilly.PutUserRequest;
|
|
103744
104040
|
export type PutUserResponse = rebilly.PutUserResponse;
|
|
103745
104041
|
export type PutUserResponsePromise = rebilly.PutUserResponsePromise;
|
|
104042
|
+
export type PostUserMfaResetResponse = rebilly.PostUserMfaResetResponse;
|
|
104043
|
+
export type PostUserMfaResetResponsePromise = rebilly.PostUserMfaResetResponsePromise;
|
|
103746
104044
|
export type GetWebhookCollectionRequest = rebilly.GetWebhookCollectionRequest;
|
|
103747
104045
|
export type GetWebhookCollectionResponse = rebilly.GetWebhookCollectionResponse;
|
|
103748
104046
|
export type GetWebhookCollectionResponsePromise = rebilly.GetWebhookCollectionResponsePromise;
|
|
@@ -105553,6 +105851,13 @@ declare module "resources/orders-resource" {
|
|
|
105553
105851
|
}): any;
|
|
105554
105852
|
};
|
|
105555
105853
|
}
|
|
105854
|
+
declare module "resources/organization-api-keys-resource" {
|
|
105855
|
+
export default function OrganizationApiKeysResource({ apiHandler }: {
|
|
105856
|
+
apiHandler: any;
|
|
105857
|
+
}): {
|
|
105858
|
+
getAll({ filter, sort, limit, offset }?: rebilly.GetOrganizationApiKeyCollectionRequest): rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
105859
|
+
};
|
|
105860
|
+
}
|
|
105556
105861
|
declare module "resources/organization-exports-resource" {
|
|
105557
105862
|
export default function OrganizationExportsResource({ apiHandler }: {
|
|
105558
105863
|
apiHandler: any;
|
|
@@ -106364,6 +106669,9 @@ declare module "resources/users-resource" {
|
|
|
106364
106669
|
id: any;
|
|
106365
106670
|
data: any;
|
|
106366
106671
|
}): rebilly.PutUserResponsePromise;
|
|
106672
|
+
resetMfa({ id }: {
|
|
106673
|
+
id: any;
|
|
106674
|
+
}): any;
|
|
106367
106675
|
};
|
|
106368
106676
|
}
|
|
106369
106677
|
declare module "resources/webhook-events-resource" {
|
|
@@ -107394,6 +107702,9 @@ declare module "resources/api-instance" {
|
|
|
107394
107702
|
data: any;
|
|
107395
107703
|
}): any;
|
|
107396
107704
|
};
|
|
107705
|
+
organizationApiKeys: {
|
|
107706
|
+
getAll({ filter, sort, limit, offset }?: rebilly.GetOrganizationApiKeyCollectionRequest): rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
107707
|
+
};
|
|
107397
107708
|
organizationExports: {
|
|
107398
107709
|
getAll({ limit, offset, filter, q, sort, }?: rebilly.GetOrganizationExportCollectionRequest): rebilly.GetOrganizationExportCollectionResponsePromise;
|
|
107399
107710
|
create({ data }: {
|
|
@@ -108038,6 +108349,9 @@ declare module "resources/api-instance" {
|
|
|
108038
108349
|
id: any;
|
|
108039
108350
|
data: any;
|
|
108040
108351
|
}): rebilly.PutUserResponsePromise;
|
|
108352
|
+
resetMfa({ id }: {
|
|
108353
|
+
id: any;
|
|
108354
|
+
}): any;
|
|
108041
108355
|
};
|
|
108042
108356
|
webhookEvents: {
|
|
108043
108357
|
getAll({ limit, offset, filter, q }?: rebilly.GetWebhookEventCollectionRequest): rebilly.GetWebhookEventCollectionResponsePromise;
|