sendpost_ruby_sdk 2.0.0 → 3.0.0

data/docs/Stat.md

@@ -4,8 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Date for which stats are retrieved (UTC). | [optional] |
-| **stats** | [**StatStats**](StatStats.md) |  | [optional] |
+| **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] |
 
 ## Example
 
@@ -13,8 +22,17 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::Stat.new(
-  date: 2020-03-12,
-  stats: null
+  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
 )
 ```
 

data/docs/StatsAApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Get Account Aggregate Stats
 
-Retrieve aggregated email statistics for all sub-accounts of a specific account for a given date range.
+Retrieve summarized email statistics across all sub-accounts for a date range. Returns a single aggregated record—perfect for high-level reporting and dashboards.  **Use Cases:** - Annual email program review - Quarterly business reports - Month-over-month comparison - Board-level metrics - ROI calculations for email program  **Example:** Get full year stats for 2024: ``` GET /account/stat/aggregate?from=2024-01-01&to=2024-12-31 ```  **Note:** Maximum date range is 366 days (1 year). 
 
 ### Examples
 
@@ -32,8 +32,8 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsAApi.new
-from = Date.parse('2019-01-01') # Date | The start date for retrieving aggregated stats (inclusive)
-to = Date.parse('2019-12-31') # Date | The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days.
+from = Date.parse('2024-01-01') # Date | Start date for aggregation (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-12-31') # Date | End date for aggregation (inclusive). Max 366 days from `from` date.
 
 begin
   # Get Account Aggregate Stats
@@ -66,8 +66,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | **Date** | The start date for retrieving aggregated stats (inclusive) |  |
-| **to** | **Date** | The end date for retrieving aggregated stats (inclusive). The difference between `from` and `to` should not exceed 366 days. |  |
+| **from** | **Date** | Start date for aggregation (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for aggregation (inclusive). Max 366 days from `from` date. |  |
 
 ### Return type
 
@@ -89,7 +89,7 @@ end
 
 Get Account Group Aggregate Stats
 
-Gets aggregated email stats for a specific group in all sub-accounts of a specific account for the given daterange. The maximum daterange for which these stats can be retrieved is 366 days.
+Retrieve summarized email statistics for a specific group across all sub-accounts. Returns a single aggregated record for the group—ideal for campaign reporting.  **Use Cases:** - Annual performance report for a specific product integration - Compare total metrics for different campaigns - Summarize email performance for a specific customer segment - Calculate ROI for a marketing campaign by group  **Example:** Get yearly stats for Shopify integration: ``` GET /account/stat/aggregate/group?group=shopify&from=2024-01-01&to=2024-12-31 ```  **Note:** Maximum date range is 366 days (1 year). 
 
 ### Examples
 
@@ -105,9 +105,9 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsAApi.new
-group = 'shopify' # String | Group whose aggregate stats need to be retrieved.
-from = Date.parse('2019-01-01') # Date | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`).
-to = Date.parse('2019-12-31') # Date | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days.
+group = 'shopify' # String | The group/tag name to filter and aggregate statistics by.
+from = Date.parse('2024-01-01') # Date | Start date for aggregation (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-12-31') # Date | End date for aggregation (inclusive). Max 366 days from `from` date.
 
 begin
   # Get Account Group Aggregate Stats
@@ -140,9 +140,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **group** | **String** | Group whose aggregate stats need to be retrieved. |  |
-| **from** | **Date** | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`). |  |
-| **to** | **Date** | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 366 days. |  |
+| **group** | **String** | The group/tag name to filter and aggregate statistics by. |  |
+| **from** | **Date** | Start date for aggregation (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for aggregation (inclusive). Max 366 days from `from` date. |  |
 
 ### Return type
 
@@ -164,7 +164,7 @@ end
 
 List Account Group Stats
 
-Gets a list of all email stats for all sub-accounts of a specific account by group for a given daterange. The maximum daterange for which these stats can be retrieved is 31 days.
+Retrieve daily email statistics for a specific group across all sub-accounts. Returns one record per day, filtered by the group/tag you specify.  **What are Groups?** Groups (tags) are labels attached to emails when sending. They enable segmented analytics across your entire account.  **Common Group Strategies:** | Strategy | Example Groups | |----------|----------------| | By Product | `shopify`, `wordpress`, `api-direct` | | By Type | `transactional`, `marketing`, `alerts` | | By Team | `sales-team`, `support`, `engineering` | | By Campaign | `black-friday-2024`, `summer-sale` |  **Use Cases:** - Compare performance across products/integrations - Track specific campaign performance account-wide - Analyze transactional vs marketing metrics - Benchmark different teams' email performance  **Note:** Maximum date range is 31 days. 
 
 ### Examples
 
@@ -180,9 +180,9 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsAApi.new
-group = 'shopify' # String | Group whose stats need to be retrieved
-from = Date.parse('2020-03-12') # Date | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`)
-to = Date.parse('2020-04-14') # Date | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days.
+group = 'shopify' # String | The group/tag name to filter statistics by.
+from = Date.parse('2024-01-01') # Date | Start date for stats retrieval (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-01-31') # Date | End date for stats retrieval (inclusive). Max 31 days from `from` date.
 
 begin
   # List Account Group Stats
@@ -215,9 +215,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **group** | **String** | Group whose stats need to be retrieved |  |
-| **from** | **Date** | Date from which stats should be retrieved (should be in the format `YYYY-MM-DD`) |  |
-| **to** | **Date** | Date to which stats should be retrieved (should be in the format `YYYY-MM-DD`). Note that the difference between `from` and `to` should not be more than 31 days. |  |
+| **group** | **String** | The group/tag name to filter statistics by. |  |
+| **from** | **Date** | Start date for stats retrieval (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for stats retrieval (inclusive). Max 31 days from `from` date. |  |
 
 ### Return type
 
@@ -239,7 +239,7 @@ end
 
 List Account Stats
 
-Retrieve email statistics for all sub-accounts of a specific account for a given date range.
+Retrieve daily email statistics aggregated across all sub-accounts. Returns one record per day within the date range—ideal for organization-wide reporting.  **Metrics Per Day:** | Metric | Description | |--------|-------------| | `processed` | Total emails submitted across all sub-accounts | | `delivered` | Successfully delivered to recipients | | `dropped` | Blocked before sending | | `hardBounced` | Permanent delivery failures | | `softBounced` | Temporary delivery failures | | `opens` | Total email opens | | `clicks` | Total link clicks | | `unsubscribed` | Recipients who unsubscribed | | `spams` | Spam complaints received |  **Use Cases:** - Organization-wide email performance dashboard - Billing and usage tracking across all sub-accounts - Executive reporting for email program health - Trend analysis across your entire email operation  **Note:** Maximum date range is 31 days. 
 
 ### Examples
 
@@ -255,8 +255,8 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsAApi.new
-from = Date.parse('2020-03-12') # Date | The start date for retrieving stats (inclusive)
-to = Date.parse('2020-04-14') # Date | The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days.
+from = Date.parse('2024-01-01') # Date | Start date for stats retrieval (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-01-31') # Date | End date for stats retrieval (inclusive). Max 31 days from `from` date.
 
 begin
   # List Account Stats
@@ -289,8 +289,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | **Date** | The start date for retrieving stats (inclusive) |  |
-| **to** | **Date** | The end date for retrieving stats (inclusive). The difference between `from` and `to` should not exceed 31 days. |  |
+| **from** | **Date** | Start date for stats retrieval (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for stats retrieval (inclusive). Max 31 days from `from` date. |  |
 
 ### Return type
 

data/docs/StatsApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Get Aggregate Stats
 
-Retrieves aggregated email stats for a specific sub-account for a date range.   **Note**: The maximum date range is 366 days. 
+Retrieve summarized email statistics for a sub-account over a date range. Unlike daily stats, this returns a single record with totals across all days—ideal for high-level reporting.  **Response includes total counts for:** - `processed` - Total emails submitted - `delivered` - Successfully delivered - `dropped` - Blocked before sending - `hardBounced` / `softBounced` - Bounce breakdowns - `opens` / `clicks` - Engagement totals - `unsubscribed` / `spams` - Negative signals  **Use Cases:** - Monthly performance reports - Executive dashboards - Billing period summaries - Year-over-year comparisons - SLA compliance reports  **Example:** To get Q1 2024 totals: ``` GET /account/subaccount/stat/11/aggregate?from=2024-01-01&to=2024-03-31 ```  **Note:** Maximum date range is 366 days (1 year). 
 
 ### Examples
 
@@ -31,9 +31,9 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsApi.new
-from = Date.parse('2013-10-20') # Date | Start date for stats retrieval.
-to = Date.parse('2013-10-20') # Date | Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) 
-subaccount_id = 11 # Integer | The ID of the subaccount to retrieve
+from = Date.parse('2024-01-01') # Date | Start date for aggregation (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-03-31') # Date | End date for aggregation (inclusive). Max 366 days from `from` date.
+subaccount_id = 11 # Integer | The unique ID of the sub-account.
 
 begin
   # Get Aggregate Stats
@@ -66,9 +66,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | **Date** | Start date for stats retrieval. |  |
-| **to** | **Date** | Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days )  |  |
-| **subaccount_id** | **Integer** | The ID of the subaccount to retrieve |  |
+| **from** | **Date** | Start date for aggregation (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for aggregation (inclusive). Max 366 days from `from` date. |  |
+| **subaccount_id** | **Integer** | The unique ID of the sub-account. |  |
 
 ### Return type
 
@@ -90,7 +90,7 @@ end
 
 List Stats
 
-Retrieves a list of email stats for a specific sub-account within a given date range. Both `from` and `to` dates are inclusive.   **Note**: The maximum date range is 31 days. 
+Retrieve daily email statistics for a specific sub-account. Returns one record per day within the date range, perfect for charting trends and identifying patterns.  **Metrics Per Day:** | Metric | Description | |--------|-------------| | `processed` | Emails submitted to SendPost | | `delivered` | Successfully delivered to recipient's mailbox | | `dropped` | Blocked before sending (suppressed, invalid, etc.) | | `hardBounced` | Permanent failures (invalid address, domain doesn't exist) | | `softBounced` | Temporary failures (mailbox full, server down) | | `opens` | Total email opens (includes multiple opens per recipient) | | `clicks` | Total link clicks | | `unsubscribed` | Recipients who unsubscribed | | `spams` | Emails marked as spam by recipients |  **Key Rates to Calculate:** - Delivery Rate = `delivered / processed × 100` - Open Rate = `opens / delivered × 100` - Click Rate = `clicks / delivered × 100` - Bounce Rate = `(hardBounced + softBounced) / processed × 100`  **Use Cases:** - Daily performance dashboard - Week-over-week trend analysis - Identifying delivery issues early - SLA monitoring and reporting  **Note:** Maximum date range is 31 days. Both `from` and `to` dates are inclusive. 
 
 ### Examples
 
@@ -106,9 +106,9 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsApi.new
-from = Date.parse('2013-10-20') # Date | Start date for stats retrieval.
-to = Date.parse('2013-10-20') # Date | Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days ) 
-subaccount_id = 11 # Integer | The ID of the subaccount to retrieve
+from = Date.parse('2024-01-01') # Date | Start date for stats retrieval (inclusive). Format YYYY-MM-DD.
+to = Date.parse('2024-01-31') # Date | End date for stats retrieval (inclusive). Must be after `from` date with max 31 days range.
+subaccount_id = 11 # Integer | The unique ID of the sub-account to retrieve stats for.
 
 begin
   # List Stats
@@ -141,9 +141,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **from** | **Date** | Start date for stats retrieval. |  |
-| **to** | **Date** | Date to which stats should be retrieved ( Note than from date should be earlier than to date. Also the difference between from and to date shouldn't ne more than 60 days )  |  |
-| **subaccount_id** | **Integer** | The ID of the subaccount to retrieve |  |
+| **from** | **Date** | Start date for stats retrieval (inclusive). Format YYYY-MM-DD. |  |
+| **to** | **Date** | End date for stats retrieval (inclusive). Must be after `from` date with max 31 days range. |  |
+| **subaccount_id** | **Integer** | The unique ID of the sub-account to retrieve stats for. |  |
 
 ### Return type
 
@@ -165,7 +165,7 @@ end
 
 Get Group Aggregate Stats
 
-Retrieves aggregated email stats for a specific group in a sub-account for the specified daterange. The maximum daterange for which these stats can be retrieved is 366 days. Ensure that the difference between the `from` and `to` dates does not exceed 366 days. 
+Retrieve aggregated email statistics filtered by a specific group/tag. Groups are labels you assign when sending emails to categorize and segment your analytics.  **What are Groups?** Groups (also called tags) are strings you attach to emails when sending. They help you: - Track different email types (transactional vs marketing) - Segment by campaign or feature - Compare performance across categories  **Setting Groups When Sending:** ```json {   \"from\": { \"email\": \"orders@shop.com\" },   \"to\": [{ \"email\": \"customer@example.com\" }],   \"subject\": \"Order Confirmation\",   \"groups\": [\"order-confirmations\", \"transactional\"] } ```  **Use Cases:** - Compare welcome email vs password reset performance - Track marketing campaign performance by campaign ID - Measure transactional vs promotional email metrics - Analyze A/B test results by variant group  **Example:** Get stats for \"welcome-emails\" group: ``` GET /account/subaccount/stat/11/group?group=welcome-emails&from=2024-01-01&to=2024-03-31 ```  **Note:** Maximum date range is 366 days. 
 
 ### Examples
 
@@ -181,8 +181,8 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::StatsApi.new
-group = 'group_example' # String | Group whose aggregated stats need to be retrieved
-from = Date.parse('2013-10-20') # Date | The starting date for the aggregated stats
+group = 'order-confirmations' # String | The group/tag name to filter statistics by. Must match the group name used when sending emails.
+from = Date.parse('2024-01-01') # Date | Start date for aggregation (inclusive). Format YYYY-MM-DD.
 to = Date.parse('2013-10-20') # Date | The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days) 
 subaccount_id = 11 # Integer | The ID of the subaccount to retrieve
 
@@ -217,8 +217,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **group** | **String** | Group whose aggregated stats need to be retrieved |  |
-| **from** | **Date** | The starting date for the aggregated stats |  |
+| **group** | **String** | The group/tag name to filter statistics by. Must match the group name used when sending emails. |  |
+| **from** | **Date** | Start date for aggregation (inclusive). Format YYYY-MM-DD. |  |
 | **to** | **Date** | The ending date for the aggregated stats (Note: `from` should be earlier than `to` and the date range should not exceed 366 days)  |  |
 | **subaccount_id** | **Integer** | The ID of the subaccount to retrieve |  |
 

data/docs/SubAccount.md

@@ -4,22 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the sub-account. | [optional] |
-| **api_key** | **String** | API key for the sub-account. | [optional] |
-| **name** | **String** | Name of the sub-account. | [optional] |
-| **labels** | [**Array<Label>**](Label.md) | Labels associated with the sub-account | [optional] |
-| **smtp_auths** | [**Array<SMTPAuth>**](SMTPAuth.md) | SMTP Auths associated with the sub-account | [optional] |
-| **type** | **Integer** | Type of the sub-account | [optional] |
-| **is_plus** | **Boolean** | Indicates whether the sub-account is a Plus sub-account | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the sub-account was created. | [optional] |
-| **created_by** | **Hash<String, Object>** | Member who created the sub-account | [optional] |
-| **updated_by** | **Hash<String, Object>** | Member who updated the sub-account | [optional] |
-| **blocked** | **Boolean** | Indicates whether the sub-account is blocked | [optional] |
-| **blocked_at** | **Integer** | UNIX epoch nano timestamp when the sub-account was blocked (0 if not blocked) | [optional] |
-| **block_reason** | **String** | Reason for blocking the sub-account | [optional] |
-| **hb_exempt** | **Boolean** | Indicates whether the sub-account is exempt from hard bounce tracking | [optional] |
-| **generate_weekly_report** | **Boolean** | Indicates whether weekly reports are generated for this sub-account | [optional] |
-| **handlers** | **Array<String>** | Handlers associated with the sub-account | [optional] |
+| **id** | **Integer** | Unique identifier for the sub-account | [optional] |
+| **account_id** | **Integer** | Identifier of the parent account this sub-account belongs to | [optional] |
+| **name** | **String** | Display name for the sub-account. Must be unique within your account. Use descriptive names.  | [optional] |
+| **api_key** | **String** | API key for this sub-account. Use this as the `X-SubAccount-ApiKey` header when making API calls for this sub-account (sending emails, managing domains, etc.).  **Security:** Treat this like a password. Rotate if compromised.  | [optional] |
+| **type** | **Integer** | Type of sub-account: - `0` = Default (the primary sub-account created with your account) - `1` = Custom (additional sub-accounts you create)  Note: The default sub-account cannot be deleted.  | [optional] |
+| **is_plus** | **Boolean** | Whether this sub-account belongs to a SendX Plus customer. SendX Plus is a premium tier that provides enhanced features and support.  | [optional] |
+| **labels** | [**Array<Label>**](Label.md) | Custom labels for organizing and filtering sub-accounts | [optional] |
+| **blocked** | **Boolean** | Whether the sub-account is blocked from sending. A blocked sub-account cannot send emails. Common reasons: - High bounce/spam rates - Billing issues - Policy violations - Manual suspension by administrator  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the sub-account was created | [optional] |
 
 ## Example
 
@@ -28,21 +21,14 @@ require 'sendpost_ruby_sdk'
 
 instance = Sendpost::SubAccount.new(
   id: 50441,
+  account_id: 4021,
+  name: Transactional - Production,
   api_key: pR0YIuxYSbVwmQi2Y8Qs,
-  name: API,
-  labels: [],
-  smtp_auths: null,
   type: 1,
   is_plus: false,
-  created: 1733844681120384500,
-  created_by: null,
-  updated_by: null,
+  labels: null,
   blocked: false,
-  blocked_at: 0,
-  block_reason: ,
-  hb_exempt: false,
-  generate_weekly_report: false,
-  handlers: []
+  created: 1704067200000000000
 )
 ```
 

data/docs/SubAccountApi.md

@@ -13,11 +13,11 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 ## create_sub_account
 
-> <SubAccount> create_sub_account(create_sub_account_request)
+> <SubAccount> create_sub_account(new_sub_account)
 
 Create Sub-Account
 
-Creates a new sub-account under the current account.
+Create a new sub-account to segment your email sending. Each sub-account gets its own API key, suppression list, and statistics.  **What You Get:** - Unique `X-SubAccount-ApiKey` for authentication - Isolated email statistics - Separate suppression management - Independent domain configuration - Optional SMTP credentials  **Naming Best Practices:** - Use descriptive names: `Transactional_Orders`, `Marketing_Newsletter` - Include environment: `Production_Alerts`, `Staging_Tests` - For multi-tenant: `Client_CompanyName`  **Use Cases:** - New application or microservice needing email - Onboarding a new client in multi-tenant setup - Creating isolated testing environment - Separating email streams for analytics 
 
 ### Examples
 
@@ -33,11 +33,11 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::SubAccountApi.new
-create_sub_account_request = Sendpost::CreateSubAccountRequest.new # CreateSubAccountRequest | 
+new_sub_account = Sendpost::NewSubAccount.new({name: 'Marketing - Production'}) # NewSubAccount | 
 
 begin
   # Create Sub-Account
-  result = api_instance.create_sub_account(create_sub_account_request)
+  result = api_instance.create_sub_account(new_sub_account)
   p result
 rescue Sendpost::ApiError => e
   puts "Error when calling SubAccountApi->create_sub_account: #{e}"
@@ -48,12 +48,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SubAccount>, Integer, Hash)> create_sub_account_with_http_info(create_sub_account_request)
+> <Array(<SubAccount>, Integer, Hash)> create_sub_account_with_http_info(new_sub_account)
 
 ```ruby
 begin
   # Create Sub-Account
-  data, status_code, headers = api_instance.create_sub_account_with_http_info(create_sub_account_request)
+  data, status_code, headers = api_instance.create_sub_account_with_http_info(new_sub_account)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SubAccount>
@@ -66,7 +66,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_sub_account_request** | [**CreateSubAccountRequest**](CreateSubAccountRequest.md) |  |  |
+| **new_sub_account** | [**NewSubAccount**](NewSubAccount.md) |  |  |
 
 ### Return type
 
@@ -88,7 +88,7 @@ end
 
 Delete Sub-Account
 
-Deletes a specific sub-account by its ID.
+Remove a sub-account from your organization. This action is irreversible.  **⚠️ Before Deleting:** - Export any needed statistics or suppression lists - Update applications using this sub-account's API key - Ensure no active email sending relies on this sub-account  **What Gets Deleted:** - All sub-account configuration - Associated API keys (will stop working) - Statistics are retained for your account records  **Note:** The default sub-account (type `0`) cannot be deleted. 
 
 ### Examples
 
@@ -104,7 +104,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::SubAccountApi.new
-subaccount_id = 12 # Integer | The ID of the sub-account to delete.
+subaccount_id = 12 # Integer | The unique ID of the sub-account to delete.
 
 begin
   # Delete Sub-Account
@@ -137,7 +137,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subaccount_id** | **Integer** | The ID of the sub-account to delete. |  |
+| **subaccount_id** | **Integer** | The unique ID of the sub-account to delete. |  |
 
 ### Return type
 
@@ -159,7 +159,7 @@ end
 
 List Sub-Accounts
 
-Retrieves a list of all sub-accounts associated with a specific account.
+Retrieve all sub-accounts under your main account. Sub-accounts allow you to segment email sending for different applications, brands, or use cases.  **Sub-Account Types:** | Type | Value | Description | |------|-------|-------------| | Default | `0` | Primary sub-account created with your account (cannot be deleted) | | Custom | `1` | Additional sub-accounts you create |  **Each Sub-Account Has:** - Unique `X-SubAccount-ApiKey` for API authentication - Independent suppression list - Isolated email statistics - Own domain configurations - SMTP credentials (if enabled)  **Use Cases:** - Separate transactional and marketing emails - Multi-tenant SaaS applications (one sub-account per customer) - Different brands or product lines - Development/staging/production environments  **Note:** `isPlus` indicates SendX Plus customers with premium features. 
 
 ### Examples
 
@@ -176,9 +176,9 @@ end
 
 api_instance = Sendpost::SubAccountApi.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 the sub-account name.
+  limit: 10, # Integer | Number of records to return per request. Default 20.
+  offset: 0, # Integer | Number of initial records to skip for pagination.
+  search: 'Production' # String | Case-insensitive search against sub-account names.
 }
 
 begin
@@ -212,9 +212,9 @@ 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 the sub-account name. | [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 sub-account names. | [optional] |
 
 ### Return type
 
@@ -236,7 +236,7 @@ end
 
 Get Sub-Account
 
-Retrieves a specific sub-account by its ID.
+Retrieve detailed information about a specific sub-account, including API keys, SMTP credentials, and configuration.  **Response Includes:** - Sub-account name and ID - API key for sub-account authentication - SMTP credentials (if enabled) - Team members with access - Labels/tags for categorization - Creation timestamp 
 
 ### Examples
 
@@ -252,7 +252,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::SubAccountApi.new
-subaccount_id = 11 # Integer | The ID of the sub-account to retrieve.
+subaccount_id = 11 # Integer | The unique ID of the sub-account to retrieve.
 
 begin
   # Get Sub-Account
@@ -285,7 +285,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subaccount_id** | **Integer** | The ID of the sub-account to retrieve. |  |
+| **subaccount_id** | **Integer** | The unique ID of the sub-account to retrieve. |  |
 
 ### Return type
 
@@ -307,7 +307,7 @@ end
 
 Update Sub-Account
 
-Updates the details of an existing sub-account.
+Modify settings for an existing sub-account. Use this to rename sub-accounts, update labels, or modify configuration.  **What Can Be Updated:** - Sub-account name - Labels/tags for categorization - Other configuration settings  **Use Cases:** - Rename sub-account for clarity - Update labels for organizational changes - Modify settings after initial setup 
 
 ### Examples
 
@@ -324,7 +324,7 @@ end
 
 api_instance = Sendpost::SubAccountApi.new
 update_sub_account = Sendpost::UpdateSubAccount.new # UpdateSubAccount | 
-subaccount_id = 12 # Integer | The ID of the sub-account to update.
+subaccount_id = 12 # Integer | The unique ID of the sub-account to update.
 
 begin
   # Update Sub-Account
@@ -358,7 +358,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **update_sub_account** | [**UpdateSubAccount**](UpdateSubAccount.md) |  |  |
-| **subaccount_id** | **Integer** | The ID of the sub-account to update. |  |
+| **subaccount_id** | **Integer** | The unique ID of the sub-account to update. |  |
 
 ### Return type
 

data/docs/SubAccountStat.md

@@ -0,0 +1,44 @@
+# Sendpost::SubAccountStat
+
+## 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] |
+| **sub_account_id** | **Integer** | Unique identifier of the sub-account. | [optional] |
+| **sub_account_name** | **String** | Human-readable name of the sub-account. | [optional] |
+| **blocked** | **Boolean** | Whether the sub-account is currently blocked from sending. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::SubAccountStat.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,
+  sub_account_id: 42,
+  sub_account_name: Marketing,
+  blocked: false
+)
+```
+

data/docs/SubAccountStatForPool.md

@@ -0,0 +1,42 @@
+# Sendpost::SubAccountStatForPool
+
+## 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] |
+| **sub_account_id** | **Integer** | Unique identifier of the sub-account. | [optional] |
+| **name** | **String** | Human-readable name of the sub-account. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::SubAccountStatForPool.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,
+  sub_account_id: 42,
+  name: Marketing
+)
+```
+