@fern-api/venus-api-sdk 11.0.0 → 11.1.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.
Files changed (50) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/organization/client/Client.d.ts +15 -0
  3. package/dist/cjs/api/resources/organization/client/Client.js +79 -0
  4. package/dist/cjs/api/resources/organization/client/getClaimStatus.d.ts +25 -0
  5. package/dist/cjs/api/resources/organization/client/getClaimStatus.js +66 -0
  6. package/dist/cjs/api/resources/organization/client/index.d.ts +1 -0
  7. package/dist/cjs/api/resources/organization/client/index.js +2 -1
  8. package/dist/cjs/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.ts +9 -0
  9. package/dist/cjs/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.js +3 -0
  10. package/dist/cjs/api/resources/organization/client/requests/index.d.ts +1 -0
  11. package/dist/cjs/api/types/ClaimStatus.d.ts +5 -0
  12. package/dist/cjs/api/types/ClaimStatus.js +8 -0
  13. package/dist/cjs/api/types/ClaimStatusResponse.d.ts +4 -0
  14. package/dist/cjs/api/types/ClaimStatusResponse.js +3 -0
  15. package/dist/cjs/api/types/index.d.ts +2 -0
  16. package/dist/cjs/api/types/index.js +2 -0
  17. package/dist/cjs/serialization/types/ClaimStatus.d.ts +7 -0
  18. package/dist/cjs/serialization/types/ClaimStatus.js +39 -0
  19. package/dist/cjs/serialization/types/ClaimStatusResponse.d.ts +10 -0
  20. package/dist/cjs/serialization/types/ClaimStatusResponse.js +42 -0
  21. package/dist/cjs/serialization/types/index.d.ts +2 -0
  22. package/dist/cjs/serialization/types/index.js +2 -0
  23. package/dist/cjs/version.d.ts +1 -1
  24. package/dist/cjs/version.js +1 -1
  25. package/dist/esm/BaseClient.mjs +2 -2
  26. package/dist/esm/api/resources/organization/client/Client.d.mts +15 -0
  27. package/dist/esm/api/resources/organization/client/Client.mjs +79 -0
  28. package/dist/esm/api/resources/organization/client/getClaimStatus.d.mts +25 -0
  29. package/dist/esm/api/resources/organization/client/getClaimStatus.mjs +30 -0
  30. package/dist/esm/api/resources/organization/client/index.d.mts +1 -0
  31. package/dist/esm/api/resources/organization/client/index.mjs +1 -0
  32. package/dist/esm/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.mts +9 -0
  33. package/dist/esm/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.mjs +2 -0
  34. package/dist/esm/api/resources/organization/client/requests/index.d.mts +1 -0
  35. package/dist/esm/api/types/ClaimStatus.d.mts +5 -0
  36. package/dist/esm/api/types/ClaimStatus.mjs +5 -0
  37. package/dist/esm/api/types/ClaimStatusResponse.d.mts +4 -0
  38. package/dist/esm/api/types/ClaimStatusResponse.mjs +2 -0
  39. package/dist/esm/api/types/index.d.mts +2 -0
  40. package/dist/esm/api/types/index.mjs +2 -0
  41. package/dist/esm/serialization/types/ClaimStatus.d.mts +7 -0
  42. package/dist/esm/serialization/types/ClaimStatus.mjs +3 -0
  43. package/dist/esm/serialization/types/ClaimStatusResponse.d.mts +10 -0
  44. package/dist/esm/serialization/types/ClaimStatusResponse.mjs +6 -0
  45. package/dist/esm/serialization/types/index.d.mts +2 -0
  46. package/dist/esm/serialization/types/index.mjs +2 -0
  47. package/dist/esm/version.d.mts +1 -1
  48. package/dist/esm/version.mjs +1 -1
  49. package/package.json +1 -1
  50. package/reference.md +67 -0
@@ -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.0.0",
47
- "User-Agent": "@fern-api/venus-api-sdk/11.0.0",
46
+ "X-Fern-SDK-Version": "11.1.0",
47
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.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);
@@ -82,6 +82,21 @@ export declare class OrganizationClient {
82
82
  */
83
83
  getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
84
84
  private __getPostmanTeamIdByOrgId;
85
+ /**
86
+ * Whether a claimable organization has been claimed. Public, so a docs
87
+ * site can show a claim banner to signed-out visitors. Organizations
88
+ * that were never claimable return 404.
89
+ *
90
+ * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
91
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
92
+ *
93
+ * @example
94
+ * await client.organization.getClaimStatus({
95
+ * orgId: "org_id"
96
+ * })
97
+ */
98
+ getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
99
+ private __getClaimStatus;
85
100
  /**
86
101
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
87
102
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -522,6 +522,85 @@ class OrganizationClient {
522
522
  };
523
523
  });
524
524
  }
525
+ /**
526
+ * Whether a claimable organization has been claimed. Public, so a docs
527
+ * site can show a claim banner to signed-out visitors. Organizations
528
+ * that were never claimable return 404.
529
+ *
530
+ * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
531
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
532
+ *
533
+ * @example
534
+ * await client.organization.getClaimStatus({
535
+ * orgId: "org_id"
536
+ * })
537
+ */
538
+ getClaimStatus(request, requestOptions) {
539
+ return core.HttpResponsePromise.fromPromise(this.__getClaimStatus(request, requestOptions));
540
+ }
541
+ __getClaimStatus(request, requestOptions) {
542
+ return __awaiter(this, void 0, void 0, function* () {
543
+ var _a, _b, _c, _d, _e, _f, _g, _h;
544
+ const { orgId } = request;
545
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
546
+ 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);
547
+ const _response = yield core.fetcher({
548
+ 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`),
549
+ method: "GET",
550
+ headers: _headers,
551
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
552
+ 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,
553
+ 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,
554
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
555
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
556
+ logging: this._options.logging,
557
+ });
558
+ if (_response.ok) {
559
+ return {
560
+ data: {
561
+ ok: true,
562
+ body: serializers.ClaimStatusResponse.parseOrThrow(_response.body, {
563
+ unrecognizedObjectKeys: "passthrough",
564
+ allowUnrecognizedUnionMembers: true,
565
+ allowUnrecognizedEnumValues: true,
566
+ skipValidation: true,
567
+ breadcrumbsPrefix: ["response"],
568
+ }),
569
+ headers: _response.headers,
570
+ rawResponse: _response.rawResponse,
571
+ },
572
+ rawResponse: _response.rawResponse,
573
+ };
574
+ }
575
+ if (_response.error.reason === "status-code") {
576
+ switch (_response.error.statusCode) {
577
+ case 422:
578
+ return {
579
+ data: {
580
+ ok: false,
581
+ error: FernVenusApi.organization.getClaimStatus.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
582
+ unrecognizedObjectKeys: "passthrough",
583
+ allowUnrecognizedUnionMembers: true,
584
+ allowUnrecognizedEnumValues: true,
585
+ skipValidation: true,
586
+ breadcrumbsPrefix: ["response"],
587
+ })),
588
+ rawResponse: _response.rawResponse,
589
+ },
590
+ rawResponse: _response.rawResponse,
591
+ };
592
+ }
593
+ }
594
+ return {
595
+ data: {
596
+ ok: false,
597
+ error: FernVenusApi.organization.getClaimStatus.Error._unknown(_response.error),
598
+ rawResponse: _response.rawResponse,
599
+ },
600
+ rawResponse: _response.rawResponse,
601
+ };
602
+ });
603
+ }
525
604
  /**
526
605
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
527
606
  * @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"));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * orgId: "org_id"
5
+ * }
6
+ */
7
+ export interface GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest {
8
+ orgId: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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";
@@ -0,0 +1,5 @@
1
+ export declare const ClaimStatus: {
2
+ readonly Unclaimed: "unclaimed";
3
+ readonly Claimed: "claimed";
4
+ };
5
+ export type ClaimStatus = (typeof ClaimStatus)[keyof typeof ClaimStatus];
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ClaimStatus = void 0;
5
+ exports.ClaimStatus = {
6
+ Unclaimed: "unclaimed",
7
+ Claimed: "claimed",
8
+ };
@@ -0,0 +1,4 @@
1
+ import type * as FernVenusApi from "../index.js";
2
+ export interface ClaimStatusResponse {
3
+ claimStatus: FernVenusApi.ClaimStatus;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.js";
2
+ export * from "./ClaimStatus.js";
3
+ export * from "./ClaimStatusResponse.js";
2
4
  export * from "./CreateOrganizationResponse.js";
3
5
  export * from "./CreateTokenResponse.js";
4
6
  export * from "./Expired.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
+ });
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.js";
2
+ export * from "./ClaimStatus.js";
3
+ export * from "./ClaimStatusResponse.js";
2
4
  export * from "./CreateOrganizationResponse.js";
3
5
  export * from "./CreateTokenResponse.js";
4
6
  export * from "./Expired.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);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.0.0";
1
+ export declare const SDK_VERSION = "11.1.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "11.0.0";
4
+ exports.SDK_VERSION = "11.1.0";
@@ -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.0.0",
10
- "User-Agent": "@fern-api/venus-api-sdk/11.0.0",
9
+ "X-Fern-SDK-Version": "11.1.0",
10
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.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);
@@ -82,6 +82,21 @@ export declare class OrganizationClient {
82
82
  */
83
83
  getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
84
84
  private __getPostmanTeamIdByOrgId;
85
+ /**
86
+ * Whether a claimable organization has been claimed. Public, so a docs
87
+ * site can show a claim banner to signed-out visitors. Organizations
88
+ * that were never claimable return 404.
89
+ *
90
+ * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
91
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
92
+ *
93
+ * @example
94
+ * await client.organization.getClaimStatus({
95
+ * orgId: "org_id"
96
+ * })
97
+ */
98
+ getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
99
+ private __getClaimStatus;
85
100
  /**
86
101
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
87
102
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -486,6 +486,85 @@ export class OrganizationClient {
486
486
  };
487
487
  });
488
488
  }
489
+ /**
490
+ * Whether a claimable organization has been claimed. Public, so a docs
491
+ * site can show a claim banner to signed-out visitors. Organizations
492
+ * that were never claimable return 404.
493
+ *
494
+ * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
495
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
496
+ *
497
+ * @example
498
+ * await client.organization.getClaimStatus({
499
+ * orgId: "org_id"
500
+ * })
501
+ */
502
+ getClaimStatus(request, requestOptions) {
503
+ return core.HttpResponsePromise.fromPromise(this.__getClaimStatus(request, requestOptions));
504
+ }
505
+ __getClaimStatus(request, requestOptions) {
506
+ return __awaiter(this, void 0, void 0, function* () {
507
+ var _a, _b, _c, _d, _e, _f, _g, _h;
508
+ const { orgId } = request;
509
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
510
+ 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);
511
+ const _response = yield core.fetcher({
512
+ 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`),
513
+ method: "GET",
514
+ headers: _headers,
515
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
516
+ 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,
517
+ 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,
518
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
519
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
520
+ logging: this._options.logging,
521
+ });
522
+ if (_response.ok) {
523
+ return {
524
+ data: {
525
+ ok: true,
526
+ body: serializers.ClaimStatusResponse.parseOrThrow(_response.body, {
527
+ unrecognizedObjectKeys: "passthrough",
528
+ allowUnrecognizedUnionMembers: true,
529
+ allowUnrecognizedEnumValues: true,
530
+ skipValidation: true,
531
+ breadcrumbsPrefix: ["response"],
532
+ }),
533
+ headers: _response.headers,
534
+ rawResponse: _response.rawResponse,
535
+ },
536
+ rawResponse: _response.rawResponse,
537
+ };
538
+ }
539
+ if (_response.error.reason === "status-code") {
540
+ switch (_response.error.statusCode) {
541
+ case 422:
542
+ return {
543
+ data: {
544
+ ok: false,
545
+ error: FernVenusApi.organization.getClaimStatus.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
546
+ unrecognizedObjectKeys: "passthrough",
547
+ allowUnrecognizedUnionMembers: true,
548
+ allowUnrecognizedEnumValues: true,
549
+ skipValidation: true,
550
+ breadcrumbsPrefix: ["response"],
551
+ })),
552
+ rawResponse: _response.rawResponse,
553
+ },
554
+ rawResponse: _response.rawResponse,
555
+ };
556
+ }
557
+ }
558
+ return {
559
+ data: {
560
+ ok: false,
561
+ error: FernVenusApi.organization.getClaimStatus.Error._unknown(_response.error),
562
+ rawResponse: _response.rawResponse,
563
+ },
564
+ rawResponse: _response.rawResponse,
565
+ };
566
+ });
567
+ }
489
568
  /**
490
569
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
491
570
  * @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";
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * orgId: "org_id"
5
+ * }
6
+ */
7
+ export interface GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest {
8
+ orgId: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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,5 @@
1
+ export declare const ClaimStatus: {
2
+ readonly Unclaimed: "unclaimed";
3
+ readonly Claimed: "claimed";
4
+ };
5
+ export type ClaimStatus = (typeof ClaimStatus)[keyof typeof ClaimStatus];
@@ -0,0 +1,5 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const ClaimStatus = {
3
+ Unclaimed: "unclaimed",
4
+ Claimed: "claimed",
5
+ };
@@ -0,0 +1,4 @@
1
+ import type * as FernVenusApi from "../index.mjs";
2
+ export interface ClaimStatusResponse {
3
+ claimStatus: FernVenusApi.ClaimStatus;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimStatus.mjs";
3
+ export * from "./ClaimStatusResponse.mjs";
2
4
  export * from "./CreateOrganizationResponse.mjs";
3
5
  export * from "./CreateTokenResponse.mjs";
4
6
  export * from "./Expired.mjs";
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimStatus.mjs";
3
+ export * from "./ClaimStatusResponse.mjs";
2
4
  export * from "./CreateOrganizationResponse.mjs";
3
5
  export * from "./CreateTokenResponse.mjs";
4
6
  export * from "./Expired.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,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.mjs";
3
+ export const ClaimStatus = core.serialization.enum_(["unclaimed", "claimed"]);
@@ -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
+ }
@@ -0,0 +1,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.mjs";
3
+ import { ClaimStatus } from "./ClaimStatus.mjs";
4
+ export const ClaimStatusResponse = core.serialization.object({
5
+ claimStatus: ClaimStatus,
6
+ });
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimStatus.mjs";
3
+ export * from "./ClaimStatusResponse.mjs";
2
4
  export * from "./CreateOrganizationResponse.mjs";
3
5
  export * from "./CreateTokenResponse.mjs";
4
6
  export * from "./Expired.mjs";
@@ -1,4 +1,6 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimStatus.mjs";
3
+ export * from "./ClaimStatusResponse.mjs";
2
4
  export * from "./CreateOrganizationResponse.mjs";
3
5
  export * from "./CreateTokenResponse.mjs";
4
6
  export * from "./Expired.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.0.0";
1
+ export declare const SDK_VERSION = "11.1.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "11.0.0";
1
+ export const SDK_VERSION = "11.1.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fern-api/venus-api-sdk",
3
- "version": "11.0.0",
3
+ "version": "11.1.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -997,6 +997,73 @@ await client.organization.getPostmanTeamIdByOrgId({
997
997
  </dl>
998
998
 
999
999
 
1000
+ </dd>
1001
+ </dl>
1002
+ </details>
1003
+
1004
+ <details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getClaimStatus</a>({ ...params }) -> core.APIResponse&lt;FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error&gt;</code></summary>
1005
+ <dl>
1006
+ <dd>
1007
+
1008
+ #### 📝 Description
1009
+
1010
+ <dl>
1011
+ <dd>
1012
+
1013
+ <dl>
1014
+ <dd>
1015
+
1016
+ Whether a claimable organization has been claimed. Public, so a docs
1017
+ site can show a claim banner to signed-out visitors. Organizations
1018
+ that were never claimable return 404.
1019
+ </dd>
1020
+ </dl>
1021
+ </dd>
1022
+ </dl>
1023
+
1024
+ #### 🔌 Usage
1025
+
1026
+ <dl>
1027
+ <dd>
1028
+
1029
+ <dl>
1030
+ <dd>
1031
+
1032
+ ```typescript
1033
+ await client.organization.getClaimStatus({
1034
+ orgId: "org_id"
1035
+ });
1036
+
1037
+ ```
1038
+ </dd>
1039
+ </dl>
1040
+ </dd>
1041
+ </dl>
1042
+
1043
+ #### ⚙️ Parameters
1044
+
1045
+ <dl>
1046
+ <dd>
1047
+
1048
+ <dl>
1049
+ <dd>
1050
+
1051
+ **request:** `FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest`
1052
+
1053
+ </dd>
1054
+ </dl>
1055
+
1056
+ <dl>
1057
+ <dd>
1058
+
1059
+ **requestOptions:** `OrganizationClient.RequestOptions`
1060
+
1061
+ </dd>
1062
+ </dl>
1063
+ </dd>
1064
+ </dl>
1065
+
1066
+
1000
1067
  </dd>
1001
1068
  </dl>
1002
1069
  </details>