postgrid-node 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.4.2 (2025-11-12)
+
+Full Changelog: [v0.4.1...v0.4.2](https://github.com/postgrid/postgrid-node/compare/v0.4.1...v0.4.2)
+
+### Bug Fixes
+
+* **readme:** update the readme ([2308e71](https://github.com/postgrid/postgrid-node/commit/2308e71046e82f88e4630e9b2277764075cd6af3))
+
+## 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)

package/README.md

@@ -4,7 +4,7 @@
 
 This library provides convenient access to the Post Grid REST API from server-side TypeScript or JavaScript.
 
-The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [docs.postgrid.com](https://docs.postgrid.com). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -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/package.json

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

package/src/version.ts

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

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.4.0";
+export declare const VERSION = "0.4.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.4.0";
+export declare const VERSION = "0.4.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.4.0'; // x-release-please-version
+exports.VERSION = '0.4.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.4.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map