Class: Brevo::DomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/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/brevo/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/brevo/api/domains_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#authenticate_domain(domain_name, opts = {}) ⇒ AuthenticateDomainModel

Authenticate a domain

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/brevo/api/domains_api.rb', line 36

def authenticate_domain(domain_name, opts = {})
  data, _status_code, _headers = authenticate_domain_with_http_info(domain_name, opts)
  data
end

#authenticate_domain_with_http_info(domain_name, opts = {}) ⇒ Array<(AuthenticateDomainModel, Fixnum, Hash)>

Authenticate a domain

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:

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

    AuthenticateDomainModel data, response status code and response headers



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

def authenticate_domain_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.authenticate_domain ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainsApi.authenticate_domain"
  end
  # resource path
  local_var_path = '/senders/domains/{domainName}/authenticate'.sub('{' + 'domainName' + '}', domain_name.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', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticateDomainModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#authenticate_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_domain(opts = {}) ⇒ CreateDomainModel

Create a new domain

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



88
89
90
91
 
# File 'lib/brevo/api/domains_api.rb', line 88

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

#create_domain_with_http_info(opts = {}) ⇒ Array<(CreateDomainModel, Fixnum, Hash)>

Create a new domain

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateDomainModel data, response status code and response headers



97
98
99
100
101
102
103
104
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
 
# File 'lib/brevo/api/domains_api.rb', line 97

def create_domain_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.create_domain ...'
  end
  # resource path
  local_var_path = '/senders/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_name'])
  auth_names = ['api-key', 'partner-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 => 'CreateDomainModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#create_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_domain(domain_name, opts = {}) ⇒ nil

Delete a domain

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:

  • (nil) 


136
137
138
139
 
# File 'lib/brevo/api/domains_api.rb', line 136

def delete_domain(domain_name, opts = {})
  delete_domain_with_http_info(domain_name, opts)
  nil
end

#delete_domain_with_http_info(domain_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a domain

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/brevo/api/domains_api.rb', line 145

def delete_domain_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.delete_domain ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainsApi.delete_domain"
  end
  # resource path
  local_var_path = '/senders/domains/{domainName}'.sub('{' + 'domainName' + '}', domain_name.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', 'partner-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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#delete_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_domain_configuration(domain_name, opts = {}) ⇒ GetDomainConfigurationModel

Validate domain configuration

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:



187
188
189
190
 
# File 'lib/brevo/api/domains_api.rb', line 187

def get_domain_configuration(domain_name, opts = {})
  data, _status_code, _headers = get_domain_configuration_with_http_info(domain_name, opts)
  data
end

#get_domain_configuration_with_http_info(domain_name, opts = {}) ⇒ Array<(GetDomainConfigurationModel, Fixnum, Hash)>

Validate domain configuration

Parameters:

  • domain_name —

    Domain name

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

    the optional parameters

Returns:



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/brevo/api/domains_api.rb', line 196

def get_domain_configuration_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.get_domain_configuration ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainsApi.get_domain_configuration"
  end
  # resource path
  local_var_path = '/senders/domains/{domainName}'.sub('{' + 'domainName' + '}', domain_name.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', 'partner-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 => 'GetDomainConfigurationModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#get_domain_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_domains(opts = {}) ⇒ GetDomainsList

Get the list of all your domains

Parameters:

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/brevo/api/domains_api.rb', line 238

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

#get_domains_with_http_info(opts = {}) ⇒ Array<(GetDomainsList, Fixnum, Hash)>

Get the list of all your domains

Parameters:

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

    the optional parameters

Returns:

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

    GetDomainsList data, response status code and response headers



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/brevo/api/domains_api.rb', line 246

def get_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.get_domains ...'
  end
  # resource path
  local_var_path = '/senders/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', 'partner-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 => 'GetDomainsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#get_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo/api/domains_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end