@credal/sdk 0.1.1 → 0.1.2

package/dist/cjs/Client.js

@@ -50,8 +50,8 @@ class CredalClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.1.1",
-                "User-Agent": "@credal/sdk/0.1.1",
+                "X-Fern-SDK-Version": "0.1.2",
+                "User-Agent": "@credal/sdk/0.1.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -74,6 +74,19 @@ export declare class DocumentCollections {
      */
     removeDocumentsFromCollection(request: Credal.RemoveDocumentsFromCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): core.HttpResponsePromise<void>;
     private __removeDocumentsFromCollection;
+    /**
+     * List documents in a collection
+     *
+     * @param {Credal.ListDocumentsInCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentCollections.listDocumentsInCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+     *     })
+     */
+    listDocumentsInCollection(request: Credal.ListDocumentsInCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): core.HttpResponsePromise<Credal.ListDocumentsInCollectionResponse>;
+    private __listDocumentsInCollection;
     /**
      * Create a new collection. The API key used will be added to the collection for future Requests
      *

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

@@ -184,6 +184,65 @@ class DocumentCollections {
             }
         });
     }
+    /**
+     * List documents in a collection
+     *
+     * @param {Credal.ListDocumentsInCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentCollections.listDocumentsInCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+     *     })
+     */
+    listDocumentsInCollection(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listDocumentsInCollection(request, requestOptions));
+    }
+    __listDocumentsInCollection(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const { collectionId } = request;
+            const _queryParams = {};
+            _queryParams["collectionId"] = collectionId;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_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/documentCollections/listDocumentsInCollection"),
+                method: "GET",
+                headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            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,
+                });
+            }
+            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 GET /v0/documentCollections/listDocumentsInCollection.");
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Create a new collection. The API key used will be added to the collection for future Requests
      *

package/dist/cjs/api/resources/documentCollections/client/requests/ListDocumentsInCollectionRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+ *     }
+ */
+export interface ListDocumentsInCollectionRequest {
+    /**
+     * The ID of the document collection to list documents from.
+     */
+    collectionId: string;
+}

package/dist/cjs/api/resources/documentCollections/client/requests/ListDocumentsInCollectionRequest.js

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

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

@@ -1,5 +1,6 @@
 export { type AddDocumentsToCollectionRequest } from "./AddDocumentsToCollectionRequest.js";
 export { type RemoveDocumentsFromCollectionRequest } from "./RemoveDocumentsFromCollectionRequest.js";
+export { type ListDocumentsInCollectionRequest } from "./ListDocumentsInCollectionRequest.js";
 export { type CreateCollectionRequest } from "./CreateCollectionRequest.js";
 export { type DeleteCollectionRequest } from "./DeleteCollectionRequest.js";
 export { type CreateMongoCollectionSyncRequest } from "./CreateMongoCollectionSyncRequest.js";

package/dist/cjs/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.js";
+export interface ListDocumentsInCollectionResponse {
+    resourceIdentifiers: Credal.ResourceIdentifier[];
+}

package/dist/cjs/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.js

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

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

@@ -1,5 +1,6 @@
 export * from "./CreateCollectionResponse.js";
 export * from "./DeleteCollectionResponse.js";
+export * from "./ListDocumentsInCollectionResponse.js";
 export * from "./MongoSourceFieldsConfig.js";
 export * from "./MongoCollectionSyncConfig.js";
 export * from "./MongoCollectionSyncResponse.js";

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

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CreateCollectionResponse.js"), exports);
 __exportStar(require("./DeleteCollectionResponse.js"), exports);
+__exportStar(require("./ListDocumentsInCollectionResponse.js"), exports);
 __exportStar(require("./MongoSourceFieldsConfig.js"), exports);
 __exportStar(require("./MongoCollectionSyncConfig.js"), exports);
 __exportStar(require("./MongoCollectionSyncResponse.js"), exports);

package/dist/cjs/core/fetcher/index.d.ts

@@ -6,4 +6,4 @@ export { Supplier } from "./Supplier.js";
 export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
 export type { RawResponse, WithRawResponse } from "./RawResponse.js";
 export { HttpResponsePromise } from "./HttpResponsePromise.js";
-export { BinaryResponse } from "./BinaryResponse.js";
+export type { BinaryResponse } from "./BinaryResponse.js";

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.1";
+export declare const SDK_VERSION = "0.1.2";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.1.1";
+exports.SDK_VERSION = "0.1.2";

package/dist/esm/Client.mjs

@@ -14,8 +14,8 @@ export class CredalClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.1.1",
-                "User-Agent": "@credal/sdk/0.1.1",
+                "X-Fern-SDK-Version": "0.1.2",
+                "User-Agent": "@credal/sdk/0.1.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -74,6 +74,19 @@ export declare class DocumentCollections {
      */
     removeDocumentsFromCollection(request: Credal.RemoveDocumentsFromCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): core.HttpResponsePromise<void>;
     private __removeDocumentsFromCollection;
+    /**
+     * List documents in a collection
+     *
+     * @param {Credal.ListDocumentsInCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentCollections.listDocumentsInCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+     *     })
+     */
+    listDocumentsInCollection(request: Credal.ListDocumentsInCollectionRequest, requestOptions?: DocumentCollections.RequestOptions): core.HttpResponsePromise<Credal.ListDocumentsInCollectionResponse>;
+    private __listDocumentsInCollection;
     /**
      * Create a new collection. The API key used will be added to the collection for future Requests
      *

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

@@ -148,6 +148,65 @@ export class DocumentCollections {
             }
         });
     }
+    /**
+     * List documents in a collection
+     *
+     * @param {Credal.ListDocumentsInCollectionRequest} request
+     * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentCollections.listDocumentsInCollection({
+     *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+     *     })
+     */
+    listDocumentsInCollection(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listDocumentsInCollection(request, requestOptions));
+    }
+    __listDocumentsInCollection(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const { collectionId } = request;
+            const _queryParams = {};
+            _queryParams["collectionId"] = collectionId;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_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/documentCollections/listDocumentsInCollection"),
+                method: "GET",
+                headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            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,
+                });
+            }
+            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 GET /v0/documentCollections/listDocumentsInCollection.");
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Create a new collection. The API key used will be added to the collection for future Requests
      *

package/dist/esm/api/resources/documentCollections/client/requests/ListDocumentsInCollectionRequest.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24"
+ *     }
+ */
+export interface ListDocumentsInCollectionRequest {
+    /**
+     * The ID of the document collection to list documents from.
+     */
+    collectionId: string;
+}

package/dist/esm/api/resources/documentCollections/client/requests/ListDocumentsInCollectionRequest.mjs

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

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

@@ -1,5 +1,6 @@
 export { type AddDocumentsToCollectionRequest } from "./AddDocumentsToCollectionRequest.mjs";
 export { type RemoveDocumentsFromCollectionRequest } from "./RemoveDocumentsFromCollectionRequest.mjs";
+export { type ListDocumentsInCollectionRequest } from "./ListDocumentsInCollectionRequest.mjs";
 export { type CreateCollectionRequest } from "./CreateCollectionRequest.mjs";
 export { type DeleteCollectionRequest } from "./DeleteCollectionRequest.mjs";
 export { type CreateMongoCollectionSyncRequest } from "./CreateMongoCollectionSyncRequest.mjs";

package/dist/esm/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export interface ListDocumentsInCollectionResponse {
+    resourceIdentifiers: Credal.ResourceIdentifier[];
+}

package/dist/esm/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.mjs

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

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

@@ -1,5 +1,6 @@
 export * from "./CreateCollectionResponse.mjs";
 export * from "./DeleteCollectionResponse.mjs";
+export * from "./ListDocumentsInCollectionResponse.mjs";
 export * from "./MongoSourceFieldsConfig.mjs";
 export * from "./MongoCollectionSyncConfig.mjs";
 export * from "./MongoCollectionSyncResponse.mjs";

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

@@ -1,5 +1,6 @@
 export * from "./CreateCollectionResponse.mjs";
 export * from "./DeleteCollectionResponse.mjs";
+export * from "./ListDocumentsInCollectionResponse.mjs";
 export * from "./MongoSourceFieldsConfig.mjs";
 export * from "./MongoCollectionSyncConfig.mjs";
 export * from "./MongoCollectionSyncResponse.mjs";

package/dist/esm/core/fetcher/index.d.mts

@@ -6,4 +6,4 @@ export { Supplier } from "./Supplier.mjs";
 export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
 export type { RawResponse, WithRawResponse } from "./RawResponse.mjs";
 export { HttpResponsePromise } from "./HttpResponsePromise.mjs";
-export { BinaryResponse } from "./BinaryResponse.mjs";
+export type { BinaryResponse } from "./BinaryResponse.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.1";
+export declare const SDK_VERSION = "0.1.2";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.1";
+export const SDK_VERSION = "0.1.2";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@credal/sdk",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "private": false,
     "repository": "github:credal-ai/credal-typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -962,6 +962,71 @@ await client.documentCollections.removeDocumentsFromCollection({
 </dl>
 </details>
 
+<details><summary><code>client.documentCollections.<a href="/src/api/resources/documentCollections/client/Client.ts">listDocumentsInCollection</a>({ ...params }) -> Credal.ListDocumentsInCollectionResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List documents in a collection
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.documentCollections.listDocumentsInCollection({
+    collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Credal.ListDocumentsInCollectionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DocumentCollections.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.documentCollections.<a href="/src/api/resources/documentCollections/client/Client.ts">createCollection</a>({ ...params }) -> Credal.CreateCollectionResponse</code></summary>
 <dl>
 <dd>