@fern-api/venus-api-sdk 11.5.0 → 11.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/organization/client/Client.d.ts +34 -1
  3. package/dist/cjs/api/resources/organization/client/Client.js +162 -1
  4. package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.d.ts +25 -0
  5. package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.js +66 -0
  6. package/dist/cjs/api/resources/organization/client/index.d.ts +2 -0
  7. package/dist/cjs/api/resources/organization/client/index.js +3 -1
  8. package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.ts +9 -0
  9. package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.js +3 -0
  10. package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.d.ts +11 -0
  11. package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.js +3 -0
  12. package/dist/cjs/api/resources/organization/client/requests/index.d.ts +2 -0
  13. package/dist/cjs/api/resources/organization/client/setDocsUrl.d.ts +25 -0
  14. package/dist/cjs/api/resources/organization/client/setDocsUrl.js +66 -0
  15. package/dist/cjs/api/types/PostmanTeamDocsResponse.d.ts +6 -0
  16. package/dist/cjs/api/types/PostmanTeamDocsResponse.js +3 -0
  17. package/dist/cjs/api/types/index.d.ts +1 -0
  18. package/dist/cjs/api/types/index.js +1 -0
  19. package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.ts +9 -0
  20. package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.js +41 -0
  21. package/dist/cjs/serialization/resources/organization/client/requests/index.d.ts +1 -0
  22. package/dist/cjs/serialization/resources/organization/client/requests/index.js +3 -1
  23. package/dist/cjs/serialization/types/PostmanTeamDocsResponse.d.ts +12 -0
  24. package/dist/cjs/serialization/types/PostmanTeamDocsResponse.js +44 -0
  25. package/dist/cjs/serialization/types/index.d.ts +1 -0
  26. package/dist/cjs/serialization/types/index.js +1 -0
  27. package/dist/cjs/version.d.ts +1 -1
  28. package/dist/cjs/version.js +1 -1
  29. package/dist/esm/BaseClient.mjs +2 -2
  30. package/dist/esm/api/resources/organization/client/Client.d.mts +34 -1
  31. package/dist/esm/api/resources/organization/client/Client.mjs +162 -1
  32. package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.d.mts +25 -0
  33. package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.mjs +30 -0
  34. package/dist/esm/api/resources/organization/client/index.d.mts +2 -0
  35. package/dist/esm/api/resources/organization/client/index.mjs +2 -0
  36. package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.mts +9 -0
  37. package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.mjs +2 -0
  38. package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.d.mts +11 -0
  39. package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.mjs +2 -0
  40. package/dist/esm/api/resources/organization/client/requests/index.d.mts +2 -0
  41. package/dist/esm/api/resources/organization/client/setDocsUrl.d.mts +25 -0
  42. package/dist/esm/api/resources/organization/client/setDocsUrl.mjs +30 -0
  43. package/dist/esm/api/types/PostmanTeamDocsResponse.d.mts +6 -0
  44. package/dist/esm/api/types/PostmanTeamDocsResponse.mjs +2 -0
  45. package/dist/esm/api/types/index.d.mts +1 -0
  46. package/dist/esm/api/types/index.mjs +1 -0
  47. package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.mts +9 -0
  48. package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.mjs +5 -0
  49. package/dist/esm/serialization/resources/organization/client/requests/index.d.mts +1 -0
  50. package/dist/esm/serialization/resources/organization/client/requests/index.mjs +1 -0
  51. package/dist/esm/serialization/types/PostmanTeamDocsResponse.d.mts +12 -0
  52. package/dist/esm/serialization/types/PostmanTeamDocsResponse.mjs +8 -0
  53. package/dist/esm/serialization/types/index.d.mts +1 -0
  54. package/dist/esm/serialization/types/index.mjs +1 -0
  55. package/dist/esm/version.d.mts +1 -1
  56. package/dist/esm/version.mjs +1 -1
  57. package/package.json +1 -1
  58. package/reference.md +138 -1
@@ -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.5.0",
47
- "User-Agent": "@fern-api/venus-api-sdk/11.5.0",
46
+ "X-Fern-SDK-Version": "11.6.0",
47
+ "User-Agent": "@fern-api/venus-api-sdk/11.6.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);
@@ -76,6 +76,22 @@ export declare class OrganizationClient {
76
76
  */
77
77
  getOrgIdsByPostmanTeamId(request: FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error>>;
78
78
  private __getOrgIdsByPostmanTeamId;
79
+ /**
80
+ * The claimable organization linked to a Postman team, with its claim
81
+ * status and the address of its docs site. Only Postman's integration
82
+ * service token can call it. 404 when the team has no claimable
83
+ * organization, or its docs address isn't set.
84
+ *
85
+ * @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
86
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
87
+ *
88
+ * @example
89
+ * await client.organization.getPostmanTeamDocs({
90
+ * postmanTeamId: "postman_team_id"
91
+ * })
92
+ */
93
+ getPostmanTeamDocs(request: FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error>>;
94
+ private __getPostmanTeamDocs;
79
95
  /**
80
96
  * Get the Postman team ID associated with an organization ID.
81
97
  *
@@ -106,7 +122,8 @@ export declare class OrganizationClient {
106
122
  private __getClaimStatus;
107
123
  /**
108
124
  * Issues a claim link for an unclaimed organization, bound to one Postman
109
- * user and valid for 15 minutes. Only the provisioner token can call it.
125
+ * user and valid for 15 minutes. Only the provisioner token and Postman's
126
+ * integration service token can call it.
110
127
  *
111
128
  * @param {FernVenusApi.CreateClaimTokenRequest} request
112
129
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -119,6 +136,22 @@ export declare class OrganizationClient {
119
136
  */
120
137
  createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
121
138
  private __createClaimToken;
139
+ /**
140
+ * Sets the address of an unclaimed organization's docs site, which the
141
+ * team docs lookup returns. Only the provisioner token can call it, and
142
+ * only until the organization is claimed.
143
+ *
144
+ * @param {FernVenusApi.SetDocsUrlRequest} request
145
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
146
+ *
147
+ * @example
148
+ * await client.organization.setDocsUrl({
149
+ * orgId: "org_id",
150
+ * docsUrl: "docsUrl"
151
+ * })
152
+ */
153
+ setDocsUrl(request: FernVenusApi.SetDocsUrlRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error>>;
154
+ private __setDocsUrl;
122
155
  /**
123
156
  * Redeems a claim link. The caller, signed in as the Postman user the link
124
157
  * is for, becomes the admin of the organization. The first claim wins, and
@@ -452,6 +452,86 @@ class OrganizationClient {
452
452
  };
453
453
  });
454
454
  }
455
+ /**
456
+ * The claimable organization linked to a Postman team, with its claim
457
+ * status and the address of its docs site. Only Postman's integration
458
+ * service token can call it. 404 when the team has no claimable
459
+ * organization, or its docs address isn't set.
460
+ *
461
+ * @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
462
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
463
+ *
464
+ * @example
465
+ * await client.organization.getPostmanTeamDocs({
466
+ * postmanTeamId: "postman_team_id"
467
+ * })
468
+ */
469
+ getPostmanTeamDocs(request, requestOptions) {
470
+ return core.HttpResponsePromise.fromPromise(this.__getPostmanTeamDocs(request, requestOptions));
471
+ }
472
+ __getPostmanTeamDocs(request, requestOptions) {
473
+ return __awaiter(this, void 0, void 0, function* () {
474
+ var _a, _b, _c, _d, _e, _f, _g, _h;
475
+ const { postmanTeamId } = request;
476
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
477
+ 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);
478
+ const _response = yield core.fetcher({
479
+ url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `organizations/postman-team/${core.url.encodePathParam(postmanTeamId)}/docs`),
480
+ method: "GET",
481
+ headers: _headers,
482
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
483
+ 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,
484
+ 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,
485
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
486
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
487
+ logging: this._options.logging,
488
+ });
489
+ if (_response.ok) {
490
+ return {
491
+ data: {
492
+ ok: true,
493
+ body: serializers.PostmanTeamDocsResponse.parseOrThrow(_response.body, {
494
+ unrecognizedObjectKeys: "passthrough",
495
+ allowUnrecognizedUnionMembers: true,
496
+ allowUnrecognizedEnumValues: true,
497
+ skipValidation: true,
498
+ breadcrumbsPrefix: ["response"],
499
+ }),
500
+ headers: _response.headers,
501
+ rawResponse: _response.rawResponse,
502
+ },
503
+ rawResponse: _response.rawResponse,
504
+ };
505
+ }
506
+ if (_response.error.reason === "status-code") {
507
+ switch (_response.error.statusCode) {
508
+ case 422:
509
+ return {
510
+ data: {
511
+ ok: false,
512
+ error: FernVenusApi.organization.getPostmanTeamDocs.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
513
+ unrecognizedObjectKeys: "passthrough",
514
+ allowUnrecognizedUnionMembers: true,
515
+ allowUnrecognizedEnumValues: true,
516
+ skipValidation: true,
517
+ breadcrumbsPrefix: ["response"],
518
+ })),
519
+ rawResponse: _response.rawResponse,
520
+ },
521
+ rawResponse: _response.rawResponse,
522
+ };
523
+ }
524
+ }
525
+ return {
526
+ data: {
527
+ ok: false,
528
+ error: FernVenusApi.organization.getPostmanTeamDocs.Error._unknown(_response.error),
529
+ rawResponse: _response.rawResponse,
530
+ },
531
+ rawResponse: _response.rawResponse,
532
+ };
533
+ });
534
+ }
455
535
  /**
456
536
  * Get the Postman team ID associated with an organization ID.
457
537
  *
@@ -610,7 +690,8 @@ class OrganizationClient {
610
690
  }
611
691
  /**
612
692
  * 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.
693
+ * user and valid for 15 minutes. Only the provisioner token and Postman's
694
+ * integration service token can call it.
614
695
  *
615
696
  * @param {FernVenusApi.CreateClaimTokenRequest} request
616
697
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -693,6 +774,86 @@ class OrganizationClient {
693
774
  };
694
775
  });
695
776
  }
777
+ /**
778
+ * Sets the address of an unclaimed organization's docs site, which the
779
+ * team docs lookup returns. Only the provisioner token can call it, and
780
+ * only until the organization is claimed.
781
+ *
782
+ * @param {FernVenusApi.SetDocsUrlRequest} request
783
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
784
+ *
785
+ * @example
786
+ * await client.organization.setDocsUrl({
787
+ * orgId: "org_id",
788
+ * docsUrl: "docsUrl"
789
+ * })
790
+ */
791
+ setDocsUrl(request, requestOptions) {
792
+ return core.HttpResponsePromise.fromPromise(this.__setDocsUrl(request, requestOptions));
793
+ }
794
+ __setDocsUrl(request, requestOptions) {
795
+ return __awaiter(this, void 0, void 0, function* () {
796
+ var _a, _b, _c, _d, _e, _f, _g, _h;
797
+ const { orgId } = request, _body = __rest(request, ["orgId"]);
798
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
799
+ 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);
800
+ const _response = yield core.fetcher({
801
+ url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `organizations/${core.url.encodePathParam(orgId)}/docs-url`),
802
+ method: "POST",
803
+ headers: _headers,
804
+ contentType: "application/json",
805
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
806
+ requestType: "json",
807
+ body: serializers.SetDocsUrlRequest.jsonOrThrow(_body, {
808
+ unrecognizedObjectKeys: "strip",
809
+ omitUndefined: true,
810
+ }),
811
+ 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,
812
+ 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,
813
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
814
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
815
+ logging: this._options.logging,
816
+ });
817
+ if (_response.ok) {
818
+ return {
819
+ data: {
820
+ ok: true,
821
+ body: undefined,
822
+ headers: _response.headers,
823
+ rawResponse: _response.rawResponse,
824
+ },
825
+ rawResponse: _response.rawResponse,
826
+ };
827
+ }
828
+ if (_response.error.reason === "status-code") {
829
+ switch (_response.error.statusCode) {
830
+ case 422:
831
+ return {
832
+ data: {
833
+ ok: false,
834
+ error: FernVenusApi.organization.setDocsUrl.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
835
+ unrecognizedObjectKeys: "passthrough",
836
+ allowUnrecognizedUnionMembers: true,
837
+ allowUnrecognizedEnumValues: true,
838
+ skipValidation: true,
839
+ breadcrumbsPrefix: ["response"],
840
+ })),
841
+ rawResponse: _response.rawResponse,
842
+ },
843
+ rawResponse: _response.rawResponse,
844
+ };
845
+ }
846
+ }
847
+ return {
848
+ data: {
849
+ ok: false,
850
+ error: FernVenusApi.organization.setDocsUrl.Error._unknown(_response.error),
851
+ rawResponse: _response.rawResponse,
852
+ },
853
+ rawResponse: _response.rawResponse,
854
+ };
855
+ });
856
+ }
696
857
  /**
697
858
  * Redeems a claim link. The caller, signed in as the Postman user the link
698
859
  * is for, becomes the admin of the organization. The first claim wins, and
@@ -0,0 +1,25 @@
1
+ import type * as core from "../../../../core/index.js";
2
+ import * as FernVenusApi from "../../../index.js";
3
+ export type Error = FernVenusApi.organization.getPostmanTeamDocs.Error.UnprocessableEntityError | FernVenusApi.organization.getPostmanTeamDocs.Error._Unknown;
4
+ export declare namespace Error {
5
+ interface UnprocessableEntityError extends _Utils {
6
+ statusCode: 422;
7
+ content: FernVenusApi.HttpValidationError;
8
+ }
9
+ interface _Unknown extends _Utils {
10
+ statusCode: void;
11
+ content: core.Fetcher.Error;
12
+ }
13
+ interface _Utils {
14
+ _visit: <_Result>(visitor: FernVenusApi.organization.getPostmanTeamDocs.Error._Visitor<_Result>) => _Result;
15
+ }
16
+ interface _Visitor<_Result> {
17
+ unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
18
+ _other: (value: core.Fetcher.Error) => _Result;
19
+ }
20
+ }
21
+ export declare const Error: {
22
+ readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.organization.getPostmanTeamDocs.Error.UnprocessableEntityError;
23
+ readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.getPostmanTeamDocs.Error._Unknown;
24
+ readonly _visit: <_Result>(value: FernVenusApi.organization.getPostmanTeamDocs.Error, visitor: FernVenusApi.organization.getPostmanTeamDocs.Error._Visitor<_Result>) => _Result;
25
+ };
@@ -0,0 +1,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.getPostmanTeamDocs.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.getPostmanTeamDocs.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
+ };
@@ -8,10 +8,12 @@ export * as getClaimStatus from "./getClaimStatus.js";
8
8
  export * as getMyOrganizationFromScopedToken from "./getMyOrganizationFromScopedToken.js";
9
9
  export * as getOrgIdsByPostmanTeamId from "./getOrgIdsByPostmanTeamId.js";
10
10
  export * as getOrgIdsFromToken from "./getOrgIdsFromToken.js";
11
+ export * as getPostmanTeamDocs from "./getPostmanTeamDocs.js";
11
12
  export * as getPostmanTeamIdByOrgId from "./getPostmanTeamIdByOrgId.js";
12
13
  export * as inviteUser from "./inviteUser.js";
13
14
  export * as isMember from "./isMember.js";
14
15
  export * as previewClaim from "./previewClaim.js";
15
16
  export * as removeUser from "./removeUser.js";
16
17
  export * from "./requests/index.js";
18
+ export * as setDocsUrl from "./setDocsUrl.js";
17
19
  export * as update from "./update.js";
@@ -36,7 +36,7 @@ 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.previewClaim = exports.isMember = exports.inviteUser = exports.getPostmanTeamIdByOrgId = exports.getOrgIdsFromToken = exports.getOrgIdsByPostmanTeamId = exports.getMyOrganizationFromScopedToken = exports.getClaimStatus = exports.get = exports.delete = exports.createClaimToken = exports.create = exports.claim = exports.addUser = void 0;
39
+ exports.update = exports.setDocsUrl = exports.removeUser = exports.previewClaim = exports.isMember = exports.inviteUser = exports.getPostmanTeamIdByOrgId = exports.getPostmanTeamDocs = exports.getOrgIdsFromToken = exports.getOrgIdsByPostmanTeamId = exports.getMyOrganizationFromScopedToken = exports.getClaimStatus = exports.get = exports.delete = exports.createClaimToken = exports.create = exports.claim = exports.addUser = void 0;
40
40
  exports.addUser = __importStar(require("./addUser.js"));
41
41
  exports.claim = __importStar(require("./claim.js"));
42
42
  exports.create = __importStar(require("./create.js"));
@@ -47,10 +47,12 @@ exports.getClaimStatus = __importStar(require("./getClaimStatus.js"));
47
47
  exports.getMyOrganizationFromScopedToken = __importStar(require("./getMyOrganizationFromScopedToken.js"));
48
48
  exports.getOrgIdsByPostmanTeamId = __importStar(require("./getOrgIdsByPostmanTeamId.js"));
49
49
  exports.getOrgIdsFromToken = __importStar(require("./getOrgIdsFromToken.js"));
50
+ exports.getPostmanTeamDocs = __importStar(require("./getPostmanTeamDocs.js"));
50
51
  exports.getPostmanTeamIdByOrgId = __importStar(require("./getPostmanTeamIdByOrgId.js"));
51
52
  exports.inviteUser = __importStar(require("./inviteUser.js"));
52
53
  exports.isMember = __importStar(require("./isMember.js"));
53
54
  exports.previewClaim = __importStar(require("./previewClaim.js"));
54
55
  exports.removeUser = __importStar(require("./removeUser.js"));
55
56
  __exportStar(require("./requests/index.js"), exports);
57
+ exports.setDocsUrl = __importStar(require("./setDocsUrl.js"));
56
58
  exports.update = __importStar(require("./update.js"));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * postmanTeamId: "postman_team_id"
5
+ * }
6
+ */
7
+ export interface GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest {
8
+ postmanTeamId: 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 });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * orgId: "org_id",
5
+ * docsUrl: "docsUrl"
6
+ * }
7
+ */
8
+ export interface SetDocsUrlRequest {
9
+ orgId: string;
10
+ docsUrl: string;
11
+ }
@@ -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 });
@@ -6,8 +6,10 @@ export type { GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest } from "./Ge
6
6
  export type { GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest } from "./GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest.js";
7
7
  export type { GetOrganizationsOrgIdGetRequest } from "./GetOrganizationsOrgIdGetRequest.js";
8
8
  export type { GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest } from "./GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest.js";
9
+ export type { GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest } from "./GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.js";
9
10
  export type { GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest } from "./GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest.js";
10
11
  export type { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.js";
11
12
  export type { IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest } from "./IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest.js";
12
13
  export type { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.js";
14
+ export type { SetDocsUrlRequest } from "./SetDocsUrlRequest.js";
13
15
  export type { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.js";
@@ -0,0 +1,25 @@
1
+ import type * as core from "../../../../core/index.js";
2
+ import * as FernVenusApi from "../../../index.js";
3
+ export type Error = FernVenusApi.organization.setDocsUrl.Error.UnprocessableEntityError | FernVenusApi.organization.setDocsUrl.Error._Unknown;
4
+ export declare namespace Error {
5
+ interface UnprocessableEntityError extends _Utils {
6
+ statusCode: 422;
7
+ content: FernVenusApi.HttpValidationError;
8
+ }
9
+ interface _Unknown extends _Utils {
10
+ statusCode: void;
11
+ content: core.Fetcher.Error;
12
+ }
13
+ interface _Utils {
14
+ _visit: <_Result>(visitor: FernVenusApi.organization.setDocsUrl.Error._Visitor<_Result>) => _Result;
15
+ }
16
+ interface _Visitor<_Result> {
17
+ unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
18
+ _other: (value: core.Fetcher.Error) => _Result;
19
+ }
20
+ }
21
+ export declare const Error: {
22
+ readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.organization.setDocsUrl.Error.UnprocessableEntityError;
23
+ readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.setDocsUrl.Error._Unknown;
24
+ readonly _visit: <_Result>(value: FernVenusApi.organization.setDocsUrl.Error, visitor: FernVenusApi.organization.setDocsUrl.Error._Visitor<_Result>) => _Result;
25
+ };
@@ -0,0 +1,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.setDocsUrl.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.setDocsUrl.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
+ };
@@ -0,0 +1,6 @@
1
+ import type * as FernVenusApi from "../index.js";
2
+ export interface PostmanTeamDocsResponse {
3
+ organizationId: string;
4
+ claimStatus: FernVenusApi.ClaimStatus;
5
+ docsUrl: string;
6
+ }
@@ -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 });
@@ -20,6 +20,7 @@ export * from "./Npm.js";
20
20
  export * from "./NpmRegistryToken.js";
21
21
  export * from "./Organization.js";
22
22
  export * from "./OrganizationsPage.js";
23
+ export * from "./PostmanTeamDocsResponse.js";
23
24
  export * from "./Pypi.js";
24
25
  export * from "./PypiRegistryToken.js";
25
26
  export * from "./RegistryToken.js";
@@ -36,6 +36,7 @@ __exportStar(require("./Npm.js"), exports);
36
36
  __exportStar(require("./NpmRegistryToken.js"), exports);
37
37
  __exportStar(require("./Organization.js"), exports);
38
38
  __exportStar(require("./OrganizationsPage.js"), exports);
39
+ __exportStar(require("./PostmanTeamDocsResponse.js"), exports);
39
40
  __exportStar(require("./Pypi.js"), exports);
40
41
  __exportStar(require("./PypiRegistryToken.js"), exports);
41
42
  __exportStar(require("./RegistryToken.js"), exports);
@@ -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 SetDocsUrlRequest: core.serialization.Schema<serializers.SetDocsUrlRequest.Raw, Omit<FernVenusApi.SetDocsUrlRequest, "orgId">>;
5
+ export declare namespace SetDocsUrlRequest {
6
+ interface Raw {
7
+ docsUrl: string;
8
+ }
9
+ }
@@ -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.SetDocsUrlRequest = void 0;
38
+ const core = __importStar(require("../../../../../core/index.js"));
39
+ exports.SetDocsUrlRequest = core.serialization.object({
40
+ docsUrl: core.serialization.string(),
41
+ });
@@ -3,4 +3,5 @@ export { CreateClaimTokenRequest } from "./CreateClaimTokenRequest.js";
3
3
  export { CreateOrganizationRequest } from "./CreateOrganizationRequest.js";
4
4
  export { InviteUserToOrgRequest } from "./InviteUserToOrgRequest.js";
5
5
  export { RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.js";
6
+ export { SetDocsUrlRequest } from "./SetDocsUrlRequest.js";
6
7
  export { UpdateOrganizationRequest } from "./UpdateOrganizationRequest.js";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.UpdateOrganizationRequest = exports.RemoveUserFromOrgRequest = exports.InviteUserToOrgRequest = exports.CreateOrganizationRequest = exports.CreateClaimTokenRequest = exports.AddUserToOrgRequest = void 0;
3
+ exports.UpdateOrganizationRequest = exports.SetDocsUrlRequest = 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
6
  var CreateClaimTokenRequest_js_1 = require("./CreateClaimTokenRequest.js");
@@ -11,5 +11,7 @@ var InviteUserToOrgRequest_js_1 = require("./InviteUserToOrgRequest.js");
11
11
  Object.defineProperty(exports, "InviteUserToOrgRequest", { enumerable: true, get: function () { return InviteUserToOrgRequest_js_1.InviteUserToOrgRequest; } });
12
12
  var RemoveUserFromOrgRequest_js_1 = require("./RemoveUserFromOrgRequest.js");
13
13
  Object.defineProperty(exports, "RemoveUserFromOrgRequest", { enumerable: true, get: function () { return RemoveUserFromOrgRequest_js_1.RemoveUserFromOrgRequest; } });
14
+ var SetDocsUrlRequest_js_1 = require("./SetDocsUrlRequest.js");
15
+ Object.defineProperty(exports, "SetDocsUrlRequest", { enumerable: true, get: function () { return SetDocsUrlRequest_js_1.SetDocsUrlRequest; } });
14
16
  var UpdateOrganizationRequest_js_1 = require("./UpdateOrganizationRequest.js");
15
17
  Object.defineProperty(exports, "UpdateOrganizationRequest", { enumerable: true, get: function () { return UpdateOrganizationRequest_js_1.UpdateOrganizationRequest; } });
@@ -0,0 +1,12 @@
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 PostmanTeamDocsResponse: core.serialization.ObjectSchema<serializers.PostmanTeamDocsResponse.Raw, FernVenusApi.PostmanTeamDocsResponse>;
6
+ export declare namespace PostmanTeamDocsResponse {
7
+ interface Raw {
8
+ organizationId: string;
9
+ claimStatus: ClaimStatus.Raw;
10
+ docsUrl: string;
11
+ }
12
+ }