@zyphr-dev/node-sdk 0.1.23 → 0.1.25

package/src/src/models/ConvertAnonymousUserRequestOneOf1AppleUser.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';
+import type { ConvertAnonymousUserRequestOneOf1AppleUserName } from './ConvertAnonymousUserRequestOneOf1AppleUserName';
+import {
+    ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSON,
+    ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSONTyped,
+    ConvertAnonymousUserRequestOneOf1AppleUserNameToJSON,
+    ConvertAnonymousUserRequestOneOf1AppleUserNameToJSONTyped,
+} from './ConvertAnonymousUserRequestOneOf1AppleUserName';
+
+/**
+ * Sign in with Apple only -- first-call name payload, since Apple omits the name from /userinfo on subsequent sign-ins.
+ * @export
+ * @interface ConvertAnonymousUserRequestOneOf1AppleUser
+ */
+export interface ConvertAnonymousUserRequestOneOf1AppleUser {
+    /**
+     * 
+     * @type {ConvertAnonymousUserRequestOneOf1AppleUserName}
+     * @memberof ConvertAnonymousUserRequestOneOf1AppleUser
+     */
+    name?: ConvertAnonymousUserRequestOneOf1AppleUserName;
+}
+
+/**
+ * Check if a given object implements the ConvertAnonymousUserRequestOneOf1AppleUser interface.
+ */
+export function instanceOfConvertAnonymousUserRequestOneOf1AppleUser(value: object): value is ConvertAnonymousUserRequestOneOf1AppleUser {
+    return true;
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserFromJSON(json: any): ConvertAnonymousUserRequestOneOf1AppleUser {
+    return ConvertAnonymousUserRequestOneOf1AppleUserFromJSONTyped(json, false);
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConvertAnonymousUserRequestOneOf1AppleUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSON(json['name']),
+    };
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserToJSON(json: any): ConvertAnonymousUserRequestOneOf1AppleUser {
+    return ConvertAnonymousUserRequestOneOf1AppleUserToJSONTyped(json, false);
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserToJSONTyped(value?: ConvertAnonymousUserRequestOneOf1AppleUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': ConvertAnonymousUserRequestOneOf1AppleUserNameToJSON(value['name']),
+    };
+}
+

package/src/src/models/ConvertAnonymousUserRequestOneOf1AppleUserName.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 ConvertAnonymousUserRequestOneOf1AppleUserName
+ */
+export interface ConvertAnonymousUserRequestOneOf1AppleUserName {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConvertAnonymousUserRequestOneOf1AppleUserName
+     */
+    firstName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConvertAnonymousUserRequestOneOf1AppleUserName
+     */
+    lastName?: string;
+}
+
+/**
+ * Check if a given object implements the ConvertAnonymousUserRequestOneOf1AppleUserName interface.
+ */
+export function instanceOfConvertAnonymousUserRequestOneOf1AppleUserName(value: object): value is ConvertAnonymousUserRequestOneOf1AppleUserName {
+    return true;
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSON(json: any): ConvertAnonymousUserRequestOneOf1AppleUserName {
+    return ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSONTyped(json, false);
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserNameFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConvertAnonymousUserRequestOneOf1AppleUserName {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'] == null ? undefined : json['firstName'],
+        'lastName': json['lastName'] == null ? undefined : json['lastName'],
+    };
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserNameToJSON(json: any): ConvertAnonymousUserRequestOneOf1AppleUserName {
+    return ConvertAnonymousUserRequestOneOf1AppleUserNameToJSONTyped(json, false);
+}
+
+export function ConvertAnonymousUserRequestOneOf1AppleUserNameToJSONTyped(value?: ConvertAnonymousUserRequestOneOf1AppleUserName | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+    };
+}
+

package/src/src/models/CreateTemplateRequest.ts

@@ -32,19 +32,34 @@ export interface CreateTemplateRequest {
      */
     description?: string;
     /**
-     * Email subject line (supports Handlebars)
+     * Email subject line. Supports Handlebars `{{var}}` interpolation;
+     * values are HTML-escaped on render (see `html` field for the full
+     * escape policy).
+     * 
      * @type {string}
      * @memberof CreateTemplateRequest
      */
     subject?: string;
     /**
-     * HTML body (supports Handlebars)
+     * HTML body. Supports Handlebars `{{var}}` interpolation; values are
+     * always HTML-escaped on render.
+     * 
+     * **Triple-brace `{{{var}}}` (raw HTML output) is not supported** for
+     * XSS-prevention reasons — input containing `{{{var}}}` is rewritten
+     * to `{{var}}` on save and the response includes a top-level
+     * `warnings` array describing what changed. To inject pre-rendered
+     * HTML, render the entire `html` field outside Zyphr and POST it to
+     * `/v1/email/send` directly without `template_id`.
+     * 
      * @type {string}
      * @memberof CreateTemplateRequest
      */
     html?: string;
     /**
-     * Plain text body (supports Handlebars)
+     * Plain text body. Supports Handlebars `{{var}}` interpolation;
+     * triple-brace syntax is rewritten to double-brace on save (same
+     * policy as the `html` field).
+     * 
      * @type {string}
      * @memberof CreateTemplateRequest
      */

package/src/src/models/SendBatchEmailRequest.ts

@@ -13,33 +13,99 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SendEmailRequest } from './SendEmailRequest';
+import type { BatchRecipient } from './BatchRecipient';
 import {
-    SendEmailRequestFromJSON,
-    SendEmailRequestFromJSONTyped,
-    SendEmailRequestToJSON,
-    SendEmailRequestToJSONTyped,
-} from './SendEmailRequest';
+    BatchRecipientFromJSON,
+    BatchRecipientFromJSONTyped,
+    BatchRecipientToJSON,
+    BatchRecipientToJSONTyped,
+} from './BatchRecipient';
+import type { EmailAddress } from './EmailAddress';
+import {
+    EmailAddressFromJSON,
+    EmailAddressFromJSONTyped,
+    EmailAddressToJSON,
+    EmailAddressToJSONTyped,
+} from './EmailAddress';
 
 /**
+ * Send a single email to up to 100 recipients in one request. Each recipient gets their own message record. Provide either raw content (`subject` plus `html` and/or `text`) or a `template_id` with `template_data`.
  * 
  * @export
  * @interface SendBatchEmailRequest
  */
 export interface SendBatchEmailRequest {
+    /**
+     * Sender address. The API also accepts a plain email string for convenience.
+     * 
+     * @type {EmailAddress}
+     * @memberof SendBatchEmailRequest
+     */
+    from: EmailAddress;
+    /**
+     * 
+     * @type {Array<BatchRecipient>}
+     * @memberof SendBatchEmailRequest
+     */
+    to: Array<BatchRecipient>;
+    /**
+     * Reply-to address. The API also accepts a plain email string for convenience.
+     * 
+     * @type {EmailAddress}
+     * @memberof SendBatchEmailRequest
+     */
+    replyTo?: EmailAddress;
+    /**
+     * Required when sending raw content (no `template_id`).
+     * @type {string}
+     * @memberof SendBatchEmailRequest
+     */
+    subject?: string;
+    /**
+     * Provide either `html` or `text` (or both) when sending raw content.
+     * @type {string}
+     * @memberof SendBatchEmailRequest
+     */
+    html?: string;
+    /**
+     * Provide either `html` or `text` (or both) when sending raw content.
+     * @type {string}
+     * @memberof SendBatchEmailRequest
+     */
+    text?: string;
+    /**
+     * Template ID to use instead of raw `subject`/`html`/`text`.
+     * @type {string}
+     * @memberof SendBatchEmailRequest
+     */
+    templateId?: string;
+    /**
+     * Default variables to pass to the template. Merged with each recipient's per-recipient `variables` (per-recipient values win on key collisions).
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof SendBatchEmailRequest
+     */
+    templateData?: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof SendBatchEmailRequest
+     */
+    tags?: Array<string>;
     /**
      * 
-     * @type {Array<SendEmailRequest>}
+     * @type {{ [key: string]: any; }}
      * @memberof SendBatchEmailRequest
      */
-    messages: Array<SendEmailRequest>;
+    metadata?: { [key: string]: any; };
 }
 
 /**
  * Check if a given object implements the SendBatchEmailRequest interface.
  */
 export function instanceOfSendBatchEmailRequest(value: object): value is SendBatchEmailRequest {
-    if (!('messages' in value) || value['messages'] === undefined) return false;
+    if (!('from' in value) || value['from'] === undefined) return false;
+    if (!('to' in value) || value['to'] === undefined) return false;
     return true;
 }
 
@@ -53,7 +119,16 @@ export function SendBatchEmailRequestFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'messages': ((json['messages'] as Array<any>).map(SendEmailRequestFromJSON)),
+        'from': EmailAddressFromJSON(json['from']),
+        'to': ((json['to'] as Array<any>).map(BatchRecipientFromJSON)),
+        'replyTo': json['reply_to'] == null ? undefined : EmailAddressFromJSON(json['reply_to']),
+        'subject': json['subject'] == null ? undefined : json['subject'],
+        'html': json['html'] == null ? undefined : json['html'],
+        'text': json['text'] == null ? undefined : json['text'],
+        'templateId': json['template_id'] == null ? undefined : json['template_id'],
+        'templateData': json['template_data'] == null ? undefined : json['template_data'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
     };
 }
 
@@ -68,7 +143,16 @@ export function SendBatchEmailRequestToJSONTyped(value?: SendBatchEmailRequest |
 
     return {
         
-        'messages': ((value['messages'] as Array<any>).map(SendEmailRequestToJSON)),
+        'from': EmailAddressToJSON(value['from']),
+        'to': ((value['to'] as Array<any>).map(BatchRecipientToJSON)),
+        'reply_to': EmailAddressToJSON(value['replyTo']),
+        'subject': value['subject'],
+        'html': value['html'],
+        'text': value['text'],
+        'template_id': value['templateId'],
+        'template_data': value['templateData'],
+        'tags': value['tags'],
+        'metadata': value['metadata'],
     };
 }
 

package/src/src/models/SignInAnonymouslyRequest.ts

@@ -0,0 +1,82 @@
+/* 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 SignInAnonymouslyRequest
+ */
+export interface SignInAnonymouslyRequest {
+    /**
+     * Stable per-device identifier supplied by the client. Use a cryptographically-random opaque value persisted to client storage on first run.
+     * @type {string}
+     * @memberof SignInAnonymouslyRequest
+     */
+    deviceId: string;
+    /**
+     * Optional display name. If omitted, the user has no name until conversion.
+     * @type {string}
+     * @memberof SignInAnonymouslyRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof SignInAnonymouslyRequest
+     */
+    metadata?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the SignInAnonymouslyRequest interface.
+ */
+export function instanceOfSignInAnonymouslyRequest(value: object): value is SignInAnonymouslyRequest {
+    if (!('deviceId' in value) || value['deviceId'] === undefined) return false;
+    return true;
+}
+
+export function SignInAnonymouslyRequestFromJSON(json: any): SignInAnonymouslyRequest {
+    return SignInAnonymouslyRequestFromJSONTyped(json, false);
+}
+
+export function SignInAnonymouslyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignInAnonymouslyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'deviceId': json['device_id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function SignInAnonymouslyRequestToJSON(json: any): SignInAnonymouslyRequest {
+    return SignInAnonymouslyRequestToJSONTyped(json, false);
+}
+
+export function SignInAnonymouslyRequestToJSONTyped(value?: SignInAnonymouslyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'device_id': value['deviceId'],
+        'name': value['name'],
+        'metadata': value['metadata'],
+    };
+}
+

package/src/src/models/TemplateResponse.ts

@@ -46,6 +46,17 @@ export interface TemplateResponse {
      * @memberof TemplateResponse
      */
     meta?: RequestMeta;
+    /**
+     * Non-fatal advisories about the request. Currently emitted only when
+     * the server rewrites template content for security (see the `html`
+     * field on `CreateTemplateRequest` for the triple-brace policy).
+     * Omitted entirely when no warnings apply — clients should treat its
+     * absence as equivalent to an empty array.
+     * 
+     * @type {Array<string>}
+     * @memberof TemplateResponse
+     */
+    warnings?: Array<string>;
 }
 
 /**
@@ -67,6 +78,7 @@ export function TemplateResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'data': json['data'] == null ? undefined : TemplateFromJSON(json['data']),
         'meta': json['meta'] == null ? undefined : RequestMetaFromJSON(json['meta']),
+        'warnings': json['warnings'] == null ? undefined : json['warnings'],
     };
 }
 
@@ -83,6 +95,7 @@ export function TemplateResponseToJSONTyped(value?: TemplateResponse | null, ign
         
         'data': TemplateToJSON(value['data']),
         'meta': RequestMetaToJSON(value['meta']),
+        'warnings': value['warnings'],
     };
 }
 

package/src/src/models/UpdateTemplateRequest.ts

@@ -32,18 +32,27 @@ export interface UpdateTemplateRequest {
      */
     description?: string;
     /**
+     * Email subject line. Supports Handlebars `{{var}}` interpolation
+     * (HTML-escaped on render).
      * 
      * @type {string}
      * @memberof UpdateTemplateRequest
      */
     subject?: string;
     /**
+     * HTML body. Supports Handlebars `{{var}}` interpolation; values are
+     * always HTML-escaped on render. Triple-brace `{{{var}}}` is not
+     * supported — input is rewritten to `{{var}}` on save and the
+     * response includes a top-level `warnings` array describing the
+     * rewrite. See `CreateTemplateRequest.html` for full rationale.
      * 
      * @type {string}
      * @memberof UpdateTemplateRequest
      */
     html?: string;
     /**
+     * Plain text body. Supports Handlebars `{{var}}` interpolation; same
+     * triple-brace rewrite policy as `html`.
      * 
      * @type {string}
      * @memberof UpdateTemplateRequest

package/src/src/models/index.ts

@@ -32,6 +32,7 @@ export * from './AuthUser';
 export * from './AuthUserResponse';
 export * from './AuthUserResponseData';
 export * from './BatchPublishWaaSEvents201Response';
+export * from './BatchRecipient';
 export * from './BulkRetryWebhookDeliveriesRequest';
 export * from './BulkUpsertAuthEmailTemplatesRequest';
 export * from './BulkUpsertAuthEmailTemplatesResponse';
@@ -48,6 +49,11 @@ export * from './ConsentRecordResponseData';
 export * from './ConsentStatus';
 export * from './ConsentStatusResponse';
 export * from './ConsentWithdrawResponse';
+export * from './ConvertAnonymousUserRequest';
+export * from './ConvertAnonymousUserRequestOneOf';
+export * from './ConvertAnonymousUserRequestOneOf1';
+export * from './ConvertAnonymousUserRequestOneOf1AppleUser';
+export * from './ConvertAnonymousUserRequestOneOf1AppleUserName';
 export * from './CreateCategoryRequest';
 export * from './CreateSubscriberRequest';
 export * from './CreateTemplateRequest';
@@ -235,6 +241,7 @@ export * from './SessionListResponseData';
 export * from './SessionListResponseDataSessionInfo';
 export * from './SetPreferencesRequest';
 export * from './SetPreferencesRequestPreferencesInner';
+export * from './SignInAnonymouslyRequest';
 export * from './SlackMessage';
 export * from './SlackMessageListResponse';
 export * from './SlackMessageListResponseMeta';