@fern-api/venus-api-sdk 11.0.0 → 11.1.1
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 +22 -0
- package/dist/cjs/api/resources/organization/client/Client.js +86 -0
- package/dist/cjs/api/resources/organization/client/getClaimStatus.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/getClaimStatus.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/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/ClaimStatus.d.ts +5 -0
- package/dist/cjs/api/types/ClaimStatus.js +8 -0
- package/dist/cjs/api/types/ClaimStatusResponse.d.ts +4 -0
- package/dist/cjs/api/types/ClaimStatusResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- package/dist/cjs/serialization/types/ClaimStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/ClaimStatus.js +39 -0
- package/dist/cjs/serialization/types/ClaimStatusResponse.d.ts +10 -0
- package/dist/cjs/serialization/types/ClaimStatusResponse.js +42 -0
- package/dist/cjs/serialization/types/index.d.ts +2 -0
- package/dist/cjs/serialization/types/index.js +2 -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 +22 -0
- package/dist/esm/api/resources/organization/client/Client.mjs +86 -0
- package/dist/esm/api/resources/organization/client/getClaimStatus.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/getClaimStatus.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/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/ClaimStatus.d.mts +5 -0
- package/dist/esm/api/types/ClaimStatus.mjs +5 -0
- package/dist/esm/api/types/ClaimStatusResponse.d.mts +4 -0
- package/dist/esm/api/types/ClaimStatusResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/serialization/types/ClaimStatus.d.mts +7 -0
- package/dist/esm/serialization/types/ClaimStatus.mjs +3 -0
- package/dist/esm/serialization/types/ClaimStatusResponse.d.mts +10 -0
- package/dist/esm/serialization/types/ClaimStatusResponse.mjs +6 -0
- package/dist/esm/serialization/types/index.d.mts +2 -0
- package/dist/esm/serialization/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +86 -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.1.1",
|
|
47
|
+
"User-Agent": "@fern-api/venus-api-sdk/11.1.1",
|
|
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);
|
|
@@ -11,6 +11,13 @@ export declare class OrganizationClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
|
|
12
12
|
constructor(options: OrganizationClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* Creates an organization with the caller as its admin. Called with the
|
|
15
|
+
* provisioner token, it instead creates an unclaimed organization, with no
|
|
16
|
+
* Auth0 organization or members, linked to the required postmanTeamId.
|
|
17
|
+
* Creating it again for the same team returns the same organization.
|
|
18
|
+
* A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
19
|
+
* organization, since that team claims its organization through Postman.
|
|
20
|
+
*
|
|
14
21
|
* @param {FernVenusApi.CreateOrganizationRequest} request
|
|
15
22
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
23
|
*
|
|
@@ -82,6 +89,21 @@ export declare class OrganizationClient {
|
|
|
82
89
|
*/
|
|
83
90
|
getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
|
|
84
91
|
private __getPostmanTeamIdByOrgId;
|
|
92
|
+
/**
|
|
93
|
+
* Whether a claimable organization has been claimed. Public, so a docs
|
|
94
|
+
* site can show a claim banner to signed-out visitors. Organizations
|
|
95
|
+
* that were never claimable return 404.
|
|
96
|
+
*
|
|
97
|
+
* @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
|
|
98
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* await client.organization.getClaimStatus({
|
|
102
|
+
* orgId: "org_id"
|
|
103
|
+
* })
|
|
104
|
+
*/
|
|
105
|
+
getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
|
|
106
|
+
private __getClaimStatus;
|
|
85
107
|
/**
|
|
86
108
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
87
109
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -65,6 +65,13 @@ class OrganizationClient {
|
|
|
65
65
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
+
* Creates an organization with the caller as its admin. Called with the
|
|
69
|
+
* provisioner token, it instead creates an unclaimed organization, with no
|
|
70
|
+
* Auth0 organization or members, linked to the required postmanTeamId.
|
|
71
|
+
* Creating it again for the same team returns the same organization.
|
|
72
|
+
* A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
73
|
+
* organization, since that team claims its organization through Postman.
|
|
74
|
+
*
|
|
68
75
|
* @param {FernVenusApi.CreateOrganizationRequest} request
|
|
69
76
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
70
77
|
*
|
|
@@ -522,6 +529,85 @@ class OrganizationClient {
|
|
|
522
529
|
};
|
|
523
530
|
});
|
|
524
531
|
}
|
|
532
|
+
/**
|
|
533
|
+
* Whether a claimable organization has been claimed. Public, so a docs
|
|
534
|
+
* site can show a claim banner to signed-out visitors. Organizations
|
|
535
|
+
* that were never claimable return 404.
|
|
536
|
+
*
|
|
537
|
+
* @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
|
|
538
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
539
|
+
*
|
|
540
|
+
* @example
|
|
541
|
+
* await client.organization.getClaimStatus({
|
|
542
|
+
* orgId: "org_id"
|
|
543
|
+
* })
|
|
544
|
+
*/
|
|
545
|
+
getClaimStatus(request, requestOptions) {
|
|
546
|
+
return core.HttpResponsePromise.fromPromise(this.__getClaimStatus(request, requestOptions));
|
|
547
|
+
}
|
|
548
|
+
__getClaimStatus(request, requestOptions) {
|
|
549
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
550
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
551
|
+
const { orgId } = request;
|
|
552
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
553
|
+
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);
|
|
554
|
+
const _response = yield core.fetcher({
|
|
555
|
+
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-status`),
|
|
556
|
+
method: "GET",
|
|
557
|
+
headers: _headers,
|
|
558
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
559
|
+
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,
|
|
560
|
+
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,
|
|
561
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
562
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
563
|
+
logging: this._options.logging,
|
|
564
|
+
});
|
|
565
|
+
if (_response.ok) {
|
|
566
|
+
return {
|
|
567
|
+
data: {
|
|
568
|
+
ok: true,
|
|
569
|
+
body: serializers.ClaimStatusResponse.parseOrThrow(_response.body, {
|
|
570
|
+
unrecognizedObjectKeys: "passthrough",
|
|
571
|
+
allowUnrecognizedUnionMembers: true,
|
|
572
|
+
allowUnrecognizedEnumValues: true,
|
|
573
|
+
skipValidation: true,
|
|
574
|
+
breadcrumbsPrefix: ["response"],
|
|
575
|
+
}),
|
|
576
|
+
headers: _response.headers,
|
|
577
|
+
rawResponse: _response.rawResponse,
|
|
578
|
+
},
|
|
579
|
+
rawResponse: _response.rawResponse,
|
|
580
|
+
};
|
|
581
|
+
}
|
|
582
|
+
if (_response.error.reason === "status-code") {
|
|
583
|
+
switch (_response.error.statusCode) {
|
|
584
|
+
case 422:
|
|
585
|
+
return {
|
|
586
|
+
data: {
|
|
587
|
+
ok: false,
|
|
588
|
+
error: FernVenusApi.organization.getClaimStatus.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
589
|
+
unrecognizedObjectKeys: "passthrough",
|
|
590
|
+
allowUnrecognizedUnionMembers: true,
|
|
591
|
+
allowUnrecognizedEnumValues: true,
|
|
592
|
+
skipValidation: true,
|
|
593
|
+
breadcrumbsPrefix: ["response"],
|
|
594
|
+
})),
|
|
595
|
+
rawResponse: _response.rawResponse,
|
|
596
|
+
},
|
|
597
|
+
rawResponse: _response.rawResponse,
|
|
598
|
+
};
|
|
599
|
+
}
|
|
600
|
+
}
|
|
601
|
+
return {
|
|
602
|
+
data: {
|
|
603
|
+
ok: false,
|
|
604
|
+
error: FernVenusApi.organization.getClaimStatus.Error._unknown(_response.error),
|
|
605
|
+
rawResponse: _response.rawResponse,
|
|
606
|
+
},
|
|
607
|
+
rawResponse: _response.rawResponse,
|
|
608
|
+
};
|
|
609
|
+
});
|
|
610
|
+
}
|
|
525
611
|
/**
|
|
526
612
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
527
613
|
* @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.getClaimStatus.Error.UnprocessableEntityError | FernVenusApi.organization.getClaimStatus.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.getClaimStatus.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.getClaimStatus.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.getClaimStatus.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.getClaimStatus.Error, visitor: FernVenusApi.organization.getClaimStatus.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.getClaimStatus.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.getClaimStatus.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
|
+
};
|
|
@@ -2,6 +2,7 @@ export * as addUser from "./addUser.js";
|
|
|
2
2
|
export * as create from "./create.js";
|
|
3
3
|
export * as delete from "./delete.js";
|
|
4
4
|
export * as get from "./get.js";
|
|
5
|
+
export * as getClaimStatus from "./getClaimStatus.js";
|
|
5
6
|
export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.js";
|
|
6
7
|
export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.js";
|
|
7
8
|
export * as getOrgIdsFromToken from "./getOrgIdsFromToken.js";
|
|
@@ -36,11 +36,12 @@ 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.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.create = exports.addUser = void 0;
|
|
40
40
|
exports.addUser = __importStar(require("./addUser.js"));
|
|
41
41
|
exports.create = __importStar(require("./create.js"));
|
|
42
42
|
exports.delete = __importStar(require("./delete.js"));
|
|
43
43
|
exports.get = __importStar(require("./get.js"));
|
|
44
|
+
exports.getClaimStatus = __importStar(require("./getClaimStatus.js"));
|
|
44
45
|
exports.getMyOrganizationFromScopedToken = __importStar(require("./getMyOrganizationFromScopedToken.js"));
|
|
45
46
|
exports.getOrgIdsByPostmanTeamId = __importStar(require("./getOrgIdsByPostmanTeamId.js"));
|
|
46
47
|
exports.getOrgIdsFromToken = __importStar(require("./getOrgIdsFromToken.js"));
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export type { AddUserToOrgRequest } from "./AddUserToOrgRequest.js";
|
|
2
2
|
export type { CreateOrganizationRequest } from "./CreateOrganizationRequest.js";
|
|
3
3
|
export type { DeleteOrganizationsOrgIdDeleteRequest } from "./DeleteOrganizationsOrgIdDeleteRequest.js";
|
|
4
|
+
export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.js";
|
|
4
5
|
export type { GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest } from "./GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest.js";
|
|
5
6
|
export type { GetOrganizationsOrgIdGetRequest } from "./GetOrganizationsOrgIdGetRequest.js";
|
|
6
7
|
export type { GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest } from "./GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest.js";
|
|
@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./Active.js"), exports);
|
|
18
|
+
__exportStar(require("./ClaimStatus.js"), exports);
|
|
19
|
+
__exportStar(require("./ClaimStatusResponse.js"), exports);
|
|
18
20
|
__exportStar(require("./CreateOrganizationResponse.js"), exports);
|
|
19
21
|
__exportStar(require("./CreateTokenResponse.js"), exports);
|
|
20
22
|
__exportStar(require("./Expired.js"), exports);
|
|
@@ -0,0 +1,7 @@
|
|
|
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 ClaimStatus: core.serialization.Schema<serializers.ClaimStatus.Raw, FernVenusApi.ClaimStatus>;
|
|
5
|
+
export declare namespace ClaimStatus {
|
|
6
|
+
type Raw = "unclaimed" | "claimed";
|
|
7
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
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.ClaimStatus = void 0;
|
|
38
|
+
const core = __importStar(require("../../core/index.js"));
|
|
39
|
+
exports.ClaimStatus = core.serialization.enum_(["unclaimed", "claimed"]);
|
|
@@ -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
|
+
import { ClaimStatus } from "./ClaimStatus.js";
|
|
5
|
+
export declare const ClaimStatusResponse: core.serialization.ObjectSchema<serializers.ClaimStatusResponse.Raw, FernVenusApi.ClaimStatusResponse>;
|
|
6
|
+
export declare namespace ClaimStatusResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
claimStatus: ClaimStatus.Raw;
|
|
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.ClaimStatusResponse = void 0;
|
|
38
|
+
const core = __importStar(require("../../core/index.js"));
|
|
39
|
+
const ClaimStatus_js_1 = require("./ClaimStatus.js");
|
|
40
|
+
exports.ClaimStatusResponse = core.serialization.object({
|
|
41
|
+
claimStatus: ClaimStatus_js_1.ClaimStatus,
|
|
42
|
+
});
|
|
@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./Active.js"), exports);
|
|
18
|
+
__exportStar(require("./ClaimStatus.js"), exports);
|
|
19
|
+
__exportStar(require("./ClaimStatusResponse.js"), exports);
|
|
18
20
|
__exportStar(require("./CreateOrganizationResponse.js"), exports);
|
|
19
21
|
__exportStar(require("./CreateTokenResponse.js"), exports);
|
|
20
22
|
__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.1.1";
|
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.1.1",
|
|
10
|
+
"User-Agent": "@fern-api/venus-api-sdk/11.1.1",
|
|
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);
|
|
@@ -11,6 +11,13 @@ export declare class OrganizationClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
|
|
12
12
|
constructor(options: OrganizationClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* Creates an organization with the caller as its admin. Called with the
|
|
15
|
+
* provisioner token, it instead creates an unclaimed organization, with no
|
|
16
|
+
* Auth0 organization or members, linked to the required postmanTeamId.
|
|
17
|
+
* Creating it again for the same team returns the same organization.
|
|
18
|
+
* A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
19
|
+
* organization, since that team claims its organization through Postman.
|
|
20
|
+
*
|
|
14
21
|
* @param {FernVenusApi.CreateOrganizationRequest} request
|
|
15
22
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
23
|
*
|
|
@@ -82,6 +89,21 @@ export declare class OrganizationClient {
|
|
|
82
89
|
*/
|
|
83
90
|
getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
|
|
84
91
|
private __getPostmanTeamIdByOrgId;
|
|
92
|
+
/**
|
|
93
|
+
* Whether a claimable organization has been claimed. Public, so a docs
|
|
94
|
+
* site can show a claim banner to signed-out visitors. Organizations
|
|
95
|
+
* that were never claimable return 404.
|
|
96
|
+
*
|
|
97
|
+
* @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
|
|
98
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* await client.organization.getClaimStatus({
|
|
102
|
+
* orgId: "org_id"
|
|
103
|
+
* })
|
|
104
|
+
*/
|
|
105
|
+
getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
|
|
106
|
+
private __getClaimStatus;
|
|
85
107
|
/**
|
|
86
108
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
87
109
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -29,6 +29,13 @@ export class OrganizationClient {
|
|
|
29
29
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
+
* Creates an organization with the caller as its admin. Called with the
|
|
33
|
+
* provisioner token, it instead creates an unclaimed organization, with no
|
|
34
|
+
* Auth0 organization or members, linked to the required postmanTeamId.
|
|
35
|
+
* Creating it again for the same team returns the same organization.
|
|
36
|
+
* A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
37
|
+
* organization, since that team claims its organization through Postman.
|
|
38
|
+
*
|
|
32
39
|
* @param {FernVenusApi.CreateOrganizationRequest} request
|
|
33
40
|
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
34
41
|
*
|
|
@@ -486,6 +493,85 @@ export class OrganizationClient {
|
|
|
486
493
|
};
|
|
487
494
|
});
|
|
488
495
|
}
|
|
496
|
+
/**
|
|
497
|
+
* Whether a claimable organization has been claimed. Public, so a docs
|
|
498
|
+
* site can show a claim banner to signed-out visitors. Organizations
|
|
499
|
+
* that were never claimable return 404.
|
|
500
|
+
*
|
|
501
|
+
* @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
|
|
502
|
+
* @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
503
|
+
*
|
|
504
|
+
* @example
|
|
505
|
+
* await client.organization.getClaimStatus({
|
|
506
|
+
* orgId: "org_id"
|
|
507
|
+
* })
|
|
508
|
+
*/
|
|
509
|
+
getClaimStatus(request, requestOptions) {
|
|
510
|
+
return core.HttpResponsePromise.fromPromise(this.__getClaimStatus(request, requestOptions));
|
|
511
|
+
}
|
|
512
|
+
__getClaimStatus(request, requestOptions) {
|
|
513
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
514
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
515
|
+
const { orgId } = request;
|
|
516
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
517
|
+
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);
|
|
518
|
+
const _response = yield core.fetcher({
|
|
519
|
+
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-status`),
|
|
520
|
+
method: "GET",
|
|
521
|
+
headers: _headers,
|
|
522
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
523
|
+
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,
|
|
524
|
+
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,
|
|
525
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
526
|
+
fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
|
|
527
|
+
logging: this._options.logging,
|
|
528
|
+
});
|
|
529
|
+
if (_response.ok) {
|
|
530
|
+
return {
|
|
531
|
+
data: {
|
|
532
|
+
ok: true,
|
|
533
|
+
body: serializers.ClaimStatusResponse.parseOrThrow(_response.body, {
|
|
534
|
+
unrecognizedObjectKeys: "passthrough",
|
|
535
|
+
allowUnrecognizedUnionMembers: true,
|
|
536
|
+
allowUnrecognizedEnumValues: true,
|
|
537
|
+
skipValidation: true,
|
|
538
|
+
breadcrumbsPrefix: ["response"],
|
|
539
|
+
}),
|
|
540
|
+
headers: _response.headers,
|
|
541
|
+
rawResponse: _response.rawResponse,
|
|
542
|
+
},
|
|
543
|
+
rawResponse: _response.rawResponse,
|
|
544
|
+
};
|
|
545
|
+
}
|
|
546
|
+
if (_response.error.reason === "status-code") {
|
|
547
|
+
switch (_response.error.statusCode) {
|
|
548
|
+
case 422:
|
|
549
|
+
return {
|
|
550
|
+
data: {
|
|
551
|
+
ok: false,
|
|
552
|
+
error: FernVenusApi.organization.getClaimStatus.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
|
|
553
|
+
unrecognizedObjectKeys: "passthrough",
|
|
554
|
+
allowUnrecognizedUnionMembers: true,
|
|
555
|
+
allowUnrecognizedEnumValues: true,
|
|
556
|
+
skipValidation: true,
|
|
557
|
+
breadcrumbsPrefix: ["response"],
|
|
558
|
+
})),
|
|
559
|
+
rawResponse: _response.rawResponse,
|
|
560
|
+
},
|
|
561
|
+
rawResponse: _response.rawResponse,
|
|
562
|
+
};
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
return {
|
|
566
|
+
data: {
|
|
567
|
+
ok: false,
|
|
568
|
+
error: FernVenusApi.organization.getClaimStatus.Error._unknown(_response.error),
|
|
569
|
+
rawResponse: _response.rawResponse,
|
|
570
|
+
},
|
|
571
|
+
rawResponse: _response.rawResponse,
|
|
572
|
+
};
|
|
573
|
+
});
|
|
574
|
+
}
|
|
489
575
|
/**
|
|
490
576
|
* @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
|
|
491
577
|
* @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.getClaimStatus.Error.UnprocessableEntityError | FernVenusApi.organization.getClaimStatus.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.getClaimStatus.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.getClaimStatus.Error.UnprocessableEntityError;
|
|
23
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.getClaimStatus.Error._Unknown;
|
|
24
|
+
readonly _visit: <_Result>(value: FernVenusApi.organization.getClaimStatus.Error, visitor: FernVenusApi.organization.getClaimStatus.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.getClaimStatus.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.getClaimStatus.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
|
+
};
|
|
@@ -2,6 +2,7 @@ export * as addUser from "./addUser.mjs";
|
|
|
2
2
|
export * as create from "./create.mjs";
|
|
3
3
|
export * as delete from "./delete.mjs";
|
|
4
4
|
export * as get from "./get.mjs";
|
|
5
|
+
export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
5
6
|
export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.mjs";
|
|
6
7
|
export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.mjs";
|
|
7
8
|
export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
|
|
@@ -2,6 +2,7 @@ export * as addUser from "./addUser.mjs";
|
|
|
2
2
|
export * as create from "./create.mjs";
|
|
3
3
|
export * as delete from "./delete.mjs";
|
|
4
4
|
export * as get from "./get.mjs";
|
|
5
|
+
export * as getClaimStatus from "./getClaimStatus.mjs";
|
|
5
6
|
export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.mjs";
|
|
6
7
|
export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.mjs";
|
|
7
8
|
export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export type { AddUserToOrgRequest } from "./AddUserToOrgRequest.mjs";
|
|
2
2
|
export type { CreateOrganizationRequest } from "./CreateOrganizationRequest.mjs";
|
|
3
3
|
export type { DeleteOrganizationsOrgIdDeleteRequest } from "./DeleteOrganizationsOrgIdDeleteRequest.mjs";
|
|
4
|
+
export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.mjs";
|
|
4
5
|
export type { GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest } from "./GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest.mjs";
|
|
5
6
|
export type { GetOrganizationsOrgIdGetRequest } from "./GetOrganizationsOrgIdGetRequest.mjs";
|
|
6
7
|
export type { GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest } from "./GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest.mjs";
|
|
@@ -0,0 +1,7 @@
|
|
|
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 ClaimStatus: core.serialization.Schema<serializers.ClaimStatus.Raw, FernVenusApi.ClaimStatus>;
|
|
5
|
+
export declare namespace ClaimStatus {
|
|
6
|
+
type Raw = "unclaimed" | "claimed";
|
|
7
|
+
}
|
|
@@ -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
|
+
import { ClaimStatus } from "./ClaimStatus.mjs";
|
|
5
|
+
export declare const ClaimStatusResponse: core.serialization.ObjectSchema<serializers.ClaimStatusResponse.Raw, FernVenusApi.ClaimStatusResponse>;
|
|
6
|
+
export declare namespace ClaimStatusResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
claimStatus: ClaimStatus.Raw;
|
|
9
|
+
}
|
|
10
|
+
}
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "11.
|
|
1
|
+
export declare const SDK_VERSION = "11.1.1";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "11.
|
|
1
|
+
export const SDK_VERSION = "11.1.1";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -657,6 +657,25 @@ await client.auth.getJwt({
|
|
|
657
657
|
<dl>
|
|
658
658
|
<dd>
|
|
659
659
|
|
|
660
|
+
#### 📝 Description
|
|
661
|
+
|
|
662
|
+
<dl>
|
|
663
|
+
<dd>
|
|
664
|
+
|
|
665
|
+
<dl>
|
|
666
|
+
<dd>
|
|
667
|
+
|
|
668
|
+
Creates an organization with the caller as its admin. Called with the
|
|
669
|
+
provisioner token, it instead creates an unclaimed organization, with no
|
|
670
|
+
Auth0 organization or members, linked to the required postmanTeamId.
|
|
671
|
+
Creating it again for the same team returns the same organization.
|
|
672
|
+
A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
673
|
+
organization, since that team claims its organization through Postman.
|
|
674
|
+
</dd>
|
|
675
|
+
</dl>
|
|
676
|
+
</dd>
|
|
677
|
+
</dl>
|
|
678
|
+
|
|
660
679
|
#### 🔌 Usage
|
|
661
680
|
|
|
662
681
|
<dl>
|
|
@@ -997,6 +1016,73 @@ await client.organization.getPostmanTeamIdByOrgId({
|
|
|
997
1016
|
</dl>
|
|
998
1017
|
|
|
999
1018
|
|
|
1019
|
+
</dd>
|
|
1020
|
+
</dl>
|
|
1021
|
+
</details>
|
|
1022
|
+
|
|
1023
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getClaimStatus</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error></code></summary>
|
|
1024
|
+
<dl>
|
|
1025
|
+
<dd>
|
|
1026
|
+
|
|
1027
|
+
#### 📝 Description
|
|
1028
|
+
|
|
1029
|
+
<dl>
|
|
1030
|
+
<dd>
|
|
1031
|
+
|
|
1032
|
+
<dl>
|
|
1033
|
+
<dd>
|
|
1034
|
+
|
|
1035
|
+
Whether a claimable organization has been claimed. Public, so a docs
|
|
1036
|
+
site can show a claim banner to signed-out visitors. Organizations
|
|
1037
|
+
that were never claimable return 404.
|
|
1038
|
+
</dd>
|
|
1039
|
+
</dl>
|
|
1040
|
+
</dd>
|
|
1041
|
+
</dl>
|
|
1042
|
+
|
|
1043
|
+
#### 🔌 Usage
|
|
1044
|
+
|
|
1045
|
+
<dl>
|
|
1046
|
+
<dd>
|
|
1047
|
+
|
|
1048
|
+
<dl>
|
|
1049
|
+
<dd>
|
|
1050
|
+
|
|
1051
|
+
```typescript
|
|
1052
|
+
await client.organization.getClaimStatus({
|
|
1053
|
+
orgId: "org_id"
|
|
1054
|
+
});
|
|
1055
|
+
|
|
1056
|
+
```
|
|
1057
|
+
</dd>
|
|
1058
|
+
</dl>
|
|
1059
|
+
</dd>
|
|
1060
|
+
</dl>
|
|
1061
|
+
|
|
1062
|
+
#### ⚙️ Parameters
|
|
1063
|
+
|
|
1064
|
+
<dl>
|
|
1065
|
+
<dd>
|
|
1066
|
+
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
**request:** `FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest`
|
|
1071
|
+
|
|
1072
|
+
</dd>
|
|
1073
|
+
</dl>
|
|
1074
|
+
|
|
1075
|
+
<dl>
|
|
1076
|
+
<dd>
|
|
1077
|
+
|
|
1078
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1079
|
+
|
|
1080
|
+
</dd>
|
|
1081
|
+
</dl>
|
|
1082
|
+
</dd>
|
|
1083
|
+
</dl>
|
|
1084
|
+
|
|
1085
|
+
|
|
1000
1086
|
</dd>
|
|
1001
1087
|
</dl>
|
|
1002
1088
|
</details>
|