@fern-api/venus-api-sdk 11.5.0 → 11.6.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/organization/client/Client.d.ts +34 -1
- package/dist/cjs/api/resources/organization/client/Client.js +162 -1
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.js +66 -0
- package/dist/cjs/api/resources/organization/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/organization/client/index.js +3 -1
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.d.ts +11 -0
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/organization/client/setDocsUrl.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/setDocsUrl.js +66 -0
- package/dist/cjs/api/types/PostmanTeamDocsResponse.d.ts +6 -0
- package/dist/cjs/api/types/PostmanTeamDocsResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.js +41 -0
- package/dist/cjs/serialization/resources/organization/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/organization/client/requests/index.js +3 -1
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.d.ts +12 -0
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.js +44 -0
- package/dist/cjs/serialization/types/index.d.ts +1 -0
- package/dist/cjs/serialization/types/index.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/organization/client/Client.d.mts +34 -1
- package/dist/esm/api/resources/organization/client/Client.mjs +162 -1
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.mjs +30 -0
- package/dist/esm/api/resources/organization/client/index.d.mts +2 -0
- package/dist/esm/api/resources/organization/client/index.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.d.mts +11 -0
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/organization/client/setDocsUrl.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/setDocsUrl.mjs +30 -0
- package/dist/esm/api/types/PostmanTeamDocsResponse.d.mts +6 -0
- package/dist/esm/api/types/PostmanTeamDocsResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.mjs +5 -0
- package/dist/esm/serialization/resources/organization/client/requests/index.d.mts +1 -0
- package/dist/esm/serialization/resources/organization/client/requests/index.mjs +1 -0
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.d.mts +12 -0
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.mjs +8 -0
- package/dist/esm/serialization/types/index.d.mts +1 -0
- package/dist/esm/serialization/types/index.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 +138 -1
|
@@ -0,0 +1,44 @@
|
|
|
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.PostmanTeamDocsResponse = void 0;
|
|
38
|
+
const core = __importStar(require("../../core/index.js"));
|
|
39
|
+
const ClaimStatus_js_1 = require("./ClaimStatus.js");
|
|
40
|
+
exports.PostmanTeamDocsResponse = core.serialization.object({
|
|
41
|
+
organizationId: core.serialization.string(),
|
|
42
|
+
claimStatus: ClaimStatus_js_1.ClaimStatus,
|
|
43
|
+
docsUrl: core.serialization.string(),
|
|
44
|
+
});
|
|
@@ -20,6 +20,7 @@ export * from "./Npm.js";
|
|
|
20
20
|
export * from "./NpmRegistryToken.js";
|
|
21
21
|
export * from "./Organization.js";
|
|
22
22
|
export * from "./OrganizationsPage.js";
|
|
23
|
+
export * from "./PostmanTeamDocsResponse.js";
|
|
23
24
|
export * from "./Pypi.js";
|
|
24
25
|
export * from "./PypiRegistryToken.js";
|
|
25
26
|
export * from "./RegistryToken.js";
|
|
@@ -36,6 +36,7 @@ __exportStar(require("./Npm.js"), exports);
|
|
|
36
36
|
__exportStar(require("./NpmRegistryToken.js"), exports);
|
|
37
37
|
__exportStar(require("./Organization.js"), exports);
|
|
38
38
|
__exportStar(require("./OrganizationsPage.js"), exports);
|
|
39
|
+
__exportStar(require("./PostmanTeamDocsResponse.js"), exports);
|
|
39
40
|
__exportStar(require("./Pypi.js"), exports);
|
|
40
41
|
__exportStar(require("./PypiRegistryToken.js"), exports);
|
|
41
42
|
__exportStar(require("./RegistryToken.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.6.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": "11.
|
|
10
|
-
"User-Agent": "@fern-api/venus-api-sdk/11.
|
|
9
|
+
"X-Fern-SDK-Version": "11.6.0",
|
|
10
|
+
"User-Agent": "@fern-api/venus-api-sdk/11.6.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);
|
|
@@ -76,6 +76,22 @@ export declare class OrganizationClient {
|
|
|
76
76
|
*/
|
|
77
77
|
getOrgIdsByPostmanTeamId(request: FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error>>;
|
|
78
78
|
private __getOrgIdsByPostmanTeamId;
|
|
79
|
+
/**
|
|
80
|
+
* The claimable organization linked to a Postman team, with its claim
|
|
81
|
+
* status and the address of its docs site. Only Postman's integration
|
|
82
|
+
* service token can call it. 404 when the team has no claimable
|
|
83
|
+
* organization, or its docs address isn't set.
|
|
84
|
+
*
|
|
85
|
+
* @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
|
|
86
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* await client.organization.getPostmanTeamDocs({
|
|
90
|
+
* postmanTeamId: "postman_team_id"
|
|
91
|
+
* })
|
|
92
|
+
*/
|
|
93
|
+
getPostmanTeamDocs(request: FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error>>;
|
|
94
|
+
private __getPostmanTeamDocs;
|
|
79
95
|
/**
|
|
80
96
|
* Get the Postman team ID associated with an organization ID.
|
|
81
97
|
*
|
|
@@ -106,7 +122,8 @@ export declare class OrganizationClient {
|
|
|
106
122
|
private __getClaimStatus;
|
|
107
123
|
/**
|
|
108
124
|
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
109
|
-
* user and valid for 15 minutes. Only the provisioner token
|
|
125
|
+
* user and valid for 15 minutes. Only the provisioner token and Postman's
|
|
126
|
+
* integration service token can call it.
|
|
110
127
|
*
|
|
111
128
|
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
112
129
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -119,6 +136,22 @@ export declare class OrganizationClient {
|
|
|
119
136
|
*/
|
|
120
137
|
createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
|
|
121
138
|
private __createClaimToken;
|
|
139
|
+
/**
|
|
140
|
+
* Sets the address of an unclaimed organization's docs site, which the
|
|
141
|
+
* team docs lookup returns. Only the provisioner token can call it, and
|
|
142
|
+
* only until the organization is claimed.
|
|
143
|
+
*
|
|
144
|
+
* @param {FernVenusApi.SetDocsUrlRequest} request
|
|
145
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
146
|
+
*
|
|
147
|
+
* @example
|
|
148
|
+
* await client.organization.setDocsUrl({
|
|
149
|
+
* orgId: "org_id",
|
|
150
|
+
* docsUrl: "docsUrl"
|
|
151
|
+
* })
|
|
152
|
+
*/
|
|
153
|
+
setDocsUrl(request: FernVenusApi.SetDocsUrlRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error>>;
|
|
154
|
+
private __setDocsUrl;
|
|
122
155
|
/**
|
|
123
156
|
* Redeems a claim link. The caller, signed in as the Postman user the link
|
|
124
157
|
* is for, becomes the admin of the organization. The first claim wins, and
|
|
@@ -416,6 +416,86 @@ export class OrganizationClient {
|
|
|
416
416
|
};
|
|
417
417
|
});
|
|
418
418
|
}
|
|
419
|
+
/**
|
|
420
|
+
* The claimable organization linked to a Postman team, with its claim
|
|
421
|
+
* status and the address of its docs site. Only Postman's integration
|
|
422
|
+
* service token can call it. 404 when the team has no claimable
|
|
423
|
+
* organization, or its docs address isn't set.
|
|
424
|
+
*
|
|
425
|
+
* @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
|
|
426
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
427
|
+
*
|
|
428
|
+
* @example
|
|
429
|
+
* await client.organization.getPostmanTeamDocs({
|
|
430
|
+
* postmanTeamId: "postman_team_id"
|
|
431
|
+
* })
|
|
432
|
+
*/
|
|
433
|
+
getPostmanTeamDocs(request, requestOptions) {
|
|
434
|
+
return core.HttpResponsePromise.fromPromise(this.__getPostmanTeamDocs(request, requestOptions));
|
|
435
|
+
}
|
|
436
|
+
__getPostmanTeamDocs(request, requestOptions) {
|
|
437
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
438
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
439
|
+
const { postmanTeamId } = request;
|
|
440
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
441
|
+
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);
|
|
442
|
+
const _response = yield core.fetcher({
|
|
443
|
+
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `organizations/postman-team/${core.url.encodePathParam(postmanTeamId)}/docs`),
|
|
444
|
+
method: "GET",
|
|
445
|
+
headers: _headers,
|
|
446
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
447
|
+
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,
|
|
448
|
+
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,
|
|
449
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
450
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
451
|
+
logging: this._options.logging,
|
|
452
|
+
});
|
|
453
|
+
if (_response.ok) {
|
|
454
|
+
return {
|
|
455
|
+
data: {
|
|
456
|
+
ok: true,
|
|
457
|
+
body: serializers.PostmanTeamDocsResponse.parseOrThrow(_response.body, {
|
|
458
|
+
unrecognizedObjectKeys: "passthrough",
|
|
459
|
+
allowUnrecognizedUnionMembers: true,
|
|
460
|
+
allowUnrecognizedEnumValues: true,
|
|
461
|
+
skipValidation: true,
|
|
462
|
+
breadcrumbsPrefix: ["response"],
|
|
463
|
+
}),
|
|
464
|
+
headers: _response.headers,
|
|
465
|
+
rawResponse: _response.rawResponse,
|
|
466
|
+
},
|
|
467
|
+
rawResponse: _response.rawResponse,
|
|
468
|
+
};
|
|
469
|
+
}
|
|
470
|
+
if (_response.error.reason === "status-code") {
|
|
471
|
+
switch (_response.error.statusCode) {
|
|
472
|
+
case 422:
|
|
473
|
+
return {
|
|
474
|
+
data: {
|
|
475
|
+
ok: false,
|
|
476
|
+
error: FernVenusApi.organization.getPostmanTeamDocs.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
477
|
+
unrecognizedObjectKeys: "passthrough",
|
|
478
|
+
allowUnrecognizedUnionMembers: true,
|
|
479
|
+
allowUnrecognizedEnumValues: true,
|
|
480
|
+
skipValidation: true,
|
|
481
|
+
breadcrumbsPrefix: ["response"],
|
|
482
|
+
})),
|
|
483
|
+
rawResponse: _response.rawResponse,
|
|
484
|
+
},
|
|
485
|
+
rawResponse: _response.rawResponse,
|
|
486
|
+
};
|
|
487
|
+
}
|
|
488
|
+
}
|
|
489
|
+
return {
|
|
490
|
+
data: {
|
|
491
|
+
ok: false,
|
|
492
|
+
error: FernVenusApi.organization.getPostmanTeamDocs.Error._unknown(_response.error),
|
|
493
|
+
rawResponse: _response.rawResponse,
|
|
494
|
+
},
|
|
495
|
+
rawResponse: _response.rawResponse,
|
|
496
|
+
};
|
|
497
|
+
});
|
|
498
|
+
}
|
|
419
499
|
/**
|
|
420
500
|
* Get the Postman team ID associated with an organization ID.
|
|
421
501
|
*
|
|
@@ -574,7 +654,8 @@ export class OrganizationClient {
|
|
|
574
654
|
}
|
|
575
655
|
/**
|
|
576
656
|
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
577
|
-
* user and valid for 15 minutes. Only the provisioner token
|
|
657
|
+
* user and valid for 15 minutes. Only the provisioner token and Postman's
|
|
658
|
+
* integration service token can call it.
|
|
578
659
|
*
|
|
579
660
|
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
580
661
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -657,6 +738,86 @@ export class OrganizationClient {
|
|
|
657
738
|
};
|
|
658
739
|
});
|
|
659
740
|
}
|
|
741
|
+
/**
|
|
742
|
+
* Sets the address of an unclaimed organization's docs site, which the
|
|
743
|
+
* team docs lookup returns. Only the provisioner token can call it, and
|
|
744
|
+
* only until the organization is claimed.
|
|
745
|
+
*
|
|
746
|
+
* @param {FernVenusApi.SetDocsUrlRequest} request
|
|
747
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
748
|
+
*
|
|
749
|
+
* @example
|
|
750
|
+
* await client.organization.setDocsUrl({
|
|
751
|
+
* orgId: "org_id",
|
|
752
|
+
* docsUrl: "docsUrl"
|
|
753
|
+
* })
|
|
754
|
+
*/
|
|
755
|
+
setDocsUrl(request, requestOptions) {
|
|
756
|
+
return core.HttpResponsePromise.fromPromise(this.__setDocsUrl(request, requestOptions));
|
|
757
|
+
}
|
|
758
|
+
__setDocsUrl(request, requestOptions) {
|
|
759
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
760
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
761
|
+
const { orgId } = request, _body = __rest(request, ["orgId"]);
|
|
762
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
763
|
+
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);
|
|
764
|
+
const _response = yield core.fetcher({
|
|
765
|
+
url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `organizations/${core.url.encodePathParam(orgId)}/docs-url`),
|
|
766
|
+
method: "POST",
|
|
767
|
+
headers: _headers,
|
|
768
|
+
contentType: "application/json",
|
|
769
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
770
|
+
requestType: "json",
|
|
771
|
+
body: serializers.SetDocsUrlRequest.jsonOrThrow(_body, {
|
|
772
|
+
unrecognizedObjectKeys: "strip",
|
|
773
|
+
omitUndefined: true,
|
|
774
|
+
}),
|
|
775
|
+
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,
|
|
776
|
+
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,
|
|
777
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
778
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
779
|
+
logging: this._options.logging,
|
|
780
|
+
});
|
|
781
|
+
if (_response.ok) {
|
|
782
|
+
return {
|
|
783
|
+
data: {
|
|
784
|
+
ok: true,
|
|
785
|
+
body: undefined,
|
|
786
|
+
headers: _response.headers,
|
|
787
|
+
rawResponse: _response.rawResponse,
|
|
788
|
+
},
|
|
789
|
+
rawResponse: _response.rawResponse,
|
|
790
|
+
};
|
|
791
|
+
}
|
|
792
|
+
if (_response.error.reason === "status-code") {
|
|
793
|
+
switch (_response.error.statusCode) {
|
|
794
|
+
case 422:
|
|
795
|
+
return {
|
|
796
|
+
data: {
|
|
797
|
+
ok: false,
|
|
798
|
+
error: FernVenusApi.organization.setDocsUrl.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
799
|
+
unrecognizedObjectKeys: "passthrough",
|
|
800
|
+
allowUnrecognizedUnionMembers: true,
|
|
801
|
+
allowUnrecognizedEnumValues: true,
|
|
802
|
+
skipValidation: true,
|
|
803
|
+
breadcrumbsPrefix: ["response"],
|
|
804
|
+
})),
|
|
805
|
+
rawResponse: _response.rawResponse,
|
|
806
|
+
},
|
|
807
|
+
rawResponse: _response.rawResponse,
|
|
808
|
+
};
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
return {
|
|
812
|
+
data: {
|
|
813
|
+
ok: false,
|
|
814
|
+
error: FernVenusApi.organization.setDocsUrl.Error._unknown(_response.error),
|
|
815
|
+
rawResponse: _response.rawResponse,
|
|
816
|
+
},
|
|
817
|
+
rawResponse: _response.rawResponse,
|
|
818
|
+
};
|
|
819
|
+
});
|
|
820
|
+
}
|
|
660
821
|
/**
|
|
661
822
|
* Redeems a claim link. The caller, signed in as the Postman user the link
|
|
662
823
|
* is for, becomes the admin of the organization. The first claim wins, and
|
|
@@ -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.organization.getPostmanTeamDocs.Error.UnprocessableEntityError | FernVenusApi.organization.getPostmanTeamDocs.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.organization.getPostmanTeamDocs.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.organization.getPostmanTeamDocs.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.getPostmanTeamDocs.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.getPostmanTeamDocs.Error, visitor: FernVenusApi.organization.getPostmanTeamDocs.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.organization.getPostmanTeamDocs.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.organization.getPostmanTeamDocs.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
|
+
};
|
|
@@ -8,10 +8,12 @@ export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
|
8
8
|
export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.mjs";
|
|
9
9
|
export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.mjs";
|
|
10
10
|
export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
|
|
11
|
+
export * as getPostmanTeamDocs from "./getPostmanTeamDocs.mjs";
|
|
11
12
|
export * as getPostmanTeamIdByOrgId from "./getPostmanTeamIdByOrgId.mjs";
|
|
12
13
|
export * as inviteUser from "./inviteUser.mjs";
|
|
13
14
|
export * as isMember from "./isMember.mjs";
|
|
14
15
|
export * as previewClaim from "./previewClaim.mjs";
|
|
15
16
|
export * as removeUser from "./removeUser.mjs";
|
|
16
17
|
export * from "./requests/index.mjs";
|
|
18
|
+
export * as setDocsUrl from "./setDocsUrl.mjs";
|
|
17
19
|
export * as update from "./update.mjs";
|
|
@@ -8,10 +8,12 @@ export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
|
8
8
|
export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.mjs";
|
|
9
9
|
export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.mjs";
|
|
10
10
|
export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
|
|
11
|
+
export * as getPostmanTeamDocs from "./getPostmanTeamDocs.mjs";
|
|
11
12
|
export * as getPostmanTeamIdByOrgId from "./getPostmanTeamIdByOrgId.mjs";
|
|
12
13
|
export * as inviteUser from "./inviteUser.mjs";
|
|
13
14
|
export * as isMember from "./isMember.mjs";
|
|
14
15
|
export * as previewClaim from "./previewClaim.mjs";
|
|
15
16
|
export * as removeUser from "./removeUser.mjs";
|
|
16
17
|
export * from "./requests/index.mjs";
|
|
18
|
+
export * as setDocsUrl from "./setDocsUrl.mjs";
|
|
17
19
|
export * as update from "./update.mjs";
|
|
@@ -6,8 +6,10 @@ export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./Ge
|
|
|
6
6
|
export type { GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest } from "./GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest.mjs";
|
|
7
7
|
export type { GetOrganizationsOrgIdGetRequest } from "./GetOrganizationsOrgIdGetRequest.mjs";
|
|
8
8
|
export type { GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest } from "./GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest.mjs";
|
|
9
|
+
export type { GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest } from "./GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.mjs";
|
|
9
10
|
export type { GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest } from "./GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest.mjs";
|
|
10
11
|
export type { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
|
|
11
12
|
export type { IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest } from "./IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest.mjs";
|
|
12
13
|
export type { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
|
|
14
|
+
export type { SetDocsUrlRequest } from "./SetDocsUrlRequest.mjs";
|
|
13
15
|
export type { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.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.organization.setDocsUrl.Error.UnprocessableEntityError | FernVenusApi.organization.setDocsUrl.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.organization.setDocsUrl.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.organization.setDocsUrl.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.setDocsUrl.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.setDocsUrl.Error, visitor: FernVenusApi.organization.setDocsUrl.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.organization.setDocsUrl.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.organization.setDocsUrl.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
|
+
};
|
|
@@ -20,6 +20,7 @@ export * from "./Npm.mjs";
|
|
|
20
20
|
export * from "./NpmRegistryToken.mjs";
|
|
21
21
|
export * from "./Organization.mjs";
|
|
22
22
|
export * from "./OrganizationsPage.mjs";
|
|
23
|
+
export * from "./PostmanTeamDocsResponse.mjs";
|
|
23
24
|
export * from "./Pypi.mjs";
|
|
24
25
|
export * from "./PypiRegistryToken.mjs";
|
|
25
26
|
export * from "./RegistryToken.mjs";
|
|
@@ -20,6 +20,7 @@ export * from "./Npm.mjs";
|
|
|
20
20
|
export * from "./NpmRegistryToken.mjs";
|
|
21
21
|
export * from "./Organization.mjs";
|
|
22
22
|
export * from "./OrganizationsPage.mjs";
|
|
23
|
+
export * from "./PostmanTeamDocsResponse.mjs";
|
|
23
24
|
export * from "./Pypi.mjs";
|
|
24
25
|
export * from "./PypiRegistryToken.mjs";
|
|
25
26
|
export * from "./RegistryToken.mjs";
|
|
@@ -0,0 +1,9 @@
|
|
|
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 SetDocsUrlRequest: core.serialization.Schema<serializers.SetDocsUrlRequest.Raw, Omit<FernVenusApi.SetDocsUrlRequest, "orgId">>;
|
|
5
|
+
export declare namespace SetDocsUrlRequest {
|
|
6
|
+
interface Raw {
|
|
7
|
+
docsUrl: string;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
@@ -3,4 +3,5 @@ export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
|
|
|
3
3
|
export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
4
4
|
export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
|
|
5
5
|
export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
|
|
6
|
+
export { SetDocsUrlRequest } from "./SetDocsUrlRequest.mjs";
|
|
6
7
|
export { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.mjs";
|
|
@@ -3,4 +3,5 @@ export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
|
|
|
3
3
|
export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
4
4
|
export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
|
|
5
5
|
export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
|
|
6
|
+
export { SetDocsUrlRequest } from "./SetDocsUrlRequest.mjs";
|
|
6
7
|
export { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.mjs";
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
import { ClaimStatus } from "./ClaimStatus.mjs";
|
|
5
|
+
export declare const PostmanTeamDocsResponse: core.serialization.ObjectSchema<serializers.PostmanTeamDocsResponse.Raw, FernVenusApi.PostmanTeamDocsResponse>;
|
|
6
|
+
export declare namespace PostmanTeamDocsResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
organizationId: string;
|
|
9
|
+
claimStatus: ClaimStatus.Raw;
|
|
10
|
+
docsUrl: string;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../core/index.mjs";
|
|
3
|
+
import { ClaimStatus } from "./ClaimStatus.mjs";
|
|
4
|
+
export const PostmanTeamDocsResponse = core.serialization.object({
|
|
5
|
+
organizationId: core.serialization.string(),
|
|
6
|
+
claimStatus: ClaimStatus,
|
|
7
|
+
docsUrl: core.serialization.string(),
|
|
8
|
+
});
|
|
@@ -20,6 +20,7 @@ export * from "./Npm.mjs";
|
|
|
20
20
|
export * from "./NpmRegistryToken.mjs";
|
|
21
21
|
export * from "./Organization.mjs";
|
|
22
22
|
export * from "./OrganizationsPage.mjs";
|
|
23
|
+
export * from "./PostmanTeamDocsResponse.mjs";
|
|
23
24
|
export * from "./Pypi.mjs";
|
|
24
25
|
export * from "./PypiRegistryToken.mjs";
|
|
25
26
|
export * from "./RegistryToken.mjs";
|
|
@@ -20,6 +20,7 @@ export * from "./Npm.mjs";
|
|
|
20
20
|
export * from "./NpmRegistryToken.mjs";
|
|
21
21
|
export * from "./Organization.mjs";
|
|
22
22
|
export * from "./OrganizationsPage.mjs";
|
|
23
|
+
export * from "./PostmanTeamDocsResponse.mjs";
|
|
23
24
|
export * from "./Pypi.mjs";
|
|
24
25
|
export * from "./PypiRegistryToken.mjs";
|
|
25
26
|
export * from "./RegistryToken.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.6.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "11.
|
|
1
|
+
export const SDK_VERSION = "11.6.0";
|