@zyphr-dev/node-sdk 0.1.4 → 0.1.6

package/src/src/models/SendPushRequest.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { PushPayload } from './PushPayload';
+import type { SendPushRequestActionButtonsInner } from './SendPushRequestActionButtonsInner';
 import {
-    PushPayloadFromJSON,
-    PushPayloadFromJSONTyped,
-    PushPayloadToJSON,
-    PushPayloadToJSONTyped,
-} from './PushPayload';
+    SendPushRequestActionButtonsInnerFromJSON,
+    SendPushRequestActionButtonsInnerFromJSONTyped,
+    SendPushRequestActionButtonsInnerToJSON,
+    SendPushRequestActionButtonsInnerToJSONTyped,
+} from './SendPushRequestActionButtonsInner';
 
 /**
  * 
@@ -28,47 +28,77 @@ import {
  */
 export interface SendPushRequest {
     /**
-     * Send to specific device
+     * Send to all devices for a user
+     * @type {string}
+     * @memberof SendPushRequest
+     */
+    userId?: string;
+    /**
+     * Send to a specific device
      * @type {string}
      * @memberof SendPushRequest
      */
     deviceId?: string;
     /**
-     * Send to multiple devices
-     * @type {Array<string>}
+     * Push notification title
+     * @type {string}
      * @memberof SendPushRequest
      */
-    deviceIds?: Array<string>;
+    title?: string;
     /**
-     * Send to all subscriber devices
+     * Push notification body text
      * @type {string}
      * @memberof SendPushRequest
      */
-    subscriberId?: string;
+    body?: string;
     /**
-     * Send to topic subscribers
+     * Custom data payload
+     * @type {{ [key: string]: any; }}
+     * @memberof SendPushRequest
+     */
+    data?: { [key: string]: any; };
+    /**
+     * Badge count (iOS)
+     * @type {number}
+     * @memberof SendPushRequest
+     */
+    badge?: number;
+    /**
+     * Notification sound
      * @type {string}
      * @memberof SendPushRequest
      */
-    topic?: string;
+    sound?: string;
     /**
-     * 
-     * @type {PushPayload}
+     * Image URL for rich notifications
+     * @type {string}
+     * @memberof SendPushRequest
+     */
+    imageUrl?: string;
+    /**
+     * Silent/background push notification
+     * @type {boolean}
+     * @memberof SendPushRequest
+     */
+    contentAvailable?: boolean;
+    /**
+     * Interactive notification buttons (max 3)
+     * @type {Array<SendPushRequestActionButtonsInner>}
      * @memberof SendPushRequest
      */
-    payload: PushPayload;
+    actionButtons?: Array<SendPushRequestActionButtonsInner>;
     /**
      * 
-     * @type {string}
+     * @type {Array<string>}
      * @memberof SendPushRequest
      */
-    priority?: SendPushRequestPriorityEnum;
+    tags?: Array<string>;
     /**
-     * Time-to-live in seconds
-     * @type {number}
+     * 
+     * @type {{ [key: string]: any; }}
      * @memberof SendPushRequest
      */
-    ttl?: number;
+    metadata?: { [key: string]: any; };
     /**
      * Replace previous notification with same key
      * @type {string}
@@ -76,31 +106,47 @@ export interface SendPushRequest {
      */
     collapseKey?: string;
     /**
-     * 
+     * Subscriber ID for preference checking
+     * @type {string}
+     * @memberof SendPushRequest
+     */
+    subscriberId?: string;
+    /**
+     * Subscriber external ID for preference checking
+     * @type {string}
+     * @memberof SendPushRequest
+     */
+    subscriberExternalId?: string;
+    /**
+     * Notification category for preference checking
+     * @type {string}
+     * @memberof SendPushRequest
+     */
+    category?: string;
+    /**
+     * Skip subscriber preference checks
+     * @type {boolean}
+     * @memberof SendPushRequest
+     */
+    force?: boolean;
+    /**
+     * Schedule for future delivery (ISO 8601)
      * @type {Date}
      * @memberof SendPushRequest
      */
-    scheduledAt?: Date;
+    sendAt?: Date;
+    /**
+     * Delay in seconds before sending
+     * @type {number}
+     * @memberof SendPushRequest
+     */
+    delay?: number;
 }
 
-
-/**
- * @export
- */
-export const SendPushRequestPriorityEnum = {
-    LOW: 'low',
-    NORMAL: 'normal',
-    HIGH: 'high',
-    URGENT: 'urgent'
-} as const;
-export type SendPushRequestPriorityEnum = typeof SendPushRequestPriorityEnum[keyof typeof SendPushRequestPriorityEnum];
-
-
 /**
  * Check if a given object implements the SendPushRequest interface.
  */
 export function instanceOfSendPushRequest(value: object): value is SendPushRequest {
-    if (!('payload' in value) || value['payload'] === undefined) return false;
     return true;
 }
 
@@ -114,15 +160,25 @@ export function SendPushRequestFromJSONTyped(json: any, ignoreDiscriminator: boo
     }
     return {
         
+        'userId': json['user_id'] == null ? undefined : json['user_id'],
         'deviceId': json['device_id'] == null ? undefined : json['device_id'],
-        'deviceIds': json['device_ids'] == null ? undefined : json['device_ids'],
-        'subscriberId': json['subscriber_id'] == null ? undefined : json['subscriber_id'],
-        'topic': json['topic'] == null ? undefined : json['topic'],
-        'payload': PushPayloadFromJSON(json['payload']),
-        'priority': json['priority'] == null ? undefined : json['priority'],
-        'ttl': json['ttl'] == null ? undefined : json['ttl'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'body': json['body'] == null ? undefined : json['body'],
+        'data': json['data'] == null ? undefined : json['data'],
+        'badge': json['badge'] == null ? undefined : json['badge'],
+        'sound': json['sound'] == null ? undefined : json['sound'],
+        'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
+        'contentAvailable': json['content_available'] == null ? undefined : json['content_available'],
+        'actionButtons': json['action_buttons'] == null ? undefined : ((json['action_buttons'] as Array<any>).map(SendPushRequestActionButtonsInnerFromJSON)),
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
         'collapseKey': json['collapse_key'] == null ? undefined : json['collapse_key'],
-        'scheduledAt': json['scheduled_at'] == null ? undefined : (new Date(json['scheduled_at'])),
+        'subscriberId': json['subscriber_id'] == null ? undefined : json['subscriber_id'],
+        'subscriberExternalId': json['subscriber_external_id'] == null ? undefined : json['subscriber_external_id'],
+        'category': json['category'] == null ? undefined : json['category'],
+        'force': json['force'] == null ? undefined : json['force'],
+        'sendAt': json['send_at'] == null ? undefined : (new Date(json['send_at'])),
+        'delay': json['delay'] == null ? undefined : json['delay'],
     };
 }
 
@@ -137,15 +193,25 @@ export function SendPushRequestToJSONTyped(value?: SendPushRequest | null, ignor
 
     return {
         
+        'user_id': value['userId'],
         'device_id': value['deviceId'],
-        'device_ids': value['deviceIds'],
-        'subscriber_id': value['subscriberId'],
-        'topic': value['topic'],
-        'payload': PushPayloadToJSON(value['payload']),
-        'priority': value['priority'],
-        'ttl': value['ttl'],
+        'title': value['title'],
+        'body': value['body'],
+        'data': value['data'],
+        'badge': value['badge'],
+        'sound': value['sound'],
+        'image_url': value['imageUrl'],
+        'content_available': value['contentAvailable'],
+        'action_buttons': value['actionButtons'] == null ? undefined : ((value['actionButtons'] as Array<any>).map(SendPushRequestActionButtonsInnerToJSON)),
+        'tags': value['tags'],
+        'metadata': value['metadata'],
         'collapse_key': value['collapseKey'],
-        'scheduled_at': value['scheduledAt'] == null ? undefined : ((value['scheduledAt']).toISOString()),
+        'subscriber_id': value['subscriberId'],
+        'subscriber_external_id': value['subscriberExternalId'],
+        'category': value['category'],
+        'force': value['force'],
+        'send_at': value['sendAt'] == null ? undefined : ((value['sendAt']).toISOString()),
+        'delay': value['delay'],
     };
 }
 

package/src/src/models/SendPushRequestActionButtonsInner.ts

@@ -0,0 +1,91 @@
+/* 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 SendPushRequestActionButtonsInner
+ */
+export interface SendPushRequestActionButtonsInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof SendPushRequestActionButtonsInner
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SendPushRequestActionButtonsInner
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SendPushRequestActionButtonsInner
+     */
+    action?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SendPushRequestActionButtonsInner
+     */
+    deepLink?: string;
+}
+
+/**
+ * Check if a given object implements the SendPushRequestActionButtonsInner interface.
+ */
+export function instanceOfSendPushRequestActionButtonsInner(value: object): value is SendPushRequestActionButtonsInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    return true;
+}
+
+export function SendPushRequestActionButtonsInnerFromJSON(json: any): SendPushRequestActionButtonsInner {
+    return SendPushRequestActionButtonsInnerFromJSONTyped(json, false);
+}
+
+export function SendPushRequestActionButtonsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendPushRequestActionButtonsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'title': json['title'],
+        'action': json['action'] == null ? undefined : json['action'],
+        'deepLink': json['deep_link'] == null ? undefined : json['deep_link'],
+    };
+}
+
+export function SendPushRequestActionButtonsInnerToJSON(json: any): SendPushRequestActionButtonsInner {
+    return SendPushRequestActionButtonsInnerToJSONTyped(json, false);
+}
+
+export function SendPushRequestActionButtonsInnerToJSONTyped(value?: SendPushRequestActionButtonsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'title': value['title'],
+        'action': value['action'],
+        'deep_link': value['deepLink'],
+    };
+}
+

package/src/src/models/index.ts

@@ -140,7 +140,7 @@ export * from './PushEvent';
 export * from './PushListResponse';
 export * from './PushMessage';
 export * from './PushMessageDetail';
-export * from './PushPayload';
+export * from './PushMessageDetailAllOfActionButtons';
 export * from './PushStatsData';
 export * from './PushStatsResponse';
 export * from './PushTopicDevice';
@@ -186,6 +186,7 @@ export * from './SendInAppMeta';
 export * from './SendInAppRequest';
 export * from './SendInAppResponse';
 export * from './SendPushRequest';
+export * from './SendPushRequestActionButtonsInner';
 export * from './SendPushResponse';
 export * from './SendPushResponseData';
 export * from './SendPushToTopicData';

package/dist/src/models/PushPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PushPayload.d.ts","sourceRoot":"","sources":["../../../src/src/models/PushPayload.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAClC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,WAAW,CAIzE;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,WAAW,CAE1D;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,WAAW,CAe7F;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,WAAW,CAExD;AAED,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAgB5G"}

package/dist/src/models/PushPayload.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PushPayload.js","sourceRoot":"","sources":["../../../src/src/models/PushPayload.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AA2DH;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAa;IAC/C,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpE,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAS;IACzC,OAAO,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,IAAS,EAAE,mBAA4B;IAC5E,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACvD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;QAC9E,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;KAC1D,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAS;IACvC,OAAO,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAA0B,EAAE,sBAA+B,KAAK;IACnG,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC;QACpC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;KACxB,CAAC;AACN,CAAC"}

package/src/src/models/PushPayload.ts

@@ -1,123 +0,0 @@
-/* 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 PushPayload
- */
-export interface PushPayload {
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    title: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    body: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    icon?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    image?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    badge?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    sound?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PushPayload
-     */
-    clickAction?: string;
-    /**
-     * 
-     * @type {{ [key: string]: any; }}
-     * @memberof PushPayload
-     */
-    data?: { [key: string]: any; };
-}
-
-/**
- * Check if a given object implements the PushPayload interface.
- */
-export function instanceOfPushPayload(value: object): value is PushPayload {
-    if (!('title' in value) || value['title'] === undefined) return false;
-    if (!('body' in value) || value['body'] === undefined) return false;
-    return true;
-}
-
-export function PushPayloadFromJSON(json: any): PushPayload {
-    return PushPayloadFromJSONTyped(json, false);
-}
-
-export function PushPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PushPayload {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'title': json['title'],
-        'body': json['body'],
-        'icon': json['icon'] == null ? undefined : json['icon'],
-        'image': json['image'] == null ? undefined : json['image'],
-        'badge': json['badge'] == null ? undefined : json['badge'],
-        'sound': json['sound'] == null ? undefined : json['sound'],
-        'clickAction': json['click_action'] == null ? undefined : json['click_action'],
-        'data': json['data'] == null ? undefined : json['data'],
-    };
-}
-
-export function PushPayloadToJSON(json: any): PushPayload {
-    return PushPayloadToJSONTyped(json, false);
-}
-
-export function PushPayloadToJSONTyped(value?: PushPayload | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'title': value['title'],
-        'body': value['body'],
-        'icon': value['icon'],
-        'image': value['image'],
-        'badge': value['badge'],
-        'sound': value['sound'],
-        'click_action': value['clickAction'],
-        'data': value['data'],
-    };
-}
-