@fern-api/venus-api-sdk 11.1.1 → 11.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
46
- "X-Fern-SDK-Version": "11.1.1",
47
- "User-Agent": "@fern-api/venus-api-sdk/11.1.1",
46
+ "X-Fern-SDK-Version": "11.1.3",
47
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.3",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -48,6 +48,10 @@ export declare class FernVenusApiClient {
48
48
  * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
49
49
  * when no RDS engines are configured.
50
50
  *
51
+ * ``hosts_allowlisted`` is true only if every engine's host matches
52
+ * RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
53
+ * since nothing has then vouched for the hosts.
54
+ *
51
55
  * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
52
56
  *
53
57
  * @example
@@ -177,6 +177,10 @@ class FernVenusApiClient {
177
177
  * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
178
178
  * when no RDS engines are configured.
179
179
  *
180
+ * ``hosts_allowlisted`` is true only if every engine's host matches
181
+ * RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
182
+ * since nothing has then vouched for the hosts.
183
+ *
180
184
  * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
181
185
  *
182
186
  * @example
@@ -11,6 +11,10 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options: ApiKeysClient.Options);
13
13
  /**
14
+ * Creates an API key for an organization the caller is a member of. Called
15
+ * with the provisioner token, it only works for an unclaimed organization
16
+ * that was created with that token, and returns 403 for any other.
17
+ *
14
18
  * @param {FernVenusApi.CreateApiKeyRequest} request
15
19
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
16
20
  *
@@ -65,6 +65,10 @@ class ApiKeysClient {
65
65
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
66
66
  }
67
67
  /**
68
+ * Creates an API key for an organization the caller is a member of. Called
69
+ * with the provisioner token, it only works for an unclaimed organization
70
+ * that was created with that token, and returns 403 for any other.
71
+ *
68
72
  * @param {FernVenusApi.CreateApiKeyRequest} request
69
73
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
70
74
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.1";
1
+ export declare const SDK_VERSION = "11.1.3";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "11.1.1";
4
+ exports.SDK_VERSION = "11.1.3";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
9
- "X-Fern-SDK-Version": "11.1.1",
10
- "User-Agent": "@fern-api/venus-api-sdk/11.1.1",
9
+ "X-Fern-SDK-Version": "11.1.3",
10
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.3",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -48,6 +48,10 @@ export declare class FernVenusApiClient {
48
48
  * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
49
49
  * when no RDS engines are configured.
50
50
  *
51
+ * ``hosts_allowlisted`` is true only if every engine's host matches
52
+ * RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
53
+ * since nothing has then vouched for the hosts.
54
+ *
51
55
  * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
52
56
  *
53
57
  * @example
@@ -141,6 +141,10 @@ export class FernVenusApiClient {
141
141
  * 503 if any engine is unhealthy. Returns 200 with ``configured: false``
142
142
  * when no RDS engines are configured.
143
143
  *
144
+ * ``hosts_allowlisted`` is true only if every engine's host matches
145
+ * RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
146
+ * since nothing has then vouched for the hosts.
147
+ *
144
148
  * @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
145
149
  *
146
150
  * @example
@@ -11,6 +11,10 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options: ApiKeysClient.Options);
13
13
  /**
14
+ * Creates an API key for an organization the caller is a member of. Called
15
+ * with the provisioner token, it only works for an unclaimed organization
16
+ * that was created with that token, and returns 403 for any other.
17
+ *
14
18
  * @param {FernVenusApi.CreateApiKeyRequest} request
15
19
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
16
20
  *
@@ -29,6 +29,10 @@ export class ApiKeysClient {
29
29
  this._options = normalizeClientOptionsWithAuth(options);
30
30
  }
31
31
  /**
32
+ * Creates an API key for an organization the caller is a member of. Called
33
+ * with the provisioner token, it only works for an unclaimed organization
34
+ * that was created with that token, and returns 403 for any other.
35
+ *
32
36
  * @param {FernVenusApi.CreateApiKeyRequest} request
33
37
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
34
38
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.1";
1
+ export declare const SDK_VERSION = "11.1.3";
@@ -1 +1 @@
1
- export const SDK_VERSION = "11.1.1";
1
+ export const SDK_VERSION = "11.1.3";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fern-api/venus-api-sdk",
3
- "version": "11.1.1",
3
+ "version": "11.1.3",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -98,6 +98,10 @@ RDS smoke check: ping each configured RDS engine.
98
98
  Returns 200 only if every configured RDS engine answers ``SELECT 1``;
99
99
  503 if any engine is unhealthy. Returns 200 with ``configured: false``
100
100
  when no RDS engines are configured.
101
+
102
+ ``hosts_allowlisted`` is true only if every engine's host matches
103
+ RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
104
+ since nothing has then vouched for the hosts.
101
105
  </dd>
102
106
  </dl>
103
107
  </dd>
@@ -145,6 +149,22 @@ await client.healthRdsHealthRdsGet();
145
149
  <dl>
146
150
  <dd>
147
151
 
152
+ #### 📝 Description
153
+
154
+ <dl>
155
+ <dd>
156
+
157
+ <dl>
158
+ <dd>
159
+
160
+ Creates an API key for an organization the caller is a member of. Called
161
+ with the provisioner token, it only works for an unclaimed organization
162
+ that was created with that token, and returns 403 for any other.
163
+ </dd>
164
+ </dl>
165
+ </dd>
166
+ </dl>
167
+
148
168
  #### 🔌 Usage
149
169
 
150
170
  <dl>