zyphr 0.1.30 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66f94994637ec053fa5f9f8b06f18100b9b36cea273a621e829a96a9fb63380d
-  data.tar.gz: 5de6264f0d9351baf0366121f63beb2810fd386eec9b716ed9c9fe15acc0b5fd
+  metadata.gz: 160f65594ad461d4615c233b0b9e3ee82e5a84efb4692799fd2ca9e9554e2c45
+  data.tar.gz: ba9792dde4092f0b85ae6c068942209ac675d2e1078539d4c043e99e793080ae
 SHA512:
-  metadata.gz: 1d36f0b3a9ce887388fc0b44407952b92826388359df2f48137a7003818e4c0a03fe2c00502cc19c5f1ee49f39a50f4a1d6a89b0c93d59a5fc32035351855b01
-  data.tar.gz: 41e1288638d3924a86f1807dc9ac9ae08cdd5cb478699d2c3bba9592818e375d431f47e3bca0ad0850ca5076cce5d29a2c83637975a68dffca3449162270aa25
+  metadata.gz: 6fedd0c1e864abcc2cfcda379c1aa45c7b185b7c58d9b388a47388b1c31e464f7d421f0a882d0c6052a4b31cf5e74c9c821e90b1d2f18b4354587e04e554554a
+  data.tar.gz: 4c4fb0fc90ce7990d504393a5f34af6024eef05f9e93933bd647395ef3fc2040a820a59a3e6a699a384ab4e8e9124dc872f2fe9e8da11f8a6a4887540c3c18bc

data/README.md

@@ -192,12 +192,12 @@ Class | Method | HTTP request | Description
 *Zyphr::DevicesApi* | [**get_device_stats**](docs/DevicesApi.md#get_device_stats) | **GET** /devices/stats | Get device statistics
 *Zyphr::DevicesApi* | [**list_devices**](docs/DevicesApi.md#list_devices) | **GET** /devices | List devices
 *Zyphr::DevicesApi* | [**register_device**](docs/DevicesApi.md#register_device) | **POST** /devices | Register a device
-*Zyphr::DomainsApi* | [**add_domain**](docs/DomainsApi.md#add_domain) | **POST** /v1/domains | Add a sending domain
-*Zyphr::DomainsApi* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{id} | Remove a sending domain
-*Zyphr::DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /v1/domains/{id} | Get a sending domain
-*Zyphr::DomainsApi* | [**get_domain_verification_status**](docs/DomainsApi.md#get_domain_verification_status) | **GET** /v1/domains/{id}/verification-status | Get domain verification status
-*Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /v1/domains | List sending domains
-*Zyphr::DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /v1/domains/{id}/verify | Trigger domain verification
+*Zyphr::DomainsApi* | [**add_domain**](docs/DomainsApi.md#add_domain) | **POST** /domains | Add a sending domain
+*Zyphr::DomainsApi* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /domains/{id} | Remove a sending domain
+*Zyphr::DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain
+*Zyphr::DomainsApi* | [**get_domain_verification_status**](docs/DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status
+*Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List sending domains
+*Zyphr::DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification
 *Zyphr::EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Get email details
 *Zyphr::EmailsApi* | [**get_email_events**](docs/EmailsApi.md#get_email_events) | **GET** /emails/{id}/events | Get email events
 *Zyphr::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{id}/tracking | Get email tracking stats

data/docs/DomainResponse.md

@@ -11,7 +11,9 @@
 | **records_verified** | **Integer** | Count of `dns_records[]` entries with `verified=true` |  |
 | **records_total** | **Integer** | Total entries in `dns_records[]` |  |
 | **verification_token** | **String** | Token used for the verification TXT record (also visible in `dns_records[]`) | [optional] |
-| **verified_at** | **Time** | Timestamp when verification first succeeded | [optional] |
+| **ses_identity_status** | **String** | AWS SES identity-verification sub-status. Surfaced so callers can see WHY top-level `status` is still `pending` when all DNS records report `verified: true` — typically because SES DKIM propagation hasn't completed yet (can take a few minutes after DNS records land). Top-level `status` only flips to `verified` once both this and `ses_dkim_status` are `success`.  | [optional] |
+| **ses_dkim_status** | **String** | AWS SES DKIM verification sub-status. See `ses_identity_status`. | [optional] |
+| **verified_at** | **Time** | Timestamp when verification first succeeded. Cleared to null if status later reverts away from `verified` (e.g. DNS records observed but SES DKIM not yet propagated). | [optional] |
 | **last_checked_at** | **Time** | Timestamp of the most recent verification attempt | [optional] |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  | [optional] |
@@ -29,6 +31,8 @@ instance = Zyphr::DomainResponse.new(
   records_verified: 0,
   records_total: 6,
   verification_token: null,
+  ses_identity_status: null,
+  ses_dkim_status: null,
   verified_at: null,
   last_checked_at: null,
   created_at: null,

data/docs/DomainsApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**add_domain**](DomainsApi.md#add_domain) | **POST** /v1/domains | Add a sending domain |
-| [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{id} | Remove a sending domain |
-| [**get_domain**](DomainsApi.md#get_domain) | **GET** /v1/domains/{id} | Get a sending domain |
-| [**get_domain_verification_status**](DomainsApi.md#get_domain_verification_status) | **GET** /v1/domains/{id}/verification-status | Get domain verification status |
-| [**list_domains**](DomainsApi.md#list_domains) | **GET** /v1/domains | List sending domains |
-| [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /v1/domains/{id}/verify | Trigger domain verification |
+| [**add_domain**](DomainsApi.md#add_domain) | **POST** /domains | Add a sending domain |
+| [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /domains/{id} | Remove a sending domain |
+| [**get_domain**](DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain |
+| [**get_domain_verification_status**](DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status |
+| [**list_domains**](DomainsApi.md#list_domains) | **GET** /domains | List sending domains |
+| [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification |
 
 
 ## add_domain

data/lib/zyphr/api/domains_api.rb

@@ -43,7 +43,7 @@ module Zyphr
         fail ArgumentError, "Missing the required parameter 'add_domain_request' when calling DomainsApi.add_domain"
       end
       # resource path
-      local_var_path = '/v1/domains'
+      local_var_path = '/domains'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -111,7 +111,7 @@ module Zyphr
         fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.delete_domain"
       end
       # resource path
-      local_var_path = '/v1/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -174,7 +174,7 @@ module Zyphr
         fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.get_domain"
       end
       # resource path
-      local_var_path = '/v1/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -237,7 +237,7 @@ module Zyphr
         fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.get_domain_verification_status"
       end
       # resource path
-      local_var_path = '/v1/domains/{id}/verification-status'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/domains/{id}/verification-status'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -294,7 +294,7 @@ module Zyphr
         @api_client.config.logger.debug 'Calling API: DomainsApi.list_domains ...'
       end
       # resource path
-      local_var_path = '/v1/domains'
+      local_var_path = '/domains'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -357,7 +357,7 @@ module Zyphr
         fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.verify_domain"
       end
       # resource path
-      local_var_path = '/v1/domains/{id}/verify'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/domains/{id}/verify'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/zyphr/models/domain_response.rb

@@ -33,7 +33,13 @@ module Zyphr
     # Token used for the verification TXT record (also visible in `dns_records[]`)
     attr_accessor :verification_token
 
-    # Timestamp when verification first succeeded
+    # AWS SES identity-verification sub-status. Surfaced so callers can see WHY top-level `status` is still `pending` when all DNS records report `verified: true` — typically because SES DKIM propagation hasn't completed yet (can take a few minutes after DNS records land). Top-level `status` only flips to `verified` once both this and `ses_dkim_status` are `success`. 
+    attr_accessor :ses_identity_status
+
+    # AWS SES DKIM verification sub-status. See `ses_identity_status`.
+    attr_accessor :ses_dkim_status
+
+    # Timestamp when verification first succeeded. Cleared to null if status later reverts away from `verified` (e.g. DNS records observed but SES DKIM not yet propagated).
     attr_accessor :verified_at
 
     # Timestamp of the most recent verification attempt
@@ -75,6 +81,8 @@ module Zyphr
         :'records_verified' => :'records_verified',
         :'records_total' => :'records_total',
         :'verification_token' => :'verification_token',
+        :'ses_identity_status' => :'ses_identity_status',
+        :'ses_dkim_status' => :'ses_dkim_status',
         :'verified_at' => :'verified_at',
         :'last_checked_at' => :'last_checked_at',
         :'created_at' => :'created_at',
@@ -102,6 +110,8 @@ module Zyphr
         :'records_verified' => :'Integer',
         :'records_total' => :'Integer',
         :'verification_token' => :'String',
+        :'ses_identity_status' => :'String',
+        :'ses_dkim_status' => :'String',
         :'verified_at' => :'Time',
         :'last_checked_at' => :'Time',
         :'created_at' => :'Time',
@@ -175,6 +185,14 @@ module Zyphr
         self.verification_token = attributes[:'verification_token']
       end
 
+      if attributes.key?(:'ses_identity_status')
+        self.ses_identity_status = attributes[:'ses_identity_status']
+      end
+
+      if attributes.key?(:'ses_dkim_status')
+        self.ses_dkim_status = attributes[:'ses_dkim_status']
+      end
+
       if attributes.key?(:'verified_at')
         self.verified_at = attributes[:'verified_at']
       end
@@ -242,6 +260,10 @@ module Zyphr
       return false if @dns_records.nil?
       return false if @records_verified.nil?
       return false if @records_total.nil?
+      ses_identity_status_validator = EnumAttributeValidator.new('String', ["pending", "success", "failed", "temporary_failure", "not_started"])
+      return false unless ses_identity_status_validator.valid?(@ses_identity_status)
+      ses_dkim_status_validator = EnumAttributeValidator.new('String', ["pending", "success", "failed", "temporary_failure", "not_started"])
+      return false unless ses_dkim_status_validator.valid?(@ses_dkim_status)
       return false if @created_at.nil?
       true
     end
@@ -306,6 +328,26 @@ module Zyphr
       @records_total = records_total
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ses_identity_status Object to be assigned
+    def ses_identity_status=(ses_identity_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "success", "failed", "temporary_failure", "not_started"])
+      unless validator.valid?(ses_identity_status)
+        fail ArgumentError, "invalid value for \"ses_identity_status\", must be one of #{validator.allowable_values}."
+      end
+      @ses_identity_status = ses_identity_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ses_dkim_status Object to be assigned
+    def ses_dkim_status=(ses_dkim_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "success", "failed", "temporary_failure", "not_started"])
+      unless validator.valid?(ses_dkim_status)
+        fail ArgumentError, "invalid value for \"ses_dkim_status\", must be one of #{validator.allowable_values}."
+      end
+      @ses_dkim_status = ses_dkim_status
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -328,6 +370,8 @@ module Zyphr
           records_verified == o.records_verified &&
           records_total == o.records_total &&
           verification_token == o.verification_token &&
+          ses_identity_status == o.ses_identity_status &&
+          ses_dkim_status == o.ses_dkim_status &&
           verified_at == o.verified_at &&
           last_checked_at == o.last_checked_at &&
           created_at == o.created_at &&
@@ -343,7 +387,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, domain, status, dns_records, records_verified, records_total, verification_token, verified_at, last_checked_at, created_at, updated_at].hash
+      [id, domain, status, dns_records, records_verified, records_total, verification_token, ses_identity_status, ses_dkim_status, verified_at, last_checked_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/spec/models/domain_response_spec.rb

@@ -73,6 +73,26 @@ describe Zyphr::DomainResponse do
     end
   end
 
+  describe 'test attribute "ses_identity_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", "success", "failed", "temporary_failure", "not_started"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.ses_identity_status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "ses_dkim_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", "success", "failed", "temporary_failure", "not_started"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.ses_dkim_status = value }.not_to raise_error
+      # end
+    end
+  end
+
   describe 'test attribute "verified_at"' 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.30'
+  s.version = '0.1.32'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.1.32
 platform: ruby
 authors:
 - Zyphr