cloudmersive-validate-api-client 1.2.9 → 1.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +16 -4
- data/docs/FirstNameValidationRequest.md +8 -0
- data/docs/FirstNameValidationResponse.md +9 -0
- data/docs/FullNameValidationRequest.md +8 -0
- data/docs/FullNameValidationResponse.md +17 -0
- data/docs/GetGenderRequest.md +9 -0
- data/docs/GetGenderResponse.md +9 -0
- data/docs/LastNameValidationRequest.md +8 -0
- data/docs/LastNameValidationResponse.md +9 -0
- data/docs/NameApi.md +228 -0
- data/lib/cloudmersive-validate-api-client.rb +9 -0
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +243 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +279 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +199 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/name_api_spec.rb +83 -0
- data/spec/models/first_name_validation_request_spec.rb +42 -0
- data/spec/models/first_name_validation_response_spec.rb +48 -0
- data/spec/models/full_name_validation_request_spec.rb +42 -0
- data/spec/models/full_name_validation_response_spec.rb +96 -0
- data/spec/models/get_gender_request_spec.rb +48 -0
- data/spec/models/get_gender_response_spec.rb +48 -0
- data/spec/models/last_name_validation_request_spec.rb +42 -0
- data/spec/models/last_name_validation_response_spec.rb +48 -0
- metadata +29 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 05bb59da0b575056bb82adbd429c529ba889b8dfbe56668e3914836566e4cbf9
|
4
|
+
data.tar.gz: cc5c4ed09866e15ca51ad4cb7d84e57b49b299228815b889ef1fa2e2d3fa7c9f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a9c10ec06a37af7ae68cad4434d8cc1830c70d200cc29d711451cc2c68ada0f55d04757b7fc75561828f4289dc25ceb81981699ee82032f257311ead74ea932d
|
7
|
+
data.tar.gz: 3e2d488d5188c41e2bf56f32391813a78011525907ce625002eba64f2b9ca02aa52ffd97cd9b0aa79522274d6a161bc9f69c4ec1ab3e8f6fe615595efc15cf2d
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.3.1
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-validate-api-client-1.
|
26
|
+
gem install ./cloudmersive-validate-api-client-1.3.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.1.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-validate-api-client', '~> 1.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 1.3.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -89,6 +89,10 @@ Class | Method | HTTP request | Description
|
|
89
89
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
90
90
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
91
91
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
92
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
93
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
94
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
95
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
92
96
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
93
97
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Lookup a VAT code
|
94
98
|
|
@@ -98,8 +102,16 @@ Class | Method | HTTP request | Description
|
|
98
102
|
- [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
|
99
103
|
- [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
|
100
104
|
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
105
|
+
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
106
|
+
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
101
107
|
- [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
|
108
|
+
- [CloudmersiveValidateApiClient::FullNameValidationRequest](docs/FullNameValidationRequest.md)
|
109
|
+
- [CloudmersiveValidateApiClient::FullNameValidationResponse](docs/FullNameValidationResponse.md)
|
102
110
|
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
111
|
+
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
112
|
+
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
113
|
+
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
114
|
+
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
103
115
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
104
116
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
105
117
|
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::FirstNameValidationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
|
7
|
+
**validation_result** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::FullNameValidationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**full_name_string** | **String** | Full name to process as a free-form string; supports many components such as First Name, Middle Name, Last Name, Title, Nickname, Suffix, and Display Name | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::FullNameValidationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
|
7
|
+
**validation_result_first_name** | **String** | Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
|
8
|
+
**validation_result_last_name** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
|
9
|
+
**title** | **String** | The person's title (if supplied), e.g. \"Mr.\" or \"Ms.\" | [optional]
|
10
|
+
**first_name** | **String** | The first name (given name) | [optional]
|
11
|
+
**middle_name** | **String** | The middle name(s); if there are multiple names they will be separated by spaces | [optional]
|
12
|
+
**last_name** | **String** | The last name (surname) | [optional]
|
13
|
+
**nick_name** | **String** | Nickname (if supplied) | [optional]
|
14
|
+
**suffix** | **String** | Suffix to the name, e.g. \"Jr.\" or \"Sr.\" | [optional]
|
15
|
+
**display_name** | **String** | The full display name of the name | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::GetGenderRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | Input first name (given name) to get the gender of | [optional]
|
7
|
+
**country_code** | **String** | Optional; the country for this name, possible values are \"US\", \"LY\", \"NI\", \"TT\", \"MK\", \"KZ\", \"BO\", \"UG\", \"TZ\", \"CL\", \"SI\", \"MA\", \"RW\", \"VN\", \"AW\", \"CY\", \"BH\", \"SG\", \"ZA\", \"MU\", \"BR\", \"TN\", \"KH\", \"US\", \"TH\", \"TW\", \"UY\", \"DO\", \"CO\", \"UA\", \"QA\", \"BY\", \"SN\", \"SD\", \"FJ\", \"LB\", \"BE\", \"ML\", \"LV\", \"FR\", \"TM\", \"NG\", \"EC\", \"NO\", \"SL\", \"CR\", \"PA\", \"GE\", \"CH\", \"KR\", \"RS\", \"ZM\", \"FI\", \"BF\", \"MC\", \"AU\", \"GA\", \"LS\", \"RU\", \"IN\", \"SE\", \"LK\", \"BZ\", \"MX\", \"GH\", \"AF\", \"TJ\", \"BN\", \"DZ\", \"CM\", \"GR\", \"MD\", \"HN\", \"AT\", \"NZ\", \"SV\", \"GW\", \"NA\", \"AR\", \"MZ\", \"PK\", \"MN\", \"IQ\", \"BW\", \"VE\", \"PT\", \"BS\", \"AL\", \"TG\", \"ID\", \"ET\", \"CF\", \"JP\", \"BB\", \"PH\", \"CU\", \"BD\", \"AO\", \"SM\", \"LC\", \"ME\", \"RO\", DANIL\"O\"\", \"ES\", \"EE\", \"IL\", \"ZW\", \"SY\", \"MW\", \"LU\", \"IR\", \"SC\", \"NL\", \"JO\", \"AM\", \"DE\", \"GL\", \"OM\", \"DK\", \"HR\", \"LI\", \"TD\", \"KM\", \"BA\", \"GM\", \"GD\", \"CA\", \"CZ\", \"MR\", \"ST\", \"IS\", \"LR\", \"IE\", \"VC\", \"AE\", \"KG\", \"DJ\", \"TR\", \"KE\", \"NE\", \"UZ\", \"CN\", \"GQ\", \"SK\", \"BJ\", \"MG\", \"BT\", \"EG\", \"PL\", \"IT\", \"SA\", \"MY\", \"CI\", \"AG\", \"AD\", \"KS\", \"HU\", \"CG\", \"KP\", \"DM\", \"GN\", \"GT\", \"NP\", \"JM\", \"LA\", \"GB\", \"BG\", \"HT\", \"PE\", \"AZ\", \"LT\", \"SZ\", \"PY\", \"MT\", \"VA\" | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::GetGenderResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**gender** | **String** | Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female) | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::LastNameValidationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the validation operation was successful, false otherwise | [optional]
|
7
|
+
**validation_result** | **String** | Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty | [optional]
|
8
|
+
|
9
|
+
|
data/docs/NameApi.md
ADDED
@@ -0,0 +1,228 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::NameApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**name_get_gender**](NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
8
|
+
[**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
9
|
+
[**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
10
|
+
[**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
11
|
+
|
12
|
+
|
13
|
+
# **name_get_gender**
|
14
|
+
> GetGenderResponse name_get_gender(input)
|
15
|
+
|
16
|
+
Get the gender of a first name
|
17
|
+
|
18
|
+
Determines the gender of a first name (given name)
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'cloudmersive-validate-api-client'
|
24
|
+
# setup authorization
|
25
|
+
CloudmersiveValidateApiClient.configure do |config|
|
26
|
+
# Configure API key authorization: Apikey
|
27
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = CloudmersiveValidateApiClient::NameApi.new
|
33
|
+
|
34
|
+
input = CloudmersiveValidateApiClient::GetGenderRequest.new # GetGenderRequest | Gender request information
|
35
|
+
|
36
|
+
|
37
|
+
begin
|
38
|
+
#Get the gender of a first name
|
39
|
+
result = api_instance.name_get_gender(input)
|
40
|
+
p result
|
41
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
42
|
+
puts "Exception when calling NameApi->name_get_gender: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**input** | [**GetGenderRequest**](GetGenderRequest.md)| Gender request information |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**GetGenderResponse**](GetGenderResponse.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[Apikey](../README.md#Apikey)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
63
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
64
|
+
|
65
|
+
|
66
|
+
|
67
|
+
# **name_validate_first_name**
|
68
|
+
> FirstNameValidationResponse name_validate_first_name(input)
|
69
|
+
|
70
|
+
Validate a first name
|
71
|
+
|
72
|
+
Determines if a string is a valid first name (given name)
|
73
|
+
|
74
|
+
### Example
|
75
|
+
```ruby
|
76
|
+
# load the gem
|
77
|
+
require 'cloudmersive-validate-api-client'
|
78
|
+
# setup authorization
|
79
|
+
CloudmersiveValidateApiClient.configure do |config|
|
80
|
+
# Configure API key authorization: Apikey
|
81
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
82
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
83
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
84
|
+
end
|
85
|
+
|
86
|
+
api_instance = CloudmersiveValidateApiClient::NameApi.new
|
87
|
+
|
88
|
+
input = CloudmersiveValidateApiClient::FirstNameValidationRequest.new # FirstNameValidationRequest | Validation request information
|
89
|
+
|
90
|
+
|
91
|
+
begin
|
92
|
+
#Validate a first name
|
93
|
+
result = api_instance.name_validate_first_name(input)
|
94
|
+
p result
|
95
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
96
|
+
puts "Exception when calling NameApi->name_validate_first_name: #{e}"
|
97
|
+
end
|
98
|
+
```
|
99
|
+
|
100
|
+
### Parameters
|
101
|
+
|
102
|
+
Name | Type | Description | Notes
|
103
|
+
------------- | ------------- | ------------- | -------------
|
104
|
+
**input** | [**FirstNameValidationRequest**](FirstNameValidationRequest.md)| Validation request information |
|
105
|
+
|
106
|
+
### Return type
|
107
|
+
|
108
|
+
[**FirstNameValidationResponse**](FirstNameValidationResponse.md)
|
109
|
+
|
110
|
+
### Authorization
|
111
|
+
|
112
|
+
[Apikey](../README.md#Apikey)
|
113
|
+
|
114
|
+
### HTTP request headers
|
115
|
+
|
116
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
117
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
# **name_validate_full_name**
|
122
|
+
> FullNameValidationResponse name_validate_full_name(input)
|
123
|
+
|
124
|
+
Parse and validate a full name
|
125
|
+
|
126
|
+
Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
|
127
|
+
|
128
|
+
### Example
|
129
|
+
```ruby
|
130
|
+
# load the gem
|
131
|
+
require 'cloudmersive-validate-api-client'
|
132
|
+
# setup authorization
|
133
|
+
CloudmersiveValidateApiClient.configure do |config|
|
134
|
+
# Configure API key authorization: Apikey
|
135
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
136
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
137
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
138
|
+
end
|
139
|
+
|
140
|
+
api_instance = CloudmersiveValidateApiClient::NameApi.new
|
141
|
+
|
142
|
+
input = CloudmersiveValidateApiClient::FullNameValidationRequest.new # FullNameValidationRequest | Validation request information
|
143
|
+
|
144
|
+
|
145
|
+
begin
|
146
|
+
#Parse and validate a full name
|
147
|
+
result = api_instance.name_validate_full_name(input)
|
148
|
+
p result
|
149
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
150
|
+
puts "Exception when calling NameApi->name_validate_full_name: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
### Parameters
|
155
|
+
|
156
|
+
Name | Type | Description | Notes
|
157
|
+
------------- | ------------- | ------------- | -------------
|
158
|
+
**input** | [**FullNameValidationRequest**](FullNameValidationRequest.md)| Validation request information |
|
159
|
+
|
160
|
+
### Return type
|
161
|
+
|
162
|
+
[**FullNameValidationResponse**](FullNameValidationResponse.md)
|
163
|
+
|
164
|
+
### Authorization
|
165
|
+
|
166
|
+
[Apikey](../README.md#Apikey)
|
167
|
+
|
168
|
+
### HTTP request headers
|
169
|
+
|
170
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
171
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
# **name_validate_last_name**
|
176
|
+
> LastNameValidationResponse name_validate_last_name(input)
|
177
|
+
|
178
|
+
Validate a last name
|
179
|
+
|
180
|
+
Determines if a string is a valid last name (surname)
|
181
|
+
|
182
|
+
### Example
|
183
|
+
```ruby
|
184
|
+
# load the gem
|
185
|
+
require 'cloudmersive-validate-api-client'
|
186
|
+
# setup authorization
|
187
|
+
CloudmersiveValidateApiClient.configure do |config|
|
188
|
+
# Configure API key authorization: Apikey
|
189
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
191
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
192
|
+
end
|
193
|
+
|
194
|
+
api_instance = CloudmersiveValidateApiClient::NameApi.new
|
195
|
+
|
196
|
+
input = CloudmersiveValidateApiClient::LastNameValidationRequest.new # LastNameValidationRequest | Validation request information
|
197
|
+
|
198
|
+
|
199
|
+
begin
|
200
|
+
#Validate a last name
|
201
|
+
result = api_instance.name_validate_last_name(input)
|
202
|
+
p result
|
203
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
204
|
+
puts "Exception when calling NameApi->name_validate_last_name: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
Name | Type | Description | Notes
|
211
|
+
------------- | ------------- | ------------- | -------------
|
212
|
+
**input** | [**LastNameValidationRequest**](LastNameValidationRequest.md)| Validation request information |
|
213
|
+
|
214
|
+
### Return type
|
215
|
+
|
216
|
+
[**LastNameValidationResponse**](LastNameValidationResponse.md)
|
217
|
+
|
218
|
+
### Authorization
|
219
|
+
|
220
|
+
[Apikey](../README.md#Apikey)
|
221
|
+
|
222
|
+
### HTTP request headers
|
223
|
+
|
224
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
225
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
226
|
+
|
227
|
+
|
228
|
+
|
@@ -20,8 +20,16 @@ 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/first_name_validation_request'
|
24
|
+
require 'cloudmersive-validate-api-client/models/first_name_validation_response'
|
23
25
|
require 'cloudmersive-validate-api-client/models/full_email_validation_response'
|
26
|
+
require 'cloudmersive-validate-api-client/models/full_name_validation_request'
|
27
|
+
require 'cloudmersive-validate-api-client/models/full_name_validation_response'
|
24
28
|
require 'cloudmersive-validate-api-client/models/geolocate_response'
|
29
|
+
require 'cloudmersive-validate-api-client/models/get_gender_request'
|
30
|
+
require 'cloudmersive-validate-api-client/models/get_gender_response'
|
31
|
+
require 'cloudmersive-validate-api-client/models/last_name_validation_request'
|
32
|
+
require 'cloudmersive-validate-api-client/models/last_name_validation_response'
|
25
33
|
require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
|
26
34
|
require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
|
27
35
|
require 'cloudmersive-validate-api-client/models/vat_lookup_request'
|
@@ -32,6 +40,7 @@ require 'cloudmersive-validate-api-client/models/whois_response'
|
|
32
40
|
require 'cloudmersive-validate-api-client/api/domain_api'
|
33
41
|
require 'cloudmersive-validate-api-client/api/email_api'
|
34
42
|
require 'cloudmersive-validate-api-client/api/ip_address_api'
|
43
|
+
require 'cloudmersive-validate-api-client/api/name_api'
|
35
44
|
require 'cloudmersive-validate-api-client/api/phone_number_api'
|
36
45
|
require 'cloudmersive-validate-api-client/api/vat_api'
|
37
46
|
|
@@ -0,0 +1,243 @@
|
|
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: unset
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module CloudmersiveValidateApiClient
|
16
|
+
class NameApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get the gender of a first name
|
24
|
+
# Determines the gender of a first name (given name)
|
25
|
+
# @param input Gender request information
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [GetGenderResponse]
|
28
|
+
def name_get_gender(input, opts = {})
|
29
|
+
data, _status_code, _headers = name_get_gender_with_http_info(input, opts)
|
30
|
+
return data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get the gender of a first name
|
34
|
+
# Determines the gender of a first name (given name)
|
35
|
+
# @param input Gender request information
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @return [Array<(GetGenderResponse, Fixnum, Hash)>] GetGenderResponse data, response status code and response headers
|
38
|
+
def name_get_gender_with_http_info(input, opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug "Calling API: NameApi.name_get_gender ..."
|
41
|
+
end
|
42
|
+
# verify the required parameter 'input' is set
|
43
|
+
if @api_client.config.client_side_validation && input.nil?
|
44
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_get_gender"
|
45
|
+
end
|
46
|
+
# resource path
|
47
|
+
local_var_path = "/validate/name/get-gender"
|
48
|
+
|
49
|
+
# query parameters
|
50
|
+
query_params = {}
|
51
|
+
|
52
|
+
# header parameters
|
53
|
+
header_params = {}
|
54
|
+
# HTTP header 'Accept' (if needed)
|
55
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
56
|
+
# HTTP header 'Content-Type'
|
57
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
58
|
+
|
59
|
+
# form parameters
|
60
|
+
form_params = {}
|
61
|
+
|
62
|
+
# http body (model)
|
63
|
+
post_body = @api_client.object_to_http_body(input)
|
64
|
+
auth_names = ['Apikey']
|
65
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
66
|
+
:header_params => header_params,
|
67
|
+
:query_params => query_params,
|
68
|
+
:form_params => form_params,
|
69
|
+
:body => post_body,
|
70
|
+
:auth_names => auth_names,
|
71
|
+
:return_type => 'GetGenderResponse')
|
72
|
+
if @api_client.config.debugging
|
73
|
+
@api_client.config.logger.debug "API called: NameApi#name_get_gender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
|
+
end
|
75
|
+
return data, status_code, headers
|
76
|
+
end
|
77
|
+
|
78
|
+
# Validate a first name
|
79
|
+
# Determines if a string is a valid first name (given name)
|
80
|
+
# @param input Validation request information
|
81
|
+
# @param [Hash] opts the optional parameters
|
82
|
+
# @return [FirstNameValidationResponse]
|
83
|
+
def name_validate_first_name(input, opts = {})
|
84
|
+
data, _status_code, _headers = name_validate_first_name_with_http_info(input, opts)
|
85
|
+
return data
|
86
|
+
end
|
87
|
+
|
88
|
+
# Validate a first name
|
89
|
+
# Determines if a string is a valid first name (given name)
|
90
|
+
# @param input Validation request information
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @return [Array<(FirstNameValidationResponse, Fixnum, Hash)>] FirstNameValidationResponse data, response status code and response headers
|
93
|
+
def name_validate_first_name_with_http_info(input, opts = {})
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug "Calling API: NameApi.name_validate_first_name ..."
|
96
|
+
end
|
97
|
+
# verify the required parameter 'input' is set
|
98
|
+
if @api_client.config.client_side_validation && input.nil?
|
99
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_first_name"
|
100
|
+
end
|
101
|
+
# resource path
|
102
|
+
local_var_path = "/validate/name/first"
|
103
|
+
|
104
|
+
# query parameters
|
105
|
+
query_params = {}
|
106
|
+
|
107
|
+
# header parameters
|
108
|
+
header_params = {}
|
109
|
+
# HTTP header 'Accept' (if needed)
|
110
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
111
|
+
# HTTP header 'Content-Type'
|
112
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
113
|
+
|
114
|
+
# form parameters
|
115
|
+
form_params = {}
|
116
|
+
|
117
|
+
# http body (model)
|
118
|
+
post_body = @api_client.object_to_http_body(input)
|
119
|
+
auth_names = ['Apikey']
|
120
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
121
|
+
:header_params => header_params,
|
122
|
+
:query_params => query_params,
|
123
|
+
:form_params => form_params,
|
124
|
+
:body => post_body,
|
125
|
+
:auth_names => auth_names,
|
126
|
+
:return_type => 'FirstNameValidationResponse')
|
127
|
+
if @api_client.config.debugging
|
128
|
+
@api_client.config.logger.debug "API called: NameApi#name_validate_first_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
129
|
+
end
|
130
|
+
return data, status_code, headers
|
131
|
+
end
|
132
|
+
|
133
|
+
# Parse and validate a full name
|
134
|
+
# Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
|
135
|
+
# @param input Validation request information
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @return [FullNameValidationResponse]
|
138
|
+
def name_validate_full_name(input, opts = {})
|
139
|
+
data, _status_code, _headers = name_validate_full_name_with_http_info(input, opts)
|
140
|
+
return data
|
141
|
+
end
|
142
|
+
|
143
|
+
# Parse and validate a full name
|
144
|
+
# Parses a full name string (e.g. \"Mr. Jon van der Waal Jr.\") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
|
145
|
+
# @param input Validation request information
|
146
|
+
# @param [Hash] opts the optional parameters
|
147
|
+
# @return [Array<(FullNameValidationResponse, Fixnum, Hash)>] FullNameValidationResponse data, response status code and response headers
|
148
|
+
def name_validate_full_name_with_http_info(input, opts = {})
|
149
|
+
if @api_client.config.debugging
|
150
|
+
@api_client.config.logger.debug "Calling API: NameApi.name_validate_full_name ..."
|
151
|
+
end
|
152
|
+
# verify the required parameter 'input' is set
|
153
|
+
if @api_client.config.client_side_validation && input.nil?
|
154
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_full_name"
|
155
|
+
end
|
156
|
+
# resource path
|
157
|
+
local_var_path = "/validate/name/full-name"
|
158
|
+
|
159
|
+
# query parameters
|
160
|
+
query_params = {}
|
161
|
+
|
162
|
+
# header parameters
|
163
|
+
header_params = {}
|
164
|
+
# HTTP header 'Accept' (if needed)
|
165
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
166
|
+
# HTTP header 'Content-Type'
|
167
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
168
|
+
|
169
|
+
# form parameters
|
170
|
+
form_params = {}
|
171
|
+
|
172
|
+
# http body (model)
|
173
|
+
post_body = @api_client.object_to_http_body(input)
|
174
|
+
auth_names = ['Apikey']
|
175
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
176
|
+
:header_params => header_params,
|
177
|
+
:query_params => query_params,
|
178
|
+
:form_params => form_params,
|
179
|
+
:body => post_body,
|
180
|
+
:auth_names => auth_names,
|
181
|
+
:return_type => 'FullNameValidationResponse')
|
182
|
+
if @api_client.config.debugging
|
183
|
+
@api_client.config.logger.debug "API called: NameApi#name_validate_full_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
184
|
+
end
|
185
|
+
return data, status_code, headers
|
186
|
+
end
|
187
|
+
|
188
|
+
# Validate a last name
|
189
|
+
# Determines if a string is a valid last name (surname)
|
190
|
+
# @param input Validation request information
|
191
|
+
# @param [Hash] opts the optional parameters
|
192
|
+
# @return [LastNameValidationResponse]
|
193
|
+
def name_validate_last_name(input, opts = {})
|
194
|
+
data, _status_code, _headers = name_validate_last_name_with_http_info(input, opts)
|
195
|
+
return data
|
196
|
+
end
|
197
|
+
|
198
|
+
# Validate a last name
|
199
|
+
# Determines if a string is a valid last name (surname)
|
200
|
+
# @param input Validation request information
|
201
|
+
# @param [Hash] opts the optional parameters
|
202
|
+
# @return [Array<(LastNameValidationResponse, Fixnum, Hash)>] LastNameValidationResponse data, response status code and response headers
|
203
|
+
def name_validate_last_name_with_http_info(input, opts = {})
|
204
|
+
if @api_client.config.debugging
|
205
|
+
@api_client.config.logger.debug "Calling API: NameApi.name_validate_last_name ..."
|
206
|
+
end
|
207
|
+
# verify the required parameter 'input' is set
|
208
|
+
if @api_client.config.client_side_validation && input.nil?
|
209
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_last_name"
|
210
|
+
end
|
211
|
+
# resource path
|
212
|
+
local_var_path = "/validate/name/last"
|
213
|
+
|
214
|
+
# query parameters
|
215
|
+
query_params = {}
|
216
|
+
|
217
|
+
# header parameters
|
218
|
+
header_params = {}
|
219
|
+
# HTTP header 'Accept' (if needed)
|
220
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
221
|
+
# HTTP header 'Content-Type'
|
222
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
223
|
+
|
224
|
+
# form parameters
|
225
|
+
form_params = {}
|
226
|
+
|
227
|
+
# http body (model)
|
228
|
+
post_body = @api_client.object_to_http_body(input)
|
229
|
+
auth_names = ['Apikey']
|
230
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
231
|
+
:header_params => header_params,
|
232
|
+
:query_params => query_params,
|
233
|
+
:form_params => form_params,
|
234
|
+
:body => post_body,
|
235
|
+
:auth_names => auth_names,
|
236
|
+
:return_type => 'LastNameValidationResponse')
|
237
|
+
if @api_client.config.debugging
|
238
|
+
@api_client.config.logger.debug "API called: NameApi#name_validate_last_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
239
|
+
end
|
240
|
+
return data, status_code, headers
|
241
|
+
end
|
242
|
+
end
|
243
|
+
end
|