@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
|
@@ -11,8 +11,8 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* @description
|
|
14
|
+
* Home — sign-in or Discover
|
|
15
|
+
* @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.
|
|
16
16
|
*/
|
|
17
17
|
get: operations["Index"];
|
|
18
18
|
put?: never;
|
|
@@ -23,6 +23,26 @@ export interface paths {
|
|
|
23
23
|
patch?: never;
|
|
24
24
|
trace?: never;
|
|
25
25
|
};
|
|
26
|
+
"/discover": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Discover — search a website to verify
|
|
35
|
+
* @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.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["Discover"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
26
46
|
"/providers": {
|
|
27
47
|
parameters: {
|
|
28
48
|
query?: never;
|
|
@@ -212,7 +232,7 @@ export interface paths {
|
|
|
212
232
|
put?: never;
|
|
213
233
|
/**
|
|
214
234
|
* Mint a SANDBOX test verification session for the selection
|
|
215
|
-
* @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
|
|
235
|
+
* @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.
|
|
216
236
|
*/
|
|
217
237
|
post: operations["SiteBuildTry"];
|
|
218
238
|
delete?: never;
|
|
@@ -221,26 +241,6 @@ export interface paths {
|
|
|
221
241
|
patch?: never;
|
|
222
242
|
trace?: never;
|
|
223
243
|
};
|
|
224
|
-
"/site/{domain}/repair": {
|
|
225
|
-
parameters: {
|
|
226
|
-
query?: never;
|
|
227
|
-
header?: never;
|
|
228
|
-
path?: never;
|
|
229
|
-
cookie?: never;
|
|
230
|
-
};
|
|
231
|
-
/**
|
|
232
|
-
* Failure-aware "Repair with an AI coding agent" wizard fragment
|
|
233
|
-
* @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.
|
|
234
|
-
*/
|
|
235
|
-
get: operations["SiteBuildRepair"];
|
|
236
|
-
put?: never;
|
|
237
|
-
post?: never;
|
|
238
|
-
delete?: never;
|
|
239
|
-
options?: never;
|
|
240
|
-
head?: never;
|
|
241
|
-
patch?: never;
|
|
242
|
-
trace?: never;
|
|
243
|
-
};
|
|
244
244
|
"/site/{domain}/alternative": {
|
|
245
245
|
parameters: {
|
|
246
246
|
query?: never;
|
|
@@ -261,7 +261,7 @@ export interface paths {
|
|
|
261
261
|
patch?: never;
|
|
262
262
|
trace?: never;
|
|
263
263
|
};
|
|
264
|
-
"/
|
|
264
|
+
"/integrate": {
|
|
265
265
|
parameters: {
|
|
266
266
|
query?: never;
|
|
267
267
|
header?: never;
|
|
@@ -269,10 +269,10 @@ export interface paths {
|
|
|
269
269
|
cookie?: never;
|
|
270
270
|
};
|
|
271
271
|
/**
|
|
272
|
-
*
|
|
273
|
-
* @description
|
|
272
|
+
* Go to the Integrate page
|
|
273
|
+
* @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.
|
|
274
274
|
*/
|
|
275
|
-
get: operations["
|
|
275
|
+
get: operations["OpenIntegrate"];
|
|
276
276
|
put?: never;
|
|
277
277
|
post?: never;
|
|
278
278
|
delete?: never;
|
|
@@ -281,26 +281,6 @@ export interface paths {
|
|
|
281
281
|
patch?: never;
|
|
282
282
|
trace?: never;
|
|
283
283
|
};
|
|
284
|
-
"/discover/agent-wizard": {
|
|
285
|
-
parameters: {
|
|
286
|
-
query?: never;
|
|
287
|
-
header?: never;
|
|
288
|
-
path?: never;
|
|
289
|
-
cookie?: never;
|
|
290
|
-
};
|
|
291
|
-
get?: never;
|
|
292
|
-
put?: never;
|
|
293
|
-
/**
|
|
294
|
-
* Setup and prompt for the coding agent picked in the wizard
|
|
295
|
-
* @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).
|
|
296
|
-
*/
|
|
297
|
-
post: operations["DiscoverAgentWizard"];
|
|
298
|
-
delete?: never;
|
|
299
|
-
options?: never;
|
|
300
|
-
head?: never;
|
|
301
|
-
patch?: never;
|
|
302
|
-
trace?: never;
|
|
303
|
-
};
|
|
304
284
|
"/discover/resolve": {
|
|
305
285
|
parameters: {
|
|
306
286
|
query?: never;
|
|
@@ -1575,7 +1555,7 @@ export interface paths {
|
|
|
1575
1555
|
put?: never;
|
|
1576
1556
|
/**
|
|
1577
1557
|
* Create an organization
|
|
1578
|
-
* @description Creates a new `ORG`-kind organization with the caller as its first `OWNER`.
|
|
1558
|
+
* @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.
|
|
1579
1559
|
*/
|
|
1580
1560
|
post: operations["CreateOrg"];
|
|
1581
1561
|
delete?: never;
|
|
@@ -1636,8 +1616,8 @@ export interface paths {
|
|
|
1636
1616
|
put?: never;
|
|
1637
1617
|
post?: never;
|
|
1638
1618
|
/**
|
|
1639
|
-
*
|
|
1640
|
-
* @description
|
|
1619
|
+
* Archive an organization
|
|
1620
|
+
* @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.
|
|
1641
1621
|
*/
|
|
1642
1622
|
delete: operations["DeleteOrg"];
|
|
1643
1623
|
options?: never;
|
|
@@ -1649,26 +1629,6 @@ export interface paths {
|
|
|
1649
1629
|
patch: operations["UpdateOrg"];
|
|
1650
1630
|
trace?: never;
|
|
1651
1631
|
};
|
|
1652
|
-
"/orgs/{orgId}/convert": {
|
|
1653
|
-
parameters: {
|
|
1654
|
-
query?: never;
|
|
1655
|
-
header?: never;
|
|
1656
|
-
path?: never;
|
|
1657
|
-
cookie?: never;
|
|
1658
|
-
};
|
|
1659
|
-
get?: never;
|
|
1660
|
-
put?: never;
|
|
1661
|
-
/**
|
|
1662
|
-
* Convert a personal organization to a regular organization
|
|
1663
|
-
* @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`.
|
|
1664
|
-
*/
|
|
1665
|
-
post: operations["ConvertOrgToRegular"];
|
|
1666
|
-
delete?: never;
|
|
1667
|
-
options?: never;
|
|
1668
|
-
head?: never;
|
|
1669
|
-
patch?: never;
|
|
1670
|
-
trace?: never;
|
|
1671
|
-
};
|
|
1672
1632
|
"/orgs/{orgId}/members": {
|
|
1673
1633
|
parameters: {
|
|
1674
1634
|
query?: never;
|
|
@@ -1684,7 +1644,7 @@ export interface paths {
|
|
|
1684
1644
|
put?: never;
|
|
1685
1645
|
/**
|
|
1686
1646
|
* Invite a member to an organization
|
|
1687
|
-
* @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`.
|
|
1647
|
+
* @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`.
|
|
1688
1648
|
*/
|
|
1689
1649
|
post: operations["AddOrgMember"];
|
|
1690
1650
|
delete?: never;
|
|
@@ -2742,16 +2702,32 @@ export interface paths {
|
|
|
2742
2702
|
/**
|
|
2743
2703
|
* Create a verification session
|
|
2744
2704
|
* @description Creates a verification session for an end-user to complete.
|
|
2705
|
+
*
|
|
2706
|
+
* **The response's `verificationUrl` is the one thing you need.** Send
|
|
2707
|
+
* your end user to it (redirect, link, or QR code): that is where they
|
|
2708
|
+
* verify. Everything else in the response is for tracking the session.
|
|
2709
|
+
*
|
|
2745
2710
|
* Authenticated by the consumer's `OrgToken`; the session is scoped to
|
|
2746
2711
|
* the resolved organization. The request carries no callback URLs —
|
|
2747
2712
|
* results are delivered to the org's pre-registered callback
|
|
2748
2713
|
* subscriptions.
|
|
2749
2714
|
*
|
|
2715
|
+
* `verificationClientUrl` picks where the user verifies. Omit it to use
|
|
2716
|
+
* the Reclaim Portal. The built-in clients are:
|
|
2717
|
+
*
|
|
2718
|
+
* | Client | `verificationClientUrl` |
|
|
2719
|
+
* | --- | --- |
|
|
2720
|
+
* | Reclaim Portal (default) | `https://build.reclaimprotocol.org/share/portals` |
|
|
2721
|
+
* | Verifier app | `https://build.reclaimprotocol.org/share/verifier-app` |
|
|
2722
|
+
* | Browser extension | `https://build.reclaimprotocol.org/share/reclaim-browser-extension` |
|
|
2723
|
+
* | Builder browser | `https://build.reclaimprotocol.org/share/builder` |
|
|
2724
|
+
* | In-app SDK | `https://build.reclaimprotocol.org/share/inapp-sdk` |
|
|
2725
|
+
*
|
|
2750
2726
|
* curl -X POST $BASE/verifications/sessions \
|
|
2751
2727
|
* -H "Authorization: Bearer $ORG_TOKEN" \
|
|
2752
2728
|
* -H 'Content-Type: application/json' \
|
|
2753
2729
|
* -d '{"providers":[{"providerId":"…","version":"^1.2.0"}],"context":{},
|
|
2754
|
-
* "verificationClientUrl":"https://
|
|
2730
|
+
* "verificationClientUrl":"https://build.reclaimprotocol.org/share/portals"}'
|
|
2755
2731
|
*
|
|
2756
2732
|
* Fails with `409 Conflict` if the organization has no callback
|
|
2757
2733
|
* subscription (there would be nowhere to deliver the result).
|
|
@@ -3059,8 +3035,8 @@ export interface paths {
|
|
|
3059
3035
|
cookie?: never;
|
|
3060
3036
|
};
|
|
3061
3037
|
/**
|
|
3062
|
-
* Get the stored
|
|
3063
|
-
* @description Returns the
|
|
3038
|
+
* Get the stored result(s) for a session
|
|
3039
|
+
* @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.
|
|
3064
3040
|
*/
|
|
3065
3041
|
get: operations["GetVerificationResult"];
|
|
3066
3042
|
put?: never;
|
|
@@ -3082,7 +3058,7 @@ export interface paths {
|
|
|
3082
3058
|
put?: never;
|
|
3083
3059
|
/**
|
|
3084
3060
|
* Re-enqueue callback delivery for a session
|
|
3085
|
-
* @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.
|
|
3061
|
+
* @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.
|
|
3086
3062
|
*/
|
|
3087
3063
|
post: operations["RetryVerificationCallback"];
|
|
3088
3064
|
delete?: never;
|
|
@@ -3122,7 +3098,7 @@ export interface paths {
|
|
|
3122
3098
|
put?: never;
|
|
3123
3099
|
/**
|
|
3124
3100
|
* Retry a dead-lettered callback (admin-only)
|
|
3125
|
-
* @description Admin only. Re-enqueues a specific DLQ entry for delivery.
|
|
3101
|
+
* @description Admin only. Re-enqueues a specific DLQ entry for delivery. 410 when the result was undelivered for 7 days and has been purged.
|
|
3126
3102
|
*/
|
|
3127
3103
|
post: operations["RetryCallbackDlq"];
|
|
3128
3104
|
delete?: never;
|
|
@@ -3391,11 +3367,9 @@ export interface components {
|
|
|
3391
3367
|
*/
|
|
3392
3368
|
EntityStatus: "ACTIVE" | "ARCHIVED";
|
|
3393
3369
|
/**
|
|
3394
|
-
* @description - `
|
|
3395
|
-
* `
|
|
3396
|
-
*
|
|
3397
|
-
* - `ORG`: Explicitly created via `POST /orgs`. Multiple
|
|
3398
|
-
* members, always ≥ 1 active `OWNER`.
|
|
3370
|
+
* @description - `ORG`: A user's organization: the default one made at sign-up,
|
|
3371
|
+
* or one created via `POST /orgs`. Multiple members, always ≥ 1
|
|
3372
|
+
* active `OWNER`.
|
|
3399
3373
|
*
|
|
3400
3374
|
* - `ANONYMOUS`: System-managed, member-less org auto-created to
|
|
3401
3375
|
* anchor an unaffiliated ETH credential's org-level settings
|
|
@@ -3404,7 +3378,7 @@ export interface components {
|
|
|
3404
3378
|
* created or named by clients; has no members.
|
|
3405
3379
|
* @enum {string}
|
|
3406
3380
|
*/
|
|
3407
|
-
OrganizationKind: "
|
|
3381
|
+
OrganizationKind: "ORG" | "ANONYMOUS";
|
|
3408
3382
|
/** @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. */
|
|
3409
3383
|
Tag: string;
|
|
3410
3384
|
ActorMetadata: {
|
|
@@ -3413,7 +3387,7 @@ export interface components {
|
|
|
3413
3387
|
/** @description Free-form notes from actor describing this change */
|
|
3414
3388
|
notes?: string;
|
|
3415
3389
|
};
|
|
3416
|
-
/** @description A registered user of the platform. Every newly created user
|
|
3390
|
+
/** @description A registered user of the platform. Every newly created user gets a default organization, whose id is exposed here as `defaultOrgId`. */
|
|
3417
3391
|
User: {
|
|
3418
3392
|
id: components["schemas"]["UserID"];
|
|
3419
3393
|
/**
|
|
@@ -3435,13 +3409,13 @@ export interface components {
|
|
|
3435
3409
|
* @enum {string}
|
|
3436
3410
|
*/
|
|
3437
3411
|
role?: "user" | "admin";
|
|
3438
|
-
/** @description ID of the
|
|
3439
|
-
|
|
3412
|
+
/** @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. */
|
|
3413
|
+
defaultOrgId: components["schemas"]["OrgID"];
|
|
3440
3414
|
createMetadata: components["schemas"]["ActorMetadata"];
|
|
3441
3415
|
updateMetadata: components["schemas"]["ActorMetadata"];
|
|
3442
3416
|
};
|
|
3443
3417
|
/**
|
|
3444
|
-
* @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.
|
|
3418
|
+
* @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.
|
|
3445
3419
|
* @enum {string}
|
|
3446
3420
|
*/
|
|
3447
3421
|
OrganizationMemberRole: "OWNER" | "MEMBER";
|
|
@@ -3476,12 +3450,12 @@ export interface components {
|
|
|
3476
3450
|
/** @description Timestamp the invite was accepted. Absent while `status` is `PENDING`. */
|
|
3477
3451
|
joinedAt?: components["schemas"]["Timestamp"];
|
|
3478
3452
|
};
|
|
3479
|
-
/** @description A workspace that owns providers and other resources. Every user gets
|
|
3453
|
+
/** @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`). */
|
|
3480
3454
|
Organization: {
|
|
3481
3455
|
id: components["schemas"]["OrgID"];
|
|
3482
|
-
/** @description Display name of the organization.
|
|
3456
|
+
/** @description Display name of the organization. A user's default org starts with their name and may be renamed by an owner. */
|
|
3483
3457
|
name: string;
|
|
3484
|
-
/** @description Whether this is a user's
|
|
3458
|
+
/** @description Whether this is a user's org or a system-managed anonymous one. */
|
|
3485
3459
|
kind: components["schemas"]["OrganizationKind"];
|
|
3486
3460
|
/**
|
|
3487
3461
|
* Format: uri
|
|
@@ -3490,7 +3464,7 @@ export interface components {
|
|
|
3490
3464
|
iconUrl?: string;
|
|
3491
3465
|
/** @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. */
|
|
3492
3466
|
readonly systemId?: string;
|
|
3493
|
-
/** @description All users with a role in this organization. `
|
|
3467
|
+
/** @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. */
|
|
3494
3468
|
members: components["schemas"]["OrganizationMember"][];
|
|
3495
3469
|
/** @description Providers owned by this organization. */
|
|
3496
3470
|
providers?: components["schemas"]["ProviderListItem"][];
|
|
@@ -4959,6 +4933,11 @@ export interface components {
|
|
|
4959
4933
|
[key: string]: string;
|
|
4960
4934
|
};
|
|
4961
4935
|
orgId?: components["schemas"]["OrgID"];
|
|
4936
|
+
/**
|
|
4937
|
+
* @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.
|
|
4938
|
+
* @enum {string}
|
|
4939
|
+
*/
|
|
4940
|
+
verificationClient?: "portals" | "verifier-app" | "reclaim-browser-extension" | "builder";
|
|
4962
4941
|
};
|
|
4963
4942
|
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
4964
4943
|
AdminSetUserOrgLimitBody: {
|
|
@@ -5224,7 +5203,7 @@ export interface components {
|
|
|
5224
5203
|
webSettings: components["schemas"]["ProviderWebSettings"];
|
|
5225
5204
|
requiredContext?: components["schemas"]["ProviderRequiredContext"];
|
|
5226
5205
|
};
|
|
5227
|
-
/** @description Body for `POST /orgs` — just a name. Every org is created keyless, like
|
|
5206
|
+
/** @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. */
|
|
5228
5207
|
CreateOrgRequest: {
|
|
5229
5208
|
name: string;
|
|
5230
5209
|
};
|
|
@@ -5805,7 +5784,7 @@ export interface components {
|
|
|
5805
5784
|
* @description Id of the registered verification client whose base URL was used (see `verification_clients`).
|
|
5806
5785
|
*/
|
|
5807
5786
|
verificationClientId: string;
|
|
5808
|
-
/** @description Ready-to-share
|
|
5787
|
+
/** @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. */
|
|
5809
5788
|
verificationUrl: string;
|
|
5810
5789
|
createdAt: components["schemas"]["Timestamp"];
|
|
5811
5790
|
/** @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. */
|
|
@@ -5836,7 +5815,14 @@ export interface components {
|
|
|
5836
5815
|
context: {
|
|
5837
5816
|
[key: string]: unknown;
|
|
5838
5817
|
};
|
|
5839
|
-
/**
|
|
5818
|
+
/**
|
|
5819
|
+
* @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.
|
|
5820
|
+
* @example https://build.reclaimprotocol.org/share/portals
|
|
5821
|
+
* @example https://build.reclaimprotocol.org/share/verifier-app
|
|
5822
|
+
* @example https://build.reclaimprotocol.org/share/reclaim-browser-extension
|
|
5823
|
+
* @example https://build.reclaimprotocol.org/share/builder
|
|
5824
|
+
* @example https://build.reclaimprotocol.org/share/inapp-sdk
|
|
5825
|
+
*/
|
|
5840
5826
|
verificationClientUrl?: string;
|
|
5841
5827
|
/** @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. */
|
|
5842
5828
|
themeId?: components["schemas"]["ThemeID"];
|
|
@@ -6316,6 +6302,24 @@ export interface operations {
|
|
|
6316
6302
|
default: components["responses"]["ProblemResponse"];
|
|
6317
6303
|
};
|
|
6318
6304
|
};
|
|
6305
|
+
Discover: {
|
|
6306
|
+
parameters: {
|
|
6307
|
+
query?: {
|
|
6308
|
+
/** @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. */
|
|
6309
|
+
q?: string;
|
|
6310
|
+
/** @description Narrow to websites with at least one visible provider carrying ANY of these tags. Repeat to pass several (OR-combined). */
|
|
6311
|
+
tag?: string[];
|
|
6312
|
+
};
|
|
6313
|
+
header?: never;
|
|
6314
|
+
path?: never;
|
|
6315
|
+
cookie?: never;
|
|
6316
|
+
};
|
|
6317
|
+
requestBody?: never;
|
|
6318
|
+
responses: {
|
|
6319
|
+
200: components["responses"]["HTMLResponse"];
|
|
6320
|
+
default: components["responses"]["ProblemResponse"];
|
|
6321
|
+
};
|
|
6322
|
+
};
|
|
6319
6323
|
Providers: {
|
|
6320
6324
|
parameters: {
|
|
6321
6325
|
query?: {
|
|
@@ -6667,40 +6671,6 @@ export interface operations {
|
|
|
6667
6671
|
default: components["responses"]["ProblemResponse"];
|
|
6668
6672
|
};
|
|
6669
6673
|
};
|
|
6670
|
-
SiteBuildRepair: {
|
|
6671
|
-
parameters: {
|
|
6672
|
-
query: {
|
|
6673
|
-
/** @description The failing sandbox session whose analytics seed the prompt. */
|
|
6674
|
-
sessionId: components["schemas"]["SessionID"];
|
|
6675
|
-
dataPoints?: string[];
|
|
6676
|
-
mode?: components["schemas"]["ResolveMode"];
|
|
6677
|
-
provided?: string[];
|
|
6678
|
-
/** @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. */
|
|
6679
|
-
pins?: {
|
|
6680
|
-
[key: string]: string;
|
|
6681
|
-
};
|
|
6682
|
-
exclude?: components["schemas"]["ProviderID"][];
|
|
6683
|
-
};
|
|
6684
|
-
header?: never;
|
|
6685
|
-
path: {
|
|
6686
|
-
domain: string;
|
|
6687
|
-
};
|
|
6688
|
-
cookie?: never;
|
|
6689
|
-
};
|
|
6690
|
-
requestBody?: never;
|
|
6691
|
-
responses: {
|
|
6692
|
-
/** @description The repair wizard fragment. */
|
|
6693
|
-
200: {
|
|
6694
|
-
headers: {
|
|
6695
|
-
[name: string]: unknown;
|
|
6696
|
-
};
|
|
6697
|
-
content: {
|
|
6698
|
-
"text/html": components["schemas"]["HtmlContent"];
|
|
6699
|
-
};
|
|
6700
|
-
};
|
|
6701
|
-
default: components["responses"]["ProblemResponse"];
|
|
6702
|
-
};
|
|
6703
|
-
};
|
|
6704
6674
|
SiteBuildAlternative: {
|
|
6705
6675
|
parameters: {
|
|
6706
6676
|
query: {
|
|
@@ -6742,49 +6712,22 @@ export interface operations {
|
|
|
6742
6712
|
default: components["responses"]["ProblemResponse"];
|
|
6743
6713
|
};
|
|
6744
6714
|
};
|
|
6745
|
-
|
|
6715
|
+
OpenIntegrate: {
|
|
6746
6716
|
parameters: {
|
|
6747
|
-
query?:
|
|
6748
|
-
/** @description Website the user wanted to verify data from. */
|
|
6749
|
-
domain?: string;
|
|
6750
|
-
/** @description Specific data point the user could not find. */
|
|
6751
|
-
dataPoint?: string;
|
|
6752
|
-
};
|
|
6717
|
+
query?: never;
|
|
6753
6718
|
header?: never;
|
|
6754
6719
|
path?: never;
|
|
6755
6720
|
cookie?: never;
|
|
6756
6721
|
};
|
|
6757
6722
|
requestBody?: never;
|
|
6758
6723
|
responses: {
|
|
6759
|
-
|
|
6760
|
-
|
|
6761
|
-
|
|
6762
|
-
|
|
6763
|
-
DiscoverAgentWizard: {
|
|
6764
|
-
parameters: {
|
|
6765
|
-
query?: never;
|
|
6766
|
-
header?: never;
|
|
6767
|
-
path?: never;
|
|
6768
|
-
cookie?: never;
|
|
6769
|
-
};
|
|
6770
|
-
requestBody: {
|
|
6771
|
-
content: {
|
|
6772
|
-
"application/x-www-form-urlencoded": {
|
|
6773
|
-
/** @description The wizard's ready-to-paste task prompt. */
|
|
6774
|
-
basePrompt: string;
|
|
6775
|
-
/** @description Prefix of the wizard's element ids, so copy targets stay unique. */
|
|
6776
|
-
idPrefix: string;
|
|
6777
|
-
/** @description Picked coding agent; unknown values fall back to the first. */
|
|
6778
|
-
agent?: string;
|
|
6779
|
-
/** @description What the user is building, appended to the prompt. */
|
|
6780
|
-
building?: string;
|
|
6781
|
-
/** @description Label for `building` in the prompt. Defaults to "What I'm building". */
|
|
6782
|
-
lead?: string;
|
|
6724
|
+
/** @description Redirect to the Integrate page, or to sign-in. */
|
|
6725
|
+
302: {
|
|
6726
|
+
headers: {
|
|
6727
|
+
[name: string]: unknown;
|
|
6783
6728
|
};
|
|
6729
|
+
content?: never;
|
|
6784
6730
|
};
|
|
6785
|
-
};
|
|
6786
|
-
responses: {
|
|
6787
|
-
200: components["responses"]["HTMLResponse"];
|
|
6788
6731
|
default: components["responses"]["ProblemResponse"];
|
|
6789
6732
|
};
|
|
6790
6733
|
};
|
|
@@ -7066,7 +7009,7 @@ export interface operations {
|
|
|
7066
7009
|
AdminUsers: {
|
|
7067
7010
|
parameters: {
|
|
7068
7011
|
query?: {
|
|
7069
|
-
/** @description Matches email, name, user id, or
|
|
7012
|
+
/** @description Matches email, name, user id, or default organization id (hyphens optional in ids). */
|
|
7070
7013
|
q?: string;
|
|
7071
7014
|
};
|
|
7072
7015
|
header?: never;
|
|
@@ -8743,13 +8686,15 @@ export interface operations {
|
|
|
8743
8686
|
/** @description Integrate tab only. Which integration path to show: a coding agent over MCP, the client package, or plain HTTP. */
|
|
8744
8687
|
track?: "agent" | "sdk" | "http";
|
|
8745
8688
|
/** @description Integrate tab, agent track only. Which coding agent's install command to show. */
|
|
8746
|
-
agent?: "claude" | "cursor" | "opencode" | "codex" | "others";
|
|
8689
|
+
agent?: "claude" | "copilot" | "cursor" | "omp" | "opencode" | "codex" | "antigravity" | "others";
|
|
8690
|
+
/** @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`. */
|
|
8691
|
+
providerId?: components["schemas"]["ProviderID"][];
|
|
8692
|
+
/** @description Integrate tab, HTTP track only. Which Verification Client the create-session example targets. `auto` (the default) leaves `verificationClientUrl` out. */
|
|
8693
|
+
client?: "auto" | "portals" | "verifier-app" | "reclaim-browser-extension" | "builder" | "inapp-sdk";
|
|
8747
8694
|
/** @description Dashboard tab only. Start of the reporting period; defaults to 30 days before `to`. */
|
|
8748
8695
|
from?: components["schemas"]["DateWindowBound"];
|
|
8749
8696
|
/** @description Dashboard tab only. End of the reporting period; defaults to now. */
|
|
8750
8697
|
to?: components["schemas"]["DateWindowBound"];
|
|
8751
|
-
/** @description Dashboard tab only. Scopes the report to sessions that ran this provider. Options come from `GET /orgs/{orgId}/providers/used`. */
|
|
8752
|
-
providerId?: components["schemas"]["ProviderID"];
|
|
8753
8698
|
/** @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. */
|
|
8754
8699
|
verificationClientId?: components["schemas"]["VerificationClientIDFilter"];
|
|
8755
8700
|
/** @description Providers tab only. Keeps providers whose title, domain, or id (hyphens optional) contains this text. */
|
|
@@ -8833,31 +8778,6 @@ export interface operations {
|
|
|
8833
8778
|
default: components["responses"]["ProblemResponse"];
|
|
8834
8779
|
};
|
|
8835
8780
|
};
|
|
8836
|
-
ConvertOrgToRegular: {
|
|
8837
|
-
parameters: {
|
|
8838
|
-
query?: never;
|
|
8839
|
-
header?: never;
|
|
8840
|
-
path: {
|
|
8841
|
-
orgId: components["schemas"]["OrgID"];
|
|
8842
|
-
};
|
|
8843
|
-
cookie?: never;
|
|
8844
|
-
};
|
|
8845
|
-
requestBody?: never;
|
|
8846
|
-
responses: {
|
|
8847
|
-
/** @description Converted */
|
|
8848
|
-
200: {
|
|
8849
|
-
headers: {
|
|
8850
|
-
[name: string]: unknown;
|
|
8851
|
-
};
|
|
8852
|
-
content: {
|
|
8853
|
-
"application/json": components["schemas"]["Organization"];
|
|
8854
|
-
};
|
|
8855
|
-
};
|
|
8856
|
-
403: components["responses"]["ForbiddenResponse"];
|
|
8857
|
-
409: components["responses"]["ProblemResponse"];
|
|
8858
|
-
default: components["responses"]["ProblemResponse"];
|
|
8859
|
-
};
|
|
8860
|
-
};
|
|
8861
8781
|
SearchOrgMembers: {
|
|
8862
8782
|
parameters: {
|
|
8863
8783
|
query?: {
|
|
@@ -11262,8 +11182,8 @@ export interface operations {
|
|
|
11262
11182
|
/** Format: uuid */
|
|
11263
11183
|
subscriptionId: string;
|
|
11264
11184
|
event: components["schemas"]["VerificationEvent"];
|
|
11265
|
-
/** @description The
|
|
11266
|
-
payload: string;
|
|
11185
|
+
/** @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. */
|
|
11186
|
+
payload: string | null;
|
|
11267
11187
|
deliveryStatus: components["schemas"]["CallbackDeliveryStatus"];
|
|
11268
11188
|
createdAt: components["schemas"]["Timestamp"];
|
|
11269
11189
|
}[];
|
|
@@ -11340,6 +11260,7 @@ export interface operations {
|
|
|
11340
11260
|
};
|
|
11341
11261
|
403: components["responses"]["ForbiddenResponse"];
|
|
11342
11262
|
404: components["responses"]["ProblemResponse"];
|
|
11263
|
+
410: components["responses"]["ProblemResponse"];
|
|
11343
11264
|
default: components["responses"]["ProblemResponse"];
|
|
11344
11265
|
};
|
|
11345
11266
|
};
|
package/lib/types/openapi.gen.js
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.
|
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.33",
|
|
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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// AUTO-GENERATED by packages/app/scripts/mcp-tools-gen.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.
|
|
@@ -37,7 +37,6 @@ export const ROUTES = {
|
|
|
37
37
|
"CancelPublicListingRequest": {"method":"post","path":"/providers/{providerId}/versions/{version}/cancel-review"},
|
|
38
38
|
"ChangeOrgPlan": {"method":"post","path":"/orgs/{orgId}/billing/change-plan"},
|
|
39
39
|
"ConsentPage": {"method":"get","path":"/oauth/consent"},
|
|
40
|
-
"ConvertOrgToRegular": {"method":"post","path":"/orgs/{orgId}/convert"},
|
|
41
40
|
"CreateAgentBrowserSession": {"method":"post","path":"/orgs/{orgId}/agent-browser-sessions"},
|
|
42
41
|
"CreateBillingCheckoutSession": {"method":"post","path":"/orgs/{orgId}/billing/checkout"},
|
|
43
42
|
"CreateBillingPortalSession": {"method":"post","path":"/orgs/{orgId}/billing/portal"},
|
|
@@ -68,10 +67,9 @@ export const ROUTES = {
|
|
|
68
67
|
"DeleteProvider": {"method":"delete","path":"/providers/{providerId}"},
|
|
69
68
|
"DeleteProviderVersion": {"method":"delete","path":"/providers/{providerId}/versions/{version}"},
|
|
70
69
|
"DeleteTheme": {"method":"delete","path":"/orgs/{orgId}/themes/{themeId}"},
|
|
71
|
-
"
|
|
70
|
+
"Discover": {"method":"get","path":"/discover"},
|
|
72
71
|
"DiscoverDataPoints": {"method":"get","path":"/discover/data-points"},
|
|
73
72
|
"DiscoverResolve": {"method":"get","path":"/discover/resolve"},
|
|
74
|
-
"DiscoverTeachAgent": {"method":"get","path":"/discover/teach"},
|
|
75
73
|
"DiscoverWebsites": {"method":"get","path":"/discover/websites"},
|
|
76
74
|
"DisposeAgentBrowserSession": {"method":"delete","path":"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}"},
|
|
77
75
|
"DisposeVerificationSession": {"method":"post","path":"/v/{sessionId}/dispose"},
|
|
@@ -121,6 +119,7 @@ export const ROUTES = {
|
|
|
121
119
|
"Logout": {"method":"post","path":"/logout"},
|
|
122
120
|
"MakePrivate": {"method":"post","path":"/providers/{providerId}/make-private"},
|
|
123
121
|
"OpenApiSpec": {"method":"get","path":"/openapi.yaml"},
|
|
122
|
+
"OpenIntegrate": {"method":"get","path":"/integrate"},
|
|
124
123
|
"OrgInvitePage": {"method":"get","path":"/orgs/{orgId}/invite"},
|
|
125
124
|
"PatchVerificationClaimant": {"method":"patch","path":"/verifications/sessions/{sessionId}/claimant"},
|
|
126
125
|
"ProviderPreviewImage": {"method":"get","path":"/providers/{providerId}/preview.png"},
|
|
@@ -151,7 +150,6 @@ export const ROUTES = {
|
|
|
151
150
|
"SharePage": {"method":"get","path":"/share/{client}"},
|
|
152
151
|
"SiteBuild": {"method":"get","path":"/site/{domain}/build"},
|
|
153
152
|
"SiteBuildAlternative": {"method":"get","path":"/site/{domain}/alternative"},
|
|
154
|
-
"SiteBuildRepair": {"method":"get","path":"/site/{domain}/repair"},
|
|
155
153
|
"SiteBuildTry": {"method":"post","path":"/site/{domain}/try"},
|
|
156
154
|
"Sitemap": {"method":"get","path":"/sitemap.xml"},
|
|
157
155
|
"SitePage": {"method":"get","path":"/site/{domain}"},
|