Class: Sendpost::DomainApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainApi

Returns a new instance of DomainApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_sub_account_domain(create_domain_request, opts = {}) ⇒ Domain

Create Domain Register a new sending domain with SendPost. After creation, you'll receive DNS records that must be configured with your DNS provider before you can send emails. Domain Setup Process: 1. Call this endpoint with your domain name 2. Copy the returned DNS records (DKIM, Return-Path, Track, DMARC) 3. Add records to your DNS provider (GoDaddy, Cloudflare, Route53, etc.) 4. Wait for DNS propagation (typically 15 minutes to 48 hours) 5. Verification happens automatically, or trigger manual verification DNS Records Explained: | Record | Purpose | Required | |--------|---------|----------| | DKIM | Cryptographically signs emails to prove authenticity | Yes | | Return-Path | Routes bounce notifications through SendPost | Recommended | | Track | Enables click tracking with your domain | Optional | | DMARC | Adds additional authentication layer | Recommended | Best Practices: - Use a subdomain like mail.yourdomain.com for sending - Keep your root domain for your website - Configure all records for best deliverability

Parameters:

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

    the optional parameters

Returns:



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

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

#create_sub_account_domain_with_http_info(create_domain_request, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Create Domain Register a new sending domain with SendPost. After creation, you'll receive DNS records that must be configured with your DNS provider before you can send emails. Domain Setup Process: 1. Call this endpoint with your domain name 2. Copy the returned DNS records (DKIM, Return-Path, Track, DMARC) 3. Add records to your DNS provider (GoDaddy, Cloudflare, Route53, etc.) 4. Wait for DNS propagation (typically 15 minutes to 48 hours) 5. Verification happens automatically, or trigger manual verification DNS Records Explained: | Record | Purpose | Required | |--------|---------|----------| | DKIM | Cryptographically signs emails to prove authenticity | Yes | | Return-Path | Routes bounce notifications through SendPost | Recommended | | Track | Enables click tracking with your domain | Optional | | DMARC | Adds additional authentication layer | Recommended | Best Practices: - Use a subdomain like `mail.yourdomain.com` for sending - Keep your root domain for your website - Configure all records for best deliverability

Parameters:

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

    the optional parameters

Returns:

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

    Domain 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/domain_api.rb', line 37

def (create_domain_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.create_sub_account_domain ...'
  end
  # verify the required parameter 'create_domain_request' is set
  if @api_client.config.client_side_validation && create_domain_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_domain_request' when calling DomainApi.create_sub_account_domain"
  end
  # resource path
  local_var_path = '/subaccount/domain'

  # 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(create_domain_request)

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

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

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

#delete_sub_account_domain(domain_id, opts = {}) ⇒ DeleteResponse

Delete Domain Remove a sending domain from your sub-account. Once deleted, you can no longer send emails from addresses on this domain. Before Deleting: - Ensure no active email campaigns use this domain - Update sender addresses in your applications - Consider impact on email deliverability Note: DNS records for the domain will become orphaned. You may want to remove them from your DNS provider.

Parameters:

  • domain_id (String) —

    The unique ID of the domain to delete.

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

    the optional parameters

Returns:



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

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

#delete_sub_account_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(DeleteResponse, Integer, Hash)>

Delete Domain Remove a sending domain from your sub-account. Once deleted, you can no longer send emails from addresses on this domain. Before Deleting: - Ensure no active email campaigns use this domain - Update sender addresses in your applications - Consider impact on email deliverability Note: DNS records for the domain will become orphaned. You may want to remove them from your DNS provider.

Parameters:

  • domain_id (String) —

    The unique ID of the domain to delete.

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

    the optional parameters

Returns:

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

    DeleteResponse 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/domain_api.rb', line 105

def (domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.delete_sub_account_domain ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling DomainApi.delete_sub_account_domain"
  end
  # resource path
  local_var_path = '/subaccount/domain/{domain_id}'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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] || 'DeleteResponse'

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

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

#get_all_domains(opts = {}) ⇒ Array<Domain>

List Domains Retrieve all sending domains configured for this sub-account. Use this endpoint to audit your domain setup, check verification status, or retrieve DNS records for configuration. Each domain record includes: - Domain name and unique ID - DNS records to configure (DKIM, Return-Path, Track, DMARC) - Verification status for each record type - Failure messages for troubleshooting - Creation timestamp Verification Status Values: - true - Record verified and active - false - Record not verified (check DNS configuration) Use Cases: - Audit all configured sending domains - Export DNS records for documentation - Identify domains pending verification - Monitor domain health across multiple domains Pagination: Use limit and offset for large domain lists.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

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

  • :offset (Integer) —

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

  • :search (String) —

    Case insensitive search against domain names. Useful for finding specific domains in large lists.

Returns:



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

def get_all_domains(opts = {})
  data, _status_code, _headers = get_all_domains_with_http_info(opts)
  data
end

#get_all_domains_with_http_info(opts = {}) ⇒ Array<(Array<Domain>, Integer, Hash)>

List Domains Retrieve all sending domains configured for this sub-account. Use this endpoint to audit your domain setup, check verification status, or retrieve DNS records for configuration. Each domain record includes: - Domain name and unique ID - DNS records to configure (DKIM, Return-Path, Track, DMARC) - Verification status for each record type - Failure messages for troubleshooting - Creation timestamp Verification Status Values: - `true` - Record verified and active - `false` - Record not verified (check DNS configuration) Use Cases: - Audit all configured sending domains - Export DNS records for documentation - Identify domains pending verification - Monitor domain health across multiple domains Pagination: Use `limit` and `offset` for large domain lists.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

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

  • :offset (Integer) —

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

  • :search (String) —

    Case insensitive search against domain names. Useful for finding specific domains in large lists.

Returns:

  • (Array<(Array<Domain>, 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
218
219
220
221
222
223
224
225
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 172

def get_all_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.get_all_domains ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DomainApi.get_all_domains, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling DomainApi.get_all_domains, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/subaccount/domain'

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

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

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

#get_sub_account_domain(domain_id, opts = {}) ⇒ Domain

Get Domain Retrieve detailed information about a specific sending domain, including DNS record configuration and verification status. Response includes: - Domain name and ID - DKIM, Return-Path, Track, and DMARC DNS records to configure - Verification status for each record type - Failure reasons if verification failed - Domain registration date Use Cases: - Check verification status before sending emails - Retrieve DNS records during domain setup - Debug DNS configuration issues - Audit domain settings for compliance

Parameters:

  • domain_id (String) —

    The unique ID of the domain to retrieve.

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

    the optional parameters

Returns:



232
233
234
235
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 232

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

#get_sub_account_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Get Domain Retrieve detailed information about a specific sending domain, including DNS record configuration and verification status. Response includes: - Domain name and ID - DKIM, Return-Path, Track, and DMARC DNS records to configure - Verification status for each record type - Failure reasons if verification failed - Domain registration date Use Cases: - Check verification status before sending emails - Retrieve DNS records during domain setup - Debug DNS configuration issues - Audit domain settings for compliance

Parameters:

  • domain_id (String) —

    The unique ID of the domain to retrieve.

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

    the optional parameters

Returns:

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

    Domain data, response status code and response headers



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
281
282
283
284
285
286
287
288
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 242

def (domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.get_sub_account_domain ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling DomainApi.get_sub_account_domain"
  end
  # resource path
  local_var_path = '/subaccount/domain/{domain_id}'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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] || 'Domain'

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

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