zyphr 0.1.27 → 0.1.30

data/docs/DomainsApi.md

@@ -0,0 +1,436 @@
+# Zyphr::DomainsApi
+
+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
+
+> <AddDomain200Response> add_domain(add_domain_request)
+
+Add a sending domain
+
+Register a new sending domain on the account. Returns the full set of DNS records that must be published before email can send from this domain.  **Idempotent:** calling this with a domain already registered on the current project returns the existing domain (200) instead of erroring, so re-runs from IaC tooling are safe. 
+
+### 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
+add_domain_request = Zyphr::AddDomainRequest.new({domain: 'sprint.example.com'}) # AddDomainRequest | 
+
+begin
+  # Add a sending domain
+  result = api_instance.add_domain(add_domain_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->add_domain: #{e}"
+end
+```
+
+#### Using the add_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddDomain200Response>, Integer, Hash)> add_domain_with_http_info(add_domain_request)
+
+```ruby
+begin
+  # Add a sending domain
+  data, status_code, headers = api_instance.add_domain_with_http_info(add_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddDomain200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->add_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_domain_request** | [**AddDomainRequest**](AddDomainRequest.md) |  |  |
+
+### Return type
+
+[**AddDomain200Response**](AddDomain200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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
+
+List sending domains
+
+List sending domains on the current project, with verification status and DNS records.
+
+### 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
+
+begin
+  # List sending domains
+  result = api_instance.list_domains
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->list_domains: #{e}"
+end
+```
+
+#### Using the list_domains_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DomainListResponse>, Integer, Hash)> list_domains_with_http_info
+
+```ruby
+begin
+  # List sending domains
+  data, status_code, headers = api_instance.list_domains_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DomainListResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling DomainsApi->list_domains_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DomainListResponse**](DomainListResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **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
+)
+```
+