@reclaimprotocol/client 0.1.31 → 0.1.33
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 +7 -15
- package/lib/routes.gen.js +3 -5
- package/lib/types/openapi.gen.d.ts +113 -192
- package/lib/types/openapi.gen.js +1 -1
- package/package.json +1 -1
- package/src/routes.gen.ts +3 -5
- package/src/types/openapi.gen.ts +114 -193
package/src/types/openapi.gen.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// AUTO-GENERATED by packages/app/scripts/openapi-typegen.ts
|
|
2
|
-
// from packages/app/openapi.yaml (spec v0.1.0, source sha256:
|
|
2
|
+
// from packages/app/openapi.yaml (spec v0.1.0, source sha256:3e28ff308da3).
|
|
3
3
|
// The hash catches drift the version misses (a spec can change without a
|
|
4
4
|
// version bump) — do not remove it as "redundant" with the version.
|
|
5
5
|
// Run `npm run openapi:gen --workspace=packages/app` to regenerate. Do not edit by hand.
|
|
@@ -17,8 +17,8 @@ export interface paths {
|
|
|
17
17
|
cookie?: never;
|
|
18
18
|
};
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
21
|
-
* @description
|
|
20
|
+
* Home — sign-in or Discover
|
|
21
|
+
* @description Signed in, renders Discover (see `GET /discover`). Signed out, renders the sign-in page; a signed-out link carrying Discover's `q` / `tag` redirects to `/discover` with them.
|
|
22
22
|
*/
|
|
23
23
|
get: operations["Index"];
|
|
24
24
|
put?: never;
|
|
@@ -29,6 +29,26 @@ export interface paths {
|
|
|
29
29
|
patch?: never;
|
|
30
30
|
trace?: never;
|
|
31
31
|
};
|
|
32
|
+
"/discover": {
|
|
33
|
+
parameters: {
|
|
34
|
+
query?: never;
|
|
35
|
+
header?: never;
|
|
36
|
+
path?: never;
|
|
37
|
+
cookie?: never;
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Discover — search a website to verify
|
|
41
|
+
* @description The Catalog. 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.
|
|
42
|
+
*/
|
|
43
|
+
get: operations["Discover"];
|
|
44
|
+
put?: never;
|
|
45
|
+
post?: never;
|
|
46
|
+
delete?: never;
|
|
47
|
+
options?: never;
|
|
48
|
+
head?: never;
|
|
49
|
+
patch?: never;
|
|
50
|
+
trace?: never;
|
|
51
|
+
};
|
|
32
52
|
"/providers": {
|
|
33
53
|
parameters: {
|
|
34
54
|
query?: never;
|
|
@@ -218,7 +238,7 @@ export interface paths {
|
|
|
218
238
|
put?: never;
|
|
219
239
|
/**
|
|
220
240
|
* Mint a SANDBOX test verification session for the selection
|
|
221
|
-
* @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
|
|
241
|
+
* @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 default organization). The provider set is recomputed server-side from the selection.
|
|
222
242
|
*/
|
|
223
243
|
post: operations["SiteBuildTry"];
|
|
224
244
|
delete?: never;
|
|
@@ -227,26 +247,6 @@ export interface paths {
|
|
|
227
247
|
patch?: never;
|
|
228
248
|
trace?: never;
|
|
229
249
|
};
|
|
230
|
-
"/site/{domain}/repair": {
|
|
231
|
-
parameters: {
|
|
232
|
-
query?: never;
|
|
233
|
-
header?: never;
|
|
234
|
-
path?: never;
|
|
235
|
-
cookie?: never;
|
|
236
|
-
};
|
|
237
|
-
/**
|
|
238
|
-
* Failure-aware "Repair with an AI coding agent" wizard fragment
|
|
239
|
-
* @description Body of the build page's repair dialog, lazy-loaded after a sandbox Try fails so the agent prompt includes the REAL failure (which provider(s) failed + the error reason, read from the session's event log) and the resolved provider set. HTML / HTMX fragment.
|
|
240
|
-
*/
|
|
241
|
-
get: operations["SiteBuildRepair"];
|
|
242
|
-
put?: never;
|
|
243
|
-
post?: never;
|
|
244
|
-
delete?: never;
|
|
245
|
-
options?: never;
|
|
246
|
-
head?: never;
|
|
247
|
-
patch?: never;
|
|
248
|
-
trace?: never;
|
|
249
|
-
};
|
|
250
250
|
"/site/{domain}/alternative": {
|
|
251
251
|
parameters: {
|
|
252
252
|
query?: never;
|
|
@@ -267,7 +267,7 @@ export interface paths {
|
|
|
267
267
|
patch?: never;
|
|
268
268
|
trace?: never;
|
|
269
269
|
};
|
|
270
|
-
"/
|
|
270
|
+
"/integrate": {
|
|
271
271
|
parameters: {
|
|
272
272
|
query?: never;
|
|
273
273
|
header?: never;
|
|
@@ -275,10 +275,10 @@ export interface paths {
|
|
|
275
275
|
cookie?: never;
|
|
276
276
|
};
|
|
277
277
|
/**
|
|
278
|
-
*
|
|
279
|
-
* @description
|
|
278
|
+
* Go to the Integrate page
|
|
279
|
+
* @description Where the "Build it with an agent" links lead, from pages that don't know the viewer's organization. Signed in, redirects to the Integrate page of the console's selected organization (else the viewer's default organization), on its coding-agent track. Signed out, redirects to sign-in and back here.
|
|
280
280
|
*/
|
|
281
|
-
get: operations["
|
|
281
|
+
get: operations["OpenIntegrate"];
|
|
282
282
|
put?: never;
|
|
283
283
|
post?: never;
|
|
284
284
|
delete?: never;
|
|
@@ -287,26 +287,6 @@ export interface paths {
|
|
|
287
287
|
patch?: never;
|
|
288
288
|
trace?: never;
|
|
289
289
|
};
|
|
290
|
-
"/discover/agent-wizard": {
|
|
291
|
-
parameters: {
|
|
292
|
-
query?: never;
|
|
293
|
-
header?: never;
|
|
294
|
-
path?: never;
|
|
295
|
-
cookie?: never;
|
|
296
|
-
};
|
|
297
|
-
get?: never;
|
|
298
|
-
put?: never;
|
|
299
|
-
/**
|
|
300
|
-
* Setup and prompt for the coding agent picked in the wizard
|
|
301
|
-
* @description Returns the last step of the "Build with an AI coding agent" wizard for the picked `agent`: how to attach the Reclaim MCP server, and the `basePrompt` with the optional `building` description appended. HTML / HTMX only (a fragment swapped into the open wizard).
|
|
302
|
-
*/
|
|
303
|
-
post: operations["DiscoverAgentWizard"];
|
|
304
|
-
delete?: never;
|
|
305
|
-
options?: never;
|
|
306
|
-
head?: never;
|
|
307
|
-
patch?: never;
|
|
308
|
-
trace?: never;
|
|
309
|
-
};
|
|
310
290
|
"/discover/resolve": {
|
|
311
291
|
parameters: {
|
|
312
292
|
query?: never;
|
|
@@ -1581,7 +1561,7 @@ export interface paths {
|
|
|
1581
1561
|
put?: never;
|
|
1582
1562
|
/**
|
|
1583
1563
|
* Create an organization
|
|
1584
|
-
* @description Creates a new `ORG`-kind organization with the caller as its first `OWNER`.
|
|
1564
|
+
* @description Creates a new `ORG`-kind organization with the caller as its first `OWNER`. Every user gets a default organization at sign-up, and it counts toward their org-creation limit (1 active organization unless Reclaim support raises it). Past the limit this returns `409`; contact support@reclaimprotocol.org to raise the limit or archive an organization.
|
|
1585
1565
|
*/
|
|
1586
1566
|
post: operations["CreateOrg"];
|
|
1587
1567
|
delete?: never;
|
|
@@ -1642,8 +1622,8 @@ export interface paths {
|
|
|
1642
1622
|
put?: never;
|
|
1643
1623
|
post?: never;
|
|
1644
1624
|
/**
|
|
1645
|
-
*
|
|
1646
|
-
* @description
|
|
1625
|
+
* Archive an organization
|
|
1626
|
+
* @description Reclaim staff only; owners ask support@reclaimprotocol.org to archive. Archives the organization, which frees a slot under its creator's org-creation limit. `403` for anyone else.
|
|
1647
1627
|
*/
|
|
1648
1628
|
delete: operations["DeleteOrg"];
|
|
1649
1629
|
options?: never;
|
|
@@ -1655,26 +1635,6 @@ export interface paths {
|
|
|
1655
1635
|
patch: operations["UpdateOrg"];
|
|
1656
1636
|
trace?: never;
|
|
1657
1637
|
};
|
|
1658
|
-
"/orgs/{orgId}/convert": {
|
|
1659
|
-
parameters: {
|
|
1660
|
-
query?: never;
|
|
1661
|
-
header?: never;
|
|
1662
|
-
path?: never;
|
|
1663
|
-
cookie?: never;
|
|
1664
|
-
};
|
|
1665
|
-
get?: never;
|
|
1666
|
-
put?: never;
|
|
1667
|
-
/**
|
|
1668
|
-
* Convert a personal organization to a regular organization
|
|
1669
|
-
* @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`.
|
|
1670
|
-
*/
|
|
1671
|
-
post: operations["ConvertOrgToRegular"];
|
|
1672
|
-
delete?: never;
|
|
1673
|
-
options?: never;
|
|
1674
|
-
head?: never;
|
|
1675
|
-
patch?: never;
|
|
1676
|
-
trace?: never;
|
|
1677
|
-
};
|
|
1678
1638
|
"/orgs/{orgId}/members": {
|
|
1679
1639
|
parameters: {
|
|
1680
1640
|
query?: never;
|
|
@@ -1690,7 +1650,7 @@ export interface paths {
|
|
|
1690
1650
|
put?: never;
|
|
1691
1651
|
/**
|
|
1692
1652
|
* Invite a member to an organization
|
|
1693
|
-
* @description Owner only. Invites a user to the organization by email. The invitee does **not** need to be a registered user — an invite is created in either case, and an invite email with an accept link is dispatched. The new row is returned with `status: PENDING`; it flips to `ACTIVE` only when the invitee explicitly accepts via `POST /orgs/{orgId}/invite`.
|
|
1653
|
+
* @description Owner only. Invites a user to the organization by email. The invitee does **not** need to be a registered user — an invite is created in either case, and an invite email with an accept link is dispatched. The new row is returned with `status: PENDING`; it flips to `ACTIVE` only when the invitee explicitly accepts via `POST /orgs/{orgId}/invite`.
|
|
1694
1654
|
*/
|
|
1695
1655
|
post: operations["AddOrgMember"];
|
|
1696
1656
|
delete?: never;
|
|
@@ -2748,16 +2708,32 @@ export interface paths {
|
|
|
2748
2708
|
/**
|
|
2749
2709
|
* Create a verification session
|
|
2750
2710
|
* @description Creates a verification session for an end-user to complete.
|
|
2711
|
+
*
|
|
2712
|
+
* **The response's `verificationUrl` is the one thing you need.** Send
|
|
2713
|
+
* your end user to it (redirect, link, or QR code): that is where they
|
|
2714
|
+
* verify. Everything else in the response is for tracking the session.
|
|
2715
|
+
*
|
|
2751
2716
|
* Authenticated by the consumer's `OrgToken`; the session is scoped to
|
|
2752
2717
|
* the resolved organization. The request carries no callback URLs —
|
|
2753
2718
|
* results are delivered to the org's pre-registered callback
|
|
2754
2719
|
* subscriptions.
|
|
2755
2720
|
*
|
|
2721
|
+
* `verificationClientUrl` picks where the user verifies. Omit it to use
|
|
2722
|
+
* the Reclaim Portal. The built-in clients are:
|
|
2723
|
+
*
|
|
2724
|
+
* | Client | `verificationClientUrl` |
|
|
2725
|
+
* | --- | --- |
|
|
2726
|
+
* | Reclaim Portal (default) | `https://build.reclaimprotocol.org/share/portals` |
|
|
2727
|
+
* | Verifier app | `https://build.reclaimprotocol.org/share/verifier-app` |
|
|
2728
|
+
* | Browser extension | `https://build.reclaimprotocol.org/share/reclaim-browser-extension` |
|
|
2729
|
+
* | Builder browser | `https://build.reclaimprotocol.org/share/builder` |
|
|
2730
|
+
* | In-app SDK | `https://build.reclaimprotocol.org/share/inapp-sdk` |
|
|
2731
|
+
*
|
|
2756
2732
|
* curl -X POST $BASE/verifications/sessions \
|
|
2757
2733
|
* -H "Authorization: Bearer $ORG_TOKEN" \
|
|
2758
2734
|
* -H 'Content-Type: application/json' \
|
|
2759
2735
|
* -d '{"providers":[{"providerId":"…","version":"^1.2.0"}],"context":{},
|
|
2760
|
-
* "verificationClientUrl":"https://
|
|
2736
|
+
* "verificationClientUrl":"https://build.reclaimprotocol.org/share/portals"}'
|
|
2761
2737
|
*
|
|
2762
2738
|
* Fails with `409 Conflict` if the organization has no callback
|
|
2763
2739
|
* subscription (there would be nowhere to deliver the result).
|
|
@@ -3065,8 +3041,8 @@ export interface paths {
|
|
|
3065
3041
|
cookie?: never;
|
|
3066
3042
|
};
|
|
3067
3043
|
/**
|
|
3068
|
-
* Get the stored
|
|
3069
|
-
* @description Returns the
|
|
3044
|
+
* Get the stored result(s) for a session
|
|
3045
|
+
* @description Returns the session's callback deliveries with their payloads — one item per callback subscription and event. Readable only by the consumer that created the session. The consumer's `OrgToken` must resolve to the session's organization. A recovery companion to push delivery, not a replacement for the callback: a signed result's `payload` (which can carry proofs) is kept only until its callback is delivered, or for 7 days while undelivered, then becomes `null`. When the organization enables encryption, a signed result is an ECIES ciphertext (base64url) that the holder of the matching private key decrypts client-side, else plaintext. Empty `items` until the session reaches a terminal state and a result has been submitted. Treat every returned payload as untrusted until `verifyResultFull` succeeds with the Builder issuer and JWKS URL.
|
|
3070
3046
|
*/
|
|
3071
3047
|
get: operations["GetVerificationResult"];
|
|
3072
3048
|
put?: never;
|
|
@@ -3088,7 +3064,7 @@ export interface paths {
|
|
|
3088
3064
|
put?: never;
|
|
3089
3065
|
/**
|
|
3090
3066
|
* Re-enqueue callback delivery for a session
|
|
3091
|
-
* @description Re-enqueues delivery of a session's stored result to its callback subscriptions. Use this after `list_verification_deliveries` shows a `failed` or dead-lettered delivery, once the consumer's callback endpoint is reachable again and answers 2xx — it re-attempts every not-yet-delivered callback for the session. Usable by the session creator (authenticated by the consumer's `OrgToken`) to recover from a transient consumer-side outage.
|
|
3067
|
+
* @description Re-enqueues delivery of a session's stored result to its callback subscriptions. Use this after `list_verification_deliveries` shows a `failed` or dead-lettered delivery, once the consumer's callback endpoint is reachable again and answers 2xx — it re-attempts every not-yet-delivered callback for the session. Usable by the session creator (authenticated by the consumer's `OrgToken`) to recover from a transient consumer-side outage. A result left undelivered for 7 days is purged and can no longer be retried.
|
|
3092
3068
|
*/
|
|
3093
3069
|
post: operations["RetryVerificationCallback"];
|
|
3094
3070
|
delete?: never;
|
|
@@ -3128,7 +3104,7 @@ export interface paths {
|
|
|
3128
3104
|
put?: never;
|
|
3129
3105
|
/**
|
|
3130
3106
|
* Retry a dead-lettered callback (admin-only)
|
|
3131
|
-
* @description Admin only. Re-enqueues a specific DLQ entry for delivery.
|
|
3107
|
+
* @description Admin only. Re-enqueues a specific DLQ entry for delivery. 410 when the result was undelivered for 7 days and has been purged.
|
|
3132
3108
|
*/
|
|
3133
3109
|
post: operations["RetryCallbackDlq"];
|
|
3134
3110
|
delete?: never;
|
|
@@ -3397,11 +3373,9 @@ export interface components {
|
|
|
3397
3373
|
*/
|
|
3398
3374
|
EntityStatus: "ACTIVE" | "ARCHIVED";
|
|
3399
3375
|
/**
|
|
3400
|
-
* @description - `
|
|
3401
|
-
* `
|
|
3402
|
-
*
|
|
3403
|
-
* - `ORG`: Explicitly created via `POST /orgs`. Multiple
|
|
3404
|
-
* members, always ≥ 1 active `OWNER`.
|
|
3376
|
+
* @description - `ORG`: A user's organization: the default one made at sign-up,
|
|
3377
|
+
* or one created via `POST /orgs`. Multiple members, always ≥ 1
|
|
3378
|
+
* active `OWNER`.
|
|
3405
3379
|
*
|
|
3406
3380
|
* - `ANONYMOUS`: System-managed, member-less org auto-created to
|
|
3407
3381
|
* anchor an unaffiliated ETH credential's org-level settings
|
|
@@ -3410,7 +3384,7 @@ export interface components {
|
|
|
3410
3384
|
* created or named by clients; has no members.
|
|
3411
3385
|
* @enum {string}
|
|
3412
3386
|
*/
|
|
3413
|
-
OrganizationKind: "
|
|
3387
|
+
OrganizationKind: "ORG" | "ANONYMOUS";
|
|
3414
3388
|
/** @description A free-form label attached to an entity for grouping and filtering in listings. Must start and end with an alphanumeric character; only ASCII letters, digits, spaces, and hyphens are allowed between. */
|
|
3415
3389
|
Tag: string;
|
|
3416
3390
|
ActorMetadata: {
|
|
@@ -3419,7 +3393,7 @@ export interface components {
|
|
|
3419
3393
|
/** @description Free-form notes from actor describing this change */
|
|
3420
3394
|
notes?: string;
|
|
3421
3395
|
};
|
|
3422
|
-
/** @description A registered user of the platform. Every newly created user
|
|
3396
|
+
/** @description A registered user of the platform. Every newly created user gets a default organization, whose id is exposed here as `defaultOrgId`. */
|
|
3423
3397
|
User: {
|
|
3424
3398
|
id: components["schemas"]["UserID"];
|
|
3425
3399
|
/**
|
|
@@ -3441,13 +3415,13 @@ export interface components {
|
|
|
3441
3415
|
* @enum {string}
|
|
3442
3416
|
*/
|
|
3443
3417
|
role?: "user" | "admin";
|
|
3444
|
-
/** @description ID of the
|
|
3445
|
-
|
|
3418
|
+
/** @description ID of the organization created for the user at sign-up. It is a regular organization and counts toward the user's org-creation limit. */
|
|
3419
|
+
defaultOrgId: components["schemas"]["OrgID"];
|
|
3446
3420
|
createMetadata: components["schemas"]["ActorMetadata"];
|
|
3447
3421
|
updateMetadata: components["schemas"]["ActorMetadata"];
|
|
3448
3422
|
};
|
|
3449
3423
|
/**
|
|
3450
|
-
* @description Role a user holds in an organization. `OWNER` can invite, promote, demote, and remove members, and delete the org. `MEMBER` has read/write access to resources owned by the org but cannot manage membership.
|
|
3424
|
+
* @description Role a user holds in an organization. `OWNER` can invite, promote, demote, and remove members, and delete the org. `MEMBER` has read/write access to resources owned by the org but cannot manage membership.
|
|
3451
3425
|
* @enum {string}
|
|
3452
3426
|
*/
|
|
3453
3427
|
OrganizationMemberRole: "OWNER" | "MEMBER";
|
|
@@ -3482,12 +3456,12 @@ export interface components {
|
|
|
3482
3456
|
/** @description Timestamp the invite was accepted. Absent while `status` is `PENDING`. */
|
|
3483
3457
|
joinedAt?: components["schemas"]["Timestamp"];
|
|
3484
3458
|
};
|
|
3485
|
-
/** @description A workspace that owns providers and other resources. Every user gets
|
|
3459
|
+
/** @description A workspace that owns providers and other resources. Every user gets a default `ORG` organization on signup; more can be created up to the user's org-creation limit, and any can have multiple members. System-managed `ANONYMOUS` organizations have no members (see `OrganizationKind`). */
|
|
3486
3460
|
Organization: {
|
|
3487
3461
|
id: components["schemas"]["OrgID"];
|
|
3488
|
-
/** @description Display name of the organization.
|
|
3462
|
+
/** @description Display name of the organization. A user's default org starts with their name and may be renamed by an owner. */
|
|
3489
3463
|
name: string;
|
|
3490
|
-
/** @description Whether this is a user's
|
|
3464
|
+
/** @description Whether this is a user's org or a system-managed anonymous one. */
|
|
3491
3465
|
kind: components["schemas"]["OrganizationKind"];
|
|
3492
3466
|
/**
|
|
3493
3467
|
* Format: uri
|
|
@@ -3496,7 +3470,7 @@ export interface components {
|
|
|
3496
3470
|
iconUrl?: string;
|
|
3497
3471
|
/** @description Marker for system-managed singleton orgs. `'reclaim-staff'` identifies the auto-membership org that every `@reclaimprotocol.org` user is enrolled into on login (PRD-1 §3). Absent on normal user-created orgs. Names, status, and lifecycle of system-managed orgs are server-protected — clients cannot rename, archive, or delete them. */
|
|
3498
3472
|
readonly systemId?: string;
|
|
3499
|
-
/** @description All users with a role in this organization. `
|
|
3473
|
+
/** @description All users with a role in this organization. `ORG` orgs always contain at least one active `OWNER`; `ANONYMOUS` orgs have no members, so this array is empty for them. */
|
|
3500
3474
|
members: components["schemas"]["OrganizationMember"][];
|
|
3501
3475
|
/** @description Providers owned by this organization. */
|
|
3502
3476
|
providers?: components["schemas"]["ProviderListItem"][];
|
|
@@ -4965,6 +4939,11 @@ export interface components {
|
|
|
4965
4939
|
[key: string]: string;
|
|
4966
4940
|
};
|
|
4967
4941
|
orgId?: components["schemas"]["OrgID"];
|
|
4942
|
+
/**
|
|
4943
|
+
* @description Built-in Verification Client that runs the sandbox session. Defaults to `portals`. `inapp-sdk` and `zkfetch` are not offered: neither has a browser flow to try.
|
|
4944
|
+
* @enum {string}
|
|
4945
|
+
*/
|
|
4946
|
+
verificationClient?: "portals" | "verifier-app" | "reclaim-browser-extension" | "builder";
|
|
4968
4947
|
};
|
|
4969
4948
|
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
4970
4949
|
AdminSetUserOrgLimitBody: {
|
|
@@ -5230,7 +5209,7 @@ export interface components {
|
|
|
5230
5209
|
webSettings: components["schemas"]["ProviderWebSettings"];
|
|
5231
5210
|
requiredContext?: components["schemas"]["ProviderRequiredContext"];
|
|
5232
5211
|
};
|
|
5233
|
-
/** @description Body for `POST /orgs` — just a name. Every org is created keyless, like
|
|
5212
|
+
/** @description Body for `POST /orgs` — just a name. Every org is created keyless, like each user's default org; its Ethereum (secp256k1) key pair is published separately via `PUT /orgs/{orgId}/keypair`, which is also where `canEncryptResult` is set. Creation deliberately collects nothing else so it never blocks on generating and safeguarding a private key. */
|
|
5234
5213
|
CreateOrgRequest: {
|
|
5235
5214
|
name: string;
|
|
5236
5215
|
};
|
|
@@ -5811,7 +5790,7 @@ export interface components {
|
|
|
5811
5790
|
* @description Id of the registered verification client whose base URL was used (see `verification_clients`).
|
|
5812
5791
|
*/
|
|
5813
5792
|
verificationClientId: string;
|
|
5814
|
-
/** @description Ready-to-share
|
|
5793
|
+
/** @description The URL to send your end user to: this is where they verify. Ready-to-share: the registered base URL with the session id attached by the Builder — substituted into a `{sessionId}` placeholder, or appended as a `?sessionId=…` query parameter. It always includes `api=2`, which selects Builder mode in dual-mode Verification Clients. The Consumer may append its own redirect query fields before opening the URL for the claimant; the Builder does not store or execute those redirects. */
|
|
5815
5794
|
verificationUrl: string;
|
|
5816
5795
|
createdAt: components["schemas"]["Timestamp"];
|
|
5817
5796
|
/** @description When the session stops being completable. After this, a still- `pending` session becomes `expired` on the next sweep and the end-user can no longer finish it. */
|
|
@@ -5842,7 +5821,14 @@ export interface components {
|
|
|
5842
5821
|
context: {
|
|
5843
5822
|
[key: string]: unknown;
|
|
5844
5823
|
};
|
|
5845
|
-
/**
|
|
5824
|
+
/**
|
|
5825
|
+
* @description Optional. Must exactly equal the base URL of a registered verification client (see the `verification_clients` registry / `/admin/verification-clients`). Omit to use the default (`portals`) client. The Builder resolves and stores the registered client UUID, then returns the ready-to-share `verificationUrl` with the session id and `api=2`. A URL that is not a registered client's base is rejected with 400. Consumers append any client-owned redirect parameters after receiving the URL; Builder does not manage them. The built-in clients are `{origin}/share/{name}`, listed in the examples.
|
|
5826
|
+
* @example https://build.reclaimprotocol.org/share/portals
|
|
5827
|
+
* @example https://build.reclaimprotocol.org/share/verifier-app
|
|
5828
|
+
* @example https://build.reclaimprotocol.org/share/reclaim-browser-extension
|
|
5829
|
+
* @example https://build.reclaimprotocol.org/share/builder
|
|
5830
|
+
* @example https://build.reclaimprotocol.org/share/inapp-sdk
|
|
5831
|
+
*/
|
|
5846
5832
|
verificationClientUrl?: string;
|
|
5847
5833
|
/** @description Optional active theme owned by the organization. When omitted, Builder snapshots the organization's most recently updated active theme. If the organization has no active theme, the Verification Client uses its default presentation. */
|
|
5848
5834
|
themeId?: components["schemas"]["ThemeID"];
|
|
@@ -6322,6 +6308,24 @@ export interface operations {
|
|
|
6322
6308
|
default: components["responses"]["ProblemResponse"];
|
|
6323
6309
|
};
|
|
6324
6310
|
};
|
|
6311
|
+
Discover: {
|
|
6312
|
+
parameters: {
|
|
6313
|
+
query?: {
|
|
6314
|
+
/** @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. */
|
|
6315
|
+
q?: string;
|
|
6316
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
6317
|
+
tag?: string[];
|
|
6318
|
+
};
|
|
6319
|
+
header?: never;
|
|
6320
|
+
path?: never;
|
|
6321
|
+
cookie?: never;
|
|
6322
|
+
};
|
|
6323
|
+
requestBody?: never;
|
|
6324
|
+
responses: {
|
|
6325
|
+
200: components["responses"]["HTMLResponse"];
|
|
6326
|
+
default: components["responses"]["ProblemResponse"];
|
|
6327
|
+
};
|
|
6328
|
+
};
|
|
6325
6329
|
Providers: {
|
|
6326
6330
|
parameters: {
|
|
6327
6331
|
query?: {
|
|
@@ -6673,40 +6677,6 @@ export interface operations {
|
|
|
6673
6677
|
default: components["responses"]["ProblemResponse"];
|
|
6674
6678
|
};
|
|
6675
6679
|
};
|
|
6676
|
-
SiteBuildRepair: {
|
|
6677
|
-
parameters: {
|
|
6678
|
-
query: {
|
|
6679
|
-
/** @description The failing sandbox session whose analytics seed the prompt. */
|
|
6680
|
-
sessionId: components["schemas"]["SessionID"];
|
|
6681
|
-
dataPoints?: string[];
|
|
6682
|
-
mode?: components["schemas"]["ResolveMode"];
|
|
6683
|
-
provided?: string[];
|
|
6684
|
-
/** @description Source pins: `pins[<dataPoint>]=<providerId>`. Pins the provider that must prove that data point; a pinned provider is taken first and is never pruned. Omit (or send empty) for Auto. A comma-separated list is also accepted — the first id that covers the point wins. */
|
|
6685
|
-
pins?: {
|
|
6686
|
-
[key: string]: string;
|
|
6687
|
-
};
|
|
6688
|
-
exclude?: components["schemas"]["ProviderID"][];
|
|
6689
|
-
};
|
|
6690
|
-
header?: never;
|
|
6691
|
-
path: {
|
|
6692
|
-
domain: string;
|
|
6693
|
-
};
|
|
6694
|
-
cookie?: never;
|
|
6695
|
-
};
|
|
6696
|
-
requestBody?: never;
|
|
6697
|
-
responses: {
|
|
6698
|
-
/** @description The repair wizard fragment. */
|
|
6699
|
-
200: {
|
|
6700
|
-
headers: {
|
|
6701
|
-
[name: string]: unknown;
|
|
6702
|
-
};
|
|
6703
|
-
content: {
|
|
6704
|
-
"text/html": components["schemas"]["HtmlContent"];
|
|
6705
|
-
};
|
|
6706
|
-
};
|
|
6707
|
-
default: components["responses"]["ProblemResponse"];
|
|
6708
|
-
};
|
|
6709
|
-
};
|
|
6710
6680
|
SiteBuildAlternative: {
|
|
6711
6681
|
parameters: {
|
|
6712
6682
|
query: {
|
|
@@ -6748,49 +6718,22 @@ export interface operations {
|
|
|
6748
6718
|
default: components["responses"]["ProblemResponse"];
|
|
6749
6719
|
};
|
|
6750
6720
|
};
|
|
6751
|
-
|
|
6721
|
+
OpenIntegrate: {
|
|
6752
6722
|
parameters: {
|
|
6753
|
-
query?:
|
|
6754
|
-
/** @description Website the user wanted to verify data from. */
|
|
6755
|
-
domain?: string;
|
|
6756
|
-
/** @description Specific data point the user could not find. */
|
|
6757
|
-
dataPoint?: string;
|
|
6758
|
-
};
|
|
6723
|
+
query?: never;
|
|
6759
6724
|
header?: never;
|
|
6760
6725
|
path?: never;
|
|
6761
6726
|
cookie?: never;
|
|
6762
6727
|
};
|
|
6763
6728
|
requestBody?: never;
|
|
6764
6729
|
responses: {
|
|
6765
|
-
|
|
6766
|
-
|
|
6767
|
-
|
|
6768
|
-
|
|
6769
|
-
DiscoverAgentWizard: {
|
|
6770
|
-
parameters: {
|
|
6771
|
-
query?: never;
|
|
6772
|
-
header?: never;
|
|
6773
|
-
path?: never;
|
|
6774
|
-
cookie?: never;
|
|
6775
|
-
};
|
|
6776
|
-
requestBody: {
|
|
6777
|
-
content: {
|
|
6778
|
-
"application/x-www-form-urlencoded": {
|
|
6779
|
-
/** @description The wizard's ready-to-paste task prompt. */
|
|
6780
|
-
basePrompt: string;
|
|
6781
|
-
/** @description Prefix of the wizard's element ids, so copy targets stay unique. */
|
|
6782
|
-
idPrefix: string;
|
|
6783
|
-
/** @description Picked coding agent; unknown values fall back to the first. */
|
|
6784
|
-
agent?: string;
|
|
6785
|
-
/** @description What the user is building, appended to the prompt. */
|
|
6786
|
-
building?: string;
|
|
6787
|
-
/** @description Label for `building` in the prompt. Defaults to "What I'm building". */
|
|
6788
|
-
lead?: string;
|
|
6730
|
+
/** @description Redirect to the Integrate page, or to sign-in. */
|
|
6731
|
+
302: {
|
|
6732
|
+
headers: {
|
|
6733
|
+
[name: string]: unknown;
|
|
6789
6734
|
};
|
|
6735
|
+
content?: never;
|
|
6790
6736
|
};
|
|
6791
|
-
};
|
|
6792
|
-
responses: {
|
|
6793
|
-
200: components["responses"]["HTMLResponse"];
|
|
6794
6737
|
default: components["responses"]["ProblemResponse"];
|
|
6795
6738
|
};
|
|
6796
6739
|
};
|
|
@@ -7072,7 +7015,7 @@ export interface operations {
|
|
|
7072
7015
|
AdminUsers: {
|
|
7073
7016
|
parameters: {
|
|
7074
7017
|
query?: {
|
|
7075
|
-
/** @description Matches email, name, user id, or
|
|
7018
|
+
/** @description Matches email, name, user id, or default organization id (hyphens optional in ids). */
|
|
7076
7019
|
q?: string;
|
|
7077
7020
|
};
|
|
7078
7021
|
header?: never;
|
|
@@ -8749,13 +8692,15 @@ export interface operations {
|
|
|
8749
8692
|
/** @description Integrate tab only. Which integration path to show: a coding agent over MCP, the client package, or plain HTTP. */
|
|
8750
8693
|
track?: "agent" | "sdk" | "http";
|
|
8751
8694
|
/** @description Integrate tab, agent track only. Which coding agent's install command to show. */
|
|
8752
|
-
agent?: "claude" | "cursor" | "opencode" | "codex" | "others";
|
|
8695
|
+
agent?: "claude" | "copilot" | "cursor" | "omp" | "opencode" | "codex" | "antigravity" | "others";
|
|
8696
|
+
/** @description Integrate tab: the providers to show in the examples in place of placeholder ids, for example when arriving from a provider page or a build page. Repeat to pass several. Dashboard tab: scopes the report to sessions that ran this provider (the first one); options come from `GET /orgs/{orgId}/providers/used`. */
|
|
8697
|
+
providerId?: components["schemas"]["ProviderID"][];
|
|
8698
|
+
/** @description Integrate tab, HTTP track only. Which Verification Client the create-session example targets. `auto` (the default) leaves `verificationClientUrl` out. */
|
|
8699
|
+
client?: "auto" | "portals" | "verifier-app" | "reclaim-browser-extension" | "builder" | "inapp-sdk";
|
|
8753
8700
|
/** @description Dashboard tab only. Start of the reporting period; defaults to 30 days before `to`. */
|
|
8754
8701
|
from?: components["schemas"]["DateWindowBound"];
|
|
8755
8702
|
/** @description Dashboard tab only. End of the reporting period; defaults to now. */
|
|
8756
8703
|
to?: components["schemas"]["DateWindowBound"];
|
|
8757
|
-
/** @description Dashboard tab only. Scopes the report to sessions that ran this provider. Options come from `GET /orgs/{orgId}/providers/used`. */
|
|
8758
|
-
providerId?: components["schemas"]["ProviderID"];
|
|
8759
8704
|
/** @description Dashboard tab only. Scopes the report to sessions created through this verification client. Hyphens are optional; an id that matches no client returns nothing. */
|
|
8760
8705
|
verificationClientId?: components["schemas"]["VerificationClientIDFilter"];
|
|
8761
8706
|
/** @description Providers tab only. Keeps providers whose title, domain, or id (hyphens optional) contains this text. */
|
|
@@ -8839,31 +8784,6 @@ export interface operations {
|
|
|
8839
8784
|
default: components["responses"]["ProblemResponse"];
|
|
8840
8785
|
};
|
|
8841
8786
|
};
|
|
8842
|
-
ConvertOrgToRegular: {
|
|
8843
|
-
parameters: {
|
|
8844
|
-
query?: never;
|
|
8845
|
-
header?: never;
|
|
8846
|
-
path: {
|
|
8847
|
-
orgId: components["schemas"]["OrgID"];
|
|
8848
|
-
};
|
|
8849
|
-
cookie?: never;
|
|
8850
|
-
};
|
|
8851
|
-
requestBody?: never;
|
|
8852
|
-
responses: {
|
|
8853
|
-
/** @description Converted */
|
|
8854
|
-
200: {
|
|
8855
|
-
headers: {
|
|
8856
|
-
[name: string]: unknown;
|
|
8857
|
-
};
|
|
8858
|
-
content: {
|
|
8859
|
-
"application/json": components["schemas"]["Organization"];
|
|
8860
|
-
};
|
|
8861
|
-
};
|
|
8862
|
-
403: components["responses"]["ForbiddenResponse"];
|
|
8863
|
-
409: components["responses"]["ProblemResponse"];
|
|
8864
|
-
default: components["responses"]["ProblemResponse"];
|
|
8865
|
-
};
|
|
8866
|
-
};
|
|
8867
8787
|
SearchOrgMembers: {
|
|
8868
8788
|
parameters: {
|
|
8869
8789
|
query?: {
|
|
@@ -11268,8 +11188,8 @@ export interface operations {
|
|
|
11268
11188
|
/** Format: uuid */
|
|
11269
11189
|
subscriptionId: string;
|
|
11270
11190
|
event: components["schemas"]["VerificationEvent"];
|
|
11271
|
-
/** @description The
|
|
11272
|
-
payload: string;
|
|
11191
|
+
/** @description The payload, as raw text. For a signed result: an ECIES ciphertext (base64url) wrapping the signed result JWS when the org's `canEncryptResult` is enabled, else the plaintext signed JWS JSON. For an event notification: `{event, eventData}` JSON. `null` once a signed result was delivered, or after 7 days undelivered. */
|
|
11192
|
+
payload: string | null;
|
|
11273
11193
|
deliveryStatus: components["schemas"]["CallbackDeliveryStatus"];
|
|
11274
11194
|
createdAt: components["schemas"]["Timestamp"];
|
|
11275
11195
|
}[];
|
|
@@ -11346,6 +11266,7 @@ export interface operations {
|
|
|
11346
11266
|
};
|
|
11347
11267
|
403: components["responses"]["ForbiddenResponse"];
|
|
11348
11268
|
404: components["responses"]["ProblemResponse"];
|
|
11269
|
+
410: components["responses"]["ProblemResponse"];
|
|
11349
11270
|
default: components["responses"]["ProblemResponse"];
|
|
11350
11271
|
};
|
|
11351
11272
|
};
|