@fern-api/venus-api-sdk 0.22.4 → 0.22.34

package/dist/esm/api/resources/auth/client/getAutopilotToken.mjs

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

package/dist/esm/api/resources/auth/client/getJwt.d.mts

@@ -0,0 +1,24 @@
+import type * as core from "../../../../core/index.mjs";
+import * as FernVenusApi from "../../../index.mjs";
+export type Error = FernVenusApi.auth.getJwt.Error.UnauthorizedError | FernVenusApi.auth.getJwt.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.auth.getJwt.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        unauthorizedError: () => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly unauthorizedError: () => FernVenusApi.auth.getJwt.Error.UnauthorizedError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => FernVenusApi.auth.getJwt.Error._Unknown;
+    readonly _visit: <_Result>(value: FernVenusApi.auth.getJwt.Error, visitor: FernVenusApi.auth.getJwt.Error._Visitor<_Result>) => _Result;
+};

package/dist/esm/api/resources/auth/client/getJwt.mjs

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

package/dist/esm/api/resources/auth/client/getOrgForGithubOwner.d.mts

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

package/dist/esm/api/resources/auth/client/getOrgForGithubOwner.mjs

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

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

@@ -0,0 +1,4 @@
+export * as getAutopilotToken from "./getAutopilotToken.mjs";
+export * as getJwt from "./getJwt.mjs";
+export * as getOrgForGithubOwner from "./getOrgForGithubOwner.mjs";
+export * from "./requests/index.mjs";

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

@@ -0,0 +1,4 @@
+export * as getAutopilotToken from "./getAutopilotToken.mjs";
+export * as getJwt from "./getJwt.mjs";
+export * as getOrgForGithubOwner from "./getOrgForGithubOwner.mjs";
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/auth/client/requests/GetAutopilotTokenRequest.d.mts

@@ -0,0 +1,22 @@
+import type * as FernVenusApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         organizationId: "my-org-id"
+ *     }
+ *
+ * @example
+ *     {
+ *         organizationId: "wrong-org",
+ *         githubOwner: "protected-github-owner"
+ *     }
+ */
+export interface GetAutopilotTokenRequest {
+    /** The organization ID to scope the JWT to */
+    organizationId: FernVenusApi.OrganizationId;
+    /**
+     * The GitHub repo owner. If provided and the owner is in the protected
+     * GitHub orgs mapping, the organizationId must match the allowed org.
+     */
+    githubOwner?: string;
+}

package/dist/esm/api/resources/auth/client/requests/GetAutopilotTokenRequest.mjs

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

package/dist/esm/api/resources/auth/client/requests/GetJwtRequest.d.mts

@@ -0,0 +1,16 @@
+import type * as FernVenusApi from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         organizationId: "my-org-id"
+ *     }
+ *
+ * @example
+ *     {
+ *         organizationId: "org-user-not-member-of"
+ *     }
+ */
+export interface GetJwtRequest {
+    /** The organization ID to scope the JWT to */
+    organizationId: FernVenusApi.OrganizationId;
+}

package/dist/esm/api/resources/auth/client/requests/GetJwtRequest.mjs

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

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

@@ -0,0 +1,2 @@
+export type { GetAutopilotTokenRequest } from "./GetAutopilotTokenRequest.mjs";
+export type { GetJwtRequest } from "./GetJwtRequest.mjs";

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

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

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

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

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

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

package/dist/esm/api/resources/auth/types/JwtResponse.d.mts

@@ -0,0 +1,11 @@
+/**
+ * @example
+ *     {
+ *         token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+ *         expiresAt: new Date("2024-12-24T10:43:35.000Z")
+ *     }
+ */
+export interface JwtResponse {
+    token: string;
+    expiresAt: Date;
+}

package/dist/esm/api/resources/auth/types/JwtResponse.mjs

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

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

@@ -0,0 +1 @@
+export * from "./JwtResponse.mjs";

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

@@ -0,0 +1 @@
+export * from "./JwtResponse.mjs";

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

@@ -1,6 +1,9 @@
 export * from "./apiKeys/client/requests/index.mjs";
 export * as apiKeys from "./apiKeys/index.mjs";
 export * from "./apiKeys/types/index.mjs";
+export * from "./auth/client/requests/index.mjs";
+export * as auth from "./auth/index.mjs";
+export * from "./auth/types/index.mjs";
 export * as commons from "./commons/index.mjs";
 export * from "./commons/types/index.mjs";
 export * from "./organization/client/requests/index.mjs";

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

@@ -1,6 +1,9 @@
 export * from "./apiKeys/client/requests/index.mjs";
 export * as apiKeys from "./apiKeys/index.mjs";
 export * from "./apiKeys/types/index.mjs";
+export * from "./auth/client/requests/index.mjs";
+export * as auth from "./auth/index.mjs";
+export * from "./auth/types/index.mjs";
 export * as commons from "./commons/index.mjs";
 export * from "./commons/types/index.mjs";
 export * from "./organization/client/requests/index.mjs";

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

@@ -1,77 +1,88 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as FernVenusApi from "../../../index.mjs";
-export declare namespace Organization {
-    interface Options extends BaseClientOptions {
-    }
+export declare namespace OrganizationClient {
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Organization {
-    protected readonly _options: Organization.Options;
-    constructor(_options?: Organization.Options);
+export declare class OrganizationClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
+    constructor(options?: OrganizationClient.Options);
     /**
      * @param {FernVenusApi.CreateOrganizationRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.create({
      *         organizationId: "organizationId"
      *     })
      */
-    create(request: FernVenusApi.CreateOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error>>;
+    create(request: FernVenusApi.CreateOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error>>;
     private __create;
     /**
      * @param {FernVenusApi.OrganizationId} orgId
      * @param {FernVenusApi.UpdateOrganizationRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.update("orgId")
      */
-    update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
+    update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
     private __update;
     /**
      * @param {FernVenusApi.OrganizationId} orgId
      * @param {FernVenusApi.GetOrganizationRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     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>>;
+    get(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.GetOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error>>;
     private __get;
+    /**
+     * Look up an organization by its associated Postman team ID.
+     *
+     * @param {string} postmanTeamId - The Postman team ID to look up
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getByPostmanTeamId("postmanTeamId")
+     */
+    getByPostmanTeamId(postmanTeamId: string, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getByPostmanTeamId.Error>>;
+    private __getByPostmanTeamId;
     /**
      * @param {FernVenusApi.OrganizationId} organizationId
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.isMember("organizationId")
      */
-    isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
+    isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
     private __isMember;
     /**
      * Returns the org for a scoped token. The token is limited to one organization.
      *
      * @param {FernVenusApi.GetMyOrganizationFromScopedToken} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.getMyOrganizationFromScopedToken()
      */
-    getMyOrganizationFromScopedToken(request?: FernVenusApi.GetMyOrganizationFromScopedToken, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error>>;
+    getMyOrganizationFromScopedToken(request?: FernVenusApi.GetMyOrganizationFromScopedToken, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error>>;
     private __getMyOrganizationFromScopedToken;
     /**
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.getOrgIdsFromToken()
      */
-    getOrgIdsFromToken(requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.OrganizationId[], FernVenusApi.organization.getOrgIdsFromToken.Error>>;
+    getOrgIdsFromToken(requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.OrganizationId[], FernVenusApi.organization.getOrgIdsFromToken.Error>>;
     private __getOrgIdsFromToken;
     /**
      * @param {FernVenusApi.AddUserToOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.addUser({
@@ -79,11 +90,11 @@ export declare class Organization {
      *         orgId: "orgId"
      *     })
      */
-    addUser(request: FernVenusApi.AddUserToOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.addUser.Error>>;
+    addUser(request: FernVenusApi.AddUserToOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.addUser.Error>>;
     private __addUser;
     /**
      * @param {FernVenusApi.InviteUserToOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.inviteUser({
@@ -91,11 +102,11 @@ export declare class Organization {
      *         auth0OrgId: "auth0OrgId"
      *     })
      */
-    inviteUser(request: FernVenusApi.InviteUserToOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.inviteUser.Error>>;
+    inviteUser(request: FernVenusApi.InviteUserToOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.inviteUser.Error>>;
     private __inviteUser;
     /**
      * @param {FernVenusApi.RemoveUserFromOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.removeUser({
@@ -103,18 +114,17 @@ export declare class Organization {
      *         auth0OrgId: "auth0OrgId"
      *     })
      */
-    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
+    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
     private __removeUser;
     /**
      * Deletes an organization. Only users with admin role can delete organizations.
      *
      * @param {FernVenusApi.OrganizationId} orgId
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.delete("orgId")
      */
-    delete(orgId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.delete.Error>>;
+    delete(orgId: FernVenusApi.OrganizationId, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.delete.Error>>;
     private __delete;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }