@fern-api/venus-api-sdk 11.2.0 → 11.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/organization/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/organization/client/Client.js +85 -0
- package/dist/cjs/api/resources/organization/client/createClaimToken.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/createClaimToken.js +66 -0
- package/dist/cjs/api/resources/organization/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/organization/client/index.js +2 -1
- package/dist/cjs/api/resources/organization/client/requests/CreateClaimTokenRequest.d.ts +11 -0
- package/dist/cjs/api/resources/organization/client/requests/CreateClaimTokenRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/ClaimTokenResponse.d.ts +4 -0
- package/dist/cjs/api/types/ClaimTokenResponse.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/CreateClaimTokenRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/organization/client/requests/CreateClaimTokenRequest.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/ClaimTokenResponse.d.ts +10 -0
- package/dist/cjs/serialization/types/ClaimTokenResponse.js +42 -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 +15 -0
- package/dist/esm/api/resources/organization/client/Client.mjs +85 -0
- package/dist/esm/api/resources/organization/client/createClaimToken.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/createClaimToken.mjs +30 -0
- package/dist/esm/api/resources/organization/client/index.d.mts +1 -0
- package/dist/esm/api/resources/organization/client/index.mjs +1 -0
- package/dist/esm/api/resources/organization/client/requests/CreateClaimTokenRequest.d.mts +11 -0
- package/dist/esm/api/resources/organization/client/requests/CreateClaimTokenRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/ClaimTokenResponse.d.mts +4 -0
- package/dist/esm/api/types/ClaimTokenResponse.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/CreateClaimTokenRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/organization/client/requests/CreateClaimTokenRequest.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/ClaimTokenResponse.d.mts +10 -0
- package/dist/esm/serialization/types/ClaimTokenResponse.mjs +6 -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 +67 -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": "11.
|
|
47
|
-
"User-Agent": "@fern-api/venus-api-sdk/11.
|
|
46
|
+
"X-Fern-SDK-Version": "11.3.0",
|
|
47
|
+
"User-Agent": "@fern-api/venus-api-sdk/11.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);
|
|
@@ -104,6 +104,21 @@ export declare class OrganizationClient {
|
|
|
104
104
|
*/
|
|
105
105
|
getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
|
|
106
106
|
private __getClaimStatus;
|
|
107
|
+
/**
|
|
108
|
+
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
109
|
+
* user and valid for 15 minutes. Only the provisioner token can call it.
|
|
110
|
+
*
|
|
111
|
+
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
112
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* await client.organization.createClaimToken({
|
|
116
|
+
* orgId: "org_id",
|
|
117
|
+
* postmanUserId: "postmanUserId"
|
|
118
|
+
* })
|
|
119
|
+
*/
|
|
120
|
+
createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
|
|
121
|
+
private __createClaimToken;
|
|
107
122
|
/**
|
|
108
123
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
109
124
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -608,6 +608,91 @@ class OrganizationClient {
|
|
|
608
608
|
};
|
|
609
609
|
});
|
|
610
610
|
}
|
|
611
|
+
/**
|
|
612
|
+
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
613
|
+
* user and valid for 15 minutes. Only the provisioner token can call it.
|
|
614
|
+
*
|
|
615
|
+
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
616
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
617
|
+
*
|
|
618
|
+
* @example
|
|
619
|
+
* await client.organization.createClaimToken({
|
|
620
|
+
* orgId: "org_id",
|
|
621
|
+
* postmanUserId: "postmanUserId"
|
|
622
|
+
* })
|
|
623
|
+
*/
|
|
624
|
+
createClaimToken(request, requestOptions) {
|
|
625
|
+
return core.HttpResponsePromise.fromPromise(this.__createClaimToken(request, requestOptions));
|
|
626
|
+
}
|
|
627
|
+
__createClaimToken(request, requestOptions) {
|
|
628
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
629
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
630
|
+
const { orgId } = request, _body = __rest(request, ["orgId"]);
|
|
631
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
632
|
+
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);
|
|
633
|
+
const _response = yield core.fetcher({
|
|
634
|
+
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)}/claim-tokens`),
|
|
635
|
+
method: "POST",
|
|
636
|
+
headers: _headers,
|
|
637
|
+
contentType: "application/json",
|
|
638
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
639
|
+
requestType: "json",
|
|
640
|
+
body: serializers.CreateClaimTokenRequest.jsonOrThrow(_body, {
|
|
641
|
+
unrecognizedObjectKeys: "strip",
|
|
642
|
+
omitUndefined: true,
|
|
643
|
+
}),
|
|
644
|
+
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,
|
|
645
|
+
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,
|
|
646
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
647
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
648
|
+
logging: this._options.logging,
|
|
649
|
+
});
|
|
650
|
+
if (_response.ok) {
|
|
651
|
+
return {
|
|
652
|
+
data: {
|
|
653
|
+
ok: true,
|
|
654
|
+
body: serializers.ClaimTokenResponse.parseOrThrow(_response.body, {
|
|
655
|
+
unrecognizedObjectKeys: "passthrough",
|
|
656
|
+
allowUnrecognizedUnionMembers: true,
|
|
657
|
+
allowUnrecognizedEnumValues: true,
|
|
658
|
+
skipValidation: true,
|
|
659
|
+
breadcrumbsPrefix: ["response"],
|
|
660
|
+
}),
|
|
661
|
+
headers: _response.headers,
|
|
662
|
+
rawResponse: _response.rawResponse,
|
|
663
|
+
},
|
|
664
|
+
rawResponse: _response.rawResponse,
|
|
665
|
+
};
|
|
666
|
+
}
|
|
667
|
+
if (_response.error.reason === "status-code") {
|
|
668
|
+
switch (_response.error.statusCode) {
|
|
669
|
+
case 422:
|
|
670
|
+
return {
|
|
671
|
+
data: {
|
|
672
|
+
ok: false,
|
|
673
|
+
error: FernVenusApi.organization.createClaimToken.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
674
|
+
unrecognizedObjectKeys: "passthrough",
|
|
675
|
+
allowUnrecognizedUnionMembers: true,
|
|
676
|
+
allowUnrecognizedEnumValues: true,
|
|
677
|
+
skipValidation: true,
|
|
678
|
+
breadcrumbsPrefix: ["response"],
|
|
679
|
+
})),
|
|
680
|
+
rawResponse: _response.rawResponse,
|
|
681
|
+
},
|
|
682
|
+
rawResponse: _response.rawResponse,
|
|
683
|
+
};
|
|
684
|
+
}
|
|
685
|
+
}
|
|
686
|
+
return {
|
|
687
|
+
data: {
|
|
688
|
+
ok: false,
|
|
689
|
+
error: FernVenusApi.organization.createClaimToken.Error._unknown(_response.error),
|
|
690
|
+
rawResponse: _response.rawResponse,
|
|
691
|
+
},
|
|
692
|
+
rawResponse: _response.rawResponse,
|
|
693
|
+
};
|
|
694
|
+
});
|
|
695
|
+
}
|
|
611
696
|
/**
|
|
612
697
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
613
698
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -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.organization.createClaimToken.Error.UnprocessableEntityError | FernVenusApi.organization.createClaimToken.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.createClaimToken.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.createClaimToken.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.createClaimToken.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.createClaimToken.Error, visitor: FernVenusApi.organization.createClaimToken.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.organization.createClaimToken.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.organization.createClaimToken.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
|
+
};
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * as addUser from "./addUser.js";
|
|
2
2
|
export * as create from "./create.js";
|
|
3
|
+
export * as createClaimToken from "./createClaimToken.js";
|
|
3
4
|
export * as delete from "./delete.js";
|
|
4
5
|
export * as get from "./get.js";
|
|
5
6
|
export * as getClaimStatus from "./getClaimStatus.js";
|
|
@@ -36,9 +36,10 @@ 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.update = exports.removeUser = exports.isMember = exports.inviteUser = exports.getPostmanTeamIdByOrgId = exports.getOrgIdsFromToken = exports.getOrgIdsByPostmanTeamId = exports.getMyOrganizationFromScopedToken = exports.getClaimStatus = exports.get = exports.delete = exports.create = exports.addUser = void 0;
|
|
39
|
+
exports.update = exports.removeUser = exports.isMember = exports.inviteUser = exports.getPostmanTeamIdByOrgId = exports.getOrgIdsFromToken = exports.getOrgIdsByPostmanTeamId = exports.getMyOrganizationFromScopedToken = exports.getClaimStatus = exports.get = exports.delete = exports.createClaimToken = exports.create = exports.addUser = void 0;
|
|
40
40
|
exports.addUser = __importStar(require("./addUser.js"));
|
|
41
41
|
exports.create = __importStar(require("./create.js"));
|
|
42
|
+
exports.createClaimToken = __importStar(require("./createClaimToken.js"));
|
|
42
43
|
exports.delete = __importStar(require("./delete.js"));
|
|
43
44
|
exports.get = __importStar(require("./get.js"));
|
|
44
45
|
exports.getClaimStatus = __importStar(require("./getClaimStatus.js"));
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { AddUserToOrgRequest } from "./AddUserToOrgRequest.js";
|
|
2
|
+
export type { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.js";
|
|
2
3
|
export type { CreateOrganizationRequest } from "./CreateOrganizationRequest.js";
|
|
3
4
|
export type { DeleteOrganizationsOrgIdDeleteRequest } from "./DeleteOrganizationsOrgIdDeleteRequest.js";
|
|
4
5
|
export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.js";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.js";
|
|
2
2
|
export * from "./ClaimStatus.js";
|
|
3
3
|
export * from "./ClaimStatusResponse.js";
|
|
4
|
+
export * from "./ClaimTokenResponse.js";
|
|
4
5
|
export * from "./CreateOrganizationResponse.js";
|
|
5
6
|
export * from "./CreateTokenResponse.js";
|
|
6
7
|
export * from "./Expired.js";
|
|
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./Active.js"), exports);
|
|
18
18
|
__exportStar(require("./ClaimStatus.js"), exports);
|
|
19
19
|
__exportStar(require("./ClaimStatusResponse.js"), exports);
|
|
20
|
+
__exportStar(require("./ClaimTokenResponse.js"), exports);
|
|
20
21
|
__exportStar(require("./CreateOrganizationResponse.js"), exports);
|
|
21
22
|
__exportStar(require("./CreateTokenResponse.js"), exports);
|
|
22
23
|
__exportStar(require("./Expired.js"), exports);
|
package/dist/cjs/serialization/resources/organization/client/requests/CreateClaimTokenRequest.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
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 CreateClaimTokenRequest: core.serialization.Schema<serializers.CreateClaimTokenRequest.Raw, Omit<FernVenusApi.CreateClaimTokenRequest, "orgId">>;
|
|
5
|
+
export declare namespace CreateClaimTokenRequest {
|
|
6
|
+
interface Raw {
|
|
7
|
+
postmanUserId: string;
|
|
8
|
+
}
|
|
9
|
+
}
|
package/dist/cjs/serialization/resources/organization/client/requests/CreateClaimTokenRequest.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
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.CreateClaimTokenRequest = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../../core/index.js"));
|
|
39
|
+
exports.CreateClaimTokenRequest = core.serialization.object({
|
|
40
|
+
postmanUserId: core.serialization.string(),
|
|
41
|
+
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { AddUserToOrgRequest } from "./AddUserToOrgRequest.js";
|
|
2
|
+
export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.js";
|
|
2
3
|
export { CreateOrganizationRequest } from "./CreateOrganizationRequest.js";
|
|
3
4
|
export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.js";
|
|
4
5
|
export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.js";
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UpdateOrganizationRequest = exports.RemoveUserFromOrgRequest = exports.InviteUserToOrgRequest = exports.CreateOrganizationRequest = exports.AddUserToOrgRequest = void 0;
|
|
3
|
+
exports.UpdateOrganizationRequest = exports.RemoveUserFromOrgRequest = exports.InviteUserToOrgRequest = exports.CreateOrganizationRequest = exports.CreateClaimTokenRequest = exports.AddUserToOrgRequest = void 0;
|
|
4
4
|
var AddUserToOrgRequest_js_1 = require("./AddUserToOrgRequest.js");
|
|
5
5
|
Object.defineProperty(exports, "AddUserToOrgRequest", { enumerable: true, get: function () { return AddUserToOrgRequest_js_1.AddUserToOrgRequest; } });
|
|
6
|
+
var CreateClaimTokenRequest_js_1 = require("./CreateClaimTokenRequest.js");
|
|
7
|
+
Object.defineProperty(exports, "CreateClaimTokenRequest", { enumerable: true, get: function () { return CreateClaimTokenRequest_js_1.CreateClaimTokenRequest; } });
|
|
6
8
|
var CreateOrganizationRequest_js_1 = require("./CreateOrganizationRequest.js");
|
|
7
9
|
Object.defineProperty(exports, "CreateOrganizationRequest", { enumerable: true, get: function () { return CreateOrganizationRequest_js_1.CreateOrganizationRequest; } });
|
|
8
10
|
var InviteUserToOrgRequest_js_1 = require("./InviteUserToOrgRequest.js");
|
|
@@ -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 ClaimTokenResponse: core.serialization.ObjectSchema<serializers.ClaimTokenResponse.Raw, FernVenusApi.ClaimTokenResponse>;
|
|
5
|
+
export declare namespace ClaimTokenResponse {
|
|
6
|
+
interface Raw {
|
|
7
|
+
claimUrl: string;
|
|
8
|
+
expiresAt: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -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.ClaimTokenResponse = void 0;
|
|
38
|
+
const core = __importStar(require("../../core/index.js"));
|
|
39
|
+
exports.ClaimTokenResponse = core.serialization.object({
|
|
40
|
+
claimUrl: core.serialization.string(),
|
|
41
|
+
expiresAt: core.serialization.date(),
|
|
42
|
+
});
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.js";
|
|
2
2
|
export * from "./ClaimStatus.js";
|
|
3
3
|
export * from "./ClaimStatusResponse.js";
|
|
4
|
+
export * from "./ClaimTokenResponse.js";
|
|
4
5
|
export * from "./CreateOrganizationResponse.js";
|
|
5
6
|
export * from "./CreateTokenResponse.js";
|
|
6
7
|
export * from "./Expired.js";
|
|
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./Active.js"), exports);
|
|
18
18
|
__exportStar(require("./ClaimStatus.js"), exports);
|
|
19
19
|
__exportStar(require("./ClaimStatusResponse.js"), exports);
|
|
20
|
+
__exportStar(require("./ClaimTokenResponse.js"), exports);
|
|
20
21
|
__exportStar(require("./CreateOrganizationResponse.js"), exports);
|
|
21
22
|
__exportStar(require("./CreateTokenResponse.js"), exports);
|
|
22
23
|
__exportStar(require("./Expired.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.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": "11.
|
|
10
|
-
"User-Agent": "@fern-api/venus-api-sdk/11.
|
|
9
|
+
"X-Fern-SDK-Version": "11.3.0",
|
|
10
|
+
"User-Agent": "@fern-api/venus-api-sdk/11.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);
|
|
@@ -104,6 +104,21 @@ export declare class OrganizationClient {
|
|
|
104
104
|
*/
|
|
105
105
|
getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
|
|
106
106
|
private __getClaimStatus;
|
|
107
|
+
/**
|
|
108
|
+
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
109
|
+
* user and valid for 15 minutes. Only the provisioner token can call it.
|
|
110
|
+
*
|
|
111
|
+
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
112
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* await client.organization.createClaimToken({
|
|
116
|
+
* orgId: "org_id",
|
|
117
|
+
* postmanUserId: "postmanUserId"
|
|
118
|
+
* })
|
|
119
|
+
*/
|
|
120
|
+
createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
|
|
121
|
+
private __createClaimToken;
|
|
107
122
|
/**
|
|
108
123
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
109
124
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -572,6 +572,91 @@ export class OrganizationClient {
|
|
|
572
572
|
};
|
|
573
573
|
});
|
|
574
574
|
}
|
|
575
|
+
/**
|
|
576
|
+
* Issues a claim link for an unclaimed organization, bound to one Postman
|
|
577
|
+
* user and valid for 15 minutes. Only the provisioner token can call it.
|
|
578
|
+
*
|
|
579
|
+
* @param {FernVenusApi.CreateClaimTokenRequest} request
|
|
580
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
581
|
+
*
|
|
582
|
+
* @example
|
|
583
|
+
* await client.organization.createClaimToken({
|
|
584
|
+
* orgId: "org_id",
|
|
585
|
+
* postmanUserId: "postmanUserId"
|
|
586
|
+
* })
|
|
587
|
+
*/
|
|
588
|
+
createClaimToken(request, requestOptions) {
|
|
589
|
+
return core.HttpResponsePromise.fromPromise(this.__createClaimToken(request, requestOptions));
|
|
590
|
+
}
|
|
591
|
+
__createClaimToken(request, requestOptions) {
|
|
592
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
593
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
594
|
+
const { orgId } = request, _body = __rest(request, ["orgId"]);
|
|
595
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
596
|
+
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);
|
|
597
|
+
const _response = yield core.fetcher({
|
|
598
|
+
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)}/claim-tokens`),
|
|
599
|
+
method: "POST",
|
|
600
|
+
headers: _headers,
|
|
601
|
+
contentType: "application/json",
|
|
602
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
603
|
+
requestType: "json",
|
|
604
|
+
body: serializers.CreateClaimTokenRequest.jsonOrThrow(_body, {
|
|
605
|
+
unrecognizedObjectKeys: "strip",
|
|
606
|
+
omitUndefined: true,
|
|
607
|
+
}),
|
|
608
|
+
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,
|
|
609
|
+
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,
|
|
610
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
611
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
612
|
+
logging: this._options.logging,
|
|
613
|
+
});
|
|
614
|
+
if (_response.ok) {
|
|
615
|
+
return {
|
|
616
|
+
data: {
|
|
617
|
+
ok: true,
|
|
618
|
+
body: serializers.ClaimTokenResponse.parseOrThrow(_response.body, {
|
|
619
|
+
unrecognizedObjectKeys: "passthrough",
|
|
620
|
+
allowUnrecognizedUnionMembers: true,
|
|
621
|
+
allowUnrecognizedEnumValues: true,
|
|
622
|
+
skipValidation: true,
|
|
623
|
+
breadcrumbsPrefix: ["response"],
|
|
624
|
+
}),
|
|
625
|
+
headers: _response.headers,
|
|
626
|
+
rawResponse: _response.rawResponse,
|
|
627
|
+
},
|
|
628
|
+
rawResponse: _response.rawResponse,
|
|
629
|
+
};
|
|
630
|
+
}
|
|
631
|
+
if (_response.error.reason === "status-code") {
|
|
632
|
+
switch (_response.error.statusCode) {
|
|
633
|
+
case 422:
|
|
634
|
+
return {
|
|
635
|
+
data: {
|
|
636
|
+
ok: false,
|
|
637
|
+
error: FernVenusApi.organization.createClaimToken.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
638
|
+
unrecognizedObjectKeys: "passthrough",
|
|
639
|
+
allowUnrecognizedUnionMembers: true,
|
|
640
|
+
allowUnrecognizedEnumValues: true,
|
|
641
|
+
skipValidation: true,
|
|
642
|
+
breadcrumbsPrefix: ["response"],
|
|
643
|
+
})),
|
|
644
|
+
rawResponse: _response.rawResponse,
|
|
645
|
+
},
|
|
646
|
+
rawResponse: _response.rawResponse,
|
|
647
|
+
};
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
return {
|
|
651
|
+
data: {
|
|
652
|
+
ok: false,
|
|
653
|
+
error: FernVenusApi.organization.createClaimToken.Error._unknown(_response.error),
|
|
654
|
+
rawResponse: _response.rawResponse,
|
|
655
|
+
},
|
|
656
|
+
rawResponse: _response.rawResponse,
|
|
657
|
+
};
|
|
658
|
+
});
|
|
659
|
+
}
|
|
575
660
|
/**
|
|
576
661
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
577
662
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -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.createClaimToken.Error.UnprocessableEntityError | FernVenusApi.organization.createClaimToken.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.createClaimToken.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.createClaimToken.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.createClaimToken.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.createClaimToken.Error, visitor: FernVenusApi.organization.createClaimToken.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.createClaimToken.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.createClaimToken.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
|
+
};
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * as addUser from "./addUser.mjs";
|
|
2
2
|
export * as create from "./create.mjs";
|
|
3
|
+
export * as createClaimToken from "./createClaimToken.mjs";
|
|
3
4
|
export * as delete from "./delete.mjs";
|
|
4
5
|
export * as get from "./get.mjs";
|
|
5
6
|
export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * as addUser from "./addUser.mjs";
|
|
2
2
|
export * as create from "./create.mjs";
|
|
3
|
+
export * as createClaimToken from "./createClaimToken.mjs";
|
|
3
4
|
export * as delete from "./delete.mjs";
|
|
4
5
|
export * as get from "./get.mjs";
|
|
5
6
|
export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { AddUserToOrgRequest } from "./AddUserToOrgRequest.mjs";
|
|
2
|
+
export type { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
|
|
2
3
|
export type { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
3
4
|
export type { DeleteOrganizationsOrgIdDeleteRequest } from "./DeleteOrganizationsOrgIdDeleteRequest.mjs";
|
|
4
5
|
export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.mjs";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.mjs";
|
|
2
2
|
export * from "./ClaimStatus.mjs";
|
|
3
3
|
export * from "./ClaimStatusResponse.mjs";
|
|
4
|
+
export * from "./ClaimTokenResponse.mjs";
|
|
4
5
|
export * from "./CreateOrganizationResponse.mjs";
|
|
5
6
|
export * from "./CreateTokenResponse.mjs";
|
|
6
7
|
export * from "./Expired.mjs";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.mjs";
|
|
2
2
|
export * from "./ClaimStatus.mjs";
|
|
3
3
|
export * from "./ClaimStatusResponse.mjs";
|
|
4
|
+
export * from "./ClaimTokenResponse.mjs";
|
|
4
5
|
export * from "./CreateOrganizationResponse.mjs";
|
|
5
6
|
export * from "./CreateTokenResponse.mjs";
|
|
6
7
|
export * from "./Expired.mjs";
|
package/dist/esm/serialization/resources/organization/client/requests/CreateClaimTokenRequest.d.mts
ADDED
|
@@ -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 CreateClaimTokenRequest: core.serialization.Schema<serializers.CreateClaimTokenRequest.Raw, Omit<FernVenusApi.CreateClaimTokenRequest, "orgId">>;
|
|
5
|
+
export declare namespace CreateClaimTokenRequest {
|
|
6
|
+
interface Raw {
|
|
7
|
+
postmanUserId: string;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { AddUserToOrgRequest } from "./AddUserToOrgRequest.mjs";
|
|
2
|
+
export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
|
|
2
3
|
export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
3
4
|
export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
|
|
4
5
|
export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { AddUserToOrgRequest } from "./AddUserToOrgRequest.mjs";
|
|
2
|
+
export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.mjs";
|
|
2
3
|
export { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
3
4
|
export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.mjs";
|
|
4
5
|
export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.mjs";
|
|
@@ -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 ClaimTokenResponse: core.serialization.ObjectSchema<serializers.ClaimTokenResponse.Raw, FernVenusApi.ClaimTokenResponse>;
|
|
5
|
+
export declare namespace ClaimTokenResponse {
|
|
6
|
+
interface Raw {
|
|
7
|
+
claimUrl: string;
|
|
8
|
+
expiresAt: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.mjs";
|
|
2
2
|
export * from "./ClaimStatus.mjs";
|
|
3
3
|
export * from "./ClaimStatusResponse.mjs";
|
|
4
|
+
export * from "./ClaimTokenResponse.mjs";
|
|
4
5
|
export * from "./CreateOrganizationResponse.mjs";
|
|
5
6
|
export * from "./CreateTokenResponse.mjs";
|
|
6
7
|
export * from "./Expired.mjs";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Active.mjs";
|
|
2
2
|
export * from "./ClaimStatus.mjs";
|
|
3
3
|
export * from "./ClaimStatusResponse.mjs";
|
|
4
|
+
export * from "./ClaimTokenResponse.mjs";
|
|
4
5
|
export * from "./CreateOrganizationResponse.mjs";
|
|
5
6
|
export * from "./CreateTokenResponse.mjs";
|
|
6
7
|
export * from "./Expired.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.3.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "11.
|
|
1
|
+
export const SDK_VERSION = "11.3.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1103,6 +1103,73 @@ await client.organization.getClaimStatus({
|
|
|
1103
1103
|
</dl>
|
|
1104
1104
|
|
|
1105
1105
|
|
|
1106
|
+
</dd>
|
|
1107
|
+
</dl>
|
|
1108
|
+
</details>
|
|
1109
|
+
|
|
1110
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">createClaimToken</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error></code></summary>
|
|
1111
|
+
<dl>
|
|
1112
|
+
<dd>
|
|
1113
|
+
|
|
1114
|
+
#### 📝 Description
|
|
1115
|
+
|
|
1116
|
+
<dl>
|
|
1117
|
+
<dd>
|
|
1118
|
+
|
|
1119
|
+
<dl>
|
|
1120
|
+
<dd>
|
|
1121
|
+
|
|
1122
|
+
Issues a claim link for an unclaimed organization, bound to one Postman
|
|
1123
|
+
user and valid for 15 minutes. Only the provisioner token can call it.
|
|
1124
|
+
</dd>
|
|
1125
|
+
</dl>
|
|
1126
|
+
</dd>
|
|
1127
|
+
</dl>
|
|
1128
|
+
|
|
1129
|
+
#### 🔌 Usage
|
|
1130
|
+
|
|
1131
|
+
<dl>
|
|
1132
|
+
<dd>
|
|
1133
|
+
|
|
1134
|
+
<dl>
|
|
1135
|
+
<dd>
|
|
1136
|
+
|
|
1137
|
+
```typescript
|
|
1138
|
+
await client.organization.createClaimToken({
|
|
1139
|
+
orgId: "org_id",
|
|
1140
|
+
postmanUserId: "postmanUserId"
|
|
1141
|
+
});
|
|
1142
|
+
|
|
1143
|
+
```
|
|
1144
|
+
</dd>
|
|
1145
|
+
</dl>
|
|
1146
|
+
</dd>
|
|
1147
|
+
</dl>
|
|
1148
|
+
|
|
1149
|
+
#### ⚙️ Parameters
|
|
1150
|
+
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
<dl>
|
|
1155
|
+
<dd>
|
|
1156
|
+
|
|
1157
|
+
**request:** `FernVenusApi.CreateClaimTokenRequest`
|
|
1158
|
+
|
|
1159
|
+
</dd>
|
|
1160
|
+
</dl>
|
|
1161
|
+
|
|
1162
|
+
<dl>
|
|
1163
|
+
<dd>
|
|
1164
|
+
|
|
1165
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1166
|
+
|
|
1167
|
+
</dd>
|
|
1168
|
+
</dl>
|
|
1169
|
+
</dd>
|
|
1170
|
+
</dl>
|
|
1171
|
+
|
|
1172
|
+
|
|
1106
1173
|
</dd>
|
|
1107
1174
|
</dl>
|
|
1108
1175
|
</details>
|