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

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

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { GuestSessionLimits } from "./GuestSessionLimits.mjs";
+export const CreateGuestSessionResponse = core.serialization.object({
+    sessionId: core.serialization.string(),
+    organizationId: core.serialization.string(),
+    token: core.serialization.string(),
+    claimSecret: core.serialization.string(),
+    expiresAt: core.serialization.date(),
+    limits: GuestSessionLimits,
+});

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/PostmanTeamDocsResponse.d.mts

@@ -0,0 +1,12 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { ClaimStatus } from "./ClaimStatus.mjs";
+export declare const PostmanTeamDocsResponse: core.serialization.ObjectSchema<serializers.PostmanTeamDocsResponse.Raw, FernVenusApi.PostmanTeamDocsResponse>;
+export declare namespace PostmanTeamDocsResponse {
+    interface Raw {
+        organizationId: string;
+        claimStatus: ClaimStatus.Raw;
+        docsUrl: string;
+    }
+}

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { ClaimStatus } from "./ClaimStatus.mjs";
+export const PostmanTeamDocsResponse = core.serialization.object({
+    organizationId: core.serialization.string(),
+    claimStatus: ClaimStatus,
+    docsUrl: core.serialization.string(),
+});

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";
@@ -18,6 +20,7 @@ export * from "./Npm.mjs";
 export * from "./NpmRegistryToken.mjs";
 export * from "./Organization.mjs";
 export * from "./OrganizationsPage.mjs";
+export * from "./PostmanTeamDocsResponse.mjs";
 export * from "./Pypi.mjs";
 export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.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";
@@ -18,6 +20,7 @@ export * from "./Npm.mjs";
 export * from "./NpmRegistryToken.mjs";
 export * from "./Organization.mjs";
 export * from "./OrganizationsPage.mjs";
+export * from "./PostmanTeamDocsResponse.mjs";
 export * from "./Pypi.mjs";
 export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "11.4.0";
+export declare const SDK_VERSION = "11.6.0";

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/venus-api-sdk",
-    "version": "11.4.0",
+    "version": "11.6.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>
@@ -971,6 +1042,74 @@ await client.organization.getOrgIdsByPostmanTeamId({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.getPostmanTeamDocs({
+    postmanTeamId: "postman_team_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1120,7 +1259,8 @@ await client.organization.getClaimStatus({
 <dd>
 
 Issues a claim link for an unclaimed organization, bound to one Postman
-user and valid for 15 minutes. Only the provisioner token can call it.
+user and valid for 15 minutes. Only the provisioner token and Postman's
+integration service token can call it.
 </dd>
 </dl>
 </dd>
@@ -1170,6 +1310,74 @@ await client.organization.createClaimToken({
 </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>