@fern-api/venus-api-sdk 11.7.0 → 12.1.0

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { ServiceUnavailableErrorBodyContent } from "./ServiceUnavailableErrorBodyContent.mjs";
+export const ServiceUnavailableErrorBody = core.serialization.object({
+    error: core.serialization.string(),
+    content: ServiceUnavailableErrorBodyContent,
+});

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

@@ -0,0 +1,14 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { ServiceUnavailableErrorBodyContentCode } from "./ServiceUnavailableErrorBodyContentCode.mjs";
+export declare const ServiceUnavailableErrorBodyContent: core.serialization.ObjectSchema<serializers.ServiceUnavailableErrorBodyContent.Raw, FernVenusApi.ServiceUnavailableErrorBodyContent>;
+export declare namespace ServiceUnavailableErrorBodyContent {
+    interface Raw {
+        code: ServiceUnavailableErrorBodyContentCode.Raw;
+        retryable: boolean;
+        suggestedFix: string;
+        nextSteps?: string[] | null;
+        limit?: Record<string, unknown> | null;
+    }
+}

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

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { ServiceUnavailableErrorBodyContentCode } from "./ServiceUnavailableErrorBodyContentCode.mjs";
+export const ServiceUnavailableErrorBodyContent = core.serialization.object({
+    code: ServiceUnavailableErrorBodyContentCode,
+    retryable: core.serialization.boolean(),
+    suggestedFix: core.serialization.string(),
+    nextSteps: core.serialization.list(core.serialization.string()).optional(),
+    limit: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
+});

package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContentCode.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 ServiceUnavailableErrorBodyContentCode: core.serialization.Schema<serializers.ServiceUnavailableErrorBodyContentCode.Raw, FernVenusApi.ServiceUnavailableErrorBodyContentCode>;
+export declare namespace ServiceUnavailableErrorBodyContentCode {
+    type Raw = "GUEST_SESSIONS_DISABLED" | "GUEST_SESSION_NOT_ISSUED" | "GUEST_SESSION_CHECK_FAILED";
+}

package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContentCode.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 ServiceUnavailableErrorBodyContentCode = core.serialization.enum_(["GUEST_SESSIONS_DISABLED", "GUEST_SESSION_NOT_ISSUED", "GUEST_SESSION_CHECK_FAILED"]);

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

@@ -0,0 +1,11 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { SettleResponseReason } from "./SettleResponseReason.mjs";
+export declare const SettleResponse: core.serialization.ObjectSchema<serializers.SettleResponse.Raw, FernVenusApi.SettleResponse>;
+export declare namespace SettleResponse {
+    interface Raw {
+        settled: boolean;
+        reason?: (SettleResponseReason.Raw | null | undefined) | null;
+    }
+}

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { SettleResponseReason } from "./SettleResponseReason.mjs";
+export const SettleResponse = core.serialization.object({
+    settled: core.serialization.boolean(),
+    reason: SettleResponseReason.optionalNullable(),
+});

package/dist/esm/serialization/types/SettleResponseReason.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 SettleResponseReason: core.serialization.Schema<serializers.SettleResponseReason.Raw, FernVenusApi.SettleResponseReason>;
+export declare namespace SettleResponseReason {
+    type Raw = "alreadySettled" | "leaseExpired";
+}

package/dist/esm/serialization/types/SettleResponseReason.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 SettleResponseReason = core.serialization.enum_(["alreadySettled", "leaseExpired"]);

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

@@ -0,0 +1,11 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { TooManyRequestsErrorBodyContent } from "./TooManyRequestsErrorBodyContent.mjs";
+export declare const TooManyRequestsErrorBody: core.serialization.ObjectSchema<serializers.TooManyRequestsErrorBody.Raw, FernVenusApi.TooManyRequestsErrorBody>;
+export declare namespace TooManyRequestsErrorBody {
+    interface Raw {
+        error: string;
+        content: TooManyRequestsErrorBodyContent.Raw;
+    }
+}

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { TooManyRequestsErrorBodyContent } from "./TooManyRequestsErrorBodyContent.mjs";
+export const TooManyRequestsErrorBody = core.serialization.object({
+    error: core.serialization.string(),
+    content: TooManyRequestsErrorBodyContent,
+});

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

@@ -0,0 +1,14 @@
+import type * as FernVenusApi from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import type * as serializers from "../index.mjs";
+import { TooManyRequestsErrorBodyContentCode } from "./TooManyRequestsErrorBodyContentCode.mjs";
+export declare const TooManyRequestsErrorBodyContent: core.serialization.ObjectSchema<serializers.TooManyRequestsErrorBodyContent.Raw, FernVenusApi.TooManyRequestsErrorBodyContent>;
+export declare namespace TooManyRequestsErrorBodyContent {
+    interface Raw {
+        code: TooManyRequestsErrorBodyContentCode.Raw;
+        retryable: boolean;
+        suggestedFix: string;
+        nextSteps?: string[] | null;
+        limit?: Record<string, unknown> | null;
+    }
+}

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

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../core/index.mjs";
+import { TooManyRequestsErrorBodyContentCode } from "./TooManyRequestsErrorBodyContentCode.mjs";
+export const TooManyRequestsErrorBodyContent = core.serialization.object({
+    code: TooManyRequestsErrorBodyContentCode,
+    retryable: core.serialization.boolean(),
+    suggestedFix: core.serialization.string(),
+    nextSteps: core.serialization.list(core.serialization.string()).optional(),
+    limit: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
+});

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,28 @@ 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 "./InternalGuestSessionResponse.mjs";
+export * from "./InternalGuestSessionResponseStatus.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";
+export * from "./Limit.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";
@@ -25,9 +41,20 @@ export * from "./Pypi.mjs";
 export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.mjs";
 export * from "./RegistryTokens.mjs";
+export * from "./ReserveResponse.mjs";
+export * from "./ReserveResponseKind.mjs";
+export * from "./ReserveResponseState.mjs";
 export * from "./Revoked.mjs";
+export * from "./ServiceUnavailableErrorBody.mjs";
+export * from "./ServiceUnavailableErrorBodyContent.mjs";
+export * from "./ServiceUnavailableErrorBodyContentCode.mjs";
+export * from "./SettleResponse.mjs";
+export * from "./SettleResponseReason.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,28 @@ 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 "./InternalGuestSessionResponse.mjs";
+export * from "./InternalGuestSessionResponseStatus.mjs";
 export * from "./JwtResponse.mjs";
 export * from "./LightweightUser.mjs";
+export * from "./Limit.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";
@@ -25,9 +41,20 @@ export * from "./Pypi.mjs";
 export * from "./PypiRegistryToken.mjs";
 export * from "./RegistryToken.mjs";
 export * from "./RegistryTokens.mjs";
+export * from "./ReserveResponse.mjs";
+export * from "./ReserveResponseKind.mjs";
+export * from "./ReserveResponseState.mjs";
 export * from "./Revoked.mjs";
+export * from "./ServiceUnavailableErrorBody.mjs";
+export * from "./ServiceUnavailableErrorBodyContent.mjs";
+export * from "./ServiceUnavailableErrorBodyContentCode.mjs";
+export * from "./SettleResponse.mjs";
+export * from "./SettleResponseReason.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.7.0";
+export declare const SDK_VERSION = "12.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "11.7.0";
+export const SDK_VERSION = "12.1.0";

package/package.json

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

package/reference.md

@@ -772,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>
@@ -2174,6 +2383,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>