sendpost_ruby_sdk 2.0.2 → 3.0.0

data/docs/DnsRecord.md

@@ -0,0 +1,22 @@
+# Sendpost::DnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | The DNS hostname where this record should be created | [optional] |
+| **type** | **String** | The DNS record type (TXT or CNAME) | [optional] |
+| **text_value** | **String** | The value to set for this DNS record | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::DnsRecord.new(
+  host: sp-dkim._domainkey.example.com,
+  type: TXT,
+  text_value: v=DKIM1;k=rsa;p=MIGfMA0GCSqGSIb3D...
+)
+```
+

data/docs/Domain.md

@@ -4,26 +4,24 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the domain. | [optional] |
-| **name** | **String** | Name of the domain. | [optional] |
-| **dkim** | [**DomainDkim**](DomainDkim.md) |  | [optional] |
-| **return_path** | [**DomainReturnPath**](DomainReturnPath.md) |  | [optional] |
-| **track** | [**DomainTrack**](DomainTrack.md) |  | [optional] |
-| **dmarc** | [**DomainDmarc**](DomainDmarc.md) |  | [optional] |
-| **dkim_config** | **String** | DKIM configuration | [optional] |
-| **dkim_verified** | **Boolean** | Status of DKIM verification ( true or false ) | [optional] |
-| **dmarc_verified** | **Boolean** | Status of DMARC verification ( true or false) | [optional] |
-| **return_path_verified** | **Boolean** | Status of ReturnPath verification ( true or false ) | [optional] |
-| **track_verified** | **Boolean** | Status of Track verification ( true or false ) | [optional] |
-| **verified** | **Boolean** | Overall verification status of the domain | [optional] |
-| **domain_registered_date** | **String** | Date when the domain was registered | [optional] |
-| **created** | **Integer** | UNIX epoch timestamp in nanoseconds. | [optional] |
-| **gpt_verified** | **Boolean** | Status of GPT verification ( true or false ) | [optional] |
-| **gpt** | [**DomainGpt**](DomainGpt.md) |  | [optional] |
-| **dmarc_failure_reason** | **String** | Reason for DMARC verification failure | [optional] |
-| **dkim_failure_reason** | **String** | Reason for DKIM verification failure | [optional] |
-| **track_failure_reason** | **String** | Reason for Track verification failure | [optional] |
-| **return_path_failure_reason** | **String** | Reason for ReturnPath verification failure | [optional] |
+| **id** | **Integer** | Unique identifier for the domain | [optional] |
+| **name** | **String** | The domain name (e.g., \"example.com\"). This is the domain portion of your sending email addresses.  | [optional] |
+| **dns_provider** | **String** | Auto-detected DNS provider for this domain (e.g. \"cloudflare\", \"other\"), used to tailor DNS-setup instructions. Read-only.  | [optional] |
+| **dkim** | [**DnsRecord**](DnsRecord.md) | DKIM (DomainKeys Identified Mail) DNS record configuration. DKIM cryptographically signs your emails to verify they haven't been tampered with. This is REQUIRED for sending emails.  | [optional] |
+| **return_path** | [**DnsRecord**](DnsRecord.md) | Return-Path (bounce handling) DNS record configuration. Configuring this allows bounce notifications to be properly routed through SendPost. RECOMMENDED for better deliverability.  | [optional] |
+| **track** | [**DnsRecord**](DnsRecord.md) | Tracking domain DNS record configuration. When configured, click tracking links use your domain instead of SendPost's domain. RECOMMENDED for brand consistency and improved click-through rates.  | [optional] |
+| **dmarc** | [**DnsRecord**](DnsRecord.md) | DMARC (Domain-based Message Authentication, Reporting & Conformance) DNS record. DMARC builds on DKIM and SPF to provide email authentication and reporting. RECOMMENDED for enterprise senders.  | [optional] |
+| **dkim_verified** | **Boolean** | Whether the DKIM DNS record has been verified successfully | [optional] |
+| **dmarc_verified** | **Boolean** | Whether the DMARC DNS record has been verified successfully | [optional] |
+| **return_path_verified** | **Boolean** | Whether the Return-Path DNS record has been verified successfully | [optional] |
+| **track_verified** | **Boolean** | Whether the tracking domain DNS record has been verified successfully | [optional] |
+| **verified** | **Boolean** | Overall verification status. True only if DKIM is verified (minimum requirement). For full verification, configure all DNS records.  | [optional] |
+| **domain_registered_date** | **Date** | Date when this domain was originally registered (from WHOIS). Newer domains may have lower sender reputation initially.  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the domain was added to SendPost | [optional] |
+| **dkim_failure_reason** | **String** | Detailed reason if DKIM verification failed (empty if verified or not attempted) | [optional] |
+| **dmarc_failure_reason** | **String** | Detailed reason if DMARC verification failed | [optional] |
+| **track_failure_reason** | **String** | Detailed reason if tracking domain verification failed | [optional] |
+| **return_path_failure_reason** | **String** | Detailed reason if Return-Path verification failed | [optional] |
 
 ## Example
 
@@ -33,22 +31,20 @@ require 'sendpost_ruby_sdk'
 instance = Sendpost::Domain.new(
   id: 117,
   name: piedpiper.com,
+  dns_provider: cloudflare,
   dkim: null,
   return_path: null,
   track: null,
   dmarc: null,
-  dkim_config: null,
-  dkim_verified: false,
+  dkim_verified: true,
   dmarc_verified: false,
-  return_path_verified: false,
+  return_path_verified: true,
   track_verified: true,
-  verified: false,
+  verified: true,
   domain_registered_date: 1995-08-14,
-  created: 1766394250613907000,
-  gpt_verified: false,
-  gpt: null,
+  created: 1704067200000000000,
+  dkim_failure_reason: DNS record not found. Please add the TXT record to your DNS provider.,
   dmarc_failure_reason: ,
-  dkim_failure_reason: ,
   track_failure_reason: ,
   return_path_failure_reason: 
 )

data/docs/DomainApi.md

@@ -4,19 +4,19 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_sub_account_domain**](DomainApi.md#create_sub_account_domain) | **POST** /subaccount/domain | Create Domain |
+| [**delete_sub_account_domain**](DomainApi.md#delete_sub_account_domain) | **DELETE** /subaccount/domain/{domain_id} | Delete Domain |
 | [**get_all_domains**](DomainApi.md#get_all_domains) | **GET** /subaccount/domain | List Domains |
-| [**subaccount_domain_domain_id_delete**](DomainApi.md#subaccount_domain_domain_id_delete) | **DELETE** /subaccount/domain/{domain_id} | Delete Domain |
-| [**subaccount_domain_domain_id_get**](DomainApi.md#subaccount_domain_domain_id_get) | **GET** /subaccount/domain/{domain_id} | Get Domain |
-| [**subaccount_domain_post**](DomainApi.md#subaccount_domain_post) | **POST** /subaccount/domain | Create Domain |
+| [**get_sub_account_domain**](DomainApi.md#get_sub_account_domain) | **GET** /subaccount/domain/{domain_id} | Get Domain |
 
 
-## get_all_domains
+## create_sub_account_domain
 
-> <Array<Domain>> get_all_domains(opts)
+> <Domain> create_sub_account_domain(create_domain_request)
 
-List Domains
+Create Domain
 
-Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status. 
+Register a new sending domain with SendPost. After creation, you'll receive DNS records that must be configured with your DNS provider before you can send emails.  **Domain Setup Process:** 1. Call this endpoint with your domain name 2. Copy the returned DNS records (DKIM, Return-Path, Track, DMARC) 3. Add records to your DNS provider (GoDaddy, Cloudflare, Route53, etc.) 4. Wait for DNS propagation (typically 15 minutes to 48 hours) 5. Verification happens automatically, or trigger manual verification  **DNS Records Explained:** | Record | Purpose | Required | |--------|---------|----------| | DKIM | Cryptographically signs emails to prove authenticity | Yes | | Return-Path | Routes bounce notifications through SendPost | Recommended | | Track | Enables click tracking with your domain | Optional | | DMARC | Adds additional authentication layer | Recommended |  **Best Practices:** - Use a subdomain like `mail.yourdomain.com` for sending - Keep your root domain for your website - Configure all records for best deliverability 
 
 ### Examples
 
@@ -32,36 +32,32 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::DomainApi.new
-opts = {
-  limit: 56, # Integer | Number of records to return per request
-  offset: 56, # Integer | Number of initial records to skip
-  search: 'search_example' # String | Case insensitive search against domain names
-}
+create_domain_request = Sendpost::CreateDomainRequest.new({name: 'piedpiper.com'}) # CreateDomainRequest | 
 
 begin
-  # List Domains
-  result = api_instance.get_all_domains(opts)
+  # Create Domain
+  result = api_instance.create_sub_account_domain(create_domain_request)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->get_all_domains: #{e}"
+  puts "Error when calling DomainApi->create_sub_account_domain: #{e}"
 end
 ```
 
-#### Using the get_all_domains_with_http_info variant
+#### Using the create_sub_account_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<Domain>>, Integer, Hash)> get_all_domains_with_http_info(opts)
+> <Array(<Domain>, Integer, Hash)> create_sub_account_domain_with_http_info(create_domain_request)
 
 ```ruby
 begin
-  # List Domains
-  data, status_code, headers = api_instance.get_all_domains_with_http_info(opts)
+  # Create Domain
+  data, status_code, headers = api_instance.create_sub_account_domain_with_http_info(create_domain_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<Domain>>
+  p data # => <Domain>
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->get_all_domains_with_http_info: #{e}"
+  puts "Error when calling DomainApi->create_sub_account_domain_with_http_info: #{e}"
 end
 ```
 
@@ -69,13 +65,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **limit** | **Integer** | Number of records to return per request | [optional] |
-| **offset** | **Integer** | Number of initial records to skip | [optional] |
-| **search** | **String** | Case insensitive search against domain names | [optional] |
+| **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md) |  |  |
 
 ### Return type
 
-[**Array&lt;Domain&gt;**](Domain.md)
+[**Domain**](Domain.md)
 
 ### Authorization
 
@@ -83,17 +77,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
-## subaccount_domain_domain_id_delete
+## delete_sub_account_domain
 
-> <DeleteResponse> subaccount_domain_domain_id_delete(domain_id)
+> <DeleteResponse> delete_sub_account_domain(domain_id)
 
 Delete Domain
 
-Delete a specific domain using its `id`.
+Remove a sending domain from your sub-account. Once deleted, you can no longer send emails from addresses on this domain.  **Before Deleting:** - Ensure no active email campaigns use this domain - Update sender addresses in your applications - Consider impact on email deliverability  **Note:** DNS records for the domain will become orphaned. You may want to remove them from your DNS provider. 
 
 ### Examples
 
@@ -113,28 +107,28 @@ domain_id = 'domain_id_example' # String | The unique ID of the domain to delete
 
 begin
   # Delete Domain
-  result = api_instance.subaccount_domain_domain_id_delete(domain_id)
+  result = api_instance.delete_sub_account_domain(domain_id)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_domain_id_delete: #{e}"
+  puts "Error when calling DomainApi->delete_sub_account_domain: #{e}"
 end
 ```
 
-#### Using the subaccount_domain_domain_id_delete_with_http_info variant
+#### Using the delete_sub_account_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<DeleteResponse>, Integer, Hash)> subaccount_domain_domain_id_delete_with_http_info(domain_id)
+> <Array(<DeleteResponse>, Integer, Hash)> delete_sub_account_domain_with_http_info(domain_id)
 
 ```ruby
 begin
   # Delete Domain
-  data, status_code, headers = api_instance.subaccount_domain_domain_id_delete_with_http_info(domain_id)
+  data, status_code, headers = api_instance.delete_sub_account_domain_with_http_info(domain_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeleteResponse>
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_domain_id_delete_with_http_info: #{e}"
+  puts "Error when calling DomainApi->delete_sub_account_domain_with_http_info: #{e}"
 end
 ```
 
@@ -158,13 +152,13 @@ end
 - **Accept**: application/json
 
 
-## subaccount_domain_domain_id_get
+## get_all_domains
 
-> <Domain> subaccount_domain_domain_id_get(domain_id)
+> <Array<Domain>> get_all_domains(opts)
 
-Get Domain
+List Domains
 
-Retrieve details of a specific domain using its `id`.
+Retrieve all sending domains configured for this sub-account. Use this endpoint to audit your domain setup, check verification status, or retrieve DNS records for configuration.  **Each domain record includes:** - Domain name and unique ID - DNS records to configure (DKIM, Return-Path, Track, DMARC) - Verification status for each record type - Failure messages for troubleshooting - Creation timestamp  **Verification Status Values:** - `true` - Record verified and active - `false` - Record not verified (check DNS configuration)  **Use Cases:** - Audit all configured sending domains - Export DNS records for documentation - Identify domains pending verification - Monitor domain health across multiple domains  **Pagination:** Use `limit` and `offset` for large domain lists. 
 
 ### Examples
 
@@ -180,32 +174,36 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::DomainApi.new
-domain_id = 'domain_id_example' # String | The unique ID of the domain to retrieve.
+opts = {
+  limit: 20, # Integer | Number of records to return per request. Default is 20.
+  offset: 0, # Integer | Number of initial records to skip for pagination.
+  search: 'mycompany' # String | Case insensitive search against domain names. Useful for finding specific domains in large lists.
+}
 
 begin
-  # Get Domain
-  result = api_instance.subaccount_domain_domain_id_get(domain_id)
+  # List Domains
+  result = api_instance.get_all_domains(opts)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_domain_id_get: #{e}"
+  puts "Error when calling DomainApi->get_all_domains: #{e}"
 end
 ```
 
-#### Using the subaccount_domain_domain_id_get_with_http_info variant
+#### Using the get_all_domains_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> subaccount_domain_domain_id_get_with_http_info(domain_id)
+> <Array(<Array<Domain>>, Integer, Hash)> get_all_domains_with_http_info(opts)
 
 ```ruby
 begin
-  # Get Domain
-  data, status_code, headers = api_instance.subaccount_domain_domain_id_get_with_http_info(domain_id)
+  # List Domains
+  data, status_code, headers = api_instance.get_all_domains_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Domain>
+  p data # => <Array<Domain>>
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_domain_id_get_with_http_info: #{e}"
+  puts "Error when calling DomainApi->get_all_domains_with_http_info: #{e}"
 end
 ```
 
@@ -213,11 +211,13 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **domain_id** | **String** | The unique ID of the domain to retrieve. |  |
+| **limit** | **Integer** | Number of records to return per request. Default is 20. | [optional][default to 20] |
+| **offset** | **Integer** | Number of initial records to skip for pagination. | [optional][default to 0] |
+| **search** | **String** | Case insensitive search against domain names. Useful for finding specific domains in large lists. | [optional] |
 
 ### Return type
 
-[**Domain**](Domain.md)
+[**Array&lt;Domain&gt;**](Domain.md)
 
 ### Authorization
 
@@ -229,13 +229,13 @@ end
 - **Accept**: application/json
 
 
-## subaccount_domain_post
+## get_sub_account_domain
 
-> <Domain> subaccount_domain_post(create_domain_request)
+> <Domain> get_sub_account_domain(domain_id)
 
-Create Domain
+Get Domain
 
-Add a new domain using its `name`.
+Retrieve detailed information about a specific sending domain, including DNS record configuration and verification status.  **Response includes:** - Domain name and ID - DKIM, Return-Path, Track, and DMARC DNS records to configure - Verification status for each record type - Failure reasons if verification failed - Domain registration date  **Use Cases:** - Check verification status before sending emails - Retrieve DNS records during domain setup - Debug DNS configuration issues - Audit domain settings for compliance 
 
 ### Examples
 
@@ -251,32 +251,32 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::DomainApi.new
-create_domain_request = Sendpost::CreateDomainRequest.new # CreateDomainRequest | 
+domain_id = 'domain_id_example' # String | The unique ID of the domain to retrieve.
 
 begin
-  # Create Domain
-  result = api_instance.subaccount_domain_post(create_domain_request)
+  # Get Domain
+  result = api_instance.get_sub_account_domain(domain_id)
   p result
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_post: #{e}"
+  puts "Error when calling DomainApi->get_sub_account_domain: #{e}"
 end
 ```
 
-#### Using the subaccount_domain_post_with_http_info variant
+#### Using the get_sub_account_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> subaccount_domain_post_with_http_info(create_domain_request)
+> <Array(<Domain>, Integer, Hash)> get_sub_account_domain_with_http_info(domain_id)
 
 ```ruby
 begin
-  # Create Domain
-  data, status_code, headers = api_instance.subaccount_domain_post_with_http_info(create_domain_request)
+  # Get Domain
+  data, status_code, headers = api_instance.get_sub_account_domain_with_http_info(domain_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domain>
 rescue Sendpost::ApiError => e
-  puts "Error when calling DomainApi->subaccount_domain_post_with_http_info: #{e}"
+  puts "Error when calling DomainApi->get_sub_account_domain_with_http_info: #{e}"
 end
 ```
 
@@ -284,7 +284,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md) |  |  |
+| **domain_id** | **String** | The unique ID of the domain to retrieve. |  |
 
 ### Return type
 
@@ -296,6 +296,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 

data/docs/DomainStat.md

@@ -0,0 +1,46 @@
+# Sendpost::DomainStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **processed** | **Integer** | Total number of emails accepted by SendPost API for processing. This is the starting point - all emails submitted through the API.  | [optional] |
+| **sent** | **Integer** | Number of emails sent to recipient mail servers. sent = processed - dropped - smtpDropped  | [optional] |
+| **dropped** | **Integer** | Number of emails dropped before sending. Common reasons: - Recipient email in suppression list (hard bounce, spam complaint, unsubscribe) - Invalid recipient email format - Sender domain not verified  | [optional] |
+| **smtp_dropped** | **Integer** | Number of emails dropped at SMTP level due to policy violations or rate limiting by the receiving server before delivery attempt completed.  | [optional] |
+| **delivered** | **Integer** | Number of emails successfully delivered to recipient mail servers. Note: Delivered means accepted by the server, not necessarily in inbox.  | [optional] |
+| **soft_bounced** | **Integer** | Number of temporary delivery failures (soft bounces). Common causes: - Recipient mailbox full - Server temporarily unavailable - Message too large SendPost automatically retries soft bounces.  | [optional] |
+| **hard_bounced** | **Integer** | Number of permanent delivery failures (hard bounces). Common causes: - Recipient email doesn't exist - Domain doesn't exist - Recipient has blocked sender Hard bounced addresses are automatically added to suppression list.  | [optional] |
+| **opened** | **Integer** | Number of emails opened (tracking pixel loaded). Requires trackOpens=true. Note: Some email clients block tracking pixels.  | [optional] |
+| **clicked** | **Integer** | Number of emails with at least one link clicked. Requires trackClicks=true.  | [optional] |
+| **unsubscribed** | **Integer** | Number of recipients who clicked the unsubscribe link. Unsubscribed addresses are automatically added to suppression list.  | [optional] |
+| **spam** | **Integer** | Number of spam complaints (recipient marked email as spam). High spam rates can severely impact your sender reputation. Target: Keep spam rate below 0.1%.  | [optional] |
+| **domain_id** | **Integer** | Unique identifier of the domain record. | [optional] |
+| **domain** | **String** | The sending domain these statistics belong to. | [optional] |
+| **domain_registered_date** | **String** | Date the domain was registered/verified in SendPost (YYYY-MM-DD). | [optional] |
+| **throttled** | **Boolean** | Whether sending on this domain is currently throttled. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::DomainStat.new(
+  processed: 225,
+  sent: 220,
+  dropped: 10,
+  smtp_dropped: 5,
+  delivered: 200,
+  soft_bounced: 5,
+  hard_bounced: 10,
+  opened: 150,
+  clicked: 50,
+  unsubscribed: 6,
+  spam: 2,
+  domain_id: 12,
+  domain: mail.hooli.com,
+  domain_registered_date: 2023-06-01,
+  throttled: false
+)
+```
+

data/docs/EIP.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_ip** | **String** | list of IP resources which are a part of the IP Pool containing public IP information. Note that the IPs specified in the IPPool should have been allocated in advance for your account |  |
+| **public_ip** | **String** | Public IPv4 address to include in the IP pool. The IP must already be allocated to your account.  |  |
 
 ## Example
 

data/docs/EmailAddress.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
+| **email** | **String** | The email address (must be a valid email format) |  |
+| **name** | **String** | Display name shown in email clients. Will appear as \"Name <email@example.com>\" in the From/To fields.  | [optional] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EmailAddress.new(
-  email: null,
-  name: null
+  email: sender@example.com,
+  name: John Doe
 )
 ```
 

data/docs/EmailApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Send Email
 
-Use this API to send either a single or batch email.
+Send transactional or marketing emails to one or multiple recipients. This is the primary endpoint for all email sending through SendPost.  **Capabilities:** - **Single Email**: Send to one recipient with full personalization - **Batch Sending**: Send to up to 500 recipients in a single API call - **Personalization**: Use Handlebars templating (`{{variableName}}`) in subject, HTML body, and text body - **Attachments**: Include base64-encoded files (max 25MB total per request) - **Tracking**: Enable/disable open and click tracking per email - **IP Pool Routing**: Route emails through specific IP pools  **Common Use Cases:**  | Use Case | Example | |----------|---------| | Order Confirmation | Send receipt with order details after purchase | | Password Reset | Time-sensitive security email with reset link | | Welcome Email | Onboard new users with personalized greeting | | Shipping Notification | Update customers when orders ship | | Invoice/Receipt | Attach PDF invoices to billing emails |  **Personalization Example:** ```json {   \"to\": [{     \"email\": \"john@example.com\",     \"customFields\": {       \"firstName\": \"John\",       \"orderTotal\": \"$99.99\"     }   }],   \"subject\": \"Hi {{firstName}}, your order is confirmed!\",   \"htmlBody\": \"<p>Thanks {{firstName}}! Your total: {{orderTotal}}</p>\" } ```  **Test Email Addresses:**  SendPost provides special test email addresses for testing webhooks and events without sending real emails:  | Test Email | Behavior | |------------|----------| | `test@playwithsendpost.io` | Generates delivered event, then simulates opens and clicks after a few seconds | | `deliver@playwithsendpost.io` | Generates delivered event only (no opens/clicks) | | `hardbounce@playwithsendpost.io` | Always generates a hard bounce event | | `softbounce@playwithsendpost.io` | Always generates a soft bounce event | | `dropped@playwithsendpost.io` | Always generates a dropped event (SMTPDropped) |  **Self-Test Email (Send to Yourself):**  Use `hello@playwithsendpost.io` as the **from** address to send emails to yourself for testing:  - **Sender**: Must be `hello@playwithsendpost.io` - **Recipient**: Must be your account owner email (the email you used to sign up) - **Behavior**: Real email delivery to your inbox (no domain verification required, no mock mode) - **Use Case**: Test your API integration by sending real emails to yourself without domain setup  **Example:** ```json {   \"from\": {\"email\": \"hello@playwithsendpost.io\"},   \"to\": [{\"email\": \"your-account-email@example.com\"}],   \"subject\": \"Test Email to Myself\",   \"htmlBody\": \"<p>This is a test email to myself</p>\" } ``` This will send a real email to your inbox that you can actually receive and open.  **Note**: If you send to any email other than your account email, the request will be rejected with an error.  **Using Test Emails:** - Simply send to any test email address like a normal recipient - Mock mode is automatically enabled for test emails - All events trigger webhooks normally - Events are marked as mock messages but follow the same structure as real events - Perfect for testing webhook integrations without using real email addresses  **Example:** ```json {   \"to\": [{\"email\": \"test@playwithsendpost.io\"}],   \"from\": {\"email\": \"sender@example.com\"},   \"subject\": \"Test Email\",   \"htmlBody\": \"<p>This is a test</p>\" } ``` This will generate: Sent → Delivered → Opened (after 2-5s) → Clicked (after 1-3s more)  **Response:** Returns an array of responses, one per recipient, each containing: - `messageId` - Unique ID for tracking - `submittedAt` - Timestamp of acceptance - `errorCode` and `message` - Status information 
 
 ### Examples
 
@@ -30,7 +30,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::EmailApi.new
-email_message_object = Sendpost::EmailMessageObject.new # EmailMessageObject | Email message details
+email_message_object = Sendpost::EmailMessageObject.new({from: Sendpost::EmailAddress.new({email: 'sender@example.com'}), to: [Sendpost::Recipient.new({email: 'recipient@example.com'})]}) # EmailMessageObject | Email message details
 
 begin
   # Send Email
@@ -85,7 +85,7 @@ end
 
 Send Email With Template
 
-Use this API to send an email with a predefined template. This makes it easy to integrate transactional emails with minimal code. 
+Send emails using pre-configured templates stored in SendPost. Templates separate email content from code, enabling:  **Benefits:** - Update email content without code deployments - Marketing teams can manage templates independently - Consistent branding across all applications - A/B test different template versions  **How It Works:** 1. Create templates in the SendPost dashboard with Handlebars variables 2. Reference the template by name or ID in this API call 3. Pass dynamic data through recipient `customFields` 4. SendPost merges data with template and sends  **Common Use Cases:**  | Template Type | Dynamic Data | |---------------|--------------| | Welcome Email | `firstName`, `accountType`, `loginUrl` | | Order Receipt | `orderNumber`, `items`, `total`, `shippingAddress` | | Password Reset | `resetLink`, `expiryTime`, `userName` | | Weekly Digest | `articleList`, `unreadCount`, `userName` |  **Example Request:** ```json {   \"from\": { \"email\": \"orders@yourstore.com\" },   \"to\": [{     \"email\": \"customer@example.com\",     \"customFields\": {       \"firstName\": \"Sarah\",       \"orderNumber\": \"ORD-2024-001\",       \"totalAmount\": \"$149.99\"     }   }],   \"template\": \"order-confirmation-v2\" } ```  **Note:** Template variables not provided in `customFields` will render as empty strings. 
 
 ### Examples
 
@@ -101,7 +101,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::EmailApi.new
-email_message_with_template = Sendpost::EmailMessageWithTemplate.new # EmailMessageWithTemplate | Email message details with template information
+email_message_with_template = Sendpost::EmailMessageWithTemplate.new({from: Sendpost::EmailAddress.new({email: 'sender@example.com'}), to: [Sendpost::Recipient.new({email: 'recipient@example.com'})]}) # EmailMessageWithTemplate | Email message details with template information
 
 begin
   # Send Email With Template

data/docs/EmailMessage.md

@@ -4,24 +4,24 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **message_id** | **String** |  | [optional] |
-| **account_id** | **Integer** |  | [optional] |
-| **sub_account_id** | **Integer** |  | [optional] |
-| **ip_id** | **Integer** |  | [optional] |
-| **public_ip** | **String** |  | [optional] |
-| **local_ip** | **String** |  | [optional] |
-| **email_type** | **String** |  | [optional] |
-| **submitted_at** | **Integer** |  | [optional] |
-| **from** | [**EmailMessageFrom**](EmailMessageFrom.md) |  | [optional] |
-| **reply_to** | [**EmailMessageReplyTo**](EmailMessageReplyTo.md) |  | [optional] |
-| **to** | [**Array<EmailMessageToInner>**](EmailMessageToInner.md) |  | [optional] |
-| **groups** | **Array<String>** |  | [optional] |
-| **ip_pool** | **String** |  | [optional] |
-| **headers** | **Hash<String, String>** |  | [optional] |
-| **custom_fields** | **Hash<String, String>** |  | [optional] |
-| **track_opens** | **Boolean** |  | [optional] |
-| **track_clicks** | **Boolean** |  | [optional] |
-| **webhook_endpoint** | **String** |  | [optional] |
+| **message_id** | **String** | Unique identifier for this email message | [optional] |
+| **account_id** | **Integer** | ID of the SendPost account that sent this email | [optional] |
+| **sub_account_id** | **Integer** | ID of the sub-account that sent this email | [optional] |
+| **ip_id** | **Integer** | ID of the dedicated IP used for sending (0 if a shared IP was used) | [optional] |
+| **public_ip** | **String** | The public IP address used to send this email | [optional] |
+| **local_ip** | **String** | The internal/local IP address used to send this email | [optional] |
+| **email_type** | **String** | Classification of the email based on recipient domain: - `gmail` - Gmail recipient - `yahoo` - Yahoo recipient - `microsoft` - Outlook/Hotmail recipient - `default` - Other email providers  | [optional] |
+| **submitted_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the email was submitted | [optional] |
+| **from** | [**EmailAddress**](EmailAddress.md) | The sender's email address | [optional] |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) | The reply-to address (if different from sender) | [optional] |
+| **to** | [**Recipient**](Recipient.md) | The envelope recipient (actual delivery address) | [optional] |
+| **groups** | **Array<String>** | Tags/groups for categorization and analytics | [optional] |
+| **ip_pool** | **String** | Name of the IP pool used for sending | [optional] |
+| **headers** | **Hash<String, String>** | Custom headers included in the email | [optional] |
+| **custom_fields** | **Hash<String, Object>** | Custom fields sent with the email, available for personalization | [optional] |
+| **track_opens** | **Boolean** | Whether open tracking was enabled | [optional] |
+| **track_clicks** | **Boolean** | Whether click tracking was enabled | [optional] |
+| **webhook_endpoint** | **String** | Custom webhook endpoint for this email (if specified) | [optional] |
 
 ## Example
 
@@ -29,24 +29,24 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EmailMessage.new(
-  message_id: mjhl-1401-sasdf-129324,
-  account_id: 117,
-  sub_account_id: 117,
-  ip_id: 123,
+  message_id: 550e8400-e29b-41d4-a716-446655440000,
+  account_id: 100,
+  sub_account_id: 50441,
+  ip_id: 11321,
   public_ip: 52.34.11.12,
-  local_ip: 127.0.0.1,
-  email_type: default,
-  submitted_at: 1567512491587205024,
+  local_ip: 10.0.1.5,
+  email_type: gmail,
+  submitted_at: 1704067200000000000,
   from: null,
   reply_to: null,
   to: null,
-  groups: ["welcome","user-onboarding"],
-  ip_pool: transactional-piedpiper,
-  headers: {"X-Campaign-Id":"12345"},
-  custom_fields: {"Company":"Company Name","Email":"user@example.com"},
+  groups: [transactional, order-confirmation],
+  ip_pool: transactional,
+  headers: {X-Campaign-ID=summer-sale-2024, List-Unsubscribe=<mailto:unsubscribe@piedpiper.com>},
+  custom_fields: {"firstName":"John","orderId":"12345"},
   track_opens: true,
   track_clicks: true,
-  webhook_endpoint: https://webhook.example.com/webhook
+  webhook_endpoint: https://piedpiper.com/webhooks/email
 )
 ```