cloudmersive-validate-api-client 1.3.2 → 1.3.7

data/docs/UserAgentValidateRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::UserAgentValidateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_agent_string** | **String** | The user agent string you wish to parse and validate | [optional] 
+
+

data/docs/UserAgentValidateResponse.md

@@ -0,0 +1,21 @@
+# CloudmersiveValidateApiClient::UserAgentValidateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**is_bot** | **BOOLEAN** | True if the request is a known robot, false otherwise | [optional] 
+**bot_name** | **String** | Optional; name of the robot if the request was from a known robot, otherwise null | [optional] 
+**bot_url** | **String** | Optional; if available, the URL to the robot | [optional] 
+**operating_system** | **String** | Operating System of the User-Agent (e.g. Windows) | [optional] 
+**operating_system_cpu_platform** | **String** | The CPU platform of the User-Agent (e.g. x64) | [optional] 
+**operating_system_version** | **String** | The version of the operating system of the User-Agent (e.g. \"10\" for Windows 10) | [optional] 
+**device_type** | **String** | Device type of the User-Agent; possible values are \"DESKTOP\", \"SMARTPHONE\", \"TABLET\" | [optional] 
+**device_brand_name** | **String** | Brand name of the User-Agent | [optional] 
+**device_model** | **String** | Model name or number of the User-Agent | [optional] 
+**browser_name** | **String** | Name of the Browser | [optional] 
+**browser_version** | **String** | Version of the Browser | [optional] 
+**browser_engine_name** | **String** | Name of the Browser Engine | [optional] 
+**browser_engine_version** | **String** | Version of the Browser Engine | [optional] 
+
+

data/docs/ValidateIdentifierRequest.md

@@ -0,0 +1,15 @@
+# CloudmersiveValidateApiClient::ValidateIdentifierRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **String** | Text string identifier input | [optional] 
+**allow_whitespace** | **BOOLEAN** | True if whitespace is allowed in the identifier, false otherwise | [optional] 
+**allow_hyphens** | **BOOLEAN** | True if hyphens are allowd in the identifier, false otherwise | [optional] 
+**allow_underscore** | **BOOLEAN** | True if underscores are allowed in the identifier, false otherwise | [optional] 
+**allow_numbers** | **BOOLEAN** | True if numbers are allowed in the identifier, false otherwise | [optional] 
+**allow_periods** | **BOOLEAN** | True if periods are allowed in the identifier, false otherwise | [optional] 
+**max_length** | **Integer** | Optional; maximum length, if any, of the identifier | [optional] 
+**min_length** | **Integer** | Optional; minimum length, if any, of the identifier | [optional] 
+
+

data/docs/ValidateIdentifierResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::ValidateIdentifierResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_identifier** | **BOOLEAN** | True if the input identifier is valid, false otherwise | [optional] 
+**error** | **String** | Resulting error from the identifier validation; possible errors are: \"InputIsEmpty\", \"ContainsWhitespace\", \"ContainsNumbers\", \"ContainsHyphen\", \"ContainsUnderscore\", \"ContainsPeriod\", \"TooShort\", \"TooLong\", \"ContainsSpecialCharacters\" | [optional] 
+
+

data/docs/ValidateUrlRequestFull.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::ValidateUrlRequestFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/ValidateUrlRequestSyntaxOnly.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to validate | [optional] 
+
+

data/docs/ValidateUrlResponseFull.md

@@ -0,0 +1,12 @@
+# CloudmersiveValidateApiClient::ValidateUrlResponseFull
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_url** | **BOOLEAN** | True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise | [optional] 
+**valid_syntax** | **BOOLEAN** | True if the URL has valid syntax, false otherwise | [optional] 
+**valid_domain** | **BOOLEAN** | True if the domain name is valid and exists, false otherwise | [optional] 
+**valid_endpoint** | **BOOLEAN** | True if the endpoint is up and responsive and passes a virus scan check, false otherwise | [optional] 
+**well_formed_url** | **String** | Well-formed version of the URL | [optional] 
+
+

data/docs/ValidateUrlResponseSyntaxOnly.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid_url** | **BOOLEAN** | True if the URL is valid, false otherwise | [optional] 
+**well_formed_url** | **String** | Well-formed version of the URL | [optional] 
+
+

data/docs/VatLookupRequest.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**vat_code** | **String** |  | [optional] 
+**vat_code** | **String** | VAT code to lookup; example \"CZ25123891\" | [optional] 
 
 

data/docs/VatLookupResponse.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**country_code** | **String** |  | [optional] 
-**vat_number** | **String** |  | [optional] 
-**is_valid** | **BOOLEAN** |  | [optional] 
-**business_name** | **String** |  | [optional] 
-**business_address** | **String** |  | [optional] 
+**country_code** | **String** | Two-letter country code | [optional] 
+**vat_number** | **String** | VAT number | [optional] 
+**is_valid** | **BOOLEAN** | True if the VAT code is valid, false otherwise | [optional] 
+**business_name** | **String** | Name of the business | [optional] 
+**business_address** | **String** | Business address | [optional] 
 
 

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -30,18 +30,30 @@ require 'cloudmersive-validate-api-client/models/get_gender_request'
 require 'cloudmersive-validate-api-client/models/get_gender_response'
 require 'cloudmersive-validate-api-client/models/last_name_validation_request'
 require 'cloudmersive-validate-api-client/models/last_name_validation_response'
+require 'cloudmersive-validate-api-client/models/parse_address_request'
+require 'cloudmersive-validate-api-client/models/parse_address_response'
 require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
 require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
+require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
+require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
+require 'cloudmersive-validate-api-client/models/validate_identifier_request'
+require 'cloudmersive-validate-api-client/models/validate_identifier_response'
+require 'cloudmersive-validate-api-client/models/validate_url_request_full'
+require 'cloudmersive-validate-api-client/models/validate_url_request_syntax_only'
+require 'cloudmersive-validate-api-client/models/validate_url_response_full'
+require 'cloudmersive-validate-api-client/models/validate_url_response_syntax_only'
 require 'cloudmersive-validate-api-client/models/vat_lookup_request'
 require 'cloudmersive-validate-api-client/models/vat_lookup_response'
 require 'cloudmersive-validate-api-client/models/whois_response'
 
 # APIs
+require 'cloudmersive-validate-api-client/api/address_api'
 require 'cloudmersive-validate-api-client/api/domain_api'
 require 'cloudmersive-validate-api-client/api/email_api'
 require 'cloudmersive-validate-api-client/api/ip_address_api'
 require 'cloudmersive-validate-api-client/api/name_api'
 require 'cloudmersive-validate-api-client/api/phone_number_api'
+require 'cloudmersive-validate-api-client/api/user_agent_api'
 require 'cloudmersive-validate-api-client/api/vat_api'
 
 module CloudmersiveValidateApiClient

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

@@ -0,0 +1,78 @@
+=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.3.1
+
+=end
+
+require "uri"
+
+module CloudmersiveValidateApiClient
+  class AddressApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Parse an unstructured input text string into an international, formatted address
+    # Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
+    # @param input Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [ParseAddressResponse]
+    def address_parse_string(input, opts = {})
+      data, _status_code, _headers = address_parse_string_with_http_info(input, opts)
+      return data
+    end
+
+    # Parse an unstructured input text string into an international, formatted address
+    # Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
+    # @param input Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ParseAddressResponse, Fixnum, Hash)>] ParseAddressResponse data, response status code and response headers
+    def address_parse_string_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AddressApi.address_parse_string ..."
+      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 AddressApi.address_parse_string"
+      end
+      # resource path
+      local_var_path = "/validate/address/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', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # 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 => 'ParseAddressResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#address_parse_string\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/domain_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -129,5 +129,115 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+
+    # Validate a URL fully
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateUrlResponseFull]
+    def domain_url_full(request, opts = {})
+      data, _status_code, _headers = domain_url_full_with_http_info(request, opts)
+      return data
+    end
+
+    # Validate a URL fully
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateUrlResponseFull, Fixnum, Hash)>] ValidateUrlResponseFull data, response status code and response headers
+    def domain_url_full_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DomainApi.domain_url_full ..."
+      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 DomainApi.domain_url_full"
+      end
+      # resource path
+      local_var_path = "/validate/domain/url/full"
+
+      # 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', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # 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 => 'ValidateUrlResponseFull')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_url_full\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Validate a URL syntactically
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity).  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateUrlResponseSyntaxOnly]
+    def domain_url_syntax_only(request, opts = {})
+      data, _status_code, _headers = domain_url_syntax_only_with_http_info(request, opts)
+      return data
+    end
+
+    # Validate a URL syntactically
+    # Validate whether a URL is syntactically valid (does not check endpoint for validity).  Accepts various types of input and produces a well-formed URL as output.
+    # @param request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>] ValidateUrlResponseSyntaxOnly data, response status code and response headers
+    def domain_url_syntax_only_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DomainApi.domain_url_syntax_only ..."
+      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 DomainApi.domain_url_syntax_only"
+      end
+      # resource path
+      local_var_path = "/validate/domain/url/syntax-only"
+
+      # 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', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # 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 => 'ValidateUrlResponseSyntaxOnly')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainApi#domain_url_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/email_api.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -75,6 +75,61 @@ module CloudmersiveValidateApiClient
       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)
+      return 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 \"helloWorld\" but not \"hello*World\".
+    # @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', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # 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