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

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
-        "X-Fern-SDK-Version": "11.6.0",
-        "User-Agent": "@fern-api/venus-api-sdk/11.6.0",
+        "X-Fern-SDK-Version": "11.7.0",
+        "User-Agent": "@fern-api/venus-api-sdk/11.7.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/resources/apiKeys/client/Client.d.ts

@@ -37,6 +37,10 @@ export declare class ApiKeysClient {
     getTokenMetadata(request: FernVenusApi.GetTokenMetadataRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata, FernVenusApi.apiKeys.getTokenMetadata.Error>>;
     private __getTokenMetadata;
     /**
+     * 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.
+     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -48,6 +52,11 @@ export declare class ApiKeysClient {
     getTokensForOrganization(request: FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata[], FernVenusApi.apiKeys.getTokensForOrganization.Error>>;
     private __getTokensForOrganization;
     /**
+     * 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.
+     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/apiKeys/client/Client.js

@@ -229,6 +229,10 @@ class ApiKeysClient {
         });
     }
     /**
+     * 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.
+     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -304,6 +308,11 @@ class ApiKeysClient {
         });
     }
     /**
+     * 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.
+     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -318,14 +327,17 @@ class ApiKeysClient {
     __revokeTokenById(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { tokenId } = request;
+            const { tokenId, organizationId } = request;
+            const _queryParams = {
+                organizationId,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `api-keys/revoke/${core.url.encodePathParam(tokenId)}`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
                 maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/cjs/api/resources/apiKeys/client/requests/RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.d.ts

@@ -6,4 +6,5 @@
  */
 export interface RevokeTokenByIdApiKeysRevokeTokenIdPostRequest {
     tokenId: string;
+    organizationId?: string | null;
 }

package/dist/cjs/api/resources/organization/client/Client.d.ts

@@ -52,6 +52,9 @@ export declare class OrganizationClient {
     private __get;
     /**
      * 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.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/organization/client/Client.js

@@ -306,6 +306,9 @@ class OrganizationClient {
     }
     /**
      * 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.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/version.d.ts

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

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "11.6.0";
+exports.SDK_VERSION = "11.7.0";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
-        "X-Fern-SDK-Version": "11.6.0",
-        "User-Agent": "@fern-api/venus-api-sdk/11.6.0",
+        "X-Fern-SDK-Version": "11.7.0",
+        "User-Agent": "@fern-api/venus-api-sdk/11.7.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/apiKeys/client/Client.d.mts

@@ -37,6 +37,10 @@ export declare class ApiKeysClient {
     getTokenMetadata(request: FernVenusApi.GetTokenMetadataRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata, FernVenusApi.apiKeys.getTokenMetadata.Error>>;
     private __getTokenMetadata;
     /**
+     * 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.
+     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -48,6 +52,11 @@ export declare class ApiKeysClient {
     getTokensForOrganization(request: FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata[], FernVenusApi.apiKeys.getTokensForOrganization.Error>>;
     private __getTokensForOrganization;
     /**
+     * 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.
+     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/apiKeys/client/Client.mjs

@@ -193,6 +193,10 @@ export class ApiKeysClient {
         });
     }
     /**
+     * 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.
+     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -268,6 +272,11 @@ export class ApiKeysClient {
         });
     }
     /**
+     * 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.
+     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -282,14 +291,17 @@ export class ApiKeysClient {
     __revokeTokenById(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { tokenId } = request;
+            const { tokenId, organizationId } = request;
+            const _queryParams = {
+                organizationId,
+            };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `api-keys/revoke/${core.url.encodePathParam(tokenId)}`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
                 maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/esm/api/resources/apiKeys/client/requests/RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.d.mts

@@ -6,4 +6,5 @@
  */
 export interface RevokeTokenByIdApiKeysRevokeTokenIdPostRequest {
     tokenId: string;
+    organizationId?: string | null;
 }

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

@@ -52,6 +52,9 @@ export declare class OrganizationClient {
     private __get;
     /**
      * 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.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -270,6 +270,9 @@ export class OrganizationClient {
     }
     /**
      * 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.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fern-api/venus-api-sdk",
-    "version": "11.6.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>