sendpost_ruby_sdk 2.0.2 → 3.0.0

data/docs/Suppression.md

@@ -4,11 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The ID of the suppression | [optional] |
-| **reason** | **Integer** | The reason for the suppression (0 = manual, 1 = unsubscribe, 2 = hard bounce, 3 = spam complaint) | [optional] |
-| **smtp_error** | **String** | SMTP error code in case of hard bounce suppression | [optional] |
-| **email** | **String** | The email address for the suppression | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the suppression was created | [optional] |
+| **id** | **Integer** | Unique identifier for the suppression record | [optional] |
+| **email** | **String** | The suppressed email address | [optional] |
+| **reason** | **Integer** | Reason code for the suppression: - `0` = Manual (added via API or dashboard) - `1` = Unsubscribe (recipient clicked unsubscribe link) - `2` = Hard Bounce (permanent delivery failure) - `3` = Spam Complaint (recipient marked as spam) - `4` = Hard Bounce (detected by post-send validation)  | [optional] |
+| **reason_text** | **String** | Human-readable suppression reason | [optional] |
+| **smtp_error** | **String** | SMTP error message from the receiving server (only for hard bounce suppressions). Useful for diagnosing delivery issues.  | [optional] |
+| **message_uuid** | **String** | UUID of the message whose bounce/complaint caused this suppression. Empty for manually added suppressions. Useful for tracing the origin.  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the suppression was added | [optional] |
 
 ## Example
 
@@ -16,11 +18,13 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::Suppression.new(
-  id: null,
-  reason: null,
-  smtp_error: null,
-  email: null,
-  created: null
+  id: 35,
+  email: bounced@example.com,
+  reason: 2,
+  reason_text: hardBounce,
+  smtp_error: 550 5.1.1 The email account that you tried to reach does not exist,
+  message_uuid: 3f2504e0-4f89-41d3-9a0c-0305e82c3301,
+  created: 1704067200000000000
 )
 ```
 

data/docs/SuppressionApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Create Suppressions
 
-Creates new suppressions by posting to the suppression resource. You can specify different types of suppressions including `hardBounce`, `manual`, `unsubscribe`, and `spamComplaint`. 
+Add email addresses to your suppression list to prevent future emails from being sent. This is essential for maintaining sender reputation and compliance.  **When to Use Each Type:** | Type | Use When | |------|----------| | `hardBounce` | You know an address is permanently invalid | | `manual` | Processing do-not-contact requests from support | | `unsubscribe` | Syncing unsubscribes from external systems | | `spamComplaint` | Importing complaints from other providers |  **Common Use Cases:** - **Migration:** Import suppression list from previous email provider - **CRM Sync:** Add unsubscribes from your marketing platform - **Bulk Cleanup:** Add known invalid addresses from data cleaning - **Support Tickets:** Honor do-not-contact requests  **Best Practices:** - Import historical bounce data when migrating providers - Sync unsubscribes immediately when received from external sources - Process support-requested suppressions within 24 hours - Use `manual` for addresses you want to suppress without categorization 
 
 ### Examples
 
@@ -82,11 +82,11 @@ end
 
 ## delete_suppression
 
-> <Array<DeleteSuppression200ResponseInner>> delete_suppression(delete_suppression_request)
+> <DeleteSuppression200Response> delete_suppression(delete_suppression_request)
 
 Delete Suppressions
 
-Deletes one or more suppressions for a given sub-account. The request can contain a list of emails to delete specific suppressions or delete a single suppression. 
+Remove email addresses from your suppression list, allowing them to receive emails again.  **⚠️ Important: Use with caution!** Re-enabling sending to previously suppressed addresses can harm your sender reputation if used incorrectly.  **Valid Use Cases:** - User confirms their valid email was incorrectly bounced - Manual suppression was added by mistake - User explicitly requests re-subscription after unsubscribing - Testing/development addresses that were suppressed  **Not Recommended:** - Bulk removing hard bounces without individual verification - Removing spam complaints (users rarely want to receive emails again) - Attempting to re-engage addresses that bounced  **Best Practice:** Before removing a suppression, verify with the recipient that they want to receive emails and that their address is valid. 
 
 ### Examples
 
@@ -117,7 +117,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<DeleteSuppression200ResponseInner>>, Integer, Hash)> delete_suppression_with_http_info(delete_suppression_request)
+> <Array(<DeleteSuppression200Response>, Integer, Hash)> delete_suppression_with_http_info(delete_suppression_request)
 
 ```ruby
 begin
@@ -125,7 +125,7 @@ begin
   data, status_code, headers = api_instance.delete_suppression_with_http_info(delete_suppression_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<DeleteSuppression200ResponseInner>>
+  p data # => <DeleteSuppression200Response>
 rescue Sendpost::ApiError => e
   puts "Error when calling SuppressionApi->delete_suppression_with_http_info: #{e}"
 end
@@ -139,7 +139,7 @@ end
 
 ### Return type
 
-[**Array&lt;DeleteSuppression200ResponseInner&gt;**](DeleteSuppression200ResponseInner.md)
+[**DeleteSuppression200Response**](DeleteSuppression200Response.md)
 
 ### Authorization
 
@@ -157,7 +157,7 @@ end
 
 List Suppressions
 
-Retrieves a list of suppressions associated with a specific sub-account within a given date range. The maximum difference between `from` and `to` dates should not exceed 60 days. 
+Retrieve the suppression list for your sub-account. Suppressions are email addresses that should not receive emails to protect your sender reputation and ensure compliance.  **Suppression Types:** | Type | Reason Code | Description | |------|-------------|-------------| | `manual` | 0 | Manually added by your team | | `unsubscribe` | 1 | User clicked unsubscribe link | | `hardBounce` | 2 | Permanent delivery failure (invalid address) | | `spamComplaint` | 3 | User marked email as spam |  **Why Suppressions Matter:** - **Reputation Protection:** Repeatedly sending to bounced addresses damages sender reputation - **Compliance:** Required for CAN-SPAM, GDPR, and other regulations - **Cost Savings:** Avoid paying to send undeliverable emails - **Deliverability:** ISPs penalize senders with high bounce/complaint rates  **Use Cases:** - Export suppression list for compliance audits - Sync suppressions with your CRM or marketing platform - Review recent bounces to identify data quality issues - Monitor spam complaints for content/targeting problems  **Pagination:** Use `limit` and `offset` for large suppression lists.  **Note:** Maximum date range is 60 days. 
 
 ### Examples
 
@@ -173,13 +173,13 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::SuppressionApi.new
-from = Date.parse('2013-10-20') # Date | Start date for the suppression records
-to = Date.parse('2013-10-20') # Date | End date for the suppression records (Note: `from` should be earlier than `to` and the date range should not exceed 60 days) 
+from = Date.parse('2024-01-01') # Date | Start date for suppression records (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-01-31') # Date | End date for suppression records (inclusive). Max 60 days from `from` date.
 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 suppression email
-  type: 'hardBounce' # String | Type of suppression. Valid values: `hardBounce`, `manual`, `spamComplaint`, `unsubscribe` 
+  limit: 50, # Integer | Number of records to return per request. Default 20, max 100.
+  offset: 0, # Integer | Number of initial records to skip for pagination.
+  search: '@example.com', # String | Case-insensitive search against suppression email addresses.
+  type: 'hardBounce' # String | Filter by suppression type. Omit to return all types.
 }
 
 begin
@@ -213,12 +213,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | **Date** | Start date for the suppression records |  |
-| **to** | **Date** | End date for the suppression records (Note: &#x60;from&#x60; should be earlier than &#x60;to&#x60; and the date range should not exceed 60 days)  |  |
-| **limit** | **Integer** | Number of records to return per request | [optional][default to 20] |
-| **offset** | **Integer** | Number of initial records to skip | [optional][default to 0] |
-| **search** | **String** | Case-insensitive search against suppression email | [optional] |
-| **type** | **String** | Type of suppression. Valid values: &#x60;hardBounce&#x60;, &#x60;manual&#x60;, &#x60;spamComplaint&#x60;, &#x60;unsubscribe&#x60;  | [optional] |
+| **from** | **Date** | Start date for suppression records (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for suppression records (inclusive). Max 60 days from &#x60;from&#x60; date. |  |
+| **limit** | **Integer** | Number of records to return per request. Default 20, max 100. | [optional][default to 20] |
+| **offset** | **Integer** | Number of initial records to skip for pagination. | [optional][default to 0] |
+| **search** | **String** | Case-insensitive search against suppression email addresses. | [optional] |
+| **type** | **String** | Filter by suppression type. Omit to return all types. | [optional] |
 
 ### Return type
 

data/docs/TPSPStat.md

@@ -0,0 +1,42 @@
+# Sendpost::TPSPStat
+
+## 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] |
+| **tpsp_id** | **Integer** | Unique identifier of the third-party sending provider. | [optional] |
+| **name** | **String** | Human-readable name of the third-party sending provider. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::TPSPStat.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,
+  tpsp_id: 7,
+  name: SendGrid
+)
+```
+

data/docs/UpdateSubAccount.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | New name for the sub-account. | [optional] |
+| **name** | **String** | New display name for the sub-account | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::UpdateSubAccount.new(
-  name: FoxHole V1
+  name: Marketing - Production v2
 )
 ```
 

data/docs/UpdateWebhook.md

@@ -4,21 +4,21 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Is the webhook active or in a paused state? | [optional] |
-| **url** | **String** | URL endpoint to which webhook calls are sent. | [optional] |
-| **processed** | **Boolean** | Trigger webhook on email message being processed. | [optional] |
-| **delivered** | **Boolean** | Trigger webhook on email message being delivered. | [optional] |
-| **dropped** | **Boolean** | Trigger webhook on email message being dropped. | [optional] |
-| **soft_bounced** | **Boolean** | Trigger webhook on email message being soft bounced. | [optional] |
-| **hard_bounced** | **Boolean** | Trigger webhook on email message being hard bounced. | [optional] |
-| **opened** | **Boolean** | Trigger webhook on email message being opened. | [optional] |
-| **clicked** | **Boolean** | Trigger webhook on email message link being clicked. | [optional] |
-| **unsubscribed** | **Boolean** | Trigger webhook on email message being unsubscribed. | [optional] |
-| **spam** | **Boolean** | Trigger webhook on email message being marked as spam. | [optional] |
-| **sent** | **Boolean** | Trigger webhook on email message being sent. | [optional] |
-| **smtp_dropped** | **Boolean** | Trigger webhook on email message being dropped by SMTP. | [optional] |
-| **unique_open** | **Boolean** | Trigger webhook on unique email opens. | [optional] |
-| **unique_click** | **Boolean** | Trigger webhook on unique email clicks. | [optional] |
+| **enabled** | **Boolean** | Whether the webhook is active immediately after creation. Set to false to configure and test before activating.  | [optional][default to true] |
+| **url** | **String** | HTTPS URL endpoint to receive webhook POST requests. Must: - Use HTTPS (HTTP not allowed for security) - Be publicly accessible - Return 2xx status within 10 seconds - Handle duplicate deliveries (use eventId for idempotency)  |  |
+| **processed** | **Boolean** | Fire when email is accepted by SendPost API | [optional][default to false] |
+| **sent** | **Boolean** | Fire when email is sent to recipient's mail server | [optional][default to false] |
+| **delivered** | **Boolean** | Fire when email is accepted by recipient's mail server | [optional][default to true] |
+| **dropped** | **Boolean** | Fire when email is not sent (suppression, invalid, etc.) | [optional][default to true] |
+| **smtp_dropped** | **Boolean** | Fire when email is rejected at SMTP level | [optional][default to false] |
+| **soft_bounced** | **Boolean** | Fire on temporary delivery failure (will retry) | [optional][default to true] |
+| **hard_bounced** | **Boolean** | Fire on permanent delivery failure | [optional][default to true] |
+| **opened** | **Boolean** | Fire when email is opened. Fires on EVERY open. Consider using `uniqueOpen` instead to reduce volume.  | [optional][default to true] |
+| **clicked** | **Boolean** | Fire when a link is clicked. Fires on EVERY click. Consider using `uniqueClick` instead to reduce volume.  | [optional][default to true] |
+| **unsubscribed** | **Boolean** | Fire when recipient clicks unsubscribe link | [optional][default to true] |
+| **spam** | **Boolean** | Fire when recipient marks email as spam | [optional][default to true] |
+| **unique_open** | **Boolean** | Fire only on FIRST open of each email (unique opens). More efficient than `opened` if you only need engagement metrics.  | [optional][default to false] |
+| **unique_click** | **Boolean** | Fire only on FIRST click of each email (unique clicks). More efficient than `clicked` if you only need engagement metrics.  | [optional][default to false] |
 
 ## Example
 
@@ -27,20 +27,20 @@ require 'sendpost_ruby_sdk'
 
 instance = Sendpost::UpdateWebhook.new(
   enabled: true,
-  url: https://app.hooli.com/email/webhook,
-  processed: true,
+  url: https://app.hooli.com/api/webhooks/sendpost,
+  processed: false,
+  sent: false,
   delivered: true,
-  dropped: false,
-  soft_bounced: false,
+  dropped: true,
+  smtp_dropped: false,
+  soft_bounced: true,
   hard_bounced: true,
   opened: true,
   clicked: true,
   unsubscribed: true,
   spam: true,
-  sent: true,
-  smtp_dropped: false,
-  unique_open: true,
-  unique_click: true
+  unique_open: false,
+  unique_click: false
 )
 ```
 

data/docs/UserAgent.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **family** | **String** |  | [optional] |
-| **major** | **String** |  | [optional] |
-| **minor** | **String** |  | [optional] |
-| **patch** | **String** |  | [optional] |
+| **family** | **String** | Browser or email client family name. Common values: Chrome, Safari, Firefox, Outlook, Apple Mail, Gmail  | [optional] |
+| **major** | **String** | Major version number | [optional] |
+| **minor** | **String** | Minor version number | [optional] |
+| **patch** | **String** | Patch version number | [optional] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::UserAgent.new(
-  family: Mozilla,
-  major: 5.0,
+  family: Chrome,
+  major: 120,
   minor: 0,
-  patch: 0
+  patch: 6099
 )
 ```
 

data/docs/ValidationStat.md

@@ -0,0 +1,32 @@
+# Sendpost::ValidationStat
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **initiated** | **Integer** | Number of validation requests initiated. | [optional] |
+| **processed** | **Integer** | Number of validation requests fully processed. | [optional] |
+| **valid** | **Integer** | Number of addresses determined to be valid/deliverable. | [optional] |
+| **invalid** | **Integer** | Number of addresses determined to be invalid/undeliverable. | [optional] |
+| **soft_bounced** | **Integer** | Number of addresses that soft-bounced during validation. | [optional] |
+| **hard_bounced** | **Integer** | Number of addresses that hard-bounced during validation. | [optional] |
+| **catch_all** | **Integer** | Number of addresses on catch-all (accept-all) domains. | [optional] |
+| **unknown** | **Integer** | Number of addresses whose deliverability could not be determined. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::ValidationStat.new(
+  initiated: 1000,
+  processed: 980,
+  valid: 820,
+  invalid: 90,
+  soft_bounced: 20,
+  hard_bounced: 15,
+  catch_all: 25,
+  unknown: 10
+)
+```
+

data/docs/Webhook.md

@@ -4,25 +4,26 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the webhook. | [optional] |
-| **enabled** | **Boolean** | Indicates if the webhook is active or paused. | [optional] |
-| **url** | **String** | URL endpoint to which webhook calls need to be made. | [optional] |
-| **processed** | **Boolean** | Trigger webhook on email message being processed. | [optional] |
-| **delivered** | **Boolean** | Trigger webhook on email message being delivered. | [optional] |
-| **dropped** | **Boolean** | Trigger webhook on email message being dropped. | [optional] |
-| **soft_bounced** | **Boolean** | Trigger webhook on email message being soft bounced. | [optional] |
-| **hard_bounced** | **Boolean** | Trigger webhook on email message being hard bounced. | [optional] |
-| **opened** | **Boolean** | Trigger webhook on email message being opened. | [optional] |
-| **clicked** | **Boolean** | Trigger webhook on email message link being clicked. | [optional] |
-| **unsubscribed** | **Boolean** | Trigger webhook on email message being unsubscribed. | [optional] |
-| **spam** | **Boolean** | Trigger webhook on email message being marked as spam. | [optional] |
-| **sent** | **Boolean** | Trigger webhook on email message being sent. | [optional] |
-| **smtp_dropped** | **Boolean** | Trigger webhook on email message being dropped by SMTP. | [optional] |
-| **unique_open** | **Boolean** | Trigger webhook on unique email opens. | [optional] |
-| **unique_click** | **Boolean** | Trigger webhook on unique email clicks. | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the webhook was created. | [optional] |
-| **created_by** | **Hash<String, Object>** | Member who created the webhook | [optional] |
-| **updated_by** | **Hash<String, Object>** | Member who updated the webhook | [optional] |
+| **id** | **Integer** | Unique identifier for the webhook configuration | [optional] |
+| **enabled** | **Boolean** | Whether the webhook is active. When false, no events will be sent to this webhook. Useful for temporarily pausing notifications during maintenance.  | [optional] |
+| **url** | **String** | HTTPS endpoint URL to receive webhook POST requests. Must be publicly accessible and return 2xx status code.  | [optional] |
+| **processed** | **Boolean** | Trigger webhook when an email is accepted for processing. Fires immediately when API call is successful.  | [optional] |
+| **sent** | **Boolean** | Trigger webhook when an email is sent to the recipient's mail server. Indicates the email left SendPost's infrastructure.  | [optional] |
+| **dropped** | **Boolean** | Trigger webhook when an email is dropped before sending. Common reasons: suppressed address, invalid email, unverified domain.  | [optional] |
+| **smtp_dropped** | **Boolean** | Trigger webhook when an email is dropped at SMTP level. Usually due to policy rejection by receiving server.  | [optional] |
+| **delivered** | **Boolean** | Trigger webhook when an email is successfully delivered. Note: \"Delivered\" means accepted by mail server, not inbox placement.  | [optional] |
+| **soft_bounced** | **Boolean** | Trigger webhook on temporary delivery failure (soft bounce). SendPost will retry delivery automatically.  | [optional] |
+| **hard_bounced** | **Boolean** | Trigger webhook on permanent delivery failure (hard bounce). The recipient is automatically added to suppression list.  | [optional] |
+| **opened** | **Boolean** | Trigger webhook when recipient opens the email. Fires on every open (can fire multiple times per email).  | [optional] |
+| **clicked** | **Boolean** | Trigger webhook when recipient clicks a link. Fires on every click (can fire multiple times per email).  | [optional] |
+| **unsubscribed** | **Boolean** | Trigger webhook when recipient clicks the unsubscribe link. The recipient is automatically added to suppression list.  | [optional] |
+| **spam** | **Boolean** | Trigger webhook when recipient marks email as spam. The recipient is automatically added to suppression list. Monitor this closely - high spam rates damage sender reputation.  | [optional] |
+| **unique_open** | **Boolean** | Trigger webhook only on the first open of an email (unique opens). Use this instead of 'opened' if you only care about unique engagement.  | [optional] |
+| **unique_click** | **Boolean** | Trigger webhook only on the first click of an email (unique clicks). Use this instead of 'clicked' if you only care about unique engagement.  | [optional] |
+| **status** | **String** | Health status of the webhook (read-only): - `active` - delivering normally - `degraded` - recent delivery failures - `disabled` - auto-disabled after repeated consecutive failures  | [optional] |
+| **disabled_at** | **Integer** | UNIX epoch timestamp in nanoseconds when the webhook was auto-disabled (0 if never). Read-only. | [optional] |
+| **disabled_reason** | **String** | Human-readable reason the webhook was auto-disabled (empty if active). Read-only. | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the webhook was created | [optional] |
 
 ## Example
 
@@ -32,23 +33,24 @@ require 'sendpost_ruby_sdk'
 instance = Sendpost::Webhook.new(
   id: 117,
   enabled: true,
-  url: https://app.hooli.com/email/webhook,
+  url: https://app.hooli.com/api/webhooks/sendpost,
   processed: true,
+  sent: true,
+  dropped: true,
+  smtp_dropped: false,
   delivered: true,
-  dropped: false,
-  soft_bounced: false,
+  soft_bounced: true,
   hard_bounced: true,
   opened: true,
   clicked: true,
   unsubscribed: true,
   spam: true,
-  sent: true,
-  smtp_dropped: false,
-  unique_open: true,
-  unique_click: true,
-  created: 1567512491588004044,
-  created_by: null,
-  updated_by: null
+  unique_open: false,
+  unique_click: false,
+  status: active,
+  disabled_at: 0,
+  disabled_reason: ,
+  created: 1704067200000000000
 )
 ```
 

data/docs/WebhookApi.md

@@ -13,11 +13,11 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 ## create_webhook
 
-> <Webhook> create_webhook(create_webhook_request)
+> <Webhook> create_webhook(new_webhook)
 
 Create Webhook
 
-Create a new webhook by specifying its properties.
+Create a new webhook to receive real-time notifications for email events. Your endpoint will receive HTTP POST requests with event data as they occur.  **Endpoint Requirements:** - Must be publicly accessible HTTPS URL - Should return 2xx status within 30 seconds - Handle potential duplicate events (use event ID for deduplication) - Implement retry/queue logic for reliability  **Choosing Events:** - **Engagement Tracking:** `uniqueOpened`, `uniqueClicked` for metrics - **Full History:** `opened`, `clicked` for complete event logs - **Delivery Monitoring:** `delivered`, `hardBounced`, `softBounced` - **Compliance:** `unsubscribed`, `spam`  **Best Practices:** - Only enable events you actually need - Store events before processing (async processing) - Implement idempotency using event IDs - Set up monitoring for webhook failures  **Webhook Payload Example:** ```json {   \"eventId\": \"evt_123\",   \"event\": \"delivered\",   \"messageId\": \"msg_456\",   \"recipient\": \"user@example.com\",   \"timestamp\": \"2024-01-15T10:30:00Z\" } ``` 
 
 ### Examples
 
@@ -33,11 +33,11 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::WebhookApi.new
-create_webhook_request = Sendpost::CreateWebhookRequest.new # CreateWebhookRequest | 
+new_webhook = Sendpost::NewWebhook.new({url: 'https://app.hooli.com/api/webhooks/sendpost'}) # NewWebhook | 
 
 begin
   # Create Webhook
-  result = api_instance.create_webhook(create_webhook_request)
+  result = api_instance.create_webhook(new_webhook)
   p result
 rescue Sendpost::ApiError => e
   puts "Error when calling WebhookApi->create_webhook: #{e}"
@@ -48,12 +48,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Webhook>, Integer, Hash)> create_webhook_with_http_info(create_webhook_request)
+> <Array(<Webhook>, Integer, Hash)> create_webhook_with_http_info(new_webhook)
 
 ```ruby
 begin
   # Create Webhook
-  data, status_code, headers = api_instance.create_webhook_with_http_info(create_webhook_request)
+  data, status_code, headers = api_instance.create_webhook_with_http_info(new_webhook)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Webhook>
@@ -66,7 +66,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md) |  |  |
+| **new_webhook** | [**NewWebhook**](NewWebhook.md) |  |  |
 
 ### Return type
 
@@ -88,7 +88,7 @@ end
 
 Delete Webhook
 
-Delete a webhook by its ID.
+Remove a webhook from your account. After deletion, no further events will be sent to that endpoint.  **Before Deleting:** - Ensure your application doesn't rely on these events - Consider updating to a new webhook instead if you're migrating  **Note:** Events that occurred before deletion are not affected. Historical data remains intact. 
 
 ### Examples
 
@@ -104,7 +104,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::WebhookApi.new
-webhook_id = 117 # Integer | ID of the webhook to delete.
+webhook_id = 117 # Integer | The unique ID of the webhook to delete.
 
 begin
   # Delete Webhook
@@ -137,7 +137,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **webhook_id** | **Integer** | ID of the webhook to delete. |  |
+| **webhook_id** | **Integer** | The unique ID of the webhook to delete. |  |
 
 ### Return type
 
@@ -155,11 +155,11 @@ end
 
 ## get_all_webhooks
 
-> <Array<Webhook>> get_all_webhooks(opts)
+> <Array<AccountWebhookWithStats>> get_all_webhooks(opts)
 
 List Webhooks
 
-Retrieves a list of all webhooks, their endpoints, and the events for which they are active.
+Retrieve all configured webhooks for your account. Webhooks enable real-time notifications when email events occur, allowing you to build reactive applications.  **Supported Events:** | Event | Description | |-------|-------------| | `processed` | Email accepted and queued for delivery | | `dropped` | Email blocked (suppressed, invalid, policy) | | `delivered` | Email successfully delivered to recipient | | `hardBounced` | Permanent delivery failure | | `softBounced` | Temporary delivery failure | | `opened` | Recipient opened the email (all opens) | | `uniqueOpened` | First open per recipient only | | `clicked` | Recipient clicked a link (all clicks) | | `uniqueClicked` | First click per recipient only | | `unsubscribed` | Recipient unsubscribed | | `spam` | Recipient marked email as spam |  **Use Cases:** - Audit configured webhook endpoints - Verify webhook URLs are correct - Review enabled events per webhook - Debug webhook delivery issues 
 
 ### Examples
 
@@ -176,9 +176,9 @@ end
 
 api_instance = Sendpost::WebhookApi.new
 opts = {
-  limit: 10, # Integer | Number of records to return per request.
-  offset: 0, # Integer | Number of initial records to skip.
-  search: 'hooli' # String | Case insensitive search against webhook URL.
+  limit: 10, # Integer | Number of records to return per request. Default 20.
+  offset: 0, # Integer | Number of initial records to skip for pagination.
+  search: 'api.yoursite.com' # String | Case insensitive search against webhook URLs.
 }
 
 begin
@@ -194,7 +194,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<Webhook>>, Integer, Hash)> get_all_webhooks_with_http_info(opts)
+> <Array(<Array<AccountWebhookWithStats>>, Integer, Hash)> get_all_webhooks_with_http_info(opts)
 
 ```ruby
 begin
@@ -202,7 +202,7 @@ begin
   data, status_code, headers = api_instance.get_all_webhooks_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<Webhook>>
+  p data # => <Array<AccountWebhookWithStats>>
 rescue Sendpost::ApiError => e
   puts "Error when calling WebhookApi->get_all_webhooks_with_http_info: #{e}"
 end
@@ -212,13 +212,13 @@ 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 webhook URL. | [optional] |
+| **limit** | **Integer** | Number of records to return per request. Default 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 webhook URLs. | [optional] |
 
 ### Return type
 
-[**Array&lt;Webhook&gt;**](Webhook.md)
+[**Array&lt;AccountWebhookWithStats&gt;**](AccountWebhookWithStats.md)
 
 ### Authorization
 
@@ -236,7 +236,7 @@ end
 
 Get Webhook
 
-Retrieves a specific webhook based on its ID.
+Retrieve detailed information about a specific webhook, including its endpoint URL and enabled events.  **Use Cases:** - Verify webhook configuration - Debug event delivery issues - Check enabled events for a webhook - Audit webhook settings 
 
 ### Examples
 
@@ -252,7 +252,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::WebhookApi.new
-webhook_id = 117 # Integer | The ID of the webhook to retrieve.
+webhook_id = 117 # Integer | The unique ID of the webhook to retrieve.
 
 begin
   # Get Webhook
@@ -285,7 +285,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **webhook_id** | **Integer** | The ID of the webhook to retrieve. |  |
+| **webhook_id** | **Integer** | The unique ID of the webhook to retrieve. |  |
 
 ### Return type
 
@@ -307,7 +307,7 @@ end
 
 Update Webhook
 
-Update the properties of an existing webhook.
+Modify an existing webhook's configuration. Use this to change the endpoint URL or update which events trigger notifications.  **What Can Be Updated:** - Webhook endpoint URL - Enabled/disabled events - Event-specific settings  **Use Cases:** - Migrate to a new endpoint URL - Enable additional events as needs grow - Disable events to reduce traffic - Update after infrastructure changes 
 
 ### Examples
 
@@ -323,8 +323,8 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::WebhookApi.new
-update_webhook = Sendpost::UpdateWebhook.new # UpdateWebhook | 
-webhook_id = 117 # Integer | ID of the webhook to update.
+update_webhook = Sendpost::UpdateWebhook.new({url: 'https://app.hooli.com/api/webhooks/sendpost'}) # UpdateWebhook | 
+webhook_id = 117 # Integer | The unique ID of the webhook to update.
 
 begin
   # Update Webhook
@@ -358,7 +358,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **update_webhook** | [**UpdateWebhook**](UpdateWebhook.md) |  |  |
-| **webhook_id** | **Integer** | ID of the webhook to update. |  |
+| **webhook_id** | **Integer** | The unique ID of the webhook to update. |  |
 
 ### Return type
 

data/docs/WebhookObject.md

@@ -0,0 +1,20 @@
+# Sendpost::WebhookObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | [**Event**](Event.md) | Details about the email event that triggered this webhook | [optional] |
+| **email_message** | [**EmailMessage**](EmailMessage.md) | The original email message associated with this event | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::WebhookObject.new(
+  event: null,
+  email_message: null
+)
+```
+