@fern-api/venus-api-sdk 5.4.0 → 5.5.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": "5.4.0",
-        "User-Agent": "@fern-api/venus-api-sdk/5.4.0",
+        "X-Fern-SDK-Version": "5.5.0",
+        "User-Agent": "@fern-api/venus-api-sdk/5.5.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/Client.d.ts

@@ -44,12 +44,19 @@ export declare class FernVenusApiClient {
     healthHealthGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error>>;
     private __healthHealthGet;
     /**
-     * Post-flip smoke check: ping each configured RDS engine.
+     * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.pingPingGet()
+     */
+    pingPingGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.pingPingGet.Error>>;
+    private __pingPingGet;
+    /**
+     * RDS smoke check: ping each configured RDS engine.
      *
      * Returns 200 only if every configured RDS engine answers ``SELECT 1``;
      * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
-     * when venus is running Supabase-only (no RDS engines), so the check is
-     * safe to call before the cutover wires RDS in.
+     * when no RDS engines are configured.
      *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/Client.js

@@ -172,12 +172,58 @@ class FernVenusApiClient {
         });
     }
     /**
-     * Post-flip smoke check: ping each configured RDS engine.
+     * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.pingPingGet()
+     */
+    pingPingGet(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingPingGet(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 = (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)), "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,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: _response.body,
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.pingPingGet.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * RDS smoke check: ping each configured RDS engine.
      *
      * Returns 200 only if every configured RDS engine answers ``SELECT 1``;
      * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
-     * when venus is running Supabase-only (no RDS engines), so the check is
-     * safe to call before the cutover wires RDS in.
+     * when no RDS engines are configured.
      *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/client/index.d.ts

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

package/dist/cjs/api/client/index.js

@@ -33,7 +33,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.metricsMetricsGet = exports.healthRdsHealthRdsGet = exports.healthHealthGet = void 0;
+exports.pingPingGet = exports.metricsMetricsGet = exports.healthRdsHealthRdsGet = exports.healthHealthGet = void 0;
 exports.healthHealthGet = __importStar(require("./healthHealthGet.js"));
 exports.healthRdsHealthRdsGet = __importStar(require("./healthRdsHealthRdsGet.js"));
 exports.metricsMetricsGet = __importStar(require("./metricsMetricsGet.js"));
+exports.pingPingGet = __importStar(require("./pingPingGet.js"));

package/dist/cjs/api/client/pingPingGet.d.ts

@@ -0,0 +1,19 @@
+import type * as core from "../../core/index.js";
+import * as FernVenusApi from "../index.js";
+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.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.pingPingGet.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.pingPingGet.Error, visitor: FernVenusApi.pingPingGet.Error._Visitor<_Result>) => _Result;
+};

package/dist/cjs/api/client/pingPingGet.js

@@ -0,0 +1,55 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const FernVenusApi = __importStar(require("../index.js"));
+exports.Error = {
+    _unknown: (fetcherError) => {
+        return {
+            statusCode: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.pingPingGet.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.statusCode) {
+            default:
+                return visitor._other(value.content);
+        }
+    },
+};

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "5.4.0";
+export declare const SDK_VERSION = "5.5.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 = "5.4.0";
+exports.SDK_VERSION = "5.5.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": "5.4.0",
-        "User-Agent": "@fern-api/venus-api-sdk/5.4.0",
+        "X-Fern-SDK-Version": "5.5.0",
+        "User-Agent": "@fern-api/venus-api-sdk/5.5.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/Client.d.mts

@@ -44,12 +44,19 @@ export declare class FernVenusApiClient {
     healthHealthGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error>>;
     private __healthHealthGet;
     /**
-     * Post-flip smoke check: ping each configured RDS engine.
+     * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.pingPingGet()
+     */
+    pingPingGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.pingPingGet.Error>>;
+    private __pingPingGet;
+    /**
+     * RDS smoke check: ping each configured RDS engine.
      *
      * Returns 200 only if every configured RDS engine answers ``SELECT 1``;
      * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
-     * when venus is running Supabase-only (no RDS engines), so the check is
-     * safe to call before the cutover wires RDS in.
+     * when no RDS engines are configured.
      *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/Client.mjs

@@ -136,12 +136,58 @@ export class FernVenusApiClient {
         });
     }
     /**
-     * Post-flip smoke check: ping each configured RDS engine.
+     * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.pingPingGet()
+     */
+    pingPingGet(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingPingGet(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)), "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,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: _response.body,
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.pingPingGet.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * RDS smoke check: ping each configured RDS engine.
      *
      * Returns 200 only if every configured RDS engine answers ``SELECT 1``;
      * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
-     * when venus is running Supabase-only (no RDS engines), so the check is
-     * safe to call before the cutover wires RDS in.
+     * when no RDS engines are configured.
      *
      * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -1,3 +1,4 @@
 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,4 @@
 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/pingPingGet.d.mts

@@ -0,0 +1,19 @@
+import type * as core from "../../core/index.mjs";
+import * as FernVenusApi from "../index.mjs";
+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.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.pingPingGet.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.pingPingGet.Error, visitor: FernVenusApi.pingPingGet.Error._Visitor<_Result>) => _Result;
+};

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

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

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "5.4.0";
+export declare const SDK_VERSION = "5.5.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "5.4.0";
+export const SDK_VERSION = "5.5.0";

package/package.json

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

package/reference.md

@@ -91,6 +91,47 @@ await client.healthHealthGet();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.<a href="/src/Client.ts">pingPingGet</a>() -> core.APIResponse&lt;string, FernVenusApi.pingPingGet.Error&gt;</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pingPingGet();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `FernVenusApiClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -107,12 +148,11 @@ await client.healthHealthGet();
 <dl>
 <dd>
 
-Post-flip smoke check: ping each configured RDS engine.
+RDS smoke check: ping each configured RDS engine.
 
 Returns 200 only if every configured RDS engine answers ``SELECT 1``;
 503 if any engine is unhealthy. Returns 200 with ``configured: false``
-when venus is running Supabase-only (no RDS engines), so the check is
-safe to call before the cutover wires RDS in.
+when no RDS engines are configured.
 </dd>
 </dl>
 </dd>