feat(api): update via SDK Studio

Author: stainless-app[bot]

api.md

@@ -12,15 +12,15 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/collections.ts">CollectionListResponse</a></code>
 - <code><a href="./src/resources/collections.ts">CollectionAddCollectionResponse</a></code>
 - <code><a href="./src/resources/collections.ts">CollectionDeleteCollectionResponse</a></code>
+- <code><a href="./src/resources/collections.ts">CollectionGetListResponse</a></code>
 
 Methods:
 
-- <code title="post /collections/get-collection-list">client.collections.<a href="./src/resources/collections.ts">list</a>() -> CollectionListResponse</code>
 - <code title="post /collections/add-collection">client.collections.<a href="./src/resources/collections.ts">addCollection</a>({ ...params }) -> CollectionAddCollectionResponse</code>
 - <code title="post /collections/delete-collection">client.collections.<a href="./src/resources/collections.ts">deleteCollection</a>({ ...params }) -> CollectionDeleteCollectionResponse</code>
+- <code title="post /collections/get-collection-list">client.collections.<a href="./src/resources/collections.ts">getList</a>() -> CollectionGetListResponse</code>
 
 # Documents
 
@@ -29,16 +29,16 @@ Types:
 - <code><a href="./src/resources/documents.ts">DocumentAddDocumentResponse</a></code>
 - <code><a href="./src/resources/documents.ts">DocumentDeleteDocumentResponse</a></code>
 - <code><a href="./src/resources/documents.ts">DocumentGetInfoResponse</a></code>
+- <code><a href="./src/resources/documents.ts">DocumentGetInfoListResponse</a></code>
 - <code><a href="./src/resources/documents.ts">DocumentGetPageInfoResponse</a></code>
-- <code><a href="./src/resources/documents.ts">DocumentListInfoResponse</a></code>
 
 Methods:
 
 - <code title="post /documents/add-document">client.documents.<a href="./src/resources/documents.ts">addDocument</a>({ ...params }) -> DocumentAddDocumentResponse</code>
 - <code title="post /documents/delete-document">client.documents.<a href="./src/resources/documents.ts">deleteDocument</a>({ ...params }) -> DocumentDeleteDocumentResponse</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-page-info">client.documents.<a href="./src/resources/documents.ts">getPageInfo</a>({ ...params }) -> DocumentGetPageInfoResponse</code>
-- <code title="post /documents/get-document-info-list">client.documents.<a href="./src/resources/documents.ts">listInfo</a>({ ...params }) -> DocumentListInfoResponse</code>
 
 # Queries
 

src/index.ts

@@ -10,21 +10,21 @@ import {
   CollectionAddCollectionResponse,
   CollectionDeleteCollectionParams,
   CollectionDeleteCollectionResponse,
-  CollectionListParams,
-  CollectionListResponse,
+  CollectionGetListParams,
+  CollectionGetListResponse,
   Collections,
 } from './resources/collections';
 import {
   DocumentAddDocumentParams,
   DocumentAddDocumentResponse,
   DocumentDeleteDocumentParams,
   DocumentDeleteDocumentResponse,
+  DocumentGetInfoListParams,
+  DocumentGetInfoListResponse,
   DocumentGetInfoParams,
   DocumentGetInfoResponse,
   DocumentGetPageInfoParams,
   DocumentGetPageInfoResponse,
-  DocumentListInfoParams,
-  DocumentListInfoResponse,
   Documents,
 } from './resources/documents';
 import { Models, StrJson } from './resources/models';
@@ -213,26 +213,26 @@ export declare namespace Zeroentropy {
 
   export {
     Collections as Collections,
-    type CollectionListResponse as CollectionListResponse,
     type CollectionAddCollectionResponse as CollectionAddCollectionResponse,
     type CollectionDeleteCollectionResponse as CollectionDeleteCollectionResponse,
-    type CollectionListParams as CollectionListParams,
+    type CollectionGetListResponse as CollectionGetListResponse,
     type CollectionAddCollectionParams as CollectionAddCollectionParams,
     type CollectionDeleteCollectionParams as CollectionDeleteCollectionParams,
+    type CollectionGetListParams as CollectionGetListParams,
   };
 
   export {
     Documents as Documents,
     type DocumentAddDocumentResponse as DocumentAddDocumentResponse,
     type DocumentDeleteDocumentResponse as DocumentDeleteDocumentResponse,
     type DocumentGetInfoResponse as DocumentGetInfoResponse,
+    type DocumentGetInfoListResponse as DocumentGetInfoListResponse,
     type DocumentGetPageInfoResponse as DocumentGetPageInfoResponse,
-    type DocumentListInfoResponse as DocumentListInfoResponse,
     type DocumentAddDocumentParams as DocumentAddDocumentParams,
     type DocumentDeleteDocumentParams as DocumentDeleteDocumentParams,
     type DocumentGetInfoParams as DocumentGetInfoParams,
+    type DocumentGetInfoListParams as DocumentGetInfoListParams,
     type DocumentGetPageInfoParams as DocumentGetPageInfoParams,
-    type DocumentListInfoParams as DocumentListInfoParams,
   };
 
   export {

src/resources/collections.ts

@@ -4,16 +4,6 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 
 export class Collections extends APIResource {
-  /**
-   * Gets a complete list of all of your collections.
-   */
-  list(
-    body?: CollectionListParams | null | undefined,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CollectionListResponse> {
-    return this._client.post('/collections/get-collection-list', { body, ...options });
-  }
-
   /**
    * Adds a collection.
    *
@@ -38,13 +28,16 @@ export class Collections extends APIResource {
   ): Core.APIPromise<CollectionDeleteCollectionResponse> {
     return this._client.post('/collections/delete-collection', { body, ...options });
   }
-}
 
-export interface CollectionListResponse {
   /**
-   * The names of the matched collections.
+   * Gets a complete list of all of your collections.
    */
-  collection_names: Array<string>;
+  getList(
+    body?: CollectionGetListParams | null | undefined,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CollectionGetListResponse> {
+    return this._client.post('/collections/get-collection-list', { body, ...options });
+  }
 }
 
 export interface CollectionAddCollectionResponse {
@@ -61,7 +54,12 @@ export interface CollectionDeleteCollectionResponse {
   message?: string;
 }
 
-export interface CollectionListParams {}
+export interface CollectionGetListResponse {
+  /**
+   * The names of the matched collections.
+   */
+  collection_names: Array<string>;
+}
 
 export interface CollectionAddCollectionParams {
   /**
@@ -79,13 +77,15 @@ export interface CollectionDeleteCollectionParams {
   collection_name: string;
 }
 
+export interface CollectionGetListParams {}
+
 export declare namespace Collections {
   export {
-    type CollectionListResponse as CollectionListResponse,
     type CollectionAddCollectionResponse as CollectionAddCollectionResponse,
     type CollectionDeleteCollectionResponse as CollectionDeleteCollectionResponse,
-    type CollectionListParams as CollectionListParams,
+    type CollectionGetListResponse as CollectionGetListResponse,
     type CollectionAddCollectionParams as CollectionAddCollectionParams,
     type CollectionDeleteCollectionParams as CollectionDeleteCollectionParams,
+    type CollectionGetListParams as CollectionGetListParams,
   };
 }

src/resources/documents.ts

@@ -53,35 +53,35 @@ export class Documents extends APIResource {
   }
 
   /**
-   * Retrieves information about a specific page. The request parameters define what
-   * information you would like to receive.
+   * Retrives a list of document metadata information that matches the provided
+   * filters.
+   *
+   * The documents returned will be sorted by ID in ascending order. `id_gt` can be
+   * used for pagination, and should be set to the ID of the last document returned
+   * in the previous call.
    *
    * A `404 Not Found` will be returned if either the collection name does not exist,
    * or the document path does not exist within the provided collection.
    */
-  getPageInfo(
-    body: DocumentGetPageInfoParams,
+  getInfoList(
+    body: DocumentGetInfoListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DocumentGetPageInfoResponse> {
-    return this._client.post('/documents/get-page-info', { body, ...options });
+  ): Core.APIPromise<DocumentGetInfoListResponse> {
+    return this._client.post('/documents/get-document-info-list', { body, ...options });
   }
 
   /**
-   * Retrives a list of document metadata information that matches the provided
-   * filters.
-   *
-   * The documents returned will be sorted by ID in ascending order. `id_gt` can be
-   * used for pagination, and should be set to the ID of the last document returned
-   * in the previous call.
+   * Retrieves information about a specific page. The request parameters define what
+   * information you would like to receive.
    *
    * A `404 Not Found` will be returned if either the collection name does not exist,
    * or the document path does not exist within the provided collection.
    */
-  listInfo(
-    body: DocumentListInfoParams,
+  getPageInfo(
+    body: DocumentGetPageInfoParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DocumentListInfoResponse> {
-    return this._client.post('/documents/get-document-info-list', { body, ...options });
+  ): Core.APIPromise<DocumentGetPageInfoResponse> {
+    return this._client.post('/documents/get-page-info', { body, ...options });
   }
 }
 
@@ -129,6 +129,31 @@ export namespace DocumentGetInfoResponse {
   }
 }
 
+export interface DocumentGetInfoListResponse {
+  documents: Array<DocumentGetInfoListResponse.Document>;
+}
+
+export namespace DocumentGetInfoListResponse {
+  export interface Document {
+    id: string;
+
+    collection_name: string;
+
+    index_status: 'parsing_failed' | 'not_parsed' | 'not_indexed' | 'indexing' | 'indexed';
+
+    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;
+
+    path: string;
+  }
+}
+
 export interface DocumentGetPageInfoResponse {
   page: DocumentGetPageInfoResponse.Page;
 }
@@ -171,31 +196,6 @@ export namespace DocumentGetPageInfoResponse {
   }
 }
 
-export interface DocumentListInfoResponse {
-  documents: Array<DocumentListInfoResponse.Document>;
-}
-
-export namespace DocumentListInfoResponse {
-  export interface Document {
-    id: string;
-
-    collection_name: string;
-
-    index_status: 'parsing_failed' | 'not_parsed' | 'not_indexed' | 'indexing' | 'indexed';
-
-    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;
-
-    path: string;
-  }
-}
-
 export interface DocumentAddDocumentParams {
   /**
    * The name of the collection to be used for this request. A `404 Not Found` status
@@ -315,6 +315,25 @@ export interface DocumentGetInfoParams {
   include_content?: boolean;
 }
 
+export interface DocumentGetInfoListParams {
+  /**
+   * The name of the collection.
+   */
+  collection_name: string;
+
+  /**
+   * All documents returned will have a UUID strictly greater than the provided UUID.
+   * (Comparison will be on the binary representations of the UUIDs)
+   */
+  id_gt?: string | null;
+
+  /**
+   * The maximum number of documents to return. This field is by default 1024, and
+   * cannot be set larger than 1024
+   */
+  limit?: number;
+}
+
 export interface DocumentGetPageInfoParams {
   /**
    * The name of the collection.
@@ -354,36 +373,17 @@ export interface DocumentGetPageInfoParams {
   include_image?: boolean;
 }
 
-export interface DocumentListInfoParams {
-  /**
-   * The name of the collection.
-   */
-  collection_name: string;
-
-  /**
-   * All documents returned will have a UUID strictly greater than the provided UUID.
-   * (Comparison will be on the binary representations of the UUIDs)
-   */
-  id_gt?: string | null;
-
-  /**
-   * The maximum number of documents to return. This field is by default 1024, and
-   * cannot be set larger than 1024
-   */
-  limit?: number;
-}
-
 export declare namespace Documents {
   export {
     type DocumentAddDocumentResponse as DocumentAddDocumentResponse,
     type DocumentDeleteDocumentResponse as DocumentDeleteDocumentResponse,
     type DocumentGetInfoResponse as DocumentGetInfoResponse,
+    type DocumentGetInfoListResponse as DocumentGetInfoListResponse,
     type DocumentGetPageInfoResponse as DocumentGetPageInfoResponse,
-    type DocumentListInfoResponse as DocumentListInfoResponse,
     type DocumentAddDocumentParams as DocumentAddDocumentParams,
     type DocumentDeleteDocumentParams as DocumentDeleteDocumentParams,
     type DocumentGetInfoParams as DocumentGetInfoParams,
+    type DocumentGetInfoListParams as DocumentGetInfoListParams,
     type DocumentGetPageInfoParams as DocumentGetPageInfoParams,
-    type DocumentListInfoParams as DocumentListInfoParams,
   };
 }

src/resources/index.ts

@@ -2,25 +2,25 @@
 
 export {
   Collections,
-  type CollectionListResponse,
   type CollectionAddCollectionResponse,
   type CollectionDeleteCollectionResponse,
-  type CollectionListParams,
+  type CollectionGetListResponse,
   type CollectionAddCollectionParams,
   type CollectionDeleteCollectionParams,
+  type CollectionGetListParams,
 } from './collections';
 export {
   Documents,
   type DocumentAddDocumentResponse,
   type DocumentDeleteDocumentResponse,
   type DocumentGetInfoResponse,
+  type DocumentGetInfoListResponse,
   type DocumentGetPageInfoResponse,
-  type DocumentListInfoResponse,
   type DocumentAddDocumentParams,
   type DocumentDeleteDocumentParams,
   type DocumentGetInfoParams,
+  type DocumentGetInfoListParams,
   type DocumentGetPageInfoParams,
-  type DocumentListInfoParams,
 } from './documents';
 export { Models, type StrJson } from './models';
 export { Parsers, type ParserParseResponse, type ParserParseParams } from './parsers';