Class: Sendpost::IPApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IPApi

Returns a new instance of IPApi.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/api/ip_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_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#allocate_new_ip(ip_allocation_request, opts = {}) ⇒ IP

Allocate IP 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

Parameters:

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

    the optional parameters

Returns:



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

def allocate_new_ip(ip_allocation_request, opts = {})
  data, _status_code, _headers = allocate_new_ip_with_http_info(ip_allocation_request, opts)
  data
end

#allocate_new_ip_with_http_info(ip_allocation_request, opts = {}) ⇒ Array<(IP, Integer, Hash)>

Allocate IP 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

Parameters:

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

    the optional parameters

Returns:

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

    IP 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_api.rb', line 37

def allocate_new_ip_with_http_info(ip_allocation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPApi.allocate_new_ip ...'
  end
  # verify the required parameter 'ip_allocation_request' is set
  if @api_client.config.client_side_validation && ip_allocation_request.nil?
    fail ArgumentError, "Missing the required parameter 'ip_allocation_request' when calling IPApi.allocate_new_ip"
  end
  # resource path
  local_var_path = '/account/ip/allocate'

  # 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_allocation_request)

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

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

  new_options = opts.merge(
    :operation => :"IPApi.allocate_new_ip",
    :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: IPApi#allocate_new_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ip(ip_id, opts = {}) ⇒ IPDeletionResponse

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

Parameters:

  • ip_id (Integer) —

    The unique ID of the IP resource to delete.

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

    the optional parameters

Returns:



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

def delete_ip(ip_id, opts = {})
  data, _status_code, _headers = delete_ip_with_http_info(ip_id, opts)
  data
end

#delete_ip_with_http_info(ip_id, opts = {}) ⇒ Array<(IPDeletionResponse, Integer, Hash)>

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

Parameters:

  • ip_id (Integer) —

    The unique ID of the IP resource to delete.

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

    the optional parameters

Returns:

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

    IPDeletionResponse 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_api.rb', line 105

def delete_ip_with_http_info(ip_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPApi.delete_ip ...'
  end
  # verify the required parameter 'ip_id' is set
  if @api_client.config.client_side_validation && ip_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_id' when calling IPApi.delete_ip"
  end
  # resource path
  local_var_path = '/account/ip/{ip_id}'.sub('{' + 'ip_id' + '}', CGI.escape(ip_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] || 'IPDeletionResponse'

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

  new_options = opts.merge(
    :operation => :"IPApi.delete_ip",
    :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: IPApi#delete_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_ips(opts = {}) ⇒ Array<IP>

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

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 public IP addresses.

Returns:

  • (Array<IP>) 


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

def get_all_ips(opts = {})
  data, _status_code, _headers = get_all_ips_with_http_info(opts)
  data
end

#get_all_ips_with_http_info(opts = {}) ⇒ Array<(Array<IP>, Integer, Hash)>

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

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 public IP addresses.

Returns:

  • (Array<(Array<IP>, 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_api.rb', line 172

def get_all_ips_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPApi.get_all_ips ...'
  end
  # resource path
  local_var_path = '/account/ip/'

  # 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<IP>'

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

  new_options = opts.merge(
    :operation => :"IPApi.get_all_ips",
    :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: IPApi#get_all_ips\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_specific_ip(ip_id, opts = {}) ⇒ IP

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

Parameters:

  • ip_id (Integer) —

    The unique ID of the IP resource to retrieve.

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

    the optional parameters

Returns:



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

def get_specific_ip(ip_id, opts = {})
  data, _status_code, _headers = get_specific_ip_with_http_info(ip_id, opts)
  data
end

#get_specific_ip_with_http_info(ip_id, opts = {}) ⇒ Array<(IP, Integer, Hash)>

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

Parameters:

  • ip_id (Integer) —

    The unique ID of the IP resource to retrieve.

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

    the optional parameters

Returns:

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

    IP 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_api.rb', line 234

def get_specific_ip_with_http_info(ip_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPApi.get_specific_ip ...'
  end
  # verify the required parameter 'ip_id' is set
  if @api_client.config.client_side_validation && ip_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_id' when calling IPApi.get_specific_ip"
  end
  # resource path
  local_var_path = '/account/ip/{ip_id}'.sub('{' + 'ip_id' + '}', CGI.escape(ip_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] || 'IP'

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

  new_options = opts.merge(
    :operation => :"IPApi.get_specific_ip",
    :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: IPApi#get_specific_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ip(ip_update_request, ip_id, opts = {}) ⇒ IP

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

Parameters:

  • ip_update_request (IPUpdateRequest)
  • ip_id (Integer) —

    The unique ID of the IP resource to update.

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

    the optional parameters

Returns:



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

def update_ip(ip_update_request, ip_id, opts = {})
  data, _status_code, _headers = update_ip_with_http_info(ip_update_request, ip_id, opts)
  data
end

#update_ip_with_http_info(ip_update_request, ip_id, opts = {}) ⇒ Array<(IP, Integer, Hash)>

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

Parameters:

  • ip_update_request (IPUpdateRequest)
  • ip_id (Integer) —

    The unique ID of the IP resource to update.

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

    the optional parameters

Returns:

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

    IP 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_api.rb', line 299

def update_ip_with_http_info(ip_update_request, ip_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPApi.update_ip ...'
  end
  # verify the required parameter 'ip_update_request' is set
  if @api_client.config.client_side_validation && ip_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'ip_update_request' when calling IPApi.update_ip"
  end
  # verify the required parameter 'ip_id' is set
  if @api_client.config.client_side_validation && ip_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_id' when calling IPApi.update_ip"
  end
  # resource path
  local_var_path = '/account/ip/{ip_id}'.sub('{' + 'ip_id' + '}', CGI.escape(ip_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_update_request)

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

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

  new_options = opts.merge(
    :operation => :"IPApi.update_ip",
    :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: IPApi#update_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end