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

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

List Domains Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request

  • :offset (Integer) —

    Number of initial records to skip

  • :search (String) —

    Case insensitive search against domain names

Returns:



29
30
31
32
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 29

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 a list of all domains associated with the sub-account, including their DNS records and authentication status.

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request

  • :offset (Integer) —

    Number of initial records to skip

  • :search (String) —

    Case insensitive search against domain names

Returns:

  • Array<Domain> data, response status code and response headers



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
89
90
91
92
93
94
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 41

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

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

Delete Domain Delete a specific domain using its ‘id`.

Parameters:

  • The unique ID of the domain to delete.

  • (defaults to: {})

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 101

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

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

Delete Domain Delete a specific domain using its &#x60;id&#x60;.

Parameters:

  • The unique ID of the domain to delete.

  • (defaults to: {})

    the optional parameters

Returns:

  • DeleteResponse data, response status code and response headers



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
152
153
154
155
156
157
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 111

def subaccount_domain_domain_id_delete_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.subaccount_domain_domain_id_delete ...'
  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.subaccount_domain_domain_id_delete"
  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.subaccount_domain_domain_id_delete",
    :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#subaccount_domain_domain_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Domain Retrieve details of a specific domain using its ‘id`.

Parameters:

  • The unique ID of the domain to retrieve.

  • (defaults to: {})

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 164

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

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

Get Domain Retrieve details of a specific domain using its &#x60;id&#x60;.

Parameters:

  • The unique ID of the domain to retrieve.

  • (defaults to: {})

    the optional parameters

Returns:

  • Domain data, response status code and response headers



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
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 174

def subaccount_domain_domain_id_get_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.subaccount_domain_domain_id_get ...'
  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.subaccount_domain_domain_id_get"
  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.subaccount_domain_domain_id_get",
    :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#subaccount_domain_domain_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create Domain Add a new domain using its ‘name`.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 227

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

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

Create Domain Add a new domain using its &#x60;name&#x60;.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • Domain 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
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/sendpost_ruby_sdk/api/domain_api.rb', line 237

def subaccount_domain_post_with_http_info(create_domain_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.subaccount_domain_post ...'
  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.subaccount_domain_post"
  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.subaccount_domain_post",
    :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#subaccount_domain_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end