@fern-api/venus-api-sdk 0.16.0-1-geacea4f → 0.17.2-1-g21bb024

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index.js";
+import * as core from "../../../../core/index.js";
+export type Error = FernVenusApi.organization.isMember.Error._Unknown;
+export declare namespace Error {
+    interface _Unknown extends _Utils {
+        error: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.organization.isMember.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.isMember.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.organization.isMember.Error, visitor: FernVenusApi.organization.isMember.Error._Visitor<_Result>) => _Result;
+};

package/dist/cjs/api/resources/organization/client/isMember.js

@@ -0,0 +1,57 @@
+"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 = {
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.organization.isMember.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            default:
+                return visitor._other(value);
+        }
+    },
+};

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

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index.js";
+import * as core from "../../../../core/index.js";
+export type Error = FernVenusApi.organization.removeUser.Error.UnauthorizedError | FernVenusApi.organization.removeUser.Error.UserIdDoesNotExistError | FernVenusApi.organization.removeUser.Error._Unknown;
+export declare namespace Error {
+    interface UnauthorizedError extends _Utils {
+        error: "UnauthorizedError";
+    }
+    interface UserIdDoesNotExistError extends _Utils {
+        error: "UserIdDoesNotExistError";
+    }
+    interface _Unknown extends _Utils {
+        error: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.organization.removeUser.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unauthorizedError: () => _Result;
+        userIdDoesNotExistError: () => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unauthorizedError: () => FernVenusApi.organization.removeUser.Error.UnauthorizedError;
+    readonly userIdDoesNotExistError: () => FernVenusApi.organization.removeUser.Error.UserIdDoesNotExistError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.removeUser.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.organization.removeUser.Error, visitor: FernVenusApi.organization.removeUser.Error._Visitor<_Result>) => _Result;
+};

package/dist/cjs/api/resources/organization/client/removeUser.js

@@ -0,0 +1,77 @@
+"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 = {
+    unauthorizedError: () => {
+        return {
+            error: "UnauthorizedError",
+            _visit: function (visitor) {
+                return FernVenusApi.organization.removeUser.Error._visit(this, visitor);
+            },
+        };
+    },
+    userIdDoesNotExistError: () => {
+        return {
+            error: "UserIdDoesNotExistError",
+            _visit: function (visitor) {
+                return FernVenusApi.organization.removeUser.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.organization.removeUser.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            case "UnauthorizedError":
+                return visitor.unauthorizedError();
+            case "UserIdDoesNotExistError":
+                return visitor.userIdDoesNotExistError();
+            default:
+                return visitor._other(value);
+        }
+    },
+};

package/dist/cjs/api/resources/organization/client/requests/AddUserToOrgRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         userId: FernVenusApi.UserId("userId"),
+ *         orgId: FernVenusApi.OrganizationId("orgId")
+ *     }
+ */
+export interface AddUserToOrgRequest {
+    userId: FernVenusApi.UserId;
+    orgId: FernVenusApi.OrganizationId;
+}

package/dist/cjs/api/resources/organization/client/requests/CreateOrganizationRequest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         organizationId: FernVenusApi.OrganizationId("organizationId"),
+ *         displayName: undefined,
+ *         artifactReadRequiresToken: undefined,
+ *         enableGithubConnection: undefined
+ *     }
+ */
+export interface CreateOrganizationRequest {
+    organizationId: FernVenusApi.OrganizationId;
+    displayName?: string;
+    /** Defaults to False */
+    artifactReadRequiresToken?: boolean;
+    /**
+     * Allow users to log into the organization with their GitHub account, necessary for accepting organizations today.
+     * This is a field to allow for us to create organizations without this in the future if necessary.
+     */
+    enableGithubConnection?: boolean;
+}

package/dist/cjs/api/resources/organization/client/requests/InviteUserToOrgRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         emailAddress: "emailAddress",
+ *         auth0OrgId: FernVenusApi.OrganizationId("auth0OrgId")
+ *     }
+ */
+export interface InviteUserToOrgRequest {
+    emailAddress: string;
+    auth0OrgId: FernVenusApi.OrganizationId;
+}

package/dist/cjs/api/resources/organization/client/requests/RemoveUserFromOrgRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         userId: "userId",
+ *         auth0OrgId: FernVenusApi.OrganizationId("auth0OrgId")
+ *     }
+ */
+export interface RemoveUserFromOrgRequest {
+    userId: string;
+    auth0OrgId: FernVenusApi.OrganizationId;
+}

package/dist/cjs/api/resources/organization/client/requests/index.d.ts

@@ -0,0 +1,7 @@
+export { type CreateOrganizationRequest } from "./CreateOrganizationRequest.js";
+export { type UpdateOrganizationRequest } from "./UpdateOrganizationRequest.js";
+export { type GetOrganizationRequest } from "./GetOrganizationRequest.js";
+export { type GetMyOrganizationFromScopedToken } from "./GetMyOrganizationFromScopedToken.js";
+export { type AddUserToOrgRequest } from "./AddUserToOrgRequest.js";
+export { type InviteUserToOrgRequest } from "./InviteUserToOrgRequest.js";
+export { type RemoveUserFromOrgRequest } from "./RemoveUserFromOrgRequest.js";

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index.js";
+import * as core from "../../../../core/index.js";
+export type Error = FernVenusApi.organization.update.Error.UnauthorizedError | FernVenusApi.organization.update.Error._Unknown;
+export declare namespace Error {
+    interface UnauthorizedError extends _Utils {
+        error: "UnauthorizedError";
+    }
+    interface _Unknown extends _Utils {
+        error: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.organization.update.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unauthorizedError: () => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unauthorizedError: () => FernVenusApi.organization.update.Error.UnauthorizedError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.organization.update.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.organization.update.Error, visitor: FernVenusApi.organization.update.Error._Visitor<_Result>) => _Result;
+};

package/dist/cjs/api/resources/organization/client/update.js

@@ -0,0 +1,67 @@
+"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 = {
+    unauthorizedError: () => {
+        return {
+            error: "UnauthorizedError",
+            _visit: function (visitor) {
+                return FernVenusApi.organization.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.organization.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            case "UnauthorizedError":
+                return visitor.unauthorizedError();
+            default:
+                return visitor._other(value);
+        }
+    },
+};

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

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

package/dist/cjs/api/resources/organization/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("./types/index.js"), exports);
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/organization/types/CreateOrganizationResponse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index.js";
+export interface CreateOrganizationResponse {
+    /**
+     * the ID of the organization. (This may be different from the
+     * organizationId passed in with the create request because auth0 has
+     * strict requirements on organization names)
+     */
+    organizationId: FernVenusApi.OrganizationId;
+}

package/dist/cjs/api/resources/organization/types/Organization.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index.js";
+export interface Organization {
+    organizationId: FernVenusApi.OrganizationId;
+    auth0Id: string;
+    displayName: string;
+    artifactReadRequiresToken: boolean;
+    users: FernVenusApi.LightweightUser[];
+    /** If the organization has paid for whitelabelling. */
+    isWhitelabled: boolean;
+    /** If the organization has paid for previews. */
+    previewEnabled: boolean;
+    /** If the organization has paid for snippets. */
+    snippetsEnabled: boolean;
+    /** If the organization has paid for snippet unit tests. */
+    snippetUnitTestsEnabled: boolean;
+    /** If the organization has paid for the snippets API. */
+    snippetsApiAccessEnabled: boolean;
+    /** If the organization has paid for dynamic snippet templates. */
+    snippetTemplatesAccessEnabled: boolean;
+    /** If the organization has paid for the the auto-pagination feature. */
+    paginationEnabled: boolean;
+    /** If the organization has paid for changelog generation. */
+    changeLogEnabled: boolean;
+    /** If the organization is canarying fernbot automation features. */
+    isFernbotCanary: boolean;
+    /** If the organization has paid for automated oauth clients within their SDKs. */
+    oauthClientEnabled: boolean;
+    /** If the organization has paid for api playground. */
+    apiPlaygroundEnabled: boolean;
+    /** If the organization has sso enabled. */
+    workosOrganizationId?: string;
+    /** If the organization has self hosted SDKs enabled. */
+    selfHostedSdKs: boolean;
+}

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

@@ -0,0 +1,3 @@
+export * from "./Organization.js";
+export * from "./LightweightUser.js";
+export * from "./CreateOrganizationResponse.js";

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

@@ -0,0 +1,19 @@
+"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("./Organization.js"), exports);
+__exportStar(require("./LightweightUser.js"), exports);
+__exportStar(require("./CreateOrganizationResponse.js"), exports);

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

@@ -0,0 +1,67 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core/index.js";
+import * as FernVenusApi from "../../../index.js";
+export declare namespace Registry {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Registry {
+    protected readonly _options: Registry.Options;
+    constructor(_options: Registry.Options);
+    /**
+     * @param {FernVenusApi.GenerateRegistryTokensRequest} request
+     * @param {Registry.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.registry.generateRegistryTokens({
+     *         organizationId: FernVenusApi.OrganizationId("organizationId")
+     *     })
+     */
+    generateRegistryTokens(request: FernVenusApi.GenerateRegistryTokensRequest, requestOptions?: Registry.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.RegistryTokens, FernVenusApi.registry.generateRegistryTokens.Error>>;
+    private __generateRegistryTokens;
+    /**
+     * @param {FernVenusApi.CheckRegistryPermissionRequest} request
+     * @param {Registry.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.registry.hasRegistryPermission({
+     *         organizationId: FernVenusApi.OrganizationId("organizationId"),
+     *         token: undefined
+     *     })
+     */
+    hasRegistryPermission(request: FernVenusApi.CheckRegistryPermissionRequest, requestOptions?: Registry.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.registry.hasRegistryPermission.Error>>;
+    private __hasRegistryPermission;
+    /**
+     * @param {FernVenusApi.RevokeTokenRequest} request
+     * @param {Registry.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.registry.revokeToken({
+     *         organizationId: FernVenusApi.OrganizationId("organizationId"),
+     *         token: "token"
+     *     })
+     */
+    revokeToken(request: FernVenusApi.RevokeTokenRequest, requestOptions?: Registry.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.registry.revokeToken.Error>>;
+    private __revokeToken;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}