rebilly-js-sdk 62.248.0 → 62.248.2
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 +4 -2
- package/dist/rebilly-js-sdk.d.cts +240 -0
- package/dist/rebilly-js-sdk.d.mts +240 -0
- package/dist/rebilly-js-sdk.d.ts +240 -0
- package/dist/rebilly-js-sdk.es.mjs +127 -116
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +2 -2
- package/src/resources/api-instance.js +2 -0
- package/src/resources/organization-api-keys-resource.js +17 -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]
|
|
@@ -4685,6 +4690,17 @@ export interface corePaths {
|
|
|
4685
4690
|
};
|
|
4686
4691
|
};
|
|
4687
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
|
+
};
|
|
4688
4704
|
"/balance-transactions": {
|
|
4689
4705
|
/**
|
|
4690
4706
|
* Retrieves a list of balance transactions.
|
|
@@ -16374,6 +16390,61 @@ export interface coreComponents {
|
|
|
16374
16390
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16375
16391
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
16376
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
|
+
};
|
|
16377
16448
|
ChargeTransaction: {
|
|
16378
16449
|
/** ID of the balance transaction. */
|
|
16379
16450
|
id?: string;
|
|
@@ -40595,6 +40666,52 @@ export interface operations {
|
|
|
40595
40666
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
40596
40667
|
};
|
|
40597
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
|
+
};
|
|
40598
40715
|
/**
|
|
40599
40716
|
* Retrieves a list of balance transactions.
|
|
40600
40717
|
*
|
|
@@ -57183,6 +57300,61 @@ export interface storefrontComponents {
|
|
|
57183
57300
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
57184
57301
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
57185
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
|
+
};
|
|
57186
57358
|
ChargeTransaction: {
|
|
57187
57359
|
/** ID of the balance transaction. */
|
|
57188
57360
|
id?: string;
|
|
@@ -85096,6 +85268,61 @@ export interface reportsComponents {
|
|
|
85096
85268
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
85097
85269
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
85098
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
|
+
};
|
|
85099
85326
|
ChargeTransaction: {
|
|
85100
85327
|
/** ID of the balance transaction. */
|
|
85101
85328
|
id?: string;
|
|
@@ -103300,6 +103527,9 @@ declare module "rebilly-js-sdk" {
|
|
|
103300
103527
|
export type PutApiKeyResponsePromise = rebilly.PutApiKeyResponsePromise;
|
|
103301
103528
|
export type DeleteApiKeyResponse = rebilly.DeleteApiKeyResponse;
|
|
103302
103529
|
export type DeleteApiKeyResponsePromise = rebilly.DeleteApiKeyResponsePromise;
|
|
103530
|
+
export type GetOrganizationApiKeyCollectionRequest = rebilly.GetOrganizationApiKeyCollectionRequest;
|
|
103531
|
+
export type GetOrganizationApiKeyCollectionResponse = rebilly.GetOrganizationApiKeyCollectionResponse;
|
|
103532
|
+
export type GetOrganizationApiKeyCollectionResponsePromise = rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
103303
103533
|
export type GetBalanceTransactionCollectionRequest = rebilly.GetBalanceTransactionCollectionRequest;
|
|
103304
103534
|
export type GetBalanceTransactionCollectionResponse = rebilly.GetBalanceTransactionCollectionResponse;
|
|
103305
103535
|
export type GetBalanceTransactionCollectionResponsePromise = rebilly.GetBalanceTransactionCollectionResponsePromise;
|
|
@@ -105621,6 +105851,13 @@ declare module "resources/orders-resource" {
|
|
|
105621
105851
|
}): any;
|
|
105622
105852
|
};
|
|
105623
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
|
+
}
|
|
105624
105861
|
declare module "resources/organization-exports-resource" {
|
|
105625
105862
|
export default function OrganizationExportsResource({ apiHandler }: {
|
|
105626
105863
|
apiHandler: any;
|
|
@@ -107465,6 +107702,9 @@ declare module "resources/api-instance" {
|
|
|
107465
107702
|
data: any;
|
|
107466
107703
|
}): any;
|
|
107467
107704
|
};
|
|
107705
|
+
organizationApiKeys: {
|
|
107706
|
+
getAll({ filter, sort, limit, offset }?: rebilly.GetOrganizationApiKeyCollectionRequest): rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
107707
|
+
};
|
|
107468
107708
|
organizationExports: {
|
|
107469
107709
|
getAll({ limit, offset, filter, q, sort, }?: rebilly.GetOrganizationExportCollectionRequest): rebilly.GetOrganizationExportCollectionResponsePromise;
|
|
107470
107710
|
create({ data }: {
|
|
@@ -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]
|
|
@@ -4685,6 +4690,17 @@ export interface corePaths {
|
|
|
4685
4690
|
};
|
|
4686
4691
|
};
|
|
4687
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
|
+
};
|
|
4688
4704
|
"/balance-transactions": {
|
|
4689
4705
|
/**
|
|
4690
4706
|
* Retrieves a list of balance transactions.
|
|
@@ -16374,6 +16390,61 @@ export interface coreComponents {
|
|
|
16374
16390
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
16375
16391
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
16376
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
|
+
};
|
|
16377
16448
|
ChargeTransaction: {
|
|
16378
16449
|
/** ID of the balance transaction. */
|
|
16379
16450
|
id?: string;
|
|
@@ -40595,6 +40666,52 @@ export interface operations {
|
|
|
40595
40666
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
40596
40667
|
};
|
|
40597
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
|
+
};
|
|
40598
40715
|
/**
|
|
40599
40716
|
* Retrieves a list of balance transactions.
|
|
40600
40717
|
*
|
|
@@ -57183,6 +57300,61 @@ export interface storefrontComponents {
|
|
|
57183
57300
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
57184
57301
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
57185
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
|
+
};
|
|
57186
57358
|
ChargeTransaction: {
|
|
57187
57359
|
/** ID of the balance transaction. */
|
|
57188
57360
|
id?: string;
|
|
@@ -85096,6 +85268,61 @@ export interface reportsComponents {
|
|
|
85096
85268
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
85097
85269
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
85098
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
|
+
};
|
|
85099
85326
|
ChargeTransaction: {
|
|
85100
85327
|
/** ID of the balance transaction. */
|
|
85101
85328
|
id?: string;
|
|
@@ -103300,6 +103527,9 @@ declare module "rebilly-js-sdk" {
|
|
|
103300
103527
|
export type PutApiKeyResponsePromise = rebilly.PutApiKeyResponsePromise;
|
|
103301
103528
|
export type DeleteApiKeyResponse = rebilly.DeleteApiKeyResponse;
|
|
103302
103529
|
export type DeleteApiKeyResponsePromise = rebilly.DeleteApiKeyResponsePromise;
|
|
103530
|
+
export type GetOrganizationApiKeyCollectionRequest = rebilly.GetOrganizationApiKeyCollectionRequest;
|
|
103531
|
+
export type GetOrganizationApiKeyCollectionResponse = rebilly.GetOrganizationApiKeyCollectionResponse;
|
|
103532
|
+
export type GetOrganizationApiKeyCollectionResponsePromise = rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
103303
103533
|
export type GetBalanceTransactionCollectionRequest = rebilly.GetBalanceTransactionCollectionRequest;
|
|
103304
103534
|
export type GetBalanceTransactionCollectionResponse = rebilly.GetBalanceTransactionCollectionResponse;
|
|
103305
103535
|
export type GetBalanceTransactionCollectionResponsePromise = rebilly.GetBalanceTransactionCollectionResponsePromise;
|
|
@@ -105621,6 +105851,13 @@ declare module "resources/orders-resource" {
|
|
|
105621
105851
|
}): any;
|
|
105622
105852
|
};
|
|
105623
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
|
+
}
|
|
105624
105861
|
declare module "resources/organization-exports-resource" {
|
|
105625
105862
|
export default function OrganizationExportsResource({ apiHandler }: {
|
|
105626
105863
|
apiHandler: any;
|
|
@@ -107465,6 +107702,9 @@ declare module "resources/api-instance" {
|
|
|
107465
107702
|
data: any;
|
|
107466
107703
|
}): any;
|
|
107467
107704
|
};
|
|
107705
|
+
organizationApiKeys: {
|
|
107706
|
+
getAll({ filter, sort, limit, offset }?: rebilly.GetOrganizationApiKeyCollectionRequest): rebilly.GetOrganizationApiKeyCollectionResponsePromise;
|
|
107707
|
+
};
|
|
107468
107708
|
organizationExports: {
|
|
107469
107709
|
getAll({ limit, offset, filter, q, sort, }?: rebilly.GetOrganizationExportCollectionRequest): rebilly.GetOrganizationExportCollectionResponsePromise;
|
|
107470
107710
|
create({ data }: {
|