cloudmersive-validate-api-client 1.3.7 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (123) hide show
  1. checksums.yaml +4 -4
  2. metadata +3 -124
  3. data/Gemfile +0 -7
  4. data/README.md +0 -145
  5. data/Rakefile +0 -8
  6. data/cloudmersive-validate-api-client.gemspec +0 -45
  7. data/docs/AddressApi.md +0 -63
  8. data/docs/AddressGetServersResponse.md +0 -9
  9. data/docs/AddressVerifySyntaxOnlyResponse.md +0 -8
  10. data/docs/CheckResponse.md +0 -8
  11. data/docs/DomainApi.md +0 -228
  12. data/docs/EmailApi.md +0 -173
  13. data/docs/FirstNameValidationRequest.md +0 -8
  14. data/docs/FirstNameValidationResponse.md +0 -9
  15. data/docs/FullEmailValidationResponse.md +0 -16
  16. data/docs/FullNameValidationRequest.md +0 -8
  17. data/docs/FullNameValidationResponse.md +0 -17
  18. data/docs/GeolocateResponse.md +0 -16
  19. data/docs/GetGenderRequest.md +0 -9
  20. data/docs/GetGenderResponse.md +0 -9
  21. data/docs/IPAddressApi.md +0 -63
  22. data/docs/LastNameValidationRequest.md +0 -8
  23. data/docs/LastNameValidationResponse.md +0 -9
  24. data/docs/NameApi.md +0 -283
  25. data/docs/ParseAddressRequest.md +0 -9
  26. data/docs/ParseAddressResponse.md +0 -15
  27. data/docs/PhoneNumberApi.md +0 -63
  28. data/docs/PhoneNumberValidateRequest.md +0 -9
  29. data/docs/PhoneNumberValidationResponse.md +0 -15
  30. data/docs/UserAgentApi.md +0 -63
  31. data/docs/UserAgentValidateRequest.md +0 -8
  32. data/docs/UserAgentValidateResponse.md +0 -21
  33. data/docs/ValidateIdentifierRequest.md +0 -15
  34. data/docs/ValidateIdentifierResponse.md +0 -9
  35. data/docs/ValidateUrlRequestFull.md +0 -8
  36. data/docs/ValidateUrlRequestSyntaxOnly.md +0 -8
  37. data/docs/ValidateUrlResponseFull.md +0 -12
  38. data/docs/ValidateUrlResponseSyntaxOnly.md +0 -9
  39. data/docs/VatApi.md +0 -63
  40. data/docs/VatLookupRequest.md +0 -8
  41. data/docs/VatLookupResponse.md +0 -12
  42. data/docs/WhoisResponse.md +0 -11
  43. data/git_push.sh +0 -55
  44. data/lib/cloudmersive-validate-api-client.rb +0 -75
  45. data/lib/cloudmersive-validate-api-client/api/address_api.rb +0 -78
  46. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +0 -243
  47. data/lib/cloudmersive-validate-api-client/api/email_api.rb +0 -188
  48. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +0 -78
  49. data/lib/cloudmersive-validate-api-client/api/name_api.rb +0 -298
  50. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +0 -78
  51. data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +0 -78
  52. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +0 -78
  53. data/lib/cloudmersive-validate-api-client/api_client.rb +0 -389
  54. data/lib/cloudmersive-validate-api-client/api_error.rb +0 -38
  55. data/lib/cloudmersive-validate-api-client/configuration.rb +0 -209
  56. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +0 -201
  57. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +0 -189
  58. data/lib/cloudmersive-validate-api-client/models/check_response.rb +0 -189
  59. data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +0 -189
  60. data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +0 -199
  61. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +0 -269
  62. data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +0 -189
  63. data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +0 -279
  64. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +0 -269
  65. data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +0 -199
  66. data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +0 -199
  67. data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +0 -189
  68. data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +0 -199
  69. data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +0 -199
  70. data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +0 -259
  71. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +0 -199
  72. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +0 -259
  73. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +0 -189
  74. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +0 -319
  75. data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +0 -259
  76. data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +0 -199
  77. data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +0 -189
  78. data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +0 -189
  79. data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +0 -229
  80. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +0 -199
  81. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +0 -189
  82. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +0 -229
  83. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +0 -219
  84. data/lib/cloudmersive-validate-api-client/version.rb +0 -15
  85. data/spec/api/address_api_spec.rb +0 -47
  86. data/spec/api/domain_api_spec.rb +0 -83
  87. data/spec/api/email_api_spec.rb +0 -71
  88. data/spec/api/ip_address_api_spec.rb +0 -47
  89. data/spec/api/name_api_spec.rb +0 -95
  90. data/spec/api/phone_number_api_spec.rb +0 -47
  91. data/spec/api/user_agent_api_spec.rb +0 -47
  92. data/spec/api/vat_api_spec.rb +0 -47
  93. data/spec/api_client_spec.rb +0 -226
  94. data/spec/configuration_spec.rb +0 -42
  95. data/spec/models/address_get_servers_response_spec.rb +0 -48
  96. data/spec/models/address_verify_syntax_only_response_spec.rb +0 -42
  97. data/spec/models/check_response_spec.rb +0 -42
  98. data/spec/models/first_name_validation_request_spec.rb +0 -42
  99. data/spec/models/first_name_validation_response_spec.rb +0 -48
  100. data/spec/models/full_email_validation_response_spec.rb +0 -90
  101. data/spec/models/full_name_validation_request_spec.rb +0 -42
  102. data/spec/models/full_name_validation_response_spec.rb +0 -96
  103. data/spec/models/geolocate_response_spec.rb +0 -90
  104. data/spec/models/get_gender_request_spec.rb +0 -48
  105. data/spec/models/get_gender_response_spec.rb +0 -48
  106. data/spec/models/last_name_validation_request_spec.rb +0 -42
  107. data/spec/models/last_name_validation_response_spec.rb +0 -48
  108. data/spec/models/parse_address_request_spec.rb +0 -48
  109. data/spec/models/parse_address_response_spec.rb +0 -84
  110. data/spec/models/phone_number_validate_request_spec.rb +0 -48
  111. data/spec/models/phone_number_validation_response_spec.rb +0 -84
  112. data/spec/models/user_agent_validate_request_spec.rb +0 -42
  113. data/spec/models/user_agent_validate_response_spec.rb +0 -120
  114. data/spec/models/validate_identifier_request_spec.rb +0 -84
  115. data/spec/models/validate_identifier_response_spec.rb +0 -48
  116. data/spec/models/validate_url_request_full_spec.rb +0 -42
  117. data/spec/models/validate_url_request_syntax_only_spec.rb +0 -42
  118. data/spec/models/validate_url_response_full_spec.rb +0 -66
  119. data/spec/models/validate_url_response_syntax_only_spec.rb +0 -48
  120. data/spec/models/vat_lookup_request_spec.rb +0 -42
  121. data/spec/models/vat_lookup_response_spec.rb +0 -66
  122. data/spec/models/whois_response_spec.rb +0 -60
  123. data/spec/spec_helper.rb +0 -111
@@ -1,78 +0,0 @@
1
- =begin
2
- #validateapi
3
-
4
- #The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
-
11
- =end
12
-
13
- require "uri"
14
-
15
- module CloudmersiveValidateApiClient
16
- class AddressApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Parse an unstructured input text string into an international, formatted address
24
- # Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
25
- # @param input Input parse request
26
- # @param [Hash] opts the optional parameters
27
- # @return [ParseAddressResponse]
28
- def address_parse_string(input, opts = {})
29
- data, _status_code, _headers = address_parse_string_with_http_info(input, opts)
30
- return data
31
- end
32
-
33
- # Parse an unstructured input text string into an international, formatted address
34
- # Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
35
- # @param input Input parse request
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(ParseAddressResponse, Fixnum, Hash)>] ParseAddressResponse data, response status code and response headers
38
- def address_parse_string_with_http_info(input, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: AddressApi.address_parse_string ..."
41
- end
42
- # verify the required parameter 'input' is set
43
- if @api_client.config.client_side_validation && input.nil?
44
- fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_parse_string"
45
- end
46
- # resource path
47
- local_var_path = "/validate/address/parse"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
58
-
59
- # form parameters
60
- form_params = {}
61
-
62
- # http body (model)
63
- post_body = @api_client.object_to_http_body(input)
64
- auth_names = ['Apikey']
65
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
66
- :header_params => header_params,
67
- :query_params => query_params,
68
- :form_params => form_params,
69
- :body => post_body,
70
- :auth_names => auth_names,
71
- :return_type => 'ParseAddressResponse')
72
- if @api_client.config.debugging
73
- @api_client.config.logger.debug "API called: AddressApi#address_parse_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
- end
75
- return data, status_code, headers
76
- end
77
- end
78
- end
@@ -1,243 +0,0 @@
1
- =begin
2
- #validateapi
3
-
4
- #The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
-
11
- =end
12
-
13
- require "uri"
14
-
15
- module CloudmersiveValidateApiClient
16
- class DomainApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Validate a domain name
24
- # 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.
25
- # @param 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.
26
- # @param [Hash] opts the optional parameters
27
- # @return [CheckResponse]
28
- def domain_check(domain, opts = {})
29
- data, _status_code, _headers = domain_check_with_http_info(domain, opts)
30
- return data
31
- end
32
-
33
- # Validate a domain name
34
- # 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.
35
- # @param 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.
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(CheckResponse, Fixnum, Hash)>] CheckResponse data, response status code and response headers
38
- def domain_check_with_http_info(domain, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: DomainApi.domain_check ..."
41
- end
42
- # verify the required parameter 'domain' is set
43
- if @api_client.config.client_side_validation && domain.nil?
44
- fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_check"
45
- end
46
- # resource path
47
- local_var_path = "/validate/domain/check"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
58
-
59
- # form parameters
60
- form_params = {}
61
-
62
- # http body (model)
63
- post_body = @api_client.object_to_http_body(domain)
64
- auth_names = ['Apikey']
65
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
66
- :header_params => header_params,
67
- :query_params => query_params,
68
- :form_params => form_params,
69
- :body => post_body,
70
- :auth_names => auth_names,
71
- :return_type => 'CheckResponse')
72
- if @api_client.config.debugging
73
- @api_client.config.logger.debug "API called: DomainApi#domain_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
- end
75
- return data, status_code, headers
76
- end
77
-
78
- # Get WHOIS information for a domain
79
- # 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.
80
- # @param 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.
81
- # @param [Hash] opts the optional parameters
82
- # @return [WhoisResponse]
83
- def domain_post(domain, opts = {})
84
- data, _status_code, _headers = domain_post_with_http_info(domain, opts)
85
- return data
86
- end
87
-
88
- # Get WHOIS information for a domain
89
- # 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.
90
- # @param 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.
91
- # @param [Hash] opts the optional parameters
92
- # @return [Array<(WhoisResponse, Fixnum, Hash)>] WhoisResponse data, response status code and response headers
93
- def domain_post_with_http_info(domain, opts = {})
94
- if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: DomainApi.domain_post ..."
96
- end
97
- # verify the required parameter 'domain' is set
98
- if @api_client.config.client_side_validation && domain.nil?
99
- fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_post"
100
- end
101
- # resource path
102
- local_var_path = "/validate/domain/whois"
103
-
104
- # query parameters
105
- query_params = {}
106
-
107
- # header parameters
108
- header_params = {}
109
- # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
111
- # HTTP header 'Content-Type'
112
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
113
-
114
- # form parameters
115
- form_params = {}
116
-
117
- # http body (model)
118
- post_body = @api_client.object_to_http_body(domain)
119
- auth_names = ['Apikey']
120
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
121
- :header_params => header_params,
122
- :query_params => query_params,
123
- :form_params => form_params,
124
- :body => post_body,
125
- :auth_names => auth_names,
126
- :return_type => 'WhoisResponse')
127
- if @api_client.config.debugging
128
- @api_client.config.logger.debug "API called: DomainApi#domain_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
129
- end
130
- return data, status_code, headers
131
- end
132
-
133
- # Validate a URL fully
134
- # 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.
135
- # @param request
136
- # @param [Hash] opts the optional parameters
137
- # @return [ValidateUrlResponseFull]
138
- def domain_url_full(request, opts = {})
139
- data, _status_code, _headers = domain_url_full_with_http_info(request, opts)
140
- return data
141
- end
142
-
143
- # Validate a URL fully
144
- # 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.
145
- # @param request
146
- # @param [Hash] opts the optional parameters
147
- # @return [Array<(ValidateUrlResponseFull, Fixnum, Hash)>] ValidateUrlResponseFull data, response status code and response headers
148
- def domain_url_full_with_http_info(request, opts = {})
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "Calling API: DomainApi.domain_url_full ..."
151
- end
152
- # verify the required parameter 'request' is set
153
- if @api_client.config.client_side_validation && request.nil?
154
- fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_url_full"
155
- end
156
- # resource path
157
- local_var_path = "/validate/domain/url/full"
158
-
159
- # query parameters
160
- query_params = {}
161
-
162
- # header parameters
163
- header_params = {}
164
- # HTTP header 'Accept' (if needed)
165
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
166
- # HTTP header 'Content-Type'
167
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
168
-
169
- # form parameters
170
- form_params = {}
171
-
172
- # http body (model)
173
- post_body = @api_client.object_to_http_body(request)
174
- auth_names = ['Apikey']
175
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
176
- :header_params => header_params,
177
- :query_params => query_params,
178
- :form_params => form_params,
179
- :body => post_body,
180
- :auth_names => auth_names,
181
- :return_type => 'ValidateUrlResponseFull')
182
- if @api_client.config.debugging
183
- @api_client.config.logger.debug "API called: DomainApi#domain_url_full\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
- end
185
- return data, status_code, headers
186
- end
187
-
188
- # Validate a URL syntactically
189
- # 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.
190
- # @param request
191
- # @param [Hash] opts the optional parameters
192
- # @return [ValidateUrlResponseSyntaxOnly]
193
- def domain_url_syntax_only(request, opts = {})
194
- data, _status_code, _headers = domain_url_syntax_only_with_http_info(request, opts)
195
- return data
196
- end
197
-
198
- # Validate a URL syntactically
199
- # 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.
200
- # @param request
201
- # @param [Hash] opts the optional parameters
202
- # @return [Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>] ValidateUrlResponseSyntaxOnly data, response status code and response headers
203
- def domain_url_syntax_only_with_http_info(request, opts = {})
204
- if @api_client.config.debugging
205
- @api_client.config.logger.debug "Calling API: DomainApi.domain_url_syntax_only ..."
206
- end
207
- # verify the required parameter 'request' is set
208
- if @api_client.config.client_side_validation && request.nil?
209
- fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_url_syntax_only"
210
- end
211
- # resource path
212
- local_var_path = "/validate/domain/url/syntax-only"
213
-
214
- # query parameters
215
- query_params = {}
216
-
217
- # header parameters
218
- header_params = {}
219
- # HTTP header 'Accept' (if needed)
220
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
221
- # HTTP header 'Content-Type'
222
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
223
-
224
- # form parameters
225
- form_params = {}
226
-
227
- # http body (model)
228
- post_body = @api_client.object_to_http_body(request)
229
- auth_names = ['Apikey']
230
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
231
- :header_params => header_params,
232
- :query_params => query_params,
233
- :form_params => form_params,
234
- :body => post_body,
235
- :auth_names => auth_names,
236
- :return_type => 'ValidateUrlResponseSyntaxOnly')
237
- if @api_client.config.debugging
238
- @api_client.config.logger.debug "API called: DomainApi#domain_url_syntax_only\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
239
- end
240
- return data, status_code, headers
241
- end
242
- end
243
- end
@@ -1,188 +0,0 @@
1
- =begin
2
- #validateapi
3
-
4
- #The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
-
11
- =end
12
-
13
- require "uri"
14
-
15
- module CloudmersiveValidateApiClient
16
- class EmailApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Partially check whether an email address is valid
24
- # Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.
25
- # @param email Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
26
- # @param [Hash] opts the optional parameters
27
- # @return [AddressGetServersResponse]
28
- def email_address_get_servers(email, opts = {})
29
- data, _status_code, _headers = email_address_get_servers_with_http_info(email, opts)
30
- return data
31
- end
32
-
33
- # Partially check whether an email address is valid
34
- # Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.
35
- # @param email Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(AddressGetServersResponse, Fixnum, Hash)>] AddressGetServersResponse data, response status code and response headers
38
- def email_address_get_servers_with_http_info(email, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: EmailApi.email_address_get_servers ..."
41
- end
42
- # verify the required parameter 'email' is set
43
- if @api_client.config.client_side_validation && email.nil?
44
- fail ArgumentError, "Missing the required parameter 'email' when calling EmailApi.email_address_get_servers"
45
- end
46
- # resource path
47
- local_var_path = "/validate/email/address/servers"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
58
-
59
- # form parameters
60
- form_params = {}
61
-
62
- # http body (model)
63
- post_body = @api_client.object_to_http_body(email)
64
- auth_names = ['Apikey']
65
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
66
- :header_params => header_params,
67
- :query_params => query_params,
68
- :form_params => form_params,
69
- :body => post_body,
70
- :auth_names => auth_names,
71
- :return_type => 'AddressGetServersResponse')
72
- if @api_client.config.debugging
73
- @api_client.config.logger.debug "API called: EmailApi#email_address_get_servers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
- end
75
- return data, status_code, headers
76
- end
77
-
78
- # Fully validate an email address
79
- # Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
80
- # @param email Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
81
- # @param [Hash] opts the optional parameters
82
- # @return [FullEmailValidationResponse]
83
- def email_full_validation(email, opts = {})
84
- data, _status_code, _headers = email_full_validation_with_http_info(email, opts)
85
- return data
86
- end
87
-
88
- # Fully validate an email address
89
- # Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
90
- # @param email Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
91
- # @param [Hash] opts the optional parameters
92
- # @return [Array<(FullEmailValidationResponse, Fixnum, Hash)>] FullEmailValidationResponse data, response status code and response headers
93
- def email_full_validation_with_http_info(email, opts = {})
94
- if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: EmailApi.email_full_validation ..."
96
- end
97
- # verify the required parameter 'email' is set
98
- if @api_client.config.client_side_validation && email.nil?
99
- fail ArgumentError, "Missing the required parameter 'email' when calling EmailApi.email_full_validation"
100
- end
101
- # resource path
102
- local_var_path = "/validate/email/address/full"
103
-
104
- # query parameters
105
- query_params = {}
106
-
107
- # header parameters
108
- header_params = {}
109
- # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
111
- # HTTP header 'Content-Type'
112
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
113
-
114
- # form parameters
115
- form_params = {}
116
-
117
- # http body (model)
118
- post_body = @api_client.object_to_http_body(email)
119
- auth_names = ['Apikey']
120
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
121
- :header_params => header_params,
122
- :query_params => query_params,
123
- :form_params => form_params,
124
- :body => post_body,
125
- :auth_names => auth_names,
126
- :return_type => 'FullEmailValidationResponse')
127
- if @api_client.config.debugging
128
- @api_client.config.logger.debug "API called: EmailApi#email_full_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
129
- end
130
- return data, status_code, headers
131
- end
132
-
133
- # Validate email adddress for syntactic correctness only
134
- # Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.
135
- # @param value Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
136
- # @param [Hash] opts the optional parameters
137
- # @return [AddressVerifySyntaxOnlyResponse]
138
- def email_post(value, opts = {})
139
- data, _status_code, _headers = email_post_with_http_info(value, opts)
140
- return data
141
- end
142
-
143
- # Validate email adddress for syntactic correctness only
144
- # Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.
145
- # @param value Email address to validate, e.g. \&quot;support@cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
146
- # @param [Hash] opts the optional parameters
147
- # @return [Array<(AddressVerifySyntaxOnlyResponse, Fixnum, Hash)>] AddressVerifySyntaxOnlyResponse data, response status code and response headers
148
- def email_post_with_http_info(value, opts = {})
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "Calling API: EmailApi.email_post ..."
151
- end
152
- # verify the required parameter 'value' is set
153
- if @api_client.config.client_side_validation && value.nil?
154
- fail ArgumentError, "Missing the required parameter 'value' when calling EmailApi.email_post"
155
- end
156
- # resource path
157
- local_var_path = "/validate/email/address/syntaxOnly"
158
-
159
- # query parameters
160
- query_params = {}
161
-
162
- # header parameters
163
- header_params = {}
164
- # HTTP header 'Accept' (if needed)
165
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
166
- # HTTP header 'Content-Type'
167
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
168
-
169
- # form parameters
170
- form_params = {}
171
-
172
- # http body (model)
173
- post_body = @api_client.object_to_http_body(value)
174
- auth_names = ['Apikey']
175
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
176
- :header_params => header_params,
177
- :query_params => query_params,
178
- :form_params => form_params,
179
- :body => post_body,
180
- :auth_names => auth_names,
181
- :return_type => 'AddressVerifySyntaxOnlyResponse')
182
- if @api_client.config.debugging
183
- @api_client.config.logger.debug "API called: EmailApi#email_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
- end
185
- return data, status_code, headers
186
- end
187
- end
188
- end