@zyphr-dev/node-sdk 0.1.25 → 0.1.26

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyphr-dev/node-sdk",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "description": "Official Zyphr SDK for Node.js, React, and React Native",
   "type": "module",
   "main": "./dist/index.cjs",

package/src/.openapi-generator/FILES

@@ -194,6 +194,9 @@ src/models/PaginationMeta.ts
 src/models/PasswordRequirements.ts
 src/models/PasswordRequirementsResponse.ts
 src/models/PasswordRequirementsResponseData.ts
+src/models/PayloadTooLargeError.ts
+src/models/PayloadTooLargeErrorError.ts
+src/models/PayloadTooLargeErrorErrorDetails.ts
 src/models/PhoneAuthAvailabilityResponse.ts
 src/models/PhoneAuthAvailabilityResponseData.ts
 src/models/PhoneLoginVerifyRequest.ts

package/src/errors.ts

@@ -82,6 +82,35 @@ export class ZyphrNotFoundError extends ZyphrError {
   }
 }
 
+/**
+ * Thrown when the API returns a 413 payload-too-large error because the
+ * request body exceeds the maximum allowed size (currently 10 MB).
+ *
+ * Use `limitBytes` to read the server-side cap and `receivedBytes` to read
+ * the size of the rejected payload, both surfaced from `details` so callers
+ * don't have to reach into the untyped error body.
+ *
+ * @see https://zyphr.dev/resources/api-limits
+ */
+export class ZyphrPayloadTooLargeError extends ZyphrError {
+  constructor(message: string, details?: Record<string, unknown>, requestId?: string) {
+    super({ message, status: 413, code: 'payload_too_large', details, requestId });
+    this.name = 'ZyphrPayloadTooLargeError';
+  }
+
+  /** Maximum allowed request body size in bytes (server-enforced). */
+  get limitBytes(): number | undefined {
+    const value = this.details?.limit_bytes;
+    return typeof value === 'number' ? value : undefined;
+  }
+
+  /** Size of the rejected request body in bytes, as measured by the server. */
+  get receivedBytes(): number | undefined {
+    const value = this.details?.received_bytes;
+    return typeof value === 'number' ? value : undefined;
+  }
+}
+
 /**
  * Thrown when a Zyphr webhook signature fails verification.
  *
@@ -129,6 +158,8 @@ export async function parseErrorResponse(response: Response): Promise<ZyphrError
       return new ZyphrAuthenticationError(message);
     case 404:
       return new ZyphrNotFoundError(message);
+    case 413:
+      return new ZyphrPayloadTooLargeError(message, details, requestId);
     case 429: {
       const retryAfterHeader = response.headers.get('Retry-After');
       const retryAfter = retryAfterHeader ? parseInt(retryAfterHeader, 10) : undefined;

package/src/src/apis/AuthEmailTemplatesApi.ts

@@ -28,6 +28,7 @@ import type {
   AuthEmailType,
   BulkUpsertAuthEmailTemplatesRequest,
   BulkUpsertAuthEmailTemplatesResponse,
+  PayloadTooLargeError,
   UpsertAuthEmailTemplateRequest,
 } from '../models/index';
 import {
@@ -57,6 +58,8 @@ import {
     BulkUpsertAuthEmailTemplatesRequestToJSON,
     BulkUpsertAuthEmailTemplatesResponseFromJSON,
     BulkUpsertAuthEmailTemplatesResponseToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     UpsertAuthEmailTemplateRequestFromJSON,
     UpsertAuthEmailTemplateRequestToJSON,
 } from '../models/index';

package/src/src/apis/EmailsApi.ts

@@ -20,6 +20,7 @@ import type {
   EmailListResponse,
   EmailResponse,
   EmailTrackingResponse,
+  PayloadTooLargeError,
   SendBatchEmailRequest,
   SendBatchEmailResponse,
   SendEmailRequest,
@@ -36,6 +37,8 @@ import {
     EmailResponseToJSON,
     EmailTrackingResponseFromJSON,
     EmailTrackingResponseToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     SendBatchEmailRequestFromJSON,
     SendBatchEmailRequestToJSON,
     SendBatchEmailResponseFromJSON,

package/src/src/apis/InboxApi.ts

@@ -24,6 +24,7 @@ import type {
   MarkAllReadResponse,
   MarkAllSubscriberNotificationsReadRequest,
   MarkInboxReadRequest,
+  PayloadTooLargeError,
   SendBatchInAppRequest,
   SendBatchInAppResponse,
   SendInAppRequest,
@@ -50,6 +51,8 @@ import {
     MarkAllSubscriberNotificationsReadRequestToJSON,
     MarkInboxReadRequestFromJSON,
     MarkInboxReadRequestToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     SendBatchInAppRequestFromJSON,
     SendBatchInAppRequestToJSON,
     SendBatchInAppResponseFromJSON,

package/src/src/apis/PushApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   ApiError,
   DevicePushTopicListResponse,
+  PayloadTooLargeError,
   PushDetailResponse,
   PushListResponse,
   PushStatsResponse,
@@ -34,6 +35,8 @@ import {
     ApiErrorToJSON,
     DevicePushTopicListResponseFromJSON,
     DevicePushTopicListResponseToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     PushDetailResponseFromJSON,
     PushDetailResponseToJSON,
     PushListResponseFromJSON,

package/src/src/apis/SMSApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  PayloadTooLargeError,
   SendBatchSmsRequest,
   SendBatchSmsResponse,
   SendSmsRequest,
@@ -32,6 +33,8 @@ import type {
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     SendBatchSmsRequestFromJSON,
     SendBatchSmsRequestToJSON,
     SendBatchSmsResponseFromJSON,

package/src/src/apis/TemplatesApi.ts

@@ -18,6 +18,7 @@ import type {
   ApiError,
   CreateTemplateRequest,
   DeleteResult,
+  PayloadTooLargeError,
   RenderTemplateRequest,
   TemplateListResponse,
   TemplateRenderResponse,
@@ -31,6 +32,8 @@ import {
     CreateTemplateRequestToJSON,
     DeleteResultFromJSON,
     DeleteResultToJSON,
+    PayloadTooLargeErrorFromJSON,
+    PayloadTooLargeErrorToJSON,
     RenderTemplateRequestFromJSON,
     RenderTemplateRequestToJSON,
     TemplateListResponseFromJSON,

package/src/src/models/PayloadTooLargeError.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { PayloadTooLargeErrorError } from './PayloadTooLargeErrorError';
+import {
+    PayloadTooLargeErrorErrorFromJSON,
+    PayloadTooLargeErrorErrorFromJSONTyped,
+    PayloadTooLargeErrorErrorToJSON,
+    PayloadTooLargeErrorErrorToJSONTyped,
+} from './PayloadTooLargeErrorError';
+import type { RequestMeta } from './RequestMeta';
+import {
+    RequestMetaFromJSON,
+    RequestMetaFromJSONTyped,
+    RequestMetaToJSON,
+    RequestMetaToJSONTyped,
+} from './RequestMeta';
+
+/**
+ * 
+ * @export
+ * @interface PayloadTooLargeError
+ */
+export interface PayloadTooLargeError {
+    /**
+     * 
+     * @type {PayloadTooLargeErrorError}
+     * @memberof PayloadTooLargeError
+     */
+    error: PayloadTooLargeErrorError;
+    /**
+     * 
+     * @type {RequestMeta}
+     * @memberof PayloadTooLargeError
+     */
+    meta?: RequestMeta;
+}
+
+/**
+ * Check if a given object implements the PayloadTooLargeError interface.
+ */
+export function instanceOfPayloadTooLargeError(value: object): value is PayloadTooLargeError {
+    if (!('error' in value) || value['error'] === undefined) return false;
+    return true;
+}
+
+export function PayloadTooLargeErrorFromJSON(json: any): PayloadTooLargeError {
+    return PayloadTooLargeErrorFromJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): PayloadTooLargeError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': PayloadTooLargeErrorErrorFromJSON(json['error']),
+        'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
+    };
+}
+
+export function PayloadTooLargeErrorToJSON(json: any): PayloadTooLargeError {
+    return PayloadTooLargeErrorToJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorToJSONTyped(value?: PayloadTooLargeError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': PayloadTooLargeErrorErrorToJSON(value['error']),
+        'meta': RequestMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/PayloadTooLargeErrorError.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { PayloadTooLargeErrorErrorDetails } from './PayloadTooLargeErrorErrorDetails';
+import {
+    PayloadTooLargeErrorErrorDetailsFromJSON,
+    PayloadTooLargeErrorErrorDetailsFromJSONTyped,
+    PayloadTooLargeErrorErrorDetailsToJSON,
+    PayloadTooLargeErrorErrorDetailsToJSONTyped,
+} from './PayloadTooLargeErrorErrorDetails';
+
+/**
+ * 
+ * @export
+ * @interface PayloadTooLargeErrorError
+ */
+export interface PayloadTooLargeErrorError {
+    /**
+     * 
+     * @type {string}
+     * @memberof PayloadTooLargeErrorError
+     */
+    code: PayloadTooLargeErrorErrorCodeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PayloadTooLargeErrorError
+     */
+    message: string;
+    /**
+     * 
+     * @type {PayloadTooLargeErrorErrorDetails}
+     * @memberof PayloadTooLargeErrorError
+     */
+    details?: PayloadTooLargeErrorErrorDetails;
+}
+
+
+/**
+ * @export
+ */
+export const PayloadTooLargeErrorErrorCodeEnum = {
+    PAYLOAD_TOO_LARGE: 'payload_too_large'
+} as const;
+export type PayloadTooLargeErrorErrorCodeEnum = typeof PayloadTooLargeErrorErrorCodeEnum[keyof typeof PayloadTooLargeErrorErrorCodeEnum];
+
+
+/**
+ * Check if a given object implements the PayloadTooLargeErrorError interface.
+ */
+export function instanceOfPayloadTooLargeErrorError(value: object): value is PayloadTooLargeErrorError {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function PayloadTooLargeErrorErrorFromJSON(json: any): PayloadTooLargeErrorError {
+    return PayloadTooLargeErrorErrorFromJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): PayloadTooLargeErrorError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+        'details': json['details'] == null ? undefined : PayloadTooLargeErrorErrorDetailsFromJSON(json['details']),
+    };
+}
+
+export function PayloadTooLargeErrorErrorToJSON(json: any): PayloadTooLargeErrorError {
+    return PayloadTooLargeErrorErrorToJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorErrorToJSONTyped(value?: PayloadTooLargeErrorError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'details': PayloadTooLargeErrorErrorDetailsToJSON(value['details']),
+    };
+}
+

package/src/src/models/PayloadTooLargeErrorErrorDetails.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PayloadTooLargeErrorErrorDetails
+ */
+export interface PayloadTooLargeErrorErrorDetails {
+    /**
+     * Maximum allowed request body size in bytes.
+     * @type {number}
+     * @memberof PayloadTooLargeErrorErrorDetails
+     */
+    limitBytes?: number;
+    /**
+     * Size of the rejected request body in bytes.
+     * @type {number}
+     * @memberof PayloadTooLargeErrorErrorDetails
+     */
+    receivedBytes?: number;
+}
+
+/**
+ * Check if a given object implements the PayloadTooLargeErrorErrorDetails interface.
+ */
+export function instanceOfPayloadTooLargeErrorErrorDetails(value: object): value is PayloadTooLargeErrorErrorDetails {
+    return true;
+}
+
+export function PayloadTooLargeErrorErrorDetailsFromJSON(json: any): PayloadTooLargeErrorErrorDetails {
+    return PayloadTooLargeErrorErrorDetailsFromJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorErrorDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PayloadTooLargeErrorErrorDetails {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'limitBytes': json['limit_bytes'] == null ? undefined : json['limit_bytes'],
+        'receivedBytes': json['received_bytes'] == null ? undefined : json['received_bytes'],
+    };
+}
+
+export function PayloadTooLargeErrorErrorDetailsToJSON(json: any): PayloadTooLargeErrorErrorDetails {
+    return PayloadTooLargeErrorErrorDetailsToJSONTyped(json, false);
+}
+
+export function PayloadTooLargeErrorErrorDetailsToJSONTyped(value?: PayloadTooLargeErrorErrorDetails | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'limit_bytes': value['limitBytes'],
+        'received_bytes': value['receivedBytes'],
+    };
+}
+

package/src/src/models/index.ts

@@ -160,6 +160,9 @@ export * from './PaginationMeta';
 export * from './PasswordRequirements';
 export * from './PasswordRequirementsResponse';
 export * from './PasswordRequirementsResponseData';
+export * from './PayloadTooLargeError';
+export * from './PayloadTooLargeErrorError';
+export * from './PayloadTooLargeErrorErrorDetails';
 export * from './PhoneAuthAvailabilityResponse';
 export * from './PhoneAuthAvailabilityResponseData';
 export * from './PhoneLoginVerifyRequest';