zyphr 0.1.27 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c0048f5a4a2294ad94e431346bc3e1f65d4c9d5e746f53e4ee57f05cfe7222c
-  data.tar.gz: a75783ec342d8e8e6780dd571c3fb59b11b76b232707fa9175a97596fb466452
+  metadata.gz: 66f94994637ec053fa5f9f8b06f18100b9b36cea273a621e829a96a9fb63380d
+  data.tar.gz: 5de6264f0d9351baf0366121f63beb2810fd386eec9b716ed9c9fe15acc0b5fd
 SHA512:
-  metadata.gz: dffd78d2a8a86b4f7c7314136bbc24fb0420b6f0e828b8a6d666c27f7bb520fc4a13040afee24fd8ad8fd661e780a15d604d9f96d18eddfbfbf96d30dd607f9e
-  data.tar.gz: 4435f2a1a9838d32d6e6ef3f44ebd0780df9972359211b4dcf3bab8bccad936fb2df80f88cdda41f87a6ff3777411eb950ba55f437e4f7e0579f70847da445e9
+  metadata.gz: 1d36f0b3a9ce887388fc0b44407952b92826388359df2f48137a7003818e4c0a03fe2c00502cc19c5f1ee49f39a50f4a1d6a89b0c93d59a5fc32035351855b01
+  data.tar.gz: 41e1288638d3924a86f1807dc9ac9ae08cdd5cb478699d2c3bba9592818e375d431f47e3bca0ad0850ca5076cce5d29a2c83637975a68dffca3449162270aa25

data/README.md

@@ -192,6 +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::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
@@ -333,6 +339,9 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [Zyphr::AddDomain200Response](docs/AddDomain200Response.md)
+ - [Zyphr::AddDomain200ResponseMeta](docs/AddDomain200ResponseMeta.md)
+ - [Zyphr::AddDomainRequest](docs/AddDomainRequest.md)
  - [Zyphr::AddTopicSubscribersRequest](docs/AddTopicSubscribersRequest.md)
  - [Zyphr::ApiError](docs/ApiError.md)
  - [Zyphr::ApiErrorError](docs/ApiErrorError.md)
@@ -399,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)
@@ -409,6 +420,10 @@ Class | Method | HTTP request | Description
  - [Zyphr::DeviceResponse](docs/DeviceResponse.md)
  - [Zyphr::DeviceStats](docs/DeviceStats.md)
  - [Zyphr::DeviceStatsResponse](docs/DeviceStatsResponse.md)
+ - [Zyphr::DnsRecord](docs/DnsRecord.md)
+ - [Zyphr::DomainListResponse](docs/DomainListResponse.md)
+ - [Zyphr::DomainListResponseMeta](docs/DomainListResponseMeta.md)
+ - [Zyphr::DomainResponse](docs/DomainResponse.md)
  - [Zyphr::EmailAddress](docs/EmailAddress.md)
  - [Zyphr::EmailAttachment](docs/EmailAttachment.md)
  - [Zyphr::EmailEvent](docs/EmailEvent.md)
@@ -433,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)
@@ -645,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/AddDomain200Response.md

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

data/docs/AddDomain200ResponseMeta.md

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

data/docs/AddDomainRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::AddDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The sending domain to add (will be lowercased and trimmed) |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AddDomainRequest.new(
+  domain: sprint.example.com
+)
+```
+

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/DnsRecord.md

@@ -0,0 +1,26 @@
+# Zyphr::DnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | DNS record type |  |
+| **name** | **String** | DNS record name (host) |  |
+| **value** | **String** | DNS record value |  |
+| **purpose** | **String** | What this record is for — useful for partial failure reasoning (e.g. \"SPF verified, DKIM #2 still pending\") instead of treating the set as opaque.  |  |
+| **verified** | **Boolean** | Whether this specific record has been observed in DNS |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::DnsRecord.new(
+  type: TXT,
+  name: _zyphr.sprint.example.com,
+  value: zyphr-verify-a58965815e2dcbacd2c7ecfdd2f342e6,
+  purpose: domain_verification,
+  verified: false
+)
+```
+

data/docs/DomainListResponse.md

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

data/docs/DomainListResponseMeta.md

@@ -0,0 +1,24 @@
+# Zyphr::DomainListResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+| **count** | **Integer** | Account-wide domain count (across all projects) | [optional] |
+| **limit** | **Integer** | Per-account domain limit from the current plan | [optional] |
+| **plan** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::DomainListResponseMeta.new(
+  request_id: null,
+  count: null,
+  limit: null,
+  plan: null
+)
+```
+

data/docs/DomainResponse.md

@@ -0,0 +1,38 @@
+# Zyphr::DomainResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **domain** | **String** | The sending domain |  |
+| **status** | **String** |  |  |
+| **dns_records** | [**Array<DnsRecord>**](DnsRecord.md) |  |  |
+| **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] |
+| **last_checked_at** | **Time** | Timestamp of the most recent verification attempt | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::DomainResponse.new(
+  id: 6dd58837-4e2d-4f0c-9b3a-1f2e3a4b5c6d,
+  domain: sprint.example.com,
+  status: pending,
+  dns_records: null,
+  records_verified: 0,
+  records_total: 6,
+  verification_token: null,
+  verified_at: null,
+  last_checked_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+