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

package/dist/esm/api/resources/organization/client/setDocsUrl.d.mts

@@ -0,0 +1,25 @@
+import type * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export type Error = FernVenusApi.organization.setDocsUrl.Error.UnprocessableEntityError | FernVenusApi.organization.setDocsUrl.Error._Unknown;
+export declare namespace Error {
+    interface UnprocessableEntityError extends _Utils {
+        statusCode: 422;
+        content: FernVenusApi.HttpValidationError;
+    }
+    interface _Unknown extends _Utils {
+        statusCode: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.organization.setDocsUrl.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.organization.setDocsUrl.Error.UnprocessableEntityError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.setDocsUrl.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.organization.setDocsUrl.Error, visitor: FernVenusApi.organization.setDocsUrl.Error._Visitor<_Result>) => _Result;
+};

package/dist/esm/api/resources/organization/client/setDocsUrl.mjs

@@ -0,0 +1,30 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as FernVenusApi from "../../../index.mjs";
+export const Error = {
+    unprocessableEntityError: (value) => {
+        return {
+            content: value,
+            statusCode: 422,
+            _visit: function (visitor) {
+                return FernVenusApi.organization.setDocsUrl.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            statusCode: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.organization.setDocsUrl.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.statusCode) {
+            case 422:
+                return visitor.unprocessableEntityError(value.content);
+            default:
+                return visitor._other(value.content);
+        }
+    },
+};

package/dist/esm/api/types/PostmanTeamDocsResponse.d.mts

@@ -0,0 +1,6 @@
+import type * as FernVenusApi from "../index.mjs";
+export interface PostmanTeamDocsResponse {
+    organizationId: string;
+    claimStatus: FernVenusApi.ClaimStatus;
+    docsUrl: string;
+}

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

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -20,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/api/types/index.mjs

@@ -20,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/resources/organization/client/requests/SetDocsUrlRequest.d.mts

@@ -0,0 +1,9 @@
+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 SetDocsUrlRequest: core.serialization.Schema<serializers.SetDocsUrlRequest.Raw, Omit<FernVenusApi.SetDocsUrlRequest, "orgId">>;
+export declare namespace SetDocsUrlRequest {
+    interface Raw {
+        docsUrl: string;
+    }
+}

package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.mjs

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

package/dist/esm/serialization/resources/organization/client/requests/index.d.mts

@@ -3,4 +3,5 @@ export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
 export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
 export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
 export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
+export { SetDocsUrlRequest } from "./SetDocsUrlRequest.mjs";
 export { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.mjs";

package/dist/esm/serialization/resources/organization/client/requests/index.mjs

@@ -3,4 +3,5 @@ export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
 export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
 export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
 export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
+export { SetDocsUrlRequest } from "./SetDocsUrlRequest.mjs";
 export { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.mjs";

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

@@ -20,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

@@ -20,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.5.0";
+export declare const SDK_VERSION = "11.7.0";

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/venus-api-sdk",
-    "version": "11.5.0",
+    "version": "11.7.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>
@@ -929,6 +962,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>
@@ -1042,6 +1078,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>
@@ -1191,7 +1295,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>
@@ -1241,6 +1346,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>