@credal/sdk 0.1.13 → 0.1.16

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

@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs
 import * as core from "../../../../core/index.mjs";
 import type * as Credal from "../../../index.mjs";
 export declare namespace CopilotsClient {
-    interface Options extends BaseClientOptions {
-    }
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }
@@ -147,4 +146,24 @@ export declare class CopilotsClient {
      */
     deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
     private __deleteCopilot;
+    /**
+     * 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/esm/api/resources/copilots/client/Client.mjs

@@ -12,6 +12,7 @@ import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
 export class CopilotsClient {
     constructor(options = {}) {
@@ -65,21 +66,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/createCopilot.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/createCopilot");
         });
     }
     /**
@@ -126,21 +113,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/createConversation.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/createConversation");
         });
     }
     /**
@@ -191,21 +164,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/provideMessageFeedback.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/provideMessageFeedback");
         });
     }
     /**
@@ -258,21 +217,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/sendMessage.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/sendMessage");
         });
     }
     /**
@@ -322,21 +267,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/streamMessage.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/streamMessage");
         });
     }
     /**
@@ -383,21 +314,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/addCollectionToCopilot.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/addCollectionToCopilot");
         });
     }
     /**
@@ -444,21 +361,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/removeCollectionFromCopilot.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/removeCollectionFromCopilot");
         });
     }
     /**
@@ -513,21 +416,7 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/updateConfiguration.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/updateConfiguration");
         });
     }
     /**
@@ -571,21 +460,60 @@ export class CopilotsClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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 DELETE /v0/copilots/deleteCopilot.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v0/copilots/deleteCopilot");
+        });
+    }
+    /**
+     * 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 = 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({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                    rawResponse: _response.rawResponse,
+                });
             }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/copilots/export");
         });
     }
 }

package/dist/esm/api/resources/copilots/client/requests/ExportCopilotsRequest.d.mts

@@ -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/esm/api/resources/copilots/client/requests/ExportCopilotsRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/copilots/client/requests/index.d.mts

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

package/dist/esm/api/resources/copilots/types/ExportCopilotsResponse.d.mts

@@ -0,0 +1,9 @@
+import type * as Credal from "../../../index.mjs";
+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/esm/api/resources/copilots/types/ExportCopilotsResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/copilots/types/ExportedCopilot.d.mts

@@ -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/esm/api/resources/copilots/types/ExportedCopilot.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/copilots/types/index.d.mts

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

package/dist/esm/api/resources/copilots/types/index.mjs

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

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

@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs
 import * as core from "../../../../core/index.mjs";
 import type * as Credal from "../../../index.mjs";
 export declare namespace DocumentCatalogClient {
-    interface Options extends BaseClientOptions {
-    }
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }

package/dist/esm/api/resources/documentCatalog/client/Client.mjs

@@ -12,6 +12,7 @@ import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
 import * as errors from "../../../../errors/index.mjs";
 export class DocumentCatalogClient {
     constructor(options = {}) {
@@ -62,21 +63,7 @@ export class DocumentCatalogClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/catalog/uploadDocumentContents.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/catalog/uploadDocumentContents");
         });
     }
     /**
@@ -149,21 +136,7 @@ export class DocumentCatalogClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/catalog/uploadFile.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/catalog/uploadFile");
         });
     }
     /**
@@ -210,21 +183,7 @@ export class DocumentCatalogClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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/catalog/syncSourceByUrl.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v0/catalog/syncSourceByUrl");
         });
     }
     /**
@@ -291,21 +250,7 @@ export class DocumentCatalogClient {
                     rawResponse: _response.rawResponse,
                 });
             }
-            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 PATCH /v0/catalog/metadata.");
-                case "unknown":
-                    throw new errors.CredalError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v0/catalog/metadata");
         });
     }
 }

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

@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs
 import * as core from "../../../../core/index.mjs";
 import type * as Credal from "../../../index.mjs";
 export declare namespace DocumentCollectionsClient {
-    interface Options extends BaseClientOptions {
-    }
+    type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
     }
 }