@zapyapi/sdk 1.0.0-beta.1 → 1.0.0-beta.11

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@zapyapi/sdk",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "description": "Official TypeScript SDK for ZapyAPI - WhatsApp API",
-  "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",
   "types": "./src/index.d.ts",

package/src/client.d.ts

@@ -11,7 +11,7 @@ import { InstancesResource } from './resources/instances.resource';
  *
  * @example
  * ```typescript
- * import { ZapyClient, WebhookEventType, isMessageEvent } from '@zapyapi/sdk';
+ * import { ZapyClient, ZapyEventTypes, isTextMessage } from '@zapyapi/sdk';
  *
  * const client = new ZapyClient({
  *   apiKey: 'your-api-key',

package/src/errors.d.ts

@@ -7,7 +7,15 @@ import type { ApiErrorResponse } from './types/common.types';
  * Base error class for all ZapyAPI errors
  */
 export declare class ZapyError extends Error {
-    constructor(message: string);
+    /**
+     * Original error that caused this error (if any)
+     */
+    readonly cause?: Error;
+    constructor(message: string, cause?: Error);
+    /**
+     * Get a detailed string representation of the error
+     */
+    toDetailedString(): string;
 }
 /**
  * Error thrown when the API returns an error response
@@ -29,11 +37,38 @@ export declare class ZapyApiError extends ZapyError {
      * Additional error details
      */
     readonly details?: Record<string, unknown>;
-    constructor(message: string, statusCode: number, code: string, requestId?: string, details?: Record<string, unknown>);
+    /**
+     * HTTP method used in the request
+     */
+    readonly method?: string;
+    /**
+     * URL that was requested
+     */
+    readonly url?: string;
+    /**
+     * Raw response body (for debugging)
+     */
+    readonly responseBody?: unknown;
+    constructor(message: string, statusCode: number, code: string, options?: {
+        requestId?: string;
+        details?: Record<string, unknown>;
+        method?: string;
+        url?: string;
+        responseBody?: unknown;
+        cause?: Error;
+    });
     /**
      * Create a ZapyApiError from an Axios error
      */
     static fromAxiosError(error: AxiosError<ApiErrorResponse>): ZapyApiError;
+    /**
+     * Get a detailed string representation for logging
+     */
+    toDetailedString(): string;
+    /**
+     * Convert to a plain object for logging/serialization
+     */
+    toJSON(): Record<string, unknown>;
 }
 /**
  * Error thrown when input validation fails
@@ -44,18 +79,30 @@ export declare class ValidationError extends ZapyError {
      */
     readonly details: Record<string, string[]>;
     constructor(message: string, details: Record<string, string[]>);
+    toDetailedString(): string;
+    toJSON(): Record<string, unknown>;
 }
 /**
  * Error thrown when an instance is not found
  */
 export declare class InstanceNotFoundError extends ZapyApiError {
-    constructor(instanceId: string, requestId?: string);
+    readonly instanceId: string;
+    constructor(instanceId: string, options?: {
+        requestId?: string;
+        method?: string;
+        url?: string;
+    });
 }
 /**
  * Error thrown when authentication fails
  */
 export declare class AuthenticationError extends ZapyApiError {
-    constructor(message?: string, requestId?: string);
+    constructor(message?: string, options?: {
+        requestId?: string;
+        method?: string;
+        url?: string;
+        cause?: Error;
+    });
 }
 /**
  * Error thrown when rate limit is exceeded
@@ -65,6 +112,55 @@ export declare class RateLimitError extends ZapyApiError {
      * Timestamp when the rate limit resets (Unix ms)
      */
     readonly retryAfter?: number;
-    constructor(message?: string, retryAfter?: number, requestId?: string);
+    constructor(message?: string, retryAfter?: number, options?: {
+        requestId?: string;
+        method?: string;
+        url?: string;
+        cause?: Error;
+    });
+    /**
+     * Get the Date when the rate limit resets
+     */
+    getRetryAfterDate(): Date | undefined;
+}
+/**
+ * Error thrown when a network error occurs (no response received)
+ */
+export declare class NetworkError extends ZapyError {
+    /**
+     * HTTP method used in the request
+     */
+    readonly method?: string;
+    /**
+     * URL that was requested
+     */
+    readonly url?: string;
+    /**
+     * Error code (e.g., ECONNREFUSED, ETIMEDOUT)
+     */
+    readonly code?: string;
+    constructor(message: string, options?: {
+        method?: string;
+        url?: string;
+        code?: string;
+        cause?: Error;
+    });
+    toDetailedString(): string;
+    toJSON(): Record<string, unknown>;
+}
+/**
+ * Error thrown when request times out
+ */
+export declare class TimeoutError extends NetworkError {
+    /**
+     * Timeout duration in milliseconds
+     */
+    readonly timeout?: number;
+    constructor(message?: string, options?: {
+        timeout?: number;
+        method?: string;
+        url?: string;
+        cause?: Error;
+    });
 }
 //# sourceMappingURL=errors.d.ts.map

package/src/errors.d.ts.map

@@ -1 +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"}
+{"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;IAClC;;OAEG;IACH,SAAyB,KAAK,CAAC,EAAE,KAAK,CAAC;gBAE3B,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAM1C;;OAEG;IACH,gBAAgB,IAAI,MAAM;CAU3B;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;IAElD;;OAEG;IACH,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAgB,GAAG,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,YAAY,CAAC,EAAE,OAAO,CAAC;gBAGrC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;IAcH;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,gBAAgB,CAAC,GAAG,YAAY;IAmDxE;;OAEG;IACM,gBAAgB,IAAI,MAAM;IAiCnC;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAclC;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;IAOrD,gBAAgB,IAAI,MAAM;IAOnC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAOlC;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,SAAgB,UAAU,EAAE,MAAM,CAAC;gBAEvB,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE;CAchG;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;gBACvC,OAAO,SAA+B,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAKnI;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;OAEG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;gBAGlC,OAAO,SAAwB,EAC/B,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;IAWhF;;OAEG;IACH,iBAAiB,IAAI,IAAI,GAAG,SAAS;CAGtC;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,SAAS;IACzC;;OAEG;IACH,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAgB,GAAG,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAG5B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;IAUlE,gBAAgB,IAAI,MAAM;IAkBnC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAUlC;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC;gBAG/B,OAAO,SAAsB,EAC7B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE;CAO/E"}