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

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

@@ -0,0 +1,7 @@
+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 TooManyRequestsErrorBodyContentCode: core.serialization.Schema<serializers.TooManyRequestsErrorBodyContentCode.Raw, FernVenusApi.TooManyRequestsErrorBodyContentCode>;
+export declare namespace TooManyRequestsErrorBodyContentCode {
+    type Raw = "RATE_LIMITED";
+}

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

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+export const TooManyRequestsErrorBodyContentCode = core.serialization.enum_(["RATE_LIMITED"]);

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

@@ -1,4 +1,6 @@
 export * from "./Active.mjs";
+export * from "./ClaimGuestSessionResponse.mjs";
+export * from "./ClaimGuestSessionResponseStatus.mjs";
 export * from "./ClaimOrganizationRequest.mjs";
 export * from "./ClaimOrganizationResponse.mjs";
 export * from "./ClaimPreviewResponse.mjs";
@@ -8,14 +10,25 @@ export * from "./ClaimTokenResponse.mjs";
 export * from "./CreateGuestSessionResponse.mjs";
 export * from "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
+export * from "./DeleteGuestSessionResponse.mjs";
+export * from "./DeleteGuestSessionResponseStatus.mjs";
 export * from "./Expired.mjs";
+export * from "./GetGuestSessionResponse.mjs";
+export * from "./GetGuestSessionResponseStatus.mjs";
+export * from "./GoneErrorBody.mjs";
+export * from "./GoneErrorBodyContent.mjs";
+export * from "./GoneErrorBodyContentCode.mjs";
 export * from "./GuestSessionLimits.mjs";
+export * from "./GuestSessionUsage.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";
 export * from "./LinkAccountsResponse.mjs";
 export * from "./Maven.mjs";
 export * from "./MavenRegistryToken.mjs";
+export * from "./NotFoundErrorBody.mjs";
+export * from "./NotFoundErrorBodyContent.mjs";
+export * from "./NotFoundErrorBodyContentCode.mjs";
 export * from "./Npm.mjs";
 export * from "./NpmRegistryToken.mjs";
 export * from "./Organization.mjs";
@@ -26,8 +39,14 @@ export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.mjs";
 export * from "./RegistryTokens.mjs";
 export * from "./Revoked.mjs";
+export * from "./ServiceUnavailableErrorBody.mjs";
+export * from "./ServiceUnavailableErrorBodyContent.mjs";
+export * from "./ServiceUnavailableErrorBodyContentCode.mjs";
 export * from "./TokenMetadata.mjs";
 export * from "./TokenStatus.mjs";
+export * from "./TooManyRequestsErrorBody.mjs";
+export * from "./TooManyRequestsErrorBodyContent.mjs";
+export * from "./TooManyRequestsErrorBodyContentCode.mjs";
 export * from "./User.mjs";
 export * from "./ValidationError.mjs";
 export * from "./ValidationErrorLocItem.mjs";

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

@@ -1,4 +1,6 @@
 export * from "./Active.mjs";
+export * from "./ClaimGuestSessionResponse.mjs";
+export * from "./ClaimGuestSessionResponseStatus.mjs";
 export * from "./ClaimOrganizationRequest.mjs";
 export * from "./ClaimOrganizationResponse.mjs";
 export * from "./ClaimPreviewResponse.mjs";
@@ -8,14 +10,25 @@ export * from "./ClaimTokenResponse.mjs";
 export * from "./CreateGuestSessionResponse.mjs";
 export * from "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
+export * from "./DeleteGuestSessionResponse.mjs";
+export * from "./DeleteGuestSessionResponseStatus.mjs";
 export * from "./Expired.mjs";
+export * from "./GetGuestSessionResponse.mjs";
+export * from "./GetGuestSessionResponseStatus.mjs";
+export * from "./GoneErrorBody.mjs";
+export * from "./GoneErrorBodyContent.mjs";
+export * from "./GoneErrorBodyContentCode.mjs";
 export * from "./GuestSessionLimits.mjs";
+export * from "./GuestSessionUsage.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";
 export * from "./LinkAccountsResponse.mjs";
 export * from "./Maven.mjs";
 export * from "./MavenRegistryToken.mjs";
+export * from "./NotFoundErrorBody.mjs";
+export * from "./NotFoundErrorBodyContent.mjs";
+export * from "./NotFoundErrorBodyContentCode.mjs";
 export * from "./Npm.mjs";
 export * from "./NpmRegistryToken.mjs";
 export * from "./Organization.mjs";
@@ -26,8 +39,14 @@ export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.mjs";
 export * from "./RegistryTokens.mjs";
 export * from "./Revoked.mjs";
+export * from "./ServiceUnavailableErrorBody.mjs";
+export * from "./ServiceUnavailableErrorBodyContent.mjs";
+export * from "./ServiceUnavailableErrorBodyContentCode.mjs";
 export * from "./TokenMetadata.mjs";
 export * from "./TokenStatus.mjs";
+export * from "./TooManyRequestsErrorBody.mjs";
+export * from "./TooManyRequestsErrorBodyContent.mjs";
+export * from "./TooManyRequestsErrorBodyContentCode.mjs";
 export * from "./User.mjs";
 export * from "./ValidationError.mjs";
 export * from "./ValidationErrorLocItem.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

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

package/reference.md

@@ -267,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>
@@ -318,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>
@@ -739,6 +772,215 @@ await client.guestSession.create({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.guestSession.get({
+    sessionId: "session_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.GetGuestSessionsSessionIdGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `GuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<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>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.guestSession.delete({
+    sessionId: "session_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.DeleteGuestSessionsSessionIdDeleteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `GuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<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>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.guestSession.claim({
+    sessionId: "session_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.ClaimGuestSessionRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `GuestSessionClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -929,6 +1171,9 @@ await client.organization.get({
 <dd>
 
 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>