Class: CloudmersiveValidateApiClient::PhoneNumberApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhoneNumberApi

Returns a new instance of PhoneNumberApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/phone_number_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/phone_number_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#phone_number_syntax_only(value, opts = {}) ⇒ PhoneNumberValidationResponse

Validate phone number (basic) Validate a phone number by analyzing the syntax

Parameters:

  • value —

    Phone number to validate in a PhoneNumberValidateRequest object. Try a phone number such as "1.800.463.3339", and either leave DefaultCountryCode blank or use "US".

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

    the optional parameters

Returns:



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

def phone_number_syntax_only(value, opts = {})
  data, _status_code, _headers = phone_number_syntax_only_with_http_info(value, opts)
  return data
end

#phone_number_syntax_only_with_http_info(value, opts = {}) ⇒ Array<(PhoneNumberValidationResponse, Fixnum, Hash)>

Validate phone number (basic) Validate a phone number by analyzing the syntax

Parameters:

  • value —

    Phone number to validate in a PhoneNumberValidateRequest object. Try a phone number such as &quot;1.800.463.3339&quot;, and either leave DefaultCountryCode blank or use &quot;US&quot;.

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

    the optional parameters

Returns:



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/phone_number_api.rb', line 38

def phone_number_syntax_only_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PhoneNumberApi.phone_number_syntax_only ..."
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling PhoneNumberApi.phone_number_syntax_only"
  end
  # resource path
  local_var_path = "/validate/phonenumber/basic"

  # 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(value)
  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 => 'PhoneNumberValidationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumberApi#phone_number_syntax_only\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end