cloudmersive-validate-api-client 2.0.2 → 2.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +176 -0
- data/Rakefile +8 -0
- data/cloudmersive-validate-api-client.gemspec +45 -0
- data/docs/AddressApi.md +552 -0
- data/docs/AddressGetServersResponse.md +9 -0
- data/docs/AddressVerifySyntaxOnlyResponse.md +11 -0
- data/docs/CheckResponse.md +8 -0
- data/docs/CountryDetails.md +14 -0
- data/docs/CountryListResult.md +9 -0
- data/docs/DomainApi.md +228 -0
- data/docs/EmailApi.md +173 -0
- data/docs/FirstNameValidationRequest.md +8 -0
- data/docs/FirstNameValidationResponse.md +9 -0
- data/docs/FullEmailValidationResponse.md +16 -0
- data/docs/FullNameValidationRequest.md +8 -0
- data/docs/FullNameValidationResponse.md +17 -0
- data/docs/GeolocateResponse.md +16 -0
- data/docs/GetGenderRequest.md +9 -0
- data/docs/GetGenderResponse.md +9 -0
- data/docs/GetTimezonesRequest.md +8 -0
- data/docs/GetTimezonesResponse.md +13 -0
- data/docs/IPAddressApi.md +173 -0
- data/docs/IPThreatResponse.md +9 -0
- data/docs/LastNameValidationRequest.md +8 -0
- data/docs/LastNameValidationResponse.md +9 -0
- data/docs/LeadEnrichmentApi.md +61 -0
- data/docs/LeadEnrichmentRequest.md +21 -0
- data/docs/LeadEnrichmentResponse.md +25 -0
- data/docs/NameApi.md +283 -0
- data/docs/ParseAddressRequest.md +9 -0
- data/docs/ParseAddressResponse.md +16 -0
- data/docs/PhoneNumberApi.md +63 -0
- data/docs/PhoneNumberValidateRequest.md +9 -0
- data/docs/PhoneNumberValidationResponse.md +15 -0
- data/docs/Timezone.md +10 -0
- data/docs/TorNodeResponse.md +8 -0
- data/docs/UserAgentApi.md +63 -0
- data/docs/UserAgentValidateRequest.md +8 -0
- data/docs/UserAgentValidateResponse.md +21 -0
- 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/ValidateCountryRequest.md +8 -0
- data/docs/ValidateCountryResponse.md +17 -0
- data/docs/ValidateIdentifierRequest.md +15 -0
- data/docs/ValidateIdentifierResponse.md +9 -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/ValidateUrlRequestFull.md +8 -0
- data/docs/ValidateUrlRequestSyntaxOnly.md +8 -0
- data/docs/ValidateUrlResponseFull.md +12 -0
- data/docs/ValidateUrlResponseSyntaxOnly.md +9 -0
- data/docs/VatApi.md +63 -0
- data/docs/VatLookupRequest.md +8 -0
- data/docs/VatLookupResponse.md +19 -0
- data/docs/WhoisResponse.md +22 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-validate-api-client.rb +95 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +555 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +239 -0
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +75 -0
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +293 -0
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +77 -0
- data/lib/cloudmersive-validate-api-client/api_client.rb +391 -0
- data/lib/cloudmersive-validate-api-client/api_error.rb +38 -0
- data/lib/cloudmersive-validate-api-client/configuration.rb +209 -0
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +216 -0
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/country_details.rb +246 -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 +186 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +276 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/get_timezones_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/get_timezones_response.rb +238 -0
- data/lib/cloudmersive-validate-api-client/models/ip_threat_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_request.rb +316 -0
- data/lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb +356 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +256 -0
- data/lib/cloudmersive-validate-api-client/models/timezone.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/tor_node_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +316 -0
- 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 +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_country_response.rb +278 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +256 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +196 -0
- 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 +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +295 -0
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +326 -0
- data/lib/cloudmersive-validate-api-client/version.rb +15 -0
- data/spec/api/address_api_spec.rb +154 -0
- data/spec/api/domain_api_spec.rb +83 -0
- data/spec/api/email_api_spec.rb +71 -0
- data/spec/api/ip_address_api_spec.rb +71 -0
- data/spec/api/lead_enrichment_api_spec.rb +46 -0
- data/spec/api/name_api_spec.rb +95 -0
- data/spec/api/phone_number_api_spec.rb +47 -0
- data/spec/api/user_agent_api_spec.rb +47 -0
- data/spec/api/vat_api_spec.rb +47 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_get_servers_response_spec.rb +47 -0
- data/spec/models/address_verify_syntax_only_response_spec.rb +59 -0
- data/spec/models/check_response_spec.rb +41 -0
- data/spec/models/country_details_spec.rb +77 -0
- data/spec/models/country_list_result_spec.rb +47 -0
- data/spec/models/first_name_validation_request_spec.rb +41 -0
- data/spec/models/first_name_validation_response_spec.rb +47 -0
- data/spec/models/full_email_validation_response_spec.rb +89 -0
- data/spec/models/full_name_validation_request_spec.rb +41 -0
- data/spec/models/full_name_validation_response_spec.rb +95 -0
- data/spec/models/geolocate_response_spec.rb +89 -0
- data/spec/models/get_gender_request_spec.rb +47 -0
- data/spec/models/get_gender_response_spec.rb +47 -0
- data/spec/models/get_timezones_request_spec.rb +41 -0
- data/spec/models/get_timezones_response_spec.rb +71 -0
- data/spec/models/ip_threat_response_spec.rb +47 -0
- data/spec/models/last_name_validation_request_spec.rb +41 -0
- data/spec/models/last_name_validation_response_spec.rb +47 -0
- data/spec/models/lead_enrichment_request_spec.rb +119 -0
- data/spec/models/lead_enrichment_response_spec.rb +143 -0
- data/spec/models/parse_address_request_spec.rb +47 -0
- data/spec/models/parse_address_response_spec.rb +89 -0
- data/spec/models/phone_number_validate_request_spec.rb +47 -0
- data/spec/models/phone_number_validation_response_spec.rb +83 -0
- data/spec/models/timezone_spec.rb +53 -0
- data/spec/models/tor_node_response_spec.rb +41 -0
- data/spec/models/user_agent_validate_request_spec.rb +41 -0
- data/spec/models/user_agent_validate_response_spec.rb +119 -0
- 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 +41 -0
- data/spec/models/validate_country_response_spec.rb +95 -0
- data/spec/models/validate_identifier_request_spec.rb +83 -0
- data/spec/models/validate_identifier_response_spec.rb +47 -0
- 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 +41 -0
- data/spec/models/validate_url_request_syntax_only_spec.rb +41 -0
- data/spec/models/validate_url_response_full_spec.rb +65 -0
- data/spec/models/validate_url_response_syntax_only_spec.rb +47 -0
- data/spec/models/vat_lookup_request_spec.rb +41 -0
- data/spec/models/vat_lookup_response_spec.rb +107 -0
- data/spec/models/whois_response_spec.rb +125 -0
- data/spec/spec_helper.rb +111 -0
- metadata +184 -3
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UserAgentValidateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**user_agent_string** | **String** | The user agent string you wish to parse and validate | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UserAgentValidateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**is_bot** | **BOOLEAN** | True if the request is a known robot, false otherwise | [optional]
|
8
|
+
**bot_name** | **String** | Optional; name of the robot if the request was from a known robot, otherwise null | [optional]
|
9
|
+
**bot_url** | **String** | Optional; if available, the URL to the robot | [optional]
|
10
|
+
**operating_system** | **String** | Operating System of the User-Agent (e.g. Windows) | [optional]
|
11
|
+
**operating_system_cpu_platform** | **String** | The CPU platform of the User-Agent (e.g. x64) | [optional]
|
12
|
+
**operating_system_version** | **String** | The version of the operating system of the User-Agent (e.g. \"10\" for Windows 10) | [optional]
|
13
|
+
**device_type** | **String** | Device type of the User-Agent; possible values are \"DESKTOP\", \"SMARTPHONE\", \"TABLET\" | [optional]
|
14
|
+
**device_brand_name** | **String** | Brand name of the User-Agent | [optional]
|
15
|
+
**device_model** | **String** | Model name or number of the User-Agent | [optional]
|
16
|
+
**browser_name** | **String** | Name of the Browser | [optional]
|
17
|
+
**browser_version** | **String** | Version of the Browser | [optional]
|
18
|
+
**browser_engine_name** | **String** | Name of the Browser Engine | [optional]
|
19
|
+
**browser_engine_version** | **String** | Version of the Browser Engine | [optional]
|
20
|
+
|
21
|
+
|
@@ -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
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateCountryRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**raw_country_input** | **String** | Raw country input - can be a two-letter code (FIPS 10-4 or ISO 3166-1), three-letter code (ISO 3166-1) or country name | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateCountryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**country_full_name** | **String** | Full name of the country | [optional]
|
8
|
+
**iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional]
|
9
|
+
**fips_two_letter_code** | **String** | Two-letter FIPS 10-4 country code | [optional]
|
10
|
+
**three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional]
|
11
|
+
**is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional]
|
12
|
+
**timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional]
|
13
|
+
**iso_currency_code** | **String** | ISO 4217 currency three-letter code associated with the country | [optional]
|
14
|
+
**currency_symbol** | **String** | Symbol associated with the currency | [optional]
|
15
|
+
**currency_english_name** | **String** | Full name of the currency | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateIdentifierRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input** | **String** | Text string identifier input | [optional]
|
7
|
+
**allow_whitespace** | **BOOLEAN** | True if whitespace is allowed in the identifier, false otherwise | [optional]
|
8
|
+
**allow_hyphens** | **BOOLEAN** | True if hyphens are allowd in the identifier, false otherwise | [optional]
|
9
|
+
**allow_underscore** | **BOOLEAN** | True if underscores are allowed in the identifier, false otherwise | [optional]
|
10
|
+
**allow_numbers** | **BOOLEAN** | True if numbers are allowed in the identifier, false otherwise | [optional]
|
11
|
+
**allow_periods** | **BOOLEAN** | True if periods are allowed in the identifier, false otherwise | [optional]
|
12
|
+
**max_length** | **Integer** | Optional; maximum length, if any, of the identifier | [optional]
|
13
|
+
**min_length** | **Integer** | Optional; minimum length, if any, of the identifier | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateIdentifierResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid_identifier** | **BOOLEAN** | True if the input identifier is valid, false otherwise | [optional]
|
7
|
+
**error** | **String** | Resulting error from the identifier validation; possible errors are: \"InputIsEmpty\", \"ContainsWhitespace\", \"ContainsNumbers\", \"ContainsHyphen\", \"ContainsUnderscore\", \"ContainsPeriod\", \"TooShort\", \"TooLong\", \"ContainsSpecialCharacters\" | [optional]
|
8
|
+
|
9
|
+
|
@@ -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
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateUrlResponseFull
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid_url** | **BOOLEAN** | True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise | [optional]
|
7
|
+
**valid_syntax** | **BOOLEAN** | True if the URL has valid syntax, false otherwise | [optional]
|
8
|
+
**valid_domain** | **BOOLEAN** | True if the domain name is valid and exists, false otherwise | [optional]
|
9
|
+
**valid_endpoint** | **BOOLEAN** | True if the endpoint is up and responsive and passes a virus scan check, false otherwise | [optional]
|
10
|
+
**well_formed_url** | **String** | Well-formed version of the URL | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid_url** | **BOOLEAN** | True if the URL is valid, false otherwise | [optional]
|
7
|
+
**well_formed_url** | **String** | Well-formed version of the URL | [optional]
|
8
|
+
|
9
|
+
|
data/docs/VatApi.md
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::VatApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**vat_vat_lookup**](VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
8
|
+
|
9
|
+
|
10
|
+
# **vat_vat_lookup**
|
11
|
+
> VatLookupResponse vat_vat_lookup(input)
|
12
|
+
|
13
|
+
Validate a VAT number
|
14
|
+
|
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
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-validate-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveValidateApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveValidateApiClient::VatApi.new
|
30
|
+
|
31
|
+
input = CloudmersiveValidateApiClient::VatLookupRequest.new # VatLookupRequest | Input VAT code
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Validate a VAT number
|
36
|
+
result = api_instance.vat_vat_lookup(input)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
39
|
+
puts "Exception when calling VatApi->vat_vat_lookup: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**input** | [**VatLookupRequest**](VatLookupRequest.md)| Input VAT code |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**VatLookupResponse**](VatLookupResponse.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json, text/json
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::VatLookupRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**vat_code** | **String** | VAT code to lookup; example \"CZ25123891\" | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::VatLookupResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**country_code** | **String** | Two-letter country code | [optional]
|
7
|
+
**vat_number** | **String** | VAT number | [optional]
|
8
|
+
**is_valid** | **BOOLEAN** | True if the VAT code is valid, false otherwise | [optional]
|
9
|
+
**business_name** | **String** | Name of the business | [optional]
|
10
|
+
**business_address** | **String** | Business address as a single string | [optional]
|
11
|
+
**business_building** | **String** | For the business address, the name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\". This will often by null. | [optional]
|
12
|
+
**business_street_number** | **String** | For the business address, the street number or house number of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"1600\". This value will typically be populated for most addresses. | [optional]
|
13
|
+
**business_street** | **String** | For the business address, the name of the street or road of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"Pennsylvania Avenue NW\". | [optional]
|
14
|
+
**business_city** | **String** | For the business address, the city of the address. | [optional]
|
15
|
+
**business_state_or_province** | **String** | For the business address, the state or province of the address. | [optional]
|
16
|
+
**business_postal_code** | **String** | For the business address, the postal code or zip code of the address. | [optional]
|
17
|
+
**business_country** | **String** | For the business address, country of the address, if present in the address. If not included in the address it will be null. | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::WhoisResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**valid_domain** | **BOOLEAN** | True if the domain is valid, false if it is not | [optional]
|
7
|
+
**registrant_name** | **String** | Name of the domain registrant | [optional]
|
8
|
+
**registrant_organization** | **String** | Organization name of the domain registrant | [optional]
|
9
|
+
**registrant_email** | **String** | Email address of the domain registrant | [optional]
|
10
|
+
**registrant_street_number** | **String** | Street number of the address of the domain registrant, if available | [optional]
|
11
|
+
**registrant_street** | **String** | Street name of the address of the domain registrant, if available | [optional]
|
12
|
+
**registrant_city** | **String** | City of the domain registrant, if available | [optional]
|
13
|
+
**registrant_state_or_province** | **String** | State or Province of the address of the domain registrant, if available | [optional]
|
14
|
+
**registrant_postal_code** | **String** | Postal code of the address of the domain registrant, if available | [optional]
|
15
|
+
**registrant_country** | **String** | Country of the address of the domain registrant, if available | [optional]
|
16
|
+
**registrant_raw_address** | **String** | Raw address string of the domain registrant, if available | [optional]
|
17
|
+
**registrant_telephone** | **String** | Telephone number of the address of the domain registrant | [optional]
|
18
|
+
**whois_server** | **String** | Server used to lookup WHOIS information (may change based on lookup). | [optional]
|
19
|
+
**raw_text_record** | **String** | WHOIS raw text record | [optional]
|
20
|
+
**created_dt** | **DateTime** | Creation date for the record | [optional]
|
21
|
+
|
22
|
+
|
data/git_push.sh
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
|
4
|
+
#
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
6
|
+
#
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
|
8
|
+
|
9
|
+
git_user_id=$1
|
10
|
+
git_repo_id=$2
|
11
|
+
release_note=$3
|
12
|
+
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
14
|
+
git_user_id="GIT_USER_ID"
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
16
|
+
fi
|
17
|
+
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
19
|
+
git_repo_id="GIT_REPO_ID"
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
21
|
+
fi
|
22
|
+
|
23
|
+
if [ "$release_note" = "" ]; then
|
24
|
+
release_note="Minor update"
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
26
|
+
fi
|
27
|
+
|
28
|
+
# Initialize the local directory as a Git repository
|
29
|
+
git init
|
30
|
+
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
32
|
+
git add .
|
33
|
+
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
35
|
+
git commit -m "$release_note"
|
36
|
+
|
37
|
+
# Sets the new remote
|
38
|
+
git_remote=`git remote`
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
40
|
+
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
44
|
+
else
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
46
|
+
fi
|
47
|
+
|
48
|
+
fi
|
49
|
+
|
50
|
+
git pull origin master
|
51
|
+
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
55
|
+
|
@@ -0,0 +1,95 @@
|
|
1
|
+
=begin
|
2
|
+
#validateapi
|
3
|
+
|
4
|
+
#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
# Common files
|
14
|
+
require 'cloudmersive-validate-api-client/api_client'
|
15
|
+
require 'cloudmersive-validate-api-client/api_error'
|
16
|
+
require 'cloudmersive-validate-api-client/version'
|
17
|
+
require 'cloudmersive-validate-api-client/configuration'
|
18
|
+
|
19
|
+
# Models
|
20
|
+
require 'cloudmersive-validate-api-client/models/address_get_servers_response'
|
21
|
+
require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_response'
|
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'
|
25
|
+
require 'cloudmersive-validate-api-client/models/first_name_validation_request'
|
26
|
+
require 'cloudmersive-validate-api-client/models/first_name_validation_response'
|
27
|
+
require 'cloudmersive-validate-api-client/models/full_email_validation_response'
|
28
|
+
require 'cloudmersive-validate-api-client/models/full_name_validation_request'
|
29
|
+
require 'cloudmersive-validate-api-client/models/full_name_validation_response'
|
30
|
+
require 'cloudmersive-validate-api-client/models/geolocate_response'
|
31
|
+
require 'cloudmersive-validate-api-client/models/get_gender_request'
|
32
|
+
require 'cloudmersive-validate-api-client/models/get_gender_response'
|
33
|
+
require 'cloudmersive-validate-api-client/models/get_timezones_request'
|
34
|
+
require 'cloudmersive-validate-api-client/models/get_timezones_response'
|
35
|
+
require 'cloudmersive-validate-api-client/models/ip_threat_response'
|
36
|
+
require 'cloudmersive-validate-api-client/models/last_name_validation_request'
|
37
|
+
require 'cloudmersive-validate-api-client/models/last_name_validation_response'
|
38
|
+
require 'cloudmersive-validate-api-client/models/lead_enrichment_request'
|
39
|
+
require 'cloudmersive-validate-api-client/models/lead_enrichment_response'
|
40
|
+
require 'cloudmersive-validate-api-client/models/parse_address_request'
|
41
|
+
require 'cloudmersive-validate-api-client/models/parse_address_response'
|
42
|
+
require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
|
43
|
+
require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
|
44
|
+
require 'cloudmersive-validate-api-client/models/timezone'
|
45
|
+
require 'cloudmersive-validate-api-client/models/tor_node_response'
|
46
|
+
require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
|
47
|
+
require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
|
48
|
+
require 'cloudmersive-validate-api-client/models/validate_address_request'
|
49
|
+
require 'cloudmersive-validate-api-client/models/validate_address_response'
|
50
|
+
require 'cloudmersive-validate-api-client/models/validate_city_request'
|
51
|
+
require 'cloudmersive-validate-api-client/models/validate_city_response'
|
52
|
+
require 'cloudmersive-validate-api-client/models/validate_country_request'
|
53
|
+
require 'cloudmersive-validate-api-client/models/validate_country_response'
|
54
|
+
require 'cloudmersive-validate-api-client/models/validate_identifier_request'
|
55
|
+
require 'cloudmersive-validate-api-client/models/validate_identifier_response'
|
56
|
+
require 'cloudmersive-validate-api-client/models/validate_postal_code_request'
|
57
|
+
require 'cloudmersive-validate-api-client/models/validate_postal_code_response'
|
58
|
+
require 'cloudmersive-validate-api-client/models/validate_state_request'
|
59
|
+
require 'cloudmersive-validate-api-client/models/validate_state_response'
|
60
|
+
require 'cloudmersive-validate-api-client/models/validate_url_request_full'
|
61
|
+
require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
|
62
|
+
require 'cloudmersive-validate-api-client/models/validate_url_response_full'
|
63
|
+
require 'cloudmersive-validate-api-client/models/validate_url_response_syntax_only'
|
64
|
+
require 'cloudmersive-validate-api-client/models/vat_lookup_request'
|
65
|
+
require 'cloudmersive-validate-api-client/models/vat_lookup_response'
|
66
|
+
require 'cloudmersive-validate-api-client/models/whois_response'
|
67
|
+
|
68
|
+
# APIs
|
69
|
+
require 'cloudmersive-validate-api-client/api/address_api'
|
70
|
+
require 'cloudmersive-validate-api-client/api/domain_api'
|
71
|
+
require 'cloudmersive-validate-api-client/api/email_api'
|
72
|
+
require 'cloudmersive-validate-api-client/api/ip_address_api'
|
73
|
+
require 'cloudmersive-validate-api-client/api/lead_enrichment_api'
|
74
|
+
require 'cloudmersive-validate-api-client/api/name_api'
|
75
|
+
require 'cloudmersive-validate-api-client/api/phone_number_api'
|
76
|
+
require 'cloudmersive-validate-api-client/api/user_agent_api'
|
77
|
+
require 'cloudmersive-validate-api-client/api/vat_api'
|
78
|
+
|
79
|
+
module CloudmersiveValidateApiClient
|
80
|
+
class << self
|
81
|
+
# Customize default settings for the SDK using block.
|
82
|
+
# CloudmersiveValidateApiClient.configure do |config|
|
83
|
+
# config.username = "xxx"
|
84
|
+
# config.password = "xxx"
|
85
|
+
# end
|
86
|
+
# If no block given, return the default Configuration object.
|
87
|
+
def configure
|
88
|
+
if block_given?
|
89
|
+
yield(Configuration.default)
|
90
|
+
else
|
91
|
+
Configuration.default
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|