@madewithremy/admin 0.1.52 → 0.1.54
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 +22 -0
- package/README.md +21 -0
- package/dist/index.d.ts +171 -29
- package/dist/index.js +142 -60
- package/dist/index.js.map +1 -1
- package/dist/prod.js +84 -13
- package/package.json +9 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,28 @@ What changed in `@madewithremy/admin`, newest first, each version under its own
|
|
|
4
4
|
|
|
5
5
|
Versions before 0.1.44 aren't recorded here.
|
|
6
6
|
|
|
7
|
+
## 0.1.54
|
|
8
|
+
|
|
9
|
+
### New
|
|
10
|
+
|
|
11
|
+
- Inside an app's own method, `createAdminClient()` with no key runs as the method's own run, on its own app: no workspace key in the app's secrets. The method declares what it may do with `"adminPermissions"` on its `mindstudio.json` entry (`analytics.view`, `usage.view`, `voice.manage` and the rest, listed on `createAdminClient` and at the end of `remy-admin --help`). A call it doesn't declare fails with `admin_permission_required:<name>` (403), `users.manage` from a dev or preview run with `admin_permission_live_only:users.manage`, and another app with `app_credential_wrong_app`. `@mindstudio-ai/agent` is an optional peer, the app's own copy, which the client reads the run from.
|
|
12
|
+
- `remy-admin usage summary [--start] [--end] [--by method|model|step]` (`admin.usage.summary`): what the app costs to run over a window, in dollars, builds left out.
|
|
13
|
+
|
|
14
|
+
### Changed behavior
|
|
15
|
+
|
|
16
|
+
- A client resolves its credential on each call: a key passed in, then the running method's own run, then `MINDSTUDIO_API_KEY`. Bound operations all return promises, and `client.context` is null when neither the options nor the environment name a key. Code that read `client.context` should allow for null.
|
|
17
|
+
- An app that bought numbers from a method with a workspace key kept as a secret can drop the key: declare `"adminPermissions": ["voice.manage"]` on the method and call `createAdminClient()` with no options.
|
|
18
|
+
|
|
19
|
+
## 0.1.53
|
|
20
|
+
|
|
21
|
+
### Changed behavior
|
|
22
|
+
|
|
23
|
+
- `remy-admin voice numbers buy` (`admin.voice.numbersBuy`) buys a number for an app that already has one: an app can hold several, one per tenant say, and app code can buy, list and release them through `createAdminClient`. The limit is the workspace's, 10 numbers across its apps unless support raised it, and a buy past it is refused with `phone_number_limit_reached` (422). `number_already_assigned` is gone, so code that branched on it should branch on `phone_number_limit_reached` instead.
|
|
24
|
+
|
|
25
|
+
### Fixed
|
|
26
|
+
|
|
27
|
+
- The voice ops' docs give `number_unavailable`, `telnyx_not_configured`, `order_in_progress` and `number_not_active` their real status, 412.
|
|
28
|
+
|
|
7
29
|
## 0.1.52
|
|
8
30
|
|
|
9
31
|
### New
|
package/README.md
CHANGED
|
@@ -58,6 +58,27 @@ try {
|
|
|
58
58
|
}
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
+
### Inside an app's own method
|
|
62
|
+
|
|
63
|
+
A Remy app's method can manage its own app with no key. Declare what it may do as `adminPermissions` on the method's entry in `mindstudio.json` (the list is on `createAdminClient`), then create the client with no options:
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{ "id": "admin-dashboard", "path": "dist/methods/src/adminDashboard.ts", "export": "adminDashboard", "adminPermissions": ["analytics.view", "usage.view"] }
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
import { createAdminClient } from '@madewithremy/admin';
|
|
71
|
+
const admin = createAdminClient();
|
|
72
|
+
|
|
73
|
+
export async function adminDashboard() {
|
|
74
|
+
const live = await admin.analytics.live();
|
|
75
|
+
const spend = await admin.usage.summary({ startTime, endTime, groupBy: 'method' });
|
|
76
|
+
return { live, spend };
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Each call runs as the method's own run (its hook token, from `@mindstudio-ai/agent`'s request context), on the method's own app, so a client made at module scope follows every execution. A call the method doesn't declare an admin permission for fails with `admin_permission_required:<name>`; another app is `app_credential_wrong_app`, and needs a key. A key passed in always wins, and outside a method the client falls back to the environment, as above.
|
|
81
|
+
|
|
61
82
|
Every response is fully typed (the shapes are hand-transcribed from the platform API). Failures throw `AdminApiError` (method/path/status/body) or `AdminTimeoutError`. Long-running composites take an `onProgress` callback (`releases.waitForCommit`, `dataSources.addDocument` / `waitForIngest`, `files.put`). The SSE/NDJSON streaming paths (`methods invoke --stream`, `jewels export --file`) are CLI-only.
|
|
62
83
|
|
|
63
84
|
## Development
|
package/dist/index.d.ts
CHANGED
|
@@ -5873,7 +5873,7 @@ declare function ls$1(ctx: AdminContext, params: FilesLsParams): Promise<FilesLs
|
|
|
5873
5873
|
* @example
|
|
5874
5874
|
* const { stores, totalObjects } = await admin.files.summary();
|
|
5875
5875
|
*/
|
|
5876
|
-
declare function summary(ctx: AdminContext): Promise<FilesListResult>;
|
|
5876
|
+
declare function summary$1(ctx: AdminContext): Promise<FilesListResult>;
|
|
5877
5877
|
/**
|
|
5878
5878
|
* Delete one object from a store.
|
|
5879
5879
|
*
|
|
@@ -5893,9 +5893,8 @@ declare const files_put: typeof put;
|
|
|
5893
5893
|
declare const files_remove: typeof remove;
|
|
5894
5894
|
declare const files_sign: typeof sign;
|
|
5895
5895
|
declare const files_stat: typeof stat;
|
|
5896
|
-
declare const files_summary: typeof summary;
|
|
5897
5896
|
declare namespace files {
|
|
5898
|
-
export { files_fetchBytes as fetchBytes, ls$1 as ls, files_put as put, files_remove as remove, files_sign as sign, files_stat as stat,
|
|
5897
|
+
export { files_fetchBytes as fetchBytes, ls$1 as ls, files_put as put, files_remove as remove, files_sign as sign, files_stat as stat, summary$1 as summary };
|
|
5899
5898
|
export type { files_FileAccess as FileAccess, files_FileRef as FileRef, files_FilesLsParams as FilesLsParams, files_FilesPutParams as FilesPutParams };
|
|
5900
5899
|
}
|
|
5901
5900
|
|
|
@@ -8530,6 +8529,82 @@ declare namespace settings {
|
|
|
8530
8529
|
};
|
|
8531
8530
|
}
|
|
8532
8531
|
|
|
8532
|
+
/**
|
|
8533
|
+
* Response types for an app's runtime cost.
|
|
8534
|
+
*
|
|
8535
|
+
* Transcribed from the api (apps/api/src/):
|
|
8536
|
+
* roles/http/routes/Apps/manage/usage.ts — the route and its shape
|
|
8537
|
+
*/
|
|
8538
|
+
/** How the spend is broken down. */
|
|
8539
|
+
type UsageGroupBy = 'method' | 'model' | 'step';
|
|
8540
|
+
/** One row of the breakdown. */
|
|
8541
|
+
interface UsageGroup {
|
|
8542
|
+
/** The method's id, the model's id, or the step type. */
|
|
8543
|
+
key: string;
|
|
8544
|
+
/** What it cost over the window, in dollars. */
|
|
8545
|
+
costDollars: number;
|
|
8546
|
+
requests: number;
|
|
8547
|
+
/** Failed requests; absent for a model row. */
|
|
8548
|
+
errors?: number;
|
|
8549
|
+
/** For a model row, its type (`text`, `image`, …). */
|
|
8550
|
+
modelType?: string;
|
|
8551
|
+
}
|
|
8552
|
+
interface UsageSummaryResult {
|
|
8553
|
+
groupBy: UsageGroupBy;
|
|
8554
|
+
startTime: string;
|
|
8555
|
+
endTime: string;
|
|
8556
|
+
/** The window's total, in dollars. */
|
|
8557
|
+
totalCostDollars: number;
|
|
8558
|
+
/** Most expensive first. */
|
|
8559
|
+
groups: UsageGroup[];
|
|
8560
|
+
}
|
|
8561
|
+
|
|
8562
|
+
/**
|
|
8563
|
+
* Usage operations: what the app costs to run.
|
|
8564
|
+
*
|
|
8565
|
+
* Ops are pure: (ctx, params) → typed result, throwing AdminApiError /
|
|
8566
|
+
* AdminTimeoutError. No printing, no process coupling — the CLI skin in
|
|
8567
|
+
* commands/usage.ts and the importable client both call these.
|
|
8568
|
+
*/
|
|
8569
|
+
|
|
8570
|
+
interface UsageSummaryParams {
|
|
8571
|
+
/** Window start, ISO 8601. */
|
|
8572
|
+
startTime: string;
|
|
8573
|
+
/** Window end, ISO 8601, after `startTime`. */
|
|
8574
|
+
endTime: string;
|
|
8575
|
+
/**
|
|
8576
|
+
* The breakdown (default `method`): `method` is the spend each method
|
|
8577
|
+
* drove, `model` the models' share, `step` the whole spend by action,
|
|
8578
|
+
* models and everything else.
|
|
8579
|
+
*/
|
|
8580
|
+
groupBy?: UsageGroupBy;
|
|
8581
|
+
}
|
|
8582
|
+
/**
|
|
8583
|
+
* The app's runtime spend over a window, broken down one way, in dollars.
|
|
8584
|
+
* Builds (Remy's own work on the app) aren't counted.
|
|
8585
|
+
*
|
|
8586
|
+
* In a method, needs the `usage.view` admin permission.
|
|
8587
|
+
*
|
|
8588
|
+
* @throws AdminApiError `invalid_window` (400) — a date that doesn't parse, or
|
|
8589
|
+
* an end not after the start; `invalid_group_by` (400);
|
|
8590
|
+
* `admin_permission_required:usage.view` (403) — a method that doesn't
|
|
8591
|
+
* declare it.
|
|
8592
|
+
* @example
|
|
8593
|
+
* const { totalCostDollars, groups } = await admin.usage.summary({
|
|
8594
|
+
* startTime: '2026-10-01T00:00:00Z',
|
|
8595
|
+
* endTime: '2026-11-01T00:00:00Z',
|
|
8596
|
+
* groupBy: 'method',
|
|
8597
|
+
* });
|
|
8598
|
+
*/
|
|
8599
|
+
declare function summary(ctx: AdminContext, params: UsageSummaryParams): Promise<UsageSummaryResult>;
|
|
8600
|
+
|
|
8601
|
+
type usage_UsageSummaryParams = UsageSummaryParams;
|
|
8602
|
+
declare const usage_summary: typeof summary;
|
|
8603
|
+
declare namespace usage {
|
|
8604
|
+
export { usage_summary as summary };
|
|
8605
|
+
export type { usage_UsageSummaryParams as UsageSummaryParams };
|
|
8606
|
+
}
|
|
8607
|
+
|
|
8533
8608
|
/**
|
|
8534
8609
|
* Response types for the v2 app users endpoints.
|
|
8535
8610
|
*
|
|
@@ -8888,7 +8963,7 @@ interface NumbersSearchParams {
|
|
|
8888
8963
|
*
|
|
8889
8964
|
* @throws AdminApiError `missing_search_filter` (400) — neither areaCode nor
|
|
8890
8965
|
* locality provided; `invalid_area_code` (400) — area code is not 3 digits;
|
|
8891
|
-
* `telnyx_not_configured` (
|
|
8966
|
+
* `telnyx_not_configured` (412) — phone numbers are not available on this
|
|
8892
8967
|
* platform host.
|
|
8893
8968
|
* @example
|
|
8894
8969
|
* const { results } = await admin.voice.numbersSearch({ areaCode: '310', limit: 5 });
|
|
@@ -8906,17 +8981,23 @@ interface NumbersBuyParams {
|
|
|
8906
8981
|
}
|
|
8907
8982
|
/**
|
|
8908
8983
|
* Buy and attach a dedicated phone number to the app ($1/month billed to the
|
|
8909
|
-
* workspace starting immediately —
|
|
8984
|
+
* workspace starting immediately — an agent acting for the user always
|
|
8985
|
+
* confirms with them first).
|
|
8910
8986
|
*
|
|
8911
|
-
* The number is
|
|
8912
|
-
*
|
|
8913
|
-
*
|
|
8987
|
+
* The number is an inbound line to the app's voice agent and a caller ID for
|
|
8988
|
+
* `voice.call()`. An app can hold several, one per tenant say, up to its
|
|
8989
|
+
* workspace's limit (10 unless support raised it), and the app's own methods
|
|
8990
|
+
* can buy and release them with this client by declaring the `voice.manage`
|
|
8991
|
+
* admin permission. A
|
|
8992
|
+
* `pending` status usually activates within seconds; poll `numbersList` to
|
|
8993
|
+
* confirm.
|
|
8914
8994
|
*
|
|
8915
8995
|
* @throws AdminApiError `invalid_phone_number` (400) — not a valid +1 E.164
|
|
8916
|
-
* US number; `
|
|
8917
|
-
*
|
|
8918
|
-
* `insufficient_credits/*` (402) — the workspace can't
|
|
8919
|
-
* `telnyx_not_configured` (
|
|
8996
|
+
* US number; `phone_number_limit_reached` (422) — the workspace holds as
|
|
8997
|
+
* many numbers as it may; `number_unavailable` (412) — the number is no
|
|
8998
|
+
* longer available; `insufficient_credits/*` (402) — the workspace can't
|
|
8999
|
+
* cover it; `telnyx_not_configured` (412) — phone numbers unavailable on
|
|
9000
|
+
* this host.
|
|
8920
9001
|
* @example
|
|
8921
9002
|
* const { number } = await admin.voice.numbersBuy({
|
|
8922
9003
|
* phoneNumber: '+13105551234',
|
|
@@ -8930,13 +9011,14 @@ declare function numbersBuy(ctx: AdminContext, params: NumbersBuyParams): Promis
|
|
|
8930
9011
|
* Release a dedicated phone number from the app (permanent).
|
|
8931
9012
|
*
|
|
8932
9013
|
* The monthly rental stops immediately (no refund for the current month),
|
|
8933
|
-
* the carrier quarantines the number for ~15 days, and
|
|
8934
|
-
* and
|
|
9014
|
+
* the carrier quarantines the number for ~15 days, and the number stops
|
|
9015
|
+
* ringing the app and can't be a `voice.call()` caller ID. The app's other
|
|
9016
|
+
* numbers are unaffected.
|
|
8935
9017
|
*
|
|
8936
9018
|
* @param e164 The phone number in E.164 or bare 10-digit US format.
|
|
8937
9019
|
* @throws Error `No phone number "${e164}" on this app` when not found;
|
|
8938
9020
|
* AdminApiError `number_not_found` (404) if the resolved id has gone stale;
|
|
8939
|
-
* `order_in_progress` (
|
|
9021
|
+
* `order_in_progress` (412) — the purchase is still settling, try again in
|
|
8940
9022
|
* a minute.
|
|
8941
9023
|
* @example
|
|
8942
9024
|
* await admin.voice.numbersRelease('+13105551234');
|
|
@@ -8953,7 +9035,7 @@ declare function numbersRelease(ctx: AdminContext, e164: string): Promise<VoiceN
|
|
|
8953
9035
|
* @param displayName 1–15 character CNAM string, or `""` to remove the listing.
|
|
8954
9036
|
* @throws Error `No phone number "${e164}" on this app` when not found;
|
|
8955
9037
|
* AdminApiError `number_not_found` (404) if the resolved id has gone stale;
|
|
8956
|
-
* `number_not_active` (
|
|
9038
|
+
* `number_not_active` (412) — the number must be active before setting a
|
|
8957
9039
|
* display name; `invalid_display_name` (400) — value is not 1–15 letters,
|
|
8958
9040
|
* numbers, or spaces.
|
|
8959
9041
|
* @example
|
|
@@ -9038,30 +9120,46 @@ declare namespace voice {
|
|
|
9038
9120
|
}
|
|
9039
9121
|
|
|
9040
9122
|
interface AdminClientOptions {
|
|
9041
|
-
/**
|
|
9123
|
+
/**
|
|
9124
|
+
* Org-scoped `sk_` API key. Inside an app's method, leave it out: the
|
|
9125
|
+
* method's own run is the credential, holding the `adminPermissions` its
|
|
9126
|
+
* `mindstudio.json` entry declares. Elsewhere it falls back to
|
|
9127
|
+
* MINDSTUDIO_API_KEY.
|
|
9128
|
+
*/
|
|
9042
9129
|
apiKey?: string;
|
|
9043
9130
|
/**
|
|
9044
|
-
* The app to manage.
|
|
9045
|
-
*
|
|
9131
|
+
* The app to manage. Inside a method, the method's own app. Elsewhere it
|
|
9132
|
+
* falls back to the workspace's mindstudio.json — pass explicitly anywhere
|
|
9133
|
+
* that file doesn't exist.
|
|
9046
9134
|
*/
|
|
9047
9135
|
appId?: string;
|
|
9048
|
-
/**
|
|
9136
|
+
/**
|
|
9137
|
+
* API origin. Inside a method, the api the run calls back on. Elsewhere it
|
|
9138
|
+
* falls back to MINDSTUDIO_BASE_URL, then the production default.
|
|
9139
|
+
*/
|
|
9049
9140
|
baseUrl?: string;
|
|
9050
9141
|
}
|
|
9051
|
-
/**
|
|
9142
|
+
/** The context one call runs with. */
|
|
9143
|
+
type ContextSource = () => Promise<AdminContext>;
|
|
9144
|
+
/** An ops module with the AdminContext applied to every function. */
|
|
9052
9145
|
type BoundOps<T> = {
|
|
9053
|
-
[K in keyof T as T[K] extends (ctx: AdminContext, ...args: never[]) => unknown ? K : never]: T[K] extends (ctx: AdminContext, ...args: infer A) => infer R ? (...args: A) => R : never;
|
|
9146
|
+
[K in keyof T as T[K] extends (ctx: AdminContext, ...args: never[]) => unknown ? K : never]: T[K] extends (ctx: AdminContext, ...args: infer A) => infer R ? (...args: A) => Promise<Awaited<R>> : never;
|
|
9054
9147
|
};
|
|
9055
|
-
declare function buildClient(
|
|
9056
|
-
/**
|
|
9057
|
-
|
|
9148
|
+
declare function buildClient(source: ContextSource, context: AdminContext | null): {
|
|
9149
|
+
/**
|
|
9150
|
+
* The context the client uses outside a running method: its options, or
|
|
9151
|
+
* the environment. Null when neither names a key, as in a method, where
|
|
9152
|
+
* each call takes the run's own.
|
|
9153
|
+
*/
|
|
9154
|
+
context: Readonly<AdminContext> | null;
|
|
9058
9155
|
/**
|
|
9059
9156
|
* A sibling client for another app, sharing credentials.
|
|
9060
9157
|
*
|
|
9061
9158
|
* The app we came from becomes the origin, so a write through the returned
|
|
9062
9159
|
* client records which app acted — the same rule the CLI's `--app` follows.
|
|
9063
9160
|
* Chaining `forApp` twice keeps the FIRST app as the origin, since that is
|
|
9064
|
-
* the one whose workspace this code is running in.
|
|
9161
|
+
* the one whose workspace this code is running in. A method's own
|
|
9162
|
+
* credential acts on its own app only, so from a method this needs a key.
|
|
9065
9163
|
*/
|
|
9066
9164
|
forApp(appId: string): /*elided*/ any;
|
|
9067
9165
|
agent: BoundOps<typeof agent>;
|
|
@@ -9110,6 +9208,7 @@ declare function buildClient(ctx: AdminContext): {
|
|
|
9110
9208
|
requests: BoundOps<typeof requests>;
|
|
9111
9209
|
secrets: BoundOps<typeof secrets>;
|
|
9112
9210
|
settings: BoundOps<typeof settings>;
|
|
9211
|
+
usage: BoundOps<typeof usage>;
|
|
9113
9212
|
users: BoundOps<typeof users>;
|
|
9114
9213
|
voice: BoundOps<typeof voice>;
|
|
9115
9214
|
};
|
|
@@ -9117,10 +9216,53 @@ type AdminClient = ReturnType<typeof buildClient>;
|
|
|
9117
9216
|
/**
|
|
9118
9217
|
* Create a client bound to one app.
|
|
9119
9218
|
*
|
|
9219
|
+
* Inside an app's method, with no options, it acts on the method's own app as
|
|
9220
|
+
* the method's own run: no key in the app's secrets. Each operation needs the
|
|
9221
|
+
* admin permission the method declares in `mindstudio.json`
|
|
9222
|
+
* (`"adminPermissions": ["analytics.view"]`), and an undeclared one fails with
|
|
9223
|
+
* `admin_permission_required:<name>`.
|
|
9224
|
+
*
|
|
9225
|
+
* The admin permissions, by the client namespaces they open (`.manage`
|
|
9226
|
+
* includes its `.view`):
|
|
9227
|
+
*
|
|
9228
|
+
* | Admin permission | Opens |
|
|
9229
|
+
* |---|---|
|
|
9230
|
+
* | `analytics.view` | `analytics` |
|
|
9231
|
+
* | `usage.view` | `usage` |
|
|
9232
|
+
* | `requests.view` | `requests`, `crashes` |
|
|
9233
|
+
* | `agent.view` / `tasks.view` | `agent` / `tasks` |
|
|
9234
|
+
* | `voice.view` / `voice.manage` | `voice` reads: call log, transcripts, settings, numbers list / buying, releasing and naming numbers, settings writes |
|
|
9235
|
+
* | `users.view` / `users.manage` | `users` reads / roles and app-user API keys, live runs only (`admin_permission_live_only:users.manage` from dev or a preview) |
|
|
9236
|
+
* | `settings.manage` | `settings` |
|
|
9237
|
+
* | `email.view` / `email.manage` | `email` reads: log, batches, status, inbox, domains list / suppressions and the sending and receiving domains |
|
|
9238
|
+
* | `domains.manage` | `domains`' custom domains and subdomain (not buying domains, which is the workspace's) |
|
|
9239
|
+
* | `issues.view` / `issues.manage` | `issues` on this app, reads / writes as the app |
|
|
9240
|
+
* | `datasources.manage` | `dataSources` and its jobs, connectors, evals, mappers and readers |
|
|
9241
|
+
* | `cron.view` / `cron.manage` | `cron` overview / run now |
|
|
9242
|
+
* | `releases.view` | `releases`, `diagnostics`' release reads |
|
|
9243
|
+
*
|
|
9244
|
+
* The rules:
|
|
9245
|
+
* - Only the method's own app: `forApp()` and another `appId` get
|
|
9246
|
+
* `app_credential_wrong_app`. Another app or the workspace needs a key.
|
|
9247
|
+
* - Not in a jewel's shadow run or a data source's mapper or reader run
|
|
9248
|
+
* (`admin_permission_unavailable`).
|
|
9249
|
+
* - Publishing the declaration is the consent, and any visitor who can call
|
|
9250
|
+
* the method can make it use what it holds, so gate the method accordingly.
|
|
9251
|
+
* - Never an admin permission: secrets (a method has its own in
|
|
9252
|
+
* `process.env`) and builder operations (deploys, data lifts, previews,
|
|
9253
|
+
* infra, jewel training). What `@mindstudio-ai/agent` already does needs
|
|
9254
|
+
* none.
|
|
9255
|
+
*
|
|
9120
9256
|
* ```ts
|
|
9121
9257
|
* import { createAdminClient } from '@madewithremy/admin';
|
|
9122
|
-
*
|
|
9123
|
-
*
|
|
9258
|
+
*
|
|
9259
|
+
* // In a method declaring "adminPermissions": ["analytics.view"]
|
|
9260
|
+
* const admin = createAdminClient();
|
|
9261
|
+
* const live = await admin.analytics.live();
|
|
9262
|
+
*
|
|
9263
|
+
* // Anywhere else, with a workspace API key
|
|
9264
|
+
* const other = createAdminClient({ apiKey: 'sk_…', appId: 'app_…' });
|
|
9265
|
+
* const { releases } = await other.releases.list({ limit: 5 });
|
|
9124
9266
|
* ```
|
|
9125
9267
|
*/
|
|
9126
9268
|
declare function createAdminClient(options?: AdminClientOptions): AdminClient;
|
|
@@ -9157,4 +9299,4 @@ declare class AdminTimeoutError extends Error {
|
|
|
9157
9299
|
declare const admin: AdminClient;
|
|
9158
9300
|
|
|
9159
9301
|
export { AdminApiError, AdminTimeoutError, admin, createAdminClient, admin as default };
|
|
9160
|
-
export type { AdminClient, AdminClientOptions, AdminContext, AgentThreadDetail, AgentThreadListItem, AgentThreadsGetResult, AgentThreadsListResult, AgentToolCall, AgentTranscriptMessage, AgentTurnError, AnalyticsAiHostRow, AnalyticsAiSourcesResult, AnalyticsAiVendorRow, AnalyticsBatchResult, AnalyticsCrawlersOverviewResult, AnalyticsCrawlersRecentResult, AnalyticsCrawlersRecentRow, AnalyticsCrawlersResult, AnalyticsCrawlersTimeseriesBucket, AnalyticsCrawlersTimeseriesResult, AnalyticsLiveResult, AnalyticsMapPoint, AnalyticsMapResult, AnalyticsMetric, AnalyticsQueryResult, AnalyticsQueryResultRow, AnalyticsSourceRow, AnalyticsSourcesResult, AppCronJobStatus, AppCronJobStatusReason, AppCronRunState, AppEmailSuppression, AppSecretRow, AppsListPage, AppsListResult, BoughtDomain, CrashGroup, CrashOccurrenceRow, CrashesGetResult, CrashesListResult, CrashesOccurrencesResult, CrashesStatsBucket, CrashesStatsResult, CronJobDecorated, CronOverviewResult, CronRunResult, CronRunSummary, DashboardLiveRelease, DashboardReleaseMethod, DashboardResult, DataLiftFromDevResult, DataLiftFromLiveResult, DataSourceConnector, DataSourceConnectorCredentials, DataSourceConnectorDeletions, DataSourceConnectorGetResult, DataSourceConnectorPolicy, DataSourceConnectorResult, DataSourceInspectReport, DataSourceInspectResult, DataSourceJob, DataSourceJobGetResult, DataSourceJobManifestTokenResult, DataSourceJobPlan, DataSourceJobResult, DataSourceJobSource, DataSourceJobState, DataSourceJobsListResult, DataSourceMapDeployResult, DataSourceMapTestDocument, DataSourceMapTestOutcome, DataSourceMapTestResult, DataSourceMapper, DataSourceObjectSelection, DataSourceQuarantineResult, DataSourceQuarantinedObject, DataSourceReader, DataSourceReaderDeliveries, DataSourceReaderRetryResult, DataSourceReaderStatusResult, DataSourceReaderTestDocument, DataSourceReaderTestResult, DataSourceRemapResult, DataSourceRereadResult, DataSourceSyncResult, DataSourcesBuildProgress, DataSourcesChunkingConfig, DataSourcesChunkingStrategy, DataSourcesConfigResult, DataSourcesConfigUpdateResult, DataSourcesCountResult, DataSourcesCreateResult, DataSourcesDeleteResult, DataSourcesDictionaryPushResult, DataSourcesDictionaryReport, DataSourcesDictionaryStatus, DataSourcesDocument, DataSourcesDocumentConfirmResult, DataSourcesDocumentDeleteManyResult, DataSourcesDocumentDeleteResult, DataSourcesDocumentSelector, DataSourcesDocumentStatus, DataSourcesDocumentsResult, DataSourcesDropResult, DataSourcesEntitiesResult, DataSourcesHydrateResult, DataSourcesHydration, DataSourcesIndex, DataSourcesIngestConfig, DataSourcesIngestUpdate, DataSourcesLinkResult, DataSourcesListEntry, DataSourcesListResult, DataSourcesMigration, DataSourcesMoveResult, DataSourcesPassage, DataSourcesPassagesResult, DataSourcesPlacement, DataSourcesPromoteResult, DataSourcesRelink, DataSourcesRetrievalConfig, DataSourcesRetrievalUpdate, DataSourcesRevectorizeResult, DataSourcesSampleResult, DataSourcesSearchCitation, DataSourcesSearchResult, DataSourcesSearchResultItem, DataSourcesUploadTokenResult, DatasetFile, DbHistoryResult, DbQueryResult, DiagnosticsAuditEnvironment, DiagnosticsDashboardResult, DiagnosticsFinding, DiagnosticsLighthouseScores, DiagnosticsPayload, DiagnosticsReleaseResult, DiagnosticsRuntimeFindings, DomainsCheckResult, DomainsCustomAddResult, DomainsCustomCheckResult, DomainsCustomHostnameUiStatus, DomainsCustomHostnameView, DomainsCustomListResult, DomainsCustomRemoveResult, DomainsCustomRetryResult, DomainsDnsInstructions, DomainsGetResult, DomainsSetResult, EmailBatchLifecycle, EmailBatchResult, EmailBatchSummary, EmailBatchesResult, EmailDomainBase, EmailEffectiveSender, EmailInboxResult, EmailListResult, EmailMessageKind, EmailMessageResult, EmailMessageStatus, EmailSenderTier, EmailSendingStatusResult, EmailStatsResult, EmailSummary, EmailSuppressResult, EmailSuppressionsResult, EmailUnsuppressResult, EvalAggregates, EvalCompareResult, EvalExpectation, EvalQueriesAddResult, EvalQueriesListResult, EvalQuery, EvalQueryResult, EvalQueryStyle, EvalRetrieval, EvalRun, EvalRunResult, EvalRunState, EvalRunsListResult, EvalSet, EvalSetGetResult, EvalSetResult, EvalSetState, EvalSetsListResult, EventChannelActivity, EventsChannelsListResult, EventsPublishResult, EventsTailFrame, FilesDeleteResult, FilesFileMeta, FilesListEntry, FilesListResult, FilesLsResult, FilesScanBadge, FilesScanFlagged, FilesScanStore, FilesStatResult, FilesStoreSummaryEntry, FilesUploadUrlResult, FilesUrlResult, FrontendErrorType, InboundDnsInstructions, InboundEmailDomainAddResult, InboundEmailDomainCheckResult, InboundEmailDomainDeleteResult, InboundEmailDomainUiStatus, InboundEmailDomainVerifyResult, InboundEmailDomainView, InboundEmailDomainsListResult, InboxEmailPreview, IssueAuthorKind, IssueCommentRow, IssueEventType, IssueRow, IssueStatus, IssuesCommentResult, IssuesCreateResult, IssuesDeleteResult, IssuesGetResult, IssuesListResult, IssuesUpdateResult, JewelPairRow, JewelPairSummaryRow, JewelVerdict, JewelsDatasetSummary, JewelsDryrunResult, JewelsExportResult, JewelsGradeResult, JewelsGrading, JewelsOverviewResult, JewelsPairResult, JewelsPairsResult, JewelsQueueResult, JewelsResolveResult, JewelsRunResult, JewelsRunsResult, JewelsTimeseriesBucket, JewelsTimeseriesResult, JewelsTrainResult, LiftedDatabase, MethodsInvokeResult, OperationProgress, OutboundDnsInstructions, OutboundDnsRecord, OutboundEmailDomainAddResult, OutboundEmailDomainCheckResult, OutboundEmailDomainDeleteResult, OutboundEmailDomainUiStatus, OutboundEmailDomainVerifyResult, OutboundEmailDomainView, OutboundEmailDomainsListResult, PlatformSuppression, PrerenderGetResult, PrerenderInvalidateResult, PrerenderPage, PrerenderPagesResult, PrerenderViewResult, PreviewShareLink, PreviewShareListResult, PreviewShareResult, PreviewShareRevokeResult, RegisteredDomainConnection, RegisteredDomainOffer, RegisteredDomainQuote, RegisteredDomainRecordType, RegisteredDomainRecords, RegisteredDomainStatus, RegisteredDomainView, RegisteredDomainZoneRecord, RegisteredDomainsBuyResult, RegisteredDomainsContactResult, RegisteredDomainsContactSetResult, RegisteredDomainsListResult, RegisteredDomainsQuoteResult, RegisteredDomainsRecordDeleteResult, RegisteredDomainsRecordResult, RegisteredDomainsSearchResult, RegisteredDomainsZoneResult, RegistrantContact, ReleaseFailureFields, ReleaseFragment, ReleasesByCommitResult, ReleasesGetResult, ReleasesListResult, RequestsGetResult, RequestsListResult, RequestsListRow, RequestsStatsMethodBucket, RequestsStatsMethodResult, RequestsStatsSummaryBucket, RequestsStatsSummaryResult, SecretsDeleteResult, SecretsGetResult, SecretsListResult, SecretsSetResult, SettingsResult, SuppressionSource, TaskTraceOutcome, TaskTraceSummary, TaskTranscriptMessage, TaskTurnError, TasksGetResult, TasksListResult, TrainingLogEntry, TrainingRunRow, TrainingRunStatus, UserAuthProvider, UserListItem, UserRecord, UsersCreateApiKeyResult, UsersListResult, UsersRevokeApiKeyResult, UsersSetRoleResult, V2AppSettings, V2BuildLogEntry, V2BuildStats, V2CommitInfo, V2EmailMessage, V2ReleaseStatus, VoiceAvailableNumber, VoiceNumbersBuyResult, VoiceNumbersListResult, VoiceNumbersReleaseResult, VoiceNumbersSearchResult, VoiceNumbersSetNameResult, VoicePhoneNumberStatus, VoicePhoneNumberView, VoiceResolvedPolicy, VoiceSessionChannel, VoiceSessionCost, VoiceSessionCostLine, VoiceSessionDetail, VoiceSessionGetResult, VoiceSessionListItem, VoiceSessionSip, VoiceSessionSpeechEntry, VoiceSessionStatus, VoiceSessionToolEntry, VoiceSessionTranscriptEntry, VoiceSessionsListResult, VoiceSettingsCeilings, VoiceSettingsGetResult, VoiceSettingsOverrides, VoiceSettingsSetResult, WorkspaceApp, WorkspaceRegistrantContact };
|
|
9302
|
+
export type { AdminClient, AdminClientOptions, AdminContext, AgentThreadDetail, AgentThreadListItem, AgentThreadsGetResult, AgentThreadsListResult, AgentToolCall, AgentTranscriptMessage, AgentTurnError, AnalyticsAiHostRow, AnalyticsAiSourcesResult, AnalyticsAiVendorRow, AnalyticsBatchResult, AnalyticsCrawlersOverviewResult, AnalyticsCrawlersRecentResult, AnalyticsCrawlersRecentRow, AnalyticsCrawlersResult, AnalyticsCrawlersTimeseriesBucket, AnalyticsCrawlersTimeseriesResult, AnalyticsLiveResult, AnalyticsMapPoint, AnalyticsMapResult, AnalyticsMetric, AnalyticsQueryResult, AnalyticsQueryResultRow, AnalyticsSourceRow, AnalyticsSourcesResult, AppCronJobStatus, AppCronJobStatusReason, AppCronRunState, AppEmailSuppression, AppSecretRow, AppsListPage, AppsListResult, BoughtDomain, CrashGroup, CrashOccurrenceRow, CrashesGetResult, CrashesListResult, CrashesOccurrencesResult, CrashesStatsBucket, CrashesStatsResult, CronJobDecorated, CronOverviewResult, CronRunResult, CronRunSummary, DashboardLiveRelease, DashboardReleaseMethod, DashboardResult, DataLiftFromDevResult, DataLiftFromLiveResult, DataSourceConnector, DataSourceConnectorCredentials, DataSourceConnectorDeletions, DataSourceConnectorGetResult, DataSourceConnectorPolicy, DataSourceConnectorResult, DataSourceInspectReport, DataSourceInspectResult, DataSourceJob, DataSourceJobGetResult, DataSourceJobManifestTokenResult, DataSourceJobPlan, DataSourceJobResult, DataSourceJobSource, DataSourceJobState, DataSourceJobsListResult, DataSourceMapDeployResult, DataSourceMapTestDocument, DataSourceMapTestOutcome, DataSourceMapTestResult, DataSourceMapper, DataSourceObjectSelection, DataSourceQuarantineResult, DataSourceQuarantinedObject, DataSourceReader, DataSourceReaderDeliveries, DataSourceReaderRetryResult, DataSourceReaderStatusResult, DataSourceReaderTestDocument, DataSourceReaderTestResult, DataSourceRemapResult, DataSourceRereadResult, DataSourceSyncResult, DataSourcesBuildProgress, DataSourcesChunkingConfig, DataSourcesChunkingStrategy, DataSourcesConfigResult, DataSourcesConfigUpdateResult, DataSourcesCountResult, DataSourcesCreateResult, DataSourcesDeleteResult, DataSourcesDictionaryPushResult, DataSourcesDictionaryReport, DataSourcesDictionaryStatus, DataSourcesDocument, DataSourcesDocumentConfirmResult, DataSourcesDocumentDeleteManyResult, DataSourcesDocumentDeleteResult, DataSourcesDocumentSelector, DataSourcesDocumentStatus, DataSourcesDocumentsResult, DataSourcesDropResult, DataSourcesEntitiesResult, DataSourcesHydrateResult, DataSourcesHydration, DataSourcesIndex, DataSourcesIngestConfig, DataSourcesIngestUpdate, DataSourcesLinkResult, DataSourcesListEntry, DataSourcesListResult, DataSourcesMigration, DataSourcesMoveResult, DataSourcesPassage, DataSourcesPassagesResult, DataSourcesPlacement, DataSourcesPromoteResult, DataSourcesRelink, DataSourcesRetrievalConfig, DataSourcesRetrievalUpdate, DataSourcesRevectorizeResult, DataSourcesSampleResult, DataSourcesSearchCitation, DataSourcesSearchResult, DataSourcesSearchResultItem, DataSourcesUploadTokenResult, DatasetFile, DbHistoryResult, DbQueryResult, DiagnosticsAuditEnvironment, DiagnosticsDashboardResult, DiagnosticsFinding, DiagnosticsLighthouseScores, DiagnosticsPayload, DiagnosticsReleaseResult, DiagnosticsRuntimeFindings, DomainsCheckResult, DomainsCustomAddResult, DomainsCustomCheckResult, DomainsCustomHostnameUiStatus, DomainsCustomHostnameView, DomainsCustomListResult, DomainsCustomRemoveResult, DomainsCustomRetryResult, DomainsDnsInstructions, DomainsGetResult, DomainsSetResult, EmailBatchLifecycle, EmailBatchResult, EmailBatchSummary, EmailBatchesResult, EmailDomainBase, EmailEffectiveSender, EmailInboxResult, EmailListResult, EmailMessageKind, EmailMessageResult, EmailMessageStatus, EmailSenderTier, EmailSendingStatusResult, EmailStatsResult, EmailSummary, EmailSuppressResult, EmailSuppressionsResult, EmailUnsuppressResult, EvalAggregates, EvalCompareResult, EvalExpectation, EvalQueriesAddResult, EvalQueriesListResult, EvalQuery, EvalQueryResult, EvalQueryStyle, EvalRetrieval, EvalRun, EvalRunResult, EvalRunState, EvalRunsListResult, EvalSet, EvalSetGetResult, EvalSetResult, EvalSetState, EvalSetsListResult, EventChannelActivity, EventsChannelsListResult, EventsPublishResult, EventsTailFrame, FilesDeleteResult, FilesFileMeta, FilesListEntry, FilesListResult, FilesLsResult, FilesScanBadge, FilesScanFlagged, FilesScanStore, FilesStatResult, FilesStoreSummaryEntry, FilesUploadUrlResult, FilesUrlResult, FrontendErrorType, InboundDnsInstructions, InboundEmailDomainAddResult, InboundEmailDomainCheckResult, InboundEmailDomainDeleteResult, InboundEmailDomainUiStatus, InboundEmailDomainVerifyResult, InboundEmailDomainView, InboundEmailDomainsListResult, InboxEmailPreview, IssueAuthorKind, IssueCommentRow, IssueEventType, IssueRow, IssueStatus, IssuesCommentResult, IssuesCreateResult, IssuesDeleteResult, IssuesGetResult, IssuesListResult, IssuesUpdateResult, JewelPairRow, JewelPairSummaryRow, JewelVerdict, JewelsDatasetSummary, JewelsDryrunResult, JewelsExportResult, JewelsGradeResult, JewelsGrading, JewelsOverviewResult, JewelsPairResult, JewelsPairsResult, JewelsQueueResult, JewelsResolveResult, JewelsRunResult, JewelsRunsResult, JewelsTimeseriesBucket, JewelsTimeseriesResult, JewelsTrainResult, LiftedDatabase, MethodsInvokeResult, OperationProgress, OutboundDnsInstructions, OutboundDnsRecord, OutboundEmailDomainAddResult, OutboundEmailDomainCheckResult, OutboundEmailDomainDeleteResult, OutboundEmailDomainUiStatus, OutboundEmailDomainVerifyResult, OutboundEmailDomainView, OutboundEmailDomainsListResult, PlatformSuppression, PrerenderGetResult, PrerenderInvalidateResult, PrerenderPage, PrerenderPagesResult, PrerenderViewResult, PreviewShareLink, PreviewShareListResult, PreviewShareResult, PreviewShareRevokeResult, RegisteredDomainConnection, RegisteredDomainOffer, RegisteredDomainQuote, RegisteredDomainRecordType, RegisteredDomainRecords, RegisteredDomainStatus, RegisteredDomainView, RegisteredDomainZoneRecord, RegisteredDomainsBuyResult, RegisteredDomainsContactResult, RegisteredDomainsContactSetResult, RegisteredDomainsListResult, RegisteredDomainsQuoteResult, RegisteredDomainsRecordDeleteResult, RegisteredDomainsRecordResult, RegisteredDomainsSearchResult, RegisteredDomainsZoneResult, RegistrantContact, ReleaseFailureFields, ReleaseFragment, ReleasesByCommitResult, ReleasesGetResult, ReleasesListResult, RequestsGetResult, RequestsListResult, RequestsListRow, RequestsStatsMethodBucket, RequestsStatsMethodResult, RequestsStatsSummaryBucket, RequestsStatsSummaryResult, SecretsDeleteResult, SecretsGetResult, SecretsListResult, SecretsSetResult, SettingsResult, SuppressionSource, TaskTraceOutcome, TaskTraceSummary, TaskTranscriptMessage, TaskTurnError, TasksGetResult, TasksListResult, TrainingLogEntry, TrainingRunRow, TrainingRunStatus, UsageGroup, UsageGroupBy, UsageSummaryResult, UserAuthProvider, UserListItem, UserRecord, UsersCreateApiKeyResult, UsersListResult, UsersRevokeApiKeyResult, UsersSetRoleResult, V2AppSettings, V2BuildLogEntry, V2BuildStats, V2CommitInfo, V2EmailMessage, V2ReleaseStatus, VoiceAvailableNumber, VoiceNumbersBuyResult, VoiceNumbersListResult, VoiceNumbersReleaseResult, VoiceNumbersSearchResult, VoiceNumbersSetNameResult, VoicePhoneNumberStatus, VoicePhoneNumberView, VoiceResolvedPolicy, VoiceSessionChannel, VoiceSessionCost, VoiceSessionCostLine, VoiceSessionDetail, VoiceSessionGetResult, VoiceSessionListItem, VoiceSessionSip, VoiceSessionSpeechEntry, VoiceSessionStatus, VoiceSessionToolEntry, VoiceSessionTranscriptEntry, VoiceSessionsListResult, VoiceSettingsCeilings, VoiceSettingsGetResult, VoiceSettingsOverrides, VoiceSettingsSetResult, WorkspaceApp, WorkspaceRegistrantContact };
|