zyphr 0.1.23 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b8fcb1badee8f50b9507765d4c2bcc896b0b966dbae85a89028f881008176a9
-  data.tar.gz: 6ba51b317d1e0f17d6c0becd75b2e8c616932c37a24a4c166c08fce7e50cb7cf
+  metadata.gz: a85b93ca7e767d1fbf04d38ecc50cd06a6b8f9cac57cb476c4598d8354f46ba9
+  data.tar.gz: 99e51428224ef0af2ede43492c38cba07d3cff36682b7562fe6477b8978e58f5
 SHA512:
-  metadata.gz: ca806ff3567cfada05a98543b861f1974ab135e235edf03ad3ae4d4668a051817451f6503ab7c301bb5f02a9cb68649f64b7faa2fe5a98f1a0957e3079a6fbcf
-  data.tar.gz: 5ce7284db506e4e5afaff6cd23da1178b36cb7d544ccd3c9fe908c7f3c083739662ee5d7731fb0a285026e54bed23e09bc3c0aa0d0c090d83c9c8ba20a43e6a2
+  metadata.gz: e8279a0d3c548f33c49d1fffdc0a7a93648da88d5afa7b2c1072076fdfa62b1170bb94ee1d104aead0d401b97bd818fca0db49e21c210bfad496beef441a0dba
+  data.tar.gz: 5635eea6e8c0de46184f8cd1d66204a360a9752347870730756d48de04b32f60be6171bbc857e4d9c94d9da3a3ae246c0cee96f807c27f53cd3c98cb4783fed9

data/README.md

@@ -363,6 +363,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::AuthUserResponse](docs/AuthUserResponse.md)
  - [Zyphr::AuthUserResponseData](docs/AuthUserResponseData.md)
  - [Zyphr::BatchPublishWaaSEvents201Response](docs/BatchPublishWaaSEvents201Response.md)
+ - [Zyphr::BatchRecipient](docs/BatchRecipient.md)
  - [Zyphr::BulkRetryWebhookDeliveriesRequest](docs/BulkRetryWebhookDeliveriesRequest.md)
  - [Zyphr::BulkUpsertAuthEmailTemplatesRequest](docs/BulkUpsertAuthEmailTemplatesRequest.md)
  - [Zyphr::BulkUpsertAuthEmailTemplatesResponse](docs/BulkUpsertAuthEmailTemplatesResponse.md)

data/docs/BatchRecipient.md

@@ -0,0 +1,22 @@
+# Zyphr::BatchRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **variables** | **Hash<String, Object>** | Per-recipient template variables. Merged on top of the batch-level `template_data`, so per-recipient values win on key collisions.  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::BatchRecipient.new(
+  email: null,
+  name: null,
+  variables: null
+)
+```
+

data/docs/CreateTemplateRequest.md

@@ -6,9 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Template name (letters, numbers, underscores, hyphens) |  |
 | **description** | **String** |  | [optional] |
-| **subject** | **String** | Email subject line (supports Handlebars) | [optional] |
-| **html** | **String** | HTML body (supports Handlebars) | [optional] |
-| **text** | **String** | Plain text body (supports Handlebars) | [optional] |
+| **subject** | **String** | Email subject line. Supports Handlebars `{{var}}` interpolation; values are HTML-escaped on render (see `html` field for the full escape policy).  | [optional] |
+| **html** | **String** | 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`.  | [optional] |
+| **text** | **String** | Plain text body. Supports Handlebars `{{var}}` interpolation; triple-brace syntax is rewritten to double-brace on save (same policy as the `html` field).  | [optional] |
 
 ## Example
 

data/docs/EmailsApi.md

@@ -310,7 +310,7 @@ end
 
 Send batch emails
 
-Send up to 100 emails in a single request. Each recipient gets their own message record.
+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`. Per-recipient `variables` are merged on top of the batch-level `template_data`. 
 
 ### Examples
 
@@ -326,7 +326,7 @@ Zyphr.configure do |config|
 end
 
 api_instance = Zyphr::EmailsApi.new
-send_batch_email_request = Zyphr::SendBatchEmailRequest.new({messages: [Zyphr::SendEmailRequest.new({to: [{"email": "user@example.com", "name": "John Doe"}], subject: 'Welcome to Zyphr!'})]}) # SendBatchEmailRequest | 
+send_batch_email_request = Zyphr::SendBatchEmailRequest.new({from: Zyphr::EmailAddress.new, to: [Zyphr::BatchRecipient.new({email: 'email_example'})]}) # SendBatchEmailRequest | 
 
 begin
   # Send batch emails

data/docs/SendBatchEmailRequest.md

@@ -4,7 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **messages** | [**Array<SendEmailRequest>**](SendEmailRequest.md) |  |  |
+| **from** | [**EmailAddress**](EmailAddress.md) | Sender address. The API also accepts a plain email string for convenience.  |  |
+| **to** | [**Array<BatchRecipient>**](BatchRecipient.md) |  |  |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) | Reply-to address. The API also accepts a plain email string for convenience.  | [optional] |
+| **subject** | **String** | Required when sending raw content (no `template_id`). | [optional] |
+| **html** | **String** | Provide either `html` or `text` (or both) when sending raw content. | [optional] |
+| **text** | **String** | Provide either `html` or `text` (or both) when sending raw content. | [optional] |
+| **template_id** | **String** | Template ID to use instead of raw `subject`/`html`/`text`. | [optional] |
+| **template_data** | **Hash<String, Object>** | Default variables to pass to the template. Merged with each recipient's per-recipient `variables` (per-recipient values win on key collisions).  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
 
 ## Example
 
@@ -12,7 +21,16 @@
 require 'zyphr'
 
 instance = Zyphr::SendBatchEmailRequest.new(
-  messages: null
+  from: null,
+  to: null,
+  reply_to: null,
+  subject: null,
+  html: null,
+  text: null,
+  template_id: null,
+  template_data: null,
+  tags: null,
+  metadata: null
 )
 ```
 

data/docs/TemplateResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Template**](Template.md) |  | [optional] |
 | **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+| **warnings** | **Array<String>** | 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.  | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'zyphr'
 
 instance = Zyphr::TemplateResponse.new(
   data: null,
-  meta: null
+  meta: null,
+  warnings: ["Stripped 1 occurrence(s) of triple-brace Handlebars syntax {{{var}}} from html. Raw HTML output is not supported for security reasons; values render HTML-escaped via {{var}}."]
 )
 ```
 

data/docs/UpdateTemplateRequest.md

@@ -6,9 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
-| **subject** | **String** |  | [optional] |
-| **html** | **String** |  | [optional] |
-| **text** | **String** |  | [optional] |
+| **subject** | **String** | Email subject line. Supports Handlebars `{{var}}` interpolation (HTML-escaped on render).  | [optional] |
+| **html** | **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.  | [optional] |
+| **text** | **String** | Plain text body. Supports Handlebars `{{var}}` interpolation; same triple-brace rewrite policy as `html`.  | [optional] |
 
 ## Example
 

data/lib/zyphr/api/emails_api.rb

@@ -294,7 +294,7 @@ module Zyphr
     end
 
     # Send batch emails
-    # Send up to 100 emails in a single request. Each recipient gets their own message record.
+    # 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`. Per-recipient `variables` are merged on top of the batch-level `template_data`. 
     # @param send_batch_email_request [SendBatchEmailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SendBatchEmailResponse]
@@ -304,7 +304,7 @@ module Zyphr
     end
 
     # Send batch emails
-    # Send up to 100 emails in a single request. Each recipient gets their own message record.
+    # 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`. Per-recipient `variables` are merged on top of the batch-level `template_data`. 
     # @param send_batch_email_request [SendBatchEmailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SendBatchEmailResponse, Integer, Hash)>] SendBatchEmailResponse data, response status code and response headers

data/lib/zyphr/models/batch_recipient.rb

@@ -0,0 +1,258 @@
+=begin
+#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
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zyphr
+  class BatchRecipient
+    attr_accessor :email
+
+    attr_accessor :name
+
+    # Per-recipient template variables. Merged on top of the batch-level `template_data`, so per-recipient values win on key collisions. 
+    attr_accessor :variables
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'name' => :'name',
+        :'variables' => :'variables'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'String',
+        :'name' => :'String',
+        :'variables' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::BatchRecipient` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::BatchRecipient`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'variables')
+        if (value = attributes[:'variables']).is_a?(Hash)
+          self.variables = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @email.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      @email = email
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          email == o.email &&
+          name == o.name &&
+          variables == o.variables
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [email, name, variables].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Zyphr.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/zyphr/models/create_template_request.rb

@@ -20,13 +20,13 @@ module Zyphr
 
     attr_accessor :description
 
-    # 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). 
     attr_accessor :subject
 
-    # 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`. 
     attr_accessor :html
 
-    # 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). 
     attr_accessor :text
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/zyphr/models/send_batch_email_request.rb

@@ -14,13 +14,48 @@ require 'date'
 require 'time'
 
 module Zyphr
+  # 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`. 
   class SendBatchEmailRequest
-    attr_accessor :messages
+    # Sender address. The API also accepts a plain email string for convenience. 
+    attr_accessor :from
+
+    attr_accessor :to
+
+    # Reply-to address. The API also accepts a plain email string for convenience. 
+    attr_accessor :reply_to
+
+    # Required when sending raw content (no `template_id`).
+    attr_accessor :subject
+
+    # Provide either `html` or `text` (or both) when sending raw content.
+    attr_accessor :html
+
+    # Provide either `html` or `text` (or both) when sending raw content.
+    attr_accessor :text
+
+    # Template ID to use instead of raw `subject`/`html`/`text`.
+    attr_accessor :template_id
+
+    # Default variables to pass to the template. Merged with each recipient's per-recipient `variables` (per-recipient values win on key collisions). 
+    attr_accessor :template_data
+
+    attr_accessor :tags
+
+    attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'messages' => :'messages'
+        :'from' => :'from',
+        :'to' => :'to',
+        :'reply_to' => :'reply_to',
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'text' => :'text',
+        :'template_id' => :'template_id',
+        :'template_data' => :'template_data',
+        :'tags' => :'tags',
+        :'metadata' => :'metadata'
       }
     end
 
@@ -37,7 +72,16 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'messages' => :'Array<SendEmailRequest>'
+        :'from' => :'EmailAddress',
+        :'to' => :'Array<BatchRecipient>',
+        :'reply_to' => :'EmailAddress',
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'text' => :'String',
+        :'template_id' => :'String',
+        :'template_data' => :'Hash<String, Object>',
+        :'tags' => :'Array<String>',
+        :'metadata' => :'Hash<String, Object>'
       }
     end
 
@@ -63,12 +107,56 @@ module Zyphr
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'messages')
-        if (value = attributes[:'messages']).is_a?(Array)
-          self.messages = value
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      else
+        self.from = nil
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
         end
       else
-        self.messages = nil
+        self.to = nil
+      end
+
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      end
+
+      if attributes.key?(:'template_data')
+        if (value = attributes[:'template_data']).is_a?(Hash)
+          self.template_data = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
     end
 
@@ -77,12 +165,24 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @messages.nil?
-        invalid_properties.push('invalid value for "messages", messages cannot be nil.')
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
 
-      if @messages.length > 100
-        invalid_properties.push('invalid value for "messages", number of items must be less than or equal to 100.')
+      if @to.length > 100
+        invalid_properties.push('invalid value for "to", number of items must be less than or equal to 100.')
+      end
+
+      if @to.length < 1
+        invalid_properties.push('invalid value for "to", number of items must be greater than or equal to 1.')
+      end
+
+      if !@tags.nil? && @tags.length > 10
+        invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 10.')
       end
 
       invalid_properties
@@ -92,23 +192,54 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @messages.nil?
-      return false if @messages.length > 100
+      return false if @from.nil?
+      return false if @to.nil?
+      return false if @to.length > 100
+      return false if @to.length < 1
+      return false if !@tags.nil? && @tags.length > 10
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] messages Value to be assigned
-    def messages=(messages)
-      if messages.nil?
-        fail ArgumentError, 'messages cannot be nil'
+    # @param [Object] from Value to be assigned
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'from cannot be nil'
+      end
+
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      if to.length > 100
+        fail ArgumentError, 'invalid value for "to", number of items must be less than or equal to 100.'
+      end
+
+      if to.length < 1
+        fail ArgumentError, 'invalid value for "to", number of items must be greater than or equal to 1.'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tags Value to be assigned
+    def tags=(tags)
+      if tags.nil?
+        fail ArgumentError, 'tags cannot be nil'
       end
 
-      if messages.length > 100
-        fail ArgumentError, 'invalid value for "messages", number of items must be less than or equal to 100.'
+      if tags.length > 10
+        fail ArgumentError, 'invalid value for "tags", number of items must be less than or equal to 10.'
       end
 
-      @messages = messages
+      @tags = tags
     end
 
     # Checks equality by comparing each attribute.
@@ -116,7 +247,16 @@ module Zyphr
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          messages == o.messages
+          from == o.from &&
+          to == o.to &&
+          reply_to == o.reply_to &&
+          subject == o.subject &&
+          html == o.html &&
+          text == o.text &&
+          template_id == o.template_id &&
+          template_data == o.template_data &&
+          tags == o.tags &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -128,7 +268,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [messages].hash
+      [from, to, reply_to, subject, html, text, template_id, template_data, tags, metadata].hash
     end
 
     # Builds the object from hash

data/lib/zyphr/models/template_response.rb

@@ -19,11 +19,15 @@ module Zyphr
 
     attr_accessor :meta
 
+    # 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. 
+    attr_accessor :warnings
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'data' => :'data',
-        :'meta' => :'meta'
+        :'meta' => :'meta',
+        :'warnings' => :'warnings'
       }
     end
 
@@ -41,7 +45,8 @@ module Zyphr
     def self.openapi_types
       {
         :'data' => :'Template',
-        :'meta' => :'RequestMeta'
+        :'meta' => :'RequestMeta',
+        :'warnings' => :'Array<String>'
       }
     end
 
@@ -74,6 +79,12 @@ module Zyphr
       if attributes.key?(:'meta')
         self.meta = attributes[:'meta']
       end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -97,7 +108,8 @@ module Zyphr
       return true if self.equal?(o)
       self.class == o.class &&
           data == o.data &&
-          meta == o.meta
+          meta == o.meta &&
+          warnings == o.warnings
     end
 
     # @see the `==` method
@@ -109,7 +121,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data, meta].hash
+      [data, meta, warnings].hash
     end
 
     # Builds the object from hash

data/lib/zyphr/models/update_template_request.rb

@@ -19,10 +19,13 @@ module Zyphr
 
     attr_accessor :description
 
+    # Email subject line. Supports Handlebars `{{var}}` interpolation (HTML-escaped on render). 
     attr_accessor :subject
 
+    # 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. 
     attr_accessor :html
 
+    # Plain text body. Supports Handlebars `{{var}}` interpolation; same triple-brace rewrite policy as `html`. 
     attr_accessor :text
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/zyphr.rb

@@ -49,6 +49,7 @@ require 'zyphr/models/auth_user'
 require 'zyphr/models/auth_user_response'
 require 'zyphr/models/auth_user_response_data'
 require 'zyphr/models/batch_publish_waa_s_events201_response'
+require 'zyphr/models/batch_recipient'
 require 'zyphr/models/bulk_retry_webhook_deliveries_request'
 require 'zyphr/models/bulk_upsert_auth_email_templates_request'
 require 'zyphr/models/bulk_upsert_auth_email_templates_response'

data/spec/api/emails_api_spec.rb

@@ -85,7 +85,7 @@ describe 'EmailsApi' do
 
   # unit tests for send_batch_email
   # Send batch emails
-  # Send up to 100 emails in a single request. Each recipient gets their own message record.
+  # 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`. Per-recipient `variables` are merged on top of the batch-level `template_data`. 
   # @param send_batch_email_request 
   # @param [Hash] opts the optional parameters
   # @return [SendBatchEmailResponse]

data/spec/models/batch_recipient_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#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
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zyphr::BatchRecipient
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zyphr::BatchRecipient do
+  let(:instance) { Zyphr::BatchRecipient.new }
+
+  describe 'test an instance of BatchRecipient' do
+    it 'should create an instance of BatchRecipient' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zyphr::BatchRecipient)
+    end
+  end
+
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "variables"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/send_batch_email_request_spec.rb

@@ -27,7 +27,61 @@ describe Zyphr::SendBatchEmailRequest do
     end
   end
 
-  describe 'test attribute "messages"' do
+  describe 'test attribute "from"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "to"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "reply_to"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "subject"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "html"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "text"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "template_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "template_data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "tags"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "metadata"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/models/template_response_spec.rb

@@ -39,4 +39,10 @@ describe Zyphr::TemplateResponse do
     end
   end
 
+  describe 'test attribute "warnings"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.23'
+  s.version = '0.1.24'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.23
+  version: 0.1.24
 platform: ruby
 authors:
 - Zyphr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-09 00:00:00.000000000 Z
+date: 2026-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -132,6 +132,7 @@ files:
 - docs/AuthUserResponseData.md
 - docs/AuthWebAuthnApi.md
 - docs/BatchPublishWaaSEvents201Response.md
+- docs/BatchRecipient.md
 - docs/BulkRetryWebhookDeliveriesRequest.md
 - docs/BulkUpsertAuthEmailTemplatesRequest.md
 - docs/BulkUpsertAuthEmailTemplatesResponse.md
@@ -557,6 +558,7 @@ files:
 - lib/zyphr/models/auth_user_response.rb
 - lib/zyphr/models/auth_user_response_data.rb
 - lib/zyphr/models/batch_publish_waa_s_events201_response.rb
+- lib/zyphr/models/batch_recipient.rb
 - lib/zyphr/models/bulk_retry_webhook_deliveries_request.rb
 - lib/zyphr/models/bulk_upsert_auth_email_templates_request.rb
 - lib/zyphr/models/bulk_upsert_auth_email_templates_response.rb
@@ -960,6 +962,7 @@ files:
 - spec/models/auth_user_response_spec.rb
 - spec/models/auth_user_spec.rb
 - spec/models/batch_publish_waa_s_events201_response_spec.rb
+- spec/models/batch_recipient_spec.rb
 - spec/models/bulk_retry_webhook_deliveries_request_spec.rb
 - spec/models/bulk_upsert_auth_email_templates_request_spec.rb
 - spec/models/bulk_upsert_auth_email_templates_response_spec.rb
@@ -1433,6 +1436,7 @@ test_files:
 - spec/models/list_waa_s_endpoints200_response_spec.rb
 - spec/models/push_message_spec.rb
 - spec/models/sms_config_delete_response_data_spec.rb
+- spec/models/batch_recipient_spec.rb
 - spec/models/waa_s_batch_publish_request_spec.rb
 - spec/models/topic_subscribers_add_response_spec.rb
 - spec/models/consent_record_response_spec.rb