cloudmersive-validate-api-client 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7135177ad51c8502ae852be5bc3617dc7c2223fc72f6cf73e4f018b536ff3b89
-  data.tar.gz: 4e03d4a5bc7f40e648406778707abf5a24c106ab39d0c7970f6ed696eaf0a196
+  metadata.gz: e6f26be0b3362767667fe698407688872c59b0a2463bfae60d206edecbb785ac
+  data.tar.gz: 6330ac5d1ab93155b4ddc3c5408034a2b2df0d0aa5ac390bb93f0b0683258be7
 SHA512:
-  metadata.gz: c86c6819ed7f137ef233b5a4b0873a213f8474c780f79373d373a364e87a821bec557c91cb629cf9a05580a0a9ac4dd03595d7a748b3130d27858d45bad5cc71
-  data.tar.gz: c49afb5ccd636f80a7527afaa5575dfc3f257d70e33cc1e97dcbbbd544533d3f9bd0c8196120709e09af296eb8559abbf9ae3ade8047321dfbd9c8cf4cf2cab4
+  metadata.gz: 5e1f9c00dce06668b21f3dd359b660f8bb08121d04390dd11cededef5b91935cda7ba9f911244e4c10f2f6560789bb54ea6ece008792a95ea6bb58c4999faf21
+  data.tar.gz: c1c9daac46befe30649f2a04ea95e0720b07b75d27ab4e5142b15999cc12b284e87af465de39edf055572f4e23ecb9d1c4172bfda0f48d01c91a726d2a9270b6

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.3.6
+- Package version: 1.3.7
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-1.3.6.gem
+gem install ./cloudmersive-validate-api-client-1.3.7.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.7.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 1.3.6'
+    gem 'cloudmersive-validate-api-client', '~> 1.3.7'
 
 ### Install from Git
 
@@ -93,6 +93,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
 *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
 *CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
+*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
 *CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
@@ -122,6 +123,8 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
+ - [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
+ - [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
  - [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
  - [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
  - [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)

data/cloudmersive-validate-api-client.gemspec

@@ -8,7 +8,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/docs/AddressGetServersResponse.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**success** | **BOOLEAN** |  | [optional] 
-**servers** | **Array<String>** |  | [optional] 
+**success** | **BOOLEAN** | True if partial address validation was successufl, false otherwise | [optional] 
+**servers** | **Array<String>** | Email servers for this email address | [optional] 
 
 

data/docs/NameApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**name_get_gender**](NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
+[**name_identifier**](NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
 [**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
 [**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
 [**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
@@ -64,6 +65,60 @@ Name | Type | Description  | Notes
 
 
 
+# **name_identifier**
+> ValidateIdentifierResponse name_identifier(input)
+
+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\".
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::NameApi.new
+
+input = CloudmersiveValidateApiClient::ValidateIdentifierRequest.new # ValidateIdentifierRequest | Identifier validation request information
+
+
+begin
+  #Validate a code identifier
+  result = api_instance.name_identifier(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling NameApi->name_identifier: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**ValidateIdentifierRequest**](ValidateIdentifierRequest.md)| Identifier validation request information | 
+
+### Return type
+
+[**ValidateIdentifierResponse**](ValidateIdentifierResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **name_validate_first_name**
 > FirstNameValidationResponse name_validate_first_name(input)
 

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

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**url** | **String** |  | [optional] 
+**url** | **String** | URL to validate | [optional] 
 
 

data/docs/ValidateUrlRequestSyntaxOnly.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**url** | **String** |  | [optional] 
+**url** | **String** | URL to validate | [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
 
@@ -36,6 +36,8 @@ 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'

data/lib/cloudmersive-validate-api-client/api/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/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
 

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

data/lib/cloudmersive-validate-api-client/api/phone_number_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/user_agent_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/vat_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_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
 

data/lib/cloudmersive-validate-api-client/api_error.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/configuration.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/models/address_get_servers_response.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
 
@@ -15,8 +15,10 @@ require 'date'
 module CloudmersiveValidateApiClient
   # Result of a partial email address validation
   class AddressGetServersResponse
+    # True if partial address validation was successufl, false otherwise
     attr_accessor :success
 
+    # Email servers for this email address
     attr_accessor :servers
 
 

data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.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/models/check_response.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