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

package/dist/cjs/api/resources/internalGuestSession/client/settle.js

@@ -0,0 +1,66 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const FernVenusApi = __importStar(require("../../../index.js"));
+exports.Error = {
+    unprocessableEntityError: (value) => {
+        return {
+            content: value,
+            statusCode: 422,
+            _visit: function (visitor) {
+                return FernVenusApi.internalGuestSession.settle.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            statusCode: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.internalGuestSession.settle.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.statusCode) {
+            case 422:
+                return visitor.unprocessableEntityError(value.content);
+            default:
+                return visitor._other(value.content);
+        }
+    },
+};

package/dist/cjs/api/resources/internalGuestSession/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/internalGuestSession/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/internalGuestSession/types/ReserveRequestKind.d.ts

@@ -0,0 +1,5 @@
+export declare const ReserveRequestKind: {
+    readonly SdkBuild: "sdkBuild";
+    readonly DocsPublish: "docsPublish";
+};
+export type ReserveRequestKind = (typeof ReserveRequestKind)[keyof typeof ReserveRequestKind];

package/dist/cjs/api/resources/internalGuestSession/types/ReserveRequestKind.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReserveRequestKind = void 0;
+exports.ReserveRequestKind = {
+    SdkBuild: "sdkBuild",
+    DocsPublish: "docsPublish",
+};

package/dist/cjs/api/resources/internalGuestSession/types/SettleRequestOutcome.d.ts

@@ -0,0 +1,5 @@
+export declare const SettleRequestOutcome: {
+    readonly Succeeded: "succeeded";
+    readonly Failed: "failed";
+};
+export type SettleRequestOutcome = (typeof SettleRequestOutcome)[keyof typeof SettleRequestOutcome];

package/dist/cjs/api/resources/internalGuestSession/types/SettleRequestOutcome.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettleRequestOutcome = void 0;
+exports.SettleRequestOutcome = {
+    Succeeded: "succeeded",
+    Failed: "failed",
+};

package/dist/cjs/api/resources/internalGuestSession/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ReserveRequestKind.js";
+export * from "./SettleRequestOutcome.js";

package/dist/cjs/api/resources/internalGuestSession/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ReserveRequestKind.js"), exports);
+__exportStar(require("./SettleRequestOutcome.js"), exports);

package/dist/cjs/api/resources/organization/client/Client.d.ts

@@ -11,6 +11,13 @@ export declare class OrganizationClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
     constructor(options: OrganizationClient.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.
      *
@@ -45,6 +52,9 @@ export declare class OrganizationClient {
     private __get;
     /**
      * 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.
@@ -69,6 +79,22 @@ export declare class OrganizationClient {
      */
     getOrgIdsByPostmanTeamId(request: FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error>>;
     private __getOrgIdsByPostmanTeamId;
+    /**
+     * 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: FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error>>;
+    private __getPostmanTeamDocs;
     /**
      * Get the Postman team ID associated with an organization ID.
      *
@@ -82,6 +108,104 @@ export declare class OrganizationClient {
      */
     getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
     private __getPostmanTeamIdByOrgId;
+    /**
+     * 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: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
+    private __getClaimStatus;
+    /**
+     * 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: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
+    private __createClaimToken;
+    /**
+     * 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: FernVenusApi.SetDocsUrlRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error>>;
+    private __setDocsUrl;
+    /**
+     * 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: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claim.Error>>;
+    private __claim;
+    /**
+     * 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: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimPreviewResponse, FernVenusApi.organization.previewClaim.Error>>;
+    private __previewClaim;
+    /**
+     * 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: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claimFromDocsSite.Error>>;
+    private __claimFromDocsSite;
     /**
      * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.