@zavudev/sdk 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.9.0 (2025-12-05)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/zavudev/sdk-typescript/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** fix other issues ([5752dcc](https://github.com/zavudev/sdk-typescript/commit/5752dcc208dd17fa8fd6fe6b21b0b88e666be052))
+
 ## 0.8.0 (2025-12-05)
 
 Full Changelog: [v0.7.0...v0.8.0](https://github.com/zavudev/sdk-typescript/compare/v0.7.0...v0.8.0)

package/README.md

@@ -26,7 +26,7 @@ const client = new Zavudev({
   apiKey: process.env['ZAVUDEV_API_KEY'], // This is the default and can be omitted
 });
 
-const messageResponse = await client.messages.send({ to: '+56912345678' });
+const messageResponse = await client.messages.send({ to: '+14155551234', text: 'Hello from Zavu!' });
 
 console.log(messageResponse.message);
 ```
@@ -43,7 +43,7 @@ const client = new Zavudev({
   apiKey: process.env['ZAVUDEV_API_KEY'], // This is the default and can be omitted
 });
 
-const params: Zavudev.MessageSendParams = { to: '+56912345678' };
+const params: Zavudev.MessageSendParams = { to: '+14155551234', text: 'Hello from Zavu!' };
 const messageResponse: Zavudev.MessageResponse = await client.messages.send(params);
 ```
 
@@ -57,15 +57,17 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const messageResponse = await client.messages.send({ to: '+56912345678' }).catch(async (err) => {
-  if (err instanceof Zavudev.APIError) {
-    console.log(err.status); // 400
-    console.log(err.name); // BadRequestError
-    console.log(err.headers); // {server: 'nginx', ...}
-  } else {
-    throw err;
-  }
-});
+const messageResponse = await client.messages
+  .send({ to: '+14155551234', text: 'Hello from Zavu!' })
+  .catch(async (err) => {
+    if (err instanceof Zavudev.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 ```
 
 Error codes are as follows:
@@ -97,7 +99,7 @@ const client = new Zavudev({
 });
 
 // Or, configure per-request:
-await client.messages.send({ to: '+56912345678' }, {
+await client.messages.send({ to: '+14155551234', text: 'Hello from Zavu!' }, {
   maxRetries: 5,
 });
 ```
@@ -114,7 +116,7 @@ const client = new Zavudev({
 });
 
 // Override per-request:
-await client.messages.send({ to: '+56912345678' }, {
+await client.messages.send({ to: '+14155551234', text: 'Hello from Zavu!' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -123,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 Zavudev API are paginated.
+You can use the `for await … of` syntax to iterate through items across all pages:
+
+```ts
+async function fetchAllMessages(params) {
+  const allMessages = [];
+  // Automatically fetches more pages as needed.
+  for await (const message of client.messages.list()) {
+    allMessages.push(message);
+  }
+  return allMessages;
+}
+```
+
+Alternatively, you can request a single page at a time:
+
+```ts
+let page = await client.messages.list();
+for (const message of page.items) {
+  console.log(message);
+}
+
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = await page.getNextPage();
+  // ...
+}
+```
+
 ## Advanced Usage
 
 ### Accessing raw Response data (e.g., headers)
@@ -137,12 +170,12 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new Zavudev();
 
-const response = await client.messages.send({ to: '+56912345678' }).asResponse();
+const response = await client.messages.send({ to: '+14155551234', text: 'Hello from Zavu!' }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
 const { data: messageResponse, response: raw } = await client.messages
-  .send({ to: '+56912345678' })
+  .send({ to: '+14155551234', text: 'Hello from Zavu!' })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(messageResponse.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zavudev/sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "The official TypeScript library for the Zavudev API",
   "author": "Zavudev <hi@zavu.dev>",
   "types": "./index.d.ts",

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.8.0'; // x-release-please-version
+export const VERSION = '0.9.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.8.0";
+export declare const VERSION = "0.9.0";
 //# 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.8.0'; // x-release-please-version
+exports.VERSION = '0.9.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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