cloudmersive-validate-api-client 1.3.6 → 1.4.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -9
  3. data/cloudmersive-validate-api-client.gemspec +1 -1
  4. data/docs/AddressApi.md +166 -1
  5. data/docs/AddressGetServersResponse.md +2 -2
  6. data/docs/AddressVerifySyntaxOnlyResponse.md +3 -0
  7. data/docs/DomainApi.md +8 -8
  8. data/docs/EmailApi.md +3 -3
  9. data/docs/GetTimezonesRequest.md +8 -0
  10. data/docs/GetTimezonesResponse.md +13 -0
  11. data/docs/IPAddressApi.md +1 -1
  12. data/docs/LeadEnrichmentApi.md +61 -0
  13. data/docs/LeadEnrichmentRequest.md +21 -0
  14. data/docs/LeadEnrichmentResponse.md +25 -0
  15. data/docs/NameApi.md +59 -4
  16. data/docs/ParseAddressResponse.md +2 -1
  17. data/docs/PhoneNumberApi.md +1 -1
  18. data/docs/Timezone.md +10 -0
  19. data/docs/UserAgentApi.md +1 -1
  20. data/docs/ValidateAddressRequest.md +13 -0
  21. data/docs/ValidateAddressResponse.md +10 -0
  22. data/docs/ValidateCountryRequest.md +8 -0
  23. data/docs/ValidateCountryResponse.md +13 -0
  24. data/docs/ValidateIdentifierRequest.md +15 -0
  25. data/docs/ValidateIdentifierResponse.md +9 -0
  26. data/docs/ValidateUrlRequestFull.md +1 -1
  27. data/docs/ValidateUrlRequestSyntaxOnly.md +1 -1
  28. data/docs/VatApi.md +5 -5
  29. data/docs/VatLookupRequest.md +1 -1
  30. data/docs/VatLookupResponse.md +12 -5
  31. data/docs/WhoisResponse.md +11 -0
  32. data/lib/cloudmersive-validate-api-client.rb +13 -1
  33. data/lib/cloudmersive-validate-api-client/api/address_api.rb +167 -2
  34. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +9 -9
  35. data/lib/cloudmersive-validate-api-client/api/email_api.rb +4 -4
  36. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +2 -2
  37. data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +78 -0
  38. data/lib/cloudmersive-validate-api-client/api/name_api.rb +60 -5
  39. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +2 -2
  40. data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +2 -2
  41. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +6 -6
  42. data/lib/cloudmersive-validate-api-client/api_client.rb +1 -1
  43. data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
  44. data/lib/cloudmersive-validate-api-client/configuration.rb +1 -1
  45. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +3 -1
  46. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +35 -5
  47. data/lib/cloudmersive-validate-api-client/models/check_response.rb +1 -1
  48. data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +1 -1
  49. data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +1 -1
  50. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +1 -1
  51. data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +1 -1
  52. data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +1 -1
  53. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
  54. data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +1 -1
  55. data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +1 -1
  56. data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +189 -0
  57. data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +241 -0
  58. data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +1 -1
  59. data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +1 -1
  60. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +319 -0
  61. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +359 -0
  62. data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +1 -1
  63. data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +18 -8
  64. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +1 -1
  65. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +1 -1
  66. data/lib/cloudmersive-validate-api-client/models/timezone.rb +209 -0
  67. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +1 -1
  68. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +1 -1
  69. data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +239 -0
  70. data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +209 -0
  71. data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +189 -0
  72. data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +241 -0
  73. data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +259 -0
  74. data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +199 -0
  75. data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +2 -1
  76. data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +2 -1
  77. data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +1 -1
  78. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +1 -1
  79. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +2 -1
  80. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +80 -5
  81. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +112 -2
  82. data/lib/cloudmersive-validate-api-client/version.rb +2 -2
  83. data/spec/api/address_api_spec.rb +37 -1
  84. data/spec/api/domain_api_spec.rb +3 -3
  85. data/spec/api/email_api_spec.rb +1 -1
  86. data/spec/api/ip_address_api_spec.rb +1 -1
  87. data/spec/api/lead_enrichment_api_spec.rb +47 -0
  88. data/spec/api/name_api_spec.rb +13 -1
  89. data/spec/api/phone_number_api_spec.rb +1 -1
  90. data/spec/api/user_agent_api_spec.rb +1 -1
  91. data/spec/api/vat_api_spec.rb +3 -3
  92. data/spec/api_client_spec.rb +1 -1
  93. data/spec/configuration_spec.rb +1 -1
  94. data/spec/models/address_get_servers_response_spec.rb +1 -1
  95. data/spec/models/address_verify_syntax_only_response_spec.rb +19 -1
  96. data/spec/models/check_response_spec.rb +1 -1
  97. data/spec/models/first_name_validation_request_spec.rb +1 -1
  98. data/spec/models/first_name_validation_response_spec.rb +1 -1
  99. data/spec/models/full_email_validation_response_spec.rb +1 -1
  100. data/spec/models/full_name_validation_request_spec.rb +1 -1
  101. data/spec/models/full_name_validation_response_spec.rb +1 -1
  102. data/spec/models/geolocate_response_spec.rb +1 -1
  103. data/spec/models/get_gender_request_spec.rb +1 -1
  104. data/spec/models/get_gender_response_spec.rb +1 -1
  105. data/spec/models/get_timezones_request_spec.rb +42 -0
  106. data/spec/models/get_timezones_response_spec.rb +72 -0
  107. data/spec/models/last_name_validation_request_spec.rb +1 -1
  108. data/spec/models/last_name_validation_response_spec.rb +1 -1
  109. data/spec/models/lead_enrichment_request_spec.rb +120 -0
  110. data/spec/models/lead_enrichment_response_spec.rb +144 -0
  111. data/spec/models/parse_address_request_spec.rb +1 -1
  112. data/spec/models/parse_address_response_spec.rb +8 -2
  113. data/spec/models/phone_number_validate_request_spec.rb +1 -1
  114. data/spec/models/phone_number_validation_response_spec.rb +1 -1
  115. data/spec/models/timezone_spec.rb +54 -0
  116. data/spec/models/user_agent_validate_request_spec.rb +1 -1
  117. data/spec/models/user_agent_validate_response_spec.rb +1 -1
  118. data/spec/models/validate_address_request_spec.rb +72 -0
  119. data/spec/models/validate_address_response_spec.rb +54 -0
  120. data/spec/models/validate_country_request_spec.rb +42 -0
  121. data/spec/models/validate_country_response_spec.rb +72 -0
  122. data/spec/models/validate_identifier_request_spec.rb +84 -0
  123. data/spec/models/validate_identifier_response_spec.rb +48 -0
  124. data/spec/models/validate_url_request_full_spec.rb +1 -1
  125. data/spec/models/validate_url_request_syntax_only_spec.rb +1 -1
  126. data/spec/models/validate_url_response_full_spec.rb +1 -1
  127. data/spec/models/validate_url_response_syntax_only_spec.rb +1 -1
  128. data/spec/models/vat_lookup_request_spec.rb +1 -1
  129. data/spec/models/vat_lookup_response_spec.rb +43 -1
  130. data/spec/models/whois_response_spec.rb +67 -1
  131. data/spec/spec_helper.rb +1 -1
  132. metadata +51 -16
@@ -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
+
data/docs/NameApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
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
8
9
  [**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
9
10
  [**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
10
11
  [**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
@@ -59,7 +60,61 @@ Name | Type | Description | Notes
59
60
 
60
61
  ### HTTP request headers
61
62
 
62
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
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
63
118
  - **Accept**: application/json, text/json, application/xml, text/xml
64
119
 
65
120
 
@@ -113,7 +168,7 @@ Name | Type | Description | Notes
113
168
 
114
169
  ### HTTP request headers
115
170
 
116
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
171
+ - **Content-Type**: application/json, text/json
117
172
  - **Accept**: application/json, text/json, application/xml, text/xml
118
173
 
119
174
 
@@ -167,7 +222,7 @@ Name | Type | Description | Notes
167
222
 
168
223
  ### HTTP request headers
169
224
 
170
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
225
+ - **Content-Type**: application/json, text/json
171
226
  - **Accept**: application/json, text/json, application/xml, text/xml
172
227
 
173
228
 
@@ -221,7 +276,7 @@ Name | Type | Description | Notes
221
276
 
222
277
  ### HTTP request headers
223
278
 
224
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
279
+ - **Content-Type**: application/json, text/json
225
280
  - **Accept**: application/json, text/json, application/xml, text/xml
226
281
 
227
282
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **city** | **String** | The city of the address. | [optional]
11
11
  **state_or_province** | **String** | The state or province of the address. | [optional]
12
12
  **postal_code** | **String** | The postal code or zip code of the address. | [optional]
13
- **country** | **String** | Country of the address, if present in the address. If not included in the address it will be null. | [optional]
13
+ **country_full_name** | **String** | Country of the address, if present in the address. If not included in the address it will be null. | [optional]
14
+ **iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
14
15
 
15
16
 
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
 
57
57
  ### HTTP request headers
58
58
 
59
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
59
+ - **Content-Type**: application/json, text/json
60
60
  - **Accept**: application/json, text/json, application/xml, text/xml
61
61
 
62
62
 
data/docs/Timezone.md ADDED
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::Timezone
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the Time Zone | [optional]
7
+ **base_utc_offset** | **String** | UTC offset for this time zone | [optional]
8
+ **now** | **DateTime** | The current time (Now) in this time zone | [optional]
9
+
10
+
data/docs/UserAgentApi.md CHANGED
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
 
57
57
  ### HTTP request headers
58
58
 
59
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
59
+ - **Content-Type**: application/json, text/json
60
60
  - **Accept**: application/json, text/json, application/xml, text/xml
61
61
 
62
62
 
@@ -0,0 +1,13 @@
1
+ # CloudmersiveValidateApiClient::ValidateAddressRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **street_address** | **String** | Required; Street address to validate, such as '2950 Buskirk Ave.' | [optional]
7
+ **city** | **String** | Required; City part of the addrerss to validate, such as 'Walnut Creek' | [optional]
8
+ **state_or_province** | **String** | Required; State or province of the address to validate, such as 'CA' or 'California' | [optional]
9
+ **postal_code** | **String** | Optional (recommended); Zip code or postal code of the address to validate, such as '94597' | [optional]
10
+ **country_full_name** | **String** | Optional (recommended); Name of the country, such as 'United States'. If left blank, and CountryCode is also left blank, will default to United States. Global countries are supported. | [optional]
11
+ **country_code** | **String** | Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country. If left blank, and CountryFullName is also left blank, will default to United States. Global countries are supported. | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::ValidateAddressResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_address** | **BOOLEAN** | True if the address is valid, false otherwise | [optional]
7
+ **latitude** | **Float** | If the address is valid, the degrees latitude of the validated address, null otherwise | [optional]
8
+ **longitude** | **Float** | If the address is valid, the degrees longitude of the validated address, null otherwise | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::ValidateCountryRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **raw_country_input** | **String** | Raw country input - can be a two-letter code (FIPS 10-4 or ISO 3166-1), three-letter code (ISO 3166-1) or country name | [optional]
7
+
8
+
@@ -0,0 +1,13 @@
1
+ # CloudmersiveValidateApiClient::ValidateCountryResponse
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,15 @@
1
+ # CloudmersiveValidateApiClient::ValidateIdentifierRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input** | **String** | Text string identifier input | [optional]
7
+ **allow_whitespace** | **BOOLEAN** | True if whitespace is allowed in the identifier, false otherwise | [optional]
8
+ **allow_hyphens** | **BOOLEAN** | True if hyphens are allowd in the identifier, false otherwise | [optional]
9
+ **allow_underscore** | **BOOLEAN** | True if underscores are allowed in the identifier, false otherwise | [optional]
10
+ **allow_numbers** | **BOOLEAN** | True if numbers are allowed in the identifier, false otherwise | [optional]
11
+ **allow_periods** | **BOOLEAN** | True if periods are allowed in the identifier, false otherwise | [optional]
12
+ **max_length** | **Integer** | Optional; maximum length, if any, of the identifier | [optional]
13
+ **min_length** | **Integer** | Optional; minimum length, if any, of the identifier | [optional]
14
+
15
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::ValidateIdentifierResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_identifier** | **BOOLEAN** | True if the input identifier is valid, false otherwise | [optional]
7
+ **error** | **String** | Resulting error from the identifier validation; possible errors are: \"InputIsEmpty\", \"ContainsWhitespace\", \"ContainsNumbers\", \"ContainsHyphen\", \"ContainsUnderscore\", \"ContainsPeriod\", \"TooShort\", \"TooLong\", \"ContainsSpecialCharacters\" | [optional]
8
+
9
+
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **url** | **String** | | [optional]
6
+ **url** | **String** | URL to validate | [optional]
7
7
 
8
8
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **url** | **String** | | [optional]
6
+ **url** | **String** | URL to validate | [optional]
7
7
 
8
8
 
data/docs/VatApi.md CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**vat_vat_lookup**](VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Lookup a VAT code
7
+ [**vat_vat_lookup**](VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
8
8
 
9
9
 
10
10
  # **vat_vat_lookup**
11
11
  > VatLookupResponse vat_vat_lookup(input)
12
12
 
13
- Lookup a VAT code
13
+ Validate a VAT number
14
14
 
15
- Checks if a VAT code is valid, and if it is, returns more information about it
15
+ Checks if a VAT code is valid, and if it is, returns more information about it. The first two letters of the VAT number must be letters that indicate the country, such as LU20260743. Possible country codes include Austria (AT), Belgium (BE), Bulgaria (BG), Cyprus (CY), Czech Republic (CZ), Germany (DE), Denmark (DK), Estonia (EE), Greece (EL), Spain (ES), Finland (FI), France (FR), United Kingdom (GB), Croatia (HR), Hungary (HU), Ireland (IE), Italy (IT), Lithuania (LT), Luxembourg (LU), Latvia (LV), Malta (MT), The Netherlands (NL), Poland (PL), Portugal (PT), Romania (RO), Sweden (SE), Slovenia (SI), Slovakia (SK).
16
16
 
17
17
  ### Example
18
18
  ```ruby
@@ -32,7 +32,7 @@ input = CloudmersiveValidateApiClient::VatLookupRequest.new # VatLookupRequest |
32
32
 
33
33
 
34
34
  begin
35
- #Lookup a VAT code
35
+ #Validate a VAT number
36
36
  result = api_instance.vat_vat_lookup(input)
37
37
  p result
38
38
  rescue CloudmersiveValidateApiClient::ApiError => e
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
 
57
57
  ### HTTP request headers
58
58
 
59
- - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
59
+ - **Content-Type**: application/json, text/json
60
60
  - **Accept**: application/json, text/json, application/xml, text/xml
61
61
 
62
62
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **vat_code** | **String** | | [optional]
6
+ **vat_code** | **String** | VAT code to lookup; example \"CZ25123891\" | [optional]
7
7
 
8
8
 
@@ -3,10 +3,17 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **country_code** | **String** | | [optional]
7
- **vat_number** | **String** | | [optional]
8
- **is_valid** | **BOOLEAN** | | [optional]
9
- **business_name** | **String** | | [optional]
10
- **business_address** | **String** | | [optional]
6
+ **country_code** | **String** | Two-letter country code | [optional]
7
+ **vat_number** | **String** | VAT number | [optional]
8
+ **is_valid** | **BOOLEAN** | True if the VAT code is valid, false otherwise | [optional]
9
+ **business_name** | **String** | Name of the business | [optional]
10
+ **business_address** | **String** | Business address as a single string | [optional]
11
+ **business_building** | **String** | For the business address, the name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\". This will often by null. | [optional]
12
+ **business_street_number** | **String** | For the business address, the street number or house number of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"1600\". This value will typically be populated for most addresses. | [optional]
13
+ **business_street** | **String** | For the business address, the name of the street or road of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"Pennsylvania Avenue NW\". | [optional]
14
+ **business_city** | **String** | For the business address, the city of the address. | [optional]
15
+ **business_state_or_province** | **String** | For the business address, the state or province of the address. | [optional]
16
+ **business_postal_code** | **String** | For the business address, the postal code or zip code of the address. | [optional]
17
+ **business_country** | **String** | For the business address, country of the address, if present in the address. If not included in the address it will be null. | [optional]
11
18
 
12
19
 
@@ -4,6 +4,17 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **valid_domain** | **BOOLEAN** | True if the domain is valid, false if it is not | [optional]
7
+ **registrant_name** | **String** | Name of the domain registrant | [optional]
8
+ **registrant_organization** | **String** | Organization name of the domain registrant | [optional]
9
+ **registrant_email** | **String** | Email address of the domain registrant | [optional]
10
+ **registrant_street_number** | **String** | Street number of the address of the domain registrant, if available | [optional]
11
+ **registrant_street** | **String** | Street name of the address of the domain registrant, if available | [optional]
12
+ **registrant_city** | **String** | City of the domain registrant, if available | [optional]
13
+ **registrant_state_or_province** | **String** | State or Province of the address of the domain registrant, if available | [optional]
14
+ **registrant_postal_code** | **String** | Postal code of the address of the domain registrant, if available | [optional]
15
+ **registrant_country** | **String** | Country of the address of the domain registrant, if available | [optional]
16
+ **registrant_raw_address** | **String** | Raw address string of the domain registrant, if available | [optional]
17
+ **registrant_telephone** | **String** | Telephone number of the address of the domain registrant | [optional]
7
18
  **whois_server** | **String** | Server used to lookup WHOIS information (may change based on lookup). | [optional]
8
19
  **raw_text_record** | **String** | WHOIS raw text record | [optional]
9
20
  **created_dt** | **DateTime** | Creation date for the record | [optional]
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: v1
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
9
+ Swagger Codegen version: 2.3.1
10
10
 
11
11
  =end
12
12
 
@@ -28,14 +28,25 @@ require 'cloudmersive-validate-api-client/models/full_name_validation_response'
28
28
  require 'cloudmersive-validate-api-client/models/geolocate_response'
29
29
  require 'cloudmersive-validate-api-client/models/get_gender_request'
30
30
  require 'cloudmersive-validate-api-client/models/get_gender_response'
31
+ require 'cloudmersive-validate-api-client/models/get_timezones_request'
32
+ require 'cloudmersive-validate-api-client/models/get_timezones_response'
31
33
  require 'cloudmersive-validate-api-client/models/last_name_validation_request'
32
34
  require 'cloudmersive-validate-api-client/models/last_name_validation_response'
35
+ require 'cloudmersive-validate-api-client/models/lead_enrichment_request'
36
+ require 'cloudmersive-validate-api-client/models/lead_enrichment_response'
33
37
  require 'cloudmersive-validate-api-client/models/parse_address_request'
34
38
  require 'cloudmersive-validate-api-client/models/parse_address_response'
35
39
  require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
36
40
  require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
41
+ require 'cloudmersive-validate-api-client/models/timezone'
37
42
  require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
38
43
  require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
44
+ require 'cloudmersive-validate-api-client/models/validate_address_request'
45
+ require 'cloudmersive-validate-api-client/models/validate_address_response'
46
+ require 'cloudmersive-validate-api-client/models/validate_country_request'
47
+ require 'cloudmersive-validate-api-client/models/validate_country_response'
48
+ require 'cloudmersive-validate-api-client/models/validate_identifier_request'
49
+ require 'cloudmersive-validate-api-client/models/validate_identifier_response'
39
50
  require 'cloudmersive-validate-api-client/models/validate_url_request_full'
40
51
  require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
41
52
  require 'cloudmersive-validate-api-client/models/validate_url_response_full'
@@ -49,6 +60,7 @@ require 'cloudmersive-validate-api-client/api/address_api'
49
60
  require 'cloudmersive-validate-api-client/api/domain_api'
50
61
  require 'cloudmersive-validate-api-client/api/email_api'
51
62
  require 'cloudmersive-validate-api-client/api/ip_address_api'
63
+ require 'cloudmersive-validate-api-client/api/lead_enrichment_api'
52
64
  require 'cloudmersive-validate-api-client/api/name_api'
53
65
  require 'cloudmersive-validate-api-client/api/phone_number_api'
54
66
  require 'cloudmersive-validate-api-client/api/user_agent_api'