@fern-api/venus-api-sdk 0.10.0 → 0.10.1-2-g8c943d4

package/dist/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";
+/**
+ * @example
+ *     {
+ *         userId: FernVenusApi.UserId("string"),
+ *         orgId: FernVenusApi.OrganizationId("string")
+ *     }
+ */
+export interface AddUserToOrgRequest {
+    userId: FernVenusApi.UserId;
+    orgId: FernVenusApi.OrganizationId;
+}

package/dist/api/resources/organization/client/requests/AddUserToOrgRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../../index";
+/**
+ * @example
+ *     {
+ *         organizationId: FernVenusApi.OrganizationId("string"),
+ *         artifactReadRequiresToken: true,
+ *         enableGithubConnection: true
+ *     }
+ */
+export interface CreateOrganizationRequest {
+    organizationId: FernVenusApi.OrganizationId;
+    /** 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/api/resources/organization/client/requests/CreateOrganizationRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/organization/client/requests/GetMyOrganizationFromScopedToken.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         shouldIncludeFernUsers: true
+ *     }
+ */
+export interface GetMyOrganizationFromScopedToken {
+    shouldIncludeFernUsers?: boolean;
+}

package/dist/api/resources/organization/client/requests/GetMyOrganizationFromScopedToken.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/organization/client/requests/GetOrganizationRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         shouldIncludeFernUsers: true
+ *     }
+ */
+export interface GetOrganizationRequest {
+    shouldIncludeFernUsers?: boolean;
+}

package/dist/api/resources/organization/client/requests/GetOrganizationRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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";
+/**
+ * @example
+ *     {
+ *         emailAddress: "string",
+ *         auth0OrgId: FernVenusApi.OrganizationId("string")
+ *     }
+ */
+export interface InviteUserToOrgRequest {
+    emailAddress: string;
+    auth0OrgId: FernVenusApi.OrganizationId;
+}

package/dist/api/resources/organization/client/requests/InviteUserToOrgRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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";
+/**
+ * @example
+ *     {
+ *         userId: "string",
+ *         auth0OrgId: FernVenusApi.OrganizationId("string")
+ *     }
+ */
+export interface RemoveUserFromOrgRequest {
+    userId: string;
+    auth0OrgId: FernVenusApi.OrganizationId;
+}

package/dist/api/resources/organization/client/requests/RemoveUserFromOrgRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/organization/client/requests/UpdateOrganizationRequest.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         artifactReadRequiresToken: true,
+ *         isWhitelabeled: true,
+ *         previewEnabled: true,
+ *         snippetsEnabled: true,
+ *         snippetUnitTestsEnabled: true,
+ *         snippetsApiAccessEnabled: true,
+ *         snippetTemplatesAccessEnabled: true,
+ *         paginationEnabled: true,
+ *         changeLogEnabled: true,
+ *         isFernbotCanary: true,
+ *         oauthClientEnabled: true,
+ *         apiPlaygroundEnabled: true,
+ *         workosOrganizationId: "string"
+ *     }
+ */
+export interface UpdateOrganizationRequest {
+    /** If not present, does not update value. */
+    artifactReadRequiresToken?: boolean;
+    /** If not present, does not update value. */
+    isWhitelabeled?: boolean;
+    /** If not present, does not update value. */
+    previewEnabled?: boolean;
+    /** If not present, does not update value. */
+    snippetsEnabled?: boolean;
+    /** If not present, does not update value. */
+    snippetUnitTestsEnabled?: boolean;
+    /** If not present, does not update value. */
+    snippetsApiAccessEnabled?: boolean;
+    /** If not present, does not update value. */
+    snippetTemplatesAccessEnabled?: boolean;
+    /** If not present, does not update value. */
+    paginationEnabled?: boolean;
+    /** If not present, does not update value. */
+    changeLogEnabled?: boolean;
+    /** If not present, does not update value. */
+    isFernbotCanary?: boolean;
+    /** If not present, does not update value. */
+    oauthClientEnabled?: boolean;
+    /** If not present, does not update value. */
+    apiPlaygroundEnabled?: boolean;
+    /** If not present, does not update value. */
+    workosOrganizationId?: string;
+}

package/dist/api/resources/organization/client/requests/UpdateOrganizationRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/api/resources/organization/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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";
+import * as core from "../../../../core";
+export declare 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/api/resources/organization/client/update.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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const FernVenusApi = __importStar(require("../../../index"));
+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/api/resources/organization/index.d.ts

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

package/dist/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"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/resources/organization/types/LightweightUser.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LightweightUser {
+    userId: string;
+    displayName: string;
+    pictureUrl?: string;
+    emailAddress?: string;
+}

package/dist/api/resources/organization/types/LightweightUser.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as FernVenusApi from "../../../index";
+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;
+}

package/dist/api/resources/organization/types/Organization.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,2 @@
+export * from "./Organization";
+export * from "./LightweightUser";

package/dist/api/resources/organization/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("./Organization"), exports);
+__exportStar(require("./LightweightUser"), exports);

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

@@ -0,0 +1,59 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as FernVenusApi from "../../../index";
+export declare namespace Registry {
+    interface Options {
+        environment: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | 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;
+    }
+}
+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("string")
+     *     })
+     */
+    generateRegistryTokens(request: FernVenusApi.GenerateRegistryTokensRequest, requestOptions?: Registry.RequestOptions): Promise<core.APIResponse<FernVenusApi.RegistryTokens, FernVenusApi.registry.generateRegistryTokens.Error>>;
+    /**
+     * @param {FernVenusApi.CheckRegistryPermissionRequest} request
+     * @param {Registry.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.registry.hasRegistryPermission({
+     *         organizationId: FernVenusApi.OrganizationId("string"),
+     *         token: {
+     *             type: "npm",
+     *             token: "string"
+     *         }
+     *     })
+     */
+    hasRegistryPermission(request: FernVenusApi.CheckRegistryPermissionRequest, requestOptions?: Registry.RequestOptions): Promise<core.APIResponse<boolean, FernVenusApi.registry.hasRegistryPermission.Error>>;
+    /**
+     * @param {FernVenusApi.RevokeTokenRequest} request
+     * @param {Registry.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.registry.revokeToken({
+     *         organizationId: FernVenusApi.OrganizationId("string"),
+     *         token: "string"
+     *     })
+     */
+    revokeToken(request: FernVenusApi.RevokeTokenRequest, requestOptions?: Registry.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.registry.revokeToken.Error>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}