cloudmersive-validate-api-client 2.0.3 → 2.0.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (183) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -0
  3. data/README.md +177 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-validate-api-client.gemspec +45 -0
  6. data/docs/AddressApi.md +607 -0
  7. data/docs/AddressGetServersResponse.md +9 -0
  8. data/docs/AddressVerifySyntaxOnlyResponse.md +11 -0
  9. data/docs/CheckResponse.md +8 -0
  10. data/docs/CountryDetails.md +16 -0
  11. data/docs/CountryListResult.md +9 -0
  12. data/docs/DomainApi.md +228 -0
  13. data/docs/EmailApi.md +173 -0
  14. data/docs/FirstNameValidationRequest.md +8 -0
  15. data/docs/FirstNameValidationResponse.md +9 -0
  16. data/docs/FullEmailValidationResponse.md +16 -0
  17. data/docs/FullNameValidationRequest.md +8 -0
  18. data/docs/FullNameValidationResponse.md +17 -0
  19. data/docs/GeolocateResponse.md +16 -0
  20. data/docs/GetGenderRequest.md +9 -0
  21. data/docs/GetGenderResponse.md +9 -0
  22. data/docs/GetTimezonesRequest.md +8 -0
  23. data/docs/GetTimezonesResponse.md +13 -0
  24. data/docs/IPAddressApi.md +173 -0
  25. data/docs/IPThreatResponse.md +9 -0
  26. data/docs/LastNameValidationRequest.md +8 -0
  27. data/docs/LastNameValidationResponse.md +9 -0
  28. data/docs/LeadEnrichmentApi.md +61 -0
  29. data/docs/LeadEnrichmentRequest.md +21 -0
  30. data/docs/LeadEnrichmentResponse.md +25 -0
  31. data/docs/NameApi.md +283 -0
  32. data/docs/ParseAddressRequest.md +9 -0
  33. data/docs/ParseAddressResponse.md +16 -0
  34. data/docs/PhoneNumberApi.md +63 -0
  35. data/docs/PhoneNumberValidateRequest.md +9 -0
  36. data/docs/PhoneNumberValidationResponse.md +15 -0
  37. data/docs/Timezone.md +10 -0
  38. data/docs/TorNodeResponse.md +8 -0
  39. data/docs/UserAgentApi.md +63 -0
  40. data/docs/UserAgentValidateRequest.md +8 -0
  41. data/docs/UserAgentValidateResponse.md +21 -0
  42. data/docs/ValidateAddressRequest.md +13 -0
  43. data/docs/ValidateAddressResponse.md +10 -0
  44. data/docs/ValidateCityRequest.md +11 -0
  45. data/docs/ValidateCityResponse.md +12 -0
  46. data/docs/ValidateCountryRequest.md +8 -0
  47. data/docs/ValidateCountryResponse.md +19 -0
  48. data/docs/ValidateIdentifierRequest.md +15 -0
  49. data/docs/ValidateIdentifierResponse.md +9 -0
  50. data/docs/ValidatePostalCodeRequest.md +10 -0
  51. data/docs/ValidatePostalCodeResponse.md +12 -0
  52. data/docs/ValidateStateRequest.md +10 -0
  53. data/docs/ValidateStateResponse.md +11 -0
  54. data/docs/ValidateUrlRequestFull.md +8 -0
  55. data/docs/ValidateUrlRequestSyntaxOnly.md +8 -0
  56. data/docs/ValidateUrlResponseFull.md +12 -0
  57. data/docs/ValidateUrlResponseSyntaxOnly.md +9 -0
  58. data/docs/VatApi.md +63 -0
  59. data/docs/VatLookupRequest.md +8 -0
  60. data/docs/VatLookupResponse.md +19 -0
  61. data/docs/WhoisResponse.md +22 -0
  62. data/git_push.sh +55 -0
  63. data/lib/cloudmersive-validate-api-client.rb +95 -0
  64. data/lib/cloudmersive-validate-api-client/api/address_api.rb +609 -0
  65. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +239 -0
  66. data/lib/cloudmersive-validate-api-client/api/email_api.rb +185 -0
  67. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +185 -0
  68. data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +75 -0
  69. data/lib/cloudmersive-validate-api-client/api/name_api.rb +293 -0
  70. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +77 -0
  71. data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +77 -0
  72. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +77 -0
  73. data/lib/cloudmersive-validate-api-client/api_client.rb +391 -0
  74. data/lib/cloudmersive-validate-api-client/api_error.rb +38 -0
  75. data/lib/cloudmersive-validate-api-client/configuration.rb +209 -0
  76. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +198 -0
  77. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +216 -0
  78. data/lib/cloudmersive-validate-api-client/models/check_response.rb +186 -0
  79. data/lib/cloudmersive-validate-api-client/models/country_details.rb +266 -0
  80. data/lib/cloudmersive-validate-api-client/models/country_list_result.rb +198 -0
  81. data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +186 -0
  82. data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +196 -0
  83. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +266 -0
  84. data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +186 -0
  85. data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +276 -0
  86. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +266 -0
  87. data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +196 -0
  88. data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +196 -0
  89. data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +186 -0
  90. data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +238 -0
  91. data/lib/cloudmersive-validate-api-client/models/ip_threat_response.rb +196 -0
  92. data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +186 -0
  93. data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +196 -0
  94. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +316 -0
  95. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +356 -0
  96. data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +196 -0
  97. data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +266 -0
  98. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +196 -0
  99. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +256 -0
  100. data/lib/cloudmersive-validate-api-client/models/timezone.rb +206 -0
  101. data/lib/cloudmersive-validate-api-client/models/tor_node_response.rb +186 -0
  102. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +186 -0
  103. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +316 -0
  104. data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +236 -0
  105. data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +206 -0
  106. data/lib/cloudmersive-validate-api-client/models/validate_city_request.rb +216 -0
  107. data/lib/cloudmersive-validate-api-client/models/validate_city_response.rb +226 -0
  108. data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +186 -0
  109. data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +298 -0
  110. data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +256 -0
  111. data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +196 -0
  112. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_request.rb +206 -0
  113. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_response.rb +226 -0
  114. data/lib/cloudmersive-validate-api-client/models/validate_state_request.rb +206 -0
  115. data/lib/cloudmersive-validate-api-client/models/validate_state_response.rb +216 -0
  116. data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +186 -0
  117. data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +186 -0
  118. data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +226 -0
  119. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +196 -0
  120. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +186 -0
  121. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +295 -0
  122. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +326 -0
  123. data/lib/cloudmersive-validate-api-client/version.rb +15 -0
  124. data/spec/api/address_api_spec.rb +166 -0
  125. data/spec/api/domain_api_spec.rb +83 -0
  126. data/spec/api/email_api_spec.rb +71 -0
  127. data/spec/api/ip_address_api_spec.rb +71 -0
  128. data/spec/api/lead_enrichment_api_spec.rb +46 -0
  129. data/spec/api/name_api_spec.rb +95 -0
  130. data/spec/api/phone_number_api_spec.rb +47 -0
  131. data/spec/api/user_agent_api_spec.rb +47 -0
  132. data/spec/api/vat_api_spec.rb +47 -0
  133. data/spec/api_client_spec.rb +243 -0
  134. data/spec/configuration_spec.rb +42 -0
  135. data/spec/models/address_get_servers_response_spec.rb +47 -0
  136. data/spec/models/address_verify_syntax_only_response_spec.rb +59 -0
  137. data/spec/models/check_response_spec.rb +41 -0
  138. data/spec/models/country_details_spec.rb +89 -0
  139. data/spec/models/country_list_result_spec.rb +47 -0
  140. data/spec/models/first_name_validation_request_spec.rb +41 -0
  141. data/spec/models/first_name_validation_response_spec.rb +47 -0
  142. data/spec/models/full_email_validation_response_spec.rb +89 -0
  143. data/spec/models/full_name_validation_request_spec.rb +41 -0
  144. data/spec/models/full_name_validation_response_spec.rb +95 -0
  145. data/spec/models/geolocate_response_spec.rb +89 -0
  146. data/spec/models/get_gender_request_spec.rb +47 -0
  147. data/spec/models/get_gender_response_spec.rb +47 -0
  148. data/spec/models/get_timezones_request_spec.rb +41 -0
  149. data/spec/models/get_timezones_response_spec.rb +71 -0
  150. data/spec/models/ip_threat_response_spec.rb +47 -0
  151. data/spec/models/last_name_validation_request_spec.rb +41 -0
  152. data/spec/models/last_name_validation_response_spec.rb +47 -0
  153. data/spec/models/lead_enrichment_request_spec.rb +119 -0
  154. data/spec/models/lead_enrichment_response_spec.rb +143 -0
  155. data/spec/models/parse_address_request_spec.rb +47 -0
  156. data/spec/models/parse_address_response_spec.rb +89 -0
  157. data/spec/models/phone_number_validate_request_spec.rb +47 -0
  158. data/spec/models/phone_number_validation_response_spec.rb +83 -0
  159. data/spec/models/timezone_spec.rb +53 -0
  160. data/spec/models/tor_node_response_spec.rb +41 -0
  161. data/spec/models/user_agent_validate_request_spec.rb +41 -0
  162. data/spec/models/user_agent_validate_response_spec.rb +119 -0
  163. data/spec/models/validate_address_request_spec.rb +71 -0
  164. data/spec/models/validate_address_response_spec.rb +53 -0
  165. data/spec/models/validate_city_request_spec.rb +59 -0
  166. data/spec/models/validate_city_response_spec.rb +65 -0
  167. data/spec/models/validate_country_request_spec.rb +41 -0
  168. data/spec/models/validate_country_response_spec.rb +107 -0
  169. data/spec/models/validate_identifier_request_spec.rb +83 -0
  170. data/spec/models/validate_identifier_response_spec.rb +47 -0
  171. data/spec/models/validate_postal_code_request_spec.rb +53 -0
  172. data/spec/models/validate_postal_code_response_spec.rb +65 -0
  173. data/spec/models/validate_state_request_spec.rb +53 -0
  174. data/spec/models/validate_state_response_spec.rb +59 -0
  175. data/spec/models/validate_url_request_full_spec.rb +41 -0
  176. data/spec/models/validate_url_request_syntax_only_spec.rb +41 -0
  177. data/spec/models/validate_url_response_full_spec.rb +65 -0
  178. data/spec/models/validate_url_response_syntax_only_spec.rb +47 -0
  179. data/spec/models/vat_lookup_request_spec.rb +41 -0
  180. data/spec/models/vat_lookup_response_spec.rb +107 -0
  181. data/spec/models/whois_response_spec.rb +125 -0
  182. data/spec/spec_helper.rb +111 -0
  183. metadata +184 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5efe04a8630eb42d2da718fbcbbea0d4d771002cc0e76511be74715b4b5e2159
4
- data.tar.gz: 33e562418f44208eb9294ebac5923521c665754fb6024839d5f4937e0437b6af
3
+ metadata.gz: 1fb382f1dbe5f06ff959501816df879a458d77f7469f9112cfabeb1f9966917c
4
+ data.tar.gz: f640178248133cd34265425ab9d4fde9ba97f353afed3fc75600f64f23f747a9
5
5
  SHA512:
6
- metadata.gz: 98eb107d146193c91d255907690e114c8a9bedf9f35738e649b7f0062704827e02aa06a21d347310afaa2427e4e0684ec8724a0787ebd807297f6ebc98d94d43
7
- data.tar.gz: d9b2ab3ced71bf5014935ec9564bdcc8851e13a1cb6a0896d0525c9cddbe478f2200a1ce027c3d33c76632ef490f9acc989ed2c0ca940c126a7a01fcda18b1f5
6
+ metadata.gz: d86f5d1155b8ddeaf82843e39a5bd1155d064d10ec5b73f62a2015bdce567718480a8772188350a0919a6dd572da368a7d7f6cc03255788e2bc213b781369c5f
7
+ data.tar.gz: 89f94bc4cfffc3faa4b97f451487a2f259e8e0a10c75aaa103b8f1d8377b7cece8541f95321112a39169b1ab41fa5d137a1a9c18a8caa7b3aa92ce7b81f0ed01
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.3.3'
7
+ end
@@ -0,0 +1,177 @@
1
+ # cloudmersive-validate-api-client
2
+
3
+ CloudmersiveValidateApiClient - the Ruby gem for the validateapi
4
+
5
+ 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.
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: v1
10
+ - Package version: 2.0.8
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build cloudmersive-validate-api-client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./cloudmersive-validate-api-client-2.0.8.gem
27
+ ```
28
+ (for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.8.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'cloudmersive-validate-api-client', '~> 2.0.8'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'cloudmersive-validate-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'cloudmersive-validate-api-client'
56
+
57
+ # Setup authorization
58
+ CloudmersiveValidateApiClient.configure do |config|
59
+ # Configure API key authorization: Apikey
60
+ config.api_key['Apikey'] = 'YOUR API KEY'
61
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
62
+ #config.api_key_prefix['Apikey'] = 'Bearer'
63
+ end
64
+
65
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
66
+
67
+ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
68
+
69
+
70
+ begin
71
+ #Check if a country is a member of the European Union (EU)
72
+ result = api_instance.address_check_eu_membership(input)
73
+ p result
74
+ rescue CloudmersiveValidateApiClient::ApiError => e
75
+ puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
76
+ end
77
+
78
+ ```
79
+
80
+ ## Documentation for API Endpoints
81
+
82
+ All URIs are relative to *https://api.cloudmersive.com*
83
+
84
+ Class | Method | HTTP request | Description
85
+ ------------ | ------------- | ------------- | -------------
86
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_check_eu_membership**](docs/AddressApi.md#address_check_eu_membership) | **POST** /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU)
87
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_country**](docs/AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
88
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_country_list**](docs/AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries
89
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_currency**](docs/AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
90
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_region**](docs/AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
91
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_get_timezone**](docs/AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
92
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_parse_string**](docs/AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
93
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
94
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_city**](docs/AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
95
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_postal_code**](docs/AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
96
+ *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_state**](docs/AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
97
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
98
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
99
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
100
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
101
+ *CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
102
+ *CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
103
+ *CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
104
+ *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_threat**](docs/IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
105
+ *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_tor_node**](docs/IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
106
+ *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
107
+ *CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_enrich_lead**](docs/LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
108
+ *CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
109
+ *CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
110
+ *CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
111
+ *CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
112
+ *CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
113
+ *CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
114
+ *CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
115
+ *CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
116
+
117
+
118
+ ## Documentation for Models
119
+
120
+ - [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
121
+ - [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
122
+ - [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
123
+ - [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
124
+ - [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
125
+ - [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
126
+ - [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
127
+ - [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
128
+ - [CloudmersiveValidateApiClient::FullNameValidationRequest](docs/FullNameValidationRequest.md)
129
+ - [CloudmersiveValidateApiClient::FullNameValidationResponse](docs/FullNameValidationResponse.md)
130
+ - [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
131
+ - [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
132
+ - [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
133
+ - [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
134
+ - [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
135
+ - [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
136
+ - [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
137
+ - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
138
+ - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
139
+ - [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
140
+ - [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
141
+ - [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
142
+ - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
143
+ - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
144
+ - [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
145
+ - [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
146
+ - [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
147
+ - [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
148
+ - [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
149
+ - [CloudmersiveValidateApiClient::ValidateAddressResponse](docs/ValidateAddressResponse.md)
150
+ - [CloudmersiveValidateApiClient::ValidateCityRequest](docs/ValidateCityRequest.md)
151
+ - [CloudmersiveValidateApiClient::ValidateCityResponse](docs/ValidateCityResponse.md)
152
+ - [CloudmersiveValidateApiClient::ValidateCountryRequest](docs/ValidateCountryRequest.md)
153
+ - [CloudmersiveValidateApiClient::ValidateCountryResponse](docs/ValidateCountryResponse.md)
154
+ - [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
155
+ - [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
156
+ - [CloudmersiveValidateApiClient::ValidatePostalCodeRequest](docs/ValidatePostalCodeRequest.md)
157
+ - [CloudmersiveValidateApiClient::ValidatePostalCodeResponse](docs/ValidatePostalCodeResponse.md)
158
+ - [CloudmersiveValidateApiClient::ValidateStateRequest](docs/ValidateStateRequest.md)
159
+ - [CloudmersiveValidateApiClient::ValidateStateResponse](docs/ValidateStateResponse.md)
160
+ - [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
161
+ - [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
162
+ - [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
163
+ - [CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly](docs/ValidateUrlResponseSyntaxOnly.md)
164
+ - [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
165
+ - [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
166
+ - [CloudmersiveValidateApiClient::WhoisResponse](docs/WhoisResponse.md)
167
+
168
+
169
+ ## Documentation for Authorization
170
+
171
+
172
+ ### Apikey
173
+
174
+ - **Type**: API key
175
+ - **API key parameter name**: Apikey
176
+ - **Location**: HTTP header
177
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,45 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #validateapi
5
+
6
+ #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.
7
+
8
+ OpenAPI spec version: v1
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 2.4.14
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "cloudmersive-validate-api-client/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "cloudmersive-validate-api-client"
20
+ s.version = CloudmersiveValidateApiClient::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Cloudmersive"]
23
+ s.email = [""]
24
+ s.homepage = "https://www.cloudmersive.com/validate-api"
25
+ s.summary = "Validate key business data thoroughly."
26
+ s.description = "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."
27
+ s.license = 'Apache 2.0'
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
35
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
36
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
37
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
38
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
+
41
+ s.files = Dir['./**/*']
42
+ s.test_files = `find spec/*`.split("\n")
43
+ s.executables = []
44
+ s.require_paths = ["lib"]
45
+ end
@@ -0,0 +1,607 @@
1
+ # CloudmersiveValidateApiClient::AddressApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**address_check_eu_membership**](AddressApi.md#address_check_eu_membership) | **POST** /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU)
8
+ [**address_country**](AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name
9
+ [**address_country_list**](AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries
10
+ [**address_get_country_currency**](AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
11
+ [**address_get_country_region**](AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
12
+ [**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
13
+ [**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
14
+ [**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
15
+ [**address_validate_city**](AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
16
+ [**address_validate_postal_code**](AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
17
+ [**address_validate_state**](AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
18
+
19
+
20
+ # **address_check_eu_membership**
21
+ > ValidateCountryResponse address_check_eu_membership(input)
22
+
23
+ Check if a country is a member of the European Union (EU)
24
+
25
+ Checks if the input country is a member of the European Union or not.
26
+
27
+ ### Example
28
+ ```ruby
29
+ # load the gem
30
+ require 'cloudmersive-validate-api-client'
31
+ # setup authorization
32
+ CloudmersiveValidateApiClient.configure do |config|
33
+ # Configure API key authorization: Apikey
34
+ config.api_key['Apikey'] = 'YOUR API KEY'
35
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
36
+ #config.api_key_prefix['Apikey'] = 'Bearer'
37
+ end
38
+
39
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
40
+
41
+ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
42
+
43
+
44
+ begin
45
+ #Check if a country is a member of the European Union (EU)
46
+ result = api_instance.address_check_eu_membership(input)
47
+ p result
48
+ rescue CloudmersiveValidateApiClient::ApiError => e
49
+ puts "Exception when calling AddressApi->address_check_eu_membership: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
58
+
59
+ ### Return type
60
+
61
+ [**ValidateCountryResponse**](ValidateCountryResponse.md)
62
+
63
+ ### Authorization
64
+
65
+ [Apikey](../README.md#Apikey)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: application/json, text/json
70
+ - **Accept**: application/json, text/json, application/xml, text/xml
71
+
72
+
73
+
74
+ # **address_country**
75
+ > ValidateCountryResponse address_country(input)
76
+
77
+ Validate and normalize country information, return ISO 3166-1 country codes and country name
78
+
79
+ Validates and normalizes country information, and returns key information about a country, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.
80
+
81
+ ### Example
82
+ ```ruby
83
+ # load the gem
84
+ require 'cloudmersive-validate-api-client'
85
+ # setup authorization
86
+ CloudmersiveValidateApiClient.configure do |config|
87
+ # Configure API key authorization: Apikey
88
+ config.api_key['Apikey'] = 'YOUR API KEY'
89
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
90
+ #config.api_key_prefix['Apikey'] = 'Bearer'
91
+ end
92
+
93
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
94
+
95
+ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
96
+
97
+
98
+ begin
99
+ #Validate and normalize country information, return ISO 3166-1 country codes and country name
100
+ result = api_instance.address_country(input)
101
+ p result
102
+ rescue CloudmersiveValidateApiClient::ApiError => e
103
+ puts "Exception when calling AddressApi->address_country: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ Name | Type | Description | Notes
110
+ ------------- | ------------- | ------------- | -------------
111
+ **input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
112
+
113
+ ### Return type
114
+
115
+ [**ValidateCountryResponse**](ValidateCountryResponse.md)
116
+
117
+ ### Authorization
118
+
119
+ [Apikey](../README.md#Apikey)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: application/json, text/json
124
+ - **Accept**: application/json, text/json, application/xml, text/xml
125
+
126
+
127
+
128
+ # **address_country_list**
129
+ > CountryListResult address_country_list
130
+
131
+ Get a list of ISO 3166-1 countries
132
+
133
+ Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
134
+
135
+ ### Example
136
+ ```ruby
137
+ # load the gem
138
+ require 'cloudmersive-validate-api-client'
139
+ # setup authorization
140
+ CloudmersiveValidateApiClient.configure do |config|
141
+ # Configure API key authorization: Apikey
142
+ config.api_key['Apikey'] = 'YOUR API KEY'
143
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
144
+ #config.api_key_prefix['Apikey'] = 'Bearer'
145
+ end
146
+
147
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
148
+
149
+ begin
150
+ #Get a list of ISO 3166-1 countries
151
+ result = api_instance.address_country_list
152
+ p result
153
+ rescue CloudmersiveValidateApiClient::ApiError => e
154
+ puts "Exception when calling AddressApi->address_country_list: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+ This endpoint does not need any parameter.
160
+
161
+ ### Return type
162
+
163
+ [**CountryListResult**](CountryListResult.md)
164
+
165
+ ### Authorization
166
+
167
+ [Apikey](../README.md#Apikey)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: Not defined
172
+ - **Accept**: application/json, text/json, application/xml, text/xml
173
+
174
+
175
+
176
+ # **address_get_country_currency**
177
+ > ValidateCountryResponse address_get_country_currency(input)
178
+
179
+ Get the currency of the input country
180
+
181
+ Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
182
+
183
+ ### Example
184
+ ```ruby
185
+ # load the gem
186
+ require 'cloudmersive-validate-api-client'
187
+ # setup authorization
188
+ CloudmersiveValidateApiClient.configure do |config|
189
+ # Configure API key authorization: Apikey
190
+ config.api_key['Apikey'] = 'YOUR API KEY'
191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
192
+ #config.api_key_prefix['Apikey'] = 'Bearer'
193
+ end
194
+
195
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
196
+
197
+ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
198
+
199
+
200
+ begin
201
+ #Get the currency of the input country
202
+ result = api_instance.address_get_country_currency(input)
203
+ p result
204
+ rescue CloudmersiveValidateApiClient::ApiError => e
205
+ puts "Exception when calling AddressApi->address_get_country_currency: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ Name | Type | Description | Notes
212
+ ------------- | ------------- | ------------- | -------------
213
+ **input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
214
+
215
+ ### Return type
216
+
217
+ [**ValidateCountryResponse**](ValidateCountryResponse.md)
218
+
219
+ ### Authorization
220
+
221
+ [Apikey](../README.md#Apikey)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: application/json, text/json
226
+ - **Accept**: application/json, text/json, application/xml, text/xml
227
+
228
+
229
+
230
+ # **address_get_country_region**
231
+ > ValidateCountryResponse address_get_country_region(input)
232
+
233
+ Get the region, subregion and continent of the country
234
+
235
+ Gets the continent information including region and subregion for the input country.
236
+
237
+ ### Example
238
+ ```ruby
239
+ # load the gem
240
+ require 'cloudmersive-validate-api-client'
241
+ # setup authorization
242
+ CloudmersiveValidateApiClient.configure do |config|
243
+ # Configure API key authorization: Apikey
244
+ config.api_key['Apikey'] = 'YOUR API KEY'
245
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
+ #config.api_key_prefix['Apikey'] = 'Bearer'
247
+ end
248
+
249
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
250
+
251
+ input = CloudmersiveValidateApiClient::ValidateCountryRequest.new # ValidateCountryRequest | Input request
252
+
253
+
254
+ begin
255
+ #Get the region, subregion and continent of the country
256
+ result = api_instance.address_get_country_region(input)
257
+ p result
258
+ rescue CloudmersiveValidateApiClient::ApiError => e
259
+ puts "Exception when calling AddressApi->address_get_country_region: #{e}"
260
+ end
261
+ ```
262
+
263
+ ### Parameters
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **input** | [**ValidateCountryRequest**](ValidateCountryRequest.md)| Input request |
268
+
269
+ ### Return type
270
+
271
+ [**ValidateCountryResponse**](ValidateCountryResponse.md)
272
+
273
+ ### Authorization
274
+
275
+ [Apikey](../README.md#Apikey)
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: application/json, text/json
280
+ - **Accept**: application/json, text/json, application/xml, text/xml
281
+
282
+
283
+
284
+ # **address_get_timezone**
285
+ > GetTimezonesResponse address_get_timezone(input)
286
+
287
+ Gets IANA/Olsen time zones for a country
288
+
289
+ Gets the IANA/Olsen time zones for a country.
290
+
291
+ ### Example
292
+ ```ruby
293
+ # load the gem
294
+ require 'cloudmersive-validate-api-client'
295
+ # setup authorization
296
+ CloudmersiveValidateApiClient.configure do |config|
297
+ # Configure API key authorization: Apikey
298
+ config.api_key['Apikey'] = 'YOUR API KEY'
299
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
300
+ #config.api_key_prefix['Apikey'] = 'Bearer'
301
+ end
302
+
303
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
304
+
305
+ input = CloudmersiveValidateApiClient::GetTimezonesRequest.new # GetTimezonesRequest | Input request
306
+
307
+
308
+ begin
309
+ #Gets IANA/Olsen time zones for a country
310
+ result = api_instance.address_get_timezone(input)
311
+ p result
312
+ rescue CloudmersiveValidateApiClient::ApiError => e
313
+ puts "Exception when calling AddressApi->address_get_timezone: #{e}"
314
+ end
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ Name | Type | Description | Notes
320
+ ------------- | ------------- | ------------- | -------------
321
+ **input** | [**GetTimezonesRequest**](GetTimezonesRequest.md)| Input request |
322
+
323
+ ### Return type
324
+
325
+ [**GetTimezonesResponse**](GetTimezonesResponse.md)
326
+
327
+ ### Authorization
328
+
329
+ [Apikey](../README.md#Apikey)
330
+
331
+ ### HTTP request headers
332
+
333
+ - **Content-Type**: application/json, text/json
334
+ - **Accept**: application/json, text/json, application/xml, text/xml
335
+
336
+
337
+
338
+ # **address_parse_string**
339
+ > ParseAddressResponse address_parse_string(input)
340
+
341
+ Parse an unstructured input text string into an international, formatted address
342
+
343
+ 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.
344
+
345
+ ### Example
346
+ ```ruby
347
+ # load the gem
348
+ require 'cloudmersive-validate-api-client'
349
+ # setup authorization
350
+ CloudmersiveValidateApiClient.configure do |config|
351
+ # Configure API key authorization: Apikey
352
+ config.api_key['Apikey'] = 'YOUR API KEY'
353
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
354
+ #config.api_key_prefix['Apikey'] = 'Bearer'
355
+ end
356
+
357
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
358
+
359
+ input = CloudmersiveValidateApiClient::ParseAddressRequest.new # ParseAddressRequest | Input parse request
360
+
361
+
362
+ begin
363
+ #Parse an unstructured input text string into an international, formatted address
364
+ result = api_instance.address_parse_string(input)
365
+ p result
366
+ rescue CloudmersiveValidateApiClient::ApiError => e
367
+ puts "Exception when calling AddressApi->address_parse_string: #{e}"
368
+ end
369
+ ```
370
+
371
+ ### Parameters
372
+
373
+ Name | Type | Description | Notes
374
+ ------------- | ------------- | ------------- | -------------
375
+ **input** | [**ParseAddressRequest**](ParseAddressRequest.md)| Input parse request |
376
+
377
+ ### Return type
378
+
379
+ [**ParseAddressResponse**](ParseAddressResponse.md)
380
+
381
+ ### Authorization
382
+
383
+ [Apikey](../README.md#Apikey)
384
+
385
+ ### HTTP request headers
386
+
387
+ - **Content-Type**: application/json, text/json
388
+ - **Accept**: application/json, text/json, application/xml, text/xml
389
+
390
+
391
+
392
+ # **address_validate_address**
393
+ > ValidateAddressResponse address_validate_address(input)
394
+
395
+ Validate a street address
396
+
397
+ Determines if an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.
398
+
399
+ ### Example
400
+ ```ruby
401
+ # load the gem
402
+ require 'cloudmersive-validate-api-client'
403
+ # setup authorization
404
+ CloudmersiveValidateApiClient.configure do |config|
405
+ # Configure API key authorization: Apikey
406
+ config.api_key['Apikey'] = 'YOUR API KEY'
407
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
408
+ #config.api_key_prefix['Apikey'] = 'Bearer'
409
+ end
410
+
411
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
412
+
413
+ input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
414
+
415
+
416
+ begin
417
+ #Validate a street address
418
+ result = api_instance.address_validate_address(input)
419
+ p result
420
+ rescue CloudmersiveValidateApiClient::ApiError => e
421
+ puts "Exception when calling AddressApi->address_validate_address: #{e}"
422
+ end
423
+ ```
424
+
425
+ ### Parameters
426
+
427
+ Name | Type | Description | Notes
428
+ ------------- | ------------- | ------------- | -------------
429
+ **input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
430
+
431
+ ### Return type
432
+
433
+ [**ValidateAddressResponse**](ValidateAddressResponse.md)
434
+
435
+ ### Authorization
436
+
437
+ [Apikey](../README.md#Apikey)
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: application/json, text/json
442
+ - **Accept**: application/json, text/json, application/xml, text/xml
443
+
444
+
445
+
446
+ # **address_validate_city**
447
+ > ValidateCityResponse address_validate_city(input)
448
+
449
+ Validate a City and State/Province combination, get location information about it
450
+
451
+ Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.
452
+
453
+ ### Example
454
+ ```ruby
455
+ # load the gem
456
+ require 'cloudmersive-validate-api-client'
457
+ # setup authorization
458
+ CloudmersiveValidateApiClient.configure do |config|
459
+ # Configure API key authorization: Apikey
460
+ config.api_key['Apikey'] = 'YOUR API KEY'
461
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
462
+ #config.api_key_prefix['Apikey'] = 'Bearer'
463
+ end
464
+
465
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
466
+
467
+ input = CloudmersiveValidateApiClient::ValidateCityRequest.new # ValidateCityRequest | Input parse request
468
+
469
+
470
+ begin
471
+ #Validate a City and State/Province combination, get location information about it
472
+ result = api_instance.address_validate_city(input)
473
+ p result
474
+ rescue CloudmersiveValidateApiClient::ApiError => e
475
+ puts "Exception when calling AddressApi->address_validate_city: #{e}"
476
+ end
477
+ ```
478
+
479
+ ### Parameters
480
+
481
+ Name | Type | Description | Notes
482
+ ------------- | ------------- | ------------- | -------------
483
+ **input** | [**ValidateCityRequest**](ValidateCityRequest.md)| Input parse request |
484
+
485
+ ### Return type
486
+
487
+ [**ValidateCityResponse**](ValidateCityResponse.md)
488
+
489
+ ### Authorization
490
+
491
+ [Apikey](../README.md#Apikey)
492
+
493
+ ### HTTP request headers
494
+
495
+ - **Content-Type**: application/json, text/json
496
+ - **Accept**: application/json, text/json, application/xml, text/xml
497
+
498
+
499
+
500
+ # **address_validate_postal_code**
501
+ > ValidatePostalCodeResponse address_validate_postal_code(input)
502
+
503
+ Validate a postal code, get location information about it
504
+
505
+ Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.
506
+
507
+ ### Example
508
+ ```ruby
509
+ # load the gem
510
+ require 'cloudmersive-validate-api-client'
511
+ # setup authorization
512
+ CloudmersiveValidateApiClient.configure do |config|
513
+ # Configure API key authorization: Apikey
514
+ config.api_key['Apikey'] = 'YOUR API KEY'
515
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
516
+ #config.api_key_prefix['Apikey'] = 'Bearer'
517
+ end
518
+
519
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
520
+
521
+ input = CloudmersiveValidateApiClient::ValidatePostalCodeRequest.new # ValidatePostalCodeRequest | Input parse request
522
+
523
+
524
+ begin
525
+ #Validate a postal code, get location information about it
526
+ result = api_instance.address_validate_postal_code(input)
527
+ p result
528
+ rescue CloudmersiveValidateApiClient::ApiError => e
529
+ puts "Exception when calling AddressApi->address_validate_postal_code: #{e}"
530
+ end
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ Name | Type | Description | Notes
536
+ ------------- | ------------- | ------------- | -------------
537
+ **input** | [**ValidatePostalCodeRequest**](ValidatePostalCodeRequest.md)| Input parse request |
538
+
539
+ ### Return type
540
+
541
+ [**ValidatePostalCodeResponse**](ValidatePostalCodeResponse.md)
542
+
543
+ ### Authorization
544
+
545
+ [Apikey](../README.md#Apikey)
546
+
547
+ ### HTTP request headers
548
+
549
+ - **Content-Type**: application/json, text/json
550
+ - **Accept**: application/json, text/json, application/xml, text/xml
551
+
552
+
553
+
554
+ # **address_validate_state**
555
+ > ValidateStateResponse address_validate_state(input)
556
+
557
+ Validate a state or province, name or abbreviation, get location information about it
558
+
559
+ Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.
560
+
561
+ ### Example
562
+ ```ruby
563
+ # load the gem
564
+ require 'cloudmersive-validate-api-client'
565
+ # setup authorization
566
+ CloudmersiveValidateApiClient.configure do |config|
567
+ # Configure API key authorization: Apikey
568
+ config.api_key['Apikey'] = 'YOUR API KEY'
569
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
570
+ #config.api_key_prefix['Apikey'] = 'Bearer'
571
+ end
572
+
573
+ api_instance = CloudmersiveValidateApiClient::AddressApi.new
574
+
575
+ input = CloudmersiveValidateApiClient::ValidateStateRequest.new # ValidateStateRequest | Input parse request
576
+
577
+
578
+ begin
579
+ #Validate a state or province, name or abbreviation, get location information about it
580
+ result = api_instance.address_validate_state(input)
581
+ p result
582
+ rescue CloudmersiveValidateApiClient::ApiError => e
583
+ puts "Exception when calling AddressApi->address_validate_state: #{e}"
584
+ end
585
+ ```
586
+
587
+ ### Parameters
588
+
589
+ Name | Type | Description | Notes
590
+ ------------- | ------------- | ------------- | -------------
591
+ **input** | [**ValidateStateRequest**](ValidateStateRequest.md)| Input parse request |
592
+
593
+ ### Return type
594
+
595
+ [**ValidateStateResponse**](ValidateStateResponse.md)
596
+
597
+ ### Authorization
598
+
599
+ [Apikey](../README.md#Apikey)
600
+
601
+ ### HTTP request headers
602
+
603
+ - **Content-Type**: application/json, text/json
604
+ - **Accept**: application/json, text/json, application/xml, text/xml
605
+
606
+
607
+