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

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

@@ -1,17 +1,17 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
-import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptions } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
-import * as FernVenusApi from "../../../index.mjs";
+import * as FernApi from "../../../index.mjs";
 export declare namespace OrganizationClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
 export declare class OrganizationClient {
-    protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
-    constructor(options?: OrganizationClient.Options);
+    protected readonly _options: NormalizedClientOptions<OrganizationClient.Options>;
+    constructor(options: OrganizationClient.Options);
     /**
-     * @param {FernVenusApi.CreateOrganizationRequest} request
+     * @param {FernApi.CreateOrganizationRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -19,58 +19,90 @@ export declare class OrganizationClient {
      *         organizationId: "organizationId"
      *     })
      */
-    create(request: FernVenusApi.CreateOrganizationRequest, requestOptions?: OrganizationClient.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 {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?: OrganizationClient.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 {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?: OrganizationClient.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;
+    /**
+     * 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 {string} postmanTeamId - The Postman team ID to look up
+     * @param {FernApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest} request
+     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getOrgIdsByPostmanTeamId({
+     *         postmanTeamId: "postman_team_id"
+     *     })
+     */
+    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.getByPostmanTeamId("postmanTeamId")
+     *     await client.organization.getPostmanTeamIdByOrgId({
+     *         orgId: "org_id"
+     *     })
      */
-    getByPostmanTeamId(postmanTeamId: string, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getByPostmanTeamId.Error>>;
-    private __getByPostmanTeamId;
+    getPostmanTeamIdByOrgId(request: FernApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernApi.organization.getPostmanTeamIdByOrgId.Error>>;
+    private __getPostmanTeamIdByOrgId;
     /**
-     * @param {FernVenusApi.OrganizationId} organizationId
+     * @param {FernApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.organization.isMember("organizationId")
+     *     await client.organization.isMember({
+     *         organizationId: "organization_id"
+     *     })
      */
-    isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
+    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 {FernApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.organization.getMyOrganizationFromScopedToken()
      */
-    getMyOrganizationFromScopedToken(request?: FernVenusApi.GetMyOrganizationFromScopedToken, requestOptions?: OrganizationClient.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 {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -78,10 +110,10 @@ export declare class OrganizationClient {
      * @example
      *     await client.organization.getOrgIdsFromToken()
      */
-    getOrgIdsFromToken(requestOptions?: OrganizationClient.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 {FernApi.AddUserToOrgRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -90,10 +122,10 @@ export declare class OrganizationClient {
      *         orgId: "orgId"
      *     })
      */
-    addUser(request: FernVenusApi.AddUserToOrgRequest, requestOptions?: OrganizationClient.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 {FernApi.InviteUserToOrgRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -102,10 +134,10 @@ export declare class OrganizationClient {
      *         auth0OrgId: "auth0OrgId"
      *     })
      */
-    inviteUser(request: FernVenusApi.InviteUserToOrgRequest, requestOptions?: OrganizationClient.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 {FernApi.RemoveUserFromOrgRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -114,17 +146,6 @@ export declare class OrganizationClient {
      *         auth0OrgId: "auth0OrgId"
      *     })
      */
-    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: OrganizationClient.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 {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.delete("orgId")
-     */
-    delete(orgId: FernVenusApi.OrganizationId, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.delete.Error>>;
-    private __delete;
 }