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

package/reference.md

@@ -1170,6 +1170,141 @@ await client.organization.createClaimToken({
 </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>