sendpost_ruby_sdk 2.0.2 → 3.0.0

data/docs/IPApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Allocate IP
 
-Allocates a new IP resource to the account. 
+Request allocation of a new dedicated IP address to your account. New IPs start in warmup state to build sender reputation gradually.  **Warmup Process:** - New IPs have limited daily sending capacity - Volume increases automatically each day while `autoWarmupEnabled` is set - Full capacity typically reached after 30-45 days - Consistent, engagement-positive sending accelerates warmup  **When to Allocate New IPs:** - Scaling beyond current IP capacity - Separating different email streams (transactional vs marketing) - Geographic IP requirements - Replacing an IP with poor reputation  **Best Practices:** - Dedicated IPs require consistent volume (10k+ emails/month ideal) - Low volume on dedicated IPs can harm deliverability - Consider shared IPs for low-volume senders 
 
 ### Examples
 
@@ -33,7 +33,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPApi.new
-ip_allocation_request = Sendpost::IPAllocationRequest.new({overflow_pool: true, ips: ['34.21.14.11']}) # IPAllocationRequest | 
+ip_allocation_request = Sendpost::IPAllocationRequest.new({ips: [34.21.14.11,  34.21.14.12]}) # IPAllocationRequest | 
 
 begin
   # Allocate IP
@@ -88,7 +88,7 @@ end
 
 Delete IP
 
-Deletes a specific IP resource based on the provided IP ID. 
+Remove an IP address from your account. This action is irreversible.  **⚠️ Before Deleting:** - Remove the IP from all IP pools first - Ensure no active sending relies on this IP - Consider impact on overall sending capacity  **Note:** You cannot delete an IP that is currently assigned to an IP pool. 
 
 ### Examples
 
@@ -104,7 +104,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPApi.new
-ip_id = 56 # Integer | The ID of the IP resource to delete
+ip_id = 11322 # Integer | The unique ID of the IP resource to delete.
 
 begin
   # Delete IP
@@ -137,7 +137,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ip_id** | **Integer** | The ID of the IP resource to delete |  |
+| **ip_id** | **Integer** | The unique ID of the IP resource to delete. |  |
 
 ### Return type
 
@@ -159,7 +159,7 @@ end
 
 List IPs
 
-Retrieves a list of all IPs associated with the main account. 
+Retrieve all IP addresses allocated to your account. IPs are the foundation of your sending infrastructure and directly impact deliverability.  **IP Types:** | Type | Value | Description | |------|-------|-------------| | Shared | `0` | IP shared with other SendPost senders. Cost-effective, reputation is pooled. | | Dedicated | `1` | Exclusive IP for your account. Full control over sender reputation. |  **IP States:** | State | Value | Description | |-------|-------|-------------| | Warmup | `0` | New IP building reputation. Volume is limited and gradually increases. | | Normal | `1` | Fully warmed IP ready for normal sending volume. |  **Warmup Information:** - `autoWarmupEnabled` - Whether SendPost is automatically increasing volume  **Use Cases:** - Monitor IP warmup progress for new IPs - Audit shared vs dedicated IP allocation - Plan IP pool configurations - Check available sending capacity 
 
 ### Examples
 
@@ -176,9 +176,9 @@ end
 
 api_instance = Sendpost::IPApi.new
 opts = {
-  limit: 56, # Integer | Number of records to return per request
-  offset: 56, # Integer | Number of initial records to skip
-  search: 'search_example' # String | Case insensitive search against IP's public IP address
+  limit: 50, # Integer | Number of records to return per request. Default 20.
+  offset: 0, # Integer | Number of initial records to skip for pagination.
+  search: '52.34' # String | Case insensitive search against public IP addresses.
 }
 
 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 IP's public IP address | [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 public IP addresses. | [optional] |
 
 ### Return type
 
@@ -236,7 +236,7 @@ end
 
 Get IP
 
-Retrieves detailed information about a specific IP based on the provided ID. 
+Retrieve detailed information about a specific IP address, including its warmup status, type, and configuration.  **Use Cases:** - Check warmup progress for a new dedicated IP - Verify IP configuration before adding to a pool - Debug deliverability issues by checking IP state - Monitor auto-warmup progress 
 
 ### Examples
 
@@ -252,7 +252,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPApi.new
-ip_id = 56 # Integer | The ID of the IP resource to retrieve
+ip_id = 11322 # Integer | The unique ID of the IP resource to retrieve.
 
 begin
   # Get IP
@@ -285,7 +285,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ip_id** | **Integer** | The ID of the IP resource to retrieve |  |
+| **ip_id** | **Integer** | The unique ID of the IP resource to retrieve. |  |
 
 ### Return type
 
@@ -307,7 +307,7 @@ end
 
 Update IP
 
-Updates an existing IP resource based on the provided IP ID. 
+Modify settings for an existing IP address. Use this to manage warmup configuration.  **Configurable Settings:** - `autoWarmupEnabled` - Enable/disable automatic warmup schedule  **Use Cases:** - Pause auto-warmup during low-volume periods - Re-enable warmup after manual intervention - Adjust warmup settings based on sending patterns 
 
 ### Examples
 
@@ -323,8 +323,8 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPApi.new
-ip_update_request = Sendpost::IPUpdateRequest.new({auto_warmup_enabled: false}) # IPUpdateRequest | 
-ip_id = 56 # Integer | The ID of the IP resource to update
+ip_update_request = Sendpost::IPUpdateRequest.new # IPUpdateRequest | 
+ip_id = 11322 # Integer | The unique ID of the IP resource to update.
 
 begin
   # Update IP
@@ -358,7 +358,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **ip_update_request** | [**IPUpdateRequest**](IPUpdateRequest.md) |  |  |
-| **ip_id** | **Integer** | The ID of the IP resource to update |  |
+| **ip_id** | **Integer** | The unique ID of the IP resource to update. |  |
 
 ### Return type
 

data/docs/IPDeletionResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The unique ID of the IP |  |
-| **message** | **String** | The confirmation message after deletion |  |
+| **id** | **Integer** | ID of the deleted IP |  |
+| **message** | **String** | Confirmation message |  |
 
 ## Example
 

data/docs/IPPool.md

@@ -4,19 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **created** | **Integer** |  | [optional] |
-| **ips** | [**Array<IP>**](IP.md) |  | [optional] |
-| **third_party_sending_providers** | [**Array<ThirdPartySendingProvider>**](ThirdPartySendingProvider.md) |  | [optional] |
-| **routing_strategy** | **Integer** |  | [optional] |
-| **routing_meta_data** | **String** |  | [optional] |
-| **auto_warmup_enabled** | **Boolean** |  | [optional] |
-| **infra_monitor** | **Boolean** |  | [optional] |
-| **ip_domain_warmup_status** | **String** |  | [optional] |
-| **should_overflow** | **Boolean** | Indicates whether the IP should overflow, once email capacity of the IP Pool has been reached, should we send remaining emails over shared IP or not | [optional] |
-| **overflow_pool_name** | **String** | The name of the overflow pool | [optional] |
-| **warmup_interval** | **Integer** | The interval for the warmup | [optional] |
+| **id** | **Integer** | Unique identifier for the IP pool | [optional] |
+| **name** | **String** | Display name for the IP pool. Must be unique within your account. Use descriptive names like \"transactional\", \"marketing\", \"high-priority\".  | [optional] |
+| **type** | **Integer** | Type of IP pool: - `0` = Shared (uses shared IPs with pooled reputation) - `1` = Dedicated (uses dedicated IPs exclusive to your account)  | [optional] |
+| **routing_strategy** | **Integer** | How emails are distributed across IPs/providers in this pool: - `0` = Round Robin (equal distribution) - `1` = Email Provider Strategy (route by recipient domain like Gmail, Yahoo) - `2` = Volume Percentage Strategy (weighted distribution) - `3` = Sending Domain Strategy (route by sender domain)  See the IPPools tag description for detailed routing configuration examples.  | [optional] |
+| **routing_meta_data** | **String** | JSON-encoded configuration for the selected routing strategy. Format depends on routingStrategy value. See IPPools documentation for examples.  For Round Robin (strategy 0): Use empty object `{}`  | [optional] |
+| **should_overflow** | **Boolean** | Whether to automatically overflow to a backup pool when this pool is unavailable (all IPs down) or at capacity (warmup limits reached).  | [optional] |
+| **overflow_pool_name** | **String** | Name of the IP pool to overflow to when shouldOverflow is enabled. The overflow pool must exist. Common pattern: overflow to shared IP pool.  | [optional] |
+| **ips** | [**Array<IP>**](IP.md) | List of dedicated IPs assigned to this pool | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the IP pool was created | [optional] |
 
 ## Example
 
@@ -26,17 +22,13 @@ require 'sendpost_ruby_sdk'
 instance = Sendpost::IPPool.new(
   id: 746,
   name: Transactional,
-  created: 1597511124804000,
-  ips: null,
-  third_party_sending_providers: null,
+  type: 1,
   routing_strategy: 0,
   routing_meta_data: {},
-  auto_warmup_enabled: false,
-  infra_monitor: true,
-  ip_domain_warmup_status: null,
   should_overflow: true,
-  overflow_pool_name: Transactional,
-  warmup_interval: 60
+  overflow_pool_name: shared-backup,
+  ips: null,
+  created: 1704067200000000000
 )
 ```
 

data/docs/IPPoolCreateRequest.md

@@ -4,12 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **ips** | [**Array<EIP>**](EIP.md) |  | [optional] |
-| **tpsps** | **Array<Integer>** |  | [optional] |
-| **routing_strategy** | **Integer** |  | [optional] |
-| **routing_meta_data** | **String** |  | [optional] |
-| **overflow_pool** | **Boolean** |  | [optional] |
+| **name** | **String** | Display name for the IP pool. Must be unique within your account. Use descriptive names like \"transactional\", \"marketing-bulk\", \"high-priority\"  |  |
+| **ips** | [**Array<EIP>**](EIP.md) | List of dedicated IP addresses to include in this pool. IPs must already be allocated to your account.  | [optional] |
+| **tpsps** | **Array<Integer>** | List of third-party sending provider IDs to include in this pool. TPSPs must be pre-configured in your account.  | [optional] |
+| **routing_strategy** | **Integer** | Email routing strategy: - `0` = Round Robin (equal distribution) - `1` = Email Provider Strategy (route by recipient domain) - `2` = Volume Percentage Strategy (weighted distribution) - `3` = Sending Domain Strategy (route by sender domain)  | [optional][default to ROUTING_STRATEGY::N0] |
+| **routing_meta_data** | **String** | JSON-encoded routing configuration. See IPPools documentation for format. Use `{}` for round-robin strategy.  | [optional][default to '{}'] |
+| **should_overflow** | **Boolean** | Whether to overflow to shared pool when this pool is unavailable | [optional][default to false] |
+| **overflow_pool_name** | **String** | Name of the IP pool to overflow to (if shouldOverflow is true) | [optional] |
 
 ## Example
 
@@ -19,10 +20,11 @@ require 'sendpost_ruby_sdk'
 instance = Sendpost::IPPoolCreateRequest.new(
   name: Marketing Promotional,
   ips: null,
-  tpsps: [1],
+  tpsps: [101, 102],
   routing_strategy: 0,
   routing_meta_data: {},
-  overflow_pool: false
+  should_overflow: true,
+  overflow_pool_name: shared-backup
 )
 ```
 

data/docs/IPPoolDeleteResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
+| **id** | **Integer** | ID of the deleted IP pool | [optional] |
+| **message** | **String** | Confirmation message | [optional] |
 
 ## Example
 

data/docs/IPPoolStat.md

@@ -0,0 +1,44 @@
+# Sendpost::IPPoolStat
+
+## 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] |
+| **ip_pool_id** | **Integer** | Unique identifier of the IP pool. | [optional] |
+| **ip_pool_name** | **String** | Human-readable name of the IP pool. | [optional] |
+| **pending** | **Integer** | Number of emails queued on this pool but not yet processed. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::IPPoolStat.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,
+  ip_pool_id: 5,
+  ip_pool_name: Transactional Pool,
+  pending: 3
+)
+```
+

data/docs/IPPoolUpdateRequest.md

@@ -4,10 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
-| **ips** | [**Array<IP>**](IP.md) |  | [optional] |
-| **routing_strategy** | **Integer** |  | [optional] |
-| **routing_meta_data** | **String** |  | [optional] |
+| **name** | **String** | New display name for the IP pool | [optional] |
+| **ips** | [**Array<EIP>**](EIP.md) | Updated list of IP addresses for this pool. This replaces the current IP list - include all IPs you want in the pool.  | [optional] |
+| **tpsps** | **Array<Integer>** | Updated list of third-party sending provider IDs | [optional] |
+| **routing_strategy** | **Integer** | Updated routing strategy (see IPPoolCreateRequest for values) | [optional] |
+| **routing_meta_data** | **String** | Updated routing configuration (JSON) | [optional] |
+| **should_overflow** | **Boolean** | Whether to enable overflow to backup pool | [optional] |
+| **overflow_pool_name** | **String** | Name of the overflow pool | [optional] |
 
 ## Example
 
@@ -15,10 +18,13 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::IPPoolUpdateRequest.new(
-  name: Marketing Promotional,
-  ips: [{publicIP=52.12.10.12}, {publicIP=52.10.12.17}, {publicIP=35.11.10.5}],
+  name: Marketing Promotional v2,
+  ips: null,
+  tpsps: null,
   routing_strategy: 0,
-  routing_meta_data: {}
+  routing_meta_data: {},
+  should_overflow: true,
+  overflow_pool_name: shared-backup
 )
 ```
 

data/docs/IPPoolsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.sendpost.io/api/v1*
 
 Create IPPool
 
-Creates a new IPPool with the specified name, IPs, and third-party sending providers.
+Create a new IP pool to organize your sending infrastructure. Pools group IPs and third-party sending providers (TPSPs) for intelligent routing.  **Pool Components:** - **IPs:** Dedicated IP addresses from your account - **TPSPs:** Third-party sending providers (SendGrid, Mailgun, etc.)  **TPSP Types:** | Value | Provider | |-------|----------| | `0` | Amazon SES | | `1` | SendGrid | | `2` | Mailgun | | `3` | Custom SMTP | | `4` | PostMark | | `5` | Gmail |  **Routing Strategies:** - `0` = Round Robin - Distribute traffic evenly - `1` = Email Provider - Route by recipient's mailbox provider - `2` = Volume Percentage - Split by defined percentages - `3` = Sending Domain - Route by your from domain  **Use Cases:** - Separate transactional from marketing emails - Route high-volume traffic through TPSPs - Implement provider-specific routing for deliverability - Create backup pools for failover  **Naming Best Practices:** - Use descriptive names: `Transactional_Orders`, `Marketing_Newsletter` - Include purpose: `HighPriority_Alerts`, `Bulk_Promotions` 
 
 ### Examples
 
@@ -33,7 +33,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPPoolsApi.new
-ip_pool_create_request = Sendpost::IPPoolCreateRequest.new # IPPoolCreateRequest | 
+ip_pool_create_request = Sendpost::IPPoolCreateRequest.new({name: 'Marketing Promotional'}) # IPPoolCreateRequest | 
 
 begin
   # Create IPPool
@@ -88,16 +88,23 @@ end
 
 Delete IPPool
 
-Delete a specific IPPool based on its ID.
+Remove an IP pool from your account. This action is irreversible.  **⚠️ Before Deleting:** - Ensure no sub-accounts are actively using this pool - Update any sending configurations that reference this pool - IPs in the pool will become unassigned (not deleted)  **Note:** The default system pool cannot be deleted. 
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
 
 api_instance = Sendpost::IPPoolsApi.new
-ippool_id = 756 # Integer | The ID of the IPPool to delete
+ippool_id = 756 # Integer | The unique ID of the IP pool to delete.
 
 begin
   # Delete IPPool
@@ -130,7 +137,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ippool_id** | **Integer** | The ID of the IPPool to delete |  |
+| **ippool_id** | **Integer** | The unique ID of the IP pool to delete. |  |
 
 ### Return type
 
@@ -138,7 +145,7 @@ end
 
 ### Authorization
 
-No authorization required
+[accountAuth](../README.md#accountAuth)
 
 ### HTTP request headers
 
@@ -152,7 +159,7 @@ No authorization required
 
 List IPPools
 
-Retrieves a list of all IPPools and information about all IPs contained in that pool.
+Retrieve all IP pools configured for your account. IP pools group IPs and third-party sending providers (TPSPs) for intelligent traffic routing.  **Pool Types:** | Type | Value | Description | |------|-------|-------------| | Shared | `0` | Pool uses shared IPs (shared with other SendPost customers) | | Dedicated | `1` | Pool uses dedicated IPs (exclusive to your account) |  **Routing Strategies:** | Strategy | Value | Description | |----------|-------|-------------| | Round Robin | `0` | Distribute traffic evenly across pool members | | Email Provider | `1` | Route based on recipient's mailbox provider (Gmail, Yahoo, etc.) | | Volume Percentage | `2` | Split traffic by defined percentages | | Sending Domain | `3` | Route based on your sending domain |  **Use Cases:** - Audit your sending infrastructure configuration - View IPs and TPSPs in each pool - Plan routing strategy changes - Verify pool setup before sending campaigns 
 
 ### Examples
 
@@ -169,9 +176,9 @@ end
 
 api_instance = Sendpost::IPPoolsApi.new
 opts = {
-  limit: 10, # Integer | Number of records to return per request
-  offset: 0, # Integer | Number of initial records to skip
-  search: 'Transactional' # String | Case insensitive search against IPPool 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: 'Transactional' # String | Case insensitive search against IP pool names.
 }
 
 begin
@@ -205,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 IPPool 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 IP pool names. | [optional] |
 
 ### Return type
 
@@ -229,7 +236,7 @@ end
 
 Get IPPool
 
-Retrieves details of a specific IPPool based on its ID.
+Retrieve complete details about a specific IP pool, including all IPs and TPSPs assigned to it.  **Response Includes:** - Pool name, ID, and creation date - Complete list of IPs with warmup status - All configured TPSPs with their settings - Current routing strategy and metadata - Warmup and monitoring configuration  **Use Cases:** - Verify pool configuration before sending - Check which IPs/TPSPs are in a pool - Debug routing issues - Audit pool settings for compliance 
 
 ### Examples
 
@@ -245,7 +252,7 @@ Sendpost.configure do |config|
 end
 
 api_instance = Sendpost::IPPoolsApi.new
-ippool_id = 74 # Integer | The ID of the IPPool whose information you want to retrieve
+ippool_id = 74 # Integer | The unique ID of the IP pool to retrieve.
 
 begin
   # Get IPPool
@@ -278,7 +285,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ippool_id** | **Integer** | The ID of the IPPool whose information you want to retrieve |  |
+| **ippool_id** | **Integer** | The unique ID of the IP pool to retrieve. |  |
 
 ### Return type
 
@@ -300,7 +307,7 @@ end
 
 Update IPPool
 
-Update the details of an existing IPPool by its ID.
+Modify an existing IP pool's configuration, including name, IPs, TPSPs, and routing strategy.  **What Can Be Updated:** - Pool name - IP addresses assigned to the pool - Third-party sending providers (TPSPs) - Routing strategy and metadata - Warmup and monitoring settings  **Use Cases:** - Add new IPs to scale capacity - Remove underperforming IPs - Change routing strategy - Add/remove TPSP integrations - Rename pool for clarity  **Best Practices:** - Test routing changes during low-traffic periods - Ensure at least one sending option remains in the pool - Document changes for team awareness 
 
 ### Examples
 
@@ -310,7 +317,7 @@ require 'sendpost_ruby_sdk'
 
 api_instance = Sendpost::IPPoolsApi.new
 ip_pool_update_request = Sendpost::IPPoolUpdateRequest.new # IPPoolUpdateRequest | 
-ippool_id = 756 # Integer | The ID of the IPPool to update
+ippool_id = 756 # Integer | The unique ID of the IP pool to update.
 
 begin
   # Update IPPool
@@ -344,7 +351,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **ip_pool_update_request** | [**IPPoolUpdateRequest**](IPPoolUpdateRequest.md) |  |  |
-| **ippool_id** | **Integer** | The ID of the IPPool to update |  |
+| **ippool_id** | **Integer** | The unique ID of the IP pool to update. |  |
 
 ### Return type
 

data/docs/IPStat.md

@@ -0,0 +1,46 @@
+# Sendpost::IPStat
+
+## 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] |
+| **ip_id** | **Integer** | Unique identifier of the IP address record. | [optional] |
+| **public_ip** | **String** | The public IPv4/IPv6 address these statistics belong to. | [optional] |
+| **state** | **Integer** | Numeric lifecycle/state code of the IP (e.g. warming, active). | [optional] |
+| **pending** | **Integer** | Number of emails queued on this IP but not yet processed. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::IPStat.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,
+  ip_id: 88,
+  public_ip: 192.0.2.10,
+  state: 1,
+  pending: 3
+)
+```
+

data/docs/IPUpdateRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **auto_warmup_enabled** | **Boolean** | Whether the IP warmup should happen automatically or be managed manually |  |
+| **auto_warmup_enabled** | **Boolean** | Toggle automatic IP warmup on or off. - `true`: SendPost automatically manages daily sending limits - `false`: You manage sending volume manually (advanced users)  Warning: Disabling warmup and sending high volume on a new IP can damage sender reputation.  | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::IPUpdateRequest.new(
-  auto_warmup_enabled: false
+  auto_warmup_enabled: true
 )
 ```
 

data/docs/Label.md

@@ -4,9 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the label | [optional] |
-| **name** | **String** | Name of the label | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the label was created | [optional] |
+| **id** | **Integer** | Unique identifier for the label | [optional] |
+| **name** | **String** | Display name for the label (max 50 characters) | [optional] |
+| **color** | **String** | Hex color code for visual identification in the dashboard. Format: 6-character hex without # prefix.  | [optional] |
+| **type** | **Integer** | Resource type this label applies to: - `0` = IP label - `1` = Sub-account label - `2` = IP Pool label  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the label was created | [optional] |
 
 ## Example
 
@@ -14,9 +16,11 @@
 require 'sendpost_ruby_sdk'
 
 instance = Sendpost::Label.new(
-  id: 325,
-  name: Free Tier,
-  created: 1685427871489941179
+  id: 42,
+  name: production,
+  color: 4CAF50,
+  type: 0,
+  created: 1704067200000000000
 )
 ```
 

data/docs/Member.md

@@ -4,18 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | Unique ID for the member | [optional] |
-| **is_verified** | **Boolean** | Indicates whether the member is verified | [optional] |
-| **is_forbidden** | **Boolean** | Indicates whether the member is forbidden | [optional] |
-| **firebase_uid** | **String** | Firebase UID for the member | [optional] |
-| **email** | **String** | Email for the member | [optional] |
-| **name** | **String** | Name for the member | [optional] |
-| **url** | **String** | Logo URL for the member | [optional] |
-| **company_name** | **String** | Company name for the member | [optional] |
-| **onboard_q_answered** | **Boolean** | Indicates whether the member has answered onboarding question | [optional] |
-| **phone_number** | **String** | Phone number for the member | [optional] |
-| **notes_color** | **String** | Color for the member's notes | [optional] |
-| **created** | **Integer** | UNIX epoch nano timestamp when the member was created | [optional] |
+| **id** | **Integer** | Unique identifier for the team member | [optional] |
+| **email** | **String** | Email address of the team member (used for login) | [optional] |
+| **name** | **String** | Display name of the team member | [optional] |
+| **is_verified** | **Boolean** | Whether the member has verified their email address. Unverified members have limited access until verification is complete.  | [optional] |
+| **logo_url** | **String** | URL of the member's profile picture/avatar | [optional] |
+| **company_name** | **String** | Company or organization name | [optional] |
+| **onboard_q_answered** | **Boolean** | Whether the member has completed the onboarding questionnaire | [optional] |
+| **phone_number** | **String** | Contact phone number in E.164 format. Used for account recovery and important notifications.  | [optional] |
+| **created** | **Integer** | UNIX epoch timestamp in nanoseconds when the member was added | [optional] |
 
 ## Example
 
@@ -24,17 +21,14 @@ require 'sendpost_ruby_sdk'
 
 instance = Sendpost::Member.new(
   id: 117,
-  is_verified: true,
-  is_forbidden: false,
-  firebase_uid: 1234567890,
   email: raj@piedpiper.com,
-  name: Raj,
-  url: https://www.sendpost.io/logo.png,
-  company_name: SendPost,
+  name: Raj Koothrappali,
+  is_verified: true,
+  logo_url: https://avatars.example.com/raj.png,
+  company_name: Pied Piper,
   onboard_q_answered: true,
-  phone_number: +919876543210,
-  notes_color: #000000,
-  created: 1567512491588004044
+  phone_number: +14155551234,
+  created: 1704067200000000000
 )
 ```