cloudmersive-validate-api-client 1.4.1 → 2.0.4
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.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +24 -8
- data/cloudmersive-validate-api-client.gemspec +3 -3
- data/docs/AddressApi.md +325 -1
- data/docs/CountryDetails.md +11 -0
- data/docs/CountryListResult.md +9 -0
- data/docs/DomainApi.md +2 -2
- data/docs/EmailApi.md +3 -3
- data/docs/IPAddressApi.md +1 -1
- data/docs/ValidateAddressRequest.md +13 -0
- data/docs/ValidateAddressResponse.md +10 -0
- data/docs/ValidateCityRequest.md +11 -0
- data/docs/ValidateCityResponse.md +12 -0
- data/docs/ValidateCountryResponse.md +1 -0
- data/docs/ValidatePostalCodeRequest.md +10 -0
- data/docs/ValidatePostalCodeResponse.md +12 -0
- data/docs/ValidateStateRequest.md +10 -0
- data/docs/ValidateStateResponse.md +11 -0
- data/docs/VatApi.md +4 -4
- data/lib/cloudmersive-validate-api-client.rb +11 -1
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +327 -14
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +14 -18
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +11 -14
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +5 -8
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +17 -22
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +5 -6
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +9 -10
- data/lib/cloudmersive-validate-api-client/api_client.rb +11 -9
- data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-validate-api-client/configuration.rb +2 -2
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/country_details.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/country_list_result.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/timezone.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_address_request.rb +236 -0
- data/lib/cloudmersive-validate-api-client/models/validate_address_response.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_city_request.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/validate_city_response.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +18 -11
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_postal_code_request.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_postal_code_response.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_state_request.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/validate_state_response.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +7 -10
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +7 -11
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +7 -10
- data/lib/cloudmersive-validate-api-client/version.rb +2 -2
- data/spec/api/address_api_spec.rb +76 -5
- data/spec/api/domain_api_spec.rb +5 -5
- data/spec/api/email_api_spec.rb +4 -4
- data/spec/api/ip_address_api_spec.rb +2 -2
- data/spec/api/lead_enrichment_api_spec.rb +2 -3
- data/spec/api/name_api_spec.rb +6 -6
- data/spec/api/phone_number_api_spec.rb +2 -2
- data/spec/api/user_agent_api_spec.rb +2 -2
- data/spec/api/vat_api_spec.rb +4 -4
- data/spec/api_client_spec.rb +52 -35
- data/spec/configuration_spec.rb +9 -9
- data/spec/models/address_get_servers_response_spec.rb +3 -4
- data/spec/models/address_verify_syntax_only_response_spec.rb +5 -6
- data/spec/models/check_response_spec.rb +2 -3
- data/spec/models/country_details_spec.rb +59 -0
- data/spec/models/country_list_result_spec.rb +47 -0
- data/spec/models/first_name_validation_request_spec.rb +2 -3
- data/spec/models/first_name_validation_response_spec.rb +3 -4
- data/spec/models/full_email_validation_response_spec.rb +10 -11
- data/spec/models/full_name_validation_request_spec.rb +2 -3
- data/spec/models/full_name_validation_response_spec.rb +11 -12
- data/spec/models/geolocate_response_spec.rb +10 -11
- data/spec/models/get_gender_request_spec.rb +3 -4
- data/spec/models/get_gender_response_spec.rb +3 -4
- data/spec/models/get_timezones_request_spec.rb +2 -3
- data/spec/models/get_timezones_response_spec.rb +7 -8
- data/spec/models/last_name_validation_request_spec.rb +2 -3
- data/spec/models/last_name_validation_response_spec.rb +3 -4
- data/spec/models/lead_enrichment_request_spec.rb +15 -16
- data/spec/models/lead_enrichment_response_spec.rb +19 -20
- data/spec/models/parse_address_request_spec.rb +3 -4
- data/spec/models/parse_address_response_spec.rb +10 -11
- data/spec/models/phone_number_validate_request_spec.rb +3 -4
- data/spec/models/phone_number_validation_response_spec.rb +9 -10
- data/spec/models/timezone_spec.rb +4 -5
- data/spec/models/user_agent_validate_request_spec.rb +2 -3
- data/spec/models/user_agent_validate_response_spec.rb +15 -16
- data/spec/models/validate_address_request_spec.rb +71 -0
- data/spec/models/validate_address_response_spec.rb +53 -0
- data/spec/models/validate_city_request_spec.rb +59 -0
- data/spec/models/validate_city_response_spec.rb +65 -0
- data/spec/models/validate_country_request_spec.rb +2 -3
- data/spec/models/validate_country_response_spec.rb +13 -8
- data/spec/models/validate_identifier_request_spec.rb +9 -10
- data/spec/models/validate_identifier_response_spec.rb +3 -4
- data/spec/models/validate_postal_code_request_spec.rb +53 -0
- data/spec/models/validate_postal_code_response_spec.rb +65 -0
- data/spec/models/validate_state_request_spec.rb +53 -0
- data/spec/models/validate_state_response_spec.rb +59 -0
- data/spec/models/validate_url_request_full_spec.rb +2 -3
- data/spec/models/validate_url_request_syntax_only_spec.rb +2 -3
- data/spec/models/validate_url_response_full_spec.rb +6 -7
- data/spec/models/validate_url_response_syntax_only_spec.rb +3 -4
- data/spec/models/vat_lookup_request_spec.rb +2 -3
- data/spec/models/vat_lookup_response_spec.rb +13 -14
- data/spec/models/whois_response_spec.rb +16 -17
- data/spec/spec_helper.rb +1 -1
- metadata +32 -2
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::CountryDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**country_name** | **String** | Name of the country | [optional]
|
|
7
|
+
**three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
|
|
8
|
+
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
|
9
|
+
**is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -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
|
+
|
data/docs/DomainApi.md
CHANGED
|
@@ -31,7 +31,7 @@ end
|
|
|
31
31
|
|
|
32
32
|
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
33
33
|
|
|
34
|
-
domain =
|
|
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 =
|
|
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
|
data/docs/EmailApi.md
CHANGED
|
@@ -30,7 +30,7 @@ end
|
|
|
30
30
|
|
|
31
31
|
api_instance = CloudmersiveValidateApiClient::EmailApi.new
|
|
32
32
|
|
|
33
|
-
email =
|
|
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 =
|
|
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 =
|
|
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
|
data/docs/IPAddressApi.md
CHANGED
|
@@ -28,7 +28,7 @@ end
|
|
|
28
28
|
|
|
29
29
|
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
|
30
30
|
|
|
31
|
-
value =
|
|
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
32
|
|
|
33
33
|
|
|
34
34
|
begin
|
|
@@ -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,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
|
+
|
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 |
|
|
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
|
-
|
|
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
|
-
#
|
|
35
|
+
#Validate a VAT number
|
|
36
36
|
result = api_instance.vat_vat_lookup(input)
|
|
37
37
|
p result
|
|
38
38
|
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
@@ -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.
|
|
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'
|
|
@@ -41,10 +43,18 @@ require 'cloudmersive-validate-api-client/models/phone_number_validation_respons
|
|
|
41
43
|
require 'cloudmersive-validate-api-client/models/timezone'
|
|
42
44
|
require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
|
|
43
45
|
require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
|
|
46
|
+
require 'cloudmersive-validate-api-client/models/validate_address_request'
|
|
47
|
+
require 'cloudmersive-validate-api-client/models/validate_address_response'
|
|
48
|
+
require 'cloudmersive-validate-api-client/models/validate_city_request'
|
|
49
|
+
require 'cloudmersive-validate-api-client/models/validate_city_response'
|
|
44
50
|
require 'cloudmersive-validate-api-client/models/validate_country_request'
|
|
45
51
|
require 'cloudmersive-validate-api-client/models/validate_country_response'
|
|
46
52
|
require 'cloudmersive-validate-api-client/models/validate_identifier_request'
|
|
47
53
|
require 'cloudmersive-validate-api-client/models/validate_identifier_response'
|
|
54
|
+
require 'cloudmersive-validate-api-client/models/validate_postal_code_request'
|
|
55
|
+
require 'cloudmersive-validate-api-client/models/validate_postal_code_response'
|
|
56
|
+
require 'cloudmersive-validate-api-client/models/validate_state_request'
|
|
57
|
+
require 'cloudmersive-validate-api-client/models/validate_state_response'
|
|
48
58
|
require 'cloudmersive-validate-api-client/models/validate_url_request_full'
|
|
49
59
|
require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
|
|
50
60
|
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.
|
|
9
|
+
Swagger Codegen version: 2.4.14
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
|
-
require
|
|
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
|
|
22
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'])
|
|
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
|
-
|
|
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
|
|
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 =
|
|
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'
|
|
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 = {}
|
|
77
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
|
-
|
|
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
|
|
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 =
|
|
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
|
-
|
|
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
|
|
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 =
|
|
254
|
+
local_var_path = '/validate/address/parse'
|
|
158
255
|
|
|
159
256
|
# query parameters
|
|
160
257
|
query_params = {}
|
|
@@ -184,5 +281,221 @@ module CloudmersiveValidateApiClient
|
|
|
184
281
|
end
|
|
185
282
|
return data, status_code, headers
|
|
186
283
|
end
|
|
284
|
+
# Validate a street address
|
|
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.
|
|
286
|
+
# @param input Input parse request
|
|
287
|
+
# @param [Hash] opts the optional parameters
|
|
288
|
+
# @return [ValidateAddressResponse]
|
|
289
|
+
def address_validate_address(input, opts = {})
|
|
290
|
+
data, _status_code, _headers = address_validate_address_with_http_info(input, opts)
|
|
291
|
+
data
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Validate a street address
|
|
295
|
+
# 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.
|
|
296
|
+
# @param input Input parse request
|
|
297
|
+
# @param [Hash] opts the optional parameters
|
|
298
|
+
# @return [Array<(ValidateAddressResponse, Fixnum, Hash)>] ValidateAddressResponse data, response status code and response headers
|
|
299
|
+
def address_validate_address_with_http_info(input, opts = {})
|
|
300
|
+
if @api_client.config.debugging
|
|
301
|
+
@api_client.config.logger.debug 'Calling API: AddressApi.address_validate_address ...'
|
|
302
|
+
end
|
|
303
|
+
# verify the required parameter 'input' is set
|
|
304
|
+
if @api_client.config.client_side_validation && input.nil?
|
|
305
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_validate_address"
|
|
306
|
+
end
|
|
307
|
+
# resource path
|
|
308
|
+
local_var_path = '/validate/address/street-address'
|
|
309
|
+
|
|
310
|
+
# query parameters
|
|
311
|
+
query_params = {}
|
|
312
|
+
|
|
313
|
+
# header parameters
|
|
314
|
+
header_params = {}
|
|
315
|
+
# HTTP header 'Accept' (if needed)
|
|
316
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
317
|
+
# HTTP header 'Content-Type'
|
|
318
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
|
319
|
+
|
|
320
|
+
# form parameters
|
|
321
|
+
form_params = {}
|
|
322
|
+
|
|
323
|
+
# http body (model)
|
|
324
|
+
post_body = @api_client.object_to_http_body(input)
|
|
325
|
+
auth_names = ['Apikey']
|
|
326
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
327
|
+
:header_params => header_params,
|
|
328
|
+
:query_params => query_params,
|
|
329
|
+
:form_params => form_params,
|
|
330
|
+
:body => post_body,
|
|
331
|
+
:auth_names => auth_names,
|
|
332
|
+
:return_type => 'ValidateAddressResponse')
|
|
333
|
+
if @api_client.config.debugging
|
|
334
|
+
@api_client.config.logger.debug "API called: AddressApi#address_validate_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
335
|
+
end
|
|
336
|
+
return data, status_code, headers
|
|
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
|
|
187
500
|
end
|
|
188
501
|
end
|