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

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

@@ -0,0 +1,10 @@
+// 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 ClaimPreviewResponse = core.serialization.object({
+    organizationId: core.serialization.string(),
+    displayName: core.serialization.string(),
+    claimStatus: ClaimStatus,
+    expiresAt: core.serialization.date(),
+    redeemed: core.serialization.boolean(),
+});

package/dist/esm/serialization/types/ClaimTokenResponse.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 ClaimTokenResponse: core.serialization.ObjectSchema<serializers.ClaimTokenResponse.Raw, FernVenusApi.ClaimTokenResponse>;
+export declare namespace ClaimTokenResponse {
+    interface Raw {
+        claimUrl: string;
+        expiresAt: string;
+    }
+}

package/dist/esm/serialization/types/ClaimTokenResponse.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 ClaimTokenResponse = core.serialization.object({
+    claimUrl: core.serialization.string(),
+    expiresAt: core.serialization.date(),
+});

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

@@ -1,6 +1,10 @@
 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 "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
 export * from "./Expired.mjs";

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

@@ -1,6 +1,10 @@
 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 "./CreateOrganizationResponse.mjs";
 export * from "./CreateTokenResponse.mjs";
 export * from "./Expired.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

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

package/reference.md

@@ -1103,6 +1103,208 @@ await client.organization.getClaimStatus({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">createClaimToken</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organization.createClaimToken({
+    orgId: "org_id",
+    postmanUserId: "postmanUserId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `FernVenusApi.CreateClaimTokenRequest` 
+    
+</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">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>