sendpost_ruby_sdk 2.0.2 → 3.0.0

data/docs/EmailMessageObject.md

@@ -4,21 +4,22 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
-| **reply_to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
-| **to** | [**Array<Recipient>**](Recipient.md) |  | [optional] |
-| **subject** | **String** |  | [optional] |
-| **pre_text** | **String** |  | [optional] |
-| **html_body** | **String** |  | [optional] |
-| **text_body** | **String** |  | [optional] |
-| **amp_body** | **String** |  | [optional] |
-| **ippool** | **String** |  | [optional] |
-| **headers** | **Hash<String, String>** |  | [optional] |
-| **track_opens** | **Boolean** |  | [optional] |
-| **track_clicks** | **Boolean** |  | [optional] |
-| **groups** | **Array<String>** |  | [optional] |
-| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
-| **webhook_endpoint** | **String** |  | [optional] |
+| **from** | [**EmailAddress**](EmailAddress.md) | The sender's email address and optional display name |  |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) | The reply-to email address. If not specified, replies will go to the `from` address | [optional] |
+| **to** | [**Array<Recipient>**](Recipient.md) | List of recipients. Each recipient can have their own CC, BCC, and custom fields for personalization. Maximum 1000 recipients per API call.  |  |
+| **subject** | **String** | Email subject line. Supports Handlebars templating for personalization. Example: \"Hello, {{firstName}}! Your order is ready\"  | [optional] |
+| **pre_text** | **String** | Preview text (preheader) shown in email clients before opening the email. This text appears after the subject line in most email clients' inbox view.  | [optional] |
+| **html_body** | **String** | HTML content of the email. Supports Handlebars templating for personalization. Use {{customFieldName}} to insert recipient-specific values.  | [optional] |
+| **text_body** | **String** | Plain text content of the email. Used as fallback when HTML cannot be rendered. Also improves deliverability as some spam filters prefer multipart emails.  | [optional] |
+| **amp_body** | **String** | AMP HTML content for supported email clients (Gmail, Yahoo). Enables interactive email experiences like carousels, forms, and real-time content. See https://amp.dev/about/email/ for more details.  | [optional] |
+| **template** | **String** | Name of a pre-defined template to use for this email. When specified, the template's subject, htmlBody, and textBody will be used unless explicitly overridden in this request.  | [optional] |
+| **ippool** | **String** | Name of the IP pool to use for sending this email. If not specified, the default IP pool for the sub-account will be used.  | [optional] |
+| **headers** | **Hash<String, String>** | Custom email headers to include in the message. Common uses: adding List-Unsubscribe headers, custom tracking IDs, or priority flags. Note: Some headers like From, To, Subject are set automatically and cannot be overridden.  | [optional] |
+| **track_opens** | **Boolean** | Whether to track email opens using a tracking pixel. When enabled, a 1x1 transparent image is inserted into the HTML body. Default: true (if not specified)  | [optional][default to true] |
+| **track_clicks** | **Boolean** | Whether to track link clicks by rewriting URLs through SendPost's tracking domain. When enabled, all links in htmlBody are replaced with tracking URLs. Default: true (if not specified)  | [optional][default to true] |
+| **groups** | **Array<String>** | Tags/groups to categorize this email for analytics and reporting. Use groups to segment your email statistics (e.g., by campaign, email type, or customer segment).  | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) | File attachments to include with the email. Maximum total attachment size: 25MB. Supported formats: PDF, images, documents, etc.  | [optional] |
+| **webhook_endpoint** | **String** | Custom webhook URL to receive events for this specific email. Overrides the default webhook configured at the account level. Useful for per-email or per-customer webhook routing.  | [optional] |
 
 ## Example
 
@@ -29,18 +30,24 @@ instance = Sendpost::EmailMessageObject.new(
   from: null,
   reply_to: null,
   to: null,
-  subject: null,
-  pre_text: null,
-  html_body: null,
-  text_body: null,
-  amp_body: null,
-  ippool: null,
-  headers: null,
-  track_opens: null,
-  track_clicks: null,
-  groups: null,
+  subject: Welcome to SendPost, {{firstName}}!,
+  pre_text: Your weekly digest is here with 5 new updates...,
+  html_body: <html><body><h1>Hello {{firstName}}</h1><p>Welcome to our platform!</p></body></html>,
+  text_body: Hello {{firstName}},
+
+Welcome to our platform!
+
+Best regards,
+The Team,
+  amp_body: <!doctype html><html ⚡4email><head>...</head><body>...</body></html>,
+  template: welcome-email-v2,
+  ippool: transactional,
+  headers: {X-Custom-Header=custom-value, X-Campaign-ID=summer-sale-2024, List-Unsubscribe=<mailto:unsubscribe@example.com>},
+  track_opens: true,
+  track_clicks: true,
+  groups: [transactional, order-confirmation, premium-customers],
   attachments: null,
-  webhook_endpoint: null
+  webhook_endpoint: https://your-app.com/webhooks/email-events
 )
 ```
 

data/docs/EmailMessageWithTemplate.md

@@ -4,22 +4,22 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
-| **reply_to** | [**EmailAddress**](EmailAddress.md) |  | [optional] |
-| **to** | [**Array<Recipient>**](Recipient.md) |  | [optional] |
-| **subject** | **String** |  | [optional] |
-| **pre_text** | **String** |  | [optional] |
-| **html_body** | **String** |  | [optional] |
-| **text_body** | **String** |  | [optional] |
-| **amp_body** | **String** |  | [optional] |
-| **ippool** | **String** |  | [optional] |
-| **headers** | **Hash<String, String>** |  | [optional] |
-| **track_opens** | **Boolean** |  | [optional] |
-| **track_clicks** | **Boolean** |  | [optional] |
-| **groups** | **Array<String>** |  | [optional] |
-| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
-| **webhook_endpoint** | **String** |  | [optional] |
+| **from** | [**EmailAddress**](EmailAddress.md) | The sender's email address and optional display name |  |
+| **reply_to** | [**EmailAddress**](EmailAddress.md) | The reply-to email address. If not specified, replies will go to the `from` address | [optional] |
+| **to** | [**Array<Recipient>**](Recipient.md) | List of recipients. Each recipient can have their own CC, BCC, and custom fields for personalization. Maximum 1000 recipients per API call.  |  |
+| **subject** | **String** | Email subject line. Supports Handlebars templating for personalization. Example: \"Hello, {{firstName}}! Your order is ready\"  | [optional] |
+| **pre_text** | **String** | Preview text (preheader) shown in email clients before opening the email. This text appears after the subject line in most email clients' inbox view.  | [optional] |
+| **html_body** | **String** | HTML content of the email. Supports Handlebars templating for personalization. Use {{customFieldName}} to insert recipient-specific values.  | [optional] |
+| **text_body** | **String** | Plain text content of the email. Used as fallback when HTML cannot be rendered. Also improves deliverability as some spam filters prefer multipart emails.  | [optional] |
+| **amp_body** | **String** | AMP HTML content for supported email clients (Gmail, Yahoo). Enables interactive email experiences like carousels, forms, and real-time content. See https://amp.dev/about/email/ for more details.  | [optional] |
 | **template** | **String** |  | [optional] |
+| **ippool** | **String** | Name of the IP pool to use for sending this email. If not specified, the default IP pool for the sub-account will be used.  | [optional] |
+| **headers** | **Hash<String, String>** | Custom email headers to include in the message. Common uses: adding List-Unsubscribe headers, custom tracking IDs, or priority flags. Note: Some headers like From, To, Subject are set automatically and cannot be overridden.  | [optional] |
+| **track_opens** | **Boolean** | Whether to track email opens using a tracking pixel. When enabled, a 1x1 transparent image is inserted into the HTML body. Default: true (if not specified)  | [optional][default to true] |
+| **track_clicks** | **Boolean** | Whether to track link clicks by rewriting URLs through SendPost's tracking domain. When enabled, all links in htmlBody are replaced with tracking URLs. Default: true (if not specified)  | [optional][default to true] |
+| **groups** | **Array<String>** | Tags/groups to categorize this email for analytics and reporting. Use groups to segment your email statistics (e.g., by campaign, email type, or customer segment).  | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) | File attachments to include with the email. Maximum total attachment size: 25MB. Supported formats: PDF, images, documents, etc.  | [optional] |
+| **webhook_endpoint** | **String** | Custom webhook URL to receive events for this specific email. Overrides the default webhook configured at the account level. Useful for per-email or per-customer webhook routing.  | [optional] |
 | **template_id** | **String** | Template ID for the email template | [optional] |
 | **template_variables** | **Hash<String, String>** | Key-Value pair of template variables | [optional] |
 
@@ -32,19 +32,24 @@ instance = Sendpost::EmailMessageWithTemplate.new(
   from: null,
   reply_to: null,
   to: null,
-  subject: null,
-  pre_text: null,
-  html_body: null,
-  text_body: null,
-  amp_body: null,
-  ippool: null,
-  headers: null,
-  track_opens: null,
-  track_clicks: null,
-  groups: null,
-  attachments: null,
-  webhook_endpoint: null,
+  subject: Welcome to SendPost, {{firstName}}!,
+  pre_text: Your weekly digest is here with 5 new updates...,
+  html_body: <html><body><h1>Hello {{firstName}}</h1><p>Welcome to our platform!</p></body></html>,
+  text_body: Hello {{firstName}},
+
+Welcome to our platform!
+
+Best regards,
+The Team,
+  amp_body: <!doctype html><html ⚡4email><head>...</head><body>...</body></html>,
   template: null,
+  ippool: transactional,
+  headers: {X-Custom-Header=custom-value, X-Campaign-ID=summer-sale-2024, List-Unsubscribe=<mailto:unsubscribe@example.com>},
+  track_opens: true,
+  track_clicks: true,
+  groups: [transactional, order-confirmation, premium-customers],
+  attachments: null,
+  webhook_endpoint: https://your-app.com/webhooks/email-events,
   template_id: null,
   template_variables: null
 )

data/docs/EmailResponse.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **to** | **String** |  | [optional] |
-| **submitted_at** | **Integer** | UNIX epoch nano timestamp | [optional] |
-| **message_id** | **String** | Message UUID | [optional] |
-| **error_code** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
+| **to** | **String** | The recipient email address this response corresponds to | [optional] |
+| **submitted_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the email was accepted for processing. Use this for precise timing and correlation with webhook events.  | [optional] |
+| **message_id** | **String** | Unique identifier (UUID) for this email message. Use this ID to track the email through webhooks and the message lookup API.  | [optional] |
+| **error_code** | **Integer** | Error code if the email submission failed. Common codes: - 0: Success (no error) - 1: Invalid recipient email - 2: Recipient in suppression list - 3: Domain not verified - 4: Rate limit exceeded - 5: Invalid sender email  | [optional] |
+| **message** | **String** | Human-readable message describing the result. On success: \"Email submitted successfully\" On error: Description of what went wrong  | [optional] |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EmailResponse.new(
-  to: null,
-  submitted_at: null,
-  message_id: null,
-  error_code: null,
-  message: null
+  to: customer@example.com,
+  submitted_at: 1704067200000000000,
+  message_id: 550e8400-e29b-41d4-a716-446655440000,
+  error_code: 0,
+  message: Email submitted successfully
 )
 ```
 

data/docs/EmailTypeStat.md

@@ -0,0 +1,40 @@
+# Sendpost::EmailTypeStat
+
+## 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] |
+| **email_type** | **String** | The email provider type these statistics are aggregated for. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::EmailTypeStat.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,
+  email_type: transactional
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,18 @@
+# Sendpost::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::ErrorResponse.new(
+  error: null
+)
+```
+

data/docs/ErrorResponseError.md

@@ -0,0 +1,26 @@
+# Sendpost::ErrorResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Machine-readable error code. Common codes: - `invalid_request` - Malformed request body or parameters - `authentication_failed` - Invalid or missing API key - `resource_not_found` - Requested resource doesn't exist - `resource_exists` - Resource with same identifier already exists - `validation_error` - Request validation failed - `rate_limit_exceeded` - Too many requests - `internal_error` - Server-side error  | [optional] |
+| **message** | **String** | Human-readable error description | [optional] |
+| **param** | **String** | The parameter that caused the error (if applicable) | [optional] |
+| **type** | **String** | Error category | [optional] |
+| **details** | [**Array<ErrorResponseErrorDetailsInner>**](ErrorResponseErrorDetailsInner.md) | Additional error details for validation errors | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::ErrorResponseError.new(
+  code: validation_error,
+  message: The 'email' field must be a valid email address,
+  param: to[0].email,
+  type: invalid_request_error,
+  details: null
+)
+```
+

data/docs/ErrorResponseErrorDetailsInner.md

@@ -0,0 +1,20 @@
+# Sendpost::ErrorResponseErrorDetailsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Field path that failed validation | [optional] |
+| **message** | **String** | Validation error message for this field | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::ErrorResponseErrorDetailsInner.new(
+  field: to[0].email,
+  message: must be a valid email address
+)
+```
+

data/docs/Event.md

@@ -4,25 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **event_id** | **String** |  | [optional] |
-| **groups** | **Array<String>** |  | [optional] |
-| **ip_id** | **Integer** |  | [optional] |
-| **ip_pool_id** | **Integer** |  | [optional] |
-| **domain_id** | **Integer** |  | [optional] |
-| **tpsp_id** | **Integer** |  | [optional] |
-| **message_type** | **String** |  | [optional] |
-| **message_subject** | **String** |  | [optional] |
-| **account_id** | **Integer** |  | [optional] |
-| **sub_account_id** | **Integer** |  | [optional] |
-| **message_id** | **String** |  | [optional] |
-| **type** | **Integer** |  | [optional] |
-| **from** | **String** |  | [optional] |
-| **from_name** | **String** |  | [optional] |
-| **to** | **String** |  | [optional] |
-| **to_name** | **String** |  | [optional] |
-| **submitted_at** | **Integer** |  | [optional] |
-| **smtp_code** | **Integer** |  | [optional] |
-| **smtp_description** | **String** |  | [optional] |
+| **event_id** | **String** | Unique identifier for this specific event. Use this for idempotency - the same event may be delivered multiple times.  | [optional] |
+| **message_id** | **String** | Unique identifier of the email message this event belongs to. Use this to correlate events with the original send request.  | [optional] |
+| **type** | **Integer** | Numeric event type code: - `0` = processed (email accepted by API) - `1` = dropped (not sent - suppression, invalid, etc.) - `2` = delivered (accepted by recipient's mail server) - `3` = softBounced (temporary failure, will retry) - `4` = hardBounced (permanent failure) - `5` = opened (tracking pixel loaded) - `6` = clicked (link clicked) - `7` = unsubscribed (clicked unsubscribe link) - `8` = spam (marked as spam by recipient) - `9` = sent (sent to mail server) - `10` = smtpDropped (dropped at SMTP level)  | [optional] |
+| **type_name** | **String** | Human-readable event type name | [optional] |
+| **from** | **String** | Sender email address | [optional] |
+| **to** | **String** | Recipient email address | [optional] |
+| **subject** | **String** | Email subject line (useful for identifying the email) | [optional] |
+| **groups** | **Array<String>** | Tags/groups that were associated with the email | [optional] |
+| **submitted_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the email was originally submitted | [optional] |
+| **timestamp** | **Integer** | UNIX epoch timestamp in nanoseconds when this event occurred | [optional] |
 | **event_metadata** | [**EventMetadata**](EventMetadata.md) |  | [optional] |
 
 ## Example
@@ -32,24 +23,15 @@ require 'sendpost_ruby_sdk'
 
 instance = Sendpost::Event.new(
   event_id: edhg-123gh-afasdf-124egh,
-  groups: ["transactional","user-onboarding"],
-  ip_id: 123,
-  ip_pool_id: 123,
-  domain_id: 123,
-  tpsp_id: 1,
-  message_type: default,
-  message_subject: Welcome to Pied Piper :) + 1 quick question,
-  account_id: 117,
-  sub_account_id: 117,
-  message_id: mjhl-1401-sasdf-129324,
+  message_id: 550e8400-e29b-41d4-a716-446655440000,
   type: 2,
-  from: richard@piedpiper.com,
-  from_name: Richard,
-  to: gavin@hooli.com,
-  to_name: Gavin,
-  submitted_at: 1567512491587205024,
-  smtp_code: 200,
-  smtp_description: email delivered successfully,
+  type_name: delivered,
+  from: notifications@piedpiper.com,
+  to: customer@example.com,
+  subject: Your order has been shipped!,
+  groups: [transactional, order-shipped],
+  submitted_at: 1704067200000000000,
+  timestamp: 1704067205000000000,
   event_metadata: null
 )
 ```

data/docs/EventMetadata.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **smtp_code** | **Integer** |  | [optional] |
-| **smtp_description** | **String** |  | [optional] |
-| **user_agent** | [**UserAgent**](UserAgent.md) |  | [optional] |
-| **os** | [**OperatingSystem**](OperatingSystem.md) |  | [optional] |
-| **device** | [**Device**](Device.md) |  | [optional] |
-| **geo** | [**GeoLocation**](GeoLocation.md) |  | [optional] |
-| **clicked_url** | **String** |  | [optional] |
-| **tracked_ip** | **String** |  | [optional] |
-| **raw_user_agent** | **String** |  | [optional] |
+| **smtp_code** | **Integer** | SMTP response code from the receiving mail server. - 250: Success - 4xx: Temporary failure (soft bounce) - 5xx: Permanent failure (hard bounce)  | [optional] |
+| **smtp_description** | **String** | Full SMTP response message from the receiving server. Useful for diagnosing delivery issues.  | [optional] |
+| **user_agent** | [**UserAgent**](UserAgent.md) | Parsed browser/email client information (for open/click events) | [optional] |
+| **os** | [**Os**](Os.md) | Parsed operating system information (for open/click events) | [optional] |
+| **device** | [**Device**](Device.md) | Device type information (for open/click events) | [optional] |
+| **geo** | [**GeoLocation**](GeoLocation.md) | Geographic location based on IP address (for open/click events) | [optional] |
+| **clicked_url** | **String** | The original URL that was clicked (only for click events) | [optional] |
+| **tracked_ip** | **String** | IP address of the user who triggered the event (open/click) | [optional] |
+| **raw_user_agent** | **String** | Raw User-Agent header string from the HTTP request | [optional] |
 
 ## Example
 
@@ -20,15 +20,15 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EventMetadata.new(
-  smtp_code: 200,
-  smtp_description: email delivered successfully,
+  smtp_code: 250,
+  smtp_description: 250 2.0.0 OK 1704067205 - Message accepted for delivery,
   user_agent: null,
   os: null,
   device: null,
   geo: null,
-  clicked_url: https://hooli.com,
-  tracked_ip: 52.34.11.12,
-  raw_user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
+  clicked_url: https://piedpiper.com/track-order?id=12345,
+  tracked_ip: 73.162.45.123,
+  raw_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
 )
 ```
 

data/docs/GeoLocation.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **city_id** | **String** |  | [optional] |
-| **continent_code** | **String** |  | [optional] |
-| **country_code** | **String** |  | [optional] |
-| **postal_code** | **String** |  | [optional] |
-| **time_zone** | **String** |  | [optional] |
+| **city_id** | **Integer** | GeoNames city identifier | [optional] |
+| **country_code** | **String** | Two-letter ISO 3166-1 alpha-2 country code | [optional] |
+| **continent_code** | **String** | Two-letter continent code: AF (Africa), AN (Antarctica), AS (Asia), EU (Europe), NA (North America), OC (Oceania), SA (South America)  | [optional] |
+| **postal_code** | **String** | Postal/ZIP code | [optional] |
+| **time_zone** | **String** | IANA timezone identifier | [optional] |
 
 ## Example
 
@@ -16,10 +16,10 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::GeoLocation.new(
-  city_id: 123,
-  continent_code: EU,
+  city_id: 5391959,
   country_code: US,
-  postal_code: 12345,
+  continent_code: NA,
+  postal_code: 94105,
   time_zone: America/Los_Angeles
 )
 ```

data/docs/GroupStat.md

@@ -0,0 +1,40 @@
+# Sendpost::GroupStat
+
+## 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] |
+| **group** | **String** | The group/tag name these statistics are aggregated for. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::GroupStat.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,
+  group: shopify
+)
+```
+

data/docs/IP.md

@@ -4,29 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the IP |  |
-| **public_ip** | **String** | The public IP address associated with the resource |  |
-| **system_domain** | [**Domain**](Domain.md) |  | [optional] |
-| **reverse_dns_hostname** | **String** | The reverse DNS hostname for the IP | [optional] |
-| **type** | **Integer** | Type of the IP | [optional] |
-| **gmail_settings** | **String** | Configuration for Gmail delivery settings in JSON format | [optional] |
-| **yahoo_settings** | **String** | Configuration for Yahoo delivery settings in JSON format | [optional] |
-| **aol_settings** | **String** | Configuration for AOL delivery settings in JSON format | [optional] |
-| **microsoft_settings** | **String** | Configuration for Microsoft delivery settings in JSON format | [optional] |
-| **comcast_settings** | **String** | Configuration for Comcast delivery settings in JSON format | [optional] |
-| **yandex_settings** | **String** | Configuration for Yandex delivery settings in JSON format | [optional] |
-| **gmx_settings** | **String** | Configuration for GMX delivery settings in JSON format | [optional] |
-| **mailru_settings** | **String** | Configuration for Mail.ru delivery settings in JSON format | [optional] |
-| **icloud_settings** | **String** | Configuration for iCloud delivery settings in JSON format | [optional] |
-| **zoho_settings** | **String** | Configuration for Zoho delivery settings in JSON format | [optional] |
-| **qq_settings** | **String** | Configuration for QQ delivery settings in JSON format | [optional] |
-| **default_settings** | **String** | Default delivery settings in JSON format | [optional] |
-| **att_settings** | **String** | Configuration for AT&T delivery settings in JSON format | [optional] |
-| **created** | **Integer** | The timestamp (UNIX epoch) when the IP was created |  |
-| **infra_classification** | **String** | Classification of the infrastructure | [optional] |
-| **infra_monitor** | **Boolean** | Indicates whether infrastructure monitoring is enabled | [optional] |
-| **state** | **Integer** | The state of the IP | [optional] |
-| **auto_warmup_plan** | [**AutoWarmupPlan**](AutoWarmupPlan.md) | The auto-warmup plan associated with the IP. Can be null if no warmup plan is assigned. | [optional] |
+| **id** | **Integer** | Unique identifier for the IP resource | [optional] |
+| **public_ip** | **String** | The public IPv4 address used for sending emails. This is the IP that receiving mail servers will see.  | [optional] |
+| **reverse_dns_hostname** | **String** | The reverse DNS (PTR record) hostname for this IP. Properly configured rDNS is important for deliverability. Format: sp{id}.{region}.sendpost.email  | [optional] |
+| **type** | **Integer** | Type of IP allocation: - `0` = Shared IP (shared with other SendPost senders, pooled reputation) - `1` = Dedicated IP (exclusive to your account, your own reputation)  | [optional] |
+| **auto_warmup_enabled** | **Boolean** | Whether automatic IP warmup is enabled. When enabled, SendPost automatically manages sending volume to gradually build reputation on this IP.  | [optional] |
+| **labels** | [**Array<Label>**](Label.md) | Custom labels/tags for organizing IPs | [optional] |
+| **state** | **Integer** | Current state of the IP: - `0` = Warmup (IP is in warmup phase, gradually building reputation) - `1` = Normal (IP is fully warmed and ready for full sending volume)  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the IP was allocated | [optional] |
 
 ## Example
 
@@ -36,27 +21,12 @@ require 'sendpost_ruby_sdk'
 instance = Sendpost::IP.new(
   id: 11321,
   public_ip: 52.34.11.12,
-  system_domain: null,
-  reverse_dns_hostname: example.mtaspg.email,
-  type: 0,
-  gmail_settings: {"name":"gmail","maxConcurrentConnections":100,...},
-  yahoo_settings: {"name":"yahoo","maxConcurrentConnections":16,...},
-  aol_settings: {"name":"aol","maxConcurrentConnections":20,...},
-  microsoft_settings: {"name":"microsoft","maxConcurrentConnections":16,...},
-  comcast_settings: {"name":"comcast","maxConcurrentConnections":20,...},
-  yandex_settings: {"name":"yandex","maxConcurrentConnections":2,...},
-  gmx_settings: {"name":"gmx","maxConcurrentConnections":2,...},
-  mailru_settings: {"name":"mailru","maxConcurrentConnections":1,...},
-  icloud_settings: {"name":"icloud","maxConcurrentConnections":20,...},
-  zoho_settings: {"name":"zoho","maxConcurrentConnections":1,...},
-  qq_settings: {"name":"qq","maxConcurrentConnections":1,...},
-  default_settings: {"name":"default","maxConcurrentConnections":14,...},
-  att_settings: {"name":"att","maxConcurrentConnections":1,...},
-  created: 1703224038766344700,
-  infra_classification: ,
-  infra_monitor: true,
+  reverse_dns_hostname: sp11321.mtaspg.email,
+  type: 1,
+  auto_warmup_enabled: true,
+  labels: null,
   state: 1,
-  auto_warmup_plan: null
+  created: 1704067200000000000
 )
 ```
 

data/docs/IPAllocationRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **overflow_pool** | **Boolean** | Determines whether emails should be sent over shared IP when the IP pool is full |  |
-| **ips** | **Array<String>** |  |  |
+| **ips** | **Array<String>** | List of IP addresses to allocate. These must be available IPs from SendPost's IP pool. Contact support to request IP allocation.  |  |
+| **auto_warmup_enabled** | **Boolean** | Enable automatic IP warmup for newly allocated IPs. Recommended: true for new IPs to gradually build sender reputation.  | [optional][default to true] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::IPAllocationRequest.new(
-  overflow_pool: true,
-  ips: null
+  ips: [34.21.14.11, 34.21.14.12],
+  auto_warmup_enabled: true
 )
 ```