@credal/sdk 0.1.12 → 0.1.14

package/dist/cjs/BaseClient.d.ts

@@ -29,4 +29,12 @@ export interface BaseRequestOptions {
     /** Additional headers to include in the request. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
 }
-export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): T;
+export type NormalizedClientOptions<T extends BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;

package/dist/cjs/BaseClient.js

@@ -35,16 +35,24 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeClientOptions = normalizeClientOptions;
+exports.normalizeClientOptionsWithAuth = normalizeClientOptionsWithAuth;
+const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
 function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@credal/sdk",
-        "X-Fern-SDK-Version": "0.1.12",
-        "User-Agent": "@credal/sdk/0.1.12",
+        "X-Fern-SDK-Version": "0.1.14",
+        "User-Agent": "@credal/sdk/0.1.14",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);
     return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
 }
+function normalizeClientOptionsWithAuth(options) {
+    var _a;
+    const normalized = normalizeClientOptions(options);
+    (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new BearerAuthProvider_js_1.BearerAuthProvider(options));
+    return normalized;
+}

package/dist/cjs/Client.d.ts

@@ -4,6 +4,7 @@ import { DocumentCollectionsClient } from "./api/resources/documentCollections/c
 import { SearchClient } from "./api/resources/search/client/Client.js";
 import { UsersClient } from "./api/resources/users/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
 export declare namespace CredalClient {
     interface Options extends BaseClientOptions {
     }
@@ -11,7 +12,7 @@ export declare namespace CredalClient {
     }
 }
 export declare class CredalClient {
-    protected readonly _options: CredalClient.Options;
+    protected readonly _options: NormalizedClientOptionsWithAuth<CredalClient.Options>;
     protected _copilots: CopilotsClient | undefined;
     protected _documentCatalog: DocumentCatalogClient | undefined;
     protected _documentCollections: DocumentCollectionsClient | undefined;

package/dist/cjs/Client.js

@@ -10,7 +10,7 @@ const Client_js_5 = require("./api/resources/users/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 class CredalClient {
     constructor(options = {}) {
-        this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     get copilots() {
         var _a;

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

@@ -1,4 +1,5 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import type * as Credal from "../../../index.js";
 export declare namespace CopilotsClient {
@@ -8,7 +9,7 @@ export declare namespace CopilotsClient {
     }
 }
 export declare class CopilotsClient {
-    protected readonly _options: CopilotsClient.Options;
+    protected readonly _options: NormalizedClientOptionsWithAuth<CopilotsClient.Options>;
     constructor(options?: CopilotsClient.Options);
     /**
      * Create a new agent. The API key used will be added to the agent for future Requests
@@ -146,5 +147,24 @@ export declare class CopilotsClient {
      */
     deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
     private __deleteCopilot;
-    protected _getAuthorizationHeader(): Promise<string>;
+    /**
+     * Export copilot configurations for backup or migration purposes.
+     *
+     * **IMPORTANT**: This endpoint requires:
+     * - Admin privileges
+     * - The 'ai-usage-analytics-log.export' scope on the API key
+     *
+     * Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.
+     *
+     * @param {Credal.ExportCopilotsRequest} request
+     * @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.export({
+     *         agentCreatedFrom: "2024-01-01T00:00:00Z",
+     *         agentCreatedTo: "2024-12-31T23:59:59Z"
+     *     })
+     */
+    export(request?: Credal.ExportCopilotsRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.ExportCopilotsResponse>;
+    private __export;
 }

package/dist/cjs/api/resources/copilots/client/Client.js

@@ -51,7 +51,7 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class CopilotsClient {
     constructor(options = {}) {
-        this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
      * Create a new agent. The API key used will be added to the agent for future Requests
@@ -75,7 +75,8 @@ class CopilotsClient {
     __createCopilot(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/createCopilot"),
                 method: "POST",
@@ -135,7 +136,8 @@ class CopilotsClient {
     __createConversation(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/createConversation"),
                 method: "POST",
@@ -199,7 +201,8 @@ class CopilotsClient {
     __provideMessageFeedback(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/provideMessageFeedback"),
                 method: "POST",
@@ -265,7 +268,8 @@ class CopilotsClient {
     __sendMessage(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/sendMessage"),
                 method: "POST",
@@ -316,7 +320,8 @@ class CopilotsClient {
     __streamMessage(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/streamMessage"),
                 method: "POST",
@@ -388,7 +393,8 @@ class CopilotsClient {
     __addCollectionToCopilot(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/addCollectionToCopilot"),
                 method: "POST",
@@ -448,7 +454,8 @@ class CopilotsClient {
     __removeCollectionFromCopilot(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/removeCollectionFromCopilot"),
                 method: "POST",
@@ -516,7 +523,8 @@ class CopilotsClient {
     __updateConfiguration(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/updateConfiguration"),
                 method: "POST",
@@ -573,7 +581,8 @@ class CopilotsClient {
     __deleteCopilot(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/deleteCopilot"),
                 method: "DELETE",
@@ -615,16 +624,71 @@ class CopilotsClient {
             }
         });
     }
-    _getAuthorizationHeader() {
-        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) {
+    /**
+     * Export copilot configurations for backup or migration purposes.
+     *
+     * **IMPORTANT**: This endpoint requires:
+     * - Admin privileges
+     * - The 'ai-usage-analytics-log.export' scope on the API key
+     *
+     * Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.
+     *
+     * @param {Credal.ExportCopilotsRequest} request
+     * @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.export({
+     *         agentCreatedFrom: "2024-01-01T00:00:00Z",
+     *         agentCreatedTo: "2024-12-31T23:59:59Z"
+     *     })
+     */
+    export(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__export(request, requestOptions));
+    }
+    __export() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/export"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
                 throw new errors.CredalError({
-                    message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
-            return `Bearer ${bearer}`;
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/export.");
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
         });
     }
 }

package/dist/cjs/api/resources/copilots/client/requests/ExportCopilotsRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @example
+ *     {
+ *         agentCreatedFrom: "2024-01-01T00:00:00Z",
+ *         agentCreatedTo: "2024-12-31T23:59:59Z"
+ *     }
+ */
+export interface ExportCopilotsRequest {
+    /** Filter copilots created on or after this datetime (ISO 8601 format). */
+    agentCreatedFrom?: string;
+    /** Filter copilots created before or on this datetime (ISO 8601 format). */
+    agentCreatedTo?: string;
+    /** Filter copilot versions created on or after this datetime (ISO 8601 format). */
+    versionCreatedFrom?: string;
+    /** Filter copilot versions created before or on this datetime (ISO 8601 format). */
+    versionCreatedTo?: string;
+    /** Maximum number of copilots to return. Must be a positive integer with a maximum value of 1000. Defaults to 100. */
+    limit?: number;
+    /** Cursor for pagination. Use the cursor returned in the previous response to fetch the next page of results. If not provided, returns the first page. */
+    cursor?: string;
+}

package/dist/cjs/api/resources/copilots/client/requests/ExportCopilotsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/copilots/client/requests/index.d.ts

@@ -2,6 +2,7 @@ export type { AddCollectionToCopilotRequest } from "./AddCollectionToCopilotRequ
 export type { CreateConversationRequest } from "./CreateConversationRequest.js";
 export type { CreateCopilotRequest } from "./CreateCopilotRequest.js";
 export type { DeleteCopilotRequest } from "./DeleteCopilotRequest.js";
+export type { ExportCopilotsRequest } from "./ExportCopilotsRequest.js";
 export type { ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest.js";
 export type { RemoveCollectionFromCopilotRequest } from "./RemoveCollectionFromCopilotRequest.js";
 export type { SendMessageRequest } from "./SendMessageRequest.js";

package/dist/cjs/api/resources/copilots/types/ExportCopilotsResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as Credal from "../../../index.js";
+export interface ExportCopilotsResponse {
+    /** List of exported copilots matching the query filters. */
+    data: Credal.ExportedCopilot[];
+    /** Indicates whether there are more results available for pagination. */
+    hasMore: boolean;
+    /** Cursor to use for fetching the next page of results. This is a UUID string. If null or not present, there are no more results. */
+    nextCursor?: string;
+}

package/dist/cjs/api/resources/copilots/types/ExportCopilotsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/copilots/types/ExportedCopilot.d.ts

@@ -0,0 +1,24 @@
+export interface ExportedCopilot {
+    /** The unique identifier of the copilot. */
+    id: string;
+    /** The name of the deployed copilot version. */
+    name: string;
+    /** The description of the deployed copilot version. */
+    description: string;
+    /** Model configuration including provider, model name, temperature, and other settings. */
+    modelConfiguration?: unknown;
+    /** AI endpoint configuration including base URL and authentication details. */
+    aiEndpointConfiguration?: unknown;
+    /** List of tool configurations available to the copilot. */
+    toolConfigurations?: unknown;
+    /** Input variable configurations for the copilot. */
+    inputs?: unknown;
+    /** Deployment settings and configuration. */
+    deploymentConfiguration?: unknown;
+    /** ISO 8601 timestamp when the copilot was originally created. */
+    agentCreatedDatetime: string;
+    /** ISO 8601 timestamp when the deployed version was created. */
+    versionCreatedDatetime: string;
+    /** Indicates if the copilot is currently deployed (always true for export results). */
+    isDeployed: boolean;
+}

package/dist/cjs/api/resources/copilots/types/ExportedCopilot.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/copilots/types/index.d.ts

@@ -12,6 +12,8 @@ export * from "./DeleteCopilotResponse.js";
 export * from "./EndOfMessageChunk.js";
 export * from "./ErrorChunk.js";
 export * from "./ErrorChunkData.js";
+export * from "./ExportCopilotsResponse.js";
+export * from "./ExportedCopilot.js";
 export * from "./FeedbackEnum.js";
 export * from "./Filter.js";
 export * from "./FinalChunk.js";

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

@@ -28,6 +28,8 @@ __exportStar(require("./DeleteCopilotResponse.js"), exports);
 __exportStar(require("./EndOfMessageChunk.js"), exports);
 __exportStar(require("./ErrorChunk.js"), exports);
 __exportStar(require("./ErrorChunkData.js"), exports);
+__exportStar(require("./ExportCopilotsResponse.js"), exports);
+__exportStar(require("./ExportedCopilot.js"), exports);
 __exportStar(require("./FeedbackEnum.js"), exports);
 __exportStar(require("./Filter.js"), exports);
 __exportStar(require("./FinalChunk.js"), exports);

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

@@ -1,4 +1,5 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import type * as Credal from "../../../index.js";
 export declare namespace DocumentCatalogClient {
@@ -8,7 +9,7 @@ export declare namespace DocumentCatalogClient {
     }
 }
 export declare class DocumentCatalogClient {
-    protected readonly _options: DocumentCatalogClient.Options;
+    protected readonly _options: NormalizedClientOptionsWithAuth<DocumentCatalogClient.Options>;
     constructor(options?: DocumentCatalogClient.Options);
     /**
      * @param {Credal.UploadDocumentContentsRequest} request
@@ -81,5 +82,4 @@ export declare class DocumentCatalogClient {
      */
     metadata(request: Credal.DocumentMetadataPatchRequest, requestOptions?: DocumentCatalogClient.RequestOptions): core.HttpResponsePromise<void>;
     private __metadata;
-    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/cjs/api/resources/documentCatalog/client/Client.js

@@ -51,7 +51,7 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class DocumentCatalogClient {
     constructor(options = {}) {
-        this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
      * @param {Credal.UploadDocumentContentsRequest} request
@@ -72,7 +72,8 @@ class DocumentCatalogClient {
     __uploadDocumentContents(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/catalog/uploadDocumentContents"),
                 method: "POST",
@@ -158,7 +159,8 @@ class DocumentCatalogClient {
                 _request.append("awaitVectorStoreSync", request.awaitVectorStoreSync);
             }
             const _maybeEncodedRequest = yield _request.getRequest();
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/catalog/uploadFile"),
                 method: "POST",
@@ -218,7 +220,8 @@ class DocumentCatalogClient {
     __syncSourceByUrl(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/catalog/syncSourceByUrl"),
                 method: "POST",
@@ -298,7 +301,8 @@ class DocumentCatalogClient {
     __metadata(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/catalog/metadata"),
                 method: "PATCH",
@@ -340,17 +344,5 @@ class DocumentCatalogClient {
             }
         });
     }
-    _getAuthorizationHeader() {
-        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 a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
-                });
-            }
-            return `Bearer ${bearer}`;
-        });
-    }
 }
 exports.DocumentCatalogClient = DocumentCatalogClient;

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

@@ -1,4 +1,5 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import type * as Credal from "../../../index.js";
 export declare namespace DocumentCollectionsClient {
@@ -8,7 +9,7 @@ export declare namespace DocumentCollectionsClient {
     }
 }
 export declare class DocumentCollectionsClient {
-    protected readonly _options: DocumentCollectionsClient.Options;
+    protected readonly _options: NormalizedClientOptionsWithAuth<DocumentCollectionsClient.Options>;
     constructor(options?: DocumentCollectionsClient.Options);
     /**
      * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the `uploadDocumentContents` endpoint.
@@ -156,5 +157,4 @@ export declare class DocumentCollectionsClient {
      */
     updateMongoCollectionSync(request: Credal.UpdateMongoCollectionSyncRequest, requestOptions?: DocumentCollectionsClient.RequestOptions): core.HttpResponsePromise<Credal.MongoCollectionSyncResponse>;
     private __updateMongoCollectionSync;
-    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/cjs/api/resources/documentCollections/client/Client.js

@@ -51,7 +51,7 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 class DocumentCollectionsClient {
     constructor(options = {}) {
-        this._options = (0, BaseClient_js_1.normalizeClientOptions)(options);
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
      * Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the `uploadDocumentContents` endpoint.
@@ -79,7 +79,8 @@ class DocumentCollectionsClient {
     __addDocumentsToCollection(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/addDocumentsToCollection"),
                 method: "POST",
@@ -147,7 +148,8 @@ class DocumentCollectionsClient {
     __removeDocumentsFromCollection(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/removeDocumentsFromCollection"),
                 method: "DELETE",
@@ -209,7 +211,8 @@ class DocumentCollectionsClient {
             const { collectionId } = request;
             const _queryParams = {};
             _queryParams.collectionId = collectionId;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/listDocumentsInCollection"),
                 method: "GET",
@@ -273,7 +276,8 @@ class DocumentCollectionsClient {
     __createCollection(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/createCollection"),
                 method: "POST",
@@ -332,7 +336,8 @@ class DocumentCollectionsClient {
     __deleteCollection(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/deleteCollection"),
                 method: "DELETE",
@@ -407,7 +412,8 @@ class DocumentCollectionsClient {
     __createMongoCollectionSync(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/mongodb/createMongoSync"),
                 method: "POST",
@@ -482,7 +488,8 @@ class DocumentCollectionsClient {
     __updateMongoCollectionSync(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
                 url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/documentCollections/mongodb/updateMongoSync"),
                 method: "POST",
@@ -524,17 +531,5 @@ class DocumentCollectionsClient {
             }
         });
     }
-    _getAuthorizationHeader() {
-        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 a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
-                });
-            }
-            return `Bearer ${bearer}`;
-        });
-    }
 }
 exports.DocumentCollectionsClient = DocumentCollectionsClient;