zyphr 0.1.45 → 0.1.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7566aa2d26c6c57823ded661edaf884ed4e3aaefa9760ac9e9d75ba552aa6f
-  data.tar.gz: 375575ac49fc49d697a2d47b12222e6771a6d0171a116ea93b2b21f1e6ea292b
+  metadata.gz: 1631c8b08187f685f9ba0705937529c10b793216403e569e084b19bbe76eed98
+  data.tar.gz: d459bb04c1089992c9c18a2287a5cdf859fdef80e94fe8859a78b659c4b56c4c
 SHA512:
-  metadata.gz: 4469bc22bf4a139e723b8f1cf339cafd440d2de808459f31ce67cbe0fbbad5462ce127c45ff61ee87b2d3571f1d509a7410592833fb0e68859e1d66606697fef
-  data.tar.gz: 821c2fc9241c4ce1ba257668d00056b1d628da96b9b632eaa478a63833915725cec8d44ec69ad598ce74c59be09bc6c53e8ff6943916fa2b994e9e158bea79d9
+  metadata.gz: dbdbfe7cb026b80ff24bfb3760983f9be06c4aaa2da6bdcd3d1386e29ac838c0ce1a927cfedfa48079ca3aab11dd4c6a4f47e065064c82a382253fdeeb01a14f
+  data.tar.gz: befc207eb3218353d296f8b14466fdb9fcf53a008c576381c843c998c8875bad60131e5bdb0b97785eb7bbd9aedc501e09f882ed1d3157f46f6350e771e65a1c

data/docs/EmailMessage.md

@@ -9,6 +9,7 @@
 | **to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
 | **subject** | **String** |  | [optional] |
 | **status** | **String** |  | [optional] |
+| **status_reason** | **String** | Why the message is in its current status, when applicable. For a `suppressed` row this is the suppression reason (e.g. `recipient_not_allowlisted` when blocked by the auth application's test_recipients allowlist). Null for normal sends.  | [optional] |
 | **tags** | **Array<String>** |  | [optional] |
 | **queued_at** | **Time** |  | [optional] |
 | **sent_at** | **Time** |  | [optional] |
@@ -29,6 +30,7 @@ instance = Zyphr::EmailMessage.new(
   to: null,
   subject: null,
   status: null,
+  status_reason: null,
   tags: null,
   queued_at: null,
   sent_at: null,

data/lib/zyphr/api/emails_api.rb

@@ -233,7 +233,7 @@ module Zyphr
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EmailsApi.list_emails ...'
       end
-      allowable_values = ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected"]
+      allowable_values = ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected", "suppressed"]
       if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
         fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
       end

data/lib/zyphr/models/email_message.rb

@@ -25,6 +25,9 @@ module Zyphr
 
     attr_accessor :status
 
+    # Why the message is in its current status, when applicable. For a `suppressed` row this is the suppression reason (e.g. `recipient_not_allowlisted` when blocked by the auth application's test_recipients allowlist). Null for normal sends. 
+    attr_accessor :status_reason
+
     attr_accessor :tags
 
     attr_accessor :queued_at
@@ -71,6 +74,7 @@ module Zyphr
         :'to' => :'to',
         :'subject' => :'subject',
         :'status' => :'status',
+        :'status_reason' => :'status_reason',
         :'tags' => :'tags',
         :'queued_at' => :'queued_at',
         :'sent_at' => :'sent_at',
@@ -100,6 +104,7 @@ module Zyphr
         :'to' => :'EmailAddress',
         :'subject' => :'String',
         :'status' => :'String',
+        :'status_reason' => :'String',
         :'tags' => :'Array<String>',
         :'queued_at' => :'Time',
         :'sent_at' => :'Time',
@@ -114,6 +119,7 @@ module Zyphr
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'status_reason',
         :'sent_at',
         :'delivered_at',
         :'bounced_at',
@@ -158,6 +164,10 @@ module Zyphr
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'status_reason')
+        self.status_reason = attributes[:'status_reason']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -205,7 +215,7 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      status_validator = EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected"])
+      status_validator = EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected", "suppressed"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -213,7 +223,7 @@ module Zyphr
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected"])
+      validator = EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected", "suppressed"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -230,6 +240,7 @@ module Zyphr
           to == o.to &&
           subject == o.subject &&
           status == o.status &&
+          status_reason == o.status_reason &&
           tags == o.tags &&
           queued_at == o.queued_at &&
           sent_at == o.sent_at &&
@@ -249,7 +260,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, from, to, subject, status, tags, queued_at, sent_at, delivered_at, bounced_at, opened_at, clicked_at, created_at].hash
+      [id, from, to, subject, status, status_reason, tags, queued_at, sent_at, delivered_at, bounced_at, opened_at, clicked_at, created_at].hash
     end
 
     # Builds the object from hash

data/lib/zyphr/models/webhook_event_type.rb

@@ -24,6 +24,7 @@ module Zyphr
     EMAIL_OPENED = "email.opened".freeze
     EMAIL_CLICKED = "email.clicked".freeze
     EMAIL_FAILED = "email.failed".freeze
+    EMAIL_SUPPRESSED = "email.suppressed".freeze
     EMAIL_RECEIVED = "email.received".freeze
     PUSH_SENT = "push.sent".freeze
     PUSH_DELIVERED = "push.delivered".freeze
@@ -45,7 +46,7 @@ module Zyphr
     DOMAIN_VERIFICATION_FAILED = "domain.verification_failed".freeze
 
     def self.all_vars
-      @all_vars ||= [EMAIL_QUEUED, EMAIL_SENT, EMAIL_DELIVERED, EMAIL_BOUNCED, EMAIL_SOFT_BOUNCED, EMAIL_COMPLAINED, EMAIL_OPENED, EMAIL_CLICKED, EMAIL_FAILED, EMAIL_RECEIVED, PUSH_SENT, PUSH_DELIVERED, PUSH_FAILED, PUSH_EXPIRED, USER_CREATED, USER_LOGIN, USER_LOGOUT, USER_PASSWORD_CHANGED, USER_PASSWORD_RESET_REQUESTED, USER_EMAIL_VERIFIED, USER_PHONE_VERIFIED, USER_DELETED, USER_SESSION_REVOKED, USER_MFA_ENABLED, USER_MFA_DISABLED, USER_IMPERSONATED, DOMAIN_VERIFIED, DOMAIN_VERIFICATION_FAILED].freeze
+      @all_vars ||= [EMAIL_QUEUED, EMAIL_SENT, EMAIL_DELIVERED, EMAIL_BOUNCED, EMAIL_SOFT_BOUNCED, EMAIL_COMPLAINED, EMAIL_OPENED, EMAIL_CLICKED, EMAIL_FAILED, EMAIL_SUPPRESSED, EMAIL_RECEIVED, PUSH_SENT, PUSH_DELIVERED, PUSH_FAILED, PUSH_EXPIRED, USER_CREATED, USER_LOGIN, USER_LOGOUT, USER_PASSWORD_CHANGED, USER_PASSWORD_RESET_REQUESTED, USER_EMAIL_VERIFIED, USER_PHONE_VERIFIED, USER_DELETED, USER_SESSION_REVOKED, USER_MFA_ENABLED, USER_MFA_DISABLED, USER_IMPERSONATED, DOMAIN_VERIFIED, DOMAIN_VERIFICATION_FAILED].freeze
     end
 
     # Builds the enum from string

data/spec/models/email_message_spec.rb

@@ -54,13 +54,19 @@ describe Zyphr::EmailMessage do
   describe 'test attribute "status"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "queued", "sent", "delivered", "failed", "bounced", "rejected", "suppressed"])
       # validator.allowable_values.each do |value|
       #   expect { instance.status = value }.not_to raise_error
       # end
     end
   end
 
+  describe 'test attribute "status_reason"' 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/

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.45'
+  s.version = '0.1.47'
   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.45
+  version: 0.1.47
 platform: ruby
 authors:
 - Zyphr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-31 00:00:00.000000000 Z
+date: 2026-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday