cloudmersive-validate-api-client 1.4.2 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +22 -7
  4. data/cloudmersive-validate-api-client.gemspec +3 -3
  5. data/docs/AddressApi.md +270 -1
  6. data/docs/CountryDetails.md +11 -0
  7. data/docs/CountryListResult.md +9 -0
  8. data/docs/DomainApi.md +2 -2
  9. data/docs/EmailApi.md +3 -3
  10. data/docs/IPAddressApi.md +56 -1
  11. data/docs/TorNodeResponse.md +8 -0
  12. data/docs/ValidateCityRequest.md +11 -0
  13. data/docs/ValidateCityResponse.md +12 -0
  14. data/docs/ValidateCountryResponse.md +1 -0
  15. data/docs/ValidatePostalCodeRequest.md +10 -0
  16. data/docs/ValidatePostalCodeResponse.md +12 -0
  17. data/docs/ValidateStateRequest.md +10 -0
  18. data/docs/ValidateStateResponse.md +11 -0
  19. data/lib/cloudmersive-validate-api-client.rb +10 -1
  20. data/lib/cloudmersive-validate-api-client/api/address_api.rb +276 -18
  21. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +14 -18
  22. data/lib/cloudmersive-validate-api-client/api/email_api.rb +11 -14
  23. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +58 -5
  24. data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +5 -8
  25. data/lib/cloudmersive-validate-api-client/api/name_api.rb +17 -22
  26. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +5 -6
  27. data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +5 -6
  28. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +5 -6
  29. data/lib/cloudmersive-validate-api-client/api_client.rb +11 -9
  30. data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
  31. data/lib/cloudmersive-validate-api-client/configuration.rb +2 -2
  32. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +7 -10
  33. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +7 -10
  34. data/lib/cloudmersive-validate-api-client/models/check_response.rb +7 -10
  35. data/lib/cloudmersive-validate-api-client/models/country_details.rb +216 -0
  36. data/lib/cloudmersive-validate-api-client/models/country_list_result.rb +198 -0
  37. data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +7 -10
  38. data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +7 -10
  39. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +7 -10
  40. data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +7 -10
  41. data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +7 -10
  42. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +7 -10
  43. data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +7 -10
  44. data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +7 -10
  45. data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +7 -10
  46. data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +7 -10
  47. data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +7 -10
  48. data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +7 -10
  49. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +7 -10
  50. data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +7 -10
  51. data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +7 -10
  52. data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +7 -10
  53. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +7 -10
  54. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +7 -10
  55. data/lib/cloudmersive-validate-api-client/models/timezone.rb +7 -10
  56. data/lib/cloudmersive-validate-api-client/models/tor_node_response.rb +186 -0
  57. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +7 -10
  58. data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +7 -10
  59. data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +7 -10
  60. data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +7 -10
  61. data/lib/cloudmersive-validate-api-client/models/validate_city_request.rb +216 -0
  62. data/lib/cloudmersive-validate-api-client/models/validate_city_response.rb +226 -0
  63. data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +7 -10
  64. data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +18 -11
  65. data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +7 -10
  66. data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +7 -10
  67. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_request.rb +206 -0
  68. data/lib/cloudmersive-validate-api-client/models/validate_postal_code_response.rb +226 -0
  69. data/lib/cloudmersive-validate-api-client/models/validate_state_request.rb +206 -0
  70. data/lib/cloudmersive-validate-api-client/models/validate_state_response.rb +216 -0
  71. data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +7 -10
  72. data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +7 -10
  73. data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +7 -10
  74. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +7 -10
  75. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +7 -10
  76. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +7 -11
  77. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +7 -10
  78. data/lib/cloudmersive-validate-api-client/version.rb +2 -2
  79. data/spec/api/address_api_spec.rb +65 -6
  80. data/spec/api/domain_api_spec.rb +5 -5
  81. data/spec/api/email_api_spec.rb +4 -4
  82. data/spec/api/ip_address_api_spec.rb +14 -2
  83. data/spec/api/lead_enrichment_api_spec.rb +2 -3
  84. data/spec/api/name_api_spec.rb +6 -6
  85. data/spec/api/phone_number_api_spec.rb +2 -2
  86. data/spec/api/user_agent_api_spec.rb +2 -2
  87. data/spec/api/vat_api_spec.rb +2 -2
  88. data/spec/api_client_spec.rb +52 -35
  89. data/spec/configuration_spec.rb +9 -9
  90. data/spec/models/address_get_servers_response_spec.rb +3 -4
  91. data/spec/models/address_verify_syntax_only_response_spec.rb +5 -6
  92. data/spec/models/check_response_spec.rb +2 -3
  93. data/spec/models/country_details_spec.rb +59 -0
  94. data/spec/models/country_list_result_spec.rb +47 -0
  95. data/spec/models/first_name_validation_request_spec.rb +2 -3
  96. data/spec/models/first_name_validation_response_spec.rb +3 -4
  97. data/spec/models/full_email_validation_response_spec.rb +10 -11
  98. data/spec/models/full_name_validation_request_spec.rb +2 -3
  99. data/spec/models/full_name_validation_response_spec.rb +11 -12
  100. data/spec/models/geolocate_response_spec.rb +10 -11
  101. data/spec/models/get_gender_request_spec.rb +3 -4
  102. data/spec/models/get_gender_response_spec.rb +3 -4
  103. data/spec/models/get_timezones_request_spec.rb +2 -3
  104. data/spec/models/get_timezones_response_spec.rb +7 -8
  105. data/spec/models/last_name_validation_request_spec.rb +2 -3
  106. data/spec/models/last_name_validation_response_spec.rb +3 -4
  107. data/spec/models/lead_enrichment_request_spec.rb +15 -16
  108. data/spec/models/lead_enrichment_response_spec.rb +19 -20
  109. data/spec/models/parse_address_request_spec.rb +3 -4
  110. data/spec/models/parse_address_response_spec.rb +10 -11
  111. data/spec/models/phone_number_validate_request_spec.rb +3 -4
  112. data/spec/models/phone_number_validation_response_spec.rb +9 -10
  113. data/spec/models/timezone_spec.rb +4 -5
  114. data/spec/models/tor_node_response_spec.rb +41 -0
  115. data/spec/models/user_agent_validate_request_spec.rb +2 -3
  116. data/spec/models/user_agent_validate_response_spec.rb +15 -16
  117. data/spec/models/validate_address_request_spec.rb +7 -8
  118. data/spec/models/validate_address_response_spec.rb +4 -5
  119. data/spec/models/validate_city_request_spec.rb +59 -0
  120. data/spec/models/validate_city_response_spec.rb +65 -0
  121. data/spec/models/validate_country_request_spec.rb +2 -3
  122. data/spec/models/validate_country_response_spec.rb +13 -8
  123. data/spec/models/validate_identifier_request_spec.rb +9 -10
  124. data/spec/models/validate_identifier_response_spec.rb +3 -4
  125. data/spec/models/validate_postal_code_request_spec.rb +53 -0
  126. data/spec/models/validate_postal_code_response_spec.rb +65 -0
  127. data/spec/models/validate_state_request_spec.rb +53 -0
  128. data/spec/models/validate_state_response_spec.rb +59 -0
  129. data/spec/models/validate_url_request_full_spec.rb +2 -3
  130. data/spec/models/validate_url_request_syntax_only_spec.rb +2 -3
  131. data/spec/models/validate_url_response_full_spec.rb +6 -7
  132. data/spec/models/validate_url_response_syntax_only_spec.rb +3 -4
  133. data/spec/models/vat_lookup_request_spec.rb +2 -3
  134. data/spec/models/vat_lookup_response_spec.rb +13 -14
  135. data/spec/models/whois_response_spec.rb +16 -17
  136. data/spec/spec_helper.rb +1 -1
  137. metadata +29 -2
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::CountryListResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **countries** | [**Array<CountryDetails>**](CountryDetails.md) | List of current ISO 3166-1 countries in the world | [optional]
8
+
9
+
@@ -31,7 +31,7 @@ end
31
31
 
32
32
  api_instance = CloudmersiveValidateApiClient::DomainApi.new
33
33
 
34
- domain = "domain_example" # String | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
34
+ domain = 'domain_example' # String | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
35
35
 
36
36
 
37
37
  begin
@@ -85,7 +85,7 @@ end
85
85
 
86
86
  api_instance = CloudmersiveValidateApiClient::DomainApi.new
87
87
 
88
- domain = "domain_example" # String | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
88
+ domain = 'domain_example' # String | Domain name to check, for example \"cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
89
89
 
90
90
 
91
91
  begin
@@ -30,7 +30,7 @@ end
30
30
 
31
31
  api_instance = CloudmersiveValidateApiClient::EmailApi.new
32
32
 
33
- email = "email_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
33
+ email = 'email_example' # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
34
34
 
35
35
 
36
36
  begin
@@ -84,7 +84,7 @@ end
84
84
 
85
85
  api_instance = CloudmersiveValidateApiClient::EmailApi.new
86
86
 
87
- email = "email_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
87
+ email = 'email_example' # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
88
88
 
89
89
 
90
90
  begin
@@ -138,7 +138,7 @@ end
138
138
 
139
139
  api_instance = CloudmersiveValidateApiClient::EmailApi.new
140
140
 
141
- value = "value_example" # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
141
+ value = 'value_example' # String | Email address to validate, e.g. \"support@cloudmersive.com\". The input is a string so be sure to enclose it in double-quotes.
142
142
 
143
143
 
144
144
  begin
@@ -4,9 +4,64 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
7
8
  [**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
8
9
 
9
10
 
11
+ # **i_p_address_is_tor_node**
12
+ > TorNodeResponse i_p_address_is_tor_node(value)
13
+
14
+ Check if IP address is a Tor node server
15
+
16
+ Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'cloudmersive-validate-api-client'
22
+ # setup authorization
23
+ CloudmersiveValidateApiClient.configure do |config|
24
+ # Configure API key authorization: Apikey
25
+ config.api_key['Apikey'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['Apikey'] = 'Bearer'
28
+ end
29
+
30
+ api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
31
+
32
+ value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
33
+
34
+
35
+ begin
36
+ #Check if IP address is a Tor node server
37
+ result = api_instance.i_p_address_is_tor_node(value)
38
+ p result
39
+ rescue CloudmersiveValidateApiClient::ApiError => e
40
+ puts "Exception when calling IPAddressApi->i_p_address_is_tor_node: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+ Name | Type | Description | Notes
47
+ ------------- | ------------- | ------------- | -------------
48
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
49
+
50
+ ### Return type
51
+
52
+ [**TorNodeResponse**](TorNodeResponse.md)
53
+
54
+ ### Authorization
55
+
56
+ [Apikey](../README.md#Apikey)
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: text/javascript, application/json, text/json
61
+ - **Accept**: application/json, text/json, application/xml, text/xml
62
+
63
+
64
+
10
65
  # **i_p_address_post**
11
66
  > GeolocateResponse i_p_address_post(value)
12
67
 
@@ -28,7 +83,7 @@ end
28
83
 
29
84
  api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
30
85
 
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.
86
+ 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
87
 
33
88
 
34
89
  begin
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::TorNodeResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **is_tor_node** | **BOOLEAN** | True if the input IP address is a Tor exit node, false otherwise | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveValidateApiClient::ValidateCityRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **city** | **String** | Required: City of the address to validate, such as 'San Francisco' or 'London' | [optional]
7
+ **state_or_province** | **String** | Required: State or province of the address to validate, such as 'California' or 'CA' | [optional]
8
+ **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]
9
+ **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]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveValidateApiClient::ValidateCityResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_city** | **BOOLEAN** | True if the city is valid, false otherwise | [optional]
7
+ **city** | **String** | If valid, City corresponding to the input postal code, such as 'Walnut Creek' | [optional]
8
+ **state_or_province** | **String** | If valid; State or province corresponding to the input state name, such as 'CA' or 'California' | [optional]
9
+ **latitude** | **Float** | If the postal code is valid, the degrees latitude of the centroid of the state, null otherwise | [optional]
10
+ **longitude** | **Float** | If the postal code is valid, the degrees longitude of the centroid of the state, null otherwise | [optional]
11
+
12
+
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
9
9
  **fips_two_letter_code** | **String** | Two-letter FIPS 10-4 country code | [optional]
10
10
  **three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
11
+ **is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional]
11
12
  **timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional]
12
13
 
13
14
 
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::ValidatePostalCodeRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **postal_code** | **String** | Required: Zip code or postal code of the address to validate, such as '94597' | [optional]
7
+ **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]
8
+ **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]
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveValidateApiClient::ValidatePostalCodeResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_postal_code** | **BOOLEAN** | True if the Postal Code is valid, false otherwise | [optional]
7
+ **city** | **String** | If valid, City corresponding to the input postal code, such as 'Walnut Creek' | [optional]
8
+ **state_or_province** | **String** | If valid; State or province corresponding to the input postal code, such as 'CA' or 'California' | [optional]
9
+ **latitude** | **Float** | If the postal code is valid, the degrees latitude of the centroid of the postal code, null otherwise | [optional]
10
+ **longitude** | **Float** | If the postal code is valid, the degrees longitude of the centroid of the postal code, null otherwise | [optional]
11
+
12
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::ValidateStateRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **state_or_province** | **String** | Required: State or province of the address to validate, such as 'California' or 'CA' | [optional]
7
+ **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]
8
+ **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]
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveValidateApiClient::ValidateStateResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **valid_state** | **BOOLEAN** | True if the address is valid, false otherwise | [optional]
7
+ **state_or_province** | **String** | If valid; State or province corresponding to the input state name, such as 'CA' or 'California' | [optional]
8
+ **latitude** | **Float** | If the postal code is valid, the degrees latitude of the centroid of the state, null otherwise | [optional]
9
+ **longitude** | **Float** | If the postal code is valid, the degrees longitude of the centroid of the state, null otherwise | [optional]
10
+
11
+
@@ -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: 2.3.1
9
+ Swagger Codegen version: 2.4.14
10
10
 
11
11
  =end
12
12
 
@@ -20,6 +20,8 @@ require 'cloudmersive-validate-api-client/configuration'
20
20
  require 'cloudmersive-validate-api-client/models/address_get_servers_response'
21
21
  require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_response'
22
22
  require 'cloudmersive-validate-api-client/models/check_response'
23
+ require 'cloudmersive-validate-api-client/models/country_details'
24
+ require 'cloudmersive-validate-api-client/models/country_list_result'
23
25
  require 'cloudmersive-validate-api-client/models/first_name_validation_request'
24
26
  require 'cloudmersive-validate-api-client/models/first_name_validation_response'
25
27
  require 'cloudmersive-validate-api-client/models/full_email_validation_response'
@@ -39,14 +41,21 @@ require 'cloudmersive-validate-api-client/models/parse_address_response'
39
41
  require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
40
42
  require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
41
43
  require 'cloudmersive-validate-api-client/models/timezone'
44
+ require 'cloudmersive-validate-api-client/models/tor_node_response'
42
45
  require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
43
46
  require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
44
47
  require 'cloudmersive-validate-api-client/models/validate_address_request'
45
48
  require 'cloudmersive-validate-api-client/models/validate_address_response'
49
+ require 'cloudmersive-validate-api-client/models/validate_city_request'
50
+ require 'cloudmersive-validate-api-client/models/validate_city_response'
46
51
  require 'cloudmersive-validate-api-client/models/validate_country_request'
47
52
  require 'cloudmersive-validate-api-client/models/validate_country_response'
48
53
  require 'cloudmersive-validate-api-client/models/validate_identifier_request'
49
54
  require 'cloudmersive-validate-api-client/models/validate_identifier_response'
55
+ require 'cloudmersive-validate-api-client/models/validate_postal_code_request'
56
+ require 'cloudmersive-validate-api-client/models/validate_postal_code_response'
57
+ require 'cloudmersive-validate-api-client/models/validate_state_request'
58
+ require 'cloudmersive-validate-api-client/models/validate_state_response'
50
59
  require 'cloudmersive-validate-api-client/models/validate_url_request_full'
51
60
  require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
52
61
  require 'cloudmersive-validate-api-client/models/validate_url_response_full'
@@ -6,11 +6,11 @@
6
6
  OpenAPI spec version: v1
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
9
+ Swagger Codegen version: 2.4.14
10
10
 
11
11
  =end
12
12
 
13
- require "uri"
13
+ require 'uri'
14
14
 
15
15
  module CloudmersiveValidateApiClient
16
16
  class AddressApi
@@ -19,32 +19,85 @@ module CloudmersiveValidateApiClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Check if a country is a member of the European Union (EU)
23
+ # Checks if the input country is a member of the European Union or not.
24
+ # @param input Input request
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [ValidateCountryResponse]
27
+ def address_check_eu_membership(input, opts = {})
28
+ data, _status_code, _headers = address_check_eu_membership_with_http_info(input, opts)
29
+ data
30
+ end
31
+
32
+ # Check if a country is a member of the European Union (EU)
33
+ # Checks if the input country is a member of the European Union or not.
34
+ # @param input Input request
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(ValidateCountryResponse, Fixnum, Hash)>] ValidateCountryResponse data, response status code and response headers
37
+ def address_check_eu_membership_with_http_info(input, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_check_eu_membership ...'
40
+ end
41
+ # verify the required parameter 'input' is set
42
+ if @api_client.config.client_side_validation && input.nil?
43
+ fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_check_eu_membership"
44
+ end
45
+ # resource path
46
+ local_var_path = '/validate/address/country/check-eu-membership'
47
+
48
+ # query parameters
49
+ query_params = {}
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
22
57
 
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = @api_client.object_to_http_body(input)
63
+ auth_names = ['Apikey']
64
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
65
+ :header_params => header_params,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body,
69
+ :auth_names => auth_names,
70
+ :return_type => 'ValidateCountryResponse')
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: AddressApi#address_check_eu_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
23
76
  # Validate and normalize country information, return ISO 3166-1 country codes and country name
24
- # Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
77
+ # 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.
25
78
  # @param input Input request
26
79
  # @param [Hash] opts the optional parameters
27
80
  # @return [ValidateCountryResponse]
28
81
  def address_country(input, opts = {})
29
82
  data, _status_code, _headers = address_country_with_http_info(input, opts)
30
- return data
83
+ data
31
84
  end
32
85
 
33
86
  # Validate and normalize country information, return ISO 3166-1 country codes and country name
34
- # Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
87
+ # 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.
35
88
  # @param input Input request
36
89
  # @param [Hash] opts the optional parameters
37
90
  # @return [Array<(ValidateCountryResponse, Fixnum, Hash)>] ValidateCountryResponse data, response status code and response headers
38
91
  def address_country_with_http_info(input, opts = {})
39
92
  if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: AddressApi.address_country ..."
93
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_country ...'
41
94
  end
42
95
  # verify the required parameter 'input' is set
43
96
  if @api_client.config.client_side_validation && input.nil?
44
97
  fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_country"
45
98
  end
46
99
  # resource path
47
- local_var_path = "/validate/address/country"
100
+ local_var_path = '/validate/address/country'
48
101
 
49
102
  # query parameters
50
103
  query_params = {}
@@ -74,7 +127,52 @@ module CloudmersiveValidateApiClient
74
127
  end
75
128
  return data, status_code, headers
76
129
  end
130
+ # Get a list of ISO 3166-1 countries
131
+ # Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
132
+ # @param [Hash] opts the optional parameters
133
+ # @return [CountryListResult]
134
+ def address_country_list(opts = {})
135
+ data, _status_code, _headers = address_country_list_with_http_info(opts)
136
+ data
137
+ end
138
+
139
+ # Get a list of ISO 3166-1 countries
140
+ # Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
141
+ # @param [Hash] opts the optional parameters
142
+ # @return [Array<(CountryListResult, Fixnum, Hash)>] CountryListResult data, response status code and response headers
143
+ def address_country_list_with_http_info(opts = {})
144
+ if @api_client.config.debugging
145
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_country_list ...'
146
+ end
147
+ # resource path
148
+ local_var_path = '/validate/address/country/list'
77
149
 
150
+ # query parameters
151
+ query_params = {}
152
+
153
+ # header parameters
154
+ header_params = {}
155
+ # HTTP header 'Accept' (if needed)
156
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
157
+
158
+ # form parameters
159
+ form_params = {}
160
+
161
+ # http body (model)
162
+ post_body = nil
163
+ auth_names = ['Apikey']
164
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
165
+ :header_params => header_params,
166
+ :query_params => query_params,
167
+ :form_params => form_params,
168
+ :body => post_body,
169
+ :auth_names => auth_names,
170
+ :return_type => 'CountryListResult')
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug "API called: AddressApi#address_country_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
173
+ end
174
+ return data, status_code, headers
175
+ end
78
176
  # Gets IANA/Olsen time zones for a country
79
177
  # Gets the IANA/Olsen time zones for a country.
80
178
  # @param input Input request
@@ -82,7 +180,7 @@ module CloudmersiveValidateApiClient
82
180
  # @return [GetTimezonesResponse]
83
181
  def address_get_timezone(input, opts = {})
84
182
  data, _status_code, _headers = address_get_timezone_with_http_info(input, opts)
85
- return data
183
+ data
86
184
  end
87
185
 
88
186
  # Gets IANA/Olsen time zones for a country
@@ -92,14 +190,14 @@ module CloudmersiveValidateApiClient
92
190
  # @return [Array<(GetTimezonesResponse, Fixnum, Hash)>] GetTimezonesResponse data, response status code and response headers
93
191
  def address_get_timezone_with_http_info(input, opts = {})
94
192
  if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: AddressApi.address_get_timezone ..."
193
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_get_timezone ...'
96
194
  end
97
195
  # verify the required parameter 'input' is set
98
196
  if @api_client.config.client_side_validation && input.nil?
99
197
  fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_get_timezone"
100
198
  end
101
199
  # resource path
102
- local_var_path = "/validate/address/country/get-timezones"
200
+ local_var_path = '/validate/address/country/get-timezones'
103
201
 
104
202
  # query parameters
105
203
  query_params = {}
@@ -129,7 +227,6 @@ module CloudmersiveValidateApiClient
129
227
  end
130
228
  return data, status_code, headers
131
229
  end
132
-
133
230
  # Parse an unstructured input text string into an international, formatted address
134
231
  # 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.
135
232
  # @param input Input parse request
@@ -137,7 +234,7 @@ module CloudmersiveValidateApiClient
137
234
  # @return [ParseAddressResponse]
138
235
  def address_parse_string(input, opts = {})
139
236
  data, _status_code, _headers = address_parse_string_with_http_info(input, opts)
140
- return data
237
+ data
141
238
  end
142
239
 
143
240
  # Parse an unstructured input text string into an international, formatted address
@@ -147,14 +244,14 @@ module CloudmersiveValidateApiClient
147
244
  # @return [Array<(ParseAddressResponse, Fixnum, Hash)>] ParseAddressResponse data, response status code and response headers
148
245
  def address_parse_string_with_http_info(input, opts = {})
149
246
  if @api_client.config.debugging
150
- @api_client.config.logger.debug "Calling API: AddressApi.address_parse_string ..."
247
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_parse_string ...'
151
248
  end
152
249
  # verify the required parameter 'input' is set
153
250
  if @api_client.config.client_side_validation && input.nil?
154
251
  fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_parse_string"
155
252
  end
156
253
  # resource path
157
- local_var_path = "/validate/address/parse"
254
+ local_var_path = '/validate/address/parse'
158
255
 
159
256
  # query parameters
160
257
  query_params = {}
@@ -184,7 +281,6 @@ module CloudmersiveValidateApiClient
184
281
  end
185
282
  return data, status_code, headers
186
283
  end
187
-
188
284
  # Validate a street address
189
285
  # 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.
190
286
  # @param input Input parse request
@@ -192,7 +288,7 @@ module CloudmersiveValidateApiClient
192
288
  # @return [ValidateAddressResponse]
193
289
  def address_validate_address(input, opts = {})
194
290
  data, _status_code, _headers = address_validate_address_with_http_info(input, opts)
195
- return data
291
+ data
196
292
  end
197
293
 
198
294
  # Validate a street address
@@ -202,14 +298,14 @@ module CloudmersiveValidateApiClient
202
298
  # @return [Array<(ValidateAddressResponse, Fixnum, Hash)>] ValidateAddressResponse data, response status code and response headers
203
299
  def address_validate_address_with_http_info(input, opts = {})
204
300
  if @api_client.config.debugging
205
- @api_client.config.logger.debug "Calling API: AddressApi.address_validate_address ..."
301
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_address ...'
206
302
  end
207
303
  # verify the required parameter 'input' is set
208
304
  if @api_client.config.client_side_validation && input.nil?
209
305
  fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_validate_address"
210
306
  end
211
307
  # resource path
212
- local_var_path = "/validate/address/street-address"
308
+ local_var_path = '/validate/address/street-address'
213
309
 
214
310
  # query parameters
215
311
  query_params = {}
@@ -239,5 +335,167 @@ module CloudmersiveValidateApiClient
239
335
  end
240
336
  return data, status_code, headers
241
337
  end
338
+ # Validate a City and State/Province combination, get location information about it
339
+ # 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.
340
+ # @param input Input parse request
341
+ # @param [Hash] opts the optional parameters
342
+ # @return [ValidateCityResponse]
343
+ def address_validate_city(input, opts = {})
344
+ data, _status_code, _headers = address_validate_city_with_http_info(input, opts)
345
+ data
346
+ end
347
+
348
+ # Validate a City and State/Province combination, get location information about it
349
+ # 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.
350
+ # @param input Input parse request
351
+ # @param [Hash] opts the optional parameters
352
+ # @return [Array<(ValidateCityResponse, Fixnum, Hash)>] ValidateCityResponse data, response status code and response headers
353
+ def address_validate_city_with_http_info(input, opts = {})
354
+ if @api_client.config.debugging
355
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_city ...'
356
+ end
357
+ # verify the required parameter 'input' is set
358
+ if @api_client.config.client_side_validation && input.nil?
359
+ fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_validate_city"
360
+ end
361
+ # resource path
362
+ local_var_path = '/validate/address/city'
363
+
364
+ # query parameters
365
+ query_params = {}
366
+
367
+ # header parameters
368
+ header_params = {}
369
+ # HTTP header 'Accept' (if needed)
370
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
371
+ # HTTP header 'Content-Type'
372
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
373
+
374
+ # form parameters
375
+ form_params = {}
376
+
377
+ # http body (model)
378
+ post_body = @api_client.object_to_http_body(input)
379
+ auth_names = ['Apikey']
380
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names,
386
+ :return_type => 'ValidateCityResponse')
387
+ if @api_client.config.debugging
388
+ @api_client.config.logger.debug "API called: AddressApi#address_validate_city\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
389
+ end
390
+ return data, status_code, headers
391
+ end
392
+ # Validate a postal code, get location information about it
393
+ # Checks if the input postal code is valid, and returns information about it such as City, State and more.
394
+ # @param input Input parse request
395
+ # @param [Hash] opts the optional parameters
396
+ # @return [ValidatePostalCodeResponse]
397
+ def address_validate_postal_code(input, opts = {})
398
+ data, _status_code, _headers = address_validate_postal_code_with_http_info(input, opts)
399
+ data
400
+ end
401
+
402
+ # Validate a postal code, get location information about it
403
+ # Checks if the input postal code is valid, and returns information about it such as City, State and more.
404
+ # @param input Input parse request
405
+ # @param [Hash] opts the optional parameters
406
+ # @return [Array<(ValidatePostalCodeResponse, Fixnum, Hash)>] ValidatePostalCodeResponse data, response status code and response headers
407
+ def address_validate_postal_code_with_http_info(input, opts = {})
408
+ if @api_client.config.debugging
409
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_postal_code ...'
410
+ end
411
+ # verify the required parameter 'input' is set
412
+ if @api_client.config.client_side_validation && input.nil?
413
+ fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_validate_postal_code"
414
+ end
415
+ # resource path
416
+ local_var_path = '/validate/address/postal-code'
417
+
418
+ # query parameters
419
+ query_params = {}
420
+
421
+ # header parameters
422
+ header_params = {}
423
+ # HTTP header 'Accept' (if needed)
424
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
425
+ # HTTP header 'Content-Type'
426
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
427
+
428
+ # form parameters
429
+ form_params = {}
430
+
431
+ # http body (model)
432
+ post_body = @api_client.object_to_http_body(input)
433
+ auth_names = ['Apikey']
434
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
435
+ :header_params => header_params,
436
+ :query_params => query_params,
437
+ :form_params => form_params,
438
+ :body => post_body,
439
+ :auth_names => auth_names,
440
+ :return_type => 'ValidatePostalCodeResponse')
441
+ if @api_client.config.debugging
442
+ @api_client.config.logger.debug "API called: AddressApi#address_validate_postal_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
443
+ end
444
+ return data, status_code, headers
445
+ end
446
+ # Validate a state or province, name or abbreviation, get location information about it
447
+ # Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.
448
+ # @param input Input parse request
449
+ # @param [Hash] opts the optional parameters
450
+ # @return [ValidateStateResponse]
451
+ def address_validate_state(input, opts = {})
452
+ data, _status_code, _headers = address_validate_state_with_http_info(input, opts)
453
+ data
454
+ end
455
+
456
+ # Validate a state or province, name or abbreviation, get location information about it
457
+ # Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.
458
+ # @param input Input parse request
459
+ # @param [Hash] opts the optional parameters
460
+ # @return [Array<(ValidateStateResponse, Fixnum, Hash)>] ValidateStateResponse data, response status code and response headers
461
+ def address_validate_state_with_http_info(input, opts = {})
462
+ if @api_client.config.debugging
463
+ @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_state ...'
464
+ end
465
+ # verify the required parameter 'input' is set
466
+ if @api_client.config.client_side_validation && input.nil?
467
+ fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_validate_state"
468
+ end
469
+ # resource path
470
+ local_var_path = '/validate/address/state'
471
+
472
+ # query parameters
473
+ query_params = {}
474
+
475
+ # header parameters
476
+ header_params = {}
477
+ # HTTP header 'Accept' (if needed)
478
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
479
+ # HTTP header 'Content-Type'
480
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
481
+
482
+ # form parameters
483
+ form_params = {}
484
+
485
+ # http body (model)
486
+ post_body = @api_client.object_to_http_body(input)
487
+ auth_names = ['Apikey']
488
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
489
+ :header_params => header_params,
490
+ :query_params => query_params,
491
+ :form_params => form_params,
492
+ :body => post_body,
493
+ :auth_names => auth_names,
494
+ :return_type => 'ValidateStateResponse')
495
+ if @api_client.config.debugging
496
+ @api_client.config.logger.debug "API called: AddressApi#address_validate_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
497
+ end
498
+ return data, status_code, headers
499
+ end
242
500
  end
243
501
  end