cloudmersive-validate-api-client 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +118 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-validate-api-client.gemspec +45 -0
  6. data/docs/AddressGetServersResponse.md +9 -0
  7. data/docs/AddressVerifySyntaxOnlyResponse.md +8 -0
  8. data/docs/CheckResponse.md +8 -0
  9. data/docs/DomainApi.md +118 -0
  10. data/docs/EmailApi.md +173 -0
  11. data/docs/FullEmailValidationResponse.md +9 -0
  12. data/docs/GeolocateResponse.md +16 -0
  13. data/docs/IPAddressApi.md +63 -0
  14. data/docs/PhoneNumberApi.md +63 -0
  15. data/docs/PhoneNumberValidateRequest.md +9 -0
  16. data/docs/PhoneNumberValidationResponse.md +15 -0
  17. data/docs/VatApi.md +63 -0
  18. data/docs/VatLookupRequest.md +8 -0
  19. data/docs/VatLookupResponse.md +12 -0
  20. data/docs/WhoisResponse.md +11 -0
  21. data/git_push.sh +55 -0
  22. data/lib/cloudmersive-validate-api-client.rb +54 -0
  23. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +133 -0
  24. data/lib/cloudmersive-validate-api-client/api/email_api.rb +188 -0
  25. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +78 -0
  26. data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +78 -0
  27. data/lib/cloudmersive-validate-api-client/api/vat_api.rb +78 -0
  28. data/lib/cloudmersive-validate-api-client/api_client.rb +389 -0
  29. data/lib/cloudmersive-validate-api-client/api_error.rb +38 -0
  30. data/lib/cloudmersive-validate-api-client/configuration.rb +209 -0
  31. data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +199 -0
  32. data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +189 -0
  33. data/lib/cloudmersive-validate-api-client/models/check_response.rb +189 -0
  34. data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +199 -0
  35. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +269 -0
  36. data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +199 -0
  37. data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +259 -0
  38. data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +188 -0
  39. data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +224 -0
  40. data/lib/cloudmersive-validate-api-client/models/whois_response.rb +219 -0
  41. data/lib/cloudmersive-validate-api-client/version.rb +15 -0
  42. data/spec/api/domain_api_spec.rb +59 -0
  43. data/spec/api/email_api_spec.rb +71 -0
  44. data/spec/api/ip_address_api_spec.rb +47 -0
  45. data/spec/api/phone_number_api_spec.rb +47 -0
  46. data/spec/api/vat_api_spec.rb +47 -0
  47. data/spec/api_client_spec.rb +226 -0
  48. data/spec/configuration_spec.rb +42 -0
  49. data/spec/models/address_get_servers_response_spec.rb +48 -0
  50. data/spec/models/address_verify_syntax_only_response_spec.rb +42 -0
  51. data/spec/models/check_response_spec.rb +42 -0
  52. data/spec/models/full_email_validation_response_spec.rb +48 -0
  53. data/spec/models/geolocate_response_spec.rb +90 -0
  54. data/spec/models/phone_number_validate_request_spec.rb +48 -0
  55. data/spec/models/phone_number_validation_response_spec.rb +84 -0
  56. data/spec/models/vat_lookup_request_spec.rb +42 -0
  57. data/spec/models/vat_lookup_response_spec.rb +66 -0
  58. data/spec/models/whois_response_spec.rb +60 -0
  59. data/spec/spec_helper.rb +111 -0
  60. metadata +284 -0
@@ -0,0 +1,199 @@
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 'date'
14
+
15
+ module CloudmersiveValidateApiClient
16
+ # Request to validate a phone number
17
+ class PhoneNumberValidateRequest
18
+ # Raw phone number string to parse as input for validation
19
+ attr_accessor :phone_number
20
+
21
+ # Optional, default country code. If left blank, will default to \"US\".
22
+ attr_accessor :default_country_code
23
+
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'phone_number' => :'PhoneNumber',
29
+ :'default_country_code' => :'DefaultCountryCode'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.swagger_types
35
+ {
36
+ :'phone_number' => :'String',
37
+ :'default_country_code' => :'String'
38
+ }
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ return unless attributes.is_a?(Hash)
45
+
46
+ # convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
48
+
49
+ if attributes.has_key?(:'PhoneNumber')
50
+ self.phone_number = attributes[:'PhoneNumber']
51
+ end
52
+
53
+ if attributes.has_key?(:'DefaultCountryCode')
54
+ self.default_country_code = attributes[:'DefaultCountryCode']
55
+ end
56
+
57
+ end
58
+
59
+ # Show invalid properties with the reasons. Usually used together with valid?
60
+ # @return Array for valid properties with the reasons
61
+ def list_invalid_properties
62
+ invalid_properties = Array.new
63
+ return invalid_properties
64
+ end
65
+
66
+ # Check to see if the all the properties in the model are valid
67
+ # @return true if the model is valid
68
+ def valid?
69
+ return true
70
+ end
71
+
72
+ # Checks equality by comparing each attribute.
73
+ # @param [Object] Object to be compared
74
+ def ==(o)
75
+ return true if self.equal?(o)
76
+ self.class == o.class &&
77
+ phone_number == o.phone_number &&
78
+ default_country_code == o.default_country_code
79
+ end
80
+
81
+ # @see the `==` method
82
+ # @param [Object] Object to be compared
83
+ def eql?(o)
84
+ self == o
85
+ end
86
+
87
+ # Calculates hash code according to all attributes.
88
+ # @return [Fixnum] Hash code
89
+ def hash
90
+ [phone_number, default_country_code].hash
91
+ end
92
+
93
+ # Builds the object from hash
94
+ # @param [Hash] attributes Model attributes in the form of hash
95
+ # @return [Object] Returns the model itself
96
+ def build_from_hash(attributes)
97
+ return nil unless attributes.is_a?(Hash)
98
+ self.class.swagger_types.each_pair do |key, type|
99
+ if type =~ /\AArray<(.*)>/i
100
+ # check to ensure the input is an array given that the the attribute
101
+ # is documented as an array but the input is not
102
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
103
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
104
+ end
105
+ elsif !attributes[self.class.attribute_map[key]].nil?
106
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
107
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
108
+ end
109
+
110
+ self
111
+ end
112
+
113
+ # Deserializes the data based on type
114
+ # @param string type Data type
115
+ # @param string value Value to be deserialized
116
+ # @return [Object] Deserialized data
117
+ def _deserialize(type, value)
118
+ case type.to_sym
119
+ when :DateTime
120
+ DateTime.parse(value)
121
+ when :Date
122
+ Date.parse(value)
123
+ when :String
124
+ value.to_s
125
+ when :Integer
126
+ value.to_i
127
+ when :Float
128
+ value.to_f
129
+ when :BOOLEAN
130
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
131
+ true
132
+ else
133
+ false
134
+ end
135
+ when :Object
136
+ # generic object (usually a Hash), return directly
137
+ value
138
+ when /\AArray<(?<inner_type>.+)>\z/
139
+ inner_type = Regexp.last_match[:inner_type]
140
+ value.map { |v| _deserialize(inner_type, v) }
141
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
142
+ k_type = Regexp.last_match[:k_type]
143
+ v_type = Regexp.last_match[:v_type]
144
+ {}.tap do |hash|
145
+ value.each do |k, v|
146
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
147
+ end
148
+ end
149
+ else # model
150
+ temp_model = CloudmersiveValidateApiClient.const_get(type).new
151
+ temp_model.build_from_hash(value)
152
+ end
153
+ end
154
+
155
+ # Returns the string representation of the object
156
+ # @return [String] String presentation of the object
157
+ def to_s
158
+ to_hash.to_s
159
+ end
160
+
161
+ # to_body is an alias to to_hash (backward compatibility)
162
+ # @return [Hash] Returns the object in the form of hash
163
+ def to_body
164
+ to_hash
165
+ end
166
+
167
+ # Returns the object in the form of hash
168
+ # @return [Hash] Returns the object in the form of hash
169
+ def to_hash
170
+ hash = {}
171
+ self.class.attribute_map.each_pair do |attr, param|
172
+ value = self.send(attr)
173
+ next if value.nil?
174
+ hash[param] = _to_hash(value)
175
+ end
176
+ hash
177
+ end
178
+
179
+ # Outputs non-array value in the form of hash
180
+ # For object, use to_hash. Otherwise, just return the value
181
+ # @param [Object] value Any valid value
182
+ # @return [Hash] Returns the value in the form of hash
183
+ def _to_hash(value)
184
+ if value.is_a?(Array)
185
+ value.compact.map{ |v| _to_hash(v) }
186
+ elsif value.is_a?(Hash)
187
+ {}.tap do |hash|
188
+ value.each { |k, v| hash[k] = _to_hash(v) }
189
+ end
190
+ elsif value.respond_to? :to_hash
191
+ value.to_hash
192
+ else
193
+ value
194
+ end
195
+ end
196
+
197
+ end
198
+
199
+ end
@@ -0,0 +1,259 @@
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 'date'
14
+
15
+ module CloudmersiveValidateApiClient
16
+ # Result from validating a phone number
17
+ class PhoneNumberValidationResponse
18
+ # True if the phone number is valid, false otherwise
19
+ attr_accessor :is_valid
20
+
21
+ # True if the operation was successful, false if there was an error during validation. See IsValid for validation result.
22
+ attr_accessor :successful
23
+
24
+ # Type of phone number; possible values are: FixedLine, Mobile, FixedLineOrMobile, TollFree, PremiumRate, SharedCost, Voip, PersonalNumber, Pager, Uan, Voicemail, Unknown
25
+ attr_accessor :phone_number_type
26
+
27
+ # E.164 format of the phone number
28
+ attr_accessor :e164_format
29
+
30
+ # Internaltional format of the phone number
31
+ attr_accessor :international_format
32
+
33
+ # National format of the phone number
34
+ attr_accessor :national_format
35
+
36
+ # Two digit country code of the phone number
37
+ attr_accessor :country_code
38
+
39
+ # User-friendly long name of the country for the phone number
40
+ attr_accessor :country_name
41
+
42
+
43
+ # Attribute mapping from ruby-style variable name to JSON key.
44
+ def self.attribute_map
45
+ {
46
+ :'is_valid' => :'IsValid',
47
+ :'successful' => :'Successful',
48
+ :'phone_number_type' => :'PhoneNumberType',
49
+ :'e164_format' => :'E164Format',
50
+ :'international_format' => :'InternationalFormat',
51
+ :'national_format' => :'NationalFormat',
52
+ :'country_code' => :'CountryCode',
53
+ :'country_name' => :'CountryName'
54
+ }
55
+ end
56
+
57
+ # Attribute type mapping.
58
+ def self.swagger_types
59
+ {
60
+ :'is_valid' => :'BOOLEAN',
61
+ :'successful' => :'BOOLEAN',
62
+ :'phone_number_type' => :'String',
63
+ :'e164_format' => :'String',
64
+ :'international_format' => :'String',
65
+ :'national_format' => :'String',
66
+ :'country_code' => :'String',
67
+ :'country_name' => :'String'
68
+ }
69
+ end
70
+
71
+ # Initializes the object
72
+ # @param [Hash] attributes Model attributes in the form of hash
73
+ def initialize(attributes = {})
74
+ return unless attributes.is_a?(Hash)
75
+
76
+ # convert string to symbol for hash key
77
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
78
+
79
+ if attributes.has_key?(:'IsValid')
80
+ self.is_valid = attributes[:'IsValid']
81
+ end
82
+
83
+ if attributes.has_key?(:'Successful')
84
+ self.successful = attributes[:'Successful']
85
+ end
86
+
87
+ if attributes.has_key?(:'PhoneNumberType')
88
+ self.phone_number_type = attributes[:'PhoneNumberType']
89
+ end
90
+
91
+ if attributes.has_key?(:'E164Format')
92
+ self.e164_format = attributes[:'E164Format']
93
+ end
94
+
95
+ if attributes.has_key?(:'InternationalFormat')
96
+ self.international_format = attributes[:'InternationalFormat']
97
+ end
98
+
99
+ if attributes.has_key?(:'NationalFormat')
100
+ self.national_format = attributes[:'NationalFormat']
101
+ end
102
+
103
+ if attributes.has_key?(:'CountryCode')
104
+ self.country_code = attributes[:'CountryCode']
105
+ end
106
+
107
+ if attributes.has_key?(:'CountryName')
108
+ self.country_name = attributes[:'CountryName']
109
+ end
110
+
111
+ end
112
+
113
+ # Show invalid properties with the reasons. Usually used together with valid?
114
+ # @return Array for valid properties with the reasons
115
+ def list_invalid_properties
116
+ invalid_properties = Array.new
117
+ return invalid_properties
118
+ end
119
+
120
+ # Check to see if the all the properties in the model are valid
121
+ # @return true if the model is valid
122
+ def valid?
123
+ return true
124
+ end
125
+
126
+ # Checks equality by comparing each attribute.
127
+ # @param [Object] Object to be compared
128
+ def ==(o)
129
+ return true if self.equal?(o)
130
+ self.class == o.class &&
131
+ is_valid == o.is_valid &&
132
+ successful == o.successful &&
133
+ phone_number_type == o.phone_number_type &&
134
+ e164_format == o.e164_format &&
135
+ international_format == o.international_format &&
136
+ national_format == o.national_format &&
137
+ country_code == o.country_code &&
138
+ country_name == o.country_name
139
+ end
140
+
141
+ # @see the `==` method
142
+ # @param [Object] Object to be compared
143
+ def eql?(o)
144
+ self == o
145
+ end
146
+
147
+ # Calculates hash code according to all attributes.
148
+ # @return [Fixnum] Hash code
149
+ def hash
150
+ [is_valid, successful, phone_number_type, e164_format, international_format, national_format, country_code, country_name].hash
151
+ end
152
+
153
+ # Builds the object from hash
154
+ # @param [Hash] attributes Model attributes in the form of hash
155
+ # @return [Object] Returns the model itself
156
+ def build_from_hash(attributes)
157
+ return nil unless attributes.is_a?(Hash)
158
+ self.class.swagger_types.each_pair do |key, type|
159
+ if type =~ /\AArray<(.*)>/i
160
+ # check to ensure the input is an array given that the the attribute
161
+ # is documented as an array but the input is not
162
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
163
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
164
+ end
165
+ elsif !attributes[self.class.attribute_map[key]].nil?
166
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
167
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
168
+ end
169
+
170
+ self
171
+ end
172
+
173
+ # Deserializes the data based on type
174
+ # @param string type Data type
175
+ # @param string value Value to be deserialized
176
+ # @return [Object] Deserialized data
177
+ def _deserialize(type, value)
178
+ case type.to_sym
179
+ when :DateTime
180
+ DateTime.parse(value)
181
+ when :Date
182
+ Date.parse(value)
183
+ when :String
184
+ value.to_s
185
+ when :Integer
186
+ value.to_i
187
+ when :Float
188
+ value.to_f
189
+ when :BOOLEAN
190
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
191
+ true
192
+ else
193
+ false
194
+ end
195
+ when :Object
196
+ # generic object (usually a Hash), return directly
197
+ value
198
+ when /\AArray<(?<inner_type>.+)>\z/
199
+ inner_type = Regexp.last_match[:inner_type]
200
+ value.map { |v| _deserialize(inner_type, v) }
201
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
202
+ k_type = Regexp.last_match[:k_type]
203
+ v_type = Regexp.last_match[:v_type]
204
+ {}.tap do |hash|
205
+ value.each do |k, v|
206
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
207
+ end
208
+ end
209
+ else # model
210
+ temp_model = CloudmersiveValidateApiClient.const_get(type).new
211
+ temp_model.build_from_hash(value)
212
+ end
213
+ end
214
+
215
+ # Returns the string representation of the object
216
+ # @return [String] String presentation of the object
217
+ def to_s
218
+ to_hash.to_s
219
+ end
220
+
221
+ # to_body is an alias to to_hash (backward compatibility)
222
+ # @return [Hash] Returns the object in the form of hash
223
+ def to_body
224
+ to_hash
225
+ end
226
+
227
+ # Returns the object in the form of hash
228
+ # @return [Hash] Returns the object in the form of hash
229
+ def to_hash
230
+ hash = {}
231
+ self.class.attribute_map.each_pair do |attr, param|
232
+ value = self.send(attr)
233
+ next if value.nil?
234
+ hash[param] = _to_hash(value)
235
+ end
236
+ hash
237
+ end
238
+
239
+ # Outputs non-array value in the form of hash
240
+ # For object, use to_hash. Otherwise, just return the value
241
+ # @param [Object] value Any valid value
242
+ # @return [Hash] Returns the value in the form of hash
243
+ def _to_hash(value)
244
+ if value.is_a?(Array)
245
+ value.compact.map{ |v| _to_hash(v) }
246
+ elsif value.is_a?(Hash)
247
+ {}.tap do |hash|
248
+ value.each { |k, v| hash[k] = _to_hash(v) }
249
+ end
250
+ elsif value.respond_to? :to_hash
251
+ value.to_hash
252
+ else
253
+ value
254
+ end
255
+ end
256
+
257
+ end
258
+
259
+ end