@fern-api/venus-api-sdk 0.19.9 → 0.19.10-2-g57e8df1

package/dist/esm/api/resources/apiKeys/client/getTokensForOrganization.mjs

@@ -0,0 +1,39 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as FernVenusApi from "../../../index.mjs";
+export const Error = {
+    unauthorizedError: () => {
+        return {
+            error: "UnauthorizedError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.getTokensForOrganization.Error._visit(this, visitor);
+            },
+        };
+    },
+    organizationNotFoundError: () => {
+        return {
+            error: "OrganizationNotFoundError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.getTokensForOrganization.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.getTokensForOrganization.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            case "UnauthorizedError":
+                return visitor.unauthorizedError();
+            case "OrganizationNotFoundError":
+                return visitor.organizationNotFoundError();
+            default:
+                return visitor._other(value);
+        }
+    },
+};

package/dist/esm/api/resources/apiKeys/client/index.d.mts

@@ -0,0 +1,6 @@
+export * as create from "./create.mjs";
+export * as getTokenMetadata from "./getTokenMetadata.mjs";
+export * as getTokensForOrganization from "./getTokensForOrganization.mjs";
+export * from "./requests/index.mjs";
+export * as revokeToken from "./revokeToken.mjs";
+export * as revokeTokenById from "./revokeTokenById.mjs";

package/dist/esm/api/resources/apiKeys/client/index.mjs

@@ -0,0 +1,6 @@
+export * as create from "./create.mjs";
+export * as getTokenMetadata from "./getTokenMetadata.mjs";
+export * as getTokensForOrganization from "./getTokensForOrganization.mjs";
+export * from "./requests/index.mjs";
+export * as revokeToken from "./revokeToken.mjs";
+export * as revokeTokenById from "./revokeTokenById.mjs";

package/dist/esm/api/resources/apiKeys/client/requests/CreateApiKeyRequest.d.mts

@@ -0,0 +1,18 @@
+import type * as FernVenusApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         organizationId: "some-org-id"
+ *     }
+ *
+ * @example
+ *     {
+ *         organizationId: "missing-org-id"
+ *     }
+ */
+export interface CreateApiKeyRequest {
+    organizationId: FernVenusApi.OrganizationId;
+    /** If specified, the token will be <prefix>_<token> */
+    prefix?: string;
+    description?: string;
+}

package/dist/esm/api/resources/apiKeys/client/requests/CreateApiKeyRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/client/requests/GetTokenMetadataRequest.d.mts

@@ -0,0 +1,14 @@
+/**
+ * @example
+ *     {
+ *         token: "token-value"
+ *     }
+ *
+ * @example
+ *     {
+ *         token: "missing-token-value"
+ *     }
+ */
+export interface GetTokenMetadataRequest {
+    token: string;
+}

package/dist/esm/api/resources/apiKeys/client/requests/GetTokenMetadataRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/client/requests/RevokeApiKeyRequest.d.mts

@@ -0,0 +1,14 @@
+/**
+ * @example
+ *     {
+ *         token: "some-token-value"
+ *     }
+ *
+ * @example
+ *     {
+ *         token: "missing-token-value"
+ *     }
+ */
+export interface RevokeApiKeyRequest {
+    token: string;
+}

package/dist/esm/api/resources/apiKeys/client/requests/RevokeApiKeyRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export type { CreateApiKeyRequest } from "./CreateApiKeyRequest.mjs";
+export type { GetTokenMetadataRequest } from "./GetTokenMetadataRequest.mjs";
+export type { RevokeApiKeyRequest } from "./RevokeApiKeyRequest.mjs";

package/dist/esm/api/resources/apiKeys/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/apiKeys/client/revokeToken.d.mts

@@ -0,0 +1,29 @@
+import type * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export type Error = FernVenusApi.apiKeys.revokeToken.Error.UnauthorizedError | FernVenusApi.apiKeys.revokeToken.Error.TokenNotFoundError | FernVenusApi.apiKeys.revokeToken.Error._Unknown;
+export declare namespace Error {
+    interface UnauthorizedError extends _Utils {
+        error: "UnauthorizedError";
+    }
+    interface TokenNotFoundError extends _Utils {
+        error: "TokenNotFoundError";
+    }
+    interface _Unknown extends _Utils {
+        error: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.apiKeys.revokeToken.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unauthorizedError: () => _Result;
+        tokenNotFoundError: () => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unauthorizedError: () => FernVenusApi.apiKeys.revokeToken.Error.UnauthorizedError;
+    readonly tokenNotFoundError: () => FernVenusApi.apiKeys.revokeToken.Error.TokenNotFoundError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.apiKeys.revokeToken.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.apiKeys.revokeToken.Error, visitor: FernVenusApi.apiKeys.revokeToken.Error._Visitor<_Result>) => _Result;
+};

package/dist/esm/api/resources/apiKeys/client/revokeToken.mjs

@@ -0,0 +1,39 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as FernVenusApi from "../../../index.mjs";
+export const Error = {
+    unauthorizedError: () => {
+        return {
+            error: "UnauthorizedError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeToken.Error._visit(this, visitor);
+            },
+        };
+    },
+    tokenNotFoundError: () => {
+        return {
+            error: "TokenNotFoundError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeToken.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeToken.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            case "UnauthorizedError":
+                return visitor.unauthorizedError();
+            case "TokenNotFoundError":
+                return visitor.tokenNotFoundError();
+            default:
+                return visitor._other(value);
+        }
+    },
+};

package/dist/esm/api/resources/apiKeys/client/revokeTokenById.d.mts

@@ -0,0 +1,29 @@
+import type * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export type Error = FernVenusApi.apiKeys.revokeTokenById.Error.UnauthorizedError | FernVenusApi.apiKeys.revokeTokenById.Error.TokenNotFoundError | FernVenusApi.apiKeys.revokeTokenById.Error._Unknown;
+export declare namespace Error {
+    interface UnauthorizedError extends _Utils {
+        error: "UnauthorizedError";
+    }
+    interface TokenNotFoundError extends _Utils {
+        error: "TokenNotFoundError";
+    }
+    interface _Unknown extends _Utils {
+        error: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: FernVenusApi.apiKeys.revokeTokenById.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unauthorizedError: () => _Result;
+        tokenNotFoundError: () => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unauthorizedError: () => FernVenusApi.apiKeys.revokeTokenById.Error.UnauthorizedError;
+    readonly tokenNotFoundError: () => FernVenusApi.apiKeys.revokeTokenById.Error.TokenNotFoundError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.apiKeys.revokeTokenById.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.apiKeys.revokeTokenById.Error, visitor: FernVenusApi.apiKeys.revokeTokenById.Error._Visitor<_Result>) => _Result;
+};

package/dist/esm/api/resources/apiKeys/client/revokeTokenById.mjs

@@ -0,0 +1,39 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as FernVenusApi from "../../../index.mjs";
+export const Error = {
+    unauthorizedError: () => {
+        return {
+            error: "UnauthorizedError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeTokenById.Error._visit(this, visitor);
+            },
+        };
+    },
+    tokenNotFoundError: () => {
+        return {
+            error: "TokenNotFoundError",
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeTokenById.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            error: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return FernVenusApi.apiKeys.revokeTokenById.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.error) {
+            case "UnauthorizedError":
+                return visitor.unauthorizedError();
+            case "TokenNotFoundError":
+                return visitor.tokenNotFoundError();
+            default:
+                return visitor._other(value);
+        }
+    },
+};

package/dist/esm/api/resources/apiKeys/index.d.mts

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

package/dist/esm/api/resources/apiKeys/index.mjs

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

package/dist/esm/api/resources/apiKeys/types/CreateTokenResponse.d.mts

@@ -0,0 +1,12 @@
+import type * as FernVenusApi from "../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         token: "some-token-value",
+ *         tokenId: "some-token-id"
+ *     }
+ */
+export interface CreateTokenResponse {
+    token: string;
+    tokenId: FernVenusApi.TokenId;
+}

package/dist/esm/api/resources/apiKeys/types/CreateTokenResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/types/TokenId.d.mts

@@ -0,0 +1,5 @@
+/**
+ * @example
+ *     "some-token-id"
+ */
+export type TokenId = string;

package/dist/esm/api/resources/apiKeys/types/TokenId.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/types/TokenMetadata.d.mts

@@ -0,0 +1,19 @@
+import type * as FernVenusApi from "../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         tokenId: "some-token-id",
+ *         organizationId: "some-org-id",
+ *         createdTime: new Date("2022-12-23T10:43:35.000Z"),
+ *         status: {
+ *             type: "active"
+ *         }
+ *     }
+ */
+export interface TokenMetadata {
+    tokenId: FernVenusApi.TokenId;
+    organizationId: FernVenusApi.OrganizationId;
+    description?: string;
+    createdTime: Date;
+    status: FernVenusApi.TokenStatus;
+}

package/dist/esm/api/resources/apiKeys/types/TokenMetadata.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/types/TokenStatus.d.mts

@@ -0,0 +1,29 @@
+import type * as FernVenusApi from "../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         type: "active"
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "expired"
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "revoked"
+ *     }
+ */
+export type TokenStatus = FernVenusApi.TokenStatus.Active | FernVenusApi.TokenStatus.Expired | FernVenusApi.TokenStatus.Revoked;
+export declare namespace TokenStatus {
+    interface Active {
+        type: "active";
+    }
+    interface Expired {
+        type: "expired";
+    }
+    interface Revoked {
+        type: "revoked";
+    }
+}

package/dist/esm/api/resources/apiKeys/types/TokenStatus.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/apiKeys/types/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./CreateTokenResponse.mjs";
+export * from "./TokenId.mjs";
+export * from "./TokenMetadata.mjs";
+export * from "./TokenStatus.mjs";

package/dist/esm/api/resources/apiKeys/types/index.mjs

@@ -0,0 +1,4 @@
+export * from "./CreateTokenResponse.mjs";
+export * from "./TokenId.mjs";
+export * from "./TokenMetadata.mjs";
+export * from "./TokenStatus.mjs";

package/dist/esm/api/resources/commons/types/OrganizationId.d.mts

@@ -1,8 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as FernVenusApi from "../../../index.mjs";
-export type OrganizationId = string & {
-    OrganizationId: void;
-};
-export declare function OrganizationId(value: string): FernVenusApi.OrganizationId;
+export type OrganizationId = string;

package/dist/esm/api/resources/commons/types/OrganizationId.mjs

@@ -1,6 +1,2 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export function OrganizationId(value) {
-    return value;
-}
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/commons/types/UserId.d.mts

@@ -1,8 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as FernVenusApi from "../../../index.mjs";
-export type UserId = string & {
-    UserId: void;
-};
-export declare function UserId(value: string): FernVenusApi.UserId;
+export type UserId = string;

package/dist/esm/api/resources/commons/types/UserId.mjs

@@ -1,6 +1,2 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export function UserId(value) {
-    return value;
-}
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/index.d.mts

@@ -1,11 +1,14 @@
+export * from "./apiKeys/client/requests/index.mjs";
+export * as apiKeys from "./apiKeys/index.mjs";
+export * from "./apiKeys/types/index.mjs";
 export * as commons from "./commons/index.mjs";
 export * from "./commons/types/index.mjs";
+export * from "./organization/client/requests/index.mjs";
 export * as organization from "./organization/index.mjs";
 export * from "./organization/types/index.mjs";
+export * from "./registry/client/requests/index.mjs";
 export * as registry from "./registry/index.mjs";
 export * from "./registry/types/index.mjs";
+export * from "./user/client/requests/index.mjs";
 export * as user from "./user/index.mjs";
 export * from "./user/types/index.mjs";
-export * from "./organization/client/requests/index.mjs";
-export * from "./registry/client/requests/index.mjs";
-export * from "./user/client/requests/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -1,11 +1,14 @@
+export * from "./apiKeys/client/requests/index.mjs";
+export * as apiKeys from "./apiKeys/index.mjs";
+export * from "./apiKeys/types/index.mjs";
 export * as commons from "./commons/index.mjs";
 export * from "./commons/types/index.mjs";
+export * from "./organization/client/requests/index.mjs";
 export * as organization from "./organization/index.mjs";
 export * from "./organization/types/index.mjs";
+export * from "./registry/client/requests/index.mjs";
 export * as registry from "./registry/index.mjs";
 export * from "./registry/types/index.mjs";
+export * from "./user/client/requests/index.mjs";
 export * as user from "./user/index.mjs";
 export * from "./user/types/index.mjs";
-export * from "./organization/client/requests/index.mjs";
-export * from "./registry/client/requests/index.mjs";
-export * from "./user/client/requests/index.mjs";

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

@@ -1,29 +1,10 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments.mjs";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as FernVenusApi from "../../../index.mjs";
 export declare namespace Organization {
-    interface Options {
-        environment?: core.Supplier<environments.FernVenusApiEnvironment | 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 Options extends BaseClientOptions {
     }
-    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>;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 export declare class Organization {
@@ -35,11 +16,7 @@ export declare class Organization {
      *
      * @example
      *     await client.organization.create({
-     *         organizationId: FernVenusApi.OrganizationId("organizationId"),
-     *         displayName: undefined,
-     *         artifactReadRequiresToken: undefined,
-     *         enableGithubConnection: undefined,
-     *         enableGoogleConnection: undefined
+     *         organizationId: "organizationId"
      *     })
      */
     create(request: FernVenusApi.CreateOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error>>;
@@ -50,24 +27,7 @@ export declare class Organization {
      * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.update(FernVenusApi.OrganizationId("orgId"), {
-     *         displayName: undefined,
-     *         logoUrl: undefined,
-     *         artifactReadRequiresToken: undefined,
-     *         isWhitelabeled: undefined,
-     *         previewEnabled: undefined,
-     *         snippetsEnabled: undefined,
-     *         snippetUnitTestsEnabled: undefined,
-     *         snippetsApiAccessEnabled: undefined,
-     *         snippetTemplatesAccessEnabled: undefined,
-     *         paginationEnabled: undefined,
-     *         changeLogEnabled: undefined,
-     *         isFernbotCanary: undefined,
-     *         oauthClientEnabled: undefined,
-     *         apiPlaygroundEnabled: undefined,
-     *         workosOrganizationId: undefined,
-     *         selfHostedSdKs: undefined
-     *     })
+     *     await client.organization.update("orgId")
      */
     update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
     private __update;
@@ -77,7 +37,7 @@ export declare class Organization {
      * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.get(FernVenusApi.OrganizationId("orgId"))
+     *     await client.organization.get("orgId")
      */
     get(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.GetOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error>>;
     private __get;
@@ -86,7 +46,7 @@ export declare class Organization {
      * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.isMember(FernVenusApi.OrganizationId("organizationId"))
+     *     await client.organization.isMember("organizationId")
      */
     isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
     private __isMember;
@@ -115,8 +75,8 @@ export declare class Organization {
      *
      * @example
      *     await client.organization.addUser({
-     *         userId: FernVenusApi.UserId("userId"),
-     *         orgId: FernVenusApi.OrganizationId("orgId")
+     *         userId: "userId",
+     *         orgId: "orgId"
      *     })
      */
     addUser(request: FernVenusApi.AddUserToOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.addUser.Error>>;
@@ -128,7 +88,7 @@ export declare class Organization {
      * @example
      *     await client.organization.inviteUser({
      *         emailAddress: "emailAddress",
-     *         auth0OrgId: FernVenusApi.OrganizationId("auth0OrgId")
+     *         auth0OrgId: "auth0OrgId"
      *     })
      */
     inviteUser(request: FernVenusApi.InviteUserToOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.inviteUser.Error>>;
@@ -140,7 +100,7 @@ export declare class Organization {
      * @example
      *     await client.organization.removeUser({
      *         userId: "userId",
-     *         auth0OrgId: FernVenusApi.OrganizationId("auth0OrgId")
+     *         auth0OrgId: "auth0OrgId"
      *     })
      */
     removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
@@ -152,7 +112,7 @@ export declare class Organization {
      * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.delete(FernVenusApi.OrganizationId("orgId"))
+     *     await client.organization.delete("orgId")
      */
     delete(orgId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.delete.Error>>;
     private __delete;