zyphr 0.1.31 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13105132a3b74de40f61e28fea625febb8d519847ca75de7c92db81484d74947
-  data.tar.gz: ac2f6c5662e5ce834c23ea898446dda8d1077595999d0e8ecbca90feb690a972
+  metadata.gz: 160f65594ad461d4615c233b0b9e3ee82e5a84efb4692799fd2ca9e9554e2c45
+  data.tar.gz: ba9792dde4092f0b85ae6c068942209ac675d2e1078539d4c043e99e793080ae
 SHA512:
-  metadata.gz: c9556352fd88d718cb012929ffaa8929d681e12c285cca0021fa5fe31ab9bc2dc04888d826c756dfd1394f3ca84e42540b2f2623d6022d75258f60cf5a29711f
-  data.tar.gz: 30b86c16eed45cc97e9be69de2daf79bb92fdfe7ccadd31057d3900f2688c8d9aa09e768524a9d1288d5cbc74be553eec9457bed6cc64d8c345e1d9a801a60bf
+  metadata.gz: 6fedd0c1e864abcc2cfcda379c1aa45c7b185b7c58d9b388a47388b1c31e464f7d421f0a882d0c6052a4b31cf5e74c9c821e90b1d2f18b4354587e04e554554a
+  data.tar.gz: 4c4fb0fc90ce7990d504393a5f34af6024eef05f9e93933bd647395ef3fc2040a820a59a3e6a699a384ab4e8e9124dc872f2fe9e8da11f8a6a4887540c3c18bc

data/README.md

@@ -193,7 +193,11 @@ Class | Method | HTTP request | Description
 *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** /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
@@ -404,6 +408,8 @@ Class | Method | HTTP request | Description
  - [Zyphr::CreateWaaSEventType201Response](docs/CreateWaaSEventType201Response.md)
  - [Zyphr::CreateWaaSEventTypeRequest](docs/CreateWaaSEventTypeRequest.md)
  - [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
+ - [Zyphr::DeleteDomainResponse](docs/DeleteDomainResponse.md)
+ - [Zyphr::DeleteDomainResponseData](docs/DeleteDomainResponseData.md)
  - [Zyphr::DeleteResult](docs/DeleteResult.md)
  - [Zyphr::DeleteResultData](docs/DeleteResultData.md)
  - [Zyphr::Device](docs/Device.md)
@@ -442,6 +448,8 @@ Class | Method | HTTP request | Description
  - [Zyphr::GenerateSubscriberToken200ResponseData](docs/GenerateSubscriberToken200ResponseData.md)
  - [Zyphr::GenerateSubscriberTokenRequest](docs/GenerateSubscriberTokenRequest.md)
  - [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
+ - [Zyphr::GetDomain200Response](docs/GetDomain200Response.md)
+ - [Zyphr::GetDomain200ResponseMeta](docs/GetDomain200ResponseMeta.md)
  - [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
  - [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
  - [Zyphr::InAppNotification](docs/InAppNotification.md)
@@ -654,6 +662,10 @@ Class | Method | HTTP request | Description
  - [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
  - [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
  - [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
+ - [Zyphr::VerificationStatusResponse](docs/VerificationStatusResponse.md)
+ - [Zyphr::VerificationStatusResponseData](docs/VerificationStatusResponseData.md)
+ - [Zyphr::VerifyDomainResponse](docs/VerifyDomainResponse.md)
+ - [Zyphr::VerifyDomainResponseData](docs/VerifyDomainResponseData.md)
  - [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
  - [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
  - [Zyphr::WaaSApplication](docs/WaaSApplication.md)

data/docs/DeleteDomainResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::DeleteDomainResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**DeleteDomainResponseData**](DeleteDomainResponseData.md) |  |  |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::DeleteDomainResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/DeleteDomainResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::DeleteDomainResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::DeleteDomainResponseData.new(
+  id: null,
+  deleted: true
+)
+```
+

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

@@ -5,7 +5,11 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**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
@@ -79,6 +83,219 @@ end
 - **Accept**: application/json
 
 
+## delete_domain
+
+> <DeleteDomainResponse> delete_domain(id)
+
+Remove a sending domain
+
+Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::DomainsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Remove a sending domain
+  result = api_instance.delete_domain(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->delete_domain: #{e}"
+end
+```
+
+#### Using the delete_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteDomainResponse>, Integer, Hash)> delete_domain_with_http_info(id)
+
+```ruby
+begin
+  # Remove a sending domain
+  data, status_code, headers = api_instance.delete_domain_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteDomainResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**DeleteDomainResponse**](DeleteDomainResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_domain
+
+> <GetDomain200Response> get_domain(id)
+
+Get a sending domain
+
+Retrieve a single sending domain by ID, including DNS records and verification counters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::DomainsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a sending domain
+  result = api_instance.get_domain(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->get_domain: #{e}"
+end
+```
+
+#### Using the get_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetDomain200Response>, Integer, Hash)> get_domain_with_http_info(id)
+
+```ruby
+begin
+  # Get a sending domain
+  data, status_code, headers = api_instance.get_domain_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetDomain200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->get_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetDomain200Response**](GetDomain200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_domain_verification_status
+
+> <VerificationStatusResponse> get_domain_verification_status(id)
+
+Get domain verification status
+
+Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::DomainsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Domain ID
+
+begin
+  # Get domain verification status
+  result = api_instance.get_domain_verification_status(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->get_domain_verification_status: #{e}"
+end
+```
+
+#### Using the get_domain_verification_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerificationStatusResponse>, Integer, Hash)> get_domain_verification_status_with_http_info(id)
+
+```ruby
+begin
+  # Get domain verification status
+  data, status_code, headers = api_instance.get_domain_verification_status_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerificationStatusResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->get_domain_verification_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Domain ID |  |
+
+### Return type
+
+[**VerificationStatusResponse**](VerificationStatusResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_domains
 
 > <DomainListResponse> list_domains
@@ -146,3 +363,74 @@ This endpoint does not need any parameter.
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## verify_domain
+
+> <VerifyDomainResponse> verify_domain(id)
+
+Trigger domain verification
+
+Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships.  Returns 409 if a verification is already in progress for this domain (within the last 2 minutes). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::DomainsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Trigger domain verification
+  result = api_instance.verify_domain(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->verify_domain: #{e}"
+end
+```
+
+#### Using the verify_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyDomainResponse>, Integer, Hash)> verify_domain_with_http_info(id)
+
+```ruby
+begin
+  # Trigger domain verification
+  data, status_code, headers = api_instance.verify_domain_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyDomainResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->verify_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**VerifyDomainResponse**](VerifyDomainResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GetDomain200Response.md

@@ -0,0 +1,20 @@
+# Zyphr::GetDomain200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**DomainResponse**](DomainResponse.md) |  | [optional] |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetDomain200Response.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetDomain200ResponseMeta.md

@@ -0,0 +1,18 @@
+# Zyphr::GetDomain200ResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::GetDomain200ResponseMeta.new(
+  request_id: null
+)
+```
+

data/docs/VerificationStatusResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::VerificationStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**VerificationStatusResponseData**](VerificationStatusResponseData.md) |  |  |
+| **meta** | [**GetDomain200ResponseMeta**](GetDomain200ResponseMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerificationStatusResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/VerificationStatusResponseData.md

@@ -0,0 +1,32 @@
+# Zyphr::VerificationStatusResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** |  |  |
+| **domain** | **String** |  |  |
+| **status** | **String** |  |  |
+| **records_verified** | **Integer** |  |  |
+| **records_total** | **Integer** |  |  |
+| **progress** | **Hash<String, Object>** | Internal verification progress detail | [optional] |
+| **dns_records** | [**Array<DnsRecord>**](DnsRecord.md) |  |  |
+| **last_checked_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerificationStatusResponseData.new(
+  domain_id: null,
+  domain: null,
+  status: null,
+  records_verified: null,
+  records_total: null,
+  progress: null,
+  dns_records: null,
+  last_checked_at: null
+)
+```
+

data/docs/VerifyDomainResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::VerifyDomainResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**VerifyDomainResponseData**](VerifyDomainResponseData.md) |  |  |
+| **meta** | [**AddDomain200ResponseMeta**](AddDomain200ResponseMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerifyDomainResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/VerifyDomainResponseData.md

@@ -0,0 +1,24 @@
+# Zyphr::VerifyDomainResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **domain_id** | **String** |  |  |
+| **domain** | **String** |  |  |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerifyDomainResponseData.new(
+  job_id: null,
+  domain_id: null,
+  domain: null,
+  status: null
+)
+```
+