Class: CloudmersiveValidateApiClient::NameApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/api/name_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NameApi

Returns a new instance of NameApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#name_get_gender(input, opts = {}) ⇒ GetGenderResponse

Get the gender of a first name Determines the gender of a first name (given name)

Parameters:

  • input —

    Gender request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 28

def name_get_gender(input, opts = {})
  data, _status_code, _headers = name_get_gender_with_http_info(input, opts)
  return data
end

#name_get_gender_with_http_info(input, opts = {}) ⇒ Array<(GetGenderResponse, Fixnum, Hash)>

Get the gender of a first name Determines the gender of a first name (given name)

Parameters:

  • input —

    Gender request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetGenderResponse, Fixnum, Hash)>) —

    GetGenderResponse data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 38

def name_get_gender_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NameApi.name_get_gender ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_get_gender"
  end
  # resource path
  local_var_path = "/validate/name/get-gender"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetGenderResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NameApi#name_get_gender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#name_identifier(input, opts = {}) ⇒ ValidateIdentifierResponse

Validate a code identifier Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be "helloWorld" but not "hello*World".

Parameters:

  • input —

    Identifier validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 83

def name_identifier(input, opts = {})
  data, _status_code, _headers = name_identifier_with_http_info(input, opts)
  return data
end

#name_identifier_with_http_info(input, opts = {}) ⇒ Array<(ValidateIdentifierResponse, Fixnum, Hash)>

Validate a code identifier Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be &quot;helloWorld&quot; but not &quot;hello*World&quot;.

Parameters:

  • input —

    Identifier validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ValidateIdentifierResponse, Fixnum, Hash)>) —

    ValidateIdentifierResponse data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 93

def name_identifier_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NameApi.name_identifier ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_identifier"
  end
  # resource path
  local_var_path = "/validate/name/identifier"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ValidateIdentifierResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NameApi#name_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#name_validate_first_name(input, opts = {}) ⇒ FirstNameValidationResponse

Validate a first name Determines if a string is a valid first name (given name)

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 138

def name_validate_first_name(input, opts = {})
  data, _status_code, _headers = name_validate_first_name_with_http_info(input, opts)
  return data
end

#name_validate_first_name_with_http_info(input, opts = {}) ⇒ Array<(FirstNameValidationResponse, Fixnum, Hash)>

Validate a first name Determines if a string is a valid first name (given name)

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 148

def name_validate_first_name_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NameApi.name_validate_first_name ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_first_name"
  end
  # resource path
  local_var_path = "/validate/name/first"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FirstNameValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NameApi#name_validate_first_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#name_validate_full_name(input, opts = {}) ⇒ FullNameValidationResponse

Parse and validate a full name 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

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 193

def name_validate_full_name(input, opts = {})
  data, _status_code, _headers = name_validate_full_name_with_http_info(input, opts)
  return data
end

#name_validate_full_name_with_http_info(input, opts = {}) ⇒ Array<(FullNameValidationResponse, Fixnum, Hash)>

Parse and validate a full name Parses a full name string (e.g. &quot;Mr. Jon van der Waal Jr.&quot;) into its component parts (and returns these component parts), and then validates whether it is a valid name string or not

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FullNameValidationResponse, Fixnum, Hash)>) —

    FullNameValidationResponse data, response status code and response headers



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 203

def name_validate_full_name_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NameApi.name_validate_full_name ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_full_name"
  end
  # resource path
  local_var_path = "/validate/name/full-name"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FullNameValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NameApi#name_validate_full_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#name_validate_last_name(input, opts = {}) ⇒ LastNameValidationResponse

Validate a last name Determines if a string is a valid last name (surname)

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 248

def name_validate_last_name(input, opts = {})
  data, _status_code, _headers = name_validate_last_name_with_http_info(input, opts)
  return data
end

#name_validate_last_name_with_http_info(input, opts = {}) ⇒ Array<(LastNameValidationResponse, Fixnum, Hash)>

Validate a last name Determines if a string is a valid last name (surname)

Parameters:

  • input —

    Validation request information

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LastNameValidationResponse, Fixnum, Hash)>) —

    LastNameValidationResponse data, response status code and response headers



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cloudmersive-validate-api-client/api/name_api.rb', line 258

def name_validate_last_name_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NameApi.name_validate_last_name ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling NameApi.name_validate_last_name"
  end
  # resource path
  local_var_path = "/validate/name/last"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(input)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LastNameValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NameApi#name_validate_last_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end