From f0e1d21d23560fa96ad5fccc80547a1f3242bdae Mon Sep 17 00:00:00 2001
From: Austin DeNoble <austin.d@pinecone.io>
Date: Mon, 25 Mar 2024 17:26:15 -0400
Subject: [PATCH] export ListResponse from generated core, add docstring for
 ListOptions type

---
 src/data/list.ts | 6 ++++++
 src/index.ts     | 1 +
 2 files changed, 7 insertions(+)

diff --git a/src/data/list.ts b/src/data/list.ts
index 68f49101..6ee8302d 100644
--- a/src/data/list.ts
+++ b/src/data/list.ts
@@ -3,9 +3,15 @@ import { Type } from '@sinclair/typebox';
 import { DataOperationsProvider } from './dataOperationsProvider';
 import type { ListRequest, ListResponse } from '../pinecone-generated-ts-fetch';
 
+/**
+ * See [List record IDs](https://docs.pinecone.io/guides/data/list-record-ids)
+ */
 export type ListOptions = {
+  /** The id prefix to match. If unspecified, an empty string prefix will be used with the effect of listing all ids in a namespace. */
   prefix?: string;
+  /** The maximum number of ids to return. If unspecified, the server will use a default value. */
   limit?: number;
+  /** A token needed to fetch the next page of results. This token is returned in the response if additional results are available. */
   paginationToken?: string;
 };
 
diff --git a/src/index.ts b/src/index.ts
index ad23fdaf..7cc19178 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -51,6 +51,7 @@ export type {
   FetchAPI,
   IndexList,
   IndexModel,
+  ListResponse,
   ServerlessSpec,
   ServerlessSpecCloudEnum,
   PodSpec,