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

package/dist/cjs/api/resources/auth/client/requests/index.js

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

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

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

package/dist/cjs/api/resources/{commons → auth}/index.js

@@ -14,4 +14,4 @@ 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/index.d.ts

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

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

@@ -36,18 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.user = exports.registry = exports.organization = exports.commons = exports.apiKeys = void 0;
+exports.user = exports.registry = exports.organization = exports.auth = exports.apiKeys = void 0;
 __exportStar(require("./apiKeys/client/requests/index.js"), exports);
 exports.apiKeys = __importStar(require("./apiKeys/index.js"));
-__exportStar(require("./apiKeys/types/index.js"), exports);
-exports.commons = __importStar(require("./commons/index.js"));
-__exportStar(require("./commons/types/index.js"), exports);
+__exportStar(require("./auth/client/requests/index.js"), exports);
+exports.auth = __importStar(require("./auth/index.js"));
 __exportStar(require("./organization/client/requests/index.js"), exports);
 exports.organization = __importStar(require("./organization/index.js"));
-__exportStar(require("./organization/types/index.js"), exports);
 __exportStar(require("./registry/client/requests/index.js"), exports);
 exports.registry = __importStar(require("./registry/index.js"));
-__exportStar(require("./registry/types/index.js"), exports);
 __exportStar(require("./user/client/requests/index.js"), exports);
 exports.user = __importStar(require("./user/index.js"));
-__exportStar(require("./user/types/index.js"), exports);

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

@@ -1,77 +1,120 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
-import * as FernVenusApi from "../../../index.js";
-export declare namespace Organization {
-    interface Options extends BaseClientOptions {
-    }
+import * as FernApi from "../../../index.js";
+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 {FernApi.CreateOrganizationRequest} request
+     * @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: FernApi.CreateOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernApi.CreateOrganizationResponse, FernApi.organization.create.Error>>;
     private __create;
     /**
-     * @param {FernVenusApi.OrganizationId} orgId
-     * @param {FernVenusApi.UpdateOrganizationRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FernApi.UpdateOrganizationRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.update("orgId")
+     *     await client.organization.update({
+     *         orgId: "org_id"
+     *     })
      */
-    update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
+    update(request: FernApi.UpdateOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernApi.organization.update.Error>>;
     private __update;
     /**
-     * @param {FernVenusApi.OrganizationId} orgId
-     * @param {FernVenusApi.GetOrganizationRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FernApi.GetOrganizationsOrgIdGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.get("orgId")
+     *     await client.organization.get({
+     *         orgId: "org_id"
+     *     })
      */
-    get(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.GetOrganizationRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error>>;
+    get(request: FernApi.GetOrganizationsOrgIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernApi.Organization, FernApi.organization.get.Error>>;
     private __get;
     /**
-     * @param {FernVenusApi.OrganizationId} organizationId
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * Deletes an organization. Only users with admin role can delete organizations.
+     *
+     * @param {FernApi.DeleteOrganizationsOrgIdDeleteRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.delete({
+     *         orgId: "org_id"
+     *     })
+     */
+    delete(request: FernApi.DeleteOrganizationsOrgIdDeleteRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernApi.organization.delete.Error>>;
+    private __delete;
+    /**
+     * Look up an organization by its associated Postman team ID.
+     *
+     * @param {FernApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.isMember("organizationId")
+     *     await client.organization.getOrgIdsByPostmanTeamId({
+     *         postmanTeamId: "postman_team_id"
+     *     })
      */
-    isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
+    getOrgIdsByPostmanTeamId(request: FernApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernApi.Organization, FernApi.organization.getOrgIdsByPostmanTeamId.Error>>;
+    private __getOrgIdsByPostmanTeamId;
+    /**
+     * Get the Postman team ID associated with an organization ID.
+     *
+     * @param {FernApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getPostmanTeamIdByOrgId({
+     *         orgId: "org_id"
+     *     })
+     */
+    getPostmanTeamIdByOrgId(request: FernApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernApi.organization.getPostmanTeamIdByOrgId.Error>>;
+    private __getPostmanTeamIdByOrgId;
+    /**
+     * @param {FernApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.isMember({
+     *         organizationId: "organization_id"
+     *     })
+     */
+    isMember(request: FernApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernApi.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 {FernApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest} request
+     * @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?: FernApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernApi.Organization, FernApi.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<string[], FernApi.organization.getOrgIdsFromToken.Error>>;
     private __getOrgIdsFromToken;
     /**
-     * @param {FernVenusApi.AddUserToOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FernApi.AddUserToOrgRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.addUser({
@@ -79,11 +122,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: FernApi.AddUserToOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernApi.organization.addUser.Error>>;
     private __addUser;
     /**
-     * @param {FernVenusApi.InviteUserToOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FernApi.InviteUserToOrgRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.inviteUser({
@@ -91,11 +134,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: FernApi.InviteUserToOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernApi.organization.inviteUser.Error>>;
     private __inviteUser;
     /**
-     * @param {FernVenusApi.RemoveUserFromOrgRequest} request
-     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FernApi.RemoveUserFromOrgRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.removeUser({
@@ -103,18 +146,6 @@ export declare class Organization {
      *         auth0OrgId: "auth0OrgId"
      *     })
      */
-    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
+    removeUser(request: FernApi.RemoveUserFromOrgRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernApi.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.
-     *
-     * @example
-     *     await client.organization.delete("orgId")
-     */
-    delete(orgId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.delete.Error>>;
-    private __delete;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }