@fern-api/venus-api-sdk 11.3.0 → 11.5.0

package/dist/esm/serialization/types/index.d.mts

@@ -1,10 +1,15 @@
 export * from "./Active.mjs";
+export * from "./ClaimOrganizationRequest.mjs";
+export * from "./ClaimOrganizationResponse.mjs";
+export * from "./ClaimPreviewResponse.mjs";
 export * from "./ClaimStatus.mjs";
 export * from "./ClaimStatusResponse.mjs";
 export * from "./ClaimTokenResponse.mjs";
+export * from "./CreateGuestSessionResponse.mjs";
 export * from "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
 export * from "./Expired.mjs";
+export * from "./GuestSessionLimits.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";

package/dist/esm/serialization/types/index.mjs

@@ -1,10 +1,15 @@
 export * from "./Active.mjs";
+export * from "./ClaimOrganizationRequest.mjs";
+export * from "./ClaimOrganizationResponse.mjs";
+export * from "./ClaimPreviewResponse.mjs";
 export * from "./ClaimStatus.mjs";
 export * from "./ClaimStatusResponse.mjs";
 export * from "./ClaimTokenResponse.mjs";
+export * from "./CreateGuestSessionResponse.mjs";
 export * from "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
 export * from "./Expired.mjs";
+export * from "./GuestSessionLimits.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "11.3.0";
+export declare const SDK_VERSION = "11.5.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "11.3.0";
+export const SDK_VERSION = "11.5.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/venus-api-sdk",
-    "version": "11.3.0",
+    "version": "11.5.0",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -668,6 +668,77 @@ await client.auth.getJwt({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## 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>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.guestSession.create({
+    fingerprint: "fingerprint"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.CreateGuestSessionRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `GuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1170,6 +1241,141 @@ await client.organization.createClaimToken({
 </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>