Class: CloudmersiveValidateApiClient::DomainApi

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

def api_client
  @api_client
end

Instance Method Details

#domain_check(domain, opts = {}) ⇒ CheckResponse

Validate a domain name Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Parameters:

  • domain —

    Domain name to check, for example "cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 28

def domain_check(domain, opts = {})
  data, _status_code, _headers = domain_check_with_http_info(domain, opts)
  return data
end

#domain_check_with_http_info(domain, opts = {}) ⇒ Array<(CheckResponse, Fixnum, Hash)>

Validate a domain name Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

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

    CheckResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 38

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(domain)
  auth_names = ['Apikey']
  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 => 'CheckResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_post(domain, opts = {}) ⇒ WhoisResponse

Get WHOIS information for a domain Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain’s owners.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 83

def domain_post(domain, opts = {})
  data, _status_code, _headers = domain_post_with_http_info(domain, opts)
  return data
end

#domain_post_with_http_info(domain, opts = {}) ⇒ Array<(WhoisResponse, Fixnum, Hash)>

Get WHOIS information for a domain Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain&#39;s owners.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

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

    WhoisResponse data, response status code and response headers



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
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 93

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(domain)
  auth_names = ['Apikey']
  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 => 'WhoisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_url_full(request, opts = {}) ⇒ ValidateUrlResponseFull

Validate a URL fully Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 138

def domain_url_full(request, opts = {})
  data, _status_code, _headers = domain_url_full_with_http_info(request, opts)
  return data
end

#domain_url_full_with_http_info(request, opts = {}) ⇒ Array<(ValidateUrlResponseFull, Fixnum, Hash)>

Validate a URL fully Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:

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

    ValidateUrlResponseFull data, response status code and response headers



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
183
184
185
186
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 148

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  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 => 'ValidateUrlResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_url_full\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_url_syntax_only(request, opts = {}) ⇒ ValidateUrlResponseSyntaxOnly

Validate a URL syntactically Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL information

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

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 193

def domain_url_syntax_only(request, opts = {})
  data, _status_code, _headers = domain_url_syntax_only_with_http_info(request, opts)
  return data
end

#domain_url_syntax_only_with_http_info(request, opts = {}) ⇒ Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>

Validate a URL syntactically Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL information

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

    the optional parameters

Returns:



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
235
236
237
238
239
240
241
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 203

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  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 => 'ValidateUrlResponseSyntaxOnly')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_url_syntax_only\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end