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

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

@@ -0,0 +1,10 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+export declare const GuestSessionLimits: core.serialization.ObjectSchema<serializers.GuestSessionLimits.Raw, FernVenusApi.GuestSessionLimits>;
+export declare namespace GuestSessionLimits {
+    interface Raw {
+        sdkBuilds: number;
+        docsPublishes: number;
+    }
+}

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

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+export const GuestSessionLimits = core.serialization.object({
+    sdkBuilds: core.serialization.number(),
+    docsPublishes: core.serialization.number(),
+});

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

@@ -5,9 +5,11 @@ 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

@@ -5,9 +5,11 @@ 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.4.0";
+export declare const SDK_VERSION = "11.5.0";

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/venus-api-sdk",
-    "version": "11.4.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>