release: 0.4.1 (#21)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.4.0"
+  ".": "0.4.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 91
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/postgrid%2Fpostgrid-be6a47768faf3612d1dc9c8a108edb10a6c5a4e52b78cc7f4768e1d497e11e08.yml
 openapi_spec_hash: a3ed2b74031c834a724b67db9ab6b23d
-config_hash: 976efc54edcbbcdb2281d74f6d9f2c98
+config_hash: fd861cd701dc9f34c859bd7a19269d99

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.1 (2025-11-12)
+
+Full Changelog: [v0.4.0...v0.4.1](https://github.com/postgrid/postgrid-node/compare/v0.4.0...v0.4.1)
+
+### Bug Fixes
+
+* **api:** small readme updates ([2a166c7](https://github.com/postgrid/postgrid-node/commit/2a166c7e2577102958777f3e9b921f5772a7ad12))
+
 ## 0.4.0 (2025-11-12)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/postgrid/postgrid-node/compare/v0.3.0...v0.4.0)

README.md

@@ -125,6 +125,37 @@ 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 PostGrid API are paginated.
+You can use the `for await … of` syntax to iterate through items across all pages:
+
+```ts
+async function fetchAllLetters(params) {
+  const allLetters = [];
+  // Automatically fetches more pages as needed.
+  for await (const letter of client.printMail.letters.list({ limit: 100 })) {
+    allLetters.push(letter);
+  }
+  return allLetters;
+}
+```
+
+Alternatively, you can request a single page at a time:
+
+```ts
+let page = await client.printMail.letters.list({ limit: 100 });
+for (const letter of page.data) {
+  console.log(letter);
+}
+
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = await page.getNextPage();
+  // ...
+}
+```
+
 ## Advanced Usage
 
 ### Accessing raw Response data (e.g., headers)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "postgrid-node",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "The official TypeScript library for the Post Grid API",
   "author": "Post Grid <support@postgrid.com>",
   "types": "dist/index.d.ts",

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.4.1'; // x-release-please-version