cloudmersive-validate-api-client 2.0.3 → 2.0.4

data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb

@@ -0,0 +1,75 @@
+=begin
+#validateapi
+
+#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.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveValidateApiClient
+  class LeadEnrichmentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Enrich an input lead with additional fields of data
+    # @param request Input lead with known fields set, and unknown fields left blank (null)
+    # @param [Hash] opts the optional parameters
+    # @return [LeadEnrichmentResponse]
+    def lead_enrichment_enrich_lead(request, opts = {})
+      data, _status_code, _headers = lead_enrichment_enrich_lead_with_http_info(request, opts)
+      data
+    end
+
+    # Enrich an input lead with additional fields of data
+    # @param request Input lead with known fields set, and unknown fields left blank (null)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LeadEnrichmentResponse, Fixnum, Hash)>] LeadEnrichmentResponse data, response status code and response headers
+    def lead_enrichment_enrich_lead_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LeadEnrichmentApi.lead_enrichment_enrich_lead ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling LeadEnrichmentApi.lead_enrichment_enrich_lead"
+      end
+      # resource path
+      local_var_path = '/validate/lead-enrichment/lead/enrich'
+
+      # 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(request)
+      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 => 'LeadEnrichmentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LeadEnrichmentApi#lead_enrichment_enrich_lead\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cloudmersive-validate-api-client/api/name_api.rb

@@ -0,0 +1,293 @@
+=begin
+#validateapi
+
+#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.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveValidateApiClient
+  class NameApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the gender of a first name
+    # Determines the gender of a first name (given name)
+    # @param input Gender request information
+    # @param [Hash] opts the optional parameters
+    # @return [GetGenderResponse]
+    def name_get_gender(input, opts = {})
+      data, _status_code, _headers = name_get_gender_with_http_info(input, opts)
+      data
+    end
+
+    # Get the gender of a first name
+    # Determines the gender of a first name (given name)
+    # @param input Gender request information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetGenderResponse, Fixnum, Hash)>] GetGenderResponse data, response status code and response headers
+    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
+    # 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\".
+    # @param input Identifier validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateIdentifierResponse]
+    def name_identifier(input, opts = {})
+      data, _status_code, _headers = name_identifier_with_http_info(input, opts)
+      data
+    end
+
+    # 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;.
+    # @param input Identifier validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateIdentifierResponse, Fixnum, Hash)>] ValidateIdentifierResponse data, response status code and response headers
+    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
+    # Validate a first name
+    # Determines if a string is a valid first name (given name)
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [FirstNameValidationResponse]
+    def name_validate_first_name(input, opts = {})
+      data, _status_code, _headers = name_validate_first_name_with_http_info(input, opts)
+      data
+    end
+
+    # Validate a first name
+    # Determines if a string is a valid first name (given name)
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FirstNameValidationResponse, Fixnum, Hash)>] FirstNameValidationResponse data, response status code and response headers
+    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
+    # 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
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [FullNameValidationResponse]
+    def name_validate_full_name(input, opts = {})
+      data, _status_code, _headers = name_validate_full_name_with_http_info(input, opts)
+      data
+    end
+
+    # 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
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FullNameValidationResponse, Fixnum, Hash)>] FullNameValidationResponse data, response status code and response headers
+    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
+    # Validate a last name
+    # Determines if a string is a valid last name (surname)
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [LastNameValidationResponse]
+    def name_validate_last_name(input, opts = {})
+      data, _status_code, _headers = name_validate_last_name_with_http_info(input, opts)
+      data
+    end
+
+    # Validate a last name
+    # Determines if a string is a valid last name (surname)
+    # @param input Validation request information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LastNameValidationResponse, Fixnum, Hash)>] LastNameValidationResponse data, response status code and response headers
+    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
+  end
+end

data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb

@@ -0,0 +1,77 @@
+=begin
+#validateapi
+
+#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.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveValidateApiClient
+  class PhoneNumberApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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]
+    def phone_number_syntax_only(value, opts = {})
+      data, _status_code, _headers = phone_number_syntax_only_with_http_info(value, opts)
+      data
+    end
+
+    # 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 [Array<(PhoneNumberValidationResponse, Fixnum, Hash)>] PhoneNumberValidationResponse data, response status code and response headers
+    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
+  end
+end

data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb

@@ -0,0 +1,77 @@
+=begin
+#validateapi
+
+#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.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveValidateApiClient
+  class UserAgentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Parse an HTTP User-Agent string, identify robots
+    # Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [UserAgentValidateResponse]
+    def user_agent_parse(request, opts = {})
+      data, _status_code, _headers = user_agent_parse_with_http_info(request, opts)
+      data
+    end
+
+    # Parse an HTTP User-Agent string, identify robots
+    # Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
+    # @param request Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserAgentValidateResponse, Fixnum, Hash)>] UserAgentValidateResponse data, response status code and response headers
+    def user_agent_parse_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserAgentApi.user_agent_parse ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling UserAgentApi.user_agent_parse"
+      end
+      # resource path
+      local_var_path = '/validate/useragent/parse'
+
+      # 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(request)
+      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 => 'UserAgentValidateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserAgentApi#user_agent_parse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end