@credal/sdk 0.0.24 → 0.0.25

package/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts

@@ -14,19 +14,10 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface CreateCollectionRequest {
-    /**
-     * A descriptive name for the collection.
-     *
-     */
+    /** A descriptive name for the collection. */
     name: string;
-    /**
-     * An in depth name for the copilot's function. Useful for routing requests to the right copilot.
-     *
-     */
+    /** An in depth name for the copilot's function. Useful for routing requests to the right copilot. */
     description: string;
-    /**
-     * A list of collaborator emails and roles that will have access to the copilot.
-     *
-     */
+    /** A list of collaborator emails and roles that will have access to the copilot. */
     collaborators: Credal.Collaborator[];
 }

package/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.ts

@@ -20,9 +20,6 @@ import * as Credal from "../../../../index";
 export interface RemoveDocumentsFromCollectionRequest {
     /** The ID of the document collection you want to add to. */
     collectionId: string;
-    /**
-     * The set of resource identifier for which you want to remove from the collection
-     *
-     */
+    /** The set of resource identifier for which you want to remove from the collection */
     resourceIdentifiers: Credal.ResourceIdentifier[];
 }

package/api/resources/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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);
 };

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace PermissionsService {
     interface Options {
         environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -17,6 +19,8 @@ export declare namespace PermissionsService {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class PermissionsService {

package/api/resources/permissionsService/client/Client.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -65,20 +75,12 @@ class PermissionsService {
      *     })
      */
     checkResourceAuthorizationForUser(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/permissions/checkResourceAuthorizationForUser"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/permissions/checkResourceAuthorizationForUser"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.25", "User-Agent": "@credal/sdk/0.0.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CheckResourceAuthorizationForUserRequest.jsonOrThrow(request, {
@@ -109,7 +111,7 @@ class PermissionsService {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/permissions/checkResourceAuthorizationForUser.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -137,20 +139,12 @@ class PermissionsService {
      *     })
      */
     checkBulkResourcesAuthorizationForUser(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/permissions/checkBulkResourcesAuthorizationForUser"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/permissions/checkBulkResourcesAuthorizationForUser"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.25", "User-Agent": "@credal/sdk/0.0.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CheckBulkResourcesAuthorizationForUserRequest.jsonOrThrow(request, {
@@ -181,7 +175,7 @@ class PermissionsService {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/permissions/checkBulkResourcesAuthorizationForUser.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -201,20 +195,12 @@ class PermissionsService {
      *     })
      */
     listCachedAuthorizedResourcesForUser(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/permissions/listCachedAuthorizedResourcesForUser"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/permissions/listCachedAuthorizedResourcesForUser"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.25", "User-Agent": "@credal/sdk/0.0.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ListCachedAuthorizedResourcesForUserRequest.jsonOrThrow(request, {
@@ -245,7 +231,7 @@ class PermissionsService {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/permissions/listCachedAuthorizedResourcesForUser.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -254,12 +240,12 @@ class PermissionsService {
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
             if (bearer == null) {
                 throw new errors.CredalError({
-                    message: "Please specify CREDAL_API_KEY when instantiating the client.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
                 });
             }
             return `Bearer ${bearer}`;

package/api/resources/permissionsService/client/requests/CheckBulkResourcesAuthorizationForUserRequest.d.ts

@@ -17,19 +17,10 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface CheckBulkResourcesAuthorizationForUserRequest {
-    /**
-     * The set of resource identifier for which you want to check authorization. Currently limited to 20 resources.
-     *
-     */
+    /** The set of resource identifier for which you want to check authorization. Currently limited to 20 resources. */
     resourceIdentifiers: Credal.ResourceIdentifier[];
-    /**
-     * The user email to check authorization for.
-     *
-     */
+    /** The user email to check authorization for. */
     userEmail: string;
-    /**
-     * If specified, Credal will bypass the permissions cache and check current permissions for all resources specified.
-     *
-     */
+    /** If specified, Credal will bypass the permissions cache and check current permissions for all resources specified. */
     disableCache?: boolean;
 }

package/api/resources/permissionsService/client/requests/CheckResourceAuthorizationForUserRequest.d.ts

@@ -14,19 +14,10 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface CheckResourceAuthorizationForUserRequest {
-    /**
-     * The resource identifier for which you want to check authorization.
-     *
-     */
+    /** The resource identifier for which you want to check authorization. */
     resourceIdentifier: Credal.ResourceIdentifier;
-    /**
-     * The user email to check authorization for.
-     *
-     */
+    /** The user email to check authorization for. */
     userEmail: string;
-    /**
-     * If specified, Credal will bypass the permissions cache and check current permissions for this resource
-     *
-     */
+    /** If specified, Credal will bypass the permissions cache and check current permissions for this resource */
     disableCache?: boolean;
 }

package/api/resources/permissionsService/client/requests/ListCachedAuthorizedResourcesForUserRequest.d.ts

@@ -9,24 +9,12 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface ListCachedAuthorizedResourcesForUserRequest {
-    /**
-     * The user email to list authorized resources for.
-     *
-     */
+    /** The user email to list authorized resources for. */
     userEmail: string;
-    /**
-     * The type of resource you want to list. If not specified, all resource types will be listed.
-     *
-     */
+    /** The type of resource you want to list. If not specified, all resource types will be listed. */
     resourceType?: Credal.ResourceType;
-    /**
-     * The maximum number of resources to return. Defaults to 100.
-     *
-     */
+    /** The maximum number of resources to return. Defaults to 100. */
     limit?: number;
-    /**
-     * The offset to use for pagination. If not specified, the first page of results will be returned.
-     *
-     */
+    /** The offset to use for pagination. If not specified, the first page of results will be returned. */
     offset?: number;
 }

package/api/resources/permissionsService/types/Action.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Action = "READ";
+export type Action = "READ";
 export declare const Action: {
     readonly Read: "READ";
 };

package/api/resources/permissionsService/types/AuthorizedResourceListPage.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Credal from "../../../index";
-export declare type AuthorizedResourceListPage = Credal.AuthorizedResource[];
+export type AuthorizedResourceListPage = Credal.AuthorizedResource[];

package/api/resources/permissionsService/types/CheckBulkResourcesAuthorizationResponse.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Credal from "../../../index";
-export declare type CheckBulkResourcesAuthorizationResponse = Credal.ResourceAuthorizationResult[];
+export type CheckBulkResourcesAuthorizationResponse = Credal.ResourceAuthorizationResult[];

package/api/resources/permissionsService/types/Principal.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Credal from "../../../index";
-export declare type Principal = Credal.Principal.Group | Credal.Principal.User;
+export type Principal = Credal.Principal.Group | Credal.Principal.User;
 export declare namespace Principal {
     interface Group extends Credal.Group {
         type: "group";

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace Search {
     interface Options {
         environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -17,6 +19,8 @@ export declare namespace Search {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Search {

package/api/resources/search/client/Client.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -75,20 +85,12 @@ class Search {
      *     })
      */
     searchDocumentCollection(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/search/searchDocumentCollection"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/search/searchDocumentCollection"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.25", "User-Agent": "@credal/sdk/0.0.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SearchDocumentCollectionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -117,7 +119,7 @@ class Search {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/search/searchDocumentCollection.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -126,12 +128,12 @@ class Search {
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
             if (bearer == null) {
                 throw new errors.CredalError({
-                    message: "Please specify CREDAL_API_KEY when instantiating the client.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
                 });
             }
             return `Bearer ${bearer}`;

package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts

@@ -26,20 +26,11 @@ import * as Credal from "../../../../index";
 export interface SearchDocumentCollectionRequest {
     collectionId: string;
     searchQuery: string;
-    /**
-     * The email of the user making the search request for permissions reduction.
-     *
-     */
+    /** The email of the user making the search request for permissions reduction. */
     userEmail: string;
-    /**
-     * The structured query filters to apply to the search query.
-     *
-     */
+    /** The structured query filters to apply to the search query. */
     structuredQueryFilters?: Credal.SingleFieldFilter[];
     searchOptions?: Credal.DocumentCollectionSearchOptions;
-    /**
-     * Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead.
-     *
-     */
+    /** Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead. */
     metadataFilterExpression?: string;
 }

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace Users {
     interface Options {
         environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -17,6 +19,8 @@ export declare namespace Users {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Users {

package/api/resources/users/client/Client.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -70,20 +80,12 @@ class Users {
      *         }])
      */
     metadata(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/users/metadata"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/users/metadata"),
                 method: "PATCH",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.25", "User-Agent": "@credal/sdk/0.0.25", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.users.metadata.Request.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -107,7 +109,7 @@ class Users {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling PATCH /v0/users/metadata.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -116,12 +118,12 @@ class Users {
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
             if (bearer == null) {
                 throw new errors.CredalError({
-                    message: "Please specify CREDAL_API_KEY when instantiating the client.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
                 });
             }
             return `Bearer ${bearer}`;

package/core/auth/BearerToken.d.ts

@@ -1,4 +1,4 @@
-export declare type BearerToken = string;
+export type BearerToken = string;
 export declare const BearerToken: {
     toAuthorizationHeader: (token: BearerToken | undefined) => string | undefined;
     fromAuthorizationHeader: (header: string) => BearerToken;

package/core/fetcher/APIResponse.d.ts

@@ -1,4 +1,4 @@
-export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;

package/core/fetcher/Fetcher.d.ts

@@ -1,12 +1,12 @@
 import { APIResponse } from "./APIResponse";
-export declare type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 export declare namespace Fetcher {
     interface Args {
         url: string;
         method: string;
         contentType?: string;
         headers?: Record<string, string | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[]>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
         body?: unknown;
         timeoutMs?: number;
         maxRetries?: number;

package/core/fetcher/Fetcher.js

@@ -9,7 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetcher = exports.fetcherImpl = void 0;
+exports.fetcher = void 0;
+exports.fetcherImpl = fetcherImpl;
+const json_1 = require("../json");
 const createRequestUrl_1 = require("./createRequestUrl");
 const getFetchFn_1 = require("./getFetchFn");
 const getRequestBody_1 = require("./getRequestBody");
@@ -30,7 +32,7 @@ function fetcherImpl(args) {
             }
         }
         const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
-        let requestBody = yield (0, getRequestBody_1.getRequestBody)({
+        const requestBody = yield (0, getRequestBody_1.getRequestBody)({
             body: args.body,
             type: args.requestType === "json" ? "json" : "other",
         });
@@ -39,7 +41,7 @@ function fetcherImpl(args) {
             const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
                 return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
             }), args.maxRetries);
-            let responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
+            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
             if (response.status >= 200 && response.status < 400) {
                 return {
                     ok: true,
@@ -89,11 +91,10 @@ function fetcherImpl(args) {
                 ok: false,
                 error: {
                     reason: "unknown",
-                    errorMessage: JSON.stringify(error),
+                    errorMessage: (0, json_1.toJson)(error),
                 },
             };
         }
     });
 }
-exports.fetcherImpl = fetcherImpl;
 exports.fetcher = fetcherImpl;