Class: Sendpost::IPPoolsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/api/ip_pools_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IPPoolsApi

Returns a new instance of IPPoolsApi.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_ip_pool(ip_pool_create_request, opts = {}) ⇒ IPPool

Create IPPool 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

Parameters:

  • ip_pool_create_request (IPPoolCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 27

def create_ip_pool(ip_pool_create_request, opts = {})
  data, _status_code, _headers = create_ip_pool_with_http_info(ip_pool_create_request, opts)
  data
end

#create_ip_pool_with_http_info(ip_pool_create_request, opts = {}) ⇒ Array<(IPPool, Integer, Hash)>

Create IPPool 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`

Parameters:

  • ip_pool_create_request (IPPoolCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IPPool, Integer, Hash)>) —

    IPPool data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 37

def create_ip_pool_with_http_info(ip_pool_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPPoolsApi.create_ip_pool ...'
  end
  # verify the required parameter 'ip_pool_create_request' is set
  if @api_client.config.client_side_validation && ip_pool_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'ip_pool_create_request' when calling IPPoolsApi.create_ip_pool"
  end
  # resource path
  local_var_path = '/account/ippool'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ip_pool_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IPPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"IPPoolsApi.create_ip_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPPoolsApi#create_ip_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ip_pool(ippool_id, opts = {}) ⇒ IPPoolDeleteResponse

Delete IPPool 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.

Parameters:

  • ippool_id (Integer) —

    The unique ID of the IP pool to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 95

def delete_ip_pool(ippool_id, opts = {})
  data, _status_code, _headers = delete_ip_pool_with_http_info(ippool_id, opts)
  data
end

#delete_ip_pool_with_http_info(ippool_id, opts = {}) ⇒ Array<(IPPoolDeleteResponse, Integer, Hash)>

Delete IPPool 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.

Parameters:

  • ippool_id (Integer) —

    The unique ID of the IP pool to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IPPoolDeleteResponse, Integer, Hash)>) —

    IPPoolDeleteResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 105

def delete_ip_pool_with_http_info(ippool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPPoolsApi.delete_ip_pool ...'
  end
  # verify the required parameter 'ippool_id' is set
  if @api_client.config.client_side_validation && ippool_id.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_id' when calling IPPoolsApi.delete_ip_pool"
  end
  # resource path
  local_var_path = '/account/ippool/{ippool_id}'.sub('{' + 'ippool_id' + '}', CGI.escape(ippool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IPPoolDeleteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"IPPoolsApi.delete_ip_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPPoolsApi#delete_ip_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_ip_pools(opts = {}) ⇒ Array<IPPool>

List IPPools 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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case insensitive search against IP pool names.

Returns:



160
161
162
163
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 160

def get_all_ip_pools(opts = {})
  data, _status_code, _headers = get_all_ip_pools_with_http_info(opts)
  data
end

#get_all_ip_pools_with_http_info(opts = {}) ⇒ Array<(Array<IPPool>, Integer, Hash)>

List IPPools 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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case insensitive search against IP pool names.

Returns:

  • (Array<(Array<IPPool>, Integer, Hash)>) —

    Array data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 172

def get_all_ip_pools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPPoolsApi.get_all_ip_pools ...'
  end
  # resource path
  local_var_path = '/account/ippool'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<IPPool>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"IPPoolsApi.get_all_ip_pools",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPPoolsApi#get_all_ip_pools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ip_pool_by_id(ippool_id, opts = {}) ⇒ IPPool

Get IPPool 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

Parameters:

  • ippool_id (Integer) —

    The unique ID of the IP pool to retrieve.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 224

def get_ip_pool_by_id(ippool_id, opts = {})
  data, _status_code, _headers = get_ip_pool_by_id_with_http_info(ippool_id, opts)
  data
end

#get_ip_pool_by_id_with_http_info(ippool_id, opts = {}) ⇒ Array<(IPPool, Integer, Hash)>

Get IPPool 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

Parameters:

  • ippool_id (Integer) —

    The unique ID of the IP pool to retrieve.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IPPool, Integer, Hash)>) —

    IPPool data, response status code and response headers



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 234

def get_ip_pool_by_id_with_http_info(ippool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPPoolsApi.get_ip_pool_by_id ...'
  end
  # verify the required parameter 'ippool_id' is set
  if @api_client.config.client_side_validation && ippool_id.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_id' when calling IPPoolsApi.get_ip_pool_by_id"
  end
  # resource path
  local_var_path = '/account/ippool/{ippool_id}'.sub('{' + 'ippool_id' + '}', CGI.escape(ippool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IPPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"IPPoolsApi.get_ip_pool_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPPoolsApi#get_ip_pool_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ip_pool(ip_pool_update_request, ippool_id, opts = {}) ⇒ IPPool

Update IPPool 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

Parameters:

  • ip_pool_update_request (IPPoolUpdateRequest)
  • ippool_id (Integer) —

    The unique ID of the IP pool to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 288

def update_ip_pool(ip_pool_update_request, ippool_id, opts = {})
  data, _status_code, _headers = update_ip_pool_with_http_info(ip_pool_update_request, ippool_id, opts)
  data
end

#update_ip_pool_with_http_info(ip_pool_update_request, ippool_id, opts = {}) ⇒ Array<(IPPool, Integer, Hash)>

Update IPPool 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

Parameters:

  • ip_pool_update_request (IPPoolUpdateRequest)
  • ippool_id (Integer) —

    The unique ID of the IP pool to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IPPool, Integer, Hash)>) —

    IPPool data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/sendpost_ruby_sdk/api/ip_pools_api.rb', line 299

def update_ip_pool_with_http_info(ip_pool_update_request, ippool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPPoolsApi.update_ip_pool ...'
  end
  # verify the required parameter 'ip_pool_update_request' is set
  if @api_client.config.client_side_validation && ip_pool_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'ip_pool_update_request' when calling IPPoolsApi.update_ip_pool"
  end
  # verify the required parameter 'ippool_id' is set
  if @api_client.config.client_side_validation && ippool_id.nil?
    fail ArgumentError, "Missing the required parameter 'ippool_id' when calling IPPoolsApi.update_ip_pool"
  end
  # resource path
  local_var_path = '/account/ippool/{ippool_id}'.sub('{' + 'ippool_id' + '}', CGI.escape(ippool_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ip_pool_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'IPPool'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"IPPoolsApi.update_ip_pool",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPPoolsApi#update_ip_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end