@fern-api/venus-api-sdk 7.0.0 → 9.0.0
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +8 -6
- package/dist/cjs/Client.js +14 -13
- package/dist/cjs/api/client/index.d.ts +1 -1
- package/dist/cjs/api/client/index.js +2 -2
- package/dist/cjs/api/client/{pingPingGet.d.ts → metricsMetricsGet.d.ts} +4 -4
- package/dist/cjs/api/client/{pingPingGet.js → metricsMetricsGet.js} +1 -1
- package/dist/cjs/api/resources/organization/client/requests/UpdateOrganizationRequest.d.ts +0 -5
- package/dist/cjs/api/types/Organization.d.ts +0 -5
- package/dist/cjs/serialization/resources/organization/client/requests/UpdateOrganizationRequest.d.ts +0 -5
- package/dist/cjs/serialization/resources/organization/client/requests/UpdateOrganizationRequest.js +0 -5
- package/dist/cjs/serialization/types/Organization.d.ts +0 -5
- package/dist/cjs/serialization/types/Organization.js +0 -5
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +8 -6
- package/dist/esm/Client.mjs +14 -13
- package/dist/esm/api/client/index.d.mts +1 -1
- package/dist/esm/api/client/index.mjs +1 -1
- package/dist/esm/api/client/{pingPingGet.d.mts → metricsMetricsGet.d.mts} +4 -4
- package/dist/esm/api/client/{pingPingGet.mjs → metricsMetricsGet.mjs} +1 -1
- package/dist/esm/api/resources/organization/client/requests/UpdateOrganizationRequest.d.mts +0 -5
- package/dist/esm/api/types/Organization.d.mts +0 -5
- package/dist/esm/serialization/resources/organization/client/requests/UpdateOrganizationRequest.d.mts +0 -5
- package/dist/esm/serialization/resources/organization/client/requests/UpdateOrganizationRequest.mjs +0 -5
- package/dist/esm/serialization/types/Organization.d.mts +0 -5
- package/dist/esm/serialization/types/Organization.mjs +0 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +18 -4
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -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": "
|
|
47
|
-
"User-Agent": "@fern-api/venus-api-sdk/
|
|
46
|
+
"X-Fern-SDK-Version": "9.0.0",
|
|
47
|
+
"User-Agent": "@fern-api/venus-api-sdk/9.0.0",
|
|
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);
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -26,21 +26,23 @@ export declare class FernVenusApiClient {
|
|
|
26
26
|
get registry(): RegistryClient;
|
|
27
27
|
get user(): UserClient;
|
|
28
28
|
/**
|
|
29
|
+
* Endpoint that serves Prometheus metrics.
|
|
30
|
+
*
|
|
29
31
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
30
32
|
*
|
|
31
33
|
* @example
|
|
32
|
-
* await client.
|
|
34
|
+
* await client.metricsMetricsGet()
|
|
33
35
|
*/
|
|
34
|
-
|
|
35
|
-
private
|
|
36
|
+
metricsMetricsGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.metricsMetricsGet.Error>>;
|
|
37
|
+
private __metricsMetricsGet;
|
|
36
38
|
/**
|
|
37
39
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
40
|
*
|
|
39
41
|
* @example
|
|
40
|
-
* await client.
|
|
42
|
+
* await client.healthHealthGet()
|
|
41
43
|
*/
|
|
42
|
-
|
|
43
|
-
private
|
|
44
|
+
healthHealthGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error>>;
|
|
45
|
+
private __healthHealthGet;
|
|
44
46
|
/**
|
|
45
47
|
* RDS smoke check: ping each configured RDS engine.
|
|
46
48
|
*
|
package/dist/cjs/Client.js
CHANGED
|
@@ -78,21 +78,23 @@ class FernVenusApiClient {
|
|
|
78
78
|
return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_js_5.UserClient(this._options)));
|
|
79
79
|
}
|
|
80
80
|
/**
|
|
81
|
+
* Endpoint that serves Prometheus metrics.
|
|
82
|
+
*
|
|
81
83
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
82
84
|
*
|
|
83
85
|
* @example
|
|
84
|
-
* await client.
|
|
86
|
+
* await client.metricsMetricsGet()
|
|
85
87
|
*/
|
|
86
|
-
|
|
87
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
88
|
+
metricsMetricsGet(requestOptions) {
|
|
89
|
+
return core.HttpResponsePromise.fromPromise(this.__metricsMetricsGet(requestOptions));
|
|
88
90
|
}
|
|
89
|
-
|
|
91
|
+
__metricsMetricsGet(requestOptions) {
|
|
90
92
|
return __awaiter(this, void 0, void 0, function* () {
|
|
91
93
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
92
94
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
93
95
|
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);
|
|
94
96
|
const _response = yield core.fetcher({
|
|
95
|
-
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "
|
|
97
|
+
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"),
|
|
96
98
|
method: "GET",
|
|
97
99
|
headers: _headers,
|
|
98
100
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -116,7 +118,7 @@ class FernVenusApiClient {
|
|
|
116
118
|
return {
|
|
117
119
|
data: {
|
|
118
120
|
ok: false,
|
|
119
|
-
error: FernVenusApi.
|
|
121
|
+
error: FernVenusApi.metricsMetricsGet.Error._unknown(_response.error),
|
|
120
122
|
rawResponse: _response.rawResponse,
|
|
121
123
|
},
|
|
122
124
|
rawResponse: _response.rawResponse,
|
|
@@ -127,22 +129,21 @@ class FernVenusApiClient {
|
|
|
127
129
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
128
130
|
*
|
|
129
131
|
* @example
|
|
130
|
-
* await client.
|
|
132
|
+
* await client.healthHealthGet()
|
|
131
133
|
*/
|
|
132
|
-
|
|
133
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
134
|
+
healthHealthGet(requestOptions) {
|
|
135
|
+
return core.HttpResponsePromise.fromPromise(this.__healthHealthGet(requestOptions));
|
|
134
136
|
}
|
|
135
|
-
|
|
137
|
+
__healthHealthGet(requestOptions) {
|
|
136
138
|
return __awaiter(this, void 0, void 0, function* () {
|
|
137
139
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
138
140
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
139
141
|
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);
|
|
140
142
|
const _response = yield core.fetcher({
|
|
141
|
-
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "
|
|
143
|
+
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"),
|
|
142
144
|
method: "GET",
|
|
143
145
|
headers: _headers,
|
|
144
146
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
145
|
-
responseType: "text",
|
|
146
147
|
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,
|
|
147
148
|
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,
|
|
148
149
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -163,7 +164,7 @@ class FernVenusApiClient {
|
|
|
163
164
|
return {
|
|
164
165
|
data: {
|
|
165
166
|
ok: false,
|
|
166
|
-
error: FernVenusApi.
|
|
167
|
+
error: FernVenusApi.healthHealthGet.Error._unknown(_response.error),
|
|
167
168
|
rawResponse: _response.rawResponse,
|
|
168
169
|
},
|
|
169
170
|
rawResponse: _response.rawResponse,
|
|
@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
36
|
+
exports.metricsMetricsGet = exports.healthRdsHealthRdsGet = exports.healthHealthGet = void 0;
|
|
37
37
|
exports.healthHealthGet = __importStar(require("./healthHealthGet.js"));
|
|
38
38
|
exports.healthRdsHealthRdsGet = __importStar(require("./healthRdsHealthRdsGet.js"));
|
|
39
|
-
exports.
|
|
39
|
+
exports.metricsMetricsGet = __importStar(require("./metricsMetricsGet.js"));
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import type * as core from "../../core/index.js";
|
|
2
2
|
import * as FernVenusApi from "../index.js";
|
|
3
|
-
export type Error = FernVenusApi.
|
|
3
|
+
export type Error = FernVenusApi.metricsMetricsGet.Error._Unknown;
|
|
4
4
|
export declare namespace Error {
|
|
5
5
|
interface _Unknown extends _Utils {
|
|
6
6
|
statusCode: void;
|
|
7
7
|
content: core.Fetcher.Error;
|
|
8
8
|
}
|
|
9
9
|
interface _Utils {
|
|
10
|
-
_visit: <_Result>(visitor: FernVenusApi.
|
|
10
|
+
_visit: <_Result>(visitor: FernVenusApi.metricsMetricsGet.Error._Visitor<_Result>) => _Result;
|
|
11
11
|
}
|
|
12
12
|
interface _Visitor<_Result> {
|
|
13
13
|
_other: (value: core.Fetcher.Error) => _Result;
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
export declare const Error: {
|
|
17
|
-
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.
|
|
18
|
-
readonly _visit: <_Result>(value: FernVenusApi.
|
|
17
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.metricsMetricsGet.Error._Unknown;
|
|
18
|
+
readonly _visit: <_Result>(value: FernVenusApi.metricsMetricsGet.Error, visitor: FernVenusApi.metricsMetricsGet.Error._Visitor<_Result>) => _Result;
|
|
19
19
|
};
|
|
@@ -10,16 +10,11 @@ export interface UpdateOrganizationRequest {
|
|
|
10
10
|
logoUrl?: string | null;
|
|
11
11
|
artifactReadRequiresToken?: boolean | null;
|
|
12
12
|
isWhitelabeled?: boolean | null;
|
|
13
|
-
previewEnabled?: boolean | null;
|
|
14
|
-
snippetsEnabled?: boolean | null;
|
|
15
13
|
snippetUnitTestsEnabled?: boolean | null;
|
|
16
14
|
snippetsApiAccessEnabled?: boolean | null;
|
|
17
15
|
snippetTemplatesAccessEnabled?: boolean | null;
|
|
18
16
|
paginationEnabled?: boolean | null;
|
|
19
|
-
changeLogEnabled?: boolean | null;
|
|
20
|
-
isFernbotCanary?: boolean | null;
|
|
21
17
|
oauthClientEnabled?: boolean | null;
|
|
22
|
-
apiPlaygroundEnabled?: boolean | null;
|
|
23
18
|
workosOrganizationId?: string | null;
|
|
24
19
|
selfHostedSdKs?: boolean | null;
|
|
25
20
|
postmanTeamId?: string | null;
|
|
@@ -6,16 +6,11 @@ export interface Organization {
|
|
|
6
6
|
artifactReadRequiresToken: boolean;
|
|
7
7
|
users: FernVenusApi.LightweightUser[];
|
|
8
8
|
isWhitelabled: boolean;
|
|
9
|
-
previewEnabled: boolean;
|
|
10
|
-
snippetsEnabled: boolean;
|
|
11
9
|
snippetUnitTestsEnabled: boolean;
|
|
12
10
|
snippetsApiAccessEnabled: boolean;
|
|
13
11
|
snippetTemplatesAccessEnabled: boolean;
|
|
14
12
|
paginationEnabled: boolean;
|
|
15
|
-
changeLogEnabled: boolean;
|
|
16
|
-
isFernbotCanary: boolean;
|
|
17
13
|
oauthClientEnabled: boolean;
|
|
18
|
-
apiPlaygroundEnabled: boolean;
|
|
19
14
|
workosOrganizationId?: string | null;
|
|
20
15
|
selfHostedSdKs: boolean;
|
|
21
16
|
postmanTeamId?: string | null;
|
package/dist/cjs/serialization/resources/organization/client/requests/UpdateOrganizationRequest.d.ts
CHANGED
|
@@ -8,16 +8,11 @@ export declare namespace UpdateOrganizationRequest {
|
|
|
8
8
|
logoUrl?: (string | null | undefined) | null;
|
|
9
9
|
artifactReadRequiresToken?: (boolean | null | undefined) | null;
|
|
10
10
|
isWhitelabeled?: (boolean | null | undefined) | null;
|
|
11
|
-
previewEnabled?: (boolean | null | undefined) | null;
|
|
12
|
-
snippetsEnabled?: (boolean | null | undefined) | null;
|
|
13
11
|
snippetUnitTestsEnabled?: (boolean | null | undefined) | null;
|
|
14
12
|
snippetsApiAccessEnabled?: (boolean | null | undefined) | null;
|
|
15
13
|
snippetTemplatesAccessEnabled?: (boolean | null | undefined) | null;
|
|
16
14
|
paginationEnabled?: (boolean | null | undefined) | null;
|
|
17
|
-
changeLogEnabled?: (boolean | null | undefined) | null;
|
|
18
|
-
isFernbotCanary?: (boolean | null | undefined) | null;
|
|
19
15
|
oauthClientEnabled?: (boolean | null | undefined) | null;
|
|
20
|
-
apiPlaygroundEnabled?: (boolean | null | undefined) | null;
|
|
21
16
|
workosOrganizationId?: (string | null | undefined) | null;
|
|
22
17
|
selfHostedSDKs?: (boolean | null | undefined) | null;
|
|
23
18
|
postmanTeamId?: (string | null | undefined) | null;
|
package/dist/cjs/serialization/resources/organization/client/requests/UpdateOrganizationRequest.js
CHANGED
|
@@ -41,16 +41,11 @@ exports.UpdateOrganizationRequest = core.serialization.object({
|
|
|
41
41
|
logoUrl: core.serialization.string().optionalNullable(),
|
|
42
42
|
artifactReadRequiresToken: core.serialization.boolean().optionalNullable(),
|
|
43
43
|
isWhitelabeled: core.serialization.boolean().optionalNullable(),
|
|
44
|
-
previewEnabled: core.serialization.boolean().optionalNullable(),
|
|
45
|
-
snippetsEnabled: core.serialization.boolean().optionalNullable(),
|
|
46
44
|
snippetUnitTestsEnabled: core.serialization.boolean().optionalNullable(),
|
|
47
45
|
snippetsApiAccessEnabled: core.serialization.boolean().optionalNullable(),
|
|
48
46
|
snippetTemplatesAccessEnabled: core.serialization.boolean().optionalNullable(),
|
|
49
47
|
paginationEnabled: core.serialization.boolean().optionalNullable(),
|
|
50
|
-
changeLogEnabled: core.serialization.boolean().optionalNullable(),
|
|
51
|
-
isFernbotCanary: core.serialization.boolean().optionalNullable(),
|
|
52
48
|
oauthClientEnabled: core.serialization.boolean().optionalNullable(),
|
|
53
|
-
apiPlaygroundEnabled: core.serialization.boolean().optionalNullable(),
|
|
54
49
|
workosOrganizationId: core.serialization.string().optionalNullable(),
|
|
55
50
|
selfHostedSdKs: core.serialization.property("selfHostedSDKs", core.serialization.boolean().optionalNullable()),
|
|
56
51
|
postmanTeamId: core.serialization.string().optionalNullable(),
|
|
@@ -11,16 +11,11 @@ export declare namespace Organization {
|
|
|
11
11
|
artifactReadRequiresToken: boolean;
|
|
12
12
|
users: LightweightUser.Raw[];
|
|
13
13
|
isWhitelabled: boolean;
|
|
14
|
-
previewEnabled: boolean;
|
|
15
|
-
snippetsEnabled: boolean;
|
|
16
14
|
snippetUnitTestsEnabled: boolean;
|
|
17
15
|
snippetsApiAccessEnabled: boolean;
|
|
18
16
|
snippetTemplatesAccessEnabled: boolean;
|
|
19
17
|
paginationEnabled: boolean;
|
|
20
|
-
changeLogEnabled: boolean;
|
|
21
|
-
isFernbotCanary: boolean;
|
|
22
18
|
oauthClientEnabled: boolean;
|
|
23
|
-
apiPlaygroundEnabled: boolean;
|
|
24
19
|
workosOrganizationId?: (string | null | undefined) | null;
|
|
25
20
|
selfHostedSDKs: boolean;
|
|
26
21
|
postmanTeamId?: (string | null | undefined) | null;
|
|
@@ -44,16 +44,11 @@ exports.Organization = core.serialization.object({
|
|
|
44
44
|
artifactReadRequiresToken: core.serialization.boolean(),
|
|
45
45
|
users: core.serialization.list(LightweightUser_js_1.LightweightUser),
|
|
46
46
|
isWhitelabled: core.serialization.boolean(),
|
|
47
|
-
previewEnabled: core.serialization.boolean(),
|
|
48
|
-
snippetsEnabled: core.serialization.boolean(),
|
|
49
47
|
snippetUnitTestsEnabled: core.serialization.boolean(),
|
|
50
48
|
snippetsApiAccessEnabled: core.serialization.boolean(),
|
|
51
49
|
snippetTemplatesAccessEnabled: core.serialization.boolean(),
|
|
52
50
|
paginationEnabled: core.serialization.boolean(),
|
|
53
|
-
changeLogEnabled: core.serialization.boolean(),
|
|
54
|
-
isFernbotCanary: core.serialization.boolean(),
|
|
55
51
|
oauthClientEnabled: core.serialization.boolean(),
|
|
56
|
-
apiPlaygroundEnabled: core.serialization.boolean(),
|
|
57
52
|
workosOrganizationId: core.serialization.string().optionalNullable(),
|
|
58
53
|
selfHostedSdKs: core.serialization.property("selfHostedSDKs", core.serialization.boolean()),
|
|
59
54
|
postmanTeamId: core.serialization.string().optionalNullable(),
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "9.0.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -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": "
|
|
10
|
-
"User-Agent": "@fern-api/venus-api-sdk/
|
|
9
|
+
"X-Fern-SDK-Version": "9.0.0",
|
|
10
|
+
"User-Agent": "@fern-api/venus-api-sdk/9.0.0",
|
|
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);
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -26,21 +26,23 @@ export declare class FernVenusApiClient {
|
|
|
26
26
|
get registry(): RegistryClient;
|
|
27
27
|
get user(): UserClient;
|
|
28
28
|
/**
|
|
29
|
+
* Endpoint that serves Prometheus metrics.
|
|
30
|
+
*
|
|
29
31
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
30
32
|
*
|
|
31
33
|
* @example
|
|
32
|
-
* await client.
|
|
34
|
+
* await client.metricsMetricsGet()
|
|
33
35
|
*/
|
|
34
|
-
|
|
35
|
-
private
|
|
36
|
+
metricsMetricsGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.metricsMetricsGet.Error>>;
|
|
37
|
+
private __metricsMetricsGet;
|
|
36
38
|
/**
|
|
37
39
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
40
|
*
|
|
39
41
|
* @example
|
|
40
|
-
* await client.
|
|
42
|
+
* await client.healthHealthGet()
|
|
41
43
|
*/
|
|
42
|
-
|
|
43
|
-
private
|
|
44
|
+
healthHealthGet(requestOptions?: FernVenusApiClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error>>;
|
|
45
|
+
private __healthHealthGet;
|
|
44
46
|
/**
|
|
45
47
|
* RDS smoke check: ping each configured RDS engine.
|
|
46
48
|
*
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -42,21 +42,23 @@ export class FernVenusApiClient {
|
|
|
42
42
|
return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new UserClient(this._options)));
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
+
* Endpoint that serves Prometheus metrics.
|
|
46
|
+
*
|
|
45
47
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
48
|
*
|
|
47
49
|
* @example
|
|
48
|
-
* await client.
|
|
50
|
+
* await client.metricsMetricsGet()
|
|
49
51
|
*/
|
|
50
|
-
|
|
51
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
52
|
+
metricsMetricsGet(requestOptions) {
|
|
53
|
+
return core.HttpResponsePromise.fromPromise(this.__metricsMetricsGet(requestOptions));
|
|
52
54
|
}
|
|
53
|
-
|
|
55
|
+
__metricsMetricsGet(requestOptions) {
|
|
54
56
|
return __awaiter(this, void 0, void 0, function* () {
|
|
55
57
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
56
58
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
57
59
|
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);
|
|
58
60
|
const _response = yield core.fetcher({
|
|
59
|
-
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "
|
|
61
|
+
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"),
|
|
60
62
|
method: "GET",
|
|
61
63
|
headers: _headers,
|
|
62
64
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -80,7 +82,7 @@ export class FernVenusApiClient {
|
|
|
80
82
|
return {
|
|
81
83
|
data: {
|
|
82
84
|
ok: false,
|
|
83
|
-
error: FernVenusApi.
|
|
85
|
+
error: FernVenusApi.metricsMetricsGet.Error._unknown(_response.error),
|
|
84
86
|
rawResponse: _response.rawResponse,
|
|
85
87
|
},
|
|
86
88
|
rawResponse: _response.rawResponse,
|
|
@@ -91,22 +93,21 @@ export class FernVenusApiClient {
|
|
|
91
93
|
* @param {FernVenusApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
92
94
|
*
|
|
93
95
|
* @example
|
|
94
|
-
* await client.
|
|
96
|
+
* await client.healthHealthGet()
|
|
95
97
|
*/
|
|
96
|
-
|
|
97
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
98
|
+
healthHealthGet(requestOptions) {
|
|
99
|
+
return core.HttpResponsePromise.fromPromise(this.__healthHealthGet(requestOptions));
|
|
98
100
|
}
|
|
99
|
-
|
|
101
|
+
__healthHealthGet(requestOptions) {
|
|
100
102
|
return __awaiter(this, void 0, void 0, function* () {
|
|
101
103
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
102
104
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
103
105
|
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);
|
|
104
106
|
const _response = yield core.fetcher({
|
|
105
|
-
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), "
|
|
107
|
+
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"),
|
|
106
108
|
method: "GET",
|
|
107
109
|
headers: _headers,
|
|
108
110
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
109
|
-
responseType: "text",
|
|
110
111
|
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,
|
|
111
112
|
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,
|
|
112
113
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -127,7 +128,7 @@ export class FernVenusApiClient {
|
|
|
127
128
|
return {
|
|
128
129
|
data: {
|
|
129
130
|
ok: false,
|
|
130
|
-
error: FernVenusApi.
|
|
131
|
+
error: FernVenusApi.healthHealthGet.Error._unknown(_response.error),
|
|
131
132
|
rawResponse: _response.rawResponse,
|
|
132
133
|
},
|
|
133
134
|
rawResponse: _response.rawResponse,
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import type * as core from "../../core/index.mjs";
|
|
2
2
|
import * as FernVenusApi from "../index.mjs";
|
|
3
|
-
export type Error = FernVenusApi.
|
|
3
|
+
export type Error = FernVenusApi.metricsMetricsGet.Error._Unknown;
|
|
4
4
|
export declare namespace Error {
|
|
5
5
|
interface _Unknown extends _Utils {
|
|
6
6
|
statusCode: void;
|
|
7
7
|
content: core.Fetcher.Error;
|
|
8
8
|
}
|
|
9
9
|
interface _Utils {
|
|
10
|
-
_visit: <_Result>(visitor: FernVenusApi.
|
|
10
|
+
_visit: <_Result>(visitor: FernVenusApi.metricsMetricsGet.Error._Visitor<_Result>) => _Result;
|
|
11
11
|
}
|
|
12
12
|
interface _Visitor<_Result> {
|
|
13
13
|
_other: (value: core.Fetcher.Error) => _Result;
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
export declare const Error: {
|
|
17
|
-
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.
|
|
18
|
-
readonly _visit: <_Result>(value: FernVenusApi.
|
|
17
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.metricsMetricsGet.Error._Unknown;
|
|
18
|
+
readonly _visit: <_Result>(value: FernVenusApi.metricsMetricsGet.Error, visitor: FernVenusApi.metricsMetricsGet.Error._Visitor<_Result>) => _Result;
|
|
19
19
|
};
|
|
@@ -10,16 +10,11 @@ export interface UpdateOrganizationRequest {
|
|
|
10
10
|
logoUrl?: string | null;
|
|
11
11
|
artifactReadRequiresToken?: boolean | null;
|
|
12
12
|
isWhitelabeled?: boolean | null;
|
|
13
|
-
previewEnabled?: boolean | null;
|
|
14
|
-
snippetsEnabled?: boolean | null;
|
|
15
13
|
snippetUnitTestsEnabled?: boolean | null;
|
|
16
14
|
snippetsApiAccessEnabled?: boolean | null;
|
|
17
15
|
snippetTemplatesAccessEnabled?: boolean | null;
|
|
18
16
|
paginationEnabled?: boolean | null;
|
|
19
|
-
changeLogEnabled?: boolean | null;
|
|
20
|
-
isFernbotCanary?: boolean | null;
|
|
21
17
|
oauthClientEnabled?: boolean | null;
|
|
22
|
-
apiPlaygroundEnabled?: boolean | null;
|
|
23
18
|
workosOrganizationId?: string | null;
|
|
24
19
|
selfHostedSdKs?: boolean | null;
|
|
25
20
|
postmanTeamId?: string | null;
|
|
@@ -6,16 +6,11 @@ export interface Organization {
|
|
|
6
6
|
artifactReadRequiresToken: boolean;
|
|
7
7
|
users: FernVenusApi.LightweightUser[];
|
|
8
8
|
isWhitelabled: boolean;
|
|
9
|
-
previewEnabled: boolean;
|
|
10
|
-
snippetsEnabled: boolean;
|
|
11
9
|
snippetUnitTestsEnabled: boolean;
|
|
12
10
|
snippetsApiAccessEnabled: boolean;
|
|
13
11
|
snippetTemplatesAccessEnabled: boolean;
|
|
14
12
|
paginationEnabled: boolean;
|
|
15
|
-
changeLogEnabled: boolean;
|
|
16
|
-
isFernbotCanary: boolean;
|
|
17
13
|
oauthClientEnabled: boolean;
|
|
18
|
-
apiPlaygroundEnabled: boolean;
|
|
19
14
|
workosOrganizationId?: string | null;
|
|
20
15
|
selfHostedSdKs: boolean;
|
|
21
16
|
postmanTeamId?: string | null;
|
|
@@ -8,16 +8,11 @@ export declare namespace UpdateOrganizationRequest {
|
|
|
8
8
|
logoUrl?: (string | null | undefined) | null;
|
|
9
9
|
artifactReadRequiresToken?: (boolean | null | undefined) | null;
|
|
10
10
|
isWhitelabeled?: (boolean | null | undefined) | null;
|
|
11
|
-
previewEnabled?: (boolean | null | undefined) | null;
|
|
12
|
-
snippetsEnabled?: (boolean | null | undefined) | null;
|
|
13
11
|
snippetUnitTestsEnabled?: (boolean | null | undefined) | null;
|
|
14
12
|
snippetsApiAccessEnabled?: (boolean | null | undefined) | null;
|
|
15
13
|
snippetTemplatesAccessEnabled?: (boolean | null | undefined) | null;
|
|
16
14
|
paginationEnabled?: (boolean | null | undefined) | null;
|
|
17
|
-
changeLogEnabled?: (boolean | null | undefined) | null;
|
|
18
|
-
isFernbotCanary?: (boolean | null | undefined) | null;
|
|
19
15
|
oauthClientEnabled?: (boolean | null | undefined) | null;
|
|
20
|
-
apiPlaygroundEnabled?: (boolean | null | undefined) | null;
|
|
21
16
|
workosOrganizationId?: (string | null | undefined) | null;
|
|
22
17
|
selfHostedSDKs?: (boolean | null | undefined) | null;
|
|
23
18
|
postmanTeamId?: (string | null | undefined) | null;
|
package/dist/esm/serialization/resources/organization/client/requests/UpdateOrganizationRequest.mjs
CHANGED
|
@@ -5,16 +5,11 @@ export const UpdateOrganizationRequest = core.serialization.object({
|
|
|
5
5
|
logoUrl: core.serialization.string().optionalNullable(),
|
|
6
6
|
artifactReadRequiresToken: core.serialization.boolean().optionalNullable(),
|
|
7
7
|
isWhitelabeled: core.serialization.boolean().optionalNullable(),
|
|
8
|
-
previewEnabled: core.serialization.boolean().optionalNullable(),
|
|
9
|
-
snippetsEnabled: core.serialization.boolean().optionalNullable(),
|
|
10
8
|
snippetUnitTestsEnabled: core.serialization.boolean().optionalNullable(),
|
|
11
9
|
snippetsApiAccessEnabled: core.serialization.boolean().optionalNullable(),
|
|
12
10
|
snippetTemplatesAccessEnabled: core.serialization.boolean().optionalNullable(),
|
|
13
11
|
paginationEnabled: core.serialization.boolean().optionalNullable(),
|
|
14
|
-
changeLogEnabled: core.serialization.boolean().optionalNullable(),
|
|
15
|
-
isFernbotCanary: core.serialization.boolean().optionalNullable(),
|
|
16
12
|
oauthClientEnabled: core.serialization.boolean().optionalNullable(),
|
|
17
|
-
apiPlaygroundEnabled: core.serialization.boolean().optionalNullable(),
|
|
18
13
|
workosOrganizationId: core.serialization.string().optionalNullable(),
|
|
19
14
|
selfHostedSdKs: core.serialization.property("selfHostedSDKs", core.serialization.boolean().optionalNullable()),
|
|
20
15
|
postmanTeamId: core.serialization.string().optionalNullable(),
|
|
@@ -11,16 +11,11 @@ export declare namespace Organization {
|
|
|
11
11
|
artifactReadRequiresToken: boolean;
|
|
12
12
|
users: LightweightUser.Raw[];
|
|
13
13
|
isWhitelabled: boolean;
|
|
14
|
-
previewEnabled: boolean;
|
|
15
|
-
snippetsEnabled: boolean;
|
|
16
14
|
snippetUnitTestsEnabled: boolean;
|
|
17
15
|
snippetsApiAccessEnabled: boolean;
|
|
18
16
|
snippetTemplatesAccessEnabled: boolean;
|
|
19
17
|
paginationEnabled: boolean;
|
|
20
|
-
changeLogEnabled: boolean;
|
|
21
|
-
isFernbotCanary: boolean;
|
|
22
18
|
oauthClientEnabled: boolean;
|
|
23
|
-
apiPlaygroundEnabled: boolean;
|
|
24
19
|
workosOrganizationId?: (string | null | undefined) | null;
|
|
25
20
|
selfHostedSDKs: boolean;
|
|
26
21
|
postmanTeamId?: (string | null | undefined) | null;
|
|
@@ -8,16 +8,11 @@ export const Organization = core.serialization.object({
|
|
|
8
8
|
artifactReadRequiresToken: core.serialization.boolean(),
|
|
9
9
|
users: core.serialization.list(LightweightUser),
|
|
10
10
|
isWhitelabled: core.serialization.boolean(),
|
|
11
|
-
previewEnabled: core.serialization.boolean(),
|
|
12
|
-
snippetsEnabled: core.serialization.boolean(),
|
|
13
11
|
snippetUnitTestsEnabled: core.serialization.boolean(),
|
|
14
12
|
snippetsApiAccessEnabled: core.serialization.boolean(),
|
|
15
13
|
snippetTemplatesAccessEnabled: core.serialization.boolean(),
|
|
16
14
|
paginationEnabled: core.serialization.boolean(),
|
|
17
|
-
changeLogEnabled: core.serialization.boolean(),
|
|
18
|
-
isFernbotCanary: core.serialization.boolean(),
|
|
19
15
|
oauthClientEnabled: core.serialization.boolean(),
|
|
20
|
-
apiPlaygroundEnabled: core.serialization.boolean(),
|
|
21
16
|
workosOrganizationId: core.serialization.string().optionalNullable(),
|
|
22
17
|
selfHostedSdKs: core.serialization.property("selfHostedSDKs", core.serialization.boolean()),
|
|
23
18
|
postmanTeamId: core.serialization.string().optionalNullable(),
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "9.0.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "
|
|
1
|
+
export const SDK_VERSION = "9.0.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1,8 +1,22 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
<details><summary><code>client.<a href="/src/Client.ts">
|
|
2
|
+
<details><summary><code>client.<a href="/src/Client.ts">metricsMetricsGet</a>() -> core.APIResponse<unknown, FernVenusApi.metricsMetricsGet.Error></code></summary>
|
|
3
|
+
<dl>
|
|
4
|
+
<dd>
|
|
5
|
+
|
|
6
|
+
#### 📝 Description
|
|
7
|
+
|
|
8
|
+
<dl>
|
|
9
|
+
<dd>
|
|
10
|
+
|
|
3
11
|
<dl>
|
|
4
12
|
<dd>
|
|
5
13
|
|
|
14
|
+
Endpoint that serves Prometheus metrics.
|
|
15
|
+
</dd>
|
|
16
|
+
</dl>
|
|
17
|
+
</dd>
|
|
18
|
+
</dl>
|
|
19
|
+
|
|
6
20
|
#### 🔌 Usage
|
|
7
21
|
|
|
8
22
|
<dl>
|
|
@@ -12,7 +26,7 @@
|
|
|
12
26
|
<dd>
|
|
13
27
|
|
|
14
28
|
```typescript
|
|
15
|
-
await client.
|
|
29
|
+
await client.metricsMetricsGet();
|
|
16
30
|
|
|
17
31
|
```
|
|
18
32
|
</dd>
|
|
@@ -40,7 +54,7 @@ await client.healthHealthGet();
|
|
|
40
54
|
</dl>
|
|
41
55
|
</details>
|
|
42
56
|
|
|
43
|
-
<details><summary><code>client.<a href="/src/Client.ts">
|
|
57
|
+
<details><summary><code>client.<a href="/src/Client.ts">healthHealthGet</a>() -> core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error></code></summary>
|
|
44
58
|
<dl>
|
|
45
59
|
<dd>
|
|
46
60
|
|
|
@@ -53,7 +67,7 @@ await client.healthHealthGet();
|
|
|
53
67
|
<dd>
|
|
54
68
|
|
|
55
69
|
```typescript
|
|
56
|
-
await client.
|
|
70
|
+
await client.healthHealthGet();
|
|
57
71
|
|
|
58
72
|
```
|
|
59
73
|
</dd>
|