@gpt-core/admin 0.10.1 → 0.10.12
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/dist/index.d.mts +39 -2
- package/dist/index.d.ts +39 -2
- package/llms.txt +7 -33
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -330,10 +330,22 @@ type Wallet = {
|
|
|
330
330
|
* Field included by default.
|
|
331
331
|
*/
|
|
332
332
|
credits_paid?: number | null | unknown;
|
|
333
|
+
/**
|
|
334
|
+
* Total promotional credits ever allocated to this tenant. Field included by default.
|
|
335
|
+
*/
|
|
336
|
+
credits_promotional_allocated?: number | null | unknown;
|
|
337
|
+
/**
|
|
338
|
+
* Total purchased credits ever allocated to this tenant. Field included by default.
|
|
339
|
+
*/
|
|
340
|
+
credits_purchased_allocated?: number | null | unknown;
|
|
333
341
|
/**
|
|
334
342
|
* Field included by default.
|
|
335
343
|
*/
|
|
336
344
|
credits_subscription?: number | null | unknown;
|
|
345
|
+
/**
|
|
346
|
+
* Total subscription credits ever allocated to this tenant. Field included by default.
|
|
347
|
+
*/
|
|
348
|
+
credits_subscription_allocated?: number | null | unknown;
|
|
337
349
|
/**
|
|
338
350
|
* Field included by default.
|
|
339
351
|
*/
|
|
@@ -6093,6 +6105,18 @@ type ExtractionDocument = {
|
|
|
6093
6105
|
type: string;
|
|
6094
6106
|
} | null;
|
|
6095
6107
|
};
|
|
6108
|
+
extraction_results?: {
|
|
6109
|
+
/**
|
|
6110
|
+
* Relationship data for extraction_results
|
|
6111
|
+
*/
|
|
6112
|
+
data?: Array<{
|
|
6113
|
+
id: string;
|
|
6114
|
+
meta?: {
|
|
6115
|
+
[key: string]: unknown;
|
|
6116
|
+
};
|
|
6117
|
+
type: string;
|
|
6118
|
+
}>;
|
|
6119
|
+
};
|
|
6096
6120
|
};
|
|
6097
6121
|
type: string;
|
|
6098
6122
|
};
|
|
@@ -7563,6 +7587,16 @@ type GetAdminLedgerByAccountByAccountIdData = {
|
|
|
7563
7587
|
account_id: string;
|
|
7564
7588
|
};
|
|
7565
7589
|
query?: {
|
|
7590
|
+
/**
|
|
7591
|
+
* JSON:API filter parameters (use flat query string format: filter[field][operator]=value)
|
|
7592
|
+
*/
|
|
7593
|
+
filter?: {
|
|
7594
|
+
[key: string]: unknown;
|
|
7595
|
+
};
|
|
7596
|
+
/**
|
|
7597
|
+
* Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas.
|
|
7598
|
+
*/
|
|
7599
|
+
sort?: string;
|
|
7566
7600
|
/**
|
|
7567
7601
|
* Include related resources in the response. Comma-separated list of relationship names to eager-load.
|
|
7568
7602
|
*/
|
|
@@ -7612,7 +7646,10 @@ type GetAdminLedgerByAccountByAccountIdResponses = {
|
|
|
7612
7646
|
* Success
|
|
7613
7647
|
*/
|
|
7614
7648
|
200: {
|
|
7615
|
-
|
|
7649
|
+
/**
|
|
7650
|
+
* An array of resource objects representing a ledger
|
|
7651
|
+
*/
|
|
7652
|
+
data?: Array<Ledger>;
|
|
7616
7653
|
included?: Array<unknown>;
|
|
7617
7654
|
meta?: {
|
|
7618
7655
|
[key: string]: unknown;
|
|
@@ -24040,8 +24077,8 @@ type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugData = {
|
|
|
24040
24077
|
"x-application-key": string;
|
|
24041
24078
|
};
|
|
24042
24079
|
path: {
|
|
24043
|
-
slug: string;
|
|
24044
24080
|
application_id: string;
|
|
24081
|
+
slug: string;
|
|
24045
24082
|
};
|
|
24046
24083
|
query?: {
|
|
24047
24084
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -330,10 +330,22 @@ type Wallet = {
|
|
|
330
330
|
* Field included by default.
|
|
331
331
|
*/
|
|
332
332
|
credits_paid?: number | null | unknown;
|
|
333
|
+
/**
|
|
334
|
+
* Total promotional credits ever allocated to this tenant. Field included by default.
|
|
335
|
+
*/
|
|
336
|
+
credits_promotional_allocated?: number | null | unknown;
|
|
337
|
+
/**
|
|
338
|
+
* Total purchased credits ever allocated to this tenant. Field included by default.
|
|
339
|
+
*/
|
|
340
|
+
credits_purchased_allocated?: number | null | unknown;
|
|
333
341
|
/**
|
|
334
342
|
* Field included by default.
|
|
335
343
|
*/
|
|
336
344
|
credits_subscription?: number | null | unknown;
|
|
345
|
+
/**
|
|
346
|
+
* Total subscription credits ever allocated to this tenant. Field included by default.
|
|
347
|
+
*/
|
|
348
|
+
credits_subscription_allocated?: number | null | unknown;
|
|
337
349
|
/**
|
|
338
350
|
* Field included by default.
|
|
339
351
|
*/
|
|
@@ -6093,6 +6105,18 @@ type ExtractionDocument = {
|
|
|
6093
6105
|
type: string;
|
|
6094
6106
|
} | null;
|
|
6095
6107
|
};
|
|
6108
|
+
extraction_results?: {
|
|
6109
|
+
/**
|
|
6110
|
+
* Relationship data for extraction_results
|
|
6111
|
+
*/
|
|
6112
|
+
data?: Array<{
|
|
6113
|
+
id: string;
|
|
6114
|
+
meta?: {
|
|
6115
|
+
[key: string]: unknown;
|
|
6116
|
+
};
|
|
6117
|
+
type: string;
|
|
6118
|
+
}>;
|
|
6119
|
+
};
|
|
6096
6120
|
};
|
|
6097
6121
|
type: string;
|
|
6098
6122
|
};
|
|
@@ -7563,6 +7587,16 @@ type GetAdminLedgerByAccountByAccountIdData = {
|
|
|
7563
7587
|
account_id: string;
|
|
7564
7588
|
};
|
|
7565
7589
|
query?: {
|
|
7590
|
+
/**
|
|
7591
|
+
* JSON:API filter parameters (use flat query string format: filter[field][operator]=value)
|
|
7592
|
+
*/
|
|
7593
|
+
filter?: {
|
|
7594
|
+
[key: string]: unknown;
|
|
7595
|
+
};
|
|
7596
|
+
/**
|
|
7597
|
+
* Sort results by one or more fields. Prefix with '-' for descending order. Separate multiple fields with commas.
|
|
7598
|
+
*/
|
|
7599
|
+
sort?: string;
|
|
7566
7600
|
/**
|
|
7567
7601
|
* Include related resources in the response. Comma-separated list of relationship names to eager-load.
|
|
7568
7602
|
*/
|
|
@@ -7612,7 +7646,10 @@ type GetAdminLedgerByAccountByAccountIdResponses = {
|
|
|
7612
7646
|
* Success
|
|
7613
7647
|
*/
|
|
7614
7648
|
200: {
|
|
7615
|
-
|
|
7649
|
+
/**
|
|
7650
|
+
* An array of resource objects representing a ledger
|
|
7651
|
+
*/
|
|
7652
|
+
data?: Array<Ledger>;
|
|
7616
7653
|
included?: Array<unknown>;
|
|
7617
7654
|
meta?: {
|
|
7618
7655
|
[key: string]: unknown;
|
|
@@ -24040,8 +24077,8 @@ type GetAdminApplicationsByApplicationIdEmailTemplatesBySlugData = {
|
|
|
24040
24077
|
"x-application-key": string;
|
|
24041
24078
|
};
|
|
24042
24079
|
path: {
|
|
24043
|
-
slug: string;
|
|
24044
24080
|
application_id: string;
|
|
24081
|
+
slug: string;
|
|
24045
24082
|
};
|
|
24046
24083
|
query?: {
|
|
24047
24084
|
/**
|
package/llms.txt
CHANGED
|
@@ -23,39 +23,6 @@ client.setConfig({
|
|
|
23
23
|
});
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
## API Versioning
|
|
27
|
-
|
|
28
|
-
The SDK sends an API version header with every request.
|
|
29
|
-
Default version: 2025-12-03
|
|
30
|
-
|
|
31
|
-
### Configuration
|
|
32
|
-
|
|
33
|
-
```typescript
|
|
34
|
-
import { GptAdmin, DEFAULT_API_VERSION } from '@gpt-core/admin';
|
|
35
|
-
|
|
36
|
-
// Use SDK default version
|
|
37
|
-
const client = new GptAdmin({ baseUrl, apiKey });
|
|
38
|
-
|
|
39
|
-
// Pin to specific version (recommended for production)
|
|
40
|
-
const client = new GptAdmin({ baseUrl, apiKey, apiVersion: '2025-12-03' });
|
|
41
|
-
|
|
42
|
-
// Read effective version
|
|
43
|
-
client.apiVersion // "2025-12-03"
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Config Options
|
|
47
|
-
|
|
48
|
-
- `baseUrl` (string) - API base URL
|
|
49
|
-
- `token` (string) - User JWT for Bearer auth
|
|
50
|
-
- `apiKey` (string) - Application key for x-application-key header
|
|
51
|
-
- `applicationId` (string) - Application ID for scoped admin operations
|
|
52
|
-
- `retry` (object|false) - Retry config or disable
|
|
53
|
-
- `apiVersion` (string) - API version date, defaults to DEFAULT_API_VERSION
|
|
54
|
-
|
|
55
|
-
### Response Header
|
|
56
|
-
|
|
57
|
-
Every response includes: `x-api-version: 2025-12-03`
|
|
58
|
-
|
|
59
26
|
## Accounts
|
|
60
27
|
|
|
61
28
|
- `getAccounts()` - List accounts
|
|
@@ -506,6 +473,13 @@ Every response includes: `x-api-version: 2025-12-03`
|
|
|
506
473
|
- `postPricing-strategies()` - Create pricing strategies
|
|
507
474
|
- `patchPricing-strategiesById()` - Update pricing strategies
|
|
508
475
|
|
|
476
|
+
## Role
|
|
477
|
+
|
|
478
|
+
- `getRoles()` - List roles
|
|
479
|
+
- `postRoles()` - Create roles
|
|
480
|
+
- `patchRolesById()` - Update roles
|
|
481
|
+
- `deleteRolesById()` - Delete roles
|
|
482
|
+
|
|
509
483
|
## Schema discovery
|
|
510
484
|
|
|
511
485
|
- `getExtractionSchema-discoveriesById()` - Get schema discoveries
|