@fern-api/venus-api-sdk 13.0.0 → 14.0.0

package/reference.md

@@ -1,22 +1,8 @@
 # Reference
-<details><summary><code>client.<a href="/src/Client.ts">metricsMetricsGet</a>() -> core.APIResponse&lt;unknown, FernVenusApi.metricsMetricsGet.Error&gt;</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.<a href="/src/Client.ts">healthHealthGet</a>() -> core.APIResponse&lt;unknown, FernVenusApi.healthHealthGet.Error&gt;</code></summary>
 <dl>
 <dd>
 
-Endpoint that serves Prometheus metrics.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -26,7 +12,7 @@ Endpoint that serves Prometheus metrics.
 <dd>
 
 ```typescript
-await client.metricsMetricsGet();
+await client.healthHealthGet();
 
 ```
 </dd>
@@ -54,7 +40,7 @@ await client.metricsMetricsGet();
 </dl>
 </details>
 
-<details><summary><code>client.<a href="/src/Client.ts">healthHealthGet</a>() -> core.APIResponse&lt;unknown, FernVenusApi.healthHealthGet.Error&gt;</code></summary>
+<details><summary><code>client.<a href="/src/Client.ts">pingPingGet</a>() -> core.APIResponse&lt;string, FernVenusApi.pingPingGet.Error&gt;</code></summary>
 <dl>
 <dd>
 
@@ -67,7 +53,7 @@ await client.metricsMetricsGet();
 <dd>
 
 ```typescript
-await client.healthHealthGet();
+await client.pingPingGet();
 
 ```
 </dd>
@@ -112,6 +98,10 @@ RDS smoke check: ping each configured RDS engine.
 Returns 200 only if every configured RDS engine answers ``SELECT 1``;
 503 if any engine is unhealthy. Returns 200 with ``configured: false``
 when no RDS engines are configured.
+
+``hosts_allowlisted`` is true only if every engine's host matches
+RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
+since nothing has then vouched for the hosts.
 </dd>
 </dl>
 </dd>
@@ -159,6 +149,22 @@ await client.healthRdsHealthRdsGet();
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates an API key for an organization the caller is a member of. Called
+with the provisioner token, it only works for an unclaimed organization
+that was created with that token, and returns 403 for any other.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -261,6 +267,22 @@ await client.apiKeys.getTokenMetadata({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists an organization's API keys. Called with the provisioner token, it
+only works for an unclaimed organization that was created with that
+token, and returns 403 for any other.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -312,6 +334,23 @@ await client.apiKeys.getTokensForOrganization({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Revokes an API key by its ID. Called with the provisioner token,
+organizationId is required and must be an unclaimed organization that
+was created with that token (403 otherwise), and the key must be that
+organization's (401 otherwise). Other callers don't need organizationId.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -666,11 +705,30 @@ await client.auth.getJwt({
 </dl>
 </details>
 
-## Organization
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">create</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error&gt;</code></summary>
+## GuestSession
+<details><summary><code>client.guestSession.<a href="/src/api/resources/guestSession/client/Client.ts">create</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.CreateGuestSessionResponse, FernVenusApi.guestSession.create.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Issue a guest session: a throwaway organization, a short-lived token bound to it, and
+the secret needed to claim it later.
+This endpoint is unauthenticated on purpose. It is the one way into Fern without a
+login, so every decision about what the session may do, how long it lasts and how many
+a caller may open is made here, on the server.
+The token and the claim secret are returned once and stored only as hashes.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -680,8 +738,8 @@ await client.auth.getJwt({
 <dd>
 
 ```typescript
-await client.organization.create({
-    organizationId: "organizationId"
+await client.guestSession.create({
+    fingerprint: "fingerprint"
 });
 
 ```
@@ -698,7 +756,7 @@ await client.organization.create({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.CreateOrganizationRequest` 
+**request:** `FernVenusApi.CreateGuestSessionRequest` 
     
 </dd>
 </dl>
@@ -706,7 +764,7 @@ await client.organization.create({
 <dl>
 <dd>
 
-**requestOptions:** `OrganizationClient.RequestOptions` 
+**requestOptions:** `GuestSessionClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -718,10 +776,28 @@ await client.organization.create({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">update</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.update.Error&gt;</code></summary>
+<details><summary><code>client.guestSession.<a href="/src/api/resources/guestSession/client/Client.ts">get</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.GetGuestSessionResponse, FernVenusApi.guestSession.get.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Read a guest session: where it is in its life, when it runs out and how much of its
+budget is spent.
+Opened by the session's own token, by the claim secret (sent as `X-Fern-Claim-Secret`,
+which is what the claim page holds), or by the user who claimed it. Anything else is
+told the session does not exist.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -731,8 +807,8 @@ await client.organization.create({
 <dd>
 
 ```typescript
-await client.organization.update({
-    orgId: "org_id"
+await client.guestSession.get({
+    sessionId: "session_id"
 });
 
 ```
@@ -749,7 +825,7 @@ await client.organization.update({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.UpdateOrganizationRequest` 
+**request:** `FernVenusApi.GetGuestSessionsSessionIdGetRequest` 
     
 </dd>
 </dl>
@@ -757,7 +833,7 @@ await client.organization.update({
 <dl>
 <dd>
 
-**requestOptions:** `OrganizationClient.RequestOptions` 
+**requestOptions:** `GuestSessionClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -769,10 +845,29 @@ await client.organization.update({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">get</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.get.Error&gt;</code></summary>
+<details><summary><code>client.guestSession.<a href="/src/api/resources/guestSession/client/Client.ts">delete</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.DeleteGuestSessionResponse, FernVenusApi.guestSession.delete.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Take a guest session down. Its token stops working at once and nothing more can be
+built or published with it.
+The session's own token or its claim secret takes it down (`deleted`); a Fern operator's
+service credential takes it down for abuse (`takenDown`). Anything else is told the
+session does not exist. Calling it again answers the same; a claimed session cannot be
+taken down here, its work belongs to an organization now.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -782,8 +877,8 @@ await client.organization.update({
 <dd>
 
 ```typescript
-await client.organization.get({
-    orgId: "org_id"
+await client.guestSession.delete({
+    sessionId: "session_id"
 });
 
 ```
@@ -800,7 +895,7 @@ await client.organization.get({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.GetOrganizationsOrgIdGetRequest` 
+**request:** `FernVenusApi.DeleteGuestSessionsSessionIdDeleteRequest` 
     
 </dd>
 </dl>
@@ -808,7 +903,7 @@ await client.organization.get({
 <dl>
 <dd>
 
-**requestOptions:** `OrganizationClient.RequestOptions` 
+**requestOptions:** `GuestSessionClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -820,7 +915,7 @@ await client.organization.get({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">delete</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.delete.Error&gt;</code></summary>
+<details><summary><code>client.guestSession.<a href="/src/api/resources/guestSession/client/Client.ts">claim</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimGuestSessionResponse, FernVenusApi.guestSession.claim.Error&gt;</code></summary>
 <dl>
 <dd>
 
@@ -832,7 +927,12 @@ await client.organization.get({
 <dl>
 <dd>
 
-Deletes an organization. Only users with admin role can delete organizations.
+Claim a guest session: make its work the caller's, for keeps.
+Needs two things: the claim secret (`X-Fern-Claim-Secret`, from the claim URL) and a
+signed-in person (`Authorization`). With `organizationId`, the caller must already be an
+admin of that organization and the session's work is moved into it. Without, the
+session's own organization becomes the caller's, with them as its first admin.
+Claiming revokes the guest token. Safe to retry: the claimant may call it again.
 </dd>
 </dl>
 </dd>
@@ -847,8 +947,8 @@ Deletes an organization. Only users with admin role can delete organizations.
 <dd>
 
 ```typescript
-await client.organization.delete({
-    orgId: "org_id"
+await client.guestSession.claim({
+    sessionId: "session_id"
 });
 
 ```
@@ -865,7 +965,7 @@ await client.organization.delete({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest` 
+**request:** `FernVenusApi.ClaimGuestSessionRequest` 
     
 </dd>
 </dl>
@@ -873,7 +973,7 @@ await client.organization.delete({
 <dl>
 <dd>
 
-**requestOptions:** `OrganizationClient.RequestOptions` 
+**requestOptions:** `GuestSessionClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -885,7 +985,8 @@ await client.organization.delete({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsByPostmanTeamId</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error&gt;</code></summary>
+## Organization
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">create</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error&gt;</code></summary>
 <dl>
 <dd>
 
@@ -897,7 +998,12 @@ await client.organization.delete({
 <dl>
 <dd>
 
-Look up an organization by its associated Postman team ID.
+Creates an organization with the caller as its admin. Called with the
+provisioner token, it instead creates an unclaimed organization, with no
+Auth0 organization or members, linked to the required postmanTeamId.
+Creating it again for the same team returns the same organization.
+A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
+organization, since that team claims its organization through Postman.
 </dd>
 </dl>
 </dd>
@@ -912,8 +1018,8 @@ Look up an organization by its associated Postman team ID.
 <dd>
 
 ```typescript
-await client.organization.getOrgIdsByPostmanTeamId({
-    postmanTeamId: "postman_team_id"
+await client.organization.create({
+    organizationId: "organizationId"
 });
 
 ```
@@ -930,7 +1036,7 @@ await client.organization.getOrgIdsByPostmanTeamId({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest` 
+**request:** `FernVenusApi.CreateOrganizationRequest` 
     
 </dd>
 </dl>
@@ -950,24 +1056,10 @@ await client.organization.getOrgIdsByPostmanTeamId({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getPostmanTeamIdByOrgId</a>({ ...params }) -> core.APIResponse&lt;string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error&gt;</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">update</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.update.Error&gt;</code></summary>
 <dl>
 <dd>
 
-Get the Postman team ID associated with an organization ID.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -977,7 +1069,7 @@ Get the Postman team ID associated with an organization ID.
 <dd>
 
 ```typescript
-await client.organization.getPostmanTeamIdByOrgId({
+await client.organization.update({
     orgId: "org_id"
 });
 
@@ -995,7 +1087,7 @@ await client.organization.getPostmanTeamIdByOrgId({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest` 
+**request:** `FernVenusApi.UpdateOrganizationRequest` 
     
 </dd>
 </dl>
@@ -1015,7 +1107,7 @@ await client.organization.getPostmanTeamIdByOrgId({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">isMember</a>({ ...params }) -> core.APIResponse&lt;boolean, FernVenusApi.organization.isMember.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">get</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.get.Error&gt;</code></summary>
 <dl>
 <dd>
 
@@ -1028,8 +1120,8 @@ await client.organization.getPostmanTeamIdByOrgId({
 <dd>
 
 ```typescript
-await client.organization.isMember({
-    organizationId: "organization_id"
+await client.organization.get({
+    orgId: "org_id"
 });
 
 ```
@@ -1046,7 +1138,7 @@ await client.organization.isMember({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest` 
+**request:** `FernVenusApi.GetOrganizationsOrgIdGetRequest` 
     
 </dd>
 </dl>
@@ -1066,7 +1158,7 @@ await client.organization.isMember({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getMyOrganizationFromScopedToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">delete</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.delete.Error&gt;</code></summary>
 <dl>
 <dd>
 
@@ -1078,7 +1170,10 @@ await client.organization.isMember({
 <dl>
 <dd>
 
-Returns the org for a scoped token. The token is limited to one organization.
+Deletes an organization. Only users with admin role can delete organizations.
+Called with the provisioner token, it only works for an unclaimed
+organization that was created with that token, and returns 403 for any
+other. It also revokes that organization's API keys.
 </dd>
 </dl>
 </dd>
@@ -1093,7 +1188,9 @@ Returns the org for a scoped token. The token is limited to one organization.
 <dd>
 
 ```typescript
-await client.organization.getMyOrganizationFromScopedToken();
+await client.organization.delete({
+    orgId: "org_id"
+});
 
 ```
 </dd>
@@ -1109,7 +1206,7 @@ await client.organization.getMyOrganizationFromScopedToken();
 <dl>
 <dd>
 
-**request:** `FernVenusApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest` 
+**request:** `FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest` 
     
 </dd>
 </dl>
@@ -1129,10 +1226,24 @@ await client.organization.getMyOrganizationFromScopedToken();
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsFromToken</a>() -> core.APIResponse&lt;string[], FernVenusApi.organization.getOrgIdsFromToken.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsByPostmanTeamId</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Look up an organization by its associated Postman team ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1142,7 +1253,9 @@ await client.organization.getMyOrganizationFromScopedToken();
 <dd>
 
 ```typescript
-await client.organization.getOrgIdsFromToken();
+await client.organization.getOrgIdsByPostmanTeamId({
+    postmanTeamId: "postman_team_id"
+});
 
 ```
 </dd>
@@ -1158,6 +1271,14 @@ await client.organization.getOrgIdsFromToken();
 <dl>
 <dd>
 
+**request:** `FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `OrganizationClient.RequestOptions` 
     
 </dd>
@@ -1170,10 +1291,27 @@ await client.organization.getOrgIdsFromToken();
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">addUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.addUser.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getPostmanTeamDocs</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+The claimable organization linked to a Postman team, with its claim
+status and the address of its docs site. Only Postman's integration
+service token can call it. 404 when the team has no claimable
+organization, or its docs address isn't set.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1183,9 +1321,8 @@ await client.organization.getOrgIdsFromToken();
 <dd>
 
 ```typescript
-await client.organization.addUser({
-    userId: "userId",
-    orgId: "orgId"
+await client.organization.getPostmanTeamDocs({
+    postmanTeamId: "postman_team_id"
 });
 
 ```
@@ -1202,7 +1339,7 @@ await client.organization.addUser({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.AddUserToOrgRequest` 
+**request:** `FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest` 
     
 </dd>
 </dl>
@@ -1222,10 +1359,24 @@ await client.organization.addUser({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">inviteUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.inviteUser.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getPostmanTeamIdByOrgId</a>({ ...params }) -> core.APIResponse&lt;string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Get the Postman team ID associated with an organization ID.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1235,9 +1386,8 @@ await client.organization.addUser({
 <dd>
 
 ```typescript
-await client.organization.inviteUser({
-    emailAddress: "emailAddress",
-    auth0OrgId: "auth0OrgId"
+await client.organization.getPostmanTeamIdByOrgId({
+    orgId: "org_id"
 });
 
 ```
@@ -1254,7 +1404,7 @@ await client.organization.inviteUser({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.InviteUserToOrgRequest` 
+**request:** `FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest` 
     
 </dd>
 </dl>
@@ -1274,10 +1424,26 @@ await client.organization.inviteUser({
 </dl>
 </details>
 
-<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">removeUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.removeUser.Error&gt;</code></summary>
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getClaimStatus</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Whether a claimable organization has been claimed. Public, so a docs
+site can show a claim banner to signed-out visitors. Organizations
+that were never claimable return 404.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1287,9 +1453,8 @@ await client.organization.inviteUser({
 <dd>
 
 ```typescript
-await client.organization.removeUser({
-    userId: "userId",
-    auth0OrgId: "auth0OrgId"
+await client.organization.getClaimStatus({
+    orgId: "org_id"
 });
 
 ```
@@ -1306,7 +1471,7 @@ await client.organization.removeUser({
 <dl>
 <dd>
 
-**request:** `FernVenusApi.RemoveUserFromOrgRequest` 
+**request:** `FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest` 
     
 </dd>
 </dl>
@@ -1326,7 +1491,661 @@ await client.organization.removeUser({
 </dl>
 </details>
 
-## Registry
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">createClaimToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Issues a claim link for an unclaimed organization, bound to one Postman
+user and valid for 15 minutes. Only the provisioner token and Postman's
+integration service token can call it.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.createClaimToken({
+    orgId: "org_id",
+    postmanUserId: "postmanUserId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.CreateClaimTokenRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">setDocsUrl</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.setDocsUrl.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Sets the address of an unclaimed organization's docs site, which the
+team docs lookup returns. Only the provisioner token can call it, and
+only until the organization is claimed.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.setDocsUrl({
+    orgId: "org_id",
+    docsUrl: "docsUrl"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.SetDocsUrlRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">claim</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claim.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Redeems a claim link. The caller, signed in as the Postman user the link
+is for, becomes the admin of the organization. The first claim wins, and
+a retry by the same user finishes a claim that failed partway.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.claim({
+    claimToken: "claimToken"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ClaimOrganizationRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">previewClaim</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimPreviewResponse, FernVenusApi.organization.previewClaim.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+What a claim link is for, without redeeming it, so the dashboard can show
+the organization and the link's state before the user signs in. Public:
+the link is the secret. The token is in the body to keep it out of
+request logs.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.previewClaim({
+    claimToken: "claimToken"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ClaimOrganizationRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">claimFromDocsSite</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claimFromDocsSite.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Redeems a claim link without a Fern sign-in, for the Claim button on
+the organization's docs site. The organization is claimed for the
+Postman user the link was issued for, who becomes its admin if they
+already have a Fern account; otherwise the organization starts with
+no members, and the dashboard adds the team's Postman users when they
+sign in with Postman. Public: the link is the secret, and only the
+provisioner and Postman's integration service can get one. The first
+claim wins, and a retry finishes a claim that failed partway.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.claimFromDocsSite({
+    claimToken: "claimToken"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ClaimOrganizationRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">isMember</a>({ ...params }) -> core.APIResponse&lt;boolean, FernVenusApi.organization.isMember.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.isMember({
+    organizationId: "organization_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getMyOrganizationFromScopedToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the org for a scoped token. The token is limited to one organization.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.getMyOrganizationFromScopedToken();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsFromToken</a>() -> core.APIResponse&lt;string[], FernVenusApi.organization.getOrgIdsFromToken.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.getOrgIdsFromToken();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">addUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.addUser.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.addUser({
+    userId: "userId",
+    orgId: "orgId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.AddUserToOrgRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">inviteUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.inviteUser.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.inviteUser({
+    emailAddress: "emailAddress",
+    auth0OrgId: "auth0OrgId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.InviteUserToOrgRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">removeUser</a>({ ...params }) -> core.APIResponse&lt;void, FernVenusApi.organization.removeUser.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.removeUser({
+    userId: "userId",
+    auth0OrgId: "auth0OrgId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.RemoveUserFromOrgRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Registry
 <details><summary><code>client.registry.<a href="/src/api/resources/registry/client/Client.ts">generateRegistryTokens</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.RegistryTokens, FernVenusApi.registry.generateRegistryTokens.Error&gt;</code></summary>
 <dl>
 <dd>
@@ -1636,6 +2455,181 @@ await client.user.linkAccounts({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## InternalGuestSession
+<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">readByOrg</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.InternalGuestSessionResponse, FernVenusApi.internalGuestSession.readByOrg.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The session behind a guest organization, for the service holding
+its work. This is the read the pull model in ``guest_resources`` rests
+on: FDR and Fiddle know the ``guest-<id>`` org their rows belong to, not
+the session ID, token or claim secret, so this is keyed by the org and
+opened by the service credential alone.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.internalGuestSession.readByOrg({
+    orgId: "org_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InternalGuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">reserve</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ReserveResponse, FernVenusApi.internalGuestSession.reserve.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.internalGuestSession.reserve({
+    sessionId: "session_id",
+    kind: "sdkBuild"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ReserveRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InternalGuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">settle</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.SettleResponse, FernVenusApi.internalGuestSession.settle.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.internalGuestSession.settle({
+    sessionId: "session_id",
+    reservationId: "reservationId",
+    outcome: "succeeded"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.SettleRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `InternalGuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>