@fern-api/venus-api-sdk 5.1.0 → 5.3.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/api/resources/apiKeys/client/Client.d.ts +12 -0
- package/dist/cjs/api/resources/apiKeys/client/Client.js +87 -0
- package/dist/cjs/api/resources/apiKeys/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/client/index.js +2 -1
- package/dist/cjs/api/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.ts +12 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.js +3 -0
- package/dist/cjs/api/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/apiKeys/client/updateTokenDescription.d.ts +25 -0
- package/dist/cjs/api/resources/apiKeys/client/updateTokenDescription.js +66 -0
- package/dist/cjs/api/types/TokenMetadata.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.js +42 -0
- package/dist/cjs/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/client/requests/index.js +3 -1
- package/dist/cjs/serialization/types/TokenMetadata.d.ts +1 -0
- package/dist/cjs/serialization/types/TokenMetadata.js +1 -0
- 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/api/resources/apiKeys/client/Client.d.mts +12 -0
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +87 -0
- package/dist/esm/api/resources/apiKeys/client/index.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/client/index.mjs +1 -0
- package/dist/esm/api/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.mts +12 -0
- package/dist/esm/api/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/apiKeys/client/updateTokenDescription.d.mts +25 -0
- package/dist/esm/api/resources/apiKeys/client/updateTokenDescription.mjs +30 -0
- package/dist/esm/api/types/TokenMetadata.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.mjs +6 -0
- package/dist/esm/serialization/resources/apiKeys/client/requests/index.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/client/requests/index.mjs +1 -0
- package/dist/esm/serialization/types/TokenMetadata.d.mts +1 -0
- package/dist/esm/serialization/types/TokenMetadata.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +52 -0
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": "5.
|
|
47
|
-
"User-Agent": "@fern-api/venus-api-sdk/5.
|
|
46
|
+
"X-Fern-SDK-Version": "5.3.0",
|
|
47
|
+
"User-Agent": "@fern-api/venus-api-sdk/5.3.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);
|
|
@@ -65,4 +65,16 @@ export declare class ApiKeysClient {
|
|
|
65
65
|
*/
|
|
66
66
|
revokeToken(request: FernVenusApi.RevokeApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.apiKeys.revokeToken.Error>>;
|
|
67
67
|
private __revokeToken;
|
|
68
|
+
/**
|
|
69
|
+
* @param {FernVenusApi.UpdateTokenDescriptionRequest} request
|
|
70
|
+
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* await client.apiKeys.updateTokenDescription({
|
|
74
|
+
* tokenId: "token_id",
|
|
75
|
+
* organizationId: "organizationId"
|
|
76
|
+
* })
|
|
77
|
+
*/
|
|
78
|
+
updateTokenDescription(request: FernVenusApi.UpdateTokenDescriptionRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.apiKeys.updateTokenDescription.Error>>;
|
|
79
|
+
private __updateTokenDescription;
|
|
68
80
|
}
|
|
@@ -42,6 +42,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
42
42
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
43
|
});
|
|
44
44
|
};
|
|
45
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
46
|
+
var t = {};
|
|
47
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
48
|
+
t[p] = s[p];
|
|
49
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
50
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
51
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
52
|
+
t[p[i]] = s[p[i]];
|
|
53
|
+
}
|
|
54
|
+
return t;
|
|
55
|
+
};
|
|
45
56
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
57
|
exports.ApiKeysClient = void 0;
|
|
47
58
|
const BaseClient_js_1 = require("../../../../BaseClient.js");
|
|
@@ -431,5 +442,81 @@ class ApiKeysClient {
|
|
|
431
442
|
};
|
|
432
443
|
});
|
|
433
444
|
}
|
|
445
|
+
/**
|
|
446
|
+
* @param {FernVenusApi.UpdateTokenDescriptionRequest} request
|
|
447
|
+
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
448
|
+
*
|
|
449
|
+
* @example
|
|
450
|
+
* await client.apiKeys.updateTokenDescription({
|
|
451
|
+
* tokenId: "token_id",
|
|
452
|
+
* organizationId: "organizationId"
|
|
453
|
+
* })
|
|
454
|
+
*/
|
|
455
|
+
updateTokenDescription(request, requestOptions) {
|
|
456
|
+
return core.HttpResponsePromise.fromPromise(this.__updateTokenDescription(request, requestOptions));
|
|
457
|
+
}
|
|
458
|
+
__updateTokenDescription(request, requestOptions) {
|
|
459
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
460
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
461
|
+
const { tokenId } = request, _body = __rest(request, ["tokenId"]);
|
|
462
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
463
|
+
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);
|
|
464
|
+
const _response = yield core.fetcher({
|
|
465
|
+
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/${core.url.encodePathParam(tokenId)}/description`),
|
|
466
|
+
method: "PATCH",
|
|
467
|
+
headers: _headers,
|
|
468
|
+
contentType: "application/json",
|
|
469
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
470
|
+
requestType: "json",
|
|
471
|
+
body: serializers.UpdateTokenDescriptionRequest.jsonOrThrow(_body, {
|
|
472
|
+
unrecognizedObjectKeys: "strip",
|
|
473
|
+
omitUndefined: true,
|
|
474
|
+
}),
|
|
475
|
+
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,
|
|
476
|
+
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,
|
|
477
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
478
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
479
|
+
logging: this._options.logging,
|
|
480
|
+
});
|
|
481
|
+
if (_response.ok) {
|
|
482
|
+
return {
|
|
483
|
+
data: {
|
|
484
|
+
ok: true,
|
|
485
|
+
body: undefined,
|
|
486
|
+
headers: _response.headers,
|
|
487
|
+
rawResponse: _response.rawResponse,
|
|
488
|
+
},
|
|
489
|
+
rawResponse: _response.rawResponse,
|
|
490
|
+
};
|
|
491
|
+
}
|
|
492
|
+
if (_response.error.reason === "status-code") {
|
|
493
|
+
switch (_response.error.statusCode) {
|
|
494
|
+
case 422:
|
|
495
|
+
return {
|
|
496
|
+
data: {
|
|
497
|
+
ok: false,
|
|
498
|
+
error: FernVenusApi.apiKeys.updateTokenDescription.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
499
|
+
unrecognizedObjectKeys: "passthrough",
|
|
500
|
+
allowUnrecognizedUnionMembers: true,
|
|
501
|
+
allowUnrecognizedEnumValues: true,
|
|
502
|
+
skipValidation: true,
|
|
503
|
+
breadcrumbsPrefix: ["response"],
|
|
504
|
+
})),
|
|
505
|
+
rawResponse: _response.rawResponse,
|
|
506
|
+
},
|
|
507
|
+
rawResponse: _response.rawResponse,
|
|
508
|
+
};
|
|
509
|
+
}
|
|
510
|
+
}
|
|
511
|
+
return {
|
|
512
|
+
data: {
|
|
513
|
+
ok: false,
|
|
514
|
+
error: FernVenusApi.apiKeys.updateTokenDescription.Error._unknown(_response.error),
|
|
515
|
+
rawResponse: _response.rawResponse,
|
|
516
|
+
},
|
|
517
|
+
rawResponse: _response.rawResponse,
|
|
518
|
+
};
|
|
519
|
+
});
|
|
520
|
+
}
|
|
434
521
|
}
|
|
435
522
|
exports.ApiKeysClient = ApiKeysClient;
|
|
@@ -4,3 +4,4 @@ export * as getTokensForOrganization from "./getTokensForOrganization.js";
|
|
|
4
4
|
export * from "./requests/index.js";
|
|
5
5
|
export * as revokeToken from "./revokeToken.js";
|
|
6
6
|
export * as revokeTokenById from "./revokeTokenById.js";
|
|
7
|
+
export * as updateTokenDescription from "./updateTokenDescription.js";
|
|
@@ -36,10 +36,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.revokeTokenById = exports.revokeToken = exports.getTokensForOrganization = exports.getTokenMetadata = exports.create = void 0;
|
|
39
|
+
exports.updateTokenDescription = exports.revokeTokenById = exports.revokeToken = exports.getTokensForOrganization = exports.getTokenMetadata = exports.create = void 0;
|
|
40
40
|
exports.create = __importStar(require("./create.js"));
|
|
41
41
|
exports.getTokenMetadata = __importStar(require("./getTokenMetadata.js"));
|
|
42
42
|
exports.getTokensForOrganization = __importStar(require("./getTokensForOrganization.js"));
|
|
43
43
|
__exportStar(require("./requests/index.js"), exports);
|
|
44
44
|
exports.revokeToken = __importStar(require("./revokeToken.js"));
|
|
45
45
|
exports.revokeTokenById = __importStar(require("./revokeTokenById.js"));
|
|
46
|
+
exports.updateTokenDescription = __importStar(require("./updateTokenDescription.js"));
|
|
@@ -3,3 +3,4 @@ export type { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.js";
|
|
|
3
3
|
export type { GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest } from "./GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest.js";
|
|
4
4
|
export type { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.js";
|
|
5
5
|
export type { RevokeTokenByIdApiKeysRevokeTokenIdPostRequest } from "./RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.js";
|
|
6
|
+
export type { UpdateTokenDescriptionRequest } from "./UpdateTokenDescriptionRequest.js";
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type * as core from "../../../../core/index.js";
|
|
2
|
+
import * as FernVenusApi from "../../../index.js";
|
|
3
|
+
export type Error = FernVenusApi.apiKeys.updateTokenDescription.Error.UnprocessableEntityError | FernVenusApi.apiKeys.updateTokenDescription.Error._Unknown;
|
|
4
|
+
export declare namespace Error {
|
|
5
|
+
interface UnprocessableEntityError extends _Utils {
|
|
6
|
+
statusCode: 422;
|
|
7
|
+
content: FernVenusApi.HttpValidationError;
|
|
8
|
+
}
|
|
9
|
+
interface _Unknown extends _Utils {
|
|
10
|
+
statusCode: void;
|
|
11
|
+
content: core.Fetcher.Error;
|
|
12
|
+
}
|
|
13
|
+
interface _Utils {
|
|
14
|
+
_visit: <_Result>(visitor: FernVenusApi.apiKeys.updateTokenDescription.Error._Visitor<_Result>) => _Result;
|
|
15
|
+
}
|
|
16
|
+
interface _Visitor<_Result> {
|
|
17
|
+
unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
|
|
18
|
+
_other: (value: core.Fetcher.Error) => _Result;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
export declare const Error: {
|
|
22
|
+
readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.apiKeys.updateTokenDescription.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.apiKeys.updateTokenDescription.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.apiKeys.updateTokenDescription.Error, visitor: FernVenusApi.apiKeys.updateTokenDescription.Error._Visitor<_Result>) => _Result;
|
|
25
|
+
};
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.Error = void 0;
|
|
38
|
+
const FernVenusApi = __importStar(require("../../../index.js"));
|
|
39
|
+
exports.Error = {
|
|
40
|
+
unprocessableEntityError: (value) => {
|
|
41
|
+
return {
|
|
42
|
+
content: value,
|
|
43
|
+
statusCode: 422,
|
|
44
|
+
_visit: function (visitor) {
|
|
45
|
+
return FernVenusApi.apiKeys.updateTokenDescription.Error._visit(this, visitor);
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
},
|
|
49
|
+
_unknown: (fetcherError) => {
|
|
50
|
+
return {
|
|
51
|
+
statusCode: undefined,
|
|
52
|
+
content: fetcherError,
|
|
53
|
+
_visit: function (visitor) {
|
|
54
|
+
return FernVenusApi.apiKeys.updateTokenDescription.Error._visit(this, visitor);
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
},
|
|
58
|
+
_visit: (value, visitor) => {
|
|
59
|
+
switch (value.statusCode) {
|
|
60
|
+
case 422:
|
|
61
|
+
return visitor.unprocessableEntityError(value.content);
|
|
62
|
+
default:
|
|
63
|
+
return visitor._other(value.content);
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
};
|
package/dist/cjs/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as FernVenusApi from "../../../../../api/index.js";
|
|
2
|
+
import * as core from "../../../../../core/index.js";
|
|
3
|
+
import type * as serializers from "../../../../index.js";
|
|
4
|
+
export declare const UpdateTokenDescriptionRequest: core.serialization.Schema<serializers.UpdateTokenDescriptionRequest.Raw, Omit<FernVenusApi.UpdateTokenDescriptionRequest, "tokenId">>;
|
|
5
|
+
export declare namespace UpdateTokenDescriptionRequest {
|
|
6
|
+
interface Raw {
|
|
7
|
+
organizationId: string;
|
|
8
|
+
description?: (string | null | undefined) | null;
|
|
9
|
+
}
|
|
10
|
+
}
|
package/dist/cjs/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.js
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.UpdateTokenDescriptionRequest = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../../core/index.js"));
|
|
39
|
+
exports.UpdateTokenDescriptionRequest = core.serialization.object({
|
|
40
|
+
organizationId: core.serialization.string(),
|
|
41
|
+
description: core.serialization.string().optionalNullable(),
|
|
42
|
+
});
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export { CreateApiKeyRequest } from "./CreateApiKeyRequest.js";
|
|
2
2
|
export { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.js";
|
|
3
3
|
export { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.js";
|
|
4
|
+
export { UpdateTokenDescriptionRequest } from "./UpdateTokenDescriptionRequest.js";
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RevokeApiKeyRequest = exports.GetTokenMetadataRequest = exports.CreateApiKeyRequest = void 0;
|
|
3
|
+
exports.UpdateTokenDescriptionRequest = exports.RevokeApiKeyRequest = exports.GetTokenMetadataRequest = exports.CreateApiKeyRequest = void 0;
|
|
4
4
|
var CreateApiKeyRequest_js_1 = require("./CreateApiKeyRequest.js");
|
|
5
5
|
Object.defineProperty(exports, "CreateApiKeyRequest", { enumerable: true, get: function () { return CreateApiKeyRequest_js_1.CreateApiKeyRequest; } });
|
|
6
6
|
var GetTokenMetadataRequest_js_1 = require("./GetTokenMetadataRequest.js");
|
|
7
7
|
Object.defineProperty(exports, "GetTokenMetadataRequest", { enumerable: true, get: function () { return GetTokenMetadataRequest_js_1.GetTokenMetadataRequest; } });
|
|
8
8
|
var RevokeApiKeyRequest_js_1 = require("./RevokeApiKeyRequest.js");
|
|
9
9
|
Object.defineProperty(exports, "RevokeApiKeyRequest", { enumerable: true, get: function () { return RevokeApiKeyRequest_js_1.RevokeApiKeyRequest; } });
|
|
10
|
+
var UpdateTokenDescriptionRequest_js_1 = require("./UpdateTokenDescriptionRequest.js");
|
|
11
|
+
Object.defineProperty(exports, "UpdateTokenDescriptionRequest", { enumerable: true, get: function () { return UpdateTokenDescriptionRequest_js_1.UpdateTokenDescriptionRequest; } });
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "5.
|
|
1
|
+
export declare const SDK_VERSION = "5.3.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": "5.
|
|
10
|
-
"User-Agent": "@fern-api/venus-api-sdk/5.
|
|
9
|
+
"X-Fern-SDK-Version": "5.3.0",
|
|
10
|
+
"User-Agent": "@fern-api/venus-api-sdk/5.3.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);
|
|
@@ -65,4 +65,16 @@ export declare class ApiKeysClient {
|
|
|
65
65
|
*/
|
|
66
66
|
revokeToken(request: FernVenusApi.RevokeApiKeyRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.apiKeys.revokeToken.Error>>;
|
|
67
67
|
private __revokeToken;
|
|
68
|
+
/**
|
|
69
|
+
* @param {FernVenusApi.UpdateTokenDescriptionRequest} request
|
|
70
|
+
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* await client.apiKeys.updateTokenDescription({
|
|
74
|
+
* tokenId: "token_id",
|
|
75
|
+
* organizationId: "organizationId"
|
|
76
|
+
* })
|
|
77
|
+
*/
|
|
78
|
+
updateTokenDescription(request: FernVenusApi.UpdateTokenDescriptionRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.apiKeys.updateTokenDescription.Error>>;
|
|
79
|
+
private __updateTokenDescription;
|
|
68
80
|
}
|
|
@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
8
8
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
12
|
+
var t = {};
|
|
13
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
14
|
+
t[p] = s[p];
|
|
15
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
16
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
17
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
18
|
+
t[p[i]] = s[p[i]];
|
|
19
|
+
}
|
|
20
|
+
return t;
|
|
21
|
+
};
|
|
11
22
|
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
12
23
|
import { mergeHeaders } from "../../../../core/headers.mjs";
|
|
13
24
|
import * as core from "../../../../core/index.mjs";
|
|
@@ -395,4 +406,80 @@ export class ApiKeysClient {
|
|
|
395
406
|
};
|
|
396
407
|
});
|
|
397
408
|
}
|
|
409
|
+
/**
|
|
410
|
+
* @param {FernVenusApi.UpdateTokenDescriptionRequest} request
|
|
411
|
+
* @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
412
|
+
*
|
|
413
|
+
* @example
|
|
414
|
+
* await client.apiKeys.updateTokenDescription({
|
|
415
|
+
* tokenId: "token_id",
|
|
416
|
+
* organizationId: "organizationId"
|
|
417
|
+
* })
|
|
418
|
+
*/
|
|
419
|
+
updateTokenDescription(request, requestOptions) {
|
|
420
|
+
return core.HttpResponsePromise.fromPromise(this.__updateTokenDescription(request, requestOptions));
|
|
421
|
+
}
|
|
422
|
+
__updateTokenDescription(request, requestOptions) {
|
|
423
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
424
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
425
|
+
const { tokenId } = request, _body = __rest(request, ["tokenId"]);
|
|
426
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
427
|
+
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);
|
|
428
|
+
const _response = yield core.fetcher({
|
|
429
|
+
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/${core.url.encodePathParam(tokenId)}/description`),
|
|
430
|
+
method: "PATCH",
|
|
431
|
+
headers: _headers,
|
|
432
|
+
contentType: "application/json",
|
|
433
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
434
|
+
requestType: "json",
|
|
435
|
+
body: serializers.UpdateTokenDescriptionRequest.jsonOrThrow(_body, {
|
|
436
|
+
unrecognizedObjectKeys: "strip",
|
|
437
|
+
omitUndefined: true,
|
|
438
|
+
}),
|
|
439
|
+
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,
|
|
440
|
+
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,
|
|
441
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
442
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
443
|
+
logging: this._options.logging,
|
|
444
|
+
});
|
|
445
|
+
if (_response.ok) {
|
|
446
|
+
return {
|
|
447
|
+
data: {
|
|
448
|
+
ok: true,
|
|
449
|
+
body: undefined,
|
|
450
|
+
headers: _response.headers,
|
|
451
|
+
rawResponse: _response.rawResponse,
|
|
452
|
+
},
|
|
453
|
+
rawResponse: _response.rawResponse,
|
|
454
|
+
};
|
|
455
|
+
}
|
|
456
|
+
if (_response.error.reason === "status-code") {
|
|
457
|
+
switch (_response.error.statusCode) {
|
|
458
|
+
case 422:
|
|
459
|
+
return {
|
|
460
|
+
data: {
|
|
461
|
+
ok: false,
|
|
462
|
+
error: FernVenusApi.apiKeys.updateTokenDescription.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
463
|
+
unrecognizedObjectKeys: "passthrough",
|
|
464
|
+
allowUnrecognizedUnionMembers: true,
|
|
465
|
+
allowUnrecognizedEnumValues: true,
|
|
466
|
+
skipValidation: true,
|
|
467
|
+
breadcrumbsPrefix: ["response"],
|
|
468
|
+
})),
|
|
469
|
+
rawResponse: _response.rawResponse,
|
|
470
|
+
},
|
|
471
|
+
rawResponse: _response.rawResponse,
|
|
472
|
+
};
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
return {
|
|
476
|
+
data: {
|
|
477
|
+
ok: false,
|
|
478
|
+
error: FernVenusApi.apiKeys.updateTokenDescription.Error._unknown(_response.error),
|
|
479
|
+
rawResponse: _response.rawResponse,
|
|
480
|
+
},
|
|
481
|
+
rawResponse: _response.rawResponse,
|
|
482
|
+
};
|
|
483
|
+
});
|
|
484
|
+
}
|
|
398
485
|
}
|
|
@@ -4,3 +4,4 @@ export * as getTokensForOrganization from "./getTokensForOrganization.mjs";
|
|
|
4
4
|
export * from "./requests/index.mjs";
|
|
5
5
|
export * as revokeToken from "./revokeToken.mjs";
|
|
6
6
|
export * as revokeTokenById from "./revokeTokenById.mjs";
|
|
7
|
+
export * as updateTokenDescription from "./updateTokenDescription.mjs";
|
|
@@ -4,3 +4,4 @@ export * as getTokensForOrganization from "./getTokensForOrganization.mjs";
|
|
|
4
4
|
export * from "./requests/index.mjs";
|
|
5
5
|
export * as revokeToken from "./revokeToken.mjs";
|
|
6
6
|
export * as revokeTokenById from "./revokeTokenById.mjs";
|
|
7
|
+
export * as updateTokenDescription from "./updateTokenDescription.mjs";
|
|
@@ -3,3 +3,4 @@ export type { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.mjs";
|
|
|
3
3
|
export type { GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest } from "./GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest.mjs";
|
|
4
4
|
export type { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.mjs";
|
|
5
5
|
export type { RevokeTokenByIdApiKeysRevokeTokenIdPostRequest } from "./RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.mjs";
|
|
6
|
+
export type { UpdateTokenDescriptionRequest } from "./UpdateTokenDescriptionRequest.mjs";
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type * as core from "../../../../core/index.mjs";
|
|
2
|
+
import * as FernVenusApi from "../../../index.mjs";
|
|
3
|
+
export type Error = FernVenusApi.apiKeys.updateTokenDescription.Error.UnprocessableEntityError | FernVenusApi.apiKeys.updateTokenDescription.Error._Unknown;
|
|
4
|
+
export declare namespace Error {
|
|
5
|
+
interface UnprocessableEntityError extends _Utils {
|
|
6
|
+
statusCode: 422;
|
|
7
|
+
content: FernVenusApi.HttpValidationError;
|
|
8
|
+
}
|
|
9
|
+
interface _Unknown extends _Utils {
|
|
10
|
+
statusCode: void;
|
|
11
|
+
content: core.Fetcher.Error;
|
|
12
|
+
}
|
|
13
|
+
interface _Utils {
|
|
14
|
+
_visit: <_Result>(visitor: FernVenusApi.apiKeys.updateTokenDescription.Error._Visitor<_Result>) => _Result;
|
|
15
|
+
}
|
|
16
|
+
interface _Visitor<_Result> {
|
|
17
|
+
unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
|
|
18
|
+
_other: (value: core.Fetcher.Error) => _Result;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
export declare const Error: {
|
|
22
|
+
readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.apiKeys.updateTokenDescription.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.apiKeys.updateTokenDescription.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.apiKeys.updateTokenDescription.Error, visitor: FernVenusApi.apiKeys.updateTokenDescription.Error._Visitor<_Result>) => _Result;
|
|
25
|
+
};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as FernVenusApi from "../../../index.mjs";
|
|
3
|
+
export const Error = {
|
|
4
|
+
unprocessableEntityError: (value) => {
|
|
5
|
+
return {
|
|
6
|
+
content: value,
|
|
7
|
+
statusCode: 422,
|
|
8
|
+
_visit: function (visitor) {
|
|
9
|
+
return FernVenusApi.apiKeys.updateTokenDescription.Error._visit(this, visitor);
|
|
10
|
+
},
|
|
11
|
+
};
|
|
12
|
+
},
|
|
13
|
+
_unknown: (fetcherError) => {
|
|
14
|
+
return {
|
|
15
|
+
statusCode: undefined,
|
|
16
|
+
content: fetcherError,
|
|
17
|
+
_visit: function (visitor) {
|
|
18
|
+
return FernVenusApi.apiKeys.updateTokenDescription.Error._visit(this, visitor);
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
|
+
},
|
|
22
|
+
_visit: (value, visitor) => {
|
|
23
|
+
switch (value.statusCode) {
|
|
24
|
+
case 422:
|
|
25
|
+
return visitor.unprocessableEntityError(value.content);
|
|
26
|
+
default:
|
|
27
|
+
return visitor._other(value.content);
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
};
|
package/dist/esm/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.d.mts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as FernVenusApi from "../../../../../api/index.mjs";
|
|
2
|
+
import * as core from "../../../../../core/index.mjs";
|
|
3
|
+
import type * as serializers from "../../../../index.mjs";
|
|
4
|
+
export declare const UpdateTokenDescriptionRequest: core.serialization.Schema<serializers.UpdateTokenDescriptionRequest.Raw, Omit<FernVenusApi.UpdateTokenDescriptionRequest, "tokenId">>;
|
|
5
|
+
export declare namespace UpdateTokenDescriptionRequest {
|
|
6
|
+
interface Raw {
|
|
7
|
+
organizationId: string;
|
|
8
|
+
description?: (string | null | undefined) | null;
|
|
9
|
+
}
|
|
10
|
+
}
|
package/dist/esm/serialization/resources/apiKeys/client/requests/UpdateTokenDescriptionRequest.mjs
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../../core/index.mjs";
|
|
3
|
+
export const UpdateTokenDescriptionRequest = core.serialization.object({
|
|
4
|
+
organizationId: core.serialization.string(),
|
|
5
|
+
description: core.serialization.string().optionalNullable(),
|
|
6
|
+
});
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export { CreateApiKeyRequest } from "./CreateApiKeyRequest.mjs";
|
|
2
2
|
export { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.mjs";
|
|
3
3
|
export { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.mjs";
|
|
4
|
+
export { UpdateTokenDescriptionRequest } from "./UpdateTokenDescriptionRequest.mjs";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export { CreateApiKeyRequest } from "./CreateApiKeyRequest.mjs";
|
|
2
2
|
export { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.mjs";
|
|
3
3
|
export { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.mjs";
|
|
4
|
+
export { UpdateTokenDescriptionRequest } from "./UpdateTokenDescriptionRequest.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "5.
|
|
1
|
+
export declare const SDK_VERSION = "5.3.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "5.
|
|
1
|
+
export const SDK_VERSION = "5.3.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -347,6 +347,58 @@ await client.apiKeys.revokeToken({
|
|
|
347
347
|
</dl>
|
|
348
348
|
|
|
349
349
|
|
|
350
|
+
</dd>
|
|
351
|
+
</dl>
|
|
352
|
+
</details>
|
|
353
|
+
|
|
354
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">updateTokenDescription</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.apiKeys.updateTokenDescription.Error></code></summary>
|
|
355
|
+
<dl>
|
|
356
|
+
<dd>
|
|
357
|
+
|
|
358
|
+
#### 🔌 Usage
|
|
359
|
+
|
|
360
|
+
<dl>
|
|
361
|
+
<dd>
|
|
362
|
+
|
|
363
|
+
<dl>
|
|
364
|
+
<dd>
|
|
365
|
+
|
|
366
|
+
```typescript
|
|
367
|
+
await client.apiKeys.updateTokenDescription({
|
|
368
|
+
tokenId: "token_id",
|
|
369
|
+
organizationId: "organizationId"
|
|
370
|
+
});
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
</dd>
|
|
374
|
+
</dl>
|
|
375
|
+
</dd>
|
|
376
|
+
</dl>
|
|
377
|
+
|
|
378
|
+
#### ⚙️ Parameters
|
|
379
|
+
|
|
380
|
+
<dl>
|
|
381
|
+
<dd>
|
|
382
|
+
|
|
383
|
+
<dl>
|
|
384
|
+
<dd>
|
|
385
|
+
|
|
386
|
+
**request:** `FernVenusApi.UpdateTokenDescriptionRequest`
|
|
387
|
+
|
|
388
|
+
</dd>
|
|
389
|
+
</dl>
|
|
390
|
+
|
|
391
|
+
<dl>
|
|
392
|
+
<dd>
|
|
393
|
+
|
|
394
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
395
|
+
|
|
396
|
+
</dd>
|
|
397
|
+
</dl>
|
|
398
|
+
</dd>
|
|
399
|
+
</dl>
|
|
400
|
+
|
|
401
|
+
|
|
350
402
|
</dd>
|
|
351
403
|
</dl>
|
|
352
404
|
</details>
|