@fern-api/venus-api-sdk 13.0.0 → 14.0.0

package/dist/esm/api/resources/organization/client/Client.mjs

@@ -29,6 +29,13 @@ export class OrganizationClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Creates an organization with the caller as its admin. Called with the
+     * provisioner token, it instead creates an unclaimed organization, with no
+     * Auth0 organization or members, linked to the required postmanTeamId.
+     * Creating it again for the same team returns the same organization.
+     * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
+     * organization, since that team claims its organization through Postman.
+     *
      * @param {FernVenusApi.CreateOrganizationRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -263,6 +270,9 @@ export class OrganizationClient {
     }
     /**
      * Deletes an organization. Only users with admin role can delete organizations.
+     * Called with the provisioner token, it only works for an unclaimed
+     * organization that was created with that token, and returns 403 for any
+     * other. It also revokes that organization's API keys.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -409,6 +419,86 @@ export class OrganizationClient {
             };
         });
     }
+    /**
+     * The claimable organization linked to a Postman team, with its claim
+     * status and the address of its docs site. Only Postman's integration
+     * service token can call it. 404 when the team has no claimable
+     * organization, or its docs address isn't set.
+     *
+     * @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getPostmanTeamDocs({
+     *         postmanTeamId: "postman_team_id"
+     *     })
+     */
+    getPostmanTeamDocs(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getPostmanTeamDocs(request, requestOptions));
+    }
+    __getPostmanTeamDocs(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { postmanTeamId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.PostmanTeamDocsResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.getPostmanTeamDocs.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.getPostmanTeamDocs.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
     /**
      * Get the Postman team ID associated with an organization ID.
      *
@@ -486,6 +576,509 @@ export class OrganizationClient {
             };
         });
     }
+    /**
+     * Whether a claimable organization has been claimed. Public, so a docs
+     * site can show a claim banner to signed-out visitors. Organizations
+     * that were never claimable return 404.
+     *
+     * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getClaimStatus({
+     *         orgId: "org_id"
+     *     })
+     */
+    getClaimStatus(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getClaimStatus(request, requestOptions));
+    }
+    __getClaimStatus(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orgId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.ClaimStatusResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.getClaimStatus.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.getClaimStatus.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * Issues a claim link for an unclaimed organization, bound to one Postman
+     * user and valid for 15 minutes. Only the provisioner token and Postman's
+     * integration service token can call it.
+     *
+     * @param {FernVenusApi.CreateClaimTokenRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.createClaimToken({
+     *         orgId: "org_id",
+     *         postmanUserId: "postmanUserId"
+     *     })
+     */
+    createClaimToken(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createClaimToken(request, requestOptions));
+    }
+    __createClaimToken(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orgId } = request, _body = __rest(request, ["orgId"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `organizations/${core.url.encodePathParam(orgId)}/claim-tokens`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.CreateClaimTokenRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.ClaimTokenResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.createClaimToken.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.createClaimToken.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * Sets the address of an unclaimed organization's docs site, which the
+     * team docs lookup returns. Only the provisioner token can call it, and
+     * only until the organization is claimed.
+     *
+     * @param {FernVenusApi.SetDocsUrlRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.setDocsUrl({
+     *         orgId: "org_id",
+     *         docsUrl: "docsUrl"
+     *     })
+     */
+    setDocsUrl(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__setDocsUrl(request, requestOptions));
+    }
+    __setDocsUrl(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { orgId } = request, _body = __rest(request, ["orgId"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.SetDocsUrlRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: undefined,
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.setDocsUrl.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.setDocsUrl.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * Redeems a claim link. The caller, signed in as the Postman user the link
+     * is for, becomes the admin of the organization. The first claim wins, and
+     * a retry by the same user finishes a claim that failed partway.
+     *
+     * @param {FernVenusApi.ClaimOrganizationRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.claim({
+     *         claimToken: "claimToken"
+     *     })
+     */
+    claim(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__claim(request, requestOptions));
+    }
+    __claim(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.ClaimOrganizationRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.ClaimOrganizationResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.claim.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.claim.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * What a claim link is for, without redeeming it, so the dashboard can show
+     * the organization and the link's state before the user signs in. Public:
+     * the link is the secret. The token is in the body to keep it out of
+     * request logs.
+     *
+     * @param {FernVenusApi.ClaimOrganizationRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.previewClaim({
+     *         claimToken: "claimToken"
+     *     })
+     */
+    previewClaim(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__previewClaim(request, requestOptions));
+    }
+    __previewClaim(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.ClaimOrganizationRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.ClaimPreviewResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.previewClaim.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.previewClaim.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
+    /**
+     * Redeems a claim link without a Fern sign-in, for the Claim button on
+     * the organization's docs site. The organization is claimed for the
+     * Postman user the link was issued for, who becomes its admin if they
+     * already have a Fern account; otherwise the organization starts with
+     * no members, and the dashboard adds the team's Postman users when they
+     * sign in with Postman. Public: the link is the secret, and only the
+     * provisioner and Postman's integration service can get one. The first
+     * claim wins, and a retry finishes a claim that failed partway.
+     *
+     * @param {FernVenusApi.ClaimOrganizationRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.claimFromDocsSite({
+     *         claimToken: "claimToken"
+     *     })
+     */
+    claimFromDocsSite(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__claimFromDocsSite(request, requestOptions));
+    }
+    __claimFromDocsSite(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            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);
+            const _response = yield core.fetcher({
+                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/docs-site"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.ClaimOrganizationRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: {
+                        ok: true,
+                        body: serializers.ClaimOrganizationResponse.parseOrThrow(_response.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }),
+                        headers: _response.headers,
+                        rawResponse: _response.rawResponse,
+                    },
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        return {
+                            data: {
+                                ok: false,
+                                error: FernVenusApi.organization.claimFromDocsSite.Error.unprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    skipValidation: true,
+                                    breadcrumbsPrefix: ["response"],
+                                })),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
+            return {
+                data: {
+                    ok: false,
+                    error: FernVenusApi.organization.claimFromDocsSite.Error._unknown(_response.error),
+                    rawResponse: _response.rawResponse,
+                },
+                rawResponse: _response.rawResponse,
+            };
+        });
+    }
     /**
      * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/organization/client/claim.d.mts

@@ -0,0 +1,25 @@
+import type * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export type Error = FernVenusApi.organization.claim.Error.UnprocessableEntityError | FernVenusApi.organization.claim.Error._Unknown;
+export declare namespace Error {
+    interface UnprocessableEntityError extends _Utils {
+        statusCode: 422;
+        content: FernVenusApi.HttpValidationError;
+    }
+    interface _Unknown extends _Utils {
+        statusCode: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.organization.claim.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unprocessableEntityError: (value: FernVenusApi.HttpValidationError) => FernVenusApi.organization.claim.Error.UnprocessableEntityError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.claim.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.organization.claim.Error, visitor: FernVenusApi.organization.claim.Error._Visitor<_Result>) => _Result;
+};