@zavudev/sdk 0.0.7 → 0.0.9

package/README.md

@@ -1,25 +1,22 @@
-# openapi
+# Zavu TypeScript SDK
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *openapi* API.
+Developer-friendly & type-safe TypeScript SDK for the Zavu multi-channel messaging API.
 
-[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=typescript)
 [![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)
 
-
-<br /><br />
-> [!IMPORTANT]
-> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/crubing/zavu). Delete this section before > publishing to a package manager.
-
 <!-- Start Summary [summary] -->
+
 ## Summary
 
 Zavu Messaging API: Unified multi-channel messaging API for Zavu.
 
 Supported channels:
+
 - **SMS**: Simple text messages
 - **WhatsApp**: Rich messaging with media, buttons, lists, and templates
 
 Design goals:
+
 - Simple `send()` entrypoint for developers
 - Project-level authentication via Bearer token
 - Support for all WhatsApp message types (text, image, video, audio, document, sticker, location, contact, buttons, list, reaction, template)
@@ -28,33 +25,36 @@ Design goals:
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
+
 ## Table of Contents
+
 <!-- $toc-max-depth=2 -->
-* [openapi](#openapi)
-  * [SDK Installation](#sdk-installation)
-  * [Requirements](#requirements)
-  * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication)
-  * [Available Resources and Operations](#available-resources-and-operations)
-  * [Standalone functions](#standalone-functions)
-  * [Retries](#retries)
-  * [Error Handling](#error-handling)
-  * [Server Selection](#server-selection)
-  * [Custom HTTP Client](#custom-http-client)
-  * [Debugging](#debugging)
-* [Development](#development)
-  * [Maturity](#maturity)
-  * [Contributions](#contributions)
+
+- [Zavu TypeScript SDK](#zavu-typescript-sdk)
+  - [SDK Installation](#sdk-installation)
+  - [Requirements](#requirements)
+  - [SDK Example Usage](#sdk-example-usage)
+  - [Authentication](#authentication)
+  - [Available Resources and Operations](#available-resources-and-operations)
+  - [Standalone functions](#standalone-functions)
+  - [Retries](#retries)
+  - [Error Handling](#error-handling)
+  - [Server Selection](#server-selection)
+  - [Custom HTTP Client](#custom-http-client)
+  - [Debugging](#debugging)
+- [Development](#development)
+  - [Maturity](#maturity)
+  - [Contributions](#contributions)
 
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
+
 ## SDK Installation
 
 > [!TIP]
 > To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
 
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
@@ -83,15 +83,19 @@ yarn add <UNSET>
 
 > [!NOTE]
 > This package is published with CommonJS and ES Modules (ESM) support.
+
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
+
 ## Requirements
 
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+
 <!-- End Requirements [requirements] -->
 
 <!-- Start SDK Example Usage [usage] -->
+
 ## SDK Example Usage
 
 ### Example
@@ -116,11 +120,12 @@ async function run() {
 }
 
 run();
-
 ```
+
 <!-- End SDK Example Usage [usage] -->
 
 <!-- Start Authentication [security] -->
+
 ## Authentication
 
 ### Per-Client Security Schemes
@@ -132,6 +137,7 @@ This SDK supports the following security scheme globally:
 | `bearerAuth` | http | HTTP Bearer |
 
 To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+
 ```typescript
 import { Zavu } from "@zavudev/sdk";
 
@@ -152,11 +158,12 @@ async function run() {
 }
 
 run();
-
 ```
+
 <!-- End Authentication [security] -->
 
 <!-- Start Available Resources and Operations [operations] -->
+
 ## Available Resources and Operations
 
 <details open>
@@ -164,29 +171,30 @@ run();
 
 ### [Zavu SDK](docs/sdks/zavu/README.md)
 
-* [sendMessage](docs/sdks/zavu/README.md#sendmessage) - Send a message
-* [listMessages](docs/sdks/zavu/README.md#listmessages) - List messages
-* [getMessage](docs/sdks/zavu/README.md#getmessage) - Get message by ID
-* [sendReaction](docs/sdks/zavu/README.md#sendreaction) - Send reaction to message
-* [listTemplates](docs/sdks/zavu/README.md#listtemplates) - List templates
-* [createTemplate](docs/sdks/zavu/README.md#createtemplate) - Create template
-* [getTemplate](docs/sdks/zavu/README.md#gettemplate) - Get template
-* [deleteTemplate](docs/sdks/zavu/README.md#deletetemplate) - Delete template
-* [listSenders](docs/sdks/zavu/README.md#listsenders) - List senders
-* [createSender](docs/sdks/zavu/README.md#createsender) - Create sender
-* [getSender](docs/sdks/zavu/README.md#getsender) - Get sender
-* [updateSender](docs/sdks/zavu/README.md#updatesender) - Update sender
-* [deleteSender](docs/sdks/zavu/README.md#deletesender) - Delete sender
-* [listContacts](docs/sdks/zavu/README.md#listcontacts) - List contacts
-* [getContact](docs/sdks/zavu/README.md#getcontact) - Get contact
-* [updateContact](docs/sdks/zavu/README.md#updatecontact) - Update contact
-* [getContactByPhone](docs/sdks/zavu/README.md#getcontactbyphone) - Get contact by phone number
-* [introspectPhone](docs/sdks/zavu/README.md#introspectphone) - Introspect phone number
+- [sendMessage](docs/sdks/zavu/README.md#sendmessage) - Send a message
+- [listMessages](docs/sdks/zavu/README.md#listmessages) - List messages
+- [getMessage](docs/sdks/zavu/README.md#getmessage) - Get message by ID
+- [sendReaction](docs/sdks/zavu/README.md#sendreaction) - Send reaction to message
+- [listTemplates](docs/sdks/zavu/README.md#listtemplates) - List templates
+- [createTemplate](docs/sdks/zavu/README.md#createtemplate) - Create template
+- [getTemplate](docs/sdks/zavu/README.md#gettemplate) - Get template
+- [deleteTemplate](docs/sdks/zavu/README.md#deletetemplate) - Delete template
+- [listSenders](docs/sdks/zavu/README.md#listsenders) - List senders
+- [createSender](docs/sdks/zavu/README.md#createsender) - Create sender
+- [getSender](docs/sdks/zavu/README.md#getsender) - Get sender
+- [updateSender](docs/sdks/zavu/README.md#updatesender) - Update sender
+- [deleteSender](docs/sdks/zavu/README.md#deletesender) - Delete sender
+- [listContacts](docs/sdks/zavu/README.md#listcontacts) - List contacts
+- [getContact](docs/sdks/zavu/README.md#getcontact) - Get contact
+- [updateContact](docs/sdks/zavu/README.md#updatecontact) - Update contact
+- [getContactByPhone](docs/sdks/zavu/README.md#getcontactbyphone) - Get contact by phone number
+- [introspectPhone](docs/sdks/zavu/README.md#introspectphone) - Introspect phone number
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Standalone functions [standalone-funcs] -->
+
 ## Standalone functions
 
 All the methods listed above are available as standalone functions. These
@@ -224,11 +232,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <!-- End Standalone functions [standalone-funcs] -->
 
 <!-- Start Retries [retries] -->
+
 ## Retries
 
-Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
 
 To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+
 ```typescript
 import { Zavu } from "@zavudev/sdk";
 
@@ -237,33 +247,36 @@ const zavu = new Zavu({
 });
 
 async function run() {
-  const result = await zavu.sendMessage({
-    zavuSender: "sender_12345",
-    body: {
-      to: "+56912345678",
-      text: "Your verification code is 123456",
+  const result = await zavu.sendMessage(
+    {
+      zavuSender: "sender_12345",
+      body: {
+        to: "+56912345678",
+        text: "Your verification code is 123456",
+      },
     },
-  }, {
-    retries: {
-      strategy: "backoff",
-      backoff: {
-        initialInterval: 1,
-        maxInterval: 50,
-        exponent: 1.1,
-        maxElapsedTime: 100,
+    {
+      retries: {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1,
+          maxInterval: 50,
+          exponent: 1.1,
+          maxElapsedTime: 100,
+        },
+        retryConnectionErrors: false,
       },
-      retryConnectionErrors: false,
     },
-  });
+  );
 
   console.log(result);
 }
 
 run();
-
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+
 ```typescript
 import { Zavu } from "@zavudev/sdk";
 
@@ -294,11 +307,12 @@ async function run() {
 }
 
 run();
-
 ```
+
 <!-- End Retries [retries] -->
 
 <!-- Start Error Handling [errors] -->
+
 ## Error Handling
 
 [`SDKError`](./src/models/errors/sdkerror.ts) is the base class for all HTTP error responses. It has the following properties:
@@ -313,6 +327,7 @@ run();
 | `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
+
 ```typescript
 import { Zavu } from "@zavudev/sdk";
 import * as errors from "@zavudev/sdk/models/errors";
@@ -351,38 +366,42 @@ async function run() {
 }
 
 run();
-
 ```
 
 ### Error Classes
+
 **Primary errors:**
-* [`SDKError`](./src/models/errors/sdkerror.ts): The base class for HTTP error responses.
-  * [`ErrorT`](./src/models/errors/errort.ts): Generic error.
+
+- [`SDKError`](./src/models/errors/sdkerror.ts): The base class for HTTP error responses.
+  - [`ErrorT`](./src/models/errors/errort.ts): Generic error.
 
 <details><summary>Less common errors (6)</summary>
 
 <br />
 
 **Network errors:**
-* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
-* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
-* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
-* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
-* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
 
+- [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+- [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+- [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+- [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+- [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
 
 **Inherit from [`SDKError`](./src/models/errors/sdkerror.ts)**:
-* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+- [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
+
 ## Server Selection
 
 ### Override Server URL Per-Client
 
 The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+
 ```typescript
 import { Zavu } from "@zavudev/sdk";
 
@@ -404,11 +423,12 @@ async function run() {
 }
 
 run();
-
 ```
+
 <!-- End Server Selection [server] -->
 
 <!-- Start Custom HTTP Client [http-client] -->
+
 ## Custom HTTP Client
 
 The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
@@ -433,12 +453,12 @@ const httpClient = new HTTPClient({
   // fetcher takes a function that has the same signature as native `fetch`.
   fetcher: (request) => {
     return fetch(request);
-  }
+  },
 });
 
 httpClient.addHook("beforeRequest", (request) => {
   const nextRequest = new Request(request, {
-    signal: request.signal || AbortSignal.timeout(5000)
+    signal: request.signal || AbortSignal.timeout(5000),
   });
 
   nextRequest.headers.set("x-custom-header", "custom value");
@@ -455,9 +475,11 @@ httpClient.addHook("requestError", (error, request) => {
 
 const sdk = new Zavu({ httpClient: httpClient });
 ```
+
 <!-- End Custom HTTP Client [http-client] -->
 
 <!-- Start Debugging [debug] -->
+
 ## Debugging
 
 You can setup your SDK to emit debug logs for SDK requests and responses.
@@ -472,6 +494,7 @@ import { Zavu } from "@zavudev/sdk";
 
 const sdk = new Zavu({ debugLogger: console });
 ```
+
 <!-- End Debugging [debug] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->
@@ -486,7 +509,7 @@ looking for the latest version.
 
 ## Contributions
 
-While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
 
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=typescript)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=zavu&utm_campaign=typescript)

package/dist/commonjs/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.2.0";
-    readonly sdkVersion: "0.0.7";
+    readonly sdkVersion: "0.0.9";
     readonly genVersion: "2.768.1";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.7 2.768.1 0.2.0 @zavudev/sdk";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.9 2.768.1 0.2.0 @zavudev/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.2.0",
-    sdkVersion: "0.0.7",
+    sdkVersion: "0.0.9",
     genVersion: "2.768.1",
-    userAgent: "speakeasy-sdk/typescript 0.0.7 2.768.1 0.2.0 @zavudev/sdk",
+    userAgent: "speakeasy-sdk/typescript 0.0.9 2.768.1 0.2.0 @zavudev/sdk",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "0.2.0";
-    readonly sdkVersion: "0.0.7";
+    readonly sdkVersion: "0.0.9";
     readonly genVersion: "2.768.1";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.7 2.768.1 0.2.0 @zavudev/sdk";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.9 2.768.1 0.2.0 @zavudev/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -24,8 +24,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "0.2.0",
-    sdkVersion: "0.0.7",
+    sdkVersion: "0.0.9",
     genVersion: "2.768.1",
-    userAgent: "speakeasy-sdk/typescript 0.0.7 2.768.1 0.2.0 @zavudev/sdk",
+    userAgent: "speakeasy-sdk/typescript 0.0.9 2.768.1 0.2.0 @zavudev/sdk",
 };
 //# sourceMappingURL=config.js.map

package/examples/node_modules/.package-lock.json

@@ -6,7 +6,7 @@
   "packages": {
     "..": {
       "name": "@zavudev/sdk",
-      "version": "0.0.7",
+      "version": "0.0.9",
       "dependencies": {
         "zod": "^3.25.65 || ^4.0.0"
       },

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@zavudev/sdk",
-      "version": "0.0.7",
+      "version": "0.0.9",
       "dependencies": {
         "zod": "^3.25.65 || ^4.0.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@zavudev/sdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zavudev/sdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "author": "Crubing LLC",
   "type": "module",
   "tshy": {

package/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.2.0",
-  sdkVersion: "0.0.7",
+  sdkVersion: "0.0.9",
   genVersion: "2.768.1",
-  userAgent: "speakeasy-sdk/typescript 0.0.7 2.768.1 0.2.0 @zavudev/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.0.9 2.768.1 0.2.0 @zavudev/sdk",
 } as const;