feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 15
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zeroentropy%2Fzeroentropy-f06c49dfd4b38a4f9d5bcad56348156bbf641aa8b7968acfbf655ad6ceff2126.yml
 openapi_spec_hash: cac52dd65fbcb65ffa7a183e764b7f06
-config_hash: a7dc8380ffa9d78eee964a96e0eb7b54
+config_hash: 34c8a6deaedce51a258bc46b38c9caa0

README.md

@@ -126,6 +126,39 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
 
 Note that requests which time out will be [retried twice by default](#retries).
 
+## Auto-pagination
+
+List methods in the ZeroEntropy API are paginated.
+You can use the `for await … of` syntax to iterate through items across all pages:
+
+```ts
+async function fetchAllDocumentGetInfoListResponses(params) {
+  const allDocumentGetInfoListResponses = [];
+  // Automatically fetches more pages as needed.
+  for await (const documentGetInfoListResponse of client.documents.getInfoList({
+    collection_name: 'example_collection',
+  })) {
+    allDocumentGetInfoListResponses.push(documentGetInfoListResponse);
+  }
+  return allDocumentGetInfoListResponses;
+}
+```
+
+Alternatively, you can request a single page at a time:
+
+```ts
+let page = await client.documents.getInfoList({ collection_name: 'example_collection' });
+for (const documentGetInfoListResponse of page.documents) {
+  console.log(documentGetInfoListResponse);
+}
+
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = await page.getNextPage();
+  // ...
+}
+```
+
 ## Advanced Usage
 
 ### Accessing raw Response data (e.g., headers)

api.md

@@ -49,7 +49,7 @@ Methods:
 - <code title="post /documents/delete-document">client.documents.<a href="./src/resources/documents.ts">delete</a>({ ...params }) -> DocumentDeleteResponse</code>
 - <code title="post /documents/add-document">client.documents.<a href="./src/resources/documents.ts">add</a>({ ...params }) -> DocumentAddResponse</code>
 - <code title="post /documents/get-document-info">client.documents.<a href="./src/resources/documents.ts">getInfo</a>({ ...params }) -> DocumentGetInfoResponse</code>
-- <code title="post /documents/get-document-info-list">client.documents.<a href="./src/resources/documents.ts">getInfoList</a>({ ...params }) -> DocumentGetInfoListResponse</code>
+- <code title="post /documents/get-document-info-list">client.documents.<a href="./src/resources/documents.ts">getInfoList</a>({ ...params }) -> DocumentGetInfoListResponsesGetDocumentInfoListCursor</code>
 - <code title="post /documents/get-page-info">client.documents.<a href="./src/resources/documents.ts">getPageInfo</a>({ ...params }) -> DocumentGetPageInfoResponse</code>
 
 # Queries

src/index.ts

@@ -24,6 +24,7 @@ import {
   DocumentDeleteResponse,
   DocumentGetInfoListParams,
   DocumentGetInfoListResponse,
+  DocumentGetInfoListResponsesGetDocumentInfoListCursor,
   DocumentGetInfoParams,
   DocumentGetInfoResponse,
   DocumentGetPageInfoParams,
@@ -204,6 +205,8 @@ ZeroEntropy.Admin = Admin;
 ZeroEntropy.Status = Status;
 ZeroEntropy.Collections = Collections;
 ZeroEntropy.Documents = Documents;
+ZeroEntropy.DocumentGetInfoListResponsesGetDocumentInfoListCursor =
+  DocumentGetInfoListResponsesGetDocumentInfoListCursor;
 ZeroEntropy.Queries = Queries;
 ZeroEntropy.Parsers = Parsers;
 export declare namespace ZeroEntropy {
@@ -245,6 +248,7 @@ export declare namespace ZeroEntropy {
     type DocumentGetInfoResponse as DocumentGetInfoResponse,
     type DocumentGetInfoListResponse as DocumentGetInfoListResponse,
     type DocumentGetPageInfoResponse as DocumentGetPageInfoResponse,
+    DocumentGetInfoListResponsesGetDocumentInfoListCursor as DocumentGetInfoListResponsesGetDocumentInfoListCursor,
     type DocumentUpdateParams as DocumentUpdateParams,
     type DocumentDeleteParams as DocumentDeleteParams,
     type DocumentAddParams as DocumentAddParams,

src/resources/documents.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
+import { GetDocumentInfoListCursor, type GetDocumentInfoListCursorParams } from '../pagination';
 
 export class Documents extends APIResource {
   /**
@@ -79,8 +80,12 @@ export class Documents extends APIResource {
   getInfoList(
     body: DocumentGetInfoListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DocumentGetInfoListResponse> {
-    return this._client.post('/documents/get-document-info-list', { body, ...options });
+  ): Core.PagePromise<DocumentGetInfoListResponsesGetDocumentInfoListCursor, DocumentGetInfoListResponse> {
+    return this._client.getAPIList(
+      '/documents/get-document-info-list',
+      DocumentGetInfoListResponsesGetDocumentInfoListCursor,
+      { body, method: 'post', ...options },
+    );
   }
 
   /**
@@ -98,6 +103,8 @@ export class Documents extends APIResource {
   }
 }
 
+export class DocumentGetInfoListResponsesGetDocumentInfoListCursor extends GetDocumentInfoListCursor<DocumentGetInfoListResponse> {}
+
 export interface DocumentUpdateResponse {
   new_id: string;
 
@@ -170,51 +177,45 @@ export namespace DocumentGetInfoResponse {
 }
 
 export interface DocumentGetInfoListResponse {
-  documents: Array<DocumentGetInfoListResponse.Document>;
-}
+  id: string;
 
-export namespace DocumentGetInfoListResponse {
-  export interface Document {
-    id: string;
+  collection_name: string;
 
-    collection_name: string;
+  created_at: string;
 
-    created_at: string;
+  /**
+   * A URL to the document data, which can be used to download the raw document
+   * content or to display the document in frontend applications.
+   *
+   * NOTE: If a `/documents/update-document` call returned a new document id, then
+   * this url will be invalidated and must be retrieved again.
+   */
+  file_url: string;
 
-    /**
-     * A URL to the document data, which can be used to download the raw document
-     * content or to display the document in frontend applications.
-     *
-     * NOTE: If a `/documents/update-document` call returned a new document id, then
-     * this url will be invalidated and must be retrieved again.
-     */
-    file_url: string;
+  index_status:
+    | 'not_parsed'
+    | 'parsing'
+    | 'not_indexed'
+    | 'indexing'
+    | 'indexed'
+    | 'parsing_failed'
+    | 'indexing_failed';
 
-    index_status:
-      | 'not_parsed'
-      | 'parsing'
-      | 'not_indexed'
-      | 'indexing'
-      | 'indexed'
-      | 'parsing_failed'
-      | 'indexing_failed';
+  metadata: Record<string, string | Array<string>>;
 
-    metadata: Record<string, string | Array<string>>;
-
-    /**
-     * The number of pages in this document. This will be `null` if the document is
-     * parsing or failed to parse. It can also be `null` if the document is a filetype
-     * that does not support pages.
-     */
-    num_pages: number | null;
+  /**
+   * The number of pages in this document. This will be `null` if the document is
+   * parsing or failed to parse. It can also be `null` if the document is a filetype
+   * that does not support pages.
+   */
+  num_pages: number | null;
 
-    path: string;
+  path: string;
 
-    /**
-     * The total size of the raw document data, in bytes.
-     */
-    size: number;
-  }
+  /**
+   * The total size of the raw document data, in bytes.
+   */
+  size: number;
 }
 
 export interface DocumentGetPageInfoResponse {
@@ -401,26 +402,12 @@ export interface DocumentGetInfoParams {
   include_content?: boolean;
 }
 
-export interface DocumentGetInfoListParams {
+export interface DocumentGetInfoListParams extends GetDocumentInfoListCursorParams {
   /**
    * The name of the collection.
    */
   collection_name: string;
 
-  /**
-   * The maximum number of documents to return. This field is by default 1024, and
-   * cannot be set larger than 1024
-   */
-  limit?: number;
-
-  /**
-   * All documents returned will have a path strictly greater than the provided
-   * `path_gt` argument. (Comparison will be based on lexicographic comparison. It is
-   * guaranteed that two strings are lexicographically equal if and only if they have
-   * identical binary representations.).
-   */
-  path_gt?: string | null;
-
   /**
    * All documents returned will have a path that starts with the provided path
    * prefix.
@@ -456,6 +443,9 @@ export interface DocumentGetPageInfoParams {
   include_content?: boolean;
 }
 
+Documents.DocumentGetInfoListResponsesGetDocumentInfoListCursor =
+  DocumentGetInfoListResponsesGetDocumentInfoListCursor;
+
 export declare namespace Documents {
   export {
     type DocumentUpdateResponse as DocumentUpdateResponse,
@@ -464,6 +454,7 @@ export declare namespace Documents {
     type DocumentGetInfoResponse as DocumentGetInfoResponse,
     type DocumentGetInfoListResponse as DocumentGetInfoListResponse,
     type DocumentGetPageInfoResponse as DocumentGetPageInfoResponse,
+    DocumentGetInfoListResponsesGetDocumentInfoListCursor as DocumentGetInfoListResponsesGetDocumentInfoListCursor,
     type DocumentUpdateParams as DocumentUpdateParams,
     type DocumentDeleteParams as DocumentDeleteParams,
     type DocumentAddParams as DocumentAddParams,

src/resources/index.ts

@@ -11,6 +11,7 @@ export {
   type CollectionGetListParams,
 } from './collections';
 export {
+  DocumentGetInfoListResponsesGetDocumentInfoListCursor,
   Documents,
   type DocumentUpdateResponse,
   type DocumentDeleteResponse,