@zyphr-dev/node-sdk 0.1.60 → 0.1.61

package/package.json

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

package/src/.openapi-generator/FILES

@@ -476,6 +476,7 @@ src/models/VerifySmsConfigResponse.ts
 src/models/WaaSApplication.ts
 src/models/WaaSBatchPublishRequest.ts
 src/models/WaaSBatchPublishResponse.ts
+src/models/WaaSBatchPublishResult.ts
 src/models/WaaSDelivery.ts
 src/models/WaaSEndpoint.ts
 src/models/WaaSEventType.ts

package/src/src/models/WaaSBatchPublishResponse.ts

@@ -13,18 +13,32 @@
  */
 
 import { mapValues } from '../runtime';
+import type { WaaSBatchPublishResult } from './WaaSBatchPublishResult';
+import {
+    WaaSBatchPublishResultFromJSON,
+    WaaSBatchPublishResultFromJSONTyped,
+    WaaSBatchPublishResultToJSON,
+    WaaSBatchPublishResultToJSONTyped,
+} from './WaaSBatchPublishResult';
+
 /**
  * 
  * @export
  * @interface WaaSBatchPublishResponse
  */
 export interface WaaSBatchPublishResponse {
+    /**
+     * Events in the request
+     * @type {number}
+     * @memberof WaaSBatchPublishResponse
+     */
+    total?: number;
     /**
      * 
      * @type {number}
      * @memberof WaaSBatchPublishResponse
      */
-    published?: number;
+    succeeded?: number;
     /**
      * 
      * @type {number}
@@ -32,11 +46,11 @@ export interface WaaSBatchPublishResponse {
      */
     failed?: number;
     /**
-     * 
-     * @type {Array<object>}
+     * One entry per event, in request order. A published event has the same fields as a single publish (`event_id`, `endpoints_matched`, `deliveries_created`, `created_at`, ...). An event that was not published has `error` and `code` instead, e.g. `code: usage_limit_exceeded` when the monthly event limit is reached. Tell them apart by the presence of `error`.
+     * @type {Array<WaaSBatchPublishResult>}
      * @memberof WaaSBatchPublishResponse
      */
-    results?: Array<object>;
+    results?: Array<WaaSBatchPublishResult>;
 }
 
 /**
@@ -56,9 +70,10 @@ export function WaaSBatchPublishResponseFromJSONTyped(json: any, ignoreDiscrimin
     }
     return {
         
-        'published': json['published'] == null ? undefined : json['published'],
+        'total': json['total'] == null ? undefined : json['total'],
+        'succeeded': json['succeeded'] == null ? undefined : json['succeeded'],
         'failed': json['failed'] == null ? undefined : json['failed'],
-        'results': json['results'] == null ? undefined : json['results'],
+        'results': json['results'] == null ? undefined : ((json['results'] as Array<any>).map(WaaSBatchPublishResultFromJSON)),
     };
 }
 
@@ -73,9 +88,10 @@ export function WaaSBatchPublishResponseToJSONTyped(value?: WaaSBatchPublishResp
 
     return {
         
-        'published': value['published'],
+        'total': value['total'],
+        'succeeded': value['succeeded'],
         'failed': value['failed'],
-        'results': value['results'],
+        'results': value['results'] == null ? undefined : ((value['results'] as Array<any>).map(WaaSBatchPublishResultToJSON)),
     };
 }
 

package/src/src/models/WaaSBatchPublishResult.ts

@@ -0,0 +1,129 @@
+/* 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.  > **Test keys are being retired.** `zy_test_*` keys are no longer issued, and existing ones stop working on **21 October 2026**. They never delivered mail — sends were mocked and marked sent without reaching a provider, so they could not verify domain authentication, rendering, or deliverability. To test your integration, use a `zy_live_*` key against a verified domain and send to an address you control.  ## 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  ## Account Sending Status  Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## 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 WaaSBatchPublishResult
+ */
+export interface WaaSBatchPublishResult {
+    /**
+     * Set when the event was published
+     * @type {string}
+     * @memberof WaaSBatchPublishResult
+     */
+    eventId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSBatchPublishResult
+     */
+    eventType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaaSBatchPublishResult
+     */
+    tenantId?: string;
+    /**
+     * Set when the event was published
+     * @type {number}
+     * @memberof WaaSBatchPublishResult
+     */
+    endpointsMatched?: number;
+    /**
+     * Set when the event was published
+     * @type {number}
+     * @memberof WaaSBatchPublishResult
+     */
+    deliveriesCreated?: number;
+    /**
+     * Set when the event was published
+     * @type {Date}
+     * @memberof WaaSBatchPublishResult
+     */
+    createdAt?: Date;
+    /**
+     * True when the idempotency key matched an earlier publish
+     * @type {boolean}
+     * @memberof WaaSBatchPublishResult
+     */
+    deduplicated?: boolean;
+    /**
+     * Set when the event was not published
+     * @type {string}
+     * @memberof WaaSBatchPublishResult
+     */
+    error?: string;
+    /**
+     * Set when the event was not published, e.g. `usage_limit_exceeded` (monthly event limit reached), `event_type_not_found`, `event_type_deprecated`, `internal_error`
+     * @type {string}
+     * @memberof WaaSBatchPublishResult
+     */
+    code?: string;
+}
+
+/**
+ * Check if a given object implements the WaaSBatchPublishResult interface.
+ */
+export function instanceOfWaaSBatchPublishResult(value: object): value is WaaSBatchPublishResult {
+    return true;
+}
+
+export function WaaSBatchPublishResultFromJSON(json: any): WaaSBatchPublishResult {
+    return WaaSBatchPublishResultFromJSONTyped(json, false);
+}
+
+export function WaaSBatchPublishResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaaSBatchPublishResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'eventId': json['event_id'] == null ? undefined : json['event_id'],
+        'eventType': json['event_type'] == null ? undefined : json['event_type'],
+        'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
+        'endpointsMatched': json['endpoints_matched'] == null ? undefined : json['endpoints_matched'],
+        'deliveriesCreated': json['deliveries_created'] == null ? undefined : json['deliveries_created'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'deduplicated': json['deduplicated'] == null ? undefined : json['deduplicated'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'code': json['code'] == null ? undefined : json['code'],
+    };
+}
+
+export function WaaSBatchPublishResultToJSON(json: any): WaaSBatchPublishResult {
+    return WaaSBatchPublishResultToJSONTyped(json, false);
+}
+
+export function WaaSBatchPublishResultToJSONTyped(value?: WaaSBatchPublishResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'event_id': value['eventId'],
+        'event_type': value['eventType'],
+        'tenant_id': value['tenantId'],
+        'endpoints_matched': value['endpointsMatched'],
+        'deliveries_created': value['deliveriesCreated'],
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'deduplicated': value['deduplicated'],
+        'error': value['error'],
+        'code': value['code'],
+    };
+}
+

package/src/src/models/WaaSPublishEventResponse.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface WaaSPublishEventResponse {
     /**
-     * 
+     * Prefixed id, not a bare UUID
      * @type {string}
      * @memberof WaaSPublishEventResponse
      */
@@ -49,6 +49,18 @@ export interface WaaSPublishEventResponse {
      * @memberof WaaSPublishEventResponse
      */
     deliveriesCreated?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WaaSPublishEventResponse
+     */
+    createdAt?: Date;
+    /**
+     * Present and true when the idempotency key matched an earlier publish, which is returned instead of publishing again
+     * @type {boolean}
+     * @memberof WaaSPublishEventResponse
+     */
+    deduplicated?: boolean;
 }
 
 /**
@@ -73,6 +85,8 @@ export function WaaSPublishEventResponseFromJSONTyped(json: any, ignoreDiscrimin
         'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
         'endpointsMatched': json['endpoints_matched'] == null ? undefined : json['endpoints_matched'],
         'deliveriesCreated': json['deliveries_created'] == null ? undefined : json['deliveries_created'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'deduplicated': json['deduplicated'] == null ? undefined : json['deduplicated'],
     };
 }
 
@@ -92,6 +106,8 @@ export function WaaSPublishEventResponseToJSONTyped(value?: WaaSPublishEventResp
         'tenant_id': value['tenantId'],
         'endpoints_matched': value['endpointsMatched'],
         'deliveries_created': value['deliveriesCreated'],
+        'created_at': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'deduplicated': value['deduplicated'],
     };
 }
 

package/src/src/models/index.ts

@@ -435,6 +435,7 @@ export * from './VerifySmsConfigResponse';
 export * from './WaaSApplication';
 export * from './WaaSBatchPublishRequest';
 export * from './WaaSBatchPublishResponse';
+export * from './WaaSBatchPublishResult';
 export * from './WaaSDelivery';
 export * from './WaaSEndpoint';
 export * from './WaaSEventType';