@reclaimprotocol/client 0.1.17 → 0.1.20
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/lib/routes.gen.d.ts +16 -0
- package/lib/routes.gen.js +4 -0
- package/lib/types/openapi.gen.d.ts +256 -17
- package/package.json +1 -1
- package/src/routes.gen.ts +4 -0
- package/src/types/openapi.gen.ts +256 -17
package/lib/routes.gen.d.ts
CHANGED
|
@@ -51,6 +51,10 @@ export declare const ROUTES: {
|
|
|
51
51
|
readonly method: "get";
|
|
52
52
|
readonly path: "/admin/sessions";
|
|
53
53
|
};
|
|
54
|
+
readonly AdminSetUserOrgLimit: {
|
|
55
|
+
readonly method: "put";
|
|
56
|
+
readonly path: "/users/{userId}/org-limit";
|
|
57
|
+
};
|
|
54
58
|
readonly AdminSubscribeOrgPlan: {
|
|
55
59
|
readonly method: "post";
|
|
56
60
|
readonly path: "/admin/orgs/{orgId}/billing/subscribe";
|
|
@@ -87,6 +91,14 @@ export declare const ROUTES: {
|
|
|
87
91
|
readonly method: "get";
|
|
88
92
|
readonly path: "/oauth/consent";
|
|
89
93
|
};
|
|
94
|
+
readonly ConvertOrgToRegular: {
|
|
95
|
+
readonly method: "post";
|
|
96
|
+
readonly path: "/orgs/{orgId}/convert";
|
|
97
|
+
};
|
|
98
|
+
readonly CreateAgentBrowserSession: {
|
|
99
|
+
readonly method: "post";
|
|
100
|
+
readonly path: "/orgs/{orgId}/agent-browser-sessions";
|
|
101
|
+
};
|
|
90
102
|
readonly CreateBillingCheckoutSession: {
|
|
91
103
|
readonly method: "post";
|
|
92
104
|
readonly path: "/orgs/{orgId}/billing/checkout";
|
|
@@ -191,6 +203,10 @@ export declare const ROUTES: {
|
|
|
191
203
|
readonly method: "get";
|
|
192
204
|
readonly path: "/discover/websites";
|
|
193
205
|
};
|
|
206
|
+
readonly DisposeAgentBrowserSession: {
|
|
207
|
+
readonly method: "delete";
|
|
208
|
+
readonly path: "/orgs/{orgId}/agent-browser-sessions/{browserSessionId}";
|
|
209
|
+
};
|
|
194
210
|
readonly DisposeVerificationSession: {
|
|
195
211
|
readonly method: "post";
|
|
196
212
|
readonly path: "/v/{sessionId}/dispose";
|
package/lib/routes.gen.js
CHANGED
|
@@ -16,6 +16,7 @@ export const ROUTES = {
|
|
|
16
16
|
"AdminProviders": { "method": "get", "path": "/admin/providers" },
|
|
17
17
|
"AdminReviews": { "method": "get", "path": "/admin/reviews" },
|
|
18
18
|
"AdminSessions": { "method": "get", "path": "/admin/sessions" },
|
|
19
|
+
"AdminSetUserOrgLimit": { "method": "put", "path": "/users/{userId}/org-limit" },
|
|
19
20
|
"AdminSubscribeOrgPlan": { "method": "post", "path": "/admin/orgs/{orgId}/billing/subscribe" },
|
|
20
21
|
"AdminThemes": { "method": "get", "path": "/admin/themes" },
|
|
21
22
|
"AdminUsers": { "method": "get", "path": "/admin/users" },
|
|
@@ -25,6 +26,8 @@ export const ROUTES = {
|
|
|
25
26
|
"CancelPublicListingRequest": { "method": "post", "path": "/providers/{providerId}/versions/{version}/cancel-review" },
|
|
26
27
|
"ChangeOrgPlan": { "method": "post", "path": "/orgs/{orgId}/billing/change-plan" },
|
|
27
28
|
"ConsentPage": { "method": "get", "path": "/oauth/consent" },
|
|
29
|
+
"ConvertOrgToRegular": { "method": "post", "path": "/orgs/{orgId}/convert" },
|
|
30
|
+
"CreateAgentBrowserSession": { "method": "post", "path": "/orgs/{orgId}/agent-browser-sessions" },
|
|
28
31
|
"CreateBillingCheckoutSession": { "method": "post", "path": "/orgs/{orgId}/billing/checkout" },
|
|
29
32
|
"CreateBillingPortalSession": { "method": "post", "path": "/orgs/{orgId}/billing/portal" },
|
|
30
33
|
"CreateCallbackSubscription": { "method": "post", "path": "/verifications/callback-subscriptions" },
|
|
@@ -51,6 +54,7 @@ export const ROUTES = {
|
|
|
51
54
|
"DiscoverResolve": { "method": "get", "path": "/discover/resolve" },
|
|
52
55
|
"DiscoverTeachAgent": { "method": "get", "path": "/discover/teach" },
|
|
53
56
|
"DiscoverWebsites": { "method": "get", "path": "/discover/websites" },
|
|
57
|
+
"DisposeAgentBrowserSession": { "method": "delete", "path": "/orgs/{orgId}/agent-browser-sessions/{browserSessionId}" },
|
|
54
58
|
"DisposeVerificationSession": { "method": "post", "path": "/v/{sessionId}/dispose" },
|
|
55
59
|
"Docs": { "method": "get", "path": "/docs" },
|
|
56
60
|
"ExplorePreviewImage": { "method": "get", "path": "/og/explore.png" },
|
|
@@ -12,7 +12,7 @@ export interface paths {
|
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
14
|
* Discover home — search a website to verify
|
|
15
|
-
* @description Default home page. A website-first search: the visitor types a website and picks one to continue to `/site/{domain}`, where they choose what data to prove. Renders popular websites below the search.
|
|
15
|
+
* @description Default home page. A website-first search: the visitor types a website and picks one to continue to `/site/{domain}`, where they choose what data to prove. Renders popular websites below the search, plus tag pills to narrow them.
|
|
16
16
|
*/
|
|
17
17
|
get: operations["Index"];
|
|
18
18
|
put?: never;
|
|
@@ -179,7 +179,7 @@ export interface paths {
|
|
|
179
179
|
put?: never;
|
|
180
180
|
/**
|
|
181
181
|
* Mint a SANDBOX test verification session for the selection
|
|
182
|
-
* @description Creates a real SANDBOX verification session
|
|
182
|
+
* @description Creates a real SANDBOX verification session for the selected data points, so the signed-in member can test the flow on `/v/{sessionId}` without registering a callback subscription. Runs under an organization the member owns (`orgId` in the body; defaults to their personal organization). The provider set is recomputed server-side from the selection.
|
|
183
183
|
*/
|
|
184
184
|
post: operations["SiteBuildTry"];
|
|
185
185
|
delete?: never;
|
|
@@ -239,7 +239,7 @@ export interface paths {
|
|
|
239
239
|
put?: never;
|
|
240
240
|
/**
|
|
241
241
|
* Author an AI (llm) provider and go to its build screen
|
|
242
|
-
* @description Creates an `llm`-verification provider under the signed-in member
|
|
242
|
+
* @description Creates an `llm`-verification provider under an organization the signed-in member owns (their personal org by default), seeded with an extraction prompt for the selected/missing data points (and carrying the working response matches from the resolved structured providers). If `fromProviderId` is an editable draft the viewer owns, it versions THAT instead. Returns the build page's AI dialog body (the editable prompt + "Try with AI"). HTML / HTMX fragment.
|
|
243
243
|
*/
|
|
244
244
|
post: operations["SiteAiProvider"];
|
|
245
245
|
delete?: never;
|
|
@@ -476,7 +476,7 @@ export interface paths {
|
|
|
476
476
|
};
|
|
477
477
|
/**
|
|
478
478
|
* Explore verification sessions (admin-only)
|
|
479
|
-
* @description Admin only. Search verification sessions across all organizations —
|
|
479
|
+
* @description Admin only. Search verification sessions across all organizations — filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `claimantClientId`, `orgId` (all exact match), `status`, and a `createdAfter`/`createdBefore` time range. Rows link to the org-scoped session detail page (admins can open any org's pages). Capped at 100, newest first.
|
|
480
480
|
*/
|
|
481
481
|
get: operations["AdminSessions"];
|
|
482
482
|
put?: never;
|
|
@@ -1002,7 +1002,7 @@ export interface paths {
|
|
|
1002
1002
|
};
|
|
1003
1003
|
/**
|
|
1004
1004
|
* Verification page for an end-user
|
|
1005
|
-
* @description Opens a
|
|
1005
|
+
* @description Opens a Builder-hosted remote-browser session, embeds its live view in an iframe, and kicks off the capture → prove → submit run for this verification session.
|
|
1006
1006
|
*/
|
|
1007
1007
|
get: operations["VerificationPage"];
|
|
1008
1008
|
put?: never;
|
|
@@ -1122,7 +1122,7 @@ export interface paths {
|
|
|
1122
1122
|
};
|
|
1123
1123
|
/**
|
|
1124
1124
|
* Get the OpenAPI specification (YAML)
|
|
1125
|
-
* @description
|
|
1125
|
+
* @description The OpenAPI 3.1 document for this API, self-contained (every `$ref` is internal). Feed it to API tooling and SDK generators. Reclaim staff additionally see the internal tag groups; everyone else gets the integration surface only.
|
|
1126
1126
|
*/
|
|
1127
1127
|
get: operations["OpenApiSpec"];
|
|
1128
1128
|
put?: never;
|
|
@@ -1142,7 +1142,7 @@ export interface paths {
|
|
|
1142
1142
|
};
|
|
1143
1143
|
/**
|
|
1144
1144
|
* View the API reference (Scalar UI)
|
|
1145
|
-
* @description
|
|
1145
|
+
* @description Interactive API reference rendered by Scalar from `GET /openapi.yaml`, so it shows whichever document the viewer is served.
|
|
1146
1146
|
*/
|
|
1147
1147
|
get: operations["Docs"];
|
|
1148
1148
|
put?: never;
|
|
@@ -1311,6 +1311,26 @@ export interface paths {
|
|
|
1311
1311
|
patch?: never;
|
|
1312
1312
|
trace?: never;
|
|
1313
1313
|
};
|
|
1314
|
+
"/users/{userId}/org-limit": {
|
|
1315
|
+
parameters: {
|
|
1316
|
+
query?: never;
|
|
1317
|
+
header?: never;
|
|
1318
|
+
path?: never;
|
|
1319
|
+
cookie?: never;
|
|
1320
|
+
};
|
|
1321
|
+
get?: never;
|
|
1322
|
+
/**
|
|
1323
|
+
* Set a user's org-creation limit (admin-only)
|
|
1324
|
+
* @description Admin only. Overrides how many ACTIVE organizations the user may create (the platform default is 3). Restore the default by sending `null` (JSON) or an empty `limit` (form).
|
|
1325
|
+
*/
|
|
1326
|
+
put: operations["AdminSetUserOrgLimit"];
|
|
1327
|
+
post?: never;
|
|
1328
|
+
delete?: never;
|
|
1329
|
+
options?: never;
|
|
1330
|
+
head?: never;
|
|
1331
|
+
patch?: never;
|
|
1332
|
+
trace?: never;
|
|
1333
|
+
};
|
|
1314
1334
|
"/orgs": {
|
|
1315
1335
|
parameters: {
|
|
1316
1336
|
query?: never;
|
|
@@ -1332,6 +1352,46 @@ export interface paths {
|
|
|
1332
1352
|
patch?: never;
|
|
1333
1353
|
trace?: never;
|
|
1334
1354
|
};
|
|
1355
|
+
"/orgs/{orgId}/agent-browser-sessions": {
|
|
1356
|
+
parameters: {
|
|
1357
|
+
query?: never;
|
|
1358
|
+
header?: never;
|
|
1359
|
+
path?: never;
|
|
1360
|
+
cookie?: never;
|
|
1361
|
+
};
|
|
1362
|
+
get?: never;
|
|
1363
|
+
put?: never;
|
|
1364
|
+
/**
|
|
1365
|
+
* Create a remote browser session for provider authoring
|
|
1366
|
+
* @description Allocates a Builder-managed Popcorn browser for an authenticated agent. The caller must be an active editor of the organization. Creating the browser consumes one use from the seeded Builder verification client's VERIFICATION quota pool, so the organization's normal sandbox, plan, overage, and credit restrictions apply. The live-view URL may be shared with a volunteer; the unrestricted CDP URL is a secret intended only for the authenticated local agent process.
|
|
1367
|
+
*/
|
|
1368
|
+
post: operations["CreateAgentBrowserSession"];
|
|
1369
|
+
delete?: never;
|
|
1370
|
+
options?: never;
|
|
1371
|
+
head?: never;
|
|
1372
|
+
patch?: never;
|
|
1373
|
+
trace?: never;
|
|
1374
|
+
};
|
|
1375
|
+
"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}": {
|
|
1376
|
+
parameters: {
|
|
1377
|
+
query?: never;
|
|
1378
|
+
header?: never;
|
|
1379
|
+
path?: never;
|
|
1380
|
+
cookie?: never;
|
|
1381
|
+
};
|
|
1382
|
+
get?: never;
|
|
1383
|
+
put?: never;
|
|
1384
|
+
post?: never;
|
|
1385
|
+
/**
|
|
1386
|
+
* Dispose a remote provider-authoring browser
|
|
1387
|
+
* @description Tears down an agent-owned Popcorn browser immediately. Idempotent for a session that was already disposed. The caller must still be an active editor of the owning organization.
|
|
1388
|
+
*/
|
|
1389
|
+
delete: operations["DisposeAgentBrowserSession"];
|
|
1390
|
+
options?: never;
|
|
1391
|
+
head?: never;
|
|
1392
|
+
patch?: never;
|
|
1393
|
+
trace?: never;
|
|
1394
|
+
};
|
|
1335
1395
|
"/orgs/{orgId}": {
|
|
1336
1396
|
parameters: {
|
|
1337
1397
|
query?: never;
|
|
@@ -1357,6 +1417,26 @@ export interface paths {
|
|
|
1357
1417
|
patch: operations["UpdateOrg"];
|
|
1358
1418
|
trace?: never;
|
|
1359
1419
|
};
|
|
1420
|
+
"/orgs/{orgId}/convert": {
|
|
1421
|
+
parameters: {
|
|
1422
|
+
query?: never;
|
|
1423
|
+
header?: never;
|
|
1424
|
+
path?: never;
|
|
1425
|
+
cookie?: never;
|
|
1426
|
+
};
|
|
1427
|
+
get?: never;
|
|
1428
|
+
put?: never;
|
|
1429
|
+
/**
|
|
1430
|
+
* Convert a personal organization to a regular organization
|
|
1431
|
+
* @description Owner only. One-way: flips a `PERSONAL` organization (auto-provisioned at sign-up, sandbox-only, single-member) to a regular `ORG`, unlocking billing, plan & usage, and member invites. All providers, sessions, credentials and themes carry over. `409` when the organization is not `PERSONAL`.
|
|
1432
|
+
*/
|
|
1433
|
+
post: operations["ConvertOrgToRegular"];
|
|
1434
|
+
delete?: never;
|
|
1435
|
+
options?: never;
|
|
1436
|
+
head?: never;
|
|
1437
|
+
patch?: never;
|
|
1438
|
+
trace?: never;
|
|
1439
|
+
};
|
|
1360
1440
|
"/orgs/{orgId}/members": {
|
|
1361
1441
|
parameters: {
|
|
1362
1442
|
query?: never;
|
|
@@ -2166,7 +2246,7 @@ export interface paths {
|
|
|
2166
2246
|
};
|
|
2167
2247
|
/**
|
|
2168
2248
|
* List an organization's verification sessions
|
|
2169
|
-
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2249
|
+
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2170
2250
|
*
|
|
2171
2251
|
* Note: `status` filters on the stored column. A session that has passed `expiresAt` but has not yet been swept is reported as `expired` in its body while still stored as `pending`, so `status=expired` may not match such sessions until the sweep runs.
|
|
2172
2252
|
*/
|
|
@@ -2582,6 +2662,23 @@ export interface components {
|
|
|
2582
2662
|
* @description Verification session id (UUID v7 when supported). Also echoed in the result payload as `reclaimSessionId`.
|
|
2583
2663
|
*/
|
|
2584
2664
|
SessionID: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* Format: uuid
|
|
2667
|
+
* @description Builder-managed remote browser session id.
|
|
2668
|
+
*/
|
|
2669
|
+
AgentBrowserSessionID: string;
|
|
2670
|
+
/** @description A short-lived Popcorn browser allocated for provider authoring. Treat `cdpUrl` and `apiUrl` as credentials: the local agent consumes them and must not display, persist, or share them. `liveViewUrl` is intentionally shareable with the volunteer operating the browser. */
|
|
2671
|
+
AgentBrowserSession: {
|
|
2672
|
+
id: components["schemas"]["AgentBrowserSessionID"];
|
|
2673
|
+
orgId: components["schemas"]["OrgID"];
|
|
2674
|
+
/** Format: uri */
|
|
2675
|
+
liveViewUrl: string;
|
|
2676
|
+
/** Format: uri */
|
|
2677
|
+
readonly cdpUrl: string;
|
|
2678
|
+
/** Format: uri */
|
|
2679
|
+
readonly apiUrl?: string;
|
|
2680
|
+
expiresAt: components["schemas"]["Timestamp"];
|
|
2681
|
+
};
|
|
2585
2682
|
/**
|
|
2586
2683
|
* Format: uuid
|
|
2587
2684
|
* @description Stable id for a callback subscription.
|
|
@@ -3762,10 +3859,21 @@ export interface components {
|
|
|
3762
3859
|
context?: {
|
|
3763
3860
|
[key: string]: string;
|
|
3764
3861
|
};
|
|
3862
|
+
orgId?: components["schemas"]["OrgID"];
|
|
3863
|
+
};
|
|
3864
|
+
/** @description Body for `POST /site/{domain}/ai-provider`. `orgId` is optional: which owned organization the AI provider is authored under (defaults to the member's personal organization, or their first owned org). `url` is required only when `domain` has no existing catalog data — the build page's confirm-URL step supplies it, and the draft is scaffolded under whatever domain that URL actually resolves to (which may differ from `domain`), not the unconfirmed search text the build page was first opened with. */
|
|
3865
|
+
SiteAiProviderBody: {
|
|
3866
|
+
orgId?: components["schemas"]["OrgID"];
|
|
3867
|
+
/** @description Confirmed website URL, for a domain with no existing catalog data. Verified reachable before anything is created. */
|
|
3868
|
+
url?: string;
|
|
3869
|
+
};
|
|
3870
|
+
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
3871
|
+
AdminSetUserOrgLimitBody: {
|
|
3872
|
+
limit?: number | string | null;
|
|
3765
3873
|
};
|
|
3766
3874
|
/** @description Body for `POST /site/{domain}/try-ai`. An optional edited extraction prompt, saved as a new draft build before the sandbox session is minted. */
|
|
3767
3875
|
SiteTryAiBody: {
|
|
3768
|
-
/** @description The edited extraction prompt for the AI provider. */
|
|
3876
|
+
/** @description The edited extraction prompt for the AI provider. Gated by the prompt guard before it is stored (see docs/prompt-guard.md); the length here documents the same ceiling the guard enforces. */
|
|
3769
3877
|
prompt?: string;
|
|
3770
3878
|
};
|
|
3771
3879
|
/** @description A single data point selectable on the `/site/{domain}` page, with how many visible providers expose it, one example provider slug, and one `references` entry per provider describing how that provider proves it (what the site page's source picker offers as selectable options). */
|
|
@@ -4110,7 +4218,7 @@ export interface components {
|
|
|
4110
4218
|
CreateProviderVersionRequest: {
|
|
4111
4219
|
/** @description Defaults to `structured` server-side when omitted; pass `llm` (with a `prompt`) to author an AI-verification provider. */
|
|
4112
4220
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4113
|
-
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. */
|
|
4221
|
+
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4114
4222
|
prompt?: string;
|
|
4115
4223
|
/**
|
|
4116
4224
|
* @description The version of this Provider upon creation. Clients typically omit this and let the dashboard's bump-suggestion compute it. When omitted, defaults to `0.1.0` for the very first version; otherwise the caller is expected to pass a value higher than the latest existing version.
|
|
@@ -4137,7 +4245,7 @@ export interface components {
|
|
|
4137
4245
|
/** Format: uri */
|
|
4138
4246
|
initialUrl?: string;
|
|
4139
4247
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4140
|
-
/** @description Extraction prompt, used when `verificationType` is `llm`. */
|
|
4248
|
+
/** @description Extraction prompt, used when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4141
4249
|
prompt?: string;
|
|
4142
4250
|
requests?: components["schemas"]["RequestSelection"][];
|
|
4143
4251
|
allowedJsRequests?: components["schemas"]["RequestSelectionTemplate"][];
|
|
@@ -4582,7 +4690,12 @@ export type $defs = Record<string, never>;
|
|
|
4582
4690
|
export interface operations {
|
|
4583
4691
|
Index: {
|
|
4584
4692
|
parameters: {
|
|
4585
|
-
query?:
|
|
4693
|
+
query?: {
|
|
4694
|
+
/** @description Free-text query matched against website domain, data points, brand title, and description. Restores the search box and results on a shared/bookmarked link. */
|
|
4695
|
+
q?: string;
|
|
4696
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
4697
|
+
tag?: string[];
|
|
4698
|
+
};
|
|
4586
4699
|
header?: never;
|
|
4587
4700
|
path?: never;
|
|
4588
4701
|
cookie?: never;
|
|
@@ -4686,6 +4799,8 @@ export interface operations {
|
|
|
4686
4799
|
query?: {
|
|
4687
4800
|
/** @description Free-text query matched against website domain, data points, brand title, and description. Omit for the popular-websites list. */
|
|
4688
4801
|
q?: string;
|
|
4802
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
4803
|
+
tag?: string[];
|
|
4689
4804
|
};
|
|
4690
4805
|
header?: never;
|
|
4691
4806
|
path?: never;
|
|
@@ -4991,7 +5106,13 @@ export interface operations {
|
|
|
4991
5106
|
};
|
|
4992
5107
|
cookie?: never;
|
|
4993
5108
|
};
|
|
4994
|
-
|
|
5109
|
+
/** @description Optional: which owned organization to author the provider under. */
|
|
5110
|
+
requestBody?: {
|
|
5111
|
+
content: {
|
|
5112
|
+
"application/x-www-form-urlencoded": components["schemas"]["SiteAiProviderBody"];
|
|
5113
|
+
"application/json": components["schemas"]["SiteAiProviderBody"];
|
|
5114
|
+
};
|
|
5115
|
+
};
|
|
4995
5116
|
responses: {
|
|
4996
5117
|
/** @description The AI dialog body (editable prompt + Try with AI). */
|
|
4997
5118
|
200: {
|
|
@@ -5010,6 +5131,8 @@ export interface operations {
|
|
|
5010
5131
|
query: {
|
|
5011
5132
|
/** @description The AI provider to try. */
|
|
5012
5133
|
providerId: components["schemas"]["ProviderID"];
|
|
5134
|
+
/** @description Which owned organization the sandbox session runs under (defaults to the member's personal organization, or their first owned org). Must own the provider. */
|
|
5135
|
+
orgId?: components["schemas"]["OrgID"];
|
|
5013
5136
|
};
|
|
5014
5137
|
header?: never;
|
|
5015
5138
|
path: {
|
|
@@ -5366,9 +5489,19 @@ export interface operations {
|
|
|
5366
5489
|
AdminSessions: {
|
|
5367
5490
|
parameters: {
|
|
5368
5491
|
query?: {
|
|
5369
|
-
/** @description
|
|
5370
|
-
|
|
5492
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
5493
|
+
sessionId?: string;
|
|
5494
|
+
/** @description Only return sessions for this exact provider id. */
|
|
5495
|
+
providerId?: string;
|
|
5496
|
+
/** @description Only return the session matching this claimant client id. */
|
|
5497
|
+
claimantClientId?: string;
|
|
5498
|
+
/** @description Only return sessions belonging to this exact organization id. */
|
|
5499
|
+
orgId?: string;
|
|
5371
5500
|
status?: components["schemas"]["VerificationStatus"];
|
|
5501
|
+
/** @description Only return sessions created at or after this time (inclusive). */
|
|
5502
|
+
createdAfter?: string;
|
|
5503
|
+
/** @description Only return sessions created at or before this time (inclusive). */
|
|
5504
|
+
createdBefore?: string;
|
|
5372
5505
|
};
|
|
5373
5506
|
header?: never;
|
|
5374
5507
|
path?: never;
|
|
@@ -6530,6 +6663,34 @@ export interface operations {
|
|
|
6530
6663
|
default: components["responses"]["ProblemResponse"];
|
|
6531
6664
|
};
|
|
6532
6665
|
};
|
|
6666
|
+
AdminSetUserOrgLimit: {
|
|
6667
|
+
parameters: {
|
|
6668
|
+
query?: never;
|
|
6669
|
+
header?: never;
|
|
6670
|
+
path: {
|
|
6671
|
+
userId: components["schemas"]["UserID"];
|
|
6672
|
+
};
|
|
6673
|
+
cookie?: never;
|
|
6674
|
+
};
|
|
6675
|
+
requestBody: {
|
|
6676
|
+
content: {
|
|
6677
|
+
"application/json": components["schemas"]["AdminSetUserOrgLimitBody"];
|
|
6678
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminSetUserOrgLimitBody"];
|
|
6679
|
+
};
|
|
6680
|
+
};
|
|
6681
|
+
responses: {
|
|
6682
|
+
/** @description Updated. */
|
|
6683
|
+
204: {
|
|
6684
|
+
headers: {
|
|
6685
|
+
[name: string]: unknown;
|
|
6686
|
+
};
|
|
6687
|
+
content?: never;
|
|
6688
|
+
};
|
|
6689
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6690
|
+
404: components["responses"]["ProblemResponse"];
|
|
6691
|
+
default: components["responses"]["ProblemResponse"];
|
|
6692
|
+
};
|
|
6693
|
+
};
|
|
6533
6694
|
ListOrgs: {
|
|
6534
6695
|
parameters: {
|
|
6535
6696
|
query?: {
|
|
@@ -6584,6 +6745,57 @@ export interface operations {
|
|
|
6584
6745
|
default: components["responses"]["ProblemResponse"];
|
|
6585
6746
|
};
|
|
6586
6747
|
};
|
|
6748
|
+
CreateAgentBrowserSession: {
|
|
6749
|
+
parameters: {
|
|
6750
|
+
query?: never;
|
|
6751
|
+
header?: never;
|
|
6752
|
+
path: {
|
|
6753
|
+
orgId: components["schemas"]["OrgID"];
|
|
6754
|
+
};
|
|
6755
|
+
cookie?: never;
|
|
6756
|
+
};
|
|
6757
|
+
requestBody?: never;
|
|
6758
|
+
responses: {
|
|
6759
|
+
/** @description Remote authoring browser created. */
|
|
6760
|
+
201: {
|
|
6761
|
+
headers: {
|
|
6762
|
+
"Cache-Control"?: string;
|
|
6763
|
+
[name: string]: unknown;
|
|
6764
|
+
};
|
|
6765
|
+
content: {
|
|
6766
|
+
"application/json": components["schemas"]["AgentBrowserSession"];
|
|
6767
|
+
};
|
|
6768
|
+
};
|
|
6769
|
+
402: components["responses"]["ProblemResponse"];
|
|
6770
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6771
|
+
429: components["responses"]["ProblemResponse"];
|
|
6772
|
+
default: components["responses"]["ProblemResponse"];
|
|
6773
|
+
};
|
|
6774
|
+
};
|
|
6775
|
+
DisposeAgentBrowserSession: {
|
|
6776
|
+
parameters: {
|
|
6777
|
+
query?: never;
|
|
6778
|
+
header?: never;
|
|
6779
|
+
path: {
|
|
6780
|
+
orgId: components["schemas"]["OrgID"];
|
|
6781
|
+
browserSessionId: components["schemas"]["AgentBrowserSessionID"];
|
|
6782
|
+
};
|
|
6783
|
+
cookie?: never;
|
|
6784
|
+
};
|
|
6785
|
+
requestBody?: never;
|
|
6786
|
+
responses: {
|
|
6787
|
+
/** @description Browser disposed or already absent. */
|
|
6788
|
+
204: {
|
|
6789
|
+
headers: {
|
|
6790
|
+
[name: string]: unknown;
|
|
6791
|
+
};
|
|
6792
|
+
content?: never;
|
|
6793
|
+
};
|
|
6794
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6795
|
+
404: components["responses"]["ProblemResponse"];
|
|
6796
|
+
default: components["responses"]["ProblemResponse"];
|
|
6797
|
+
};
|
|
6798
|
+
};
|
|
6587
6799
|
GetOrg: {
|
|
6588
6800
|
parameters: {
|
|
6589
6801
|
query?: {
|
|
@@ -6664,6 +6876,31 @@ export interface operations {
|
|
|
6664
6876
|
default: components["responses"]["ProblemResponse"];
|
|
6665
6877
|
};
|
|
6666
6878
|
};
|
|
6879
|
+
ConvertOrgToRegular: {
|
|
6880
|
+
parameters: {
|
|
6881
|
+
query?: never;
|
|
6882
|
+
header?: never;
|
|
6883
|
+
path: {
|
|
6884
|
+
orgId: components["schemas"]["OrgID"];
|
|
6885
|
+
};
|
|
6886
|
+
cookie?: never;
|
|
6887
|
+
};
|
|
6888
|
+
requestBody?: never;
|
|
6889
|
+
responses: {
|
|
6890
|
+
/** @description Converted */
|
|
6891
|
+
200: {
|
|
6892
|
+
headers: {
|
|
6893
|
+
[name: string]: unknown;
|
|
6894
|
+
};
|
|
6895
|
+
content: {
|
|
6896
|
+
"application/json": components["schemas"]["Organization"];
|
|
6897
|
+
};
|
|
6898
|
+
};
|
|
6899
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6900
|
+
409: components["responses"]["ProblemResponse"];
|
|
6901
|
+
default: components["responses"]["ProblemResponse"];
|
|
6902
|
+
};
|
|
6903
|
+
};
|
|
6667
6904
|
SearchOrgMembers: {
|
|
6668
6905
|
parameters: {
|
|
6669
6906
|
query?: {
|
|
@@ -8180,8 +8417,10 @@ export interface operations {
|
|
|
8180
8417
|
ListOrgVerificationSessions: {
|
|
8181
8418
|
parameters: {
|
|
8182
8419
|
query?: {
|
|
8183
|
-
/** @description Only return sessions
|
|
8184
|
-
|
|
8420
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
8421
|
+
sessionId?: string;
|
|
8422
|
+
/** @description Only return sessions for this exact provider id. */
|
|
8423
|
+
providerId?: string;
|
|
8185
8424
|
/** @description Only return sessions in this status. */
|
|
8186
8425
|
status?: components["schemas"]["VerificationStatus"];
|
|
8187
8426
|
/** @description Only return sessions resolved to this exact provider version. */
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reclaimprotocol/client",
|
|
3
3
|
"title": "Reclaim Client",
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.20",
|
|
5
5
|
"description": "Typed SDK/HTTP client SDK for the Reclaim Protocol — the programmatic way to use Reclaim Protocol to verify **data points** about your users (a follower count, an account balance, an order). Can be directly integrated by apps to request verification for their users using Reclaim Protocol and verify the results.",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"sideEffects": false,
|
package/src/routes.gen.ts
CHANGED
|
@@ -17,6 +17,7 @@ export const ROUTES = {
|
|
|
17
17
|
"AdminProviders": {"method":"get","path":"/admin/providers"},
|
|
18
18
|
"AdminReviews": {"method":"get","path":"/admin/reviews"},
|
|
19
19
|
"AdminSessions": {"method":"get","path":"/admin/sessions"},
|
|
20
|
+
"AdminSetUserOrgLimit": {"method":"put","path":"/users/{userId}/org-limit"},
|
|
20
21
|
"AdminSubscribeOrgPlan": {"method":"post","path":"/admin/orgs/{orgId}/billing/subscribe"},
|
|
21
22
|
"AdminThemes": {"method":"get","path":"/admin/themes"},
|
|
22
23
|
"AdminUsers": {"method":"get","path":"/admin/users"},
|
|
@@ -26,6 +27,8 @@ export const ROUTES = {
|
|
|
26
27
|
"CancelPublicListingRequest": {"method":"post","path":"/providers/{providerId}/versions/{version}/cancel-review"},
|
|
27
28
|
"ChangeOrgPlan": {"method":"post","path":"/orgs/{orgId}/billing/change-plan"},
|
|
28
29
|
"ConsentPage": {"method":"get","path":"/oauth/consent"},
|
|
30
|
+
"ConvertOrgToRegular": {"method":"post","path":"/orgs/{orgId}/convert"},
|
|
31
|
+
"CreateAgentBrowserSession": {"method":"post","path":"/orgs/{orgId}/agent-browser-sessions"},
|
|
29
32
|
"CreateBillingCheckoutSession": {"method":"post","path":"/orgs/{orgId}/billing/checkout"},
|
|
30
33
|
"CreateBillingPortalSession": {"method":"post","path":"/orgs/{orgId}/billing/portal"},
|
|
31
34
|
"CreateCallbackSubscription": {"method":"post","path":"/verifications/callback-subscriptions"},
|
|
@@ -52,6 +55,7 @@ export const ROUTES = {
|
|
|
52
55
|
"DiscoverResolve": {"method":"get","path":"/discover/resolve"},
|
|
53
56
|
"DiscoverTeachAgent": {"method":"get","path":"/discover/teach"},
|
|
54
57
|
"DiscoverWebsites": {"method":"get","path":"/discover/websites"},
|
|
58
|
+
"DisposeAgentBrowserSession": {"method":"delete","path":"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}"},
|
|
55
59
|
"DisposeVerificationSession": {"method":"post","path":"/v/{sessionId}/dispose"},
|
|
56
60
|
"Docs": {"method":"get","path":"/docs"},
|
|
57
61
|
"ExplorePreviewImage": {"method":"get","path":"/og/explore.png"},
|
package/src/types/openapi.gen.ts
CHANGED
|
@@ -13,7 +13,7 @@ export interface paths {
|
|
|
13
13
|
};
|
|
14
14
|
/**
|
|
15
15
|
* Discover home — search a website to verify
|
|
16
|
-
* @description Default home page. A website-first search: the visitor types a website and picks one to continue to `/site/{domain}`, where they choose what data to prove. Renders popular websites below the search.
|
|
16
|
+
* @description Default home page. A website-first search: the visitor types a website and picks one to continue to `/site/{domain}`, where they choose what data to prove. Renders popular websites below the search, plus tag pills to narrow them.
|
|
17
17
|
*/
|
|
18
18
|
get: operations["Index"];
|
|
19
19
|
put?: never;
|
|
@@ -180,7 +180,7 @@ export interface paths {
|
|
|
180
180
|
put?: never;
|
|
181
181
|
/**
|
|
182
182
|
* Mint a SANDBOX test verification session for the selection
|
|
183
|
-
* @description Creates a real SANDBOX verification session
|
|
183
|
+
* @description Creates a real SANDBOX verification session for the selected data points, so the signed-in member can test the flow on `/v/{sessionId}` without registering a callback subscription. Runs under an organization the member owns (`orgId` in the body; defaults to their personal organization). The provider set is recomputed server-side from the selection.
|
|
184
184
|
*/
|
|
185
185
|
post: operations["SiteBuildTry"];
|
|
186
186
|
delete?: never;
|
|
@@ -240,7 +240,7 @@ export interface paths {
|
|
|
240
240
|
put?: never;
|
|
241
241
|
/**
|
|
242
242
|
* Author an AI (llm) provider and go to its build screen
|
|
243
|
-
* @description Creates an `llm`-verification provider under the signed-in member
|
|
243
|
+
* @description Creates an `llm`-verification provider under an organization the signed-in member owns (their personal org by default), seeded with an extraction prompt for the selected/missing data points (and carrying the working response matches from the resolved structured providers). If `fromProviderId` is an editable draft the viewer owns, it versions THAT instead. Returns the build page's AI dialog body (the editable prompt + "Try with AI"). HTML / HTMX fragment.
|
|
244
244
|
*/
|
|
245
245
|
post: operations["SiteAiProvider"];
|
|
246
246
|
delete?: never;
|
|
@@ -477,7 +477,7 @@ export interface paths {
|
|
|
477
477
|
};
|
|
478
478
|
/**
|
|
479
479
|
* Explore verification sessions (admin-only)
|
|
480
|
-
* @description Admin only. Search verification sessions across all organizations —
|
|
480
|
+
* @description Admin only. Search verification sessions across all organizations — filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `claimantClientId`, `orgId` (all exact match), `status`, and a `createdAfter`/`createdBefore` time range. Rows link to the org-scoped session detail page (admins can open any org's pages). Capped at 100, newest first.
|
|
481
481
|
*/
|
|
482
482
|
get: operations["AdminSessions"];
|
|
483
483
|
put?: never;
|
|
@@ -1003,7 +1003,7 @@ export interface paths {
|
|
|
1003
1003
|
};
|
|
1004
1004
|
/**
|
|
1005
1005
|
* Verification page for an end-user
|
|
1006
|
-
* @description Opens a
|
|
1006
|
+
* @description Opens a Builder-hosted remote-browser session, embeds its live view in an iframe, and kicks off the capture → prove → submit run for this verification session.
|
|
1007
1007
|
*/
|
|
1008
1008
|
get: operations["VerificationPage"];
|
|
1009
1009
|
put?: never;
|
|
@@ -1123,7 +1123,7 @@ export interface paths {
|
|
|
1123
1123
|
};
|
|
1124
1124
|
/**
|
|
1125
1125
|
* Get the OpenAPI specification (YAML)
|
|
1126
|
-
* @description
|
|
1126
|
+
* @description The OpenAPI 3.1 document for this API, self-contained (every `$ref` is internal). Feed it to API tooling and SDK generators. Reclaim staff additionally see the internal tag groups; everyone else gets the integration surface only.
|
|
1127
1127
|
*/
|
|
1128
1128
|
get: operations["OpenApiSpec"];
|
|
1129
1129
|
put?: never;
|
|
@@ -1143,7 +1143,7 @@ export interface paths {
|
|
|
1143
1143
|
};
|
|
1144
1144
|
/**
|
|
1145
1145
|
* View the API reference (Scalar UI)
|
|
1146
|
-
* @description
|
|
1146
|
+
* @description Interactive API reference rendered by Scalar from `GET /openapi.yaml`, so it shows whichever document the viewer is served.
|
|
1147
1147
|
*/
|
|
1148
1148
|
get: operations["Docs"];
|
|
1149
1149
|
put?: never;
|
|
@@ -1312,6 +1312,26 @@ export interface paths {
|
|
|
1312
1312
|
patch?: never;
|
|
1313
1313
|
trace?: never;
|
|
1314
1314
|
};
|
|
1315
|
+
"/users/{userId}/org-limit": {
|
|
1316
|
+
parameters: {
|
|
1317
|
+
query?: never;
|
|
1318
|
+
header?: never;
|
|
1319
|
+
path?: never;
|
|
1320
|
+
cookie?: never;
|
|
1321
|
+
};
|
|
1322
|
+
get?: never;
|
|
1323
|
+
/**
|
|
1324
|
+
* Set a user's org-creation limit (admin-only)
|
|
1325
|
+
* @description Admin only. Overrides how many ACTIVE organizations the user may create (the platform default is 3). Restore the default by sending `null` (JSON) or an empty `limit` (form).
|
|
1326
|
+
*/
|
|
1327
|
+
put: operations["AdminSetUserOrgLimit"];
|
|
1328
|
+
post?: never;
|
|
1329
|
+
delete?: never;
|
|
1330
|
+
options?: never;
|
|
1331
|
+
head?: never;
|
|
1332
|
+
patch?: never;
|
|
1333
|
+
trace?: never;
|
|
1334
|
+
};
|
|
1315
1335
|
"/orgs": {
|
|
1316
1336
|
parameters: {
|
|
1317
1337
|
query?: never;
|
|
@@ -1333,6 +1353,46 @@ export interface paths {
|
|
|
1333
1353
|
patch?: never;
|
|
1334
1354
|
trace?: never;
|
|
1335
1355
|
};
|
|
1356
|
+
"/orgs/{orgId}/agent-browser-sessions": {
|
|
1357
|
+
parameters: {
|
|
1358
|
+
query?: never;
|
|
1359
|
+
header?: never;
|
|
1360
|
+
path?: never;
|
|
1361
|
+
cookie?: never;
|
|
1362
|
+
};
|
|
1363
|
+
get?: never;
|
|
1364
|
+
put?: never;
|
|
1365
|
+
/**
|
|
1366
|
+
* Create a remote browser session for provider authoring
|
|
1367
|
+
* @description Allocates a Builder-managed Popcorn browser for an authenticated agent. The caller must be an active editor of the organization. Creating the browser consumes one use from the seeded Builder verification client's VERIFICATION quota pool, so the organization's normal sandbox, plan, overage, and credit restrictions apply. The live-view URL may be shared with a volunteer; the unrestricted CDP URL is a secret intended only for the authenticated local agent process.
|
|
1368
|
+
*/
|
|
1369
|
+
post: operations["CreateAgentBrowserSession"];
|
|
1370
|
+
delete?: never;
|
|
1371
|
+
options?: never;
|
|
1372
|
+
head?: never;
|
|
1373
|
+
patch?: never;
|
|
1374
|
+
trace?: never;
|
|
1375
|
+
};
|
|
1376
|
+
"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}": {
|
|
1377
|
+
parameters: {
|
|
1378
|
+
query?: never;
|
|
1379
|
+
header?: never;
|
|
1380
|
+
path?: never;
|
|
1381
|
+
cookie?: never;
|
|
1382
|
+
};
|
|
1383
|
+
get?: never;
|
|
1384
|
+
put?: never;
|
|
1385
|
+
post?: never;
|
|
1386
|
+
/**
|
|
1387
|
+
* Dispose a remote provider-authoring browser
|
|
1388
|
+
* @description Tears down an agent-owned Popcorn browser immediately. Idempotent for a session that was already disposed. The caller must still be an active editor of the owning organization.
|
|
1389
|
+
*/
|
|
1390
|
+
delete: operations["DisposeAgentBrowserSession"];
|
|
1391
|
+
options?: never;
|
|
1392
|
+
head?: never;
|
|
1393
|
+
patch?: never;
|
|
1394
|
+
trace?: never;
|
|
1395
|
+
};
|
|
1336
1396
|
"/orgs/{orgId}": {
|
|
1337
1397
|
parameters: {
|
|
1338
1398
|
query?: never;
|
|
@@ -1358,6 +1418,26 @@ export interface paths {
|
|
|
1358
1418
|
patch: operations["UpdateOrg"];
|
|
1359
1419
|
trace?: never;
|
|
1360
1420
|
};
|
|
1421
|
+
"/orgs/{orgId}/convert": {
|
|
1422
|
+
parameters: {
|
|
1423
|
+
query?: never;
|
|
1424
|
+
header?: never;
|
|
1425
|
+
path?: never;
|
|
1426
|
+
cookie?: never;
|
|
1427
|
+
};
|
|
1428
|
+
get?: never;
|
|
1429
|
+
put?: never;
|
|
1430
|
+
/**
|
|
1431
|
+
* Convert a personal organization to a regular organization
|
|
1432
|
+
* @description Owner only. One-way: flips a `PERSONAL` organization (auto-provisioned at sign-up, sandbox-only, single-member) to a regular `ORG`, unlocking billing, plan & usage, and member invites. All providers, sessions, credentials and themes carry over. `409` when the organization is not `PERSONAL`.
|
|
1433
|
+
*/
|
|
1434
|
+
post: operations["ConvertOrgToRegular"];
|
|
1435
|
+
delete?: never;
|
|
1436
|
+
options?: never;
|
|
1437
|
+
head?: never;
|
|
1438
|
+
patch?: never;
|
|
1439
|
+
trace?: never;
|
|
1440
|
+
};
|
|
1361
1441
|
"/orgs/{orgId}/members": {
|
|
1362
1442
|
parameters: {
|
|
1363
1443
|
query?: never;
|
|
@@ -2167,7 +2247,7 @@ export interface paths {
|
|
|
2167
2247
|
};
|
|
2168
2248
|
/**
|
|
2169
2249
|
* List an organization's verification sessions
|
|
2170
|
-
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2250
|
+
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2171
2251
|
*
|
|
2172
2252
|
* Note: `status` filters on the stored column. A session that has passed `expiresAt` but has not yet been swept is reported as `expired` in its body while still stored as `pending`, so `status=expired` may not match such sessions until the sweep runs.
|
|
2173
2253
|
*/
|
|
@@ -2583,6 +2663,23 @@ export interface components {
|
|
|
2583
2663
|
* @description Verification session id (UUID v7 when supported). Also echoed in the result payload as `reclaimSessionId`.
|
|
2584
2664
|
*/
|
|
2585
2665
|
SessionID: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* Format: uuid
|
|
2668
|
+
* @description Builder-managed remote browser session id.
|
|
2669
|
+
*/
|
|
2670
|
+
AgentBrowserSessionID: string;
|
|
2671
|
+
/** @description A short-lived Popcorn browser allocated for provider authoring. Treat `cdpUrl` and `apiUrl` as credentials: the local agent consumes them and must not display, persist, or share them. `liveViewUrl` is intentionally shareable with the volunteer operating the browser. */
|
|
2672
|
+
AgentBrowserSession: {
|
|
2673
|
+
id: components["schemas"]["AgentBrowserSessionID"];
|
|
2674
|
+
orgId: components["schemas"]["OrgID"];
|
|
2675
|
+
/** Format: uri */
|
|
2676
|
+
liveViewUrl: string;
|
|
2677
|
+
/** Format: uri */
|
|
2678
|
+
readonly cdpUrl: string;
|
|
2679
|
+
/** Format: uri */
|
|
2680
|
+
readonly apiUrl?: string;
|
|
2681
|
+
expiresAt: components["schemas"]["Timestamp"];
|
|
2682
|
+
};
|
|
2586
2683
|
/**
|
|
2587
2684
|
* Format: uuid
|
|
2588
2685
|
* @description Stable id for a callback subscription.
|
|
@@ -3763,10 +3860,21 @@ export interface components {
|
|
|
3763
3860
|
context?: {
|
|
3764
3861
|
[key: string]: string;
|
|
3765
3862
|
};
|
|
3863
|
+
orgId?: components["schemas"]["OrgID"];
|
|
3864
|
+
};
|
|
3865
|
+
/** @description Body for `POST /site/{domain}/ai-provider`. `orgId` is optional: which owned organization the AI provider is authored under (defaults to the member's personal organization, or their first owned org). `url` is required only when `domain` has no existing catalog data — the build page's confirm-URL step supplies it, and the draft is scaffolded under whatever domain that URL actually resolves to (which may differ from `domain`), not the unconfirmed search text the build page was first opened with. */
|
|
3866
|
+
SiteAiProviderBody: {
|
|
3867
|
+
orgId?: components["schemas"]["OrgID"];
|
|
3868
|
+
/** @description Confirmed website URL, for a domain with no existing catalog data. Verified reachable before anything is created. */
|
|
3869
|
+
url?: string;
|
|
3870
|
+
};
|
|
3871
|
+
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
3872
|
+
AdminSetUserOrgLimitBody: {
|
|
3873
|
+
limit?: number | string | null;
|
|
3766
3874
|
};
|
|
3767
3875
|
/** @description Body for `POST /site/{domain}/try-ai`. An optional edited extraction prompt, saved as a new draft build before the sandbox session is minted. */
|
|
3768
3876
|
SiteTryAiBody: {
|
|
3769
|
-
/** @description The edited extraction prompt for the AI provider. */
|
|
3877
|
+
/** @description The edited extraction prompt for the AI provider. Gated by the prompt guard before it is stored (see docs/prompt-guard.md); the length here documents the same ceiling the guard enforces. */
|
|
3770
3878
|
prompt?: string;
|
|
3771
3879
|
};
|
|
3772
3880
|
/** @description A single data point selectable on the `/site/{domain}` page, with how many visible providers expose it, one example provider slug, and one `references` entry per provider describing how that provider proves it (what the site page's source picker offers as selectable options). */
|
|
@@ -4111,7 +4219,7 @@ export interface components {
|
|
|
4111
4219
|
CreateProviderVersionRequest: {
|
|
4112
4220
|
/** @description Defaults to `structured` server-side when omitted; pass `llm` (with a `prompt`) to author an AI-verification provider. */
|
|
4113
4221
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4114
|
-
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. */
|
|
4222
|
+
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4115
4223
|
prompt?: string;
|
|
4116
4224
|
/**
|
|
4117
4225
|
* @description The version of this Provider upon creation. Clients typically omit this and let the dashboard's bump-suggestion compute it. When omitted, defaults to `0.1.0` for the very first version; otherwise the caller is expected to pass a value higher than the latest existing version.
|
|
@@ -4138,7 +4246,7 @@ export interface components {
|
|
|
4138
4246
|
/** Format: uri */
|
|
4139
4247
|
initialUrl?: string;
|
|
4140
4248
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4141
|
-
/** @description Extraction prompt, used when `verificationType` is `llm`. */
|
|
4249
|
+
/** @description Extraction prompt, used when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4142
4250
|
prompt?: string;
|
|
4143
4251
|
requests?: components["schemas"]["RequestSelection"][];
|
|
4144
4252
|
allowedJsRequests?: components["schemas"]["RequestSelectionTemplate"][];
|
|
@@ -4583,7 +4691,12 @@ export type $defs = Record<string, never>;
|
|
|
4583
4691
|
export interface operations {
|
|
4584
4692
|
Index: {
|
|
4585
4693
|
parameters: {
|
|
4586
|
-
query?:
|
|
4694
|
+
query?: {
|
|
4695
|
+
/** @description Free-text query matched against website domain, data points, brand title, and description. Restores the search box and results on a shared/bookmarked link. */
|
|
4696
|
+
q?: string;
|
|
4697
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
4698
|
+
tag?: string[];
|
|
4699
|
+
};
|
|
4587
4700
|
header?: never;
|
|
4588
4701
|
path?: never;
|
|
4589
4702
|
cookie?: never;
|
|
@@ -4687,6 +4800,8 @@ export interface operations {
|
|
|
4687
4800
|
query?: {
|
|
4688
4801
|
/** @description Free-text query matched against website domain, data points, brand title, and description. Omit for the popular-websites list. */
|
|
4689
4802
|
q?: string;
|
|
4803
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
4804
|
+
tag?: string[];
|
|
4690
4805
|
};
|
|
4691
4806
|
header?: never;
|
|
4692
4807
|
path?: never;
|
|
@@ -4992,7 +5107,13 @@ export interface operations {
|
|
|
4992
5107
|
};
|
|
4993
5108
|
cookie?: never;
|
|
4994
5109
|
};
|
|
4995
|
-
|
|
5110
|
+
/** @description Optional: which owned organization to author the provider under. */
|
|
5111
|
+
requestBody?: {
|
|
5112
|
+
content: {
|
|
5113
|
+
"application/x-www-form-urlencoded": components["schemas"]["SiteAiProviderBody"];
|
|
5114
|
+
"application/json": components["schemas"]["SiteAiProviderBody"];
|
|
5115
|
+
};
|
|
5116
|
+
};
|
|
4996
5117
|
responses: {
|
|
4997
5118
|
/** @description The AI dialog body (editable prompt + Try with AI). */
|
|
4998
5119
|
200: {
|
|
@@ -5011,6 +5132,8 @@ export interface operations {
|
|
|
5011
5132
|
query: {
|
|
5012
5133
|
/** @description The AI provider to try. */
|
|
5013
5134
|
providerId: components["schemas"]["ProviderID"];
|
|
5135
|
+
/** @description Which owned organization the sandbox session runs under (defaults to the member's personal organization, or their first owned org). Must own the provider. */
|
|
5136
|
+
orgId?: components["schemas"]["OrgID"];
|
|
5014
5137
|
};
|
|
5015
5138
|
header?: never;
|
|
5016
5139
|
path: {
|
|
@@ -5367,9 +5490,19 @@ export interface operations {
|
|
|
5367
5490
|
AdminSessions: {
|
|
5368
5491
|
parameters: {
|
|
5369
5492
|
query?: {
|
|
5370
|
-
/** @description
|
|
5371
|
-
|
|
5493
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
5494
|
+
sessionId?: string;
|
|
5495
|
+
/** @description Only return sessions for this exact provider id. */
|
|
5496
|
+
providerId?: string;
|
|
5497
|
+
/** @description Only return the session matching this claimant client id. */
|
|
5498
|
+
claimantClientId?: string;
|
|
5499
|
+
/** @description Only return sessions belonging to this exact organization id. */
|
|
5500
|
+
orgId?: string;
|
|
5372
5501
|
status?: components["schemas"]["VerificationStatus"];
|
|
5502
|
+
/** @description Only return sessions created at or after this time (inclusive). */
|
|
5503
|
+
createdAfter?: string;
|
|
5504
|
+
/** @description Only return sessions created at or before this time (inclusive). */
|
|
5505
|
+
createdBefore?: string;
|
|
5373
5506
|
};
|
|
5374
5507
|
header?: never;
|
|
5375
5508
|
path?: never;
|
|
@@ -6531,6 +6664,34 @@ export interface operations {
|
|
|
6531
6664
|
default: components["responses"]["ProblemResponse"];
|
|
6532
6665
|
};
|
|
6533
6666
|
};
|
|
6667
|
+
AdminSetUserOrgLimit: {
|
|
6668
|
+
parameters: {
|
|
6669
|
+
query?: never;
|
|
6670
|
+
header?: never;
|
|
6671
|
+
path: {
|
|
6672
|
+
userId: components["schemas"]["UserID"];
|
|
6673
|
+
};
|
|
6674
|
+
cookie?: never;
|
|
6675
|
+
};
|
|
6676
|
+
requestBody: {
|
|
6677
|
+
content: {
|
|
6678
|
+
"application/json": components["schemas"]["AdminSetUserOrgLimitBody"];
|
|
6679
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminSetUserOrgLimitBody"];
|
|
6680
|
+
};
|
|
6681
|
+
};
|
|
6682
|
+
responses: {
|
|
6683
|
+
/** @description Updated. */
|
|
6684
|
+
204: {
|
|
6685
|
+
headers: {
|
|
6686
|
+
[name: string]: unknown;
|
|
6687
|
+
};
|
|
6688
|
+
content?: never;
|
|
6689
|
+
};
|
|
6690
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6691
|
+
404: components["responses"]["ProblemResponse"];
|
|
6692
|
+
default: components["responses"]["ProblemResponse"];
|
|
6693
|
+
};
|
|
6694
|
+
};
|
|
6534
6695
|
ListOrgs: {
|
|
6535
6696
|
parameters: {
|
|
6536
6697
|
query?: {
|
|
@@ -6585,6 +6746,57 @@ export interface operations {
|
|
|
6585
6746
|
default: components["responses"]["ProblemResponse"];
|
|
6586
6747
|
};
|
|
6587
6748
|
};
|
|
6749
|
+
CreateAgentBrowserSession: {
|
|
6750
|
+
parameters: {
|
|
6751
|
+
query?: never;
|
|
6752
|
+
header?: never;
|
|
6753
|
+
path: {
|
|
6754
|
+
orgId: components["schemas"]["OrgID"];
|
|
6755
|
+
};
|
|
6756
|
+
cookie?: never;
|
|
6757
|
+
};
|
|
6758
|
+
requestBody?: never;
|
|
6759
|
+
responses: {
|
|
6760
|
+
/** @description Remote authoring browser created. */
|
|
6761
|
+
201: {
|
|
6762
|
+
headers: {
|
|
6763
|
+
"Cache-Control"?: string;
|
|
6764
|
+
[name: string]: unknown;
|
|
6765
|
+
};
|
|
6766
|
+
content: {
|
|
6767
|
+
"application/json": components["schemas"]["AgentBrowserSession"];
|
|
6768
|
+
};
|
|
6769
|
+
};
|
|
6770
|
+
402: components["responses"]["ProblemResponse"];
|
|
6771
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6772
|
+
429: components["responses"]["ProblemResponse"];
|
|
6773
|
+
default: components["responses"]["ProblemResponse"];
|
|
6774
|
+
};
|
|
6775
|
+
};
|
|
6776
|
+
DisposeAgentBrowserSession: {
|
|
6777
|
+
parameters: {
|
|
6778
|
+
query?: never;
|
|
6779
|
+
header?: never;
|
|
6780
|
+
path: {
|
|
6781
|
+
orgId: components["schemas"]["OrgID"];
|
|
6782
|
+
browserSessionId: components["schemas"]["AgentBrowserSessionID"];
|
|
6783
|
+
};
|
|
6784
|
+
cookie?: never;
|
|
6785
|
+
};
|
|
6786
|
+
requestBody?: never;
|
|
6787
|
+
responses: {
|
|
6788
|
+
/** @description Browser disposed or already absent. */
|
|
6789
|
+
204: {
|
|
6790
|
+
headers: {
|
|
6791
|
+
[name: string]: unknown;
|
|
6792
|
+
};
|
|
6793
|
+
content?: never;
|
|
6794
|
+
};
|
|
6795
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6796
|
+
404: components["responses"]["ProblemResponse"];
|
|
6797
|
+
default: components["responses"]["ProblemResponse"];
|
|
6798
|
+
};
|
|
6799
|
+
};
|
|
6588
6800
|
GetOrg: {
|
|
6589
6801
|
parameters: {
|
|
6590
6802
|
query?: {
|
|
@@ -6665,6 +6877,31 @@ export interface operations {
|
|
|
6665
6877
|
default: components["responses"]["ProblemResponse"];
|
|
6666
6878
|
};
|
|
6667
6879
|
};
|
|
6880
|
+
ConvertOrgToRegular: {
|
|
6881
|
+
parameters: {
|
|
6882
|
+
query?: never;
|
|
6883
|
+
header?: never;
|
|
6884
|
+
path: {
|
|
6885
|
+
orgId: components["schemas"]["OrgID"];
|
|
6886
|
+
};
|
|
6887
|
+
cookie?: never;
|
|
6888
|
+
};
|
|
6889
|
+
requestBody?: never;
|
|
6890
|
+
responses: {
|
|
6891
|
+
/** @description Converted */
|
|
6892
|
+
200: {
|
|
6893
|
+
headers: {
|
|
6894
|
+
[name: string]: unknown;
|
|
6895
|
+
};
|
|
6896
|
+
content: {
|
|
6897
|
+
"application/json": components["schemas"]["Organization"];
|
|
6898
|
+
};
|
|
6899
|
+
};
|
|
6900
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6901
|
+
409: components["responses"]["ProblemResponse"];
|
|
6902
|
+
default: components["responses"]["ProblemResponse"];
|
|
6903
|
+
};
|
|
6904
|
+
};
|
|
6668
6905
|
SearchOrgMembers: {
|
|
6669
6906
|
parameters: {
|
|
6670
6907
|
query?: {
|
|
@@ -8181,8 +8418,10 @@ export interface operations {
|
|
|
8181
8418
|
ListOrgVerificationSessions: {
|
|
8182
8419
|
parameters: {
|
|
8183
8420
|
query?: {
|
|
8184
|
-
/** @description Only return sessions
|
|
8185
|
-
|
|
8421
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
8422
|
+
sessionId?: string;
|
|
8423
|
+
/** @description Only return sessions for this exact provider id. */
|
|
8424
|
+
providerId?: string;
|
|
8186
8425
|
/** @description Only return sessions in this status. */
|
|
8187
8426
|
status?: components["schemas"]["VerificationStatus"];
|
|
8188
8427
|
/** @description Only return sessions resolved to this exact provider version. */
|