Class: MailchimpTransactional::IpsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpTransactional/api/ips_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IpsApi

Returns a new instance of IpsApi.



19
20
21
 
# File 'lib/MailchimpTransactional/api/ips_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/MailchimpTransactional/api/ips_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_warmup(body = {}) ⇒ Array<(InlineResponse20020, Fixnum, Hash)>

Cancel ip warmup Cancels the warmup process for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20020, Fixnum, Hash)>) —

    InlineResponse20020 data, response status code and response headers



28
29
30
31
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 28

def cancel_warmup(body = {})
  data = @api_client.call_api(:POST, '/ips/cancel-warmup', body)
  data
end

#check_custom_dns(body = {}) ⇒ Array<(InlineResponse20026, Fixnum, Hash)>

Test custom dns Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20026, Fixnum, Hash)>) —

    InlineResponse20026 data, response status code and response headers



38
39
40
41
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 38

def check_custom_dns(body = {})
  data = @api_client.call_api(:POST, '/ips/check-custom-dns', body)
  data
end

#create_pool(body = {}) ⇒ Array<(InlineResponse20024, Fixnum, Hash)>

Add ip pool Creates a pool and returns it. If a pool already exists with this name, no action will be performed.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20024, Fixnum, Hash)>) —

    InlineResponse20024 data, response status code and response headers



48
49
50
51
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 48

def create_pool(body = {})
  data = @api_client.call_api(:POST, '/ips/create-pool', body)
  data
end

#delete(body = {}) ⇒ Array<(InlineResponse20022, Fixnum, Hash)>

Delete ip address Deletes a dedicated IP. This is permanent and cannot be undone.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20022, Fixnum, Hash)>) —

    InlineResponse20022 data, response status code and response headers



58
59
60
61
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 58

def delete(body = {})
  data = @api_client.call_api(:POST, '/ips/delete', body)
  data
end

#delete_pool(body = {}) ⇒ Array<(InlineResponse20025, Fixnum, Hash)>

Delete ip pool Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20025, Fixnum, Hash)>) —

    InlineResponse20025 data, response status code and response headers



68
69
70
71
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 68

def delete_pool(body = {})
  data = @api_client.call_api(:POST, '/ips/delete-pool', body)
  data
end

#info(body = {}) ⇒ Array<(InlineResponse20018, Fixnum, Hash)>

Get ip info Retrieves information about a single dedicated IP.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20018, Fixnum, Hash)>) —

    InlineResponse20018 data, response status code and response headers



78
79
80
81
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 78

def info(body = {})
  data = @api_client.call_api(:POST, '/ips/info', body)
  data
end

#list(body = {}) ⇒ Array<(Array<InlineResponse20017>, Fixnum, Hash)>

List ip addresses Lists your dedicated IPs.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20017>, Fixnum, Hash)>) —

    Array<InlineResponse20017> data, response status code and response headers



88
89
90
91
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 88

def list(body = {})
  data = @api_client.call_api(:POST, '/ips/list', body)
  data
end

#list_pools(body = {}) ⇒ Array<(Array<InlineResponse20023>, Fixnum, Hash)>

List ip pools Lists your dedicated IP pools.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<InlineResponse20023>, Fixnum, Hash)>) —

    Array<InlineResponse20023> data, response status code and response headers



98
99
100
101
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 98

def list_pools(body = {})
  data = @api_client.call_api(:POST, '/ips/list-pools', body)
  data
end

#pool_info(body = {}) ⇒ Array<(InlineResponse20024, Fixnum, Hash)>

Get ip pool info Describes a single dedicated IP pool.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20024, Fixnum, Hash)>) —

    InlineResponse20024 data, response status code and response headers



108
109
110
111
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 108

def pool_info(body = {})
  data = @api_client.call_api(:POST, '/ips/pool-info', body)
  data
end

#provision(body = {}) ⇒ Array<(InlineResponse20019, Fixnum, Hash)>

Request additional ip Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20019, Fixnum, Hash)>) —

    InlineResponse20019 data, response status code and response headers



118
119
120
121
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 118

def provision(body = {})
  data = @api_client.call_api(:POST, '/ips/provision', body)
  data
end

#set_custom_dns(body = {}) ⇒ Array<(InlineResponse20027, Fixnum, Hash)>

Set custom dns Configures the custom DNS name for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20027, Fixnum, Hash)>) —

    InlineResponse20027 data, response status code and response headers



128
129
130
131
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 128

def set_custom_dns(body = {})
  data = @api_client.call_api(:POST, '/ips/set-custom-dns', body)
  data
end

#set_pool(body = {}) ⇒ Array<(InlineResponse20021, Fixnum, Hash)>

Move ip to different pool Moves a dedicated IP to a different pool.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20021, Fixnum, Hash)>) —

    InlineResponse20021 data, response status code and response headers



138
139
140
141
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 138

def set_pool(body = {})
  data = @api_client.call_api(:POST, '/ips/set-pool', body)
  data
end

#start_warmup(body = {}) ⇒ Array<(InlineResponse20020, Fixnum, Hash)>

Start ip warmup Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20020, Fixnum, Hash)>) —

    InlineResponse20020 data, response status code and response headers



148
149
150
151
 
# File 'lib/MailchimpTransactional/api/ips_api.rb', line 148

def start_warmup(body = {})
  data = @api_client.call_api(:POST, '/ips/start-warmup', body)
  data
end