@fern-api/venus-api-sdk 0.10.0 → 0.10.1-1-ged0356b

package/Client.d.ts

@@ -7,17 +7,25 @@ import { Registry } from "./api/resources/registry/client/Client";
 import { User } from "./api/resources/user/client/Client";
 export declare namespace FernVenusApiClient {
     interface Options {
-        environment: string;
+        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 FernVenusApiClient {
-    private readonly options;
-    constructor(options: FernVenusApiClient.Options);
-    private _organization;
+    protected readonly _options: FernVenusApiClient.Options;
+    constructor(_options: FernVenusApiClient.Options);
+    protected _organization: Organization | undefined;
     get organization(): Organization;
-    private _registry;
+    protected _registry: Registry | undefined;
     get registry(): Registry;
-    private _user;
+    protected _user: User | undefined;
     get user(): User;
 }

package/Client.js

@@ -8,21 +8,20 @@ const Client_1 = require("./api/resources/organization/client/Client");
 const Client_2 = require("./api/resources/registry/client/Client");
 const Client_3 = require("./api/resources/user/client/Client");
 class FernVenusApiClient {
-    options;
-    constructor(options) {
-        this.options = options;
+    constructor(_options) {
+        this._options = _options;
     }
-    _organization;
     get organization() {
-        return (this._organization ??= new Client_1.Organization(this.options));
+        var _a;
+        return ((_a = this._organization) !== null && _a !== void 0 ? _a : (this._organization = new Client_1.Organization(this._options)));
     }
-    _registry;
     get registry() {
-        return (this._registry ??= new Client_2.Registry(this.options));
+        var _a;
+        return ((_a = this._registry) !== null && _a !== void 0 ? _a : (this._registry = new Client_2.Registry(this._options)));
     }
-    _user;
     get user() {
-        return (this._user ??= new Client_3.User(this.options));
+        var _a;
+        return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_3.User(this._options)));
     }
 }
 exports.FernVenusApiClient = FernVenusApiClient;

package/api/resources/commons/types/OrganizationId.d.ts

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

package/api/resources/commons/types/UserId.d.ts

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

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

@@ -2,26 +2,129 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-import { FernVenusApi } from "../../../..";
+import * as FernVenusApi from "../../../index";
 export declare namespace Organization {
     interface Options {
-        environment: string;
+        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 Organization {
-    private readonly options;
-    constructor(options: Organization.Options);
-    create(request: FernVenusApi.CreateOrganizationRequest): Promise<core.APIResponse<void, FernVenusApi.organization.create.Error>>;
-    update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest): Promise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
-    get(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.GetOrganizationRequest): Promise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error>>;
-    isMember(organizationId: FernVenusApi.OrganizationId): Promise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
+    protected readonly _options: Organization.Options;
+    constructor(_options: Organization.Options);
+    /**
+     * @param {FernVenusApi.CreateOrganizationRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.create({
+     *         organizationId: FernVenusApi.OrganizationId("string"),
+     *         artifactReadRequiresToken: true,
+     *         enableGithubConnection: true
+     *     })
+     */
+    create(request: FernVenusApi.CreateOrganizationRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.organization.create.Error>>;
+    /**
+     * @param {FernVenusApi.OrganizationId} orgId
+     * @param {FernVenusApi.UpdateOrganizationRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.update(FernVenusApi.OrganizationId("string"), {
+     *         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"
+     *     })
+     */
+    update(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.UpdateOrganizationRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.organization.update.Error>>;
+    /**
+     * @param {FernVenusApi.OrganizationId} orgId
+     * @param {FernVenusApi.GetOrganizationRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.get(FernVenusApi.OrganizationId("string"), {
+     *         shouldIncludeFernUsers: true
+     *     })
+     */
+    get(orgId: FernVenusApi.OrganizationId, request?: FernVenusApi.GetOrganizationRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error>>;
+    /**
+     * @param {FernVenusApi.OrganizationId} organizationId
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.isMember(FernVenusApi.OrganizationId("string"))
+     */
+    isMember(organizationId: FernVenusApi.OrganizationId, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<boolean, FernVenusApi.organization.isMember.Error>>;
     /**
      * 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.
+     *
+     * @example
+     *     await client.organization.getMyOrganizationFromScopedToken({
+     *         shouldIncludeFernUsers: true
+     *     })
+     */
+    getMyOrganizationFromScopedToken(request?: FernVenusApi.GetMyOrganizationFromScopedToken, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error>>;
+    /**
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.getOrgIdsFromToken()
+     */
+    getOrgIdsFromToken(requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<FernVenusApi.OrganizationId[], FernVenusApi.organization.getOrgIdsFromToken.Error>>;
+    /**
+     * @param {FernVenusApi.AddUserToOrgRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.addUser({
+     *         userId: FernVenusApi.UserId("string"),
+     *         orgId: FernVenusApi.OrganizationId("string")
+     *     })
+     */
+    addUser(request: FernVenusApi.AddUserToOrgRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.organization.addUser.Error>>;
+    /**
+     * @param {FernVenusApi.InviteUserToOrgRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.inviteUser({
+     *         emailAddress: "string",
+     *         auth0OrgId: FernVenusApi.OrganizationId("string")
+     *     })
+     */
+    inviteUser(request: FernVenusApi.InviteUserToOrgRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.organization.inviteUser.Error>>;
+    /**
+     * @param {FernVenusApi.RemoveUserFromOrgRequest} request
+     * @param {Organization.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.organization.removeUser({
+     *         userId: "string",
+     *         auth0OrgId: FernVenusApi.OrganizationId("string")
+     *     })
      */
-    getMyOrganizationFromScopedToken(request?: FernVenusApi.GetMyOrganizationFromScopedToken): Promise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error>>;
-    getOrgIdsFromToken(): Promise<core.APIResponse<FernVenusApi.OrganizationId[], FernVenusApi.organization.getOrgIdsFromToken.Error>>;
-    addUser(request: FernVenusApi.AddUserToOrgRequest): Promise<core.APIResponse<void, FernVenusApi.organization.addUser.Error>>;
-    inviteUser(request: FernVenusApi.InviteUserToOrgRequest): Promise<core.APIResponse<void, FernVenusApi.organization.inviteUser.Error>>;
-    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest): Promise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
+    removeUser(request: FernVenusApi.RemoveUserFromOrgRequest, requestOptions?: Organization.RequestOptions): Promise<core.APIResponse<void, FernVenusApi.organization.removeUser.Error>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }