Class: Mimepost::DomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mimepost/api/domains_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainsApi

Returns a new instance of DomainsApi.



19
20
21
 
# File 'lib/mimepost/api/domains_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/mimepost/api/domains_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#domains_get(opts = {}) ⇒ ApiResponseDomainsList

Get a list of all the domains

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/mimepost/api/domains_api.rb', line 25

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

#domains_get_with_http_info(opts = {}) ⇒ Array<(ApiResponseDomainsList, Fixnum, Hash)>

Get a list of all the domains

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponseDomainsList data, response status code and response headers



33
34
35
36
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
 
# File 'lib/mimepost/api/domains_api.rb', line 33

def domains_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_get ...'
  end
  # resource path
  local_var_path = '/domains/'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseDomainsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_approve_post(id, opts = {}) ⇒ ApiResponse

Submit request for the approval of a verified domain

Parameters:

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

    the optional parameters

Returns:



72
73
74
75
 
# File 'lib/mimepost/api/domains_api.rb', line 72

def domains_id_approve_post(id, opts = {})
  data, _status_code, _headers = domains_id_approve_post_with_http_info(id, opts)
  data
end

#domains_id_approve_post_with_http_info(id, opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Submit request for the approval of a verified domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponse data, response status code and response headers



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mimepost/api/domains_api.rb', line 81

def domains_id_approve_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_approve_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_approve_post"
  end
  # resource path
  local_var_path = '/domains/{id}/approve/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_approve_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_delete(id, opts = {}) ⇒ ApiResponse

Remove a single domain

Parameters:

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

    the optional parameters

Returns:



124
125
126
127
 
# File 'lib/mimepost/api/domains_api.rb', line 124

def domains_id_delete(id, opts = {})
  data, _status_code, _headers = domains_id_delete_with_http_info(id, opts)
  data
end

#domains_id_delete_with_http_info(id, opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Remove a single domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponse data, response status code and response headers



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/mimepost/api/domains_api.rb', line 133

def domains_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_delete"
  end
  # resource path
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_get(id, opts = {}) ⇒ ApiResponseDomainsList

Get the details of a single domain

Parameters:

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/mimepost/api/domains_api.rb', line 176

def domains_id_get(id, opts = {})
  data, _status_code, _headers = domains_id_get_with_http_info(id, opts)
  data
end

#domains_id_get_with_http_info(id, opts = {}) ⇒ Array<(ApiResponseDomainsList, Fixnum, Hash)>

Get the details of a single domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponseDomainsList data, response status code and response headers



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
 
# File 'lib/mimepost/api/domains_api.rb', line 185

def domains_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_get"
  end
  # resource path
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseDomainsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_verify_dkim_post(id, opts = {}) ⇒ ApiResponse

Request for the verification of DKIM record for a single domain

Parameters:

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

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/mimepost/api/domains_api.rb', line 228

def domains_id_verify_dkim_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_dkim_post_with_http_info(id, opts)
  data
end

#domains_id_verify_dkim_post_with_http_info(id, opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Request for the verification of DKIM record for a single domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponse data, response status code and response headers



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
 
# File 'lib/mimepost/api/domains_api.rb', line 237

def domains_id_verify_dkim_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_dkim_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_dkim_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_dkim/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_dkim_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_verify_spf_post(id, opts = {}) ⇒ ApiResponse

Request for the verification of SPF record for a single domain

Parameters:

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

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/mimepost/api/domains_api.rb', line 280

def domains_id_verify_spf_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_spf_post_with_http_info(id, opts)
  data
end

#domains_id_verify_spf_post_with_http_info(id, opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Request for the verification of SPF record for a single domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponse data, response status code and response headers



289
290
291
292
293
294
295
296
297
298
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
 
# File 'lib/mimepost/api/domains_api.rb', line 289

def domains_id_verify_spf_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_spf_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_spf_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_spf/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_spf_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_id_verify_tracking_post(id, opts = {}) ⇒ ApiResponse

Request for the verification of tracking record for a single domain

Parameters:

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

    the optional parameters

Returns:



332
333
334
335
 
# File 'lib/mimepost/api/domains_api.rb', line 332

def domains_id_verify_tracking_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_tracking_post_with_http_info(id, opts)
  data
end

#domains_id_verify_tracking_post_with_http_info(id, opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Request for the verification of tracking record for a single domain

Parameters:

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

    the optional parameters

Returns:

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

    ApiResponse data, response status code and response headers



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/mimepost/api/domains_api.rb', line 341

def domains_id_verify_tracking_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_tracking_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_tracking_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_tracking/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_tracking_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domains_post(opts = {}) ⇒ ApiResponse

Add single domain

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :domain (Domain) —

    The name of the domain name

Returns:



384
385
386
387
 
# File 'lib/mimepost/api/domains_api.rb', line 384

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

#domains_post_with_http_info(opts = {}) ⇒ Array<(ApiResponse, Fixnum, Hash)>

Add single domain

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :domain (Domain) —

    The name of the domain name

Returns:

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

    ApiResponse data, response status code and response headers



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/mimepost/api/domains_api.rb', line 393

def domains_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_post ...'
  end
  # resource path
  local_var_path = '/domains/'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'domain'])
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end