@fern-api/venus-api-sdk 13.0.0 → 14.0.0

package/dist/esm/Client.mjs

@@ -11,6 +11,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import * as FernVenusApi from "./api/index.mjs";
 import { ApiKeysClient } from "./api/resources/apiKeys/client/Client.mjs";
 import { AuthClient } from "./api/resources/auth/client/Client.mjs";
+import { GuestSessionClient } from "./api/resources/guestSession/client/Client.mjs";
+import { InternalGuestSessionClient } from "./api/resources/internalGuestSession/client/Client.mjs";
 import { OrganizationClient } from "./api/resources/organization/client/Client.mjs";
 import { RegistryClient } from "./api/resources/registry/client/Client.mjs";
 import { UserClient } from "./api/resources/user/client/Client.mjs";
@@ -29,6 +31,10 @@ export class FernVenusApiClient {
         var _a;
         return ((_a = this._auth) !== null && _a !== void 0 ? _a : (this._auth = new AuthClient(this._options)));
     }
+    get guestSession() {
+        var _a;
+        return ((_a = this._guestSession) !== null && _a !== void 0 ? _a : (this._guestSession = new GuestSessionClient(this._options)));
+    }
     get organization() {
         var _a;
         return ((_a = this._organization) !== null && _a !== void 0 ? _a : (this._organization = new OrganizationClient(this._options)));
@@ -41,24 +47,26 @@ export class FernVenusApiClient {
         var _a;
         return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new UserClient(this._options)));
     }
+    get internalGuestSession() {
+        var _a;
+        return ((_a = this._internalGuestSession) !== null && _a !== void 0 ? _a : (this._internalGuestSession = new InternalGuestSessionClient(this._options)));
+    }
     /**
-     * Endpoint that serves Prometheus metrics.
-     *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.metricsMetricsGet()
+     *     await client.healthHealthGet()
      */
-    metricsMetricsGet(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__metricsMetricsGet(requestOptions));
+    healthHealthGet(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__healthHealthGet(requestOptions));
     }
-    __metricsMetricsGet(requestOptions) {
+    __healthHealthGet(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             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)), "metrics"),
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "health"),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -82,7 +90,7 @@ export class FernVenusApiClient {
             return {
                 data: {
                     ok: false,
-                    error: FernVenusApi.metricsMetricsGet.Error._unknown(_response.error),
+                    error: FernVenusApi.healthHealthGet.Error._unknown(_response.error),
                     rawResponse: _response.rawResponse,
                 },
                 rawResponse: _response.rawResponse,
@@ -93,21 +101,22 @@ export class FernVenusApiClient {
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.healthHealthGet()
+     *     await client.pingPingGet()
      */
-    healthHealthGet(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__healthHealthGet(requestOptions));
+    pingPingGet(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingPingGet(requestOptions));
     }
-    __healthHealthGet(requestOptions) {
+    __pingPingGet(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             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)), "health"),
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "ping"),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                responseType: "text",
                 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,
@@ -128,7 +137,7 @@ export class FernVenusApiClient {
             return {
                 data: {
                     ok: false,
-                    error: FernVenusApi.healthHealthGet.Error._unknown(_response.error),
+                    error: FernVenusApi.pingPingGet.Error._unknown(_response.error),
                     rawResponse: _response.rawResponse,
                 },
                 rawResponse: _response.rawResponse,
@@ -142,6 +151,10 @@ export class FernVenusApiClient {
      * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
      * when no RDS engines are configured.
      *
+     * ``hosts_allowlisted`` is true only if every engine's host matches
+     * RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
+     * since nothing has then vouched for the hosts.
+     *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example

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

@@ -1,3 +1,3 @@
 export * as healthHealthGet from "./healthHealthGet.mjs";
 export * as healthRdsHealthRdsGet from "./healthRdsHealthRdsGet.mjs";
-export * as metricsMetricsGet from "./metricsMetricsGet.mjs";
+export * as pingPingGet from "./pingPingGet.mjs";

package/dist/esm/api/client/index.mjs

@@ -1,3 +1,3 @@
 export * as healthHealthGet from "./healthHealthGet.mjs";
 export * as healthRdsHealthRdsGet from "./healthRdsHealthRdsGet.mjs";
-export * as metricsMetricsGet from "./metricsMetricsGet.mjs";
+export * as pingPingGet from "./pingPingGet.mjs";

package/dist/esm/api/client/{metricsMetricsGet.d.mts → pingPingGet.d.mts}

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

package/dist/esm/api/client/{metricsMetricsGet.mjs → pingPingGet.mjs}

@@ -6,7 +6,7 @@ export const Error = {
             statusCode: undefined,
             content: fetcherError,
             _visit: function (visitor) {
-                return FernVenusApi.metricsMetricsGet.Error._visit(this, visitor);
+                return FernVenusApi.pingPingGet.Error._visit(this, visitor);
             },
         };
     },

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

@@ -11,6 +11,10 @@ export declare class ApiKeysClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
     constructor(options: ApiKeysClient.Options);
     /**
+     * Creates an API key for an organization the caller is a member of. 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.CreateApiKeyRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -33,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.
      *
@@ -44,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

@@ -29,6 +29,10 @@ export class ApiKeysClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Creates an API key for an organization the caller is a member of. 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.CreateApiKeyRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -189,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.
      *
@@ -264,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.
      *
@@ -278,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/guestSession/client/Client.d.mts

@@ -0,0 +1,84 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export declare namespace GuestSessionClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class GuestSessionClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<GuestSessionClient.Options>;
+    constructor(options: GuestSessionClient.Options);
+    /**
+     * Issue a guest session: a throwaway organization, a short-lived token bound to it, and
+     * the secret needed to claim it later.
+     * This endpoint is unauthenticated on purpose. It is the one way into Fern without a
+     * login, so every decision about what the session may do, how long it lasts and how many
+     * a caller may open is made here, on the server.
+     * The token and the claim secret are returned once and stored only as hashes.
+     *
+     * @param {FernVenusApi.CreateGuestSessionRequest} request
+     * @param {GuestSessionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guestSession.create({
+     *         fingerprint: "fingerprint"
+     *     })
+     */
+    create(request: FernVenusApi.CreateGuestSessionRequest, requestOptions?: GuestSessionClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.CreateGuestSessionResponse, FernVenusApi.guestSession.create.Error>>;
+    private __create;
+    /**
+     * 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.
+     *
+     * @param {FernVenusApi.GetGuestSessionsSessionIdGetRequest} request
+     * @param {GuestSessionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guestSession.get({
+     *         sessionId: "session_id"
+     *     })
+     */
+    get(request: FernVenusApi.GetGuestSessionsSessionIdGetRequest, requestOptions?: GuestSessionClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.GetGuestSessionResponse, FernVenusApi.guestSession.get.Error>>;
+    private __get;
+    /**
+     * 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.
+     *
+     * @param {FernVenusApi.DeleteGuestSessionsSessionIdDeleteRequest} request
+     * @param {GuestSessionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guestSession.delete({
+     *         sessionId: "session_id"
+     *     })
+     */
+    delete(request: FernVenusApi.DeleteGuestSessionsSessionIdDeleteRequest, requestOptions?: GuestSessionClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.DeleteGuestSessionResponse, FernVenusApi.guestSession.delete.Error>>;
+    private __delete;
+    /**
+     * 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.
+     *
+     * @param {FernVenusApi.ClaimGuestSessionRequest} request
+     * @param {GuestSessionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guestSession.claim({
+     *         sessionId: "session_id"
+     *     })
+     */
+    claim(request: FernVenusApi.ClaimGuestSessionRequest, requestOptions?: GuestSessionClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimGuestSessionResponse, FernVenusApi.guestSession.claim.Error>>;
+    private __claim;
+}