@zapyapi/sdk 1.0.0-beta.1

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@zapyapi/sdk",
+  "version": "1.0.0-beta.1",
+  "description": "Official TypeScript SDK for ZapyAPI - WhatsApp API",
+  "type": "module",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.cjs",
+    "src",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "whatsapp",
+    "whatsapp-api",
+    "zapyapi",
+    "messaging",
+    "sdk",
+    "typescript"
+  ],
+  "author": "ZapyAPI <contato@zapyapi.com>",
+  "license": "MIT",
+  "homepage": "https://zapyapi.com",
+  "scripts": {
+    "generate": "node scripts/generate-api.mjs",
+    "generate:prod": "OPENAPI_URL=https://api.zapyapi.com/swagger-json node scripts/generate-api.mjs",
+    "generate:local": "OPENAPI_URL=http://localhost:3001/swagger-json node scripts/generate-api.mjs"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "axios": "^1.11.0",
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "swagger-typescript-api": "^13.0.0"
+  }
+}

package/src/client.d.ts

@@ -0,0 +1,98 @@
+/**
+ * ZapyClient - Main entry point for the ZapyAPI SDK
+ */
+import { type AxiosInstance } from 'axios';
+import type { ZapyClientOptions } from './types';
+import { MessagesResource } from './resources/messages.resource';
+import { WebhooksResource } from './resources/webhooks.resource';
+import { InstancesResource } from './resources/instances.resource';
+/**
+ * ZapyClient - Official TypeScript SDK for ZapyAPI
+ *
+ * @example
+ * ```typescript
+ * import { ZapyClient, WebhookEventType, isMessageEvent } from '@zapyapi/sdk';
+ *
+ * const client = new ZapyClient({
+ *   apiKey: 'your-api-key',
+ * });
+ *
+ * // Send a text message
+ * await client.messages.sendText('my-instance', {
+ *   to: '5511999999999',
+ *   text: 'Hello from ZapyAPI SDK!'
+ * });
+ *
+ * // List instances
+ * const instances = await client.instances.list();
+ *
+ * // Get QR code for an instance
+ * const qr = await client.instances.getQRCode('my-instance');
+ *
+ * // Configure webhooks programmatically
+ * await client.webhooks.configure({
+ *   url: 'https://your-server.com/webhook',
+ *   secret: 'your-secret-key-min-16-chars',
+ *   isActive: true,
+ * });
+ * ```
+ */
+export declare class ZapyClient {
+    /**
+     * Internal Axios HTTP client
+     */
+    private readonly http;
+    /**
+     * Instance management operations
+     */
+    readonly instances: InstancesResource;
+    /**
+     * Message sending and management operations
+     */
+    readonly messages: MessagesResource;
+    /**
+     * Webhook configuration and management operations
+     *
+     * Webhooks are configured at the user level - one webhook URL receives
+     * events from ALL your instances. Each payload includes `instanceId`.
+     */
+    readonly webhooks: WebhooksResource;
+    /**
+     * Create a new ZapyClient instance
+     *
+     * @param options - Client configuration options
+     *
+     * @example
+     * const client = new ZapyClient({
+     *   apiKey: 'your-api-key',
+     *   baseUrl: 'https://api.zapyapi.com/api', // optional
+     *   timeout: 30000, // optional, in milliseconds
+     * });
+     */
+    constructor(options: ZapyClientOptions);
+    /**
+     * Get the underlying Axios instance for advanced usage
+     *
+     * @returns The configured Axios instance
+     *
+     * @example
+     * const httpClient = client.getHttpClient();
+     * httpClient.interceptors.response.use(/* ... *\/);
+     */
+    getHttpClient(): AxiosInstance;
+}
+/**
+ * Create a new ZapyClient instance
+ *
+ * @param options - Client configuration options
+ * @returns A configured ZapyClient instance
+ *
+ * @example
+ * import { createClient } from '@zapyapi/sdk';
+ *
+ * const client = createClient({
+ *   apiKey: 'your-api-key',
+ * });
+ */
+export declare function createClient(options: ZapyClientOptions): ZapyClient;
+//# sourceMappingURL=client.d.ts.map

package/src/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../libs/sdk/src/client.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgB;IAErC;;OAEG;IACH,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAE7C;;OAEG;IACH,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C;;;;;OAKG;IACH,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C;;;;;;;;;;;OAWG;gBACS,OAAO,EAAE,iBAAiB;IAsBtC;;;;;;;;OAQG;IACH,aAAa,IAAI,aAAa;CAG/B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CAEnE"}

package/src/errors.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Custom error classes for @zapyapi/sdk
+ */
+import type { AxiosError } from 'axios';
+import type { ApiErrorResponse } from './types/common.types';
+/**
+ * Base error class for all ZapyAPI errors
+ */
+export declare class ZapyError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error thrown when the API returns an error response
+ */
+export declare class ZapyApiError extends ZapyError {
+    /**
+     * HTTP status code
+     */
+    readonly statusCode: number;
+    /**
+     * Error code from the API
+     */
+    readonly code: string;
+    /**
+     * Request ID for debugging (if available)
+     */
+    readonly requestId?: string;
+    /**
+     * Additional error details
+     */
+    readonly details?: Record<string, unknown>;
+    constructor(message: string, statusCode: number, code: string, requestId?: string, details?: Record<string, unknown>);
+    /**
+     * Create a ZapyApiError from an Axios error
+     */
+    static fromAxiosError(error: AxiosError<ApiErrorResponse>): ZapyApiError;
+}
+/**
+ * Error thrown when input validation fails
+ */
+export declare class ValidationError extends ZapyError {
+    /**
+     * Validation error details by field
+     */
+    readonly details: Record<string, string[]>;
+    constructor(message: string, details: Record<string, string[]>);
+}
+/**
+ * Error thrown when an instance is not found
+ */
+export declare class InstanceNotFoundError extends ZapyApiError {
+    constructor(instanceId: string, requestId?: string);
+}
+/**
+ * Error thrown when authentication fails
+ */
+export declare class AuthenticationError extends ZapyApiError {
+    constructor(message?: string, requestId?: string);
+}
+/**
+ * Error thrown when rate limit is exceeded
+ */
+export declare class RateLimitError extends ZapyApiError {
+    /**
+     * Timestamp when the rate limit resets (Unix ms)
+     */
+    readonly retryAfter?: number;
+    constructor(message?: string, retryAfter?: number, requestId?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../libs/sdk/src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAExC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;gBACtB,OAAO,EAAE,MAAM;CAK5B;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,SAAS;IACzC;;OAEG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAGhD,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAWnC;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,YAAY;CAsBzE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;gBAEtC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;CAM/D;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;gBACzC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CAWnD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;gBACvC,OAAO,SAA+B,EAAE,SAAS,CAAC,EAAE,MAAM;CAKvE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;OAEG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;gBAExB,OAAO,SAAwB,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CAMrF"}