cloudmersive-validate-api-client 2.0.3 → 2.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (177) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -0
  3. data/README.md +171 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-validate-api-client.gemspec +45 -0
  6. data/docs/AddressApi.md +497 -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 +11 -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 +63 -0
  25. data/docs/LastNameValidationRequest.md +8 -0
  26. data/docs/LastNameValidationResponse.md +9 -0
  27. data/docs/LeadEnrichmentApi.md +61 -0
  28. data/docs/LeadEnrichmentRequest.md +21 -0
  29. data/docs/LeadEnrichmentResponse.md +25 -0
  30. data/docs/NameApi.md +283 -0
  31. data/docs/ParseAddressRequest.md +9 -0
  32. data/docs/ParseAddressResponse.md +16 -0
  33. data/docs/PhoneNumberApi.md +63 -0
  34. data/docs/PhoneNumberValidateRequest.md +9 -0
  35. data/docs/PhoneNumberValidationResponse.md +15 -0
  36. data/docs/Timezone.md +10 -0
  37. data/docs/UserAgentApi.md +63 -0
  38. data/docs/UserAgentValidateRequest.md +8 -0
  39. data/docs/UserAgentValidateResponse.md +21 -0
  40. data/docs/ValidateAddressRequest.md +13 -0
  41. data/docs/ValidateAddressResponse.md +10 -0
  42. data/docs/ValidateCityRequest.md +11 -0
  43. data/docs/ValidateCityResponse.md +12 -0
  44. data/docs/ValidateCountryRequest.md +8 -0
  45. data/docs/ValidateCountryResponse.md +14 -0
  46. data/docs/ValidateIdentifierRequest.md +15 -0
  47. data/docs/ValidateIdentifierResponse.md +9 -0
  48. data/docs/ValidatePostalCodeRequest.md +10 -0
  49. data/docs/ValidatePostalCodeResponse.md +12 -0
  50. data/docs/ValidateStateRequest.md +10 -0
  51. data/docs/ValidateStateResponse.md +11 -0
  52. data/docs/ValidateUrlRequestFull.md +8 -0
  53. data/docs/ValidateUrlRequestSyntaxOnly.md +8 -0
  54. data/docs/ValidateUrlResponseFull.md +12 -0
  55. data/docs/ValidateUrlResponseSyntaxOnly.md +9 -0
  56. data/docs/VatApi.md +63 -0
  57. data/docs/VatLookupRequest.md +8 -0
  58. data/docs/VatLookupResponse.md +19 -0
  59. data/docs/WhoisResponse.md +22 -0
  60. data/git_push.sh +55 -0
  61. data/lib/cloudmersive-validate-api-client.rb +93 -0
  62. data/lib/cloudmersive-validate-api-client/api/address_api.rb +501 -0
  63. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +239 -0
  64. data/lib/cloudmersive-validate-api-client/api/email_api.rb +185 -0
  65. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +77 -0
  66. data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +75 -0
  67. data/lib/cloudmersive-validate-api-client/api/name_api.rb +293 -0
  68. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +77 -0
  69. data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +77 -0
  70. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +77 -0
  71. data/lib/cloudmersive-validate-api-client/api_client.rb +391 -0
  72. data/lib/cloudmersive-validate-api-client/api_error.rb +38 -0
  73. data/lib/cloudmersive-validate-api-client/configuration.rb +209 -0
  74. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +198 -0
  75. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +216 -0
  76. data/lib/cloudmersive-validate-api-client/models/check_response.rb +186 -0
  77. data/lib/cloudmersive-validate-api-client/models/country_details.rb +216 -0
  78. data/lib/cloudmersive-validate-api-client/models/country_list_result.rb +198 -0
  79. data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +186 -0
  80. data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +196 -0
  81. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +266 -0
  82. data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +186 -0
  83. data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +276 -0
  84. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +266 -0
  85. data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +196 -0
  86. data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +196 -0
  87. data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +186 -0
  88. data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +238 -0
  89. data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +186 -0
  90. data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +196 -0
  91. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +316 -0
  92. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +356 -0
  93. data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +196 -0
  94. data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +266 -0
  95. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +196 -0
  96. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +256 -0
  97. data/lib/cloudmersive-validate-api-client/models/timezone.rb +206 -0
  98. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +186 -0
  99. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +316 -0
  100. data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +236 -0
  101. data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +206 -0
  102. data/lib/cloudmersive-validate-api-client/models/validate_city_request.rb +216 -0
  103. data/lib/cloudmersive-validate-api-client/models/validate_city_response.rb +226 -0
  104. data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +186 -0
  105. data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +248 -0
  106. data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +256 -0
  107. data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +196 -0
  108. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_request.rb +206 -0
  109. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_response.rb +226 -0
  110. data/lib/cloudmersive-validate-api-client/models/validate_state_request.rb +206 -0
  111. data/lib/cloudmersive-validate-api-client/models/validate_state_response.rb +216 -0
  112. data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +186 -0
  113. data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +186 -0
  114. data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +226 -0
  115. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +196 -0
  116. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +186 -0
  117. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +295 -0
  118. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +326 -0
  119. data/lib/cloudmersive-validate-api-client/version.rb +15 -0
  120. data/spec/api/address_api_spec.rb +142 -0
  121. data/spec/api/domain_api_spec.rb +83 -0
  122. data/spec/api/email_api_spec.rb +71 -0
  123. data/spec/api/ip_address_api_spec.rb +47 -0
  124. data/spec/api/lead_enrichment_api_spec.rb +46 -0
  125. data/spec/api/name_api_spec.rb +95 -0
  126. data/spec/api/phone_number_api_spec.rb +47 -0
  127. data/spec/api/user_agent_api_spec.rb +47 -0
  128. data/spec/api/vat_api_spec.rb +47 -0
  129. data/spec/api_client_spec.rb +243 -0
  130. data/spec/configuration_spec.rb +42 -0
  131. data/spec/models/address_get_servers_response_spec.rb +47 -0
  132. data/spec/models/address_verify_syntax_only_response_spec.rb +59 -0
  133. data/spec/models/check_response_spec.rb +41 -0
  134. data/spec/models/country_details_spec.rb +59 -0
  135. data/spec/models/country_list_result_spec.rb +47 -0
  136. data/spec/models/first_name_validation_request_spec.rb +41 -0
  137. data/spec/models/first_name_validation_response_spec.rb +47 -0
  138. data/spec/models/full_email_validation_response_spec.rb +89 -0
  139. data/spec/models/full_name_validation_request_spec.rb +41 -0
  140. data/spec/models/full_name_validation_response_spec.rb +95 -0
  141. data/spec/models/geolocate_response_spec.rb +89 -0
  142. data/spec/models/get_gender_request_spec.rb +47 -0
  143. data/spec/models/get_gender_response_spec.rb +47 -0
  144. data/spec/models/get_timezones_request_spec.rb +41 -0
  145. data/spec/models/get_timezones_response_spec.rb +71 -0
  146. data/spec/models/last_name_validation_request_spec.rb +41 -0
  147. data/spec/models/last_name_validation_response_spec.rb +47 -0
  148. data/spec/models/lead_enrichment_request_spec.rb +119 -0
  149. data/spec/models/lead_enrichment_response_spec.rb +143 -0
  150. data/spec/models/parse_address_request_spec.rb +47 -0
  151. data/spec/models/parse_address_response_spec.rb +89 -0
  152. data/spec/models/phone_number_validate_request_spec.rb +47 -0
  153. data/spec/models/phone_number_validation_response_spec.rb +83 -0
  154. data/spec/models/timezone_spec.rb +53 -0
  155. data/spec/models/user_agent_validate_request_spec.rb +41 -0
  156. data/spec/models/user_agent_validate_response_spec.rb +119 -0
  157. data/spec/models/validate_address_request_spec.rb +71 -0
  158. data/spec/models/validate_address_response_spec.rb +53 -0
  159. data/spec/models/validate_city_request_spec.rb +59 -0
  160. data/spec/models/validate_city_response_spec.rb +65 -0
  161. data/spec/models/validate_country_request_spec.rb +41 -0
  162. data/spec/models/validate_country_response_spec.rb +77 -0
  163. data/spec/models/validate_identifier_request_spec.rb +83 -0
  164. data/spec/models/validate_identifier_response_spec.rb +47 -0
  165. data/spec/models/validate_postal_code_request_spec.rb +53 -0
  166. data/spec/models/validate_postal_code_response_spec.rb +65 -0
  167. data/spec/models/validate_state_request_spec.rb +53 -0
  168. data/spec/models/validate_state_response_spec.rb +59 -0
  169. data/spec/models/validate_url_request_full_spec.rb +41 -0
  170. data/spec/models/validate_url_request_syntax_only_spec.rb +41 -0
  171. data/spec/models/validate_url_response_full_spec.rb +65 -0
  172. data/spec/models/validate_url_response_syntax_only_spec.rb +47 -0
  173. data/spec/models/vat_lookup_request_spec.rb +41 -0
  174. data/spec/models/vat_lookup_response_spec.rb +107 -0
  175. data/spec/models/whois_response_spec.rb +125 -0
  176. data/spec/spec_helper.rb +111 -0
  177. metadata +177 -2
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::FirstNameValidationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **first_name** | **String** | First name to process | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::FirstNameValidationResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
7
+ **validation_result** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
8
+
9
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveValidateApiClient::FullEmailValidationResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_address** | **BOOLEAN** | True if the email address is valid overall, false otherwise | [optional]
7
+ **mail_server_used_for_validation** | **String** | Email server connected to for verification | [optional]
8
+ **valid_syntax** | **BOOLEAN** | True if the syntax of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one. | [optional]
9
+ **valid_domain** | **BOOLEAN** | True if the domain name of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one. | [optional]
10
+ **valid_smtp** | **BOOLEAN** | True if the email address was verified by the remote server, false otherwise. This is one component of ValidAddress, but not the only one. | [optional]
11
+ **is_catchall_domain** | **BOOLEAN** | True if the domain is a catch-all domain name, false otherwise. Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails. Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time. | [optional]
12
+ **domain** | **String** | Domain name of the email address | [optional]
13
+ **is_free_email_provider** | **BOOLEAN** | True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise. | [optional]
14
+ **is_disposable** | **BOOLEAN** | True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there. | [optional]
15
+
16
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::FullNameValidationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **full_name_string** | **String** | Full name to process as a free-form string; supports many components such as First Name, Middle Name, Last Name, Title, Nickname, Suffix, and Display Name | [optional]
7
+
8
+
@@ -0,0 +1,17 @@
1
+ # CloudmersiveValidateApiClient::FullNameValidationResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
7
+ **validation_result_first_name** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
8
+ **validation_result_last_name** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
9
+ **title** | **String** | The person's title (if supplied), e.g. \"Mr.\" or \"Ms.\" | [optional]
10
+ **first_name** | **String** | The first name (given name) | [optional]
11
+ **middle_name** | **String** | The middle name(s); if there are multiple names they will be separated by spaces | [optional]
12
+ **last_name** | **String** | The last name (surname) | [optional]
13
+ **nick_name** | **String** | Nickname (if supplied) | [optional]
14
+ **suffix** | **String** | Suffix to the name, e.g. \"Jr.\" or \"Sr.\" | [optional]
15
+ **display_name** | **String** | The full display name of the name | [optional]
16
+
17
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveValidateApiClient::GeolocateResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_code** | **String** | Two-letter country code of IP address | [optional]
7
+ **country_name** | **String** | Country name of IP address | [optional]
8
+ **city** | **String** | City of IP address | [optional]
9
+ **region_code** | **String** | State/region code of IP address | [optional]
10
+ **region_name** | **String** | State/region of IP address | [optional]
11
+ **zip_code** | **String** | Zip or postal code of IP address | [optional]
12
+ **timezone_standard_name** | **String** | Timezone of IP address | [optional]
13
+ **latitude** | **Float** | Latitude of IP address | [optional]
14
+ **longitude** | **Float** | Longitude of IP address | [optional]
15
+
16
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::GetGenderRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **first_name** | **String** | Input first name (given name) to get the gender of | [optional]
7
+ **country_code** | **String** | Optional; the country for this name, possible values are \"US\", \"LY\", \"NI\", \"TT\", \"MK\", \"KZ\", \"BO\", \"UG\", \"TZ\", \"CL\", \"SI\", \"MA\", \"RW\", \"VN\", \"AW\", \"CY\", \"BH\", \"SG\", \"ZA\", \"MU\", \"BR\", \"TN\", \"KH\", \"US\", \"TH\", \"TW\", \"UY\", \"DO\", \"CO\", \"UA\", \"QA\", \"BY\", \"SN\", \"SD\", \"FJ\", \"LB\", \"BE\", \"ML\", \"LV\", \"FR\", \"TM\", \"NG\", \"EC\", \"NO\", \"SL\", \"CR\", \"PA\", \"GE\", \"CH\", \"KR\", \"RS\", \"ZM\", \"FI\", \"BF\", \"MC\", \"AU\", \"GA\", \"LS\", \"RU\", \"IN\", \"SE\", \"LK\", \"BZ\", \"MX\", \"GH\", \"AF\", \"TJ\", \"BN\", \"DZ\", \"CM\", \"GR\", \"MD\", \"HN\", \"AT\", \"NZ\", \"SV\", \"GW\", \"NA\", \"AR\", \"MZ\", \"PK\", \"MN\", \"IQ\", \"BW\", \"VE\", \"PT\", \"BS\", \"AL\", \"TG\", \"ID\", \"ET\", \"CF\", \"JP\", \"BB\", \"PH\", \"CU\", \"BD\", \"AO\", \"SM\", \"LC\", \"ME\", \"RO\", DANIL\"O\"\", \"ES\", \"EE\", \"IL\", \"ZW\", \"SY\", \"MW\", \"LU\", \"IR\", \"SC\", \"NL\", \"JO\", \"AM\", \"DE\", \"GL\", \"OM\", \"DK\", \"HR\", \"LI\", \"TD\", \"KM\", \"BA\", \"GM\", \"GD\", \"CA\", \"CZ\", \"MR\", \"ST\", \"IS\", \"LR\", \"IE\", \"VC\", \"AE\", \"KG\", \"DJ\", \"TR\", \"KE\", \"NE\", \"UZ\", \"CN\", \"GQ\", \"SK\", \"BJ\", \"MG\", \"BT\", \"EG\", \"PL\", \"IT\", \"SA\", \"MY\", \"CI\", \"AG\", \"AD\", \"KS\", \"HU\", \"CG\", \"KP\", \"DM\", \"GN\", \"GT\", \"NP\", \"JM\", \"LA\", \"GB\", \"BG\", \"HT\", \"PE\", \"AZ\", \"LT\", \"SZ\", \"PY\", \"MT\", \"VA\" | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::GetGenderResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **gender** | **String** | Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female) | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::GetTimezonesRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_code_or_name** | **String** | Can be the two-letter, three-letter country codes or country name | [optional]
7
+
8
+
@@ -0,0 +1,13 @@
1
+ # CloudmersiveValidateApiClient::GetTimezonesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **country_full_name** | **String** | Full name of the country | [optional]
8
+ **iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
9
+ **fips_two_letter_code** | **String** | Two-letter FIPS 10-4 country code | [optional]
10
+ **three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
11
+ **timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional]
12
+
13
+
@@ -0,0 +1,63 @@
1
+ # CloudmersiveValidateApiClient::IPAddressApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
8
+
9
+
10
+ # **i_p_address_post**
11
+ > GeolocateResponse i_p_address_post(value)
12
+
13
+ Geolocate an IP address
14
+
15
+ Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'cloudmersive-validate-api-client'
21
+ # setup authorization
22
+ CloudmersiveValidateApiClient.configure do |config|
23
+ # Configure API key authorization: Apikey
24
+ config.api_key['Apikey'] = 'YOUR API KEY'
25
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
26
+ #config.api_key_prefix['Apikey'] = 'Bearer'
27
+ end
28
+
29
+ api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
30
+
31
+ value = 'value_example' # String | IP address to geolocate, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
32
+
33
+
34
+ begin
35
+ #Geolocate an IP address
36
+ result = api_instance.i_p_address_post(value)
37
+ p result
38
+ rescue CloudmersiveValidateApiClient::ApiError => e
39
+ puts "Exception when calling IPAddressApi->i_p_address_post: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **value** | **String**| IP address to geolocate, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
48
+
49
+ ### Return type
50
+
51
+ [**GeolocateResponse**](GeolocateResponse.md)
52
+
53
+ ### Authorization
54
+
55
+ [Apikey](../README.md#Apikey)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: text/javascript, application/json, text/json
60
+ - **Accept**: application/json, text/json, application/xml, text/xml
61
+
62
+
63
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::LastNameValidationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **last_name** | **String** | Last name to process | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::LastNameValidationResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
7
+ **validation_result** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
8
+
9
+
@@ -0,0 +1,61 @@
1
+ # CloudmersiveValidateApiClient::LeadEnrichmentApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**lead_enrichment_enrich_lead**](LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
8
+
9
+
10
+ # **lead_enrichment_enrich_lead**
11
+ > LeadEnrichmentResponse lead_enrichment_enrich_lead(request)
12
+
13
+ Enrich an input lead with additional fields of data
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'cloudmersive-validate-api-client'
19
+ # setup authorization
20
+ CloudmersiveValidateApiClient.configure do |config|
21
+ # Configure API key authorization: Apikey
22
+ config.api_key['Apikey'] = 'YOUR API KEY'
23
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24
+ #config.api_key_prefix['Apikey'] = 'Bearer'
25
+ end
26
+
27
+ api_instance = CloudmersiveValidateApiClient::LeadEnrichmentApi.new
28
+
29
+ request = CloudmersiveValidateApiClient::LeadEnrichmentRequest.new # LeadEnrichmentRequest | Input lead with known fields set, and unknown fields left blank (null)
30
+
31
+
32
+ begin
33
+ #Enrich an input lead with additional fields of data
34
+ result = api_instance.lead_enrichment_enrich_lead(request)
35
+ p result
36
+ rescue CloudmersiveValidateApiClient::ApiError => e
37
+ puts "Exception when calling LeadEnrichmentApi->lead_enrichment_enrich_lead: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **request** | [**LeadEnrichmentRequest**](LeadEnrichmentRequest.md)| Input lead with known fields set, and unknown fields left blank (null) |
46
+
47
+ ### Return type
48
+
49
+ [**LeadEnrichmentResponse**](LeadEnrichmentResponse.md)
50
+
51
+ ### Authorization
52
+
53
+ [Apikey](../README.md#Apikey)
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: application/json, text/json
58
+ - **Accept**: application/json, text/json, application/xml, text/xml
59
+
60
+
61
+
@@ -0,0 +1,21 @@
1
+ # CloudmersiveValidateApiClient::LeadEnrichmentRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **contact_business_email** | **String** | The person's business email address for the lead | [optional]
7
+ **contact_first_name** | **String** | The person's first name for the lead | [optional]
8
+ **contact_last_name** | **String** | The person's last name for the lead | [optional]
9
+ **company_name** | **String** | Name of the company for the lead | [optional]
10
+ **company_domain_name** | **String** | Domain name / website for the lead | [optional]
11
+ **company_house_number** | **String** | House number of the address of the company for the lead | [optional]
12
+ **company_street** | **String** | Street name of the address of the company for the lead | [optional]
13
+ **company_city** | **String** | City of the address of the company for the lead | [optional]
14
+ **company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional]
15
+ **company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional]
16
+ **company_country** | **String** | Country of the address of the company for the lead | [optional]
17
+ **company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional]
18
+ **company_telephone** | **String** | Telephone of the company office for the lead | [optional]
19
+ **company_vat_number** | **String** | VAT number of the company for the lead | [optional]
20
+
21
+
@@ -0,0 +1,25 @@
1
+ # CloudmersiveValidateApiClient::LeadEnrichmentResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **lead_type** | **String** | The type of the lead; possible types are Junk (a single individual using a disposable/throwaway email address); Individual (a single individual, typically a consumer, not purchasing on behalf of a business); SmallBusiness (a small business, typically with fewer than 100 employees); MediumBusiness (a medium business, larger than 100 employees but fewer than 1000 employees); Enterprise (a large business with greater than 1000 employees); Business (a business customer of unknown size) | [optional]
8
+ **contact_business_email** | **String** | The person's business email address for the lead | [optional]
9
+ **contact_first_name** | **String** | The person's first name for the lead | [optional]
10
+ **contact_last_name** | **String** | The person's last name for the lead | [optional]
11
+ **contact_gender** | **String** | Gender for contact name; possible values are Male, Female, and Neutral (can be applied to Male or Female). Requires ContactFirstName. | [optional]
12
+ **company_name** | **String** | Name of the company for the lead | [optional]
13
+ **company_domain_name** | **String** | Domain name / website for the lead | [optional]
14
+ **company_house_number** | **String** | House number of the address of the company for the lead | [optional]
15
+ **company_street** | **String** | Street name of the address of the company for the lead | [optional]
16
+ **company_city** | **String** | City of the address of the company for the lead | [optional]
17
+ **company_state_or_province** | **String** | State or Province of the address of the company for the lead | [optional]
18
+ **company_postal_code** | **String** | Postal Code of the address of the company for the lead | [optional]
19
+ **company_country** | **String** | Country Name of the address of the company for the lead | [optional]
20
+ **company_country_code** | **String** | Country Code (2-letter ISO 3166-1) of the address of the company for the lead | [optional]
21
+ **company_telephone** | **String** | Telephone of the company office for the lead | [optional]
22
+ **company_vat_number** | **String** | VAT number of the company for the lead | [optional]
23
+ **employee_count** | **Integer** | Count of employees at the company (estimated), if available | [optional]
24
+
25
+
@@ -0,0 +1,283 @@
1
+ # CloudmersiveValidateApiClient::NameApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**name_get_gender**](NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
8
+ [**name_identifier**](NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
9
+ [**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
10
+ [**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
11
+ [**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
12
+
13
+
14
+ # **name_get_gender**
15
+ > GetGenderResponse name_get_gender(input)
16
+
17
+ Get the gender of a first name
18
+
19
+ Determines the gender of a first name (given name)
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'cloudmersive-validate-api-client'
25
+ # setup authorization
26
+ CloudmersiveValidateApiClient.configure do |config|
27
+ # Configure API key authorization: Apikey
28
+ config.api_key['Apikey'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Apikey'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = CloudmersiveValidateApiClient::NameApi.new
34
+
35
+ input = CloudmersiveValidateApiClient::GetGenderRequest.new # GetGenderRequest | Gender request information
36
+
37
+
38
+ begin
39
+ #Get the gender of a first name
40
+ result = api_instance.name_get_gender(input)
41
+ p result
42
+ rescue CloudmersiveValidateApiClient::ApiError => e
43
+ puts "Exception when calling NameApi->name_get_gender: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **input** | [**GetGenderRequest**](GetGenderRequest.md)| Gender request information |
52
+
53
+ ### Return type
54
+
55
+ [**GetGenderResponse**](GetGenderResponse.md)
56
+
57
+ ### Authorization
58
+
59
+ [Apikey](../README.md#Apikey)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json, text/json
64
+ - **Accept**: application/json, text/json, application/xml, text/xml
65
+
66
+
67
+
68
+ # **name_identifier**
69
+ > ValidateIdentifierResponse name_identifier(input)
70
+
71
+ Validate a code identifier
72
+
73
+ Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be \"helloWorld\" but not \"hello*World\".
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'cloudmersive-validate-api-client'
79
+ # setup authorization
80
+ CloudmersiveValidateApiClient.configure do |config|
81
+ # Configure API key authorization: Apikey
82
+ config.api_key['Apikey'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Apikey'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = CloudmersiveValidateApiClient::NameApi.new
88
+
89
+ input = CloudmersiveValidateApiClient::ValidateIdentifierRequest.new # ValidateIdentifierRequest | Identifier validation request information
90
+
91
+
92
+ begin
93
+ #Validate a code identifier
94
+ result = api_instance.name_identifier(input)
95
+ p result
96
+ rescue CloudmersiveValidateApiClient::ApiError => e
97
+ puts "Exception when calling NameApi->name_identifier: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **input** | [**ValidateIdentifierRequest**](ValidateIdentifierRequest.md)| Identifier validation request information |
106
+
107
+ ### Return type
108
+
109
+ [**ValidateIdentifierResponse**](ValidateIdentifierResponse.md)
110
+
111
+ ### Authorization
112
+
113
+ [Apikey](../README.md#Apikey)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: application/json, text/json
118
+ - **Accept**: application/json, text/json, application/xml, text/xml
119
+
120
+
121
+
122
+ # **name_validate_first_name**
123
+ > FirstNameValidationResponse name_validate_first_name(input)
124
+
125
+ Validate a first name
126
+
127
+ Determines if a string is a valid first name (given name)
128
+
129
+ ### Example
130
+ ```ruby
131
+ # load the gem
132
+ require 'cloudmersive-validate-api-client'
133
+ # setup authorization
134
+ CloudmersiveValidateApiClient.configure do |config|
135
+ # Configure API key authorization: Apikey
136
+ config.api_key['Apikey'] = 'YOUR API KEY'
137
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
138
+ #config.api_key_prefix['Apikey'] = 'Bearer'
139
+ end
140
+
141
+ api_instance = CloudmersiveValidateApiClient::NameApi.new
142
+
143
+ input = CloudmersiveValidateApiClient::FirstNameValidationRequest.new # FirstNameValidationRequest | Validation request information
144
+
145
+
146
+ begin
147
+ #Validate a first name
148
+ result = api_instance.name_validate_first_name(input)
149
+ p result
150
+ rescue CloudmersiveValidateApiClient::ApiError => e
151
+ puts "Exception when calling NameApi->name_validate_first_name: #{e}"
152
+ end
153
+ ```
154
+
155
+ ### Parameters
156
+
157
+ Name | Type | Description | Notes
158
+ ------------- | ------------- | ------------- | -------------
159
+ **input** | [**FirstNameValidationRequest**](FirstNameValidationRequest.md)| Validation request information |
160
+
161
+ ### Return type
162
+
163
+ [**FirstNameValidationResponse**](FirstNameValidationResponse.md)
164
+
165
+ ### Authorization
166
+
167
+ [Apikey](../README.md#Apikey)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: application/json, text/json
172
+ - **Accept**: application/json, text/json, application/xml, text/xml
173
+
174
+
175
+
176
+ # **name_validate_full_name**
177
+ > FullNameValidationResponse name_validate_full_name(input)
178
+
179
+ Parse and validate a full name
180
+
181
+ Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
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::NameApi.new
196
+
197
+ input = CloudmersiveValidateApiClient::FullNameValidationRequest.new # FullNameValidationRequest | Validation request information
198
+
199
+
200
+ begin
201
+ #Parse and validate a full name
202
+ result = api_instance.name_validate_full_name(input)
203
+ p result
204
+ rescue CloudmersiveValidateApiClient::ApiError => e
205
+ puts "Exception when calling NameApi->name_validate_full_name: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ Name | Type | Description | Notes
212
+ ------------- | ------------- | ------------- | -------------
213
+ **input** | [**FullNameValidationRequest**](FullNameValidationRequest.md)| Validation request information |
214
+
215
+ ### Return type
216
+
217
+ [**FullNameValidationResponse**](FullNameValidationResponse.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
+ # **name_validate_last_name**
231
+ > LastNameValidationResponse name_validate_last_name(input)
232
+
233
+ Validate a last name
234
+
235
+ Determines if a string is a valid last name (surname)
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::NameApi.new
250
+
251
+ input = CloudmersiveValidateApiClient::LastNameValidationRequest.new # LastNameValidationRequest | Validation request information
252
+
253
+
254
+ begin
255
+ #Validate a last name
256
+ result = api_instance.name_validate_last_name(input)
257
+ p result
258
+ rescue CloudmersiveValidateApiClient::ApiError => e
259
+ puts "Exception when calling NameApi->name_validate_last_name: #{e}"
260
+ end
261
+ ```
262
+
263
+ ### Parameters
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **input** | [**LastNameValidationRequest**](LastNameValidationRequest.md)| Validation request information |
268
+
269
+ ### Return type
270
+
271
+ [**LastNameValidationResponse**](LastNameValidationResponse.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
+