class CloudmersiveValidateApiClient::PhoneNumberApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/cloudmersive-validate-api-client/api/phone_number_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

phone_number_syntax_only(value, opts = {}) click to toggle source

Validate phone number (basic) Validate a phone number by analyzing the syntax @param 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". @param [Hash] opts the optional parameters @return [PhoneNumberValidationResponse]

# File lib/cloudmersive-validate-api-client/api/phone_number_api.rb, line 27
def phone_number_syntax_only(value, opts = {})
  data, _status_code, _headers = phone_number_syntax_only_with_http_info(value, opts)
  data
end
phone_number_syntax_only_with_http_info(value, opts = {}) click to toggle source

Validate phone number (basic) Validate a phone number by analyzing the syntax @param value Phone number to validate in a PhoneNumberValidateRequest object. Try a phone number such as "1.800.463.3339&quot;, and either leave DefaultCountryCode blank or use "US&quot;. @param [Hash] opts the optional parameters @return [Array<(PhoneNumberValidationResponse, Fixnum, Hash)>] PhoneNumberValidationResponse data, response status code and response headers

# File lib/cloudmersive-validate-api-client/api/phone_number_api.rb, line 37
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