@fern-api/venus-api-sdk 11.3.0 → 11.5.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 (124) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +11 -6
  4. package/dist/cjs/api/resources/guestSession/client/Client.d.ts +31 -0
  5. package/dist/cjs/api/resources/guestSession/client/Client.js +144 -0
  6. package/dist/cjs/api/resources/guestSession/client/create.d.ts +25 -0
  7. package/dist/cjs/api/resources/guestSession/client/create.js +66 -0
  8. package/dist/cjs/api/resources/guestSession/client/index.d.ts +2 -0
  9. package/dist/cjs/api/resources/guestSession/client/index.js +41 -0
  10. package/dist/cjs/api/resources/guestSession/client/requests/CreateGuestSessionRequest.d.ts +11 -0
  11. package/dist/cjs/api/resources/guestSession/client/requests/CreateGuestSessionRequest.js +3 -0
  12. package/dist/cjs/api/resources/guestSession/client/requests/index.d.ts +1 -0
  13. package/dist/cjs/api/resources/guestSession/client/requests/index.js +2 -0
  14. package/dist/cjs/api/resources/guestSession/index.d.ts +1 -0
  15. package/dist/cjs/api/resources/guestSession/index.js +17 -0
  16. package/dist/cjs/api/resources/index.d.ts +2 -0
  17. package/dist/cjs/api/resources/index.js +3 -1
  18. package/dist/cjs/api/resources/organization/client/Client.d.ts +31 -0
  19. package/dist/cjs/api/resources/organization/client/Client.js +169 -0
  20. package/dist/cjs/api/resources/organization/client/claim.d.ts +25 -0
  21. package/dist/cjs/api/resources/organization/client/claim.js +66 -0
  22. package/dist/cjs/api/resources/organization/client/index.d.ts +2 -0
  23. package/dist/cjs/api/resources/organization/client/index.js +3 -1
  24. package/dist/cjs/api/resources/organization/client/previewClaim.d.ts +25 -0
  25. package/dist/cjs/api/resources/organization/client/previewClaim.js +66 -0
  26. package/dist/cjs/api/types/ClaimOrganizationRequest.d.ts +3 -0
  27. package/dist/cjs/api/types/ClaimOrganizationRequest.js +3 -0
  28. package/dist/cjs/api/types/ClaimOrganizationResponse.d.ts +5 -0
  29. package/dist/cjs/api/types/ClaimOrganizationResponse.js +3 -0
  30. package/dist/cjs/api/types/ClaimPreviewResponse.d.ts +8 -0
  31. package/dist/cjs/api/types/ClaimPreviewResponse.js +3 -0
  32. package/dist/cjs/api/types/CreateGuestSessionResponse.d.ts +9 -0
  33. package/dist/cjs/api/types/CreateGuestSessionResponse.js +3 -0
  34. package/dist/cjs/api/types/GuestSessionLimits.d.ts +4 -0
  35. package/dist/cjs/api/types/GuestSessionLimits.js +3 -0
  36. package/dist/cjs/api/types/index.d.ts +5 -0
  37. package/dist/cjs/api/types/index.js +5 -0
  38. package/dist/cjs/serialization/resources/guestSession/client/index.d.ts +1 -0
  39. package/dist/cjs/serialization/resources/guestSession/client/index.js +17 -0
  40. package/dist/cjs/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.d.ts +11 -0
  41. package/dist/cjs/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.js +43 -0
  42. package/dist/cjs/serialization/resources/guestSession/client/requests/index.d.ts +1 -0
  43. package/dist/cjs/serialization/resources/guestSession/client/requests/index.js +5 -0
  44. package/dist/cjs/serialization/resources/guestSession/index.d.ts +1 -0
  45. package/dist/cjs/serialization/resources/guestSession/index.js +17 -0
  46. package/dist/cjs/serialization/resources/index.d.ts +2 -0
  47. package/dist/cjs/serialization/resources/index.js +3 -1
  48. package/dist/cjs/serialization/types/ClaimOrganizationRequest.d.ts +9 -0
  49. package/dist/cjs/serialization/types/ClaimOrganizationRequest.js +41 -0
  50. package/dist/cjs/serialization/types/ClaimOrganizationResponse.d.ts +11 -0
  51. package/dist/cjs/serialization/types/ClaimOrganizationResponse.js +43 -0
  52. package/dist/cjs/serialization/types/ClaimPreviewResponse.d.ts +14 -0
  53. package/dist/cjs/serialization/types/ClaimPreviewResponse.js +46 -0
  54. package/dist/cjs/serialization/types/CreateGuestSessionResponse.d.ts +15 -0
  55. package/dist/cjs/serialization/types/CreateGuestSessionResponse.js +47 -0
  56. package/dist/cjs/serialization/types/GuestSessionLimits.d.ts +10 -0
  57. package/dist/cjs/serialization/types/GuestSessionLimits.js +42 -0
  58. package/dist/cjs/serialization/types/index.d.ts +5 -0
  59. package/dist/cjs/serialization/types/index.js +5 -0
  60. package/dist/cjs/version.d.ts +1 -1
  61. package/dist/cjs/version.js +1 -1
  62. package/dist/esm/BaseClient.mjs +2 -2
  63. package/dist/esm/Client.d.mts +3 -0
  64. package/dist/esm/Client.mjs +5 -0
  65. package/dist/esm/api/resources/guestSession/client/Client.d.mts +31 -0
  66. package/dist/esm/api/resources/guestSession/client/Client.mjs +107 -0
  67. package/dist/esm/api/resources/guestSession/client/create.d.mts +25 -0
  68. package/dist/esm/api/resources/guestSession/client/create.mjs +30 -0
  69. package/dist/esm/api/resources/guestSession/client/index.d.mts +2 -0
  70. package/dist/esm/api/resources/guestSession/client/index.mjs +2 -0
  71. package/dist/esm/api/resources/guestSession/client/requests/CreateGuestSessionRequest.d.mts +11 -0
  72. package/dist/esm/api/resources/guestSession/client/requests/CreateGuestSessionRequest.mjs +2 -0
  73. package/dist/esm/api/resources/guestSession/client/requests/index.d.mts +1 -0
  74. package/dist/esm/api/resources/guestSession/client/requests/index.mjs +1 -0
  75. package/dist/esm/api/resources/guestSession/index.d.mts +1 -0
  76. package/dist/esm/api/resources/guestSession/index.mjs +1 -0
  77. package/dist/esm/api/resources/index.d.mts +2 -0
  78. package/dist/esm/api/resources/index.mjs +2 -0
  79. package/dist/esm/api/resources/organization/client/Client.d.mts +31 -0
  80. package/dist/esm/api/resources/organization/client/Client.mjs +169 -0
  81. package/dist/esm/api/resources/organization/client/claim.d.mts +25 -0
  82. package/dist/esm/api/resources/organization/client/claim.mjs +30 -0
  83. package/dist/esm/api/resources/organization/client/index.d.mts +2 -0
  84. package/dist/esm/api/resources/organization/client/index.mjs +2 -0
  85. package/dist/esm/api/resources/organization/client/previewClaim.d.mts +25 -0
  86. package/dist/esm/api/resources/organization/client/previewClaim.mjs +30 -0
  87. package/dist/esm/api/types/ClaimOrganizationRequest.d.mts +3 -0
  88. package/dist/esm/api/types/ClaimOrganizationRequest.mjs +2 -0
  89. package/dist/esm/api/types/ClaimOrganizationResponse.d.mts +5 -0
  90. package/dist/esm/api/types/ClaimOrganizationResponse.mjs +2 -0
  91. package/dist/esm/api/types/ClaimPreviewResponse.d.mts +8 -0
  92. package/dist/esm/api/types/ClaimPreviewResponse.mjs +2 -0
  93. package/dist/esm/api/types/CreateGuestSessionResponse.d.mts +9 -0
  94. package/dist/esm/api/types/CreateGuestSessionResponse.mjs +2 -0
  95. package/dist/esm/api/types/GuestSessionLimits.d.mts +4 -0
  96. package/dist/esm/api/types/GuestSessionLimits.mjs +2 -0
  97. package/dist/esm/api/types/index.d.mts +5 -0
  98. package/dist/esm/api/types/index.mjs +5 -0
  99. package/dist/esm/serialization/resources/guestSession/client/index.d.mts +1 -0
  100. package/dist/esm/serialization/resources/guestSession/client/index.mjs +1 -0
  101. package/dist/esm/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.d.mts +11 -0
  102. package/dist/esm/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.mjs +7 -0
  103. package/dist/esm/serialization/resources/guestSession/client/requests/index.d.mts +1 -0
  104. package/dist/esm/serialization/resources/guestSession/client/requests/index.mjs +1 -0
  105. package/dist/esm/serialization/resources/guestSession/index.d.mts +1 -0
  106. package/dist/esm/serialization/resources/guestSession/index.mjs +1 -0
  107. package/dist/esm/serialization/resources/index.d.mts +2 -0
  108. package/dist/esm/serialization/resources/index.mjs +2 -0
  109. package/dist/esm/serialization/types/ClaimOrganizationRequest.d.mts +9 -0
  110. package/dist/esm/serialization/types/ClaimOrganizationRequest.mjs +5 -0
  111. package/dist/esm/serialization/types/ClaimOrganizationResponse.d.mts +11 -0
  112. package/dist/esm/serialization/types/ClaimOrganizationResponse.mjs +7 -0
  113. package/dist/esm/serialization/types/ClaimPreviewResponse.d.mts +14 -0
  114. package/dist/esm/serialization/types/ClaimPreviewResponse.mjs +10 -0
  115. package/dist/esm/serialization/types/CreateGuestSessionResponse.d.mts +15 -0
  116. package/dist/esm/serialization/types/CreateGuestSessionResponse.mjs +11 -0
  117. package/dist/esm/serialization/types/GuestSessionLimits.d.mts +10 -0
  118. package/dist/esm/serialization/types/GuestSessionLimits.mjs +6 -0
  119. package/dist/esm/serialization/types/index.d.mts +5 -0
  120. package/dist/esm/serialization/types/index.mjs +5 -0
  121. package/dist/esm/version.d.mts +1 -1
  122. package/dist/esm/version.mjs +1 -1
  123. package/package.json +1 -1
  124. package/reference.md +206 -0
@@ -119,6 +119,37 @@ export declare class OrganizationClient {
119
119
  */
120
120
  createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
121
121
  private __createClaimToken;
122
+ /**
123
+ * Redeems a claim link. The caller, signed in as the Postman user the link
124
+ * is for, becomes the admin of the organization. The first claim wins, and
125
+ * a retry by the same user finishes a claim that failed partway.
126
+ *
127
+ * @param {FernVenusApi.ClaimOrganizationRequest} request
128
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
129
+ *
130
+ * @example
131
+ * await client.organization.claim({
132
+ * claimToken: "claimToken"
133
+ * })
134
+ */
135
+ claim(request: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claim.Error>>;
136
+ private __claim;
137
+ /**
138
+ * What a claim link is for, without redeeming it, so the dashboard can show
139
+ * the organization and the link's state before the user signs in. Public:
140
+ * the link is the secret. The token is in the body to keep it out of
141
+ * request logs.
142
+ *
143
+ * @param {FernVenusApi.ClaimOrganizationRequest} request
144
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
145
+ *
146
+ * @example
147
+ * await client.organization.previewClaim({
148
+ * claimToken: "claimToken"
149
+ * })
150
+ */
151
+ previewClaim(request: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimPreviewResponse, FernVenusApi.organization.previewClaim.Error>>;
152
+ private __previewClaim;
122
153
  /**
123
154
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
124
155
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -657,6 +657,175 @@ export class OrganizationClient {
657
657
  };
658
658
  });
659
659
  }
660
+ /**
661
+ * Redeems a claim link. The caller, signed in as the Postman user the link
662
+ * is for, becomes the admin of the organization. The first claim wins, and
663
+ * a retry by the same user finishes a claim that failed partway.
664
+ *
665
+ * @param {FernVenusApi.ClaimOrganizationRequest} request
666
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
667
+ *
668
+ * @example
669
+ * await client.organization.claim({
670
+ * claimToken: "claimToken"
671
+ * })
672
+ */
673
+ claim(request, requestOptions) {
674
+ return core.HttpResponsePromise.fromPromise(this.__claim(request, requestOptions));
675
+ }
676
+ __claim(request, requestOptions) {
677
+ return __awaiter(this, void 0, void 0, function* () {
678
+ var _a, _b, _c, _d, _e, _f, _g, _h;
679
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
680
+ 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);
681
+ const _response = yield core.fetcher({
682
+ 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/claim"),
683
+ method: "POST",
684
+ headers: _headers,
685
+ contentType: "application/json",
686
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
687
+ requestType: "json",
688
+ body: serializers.ClaimOrganizationRequest.jsonOrThrow(request, {
689
+ unrecognizedObjectKeys: "strip",
690
+ omitUndefined: true,
691
+ }),
692
+ 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,
693
+ 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,
694
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
695
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
696
+ logging: this._options.logging,
697
+ });
698
+ if (_response.ok) {
699
+ return {
700
+ data: {
701
+ ok: true,
702
+ body: serializers.ClaimOrganizationResponse.parseOrThrow(_response.body, {
703
+ unrecognizedObjectKeys: "passthrough",
704
+ allowUnrecognizedUnionMembers: true,
705
+ allowUnrecognizedEnumValues: true,
706
+ skipValidation: true,
707
+ breadcrumbsPrefix: ["response"],
708
+ }),
709
+ headers: _response.headers,
710
+ rawResponse: _response.rawResponse,
711
+ },
712
+ rawResponse: _response.rawResponse,
713
+ };
714
+ }
715
+ if (_response.error.reason === "status-code") {
716
+ switch (_response.error.statusCode) {
717
+ case 422:
718
+ return {
719
+ data: {
720
+ ok: false,
721
+ error: FernVenusApi.organization.claim.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
722
+ unrecognizedObjectKeys: "passthrough",
723
+ allowUnrecognizedUnionMembers: true,
724
+ allowUnrecognizedEnumValues: true,
725
+ skipValidation: true,
726
+ breadcrumbsPrefix: ["response"],
727
+ })),
728
+ rawResponse: _response.rawResponse,
729
+ },
730
+ rawResponse: _response.rawResponse,
731
+ };
732
+ }
733
+ }
734
+ return {
735
+ data: {
736
+ ok: false,
737
+ error: FernVenusApi.organization.claim.Error._unknown(_response.error),
738
+ rawResponse: _response.rawResponse,
739
+ },
740
+ rawResponse: _response.rawResponse,
741
+ };
742
+ });
743
+ }
744
+ /**
745
+ * What a claim link is for, without redeeming it, so the dashboard can show
746
+ * the organization and the link's state before the user signs in. Public:
747
+ * the link is the secret. The token is in the body to keep it out of
748
+ * request logs.
749
+ *
750
+ * @param {FernVenusApi.ClaimOrganizationRequest} request
751
+ * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
752
+ *
753
+ * @example
754
+ * await client.organization.previewClaim({
755
+ * claimToken: "claimToken"
756
+ * })
757
+ */
758
+ previewClaim(request, requestOptions) {
759
+ return core.HttpResponsePromise.fromPromise(this.__previewClaim(request, requestOptions));
760
+ }
761
+ __previewClaim(request, requestOptions) {
762
+ return __awaiter(this, void 0, void 0, function* () {
763
+ var _a, _b, _c, _d, _e, _f, _g, _h;
764
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
765
+ 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);
766
+ const _response = yield core.fetcher({
767
+ 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/claim/preview"),
768
+ method: "POST",
769
+ headers: _headers,
770
+ contentType: "application/json",
771
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
772
+ requestType: "json",
773
+ body: serializers.ClaimOrganizationRequest.jsonOrThrow(request, {
774
+ unrecognizedObjectKeys: "strip",
775
+ omitUndefined: true,
776
+ }),
777
+ 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,
778
+ 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,
779
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
780
+ fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
781
+ logging: this._options.logging,
782
+ });
783
+ if (_response.ok) {
784
+ return {
785
+ data: {
786
+ ok: true,
787
+ body: serializers.ClaimPreviewResponse.parseOrThrow(_response.body, {
788
+ unrecognizedObjectKeys: "passthrough",
789
+ allowUnrecognizedUnionMembers: true,
790
+ allowUnrecognizedEnumValues: true,
791
+ skipValidation: true,
792
+ breadcrumbsPrefix: ["response"],
793
+ }),
794
+ headers: _response.headers,
795
+ rawResponse: _response.rawResponse,
796
+ },
797
+ rawResponse: _response.rawResponse,
798
+ };
799
+ }
800
+ if (_response.error.reason === "status-code") {
801
+ switch (_response.error.statusCode) {
802
+ case 422:
803
+ return {
804
+ data: {
805
+ ok: false,
806
+ error: FernVenusApi.organization.previewClaim.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
807
+ unrecognizedObjectKeys: "passthrough",
808
+ allowUnrecognizedUnionMembers: true,
809
+ allowUnrecognizedEnumValues: true,
810
+ skipValidation: true,
811
+ breadcrumbsPrefix: ["response"],
812
+ })),
813
+ rawResponse: _response.rawResponse,
814
+ },
815
+ rawResponse: _response.rawResponse,
816
+ };
817
+ }
818
+ }
819
+ return {
820
+ data: {
821
+ ok: false,
822
+ error: FernVenusApi.organization.previewClaim.Error._unknown(_response.error),
823
+ rawResponse: _response.rawResponse,
824
+ },
825
+ rawResponse: _response.rawResponse,
826
+ };
827
+ });
828
+ }
660
829
  /**
661
830
  * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
662
831
  * @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.claim.Error.UnprocessableEntityError | FernVenusApi.organization.claim.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.claim.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.claim.Error.UnprocessableEntityError;
23
+ readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.claim.Error._Unknown;
24
+ readonly _visit: <_Result>(value: FernVenusApi.organization.claim.Error, visitor: FernVenusApi.organization.claim.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.claim.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.claim.Error._visit(this, visitor);
19
+ },
20
+ };
21
+ },
22
+ _visit: (value, visitor) => {
23
+ switch (value.statusCode) {
24
+ case 422:
25
+ return visitor.unprocessableEntityError(value.content);
26
+ default:
27
+ return visitor._other(value.content);
28
+ }
29
+ },
30
+ };
@@ -1,4 +1,5 @@
1
1
  export * as addUser from "./addUser.mjs";
2
+ export * as claim from "./claim.mjs";
2
3
  export * as create from "./create.mjs";
3
4
  export * as createClaimToken from "./createClaimToken.mjs";
4
5
  export * as delete from "./delete.mjs";
@@ -10,6 +11,7 @@ export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
10
11
  export * as getPostmanTeamIdByOrgId from "./getPostmanTeamIdByOrgId.mjs";
11
12
  export * as inviteUser from "./inviteUser.mjs";
12
13
  export * as isMember from "./isMember.mjs";
14
+ export * as previewClaim from "./previewClaim.mjs";
13
15
  export * as removeUser from "./removeUser.mjs";
14
16
  export * from "./requests/index.mjs";
15
17
  export * as update from "./update.mjs";
@@ -1,4 +1,5 @@
1
1
  export * as addUser from "./addUser.mjs";
2
+ export * as claim from "./claim.mjs";
2
3
  export * as create from "./create.mjs";
3
4
  export * as createClaimToken from "./createClaimToken.mjs";
4
5
  export * as delete from "./delete.mjs";
@@ -10,6 +11,7 @@ export * as getOrgIdsFromToken from "./getOrgIdsFromToken.mjs";
10
11
  export * as getPostmanTeamIdByOrgId from "./getPostmanTeamIdByOrgId.mjs";
11
12
  export * as inviteUser from "./inviteUser.mjs";
12
13
  export * as isMember from "./isMember.mjs";
14
+ export * as previewClaim from "./previewClaim.mjs";
13
15
  export * as removeUser from "./removeUser.mjs";
14
16
  export * from "./requests/index.mjs";
15
17
  export * as update from "./update.mjs";
@@ -0,0 +1,25 @@
1
+ import type * as core from "../../../../core/index.mjs";
2
+ import * as FernVenusApi from "../../../index.mjs";
3
+ export type Error = FernVenusApi.organization.previewClaim.Error.UnprocessableEntityError | FernVenusApi.organization.previewClaim.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.previewClaim.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.previewClaim.Error.UnprocessableEntityError;
23
+ readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.previewClaim.Error._Unknown;
24
+ readonly _visit: <_Result>(value: FernVenusApi.organization.previewClaim.Error, visitor: FernVenusApi.organization.previewClaim.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.previewClaim.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.previewClaim.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
+ };
@@ -0,0 +1,3 @@
1
+ export interface ClaimOrganizationRequest {
2
+ claimToken: string;
3
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface ClaimOrganizationResponse {
2
+ organizationId: string;
3
+ auth0Id: string;
4
+ displayName: string;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ import type * as FernVenusApi from "../index.mjs";
2
+ export interface ClaimPreviewResponse {
3
+ organizationId: string;
4
+ displayName: string;
5
+ claimStatus: FernVenusApi.ClaimStatus;
6
+ expiresAt: Date;
7
+ redeemed: boolean;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ import type * as FernVenusApi from "../index.mjs";
2
+ export interface CreateGuestSessionResponse {
3
+ sessionId: string;
4
+ organizationId: string;
5
+ token: string;
6
+ claimSecret: string;
7
+ expiresAt: Date;
8
+ limits: FernVenusApi.GuestSessionLimits;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface GuestSessionLimits {
2
+ sdkBuilds: number;
3
+ docsPublishes: number;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,10 +1,15 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimOrganizationRequest.mjs";
3
+ export * from "./ClaimOrganizationResponse.mjs";
4
+ export * from "./ClaimPreviewResponse.mjs";
2
5
  export * from "./ClaimStatus.mjs";
3
6
  export * from "./ClaimStatusResponse.mjs";
4
7
  export * from "./ClaimTokenResponse.mjs";
8
+ export * from "./CreateGuestSessionResponse.mjs";
5
9
  export * from "./CreateOrganizationResponse.mjs";
6
10
  export * from "./CreateTokenResponse.mjs";
7
11
  export * from "./Expired.mjs";
12
+ export * from "./GuestSessionLimits.mjs";
8
13
  export * from "./HttpValidationError.mjs";
9
14
  export * from "./JwtResponse.mjs";
10
15
  export * from "./LightweightUser.mjs";
@@ -1,10 +1,15 @@
1
1
  export * from "./Active.mjs";
2
+ export * from "./ClaimOrganizationRequest.mjs";
3
+ export * from "./ClaimOrganizationResponse.mjs";
4
+ export * from "./ClaimPreviewResponse.mjs";
2
5
  export * from "./ClaimStatus.mjs";
3
6
  export * from "./ClaimStatusResponse.mjs";
4
7
  export * from "./ClaimTokenResponse.mjs";
8
+ export * from "./CreateGuestSessionResponse.mjs";
5
9
  export * from "./CreateOrganizationResponse.mjs";
6
10
  export * from "./CreateTokenResponse.mjs";
7
11
  export * from "./Expired.mjs";
12
+ export * from "./GuestSessionLimits.mjs";
8
13
  export * from "./HttpValidationError.mjs";
9
14
  export * from "./JwtResponse.mjs";
10
15
  export * from "./LightweightUser.mjs";
@@ -0,0 +1 @@
1
+ export * from "./requests/index.mjs";
@@ -0,0 +1 @@
1
+ export * from "./requests/index.mjs";
@@ -0,0 +1,11 @@
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 CreateGuestSessionRequest: core.serialization.Schema<serializers.CreateGuestSessionRequest.Raw, FernVenusApi.CreateGuestSessionRequest>;
5
+ export declare namespace CreateGuestSessionRequest {
6
+ interface Raw {
7
+ fingerprint: string;
8
+ clientVersion?: (string | null | undefined) | null;
9
+ requestedOrgName?: (string | null | undefined) | null;
10
+ }
11
+ }
@@ -0,0 +1,7 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../../../../core/index.mjs";
3
+ export const CreateGuestSessionRequest = core.serialization.object({
4
+ fingerprint: core.serialization.string(),
5
+ clientVersion: core.serialization.string().optionalNullable(),
6
+ requestedOrgName: core.serialization.string().optionalNullable(),
7
+ });
@@ -0,0 +1 @@
1
+ export { CreateGuestSessionRequest } from "./CreateGuestSessionRequest.mjs";
@@ -0,0 +1 @@
1
+ export { CreateGuestSessionRequest } from "./CreateGuestSessionRequest.mjs";
@@ -0,0 +1 @@
1
+ export * from "./client/index.mjs";
@@ -0,0 +1 @@
1
+ export * from "./client/index.mjs";
@@ -2,6 +2,8 @@ export * from "./apiKeys/client/requests/index.mjs";
2
2
  export * as apiKeys from "./apiKeys/index.mjs";
3
3
  export * from "./auth/client/requests/index.mjs";
4
4
  export * as auth from "./auth/index.mjs";
5
+ export * from "./guestSession/client/requests/index.mjs";
6
+ export * as guestSession from "./guestSession/index.mjs";
5
7
  export * from "./organization/client/requests/index.mjs";
6
8
  export * as organization from "./organization/index.mjs";
7
9
  export * from "./registry/client/requests/index.mjs";
@@ -2,6 +2,8 @@ export * from "./apiKeys/client/requests/index.mjs";
2
2
  export * as apiKeys from "./apiKeys/index.mjs";
3
3
  export * from "./auth/client/requests/index.mjs";
4
4
  export * as auth from "./auth/index.mjs";
5
+ export * from "./guestSession/client/requests/index.mjs";
6
+ export * as guestSession from "./guestSession/index.mjs";
5
7
  export * from "./organization/client/requests/index.mjs";
6
8
  export * as organization from "./organization/index.mjs";
7
9
  export * from "./registry/client/requests/index.mjs";
@@ -0,0 +1,9 @@
1
+ import type * as FernVenusApi from "../../api/index.mjs";
2
+ import * as core from "../../core/index.mjs";
3
+ import type * as serializers from "../index.mjs";
4
+ export declare const ClaimOrganizationRequest: core.serialization.ObjectSchema<serializers.ClaimOrganizationRequest.Raw, FernVenusApi.ClaimOrganizationRequest>;
5
+ export declare namespace ClaimOrganizationRequest {
6
+ interface Raw {
7
+ claimToken: string;
8
+ }
9
+ }
@@ -0,0 +1,5 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.mjs";
3
+ export const ClaimOrganizationRequest = core.serialization.object({
4
+ claimToken: core.serialization.string(),
5
+ });
@@ -0,0 +1,11 @@
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 ClaimOrganizationResponse: core.serialization.ObjectSchema<serializers.ClaimOrganizationResponse.Raw, FernVenusApi.ClaimOrganizationResponse>;
5
+ export declare namespace ClaimOrganizationResponse {
6
+ interface Raw {
7
+ organizationId: string;
8
+ auth0Id: string;
9
+ displayName: string;
10
+ }
11
+ }
@@ -0,0 +1,7 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.mjs";
3
+ export const ClaimOrganizationResponse = core.serialization.object({
4
+ organizationId: core.serialization.string(),
5
+ auth0Id: core.serialization.string(),
6
+ displayName: core.serialization.string(),
7
+ });
@@ -0,0 +1,14 @@
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 ClaimPreviewResponse: core.serialization.ObjectSchema<serializers.ClaimPreviewResponse.Raw, FernVenusApi.ClaimPreviewResponse>;
6
+ export declare namespace ClaimPreviewResponse {
7
+ interface Raw {
8
+ organizationId: string;
9
+ displayName: string;
10
+ claimStatus: ClaimStatus.Raw;
11
+ expiresAt: string;
12
+ redeemed: boolean;
13
+ }
14
+ }
@@ -0,0 +1,10 @@
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 ClaimPreviewResponse = core.serialization.object({
5
+ organizationId: core.serialization.string(),
6
+ displayName: core.serialization.string(),
7
+ claimStatus: ClaimStatus,
8
+ expiresAt: core.serialization.date(),
9
+ redeemed: core.serialization.boolean(),
10
+ });
@@ -0,0 +1,15 @@
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 { GuestSessionLimits } from "./GuestSessionLimits.mjs";
5
+ export declare const CreateGuestSessionResponse: core.serialization.ObjectSchema<serializers.CreateGuestSessionResponse.Raw, FernVenusApi.CreateGuestSessionResponse>;
6
+ export declare namespace CreateGuestSessionResponse {
7
+ interface Raw {
8
+ sessionId: string;
9
+ organizationId: string;
10
+ token: string;
11
+ claimSecret: string;
12
+ expiresAt: string;
13
+ limits: GuestSessionLimits.Raw;
14
+ }
15
+ }
@@ -0,0 +1,11 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.mjs";
3
+ import { GuestSessionLimits } from "./GuestSessionLimits.mjs";
4
+ export const CreateGuestSessionResponse = core.serialization.object({
5
+ sessionId: core.serialization.string(),
6
+ organizationId: core.serialization.string(),
7
+ token: core.serialization.string(),
8
+ claimSecret: core.serialization.string(),
9
+ expiresAt: core.serialization.date(),
10
+ limits: GuestSessionLimits,
11
+ });
@@ -0,0 +1,10 @@
1
+ import type * as FernVenusApi from "../../api/index.mjs";
2
+ import * as core from "../../core/index.mjs";
3
+ import type * as serializers from "../index.mjs";
4
+ export declare const GuestSessionLimits: core.serialization.ObjectSchema<serializers.GuestSessionLimits.Raw, FernVenusApi.GuestSessionLimits>;
5
+ export declare namespace GuestSessionLimits {
6
+ interface Raw {
7
+ sdkBuilds: number;
8
+ docsPublishes: number;
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
+ export const GuestSessionLimits = core.serialization.object({
4
+ sdkBuilds: core.serialization.number(),
5
+ docsPublishes: core.serialization.number(),
6
+ });