cloudmersive-frauddetection-api-client 2.0.0

data/lib/cloudmersive-frauddetection-api-client/models/advanced_fraud_detection_result.rb

@@ -0,0 +1,266 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveFrauddetectionApiClient
+  # Result of performing an advanced document fraud analysis
+  class AdvancedFraudDetectionResult
+    # True if successful, false otherwise
+    attr_accessor :successful
+
+    # True if the document is clean, false if fraud threats were found
+    attr_accessor :clean_result
+
+    # Overall fraud risk level between 0.0 and 1.0
+    attr_accessor :fraud_risk_level
+
+    # True if the document contains financial liability
+    attr_accessor :contains_financial_liability
+
+    # True if the document contains sensitive data collection from the recipient
+    attr_accessor :contains_sensitive_information_collection
+
+    # True if the document contains an asset transfer
+    attr_accessor :contains_asset_transfer
+
+    # True if the document contains a purchase agreement
+    attr_accessor :contains_purchase_agreement
+
+    # True if the document contains an employment agreement
+    attr_accessor :contains_employment_agreement
+
+    # Rationale on why the document was classified as such
+    attr_accessor :analysis_rationale
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'clean_result' => :'CleanResult',
+        :'fraud_risk_level' => :'FraudRiskLevel',
+        :'contains_financial_liability' => :'ContainsFinancialLiability',
+        :'contains_sensitive_information_collection' => :'ContainsSensitiveInformationCollection',
+        :'contains_asset_transfer' => :'ContainsAssetTransfer',
+        :'contains_purchase_agreement' => :'ContainsPurchaseAgreement',
+        :'contains_employment_agreement' => :'ContainsEmploymentAgreement',
+        :'analysis_rationale' => :'AnalysisRationale'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'clean_result' => :'BOOLEAN',
+        :'fraud_risk_level' => :'Float',
+        :'contains_financial_liability' => :'BOOLEAN',
+        :'contains_sensitive_information_collection' => :'BOOLEAN',
+        :'contains_asset_transfer' => :'BOOLEAN',
+        :'contains_purchase_agreement' => :'BOOLEAN',
+        :'contains_employment_agreement' => :'BOOLEAN',
+        :'analysis_rationale' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'FraudRiskLevel')
+        self.fraud_risk_level = attributes[:'FraudRiskLevel']
+      end
+
+      if attributes.has_key?(:'ContainsFinancialLiability')
+        self.contains_financial_liability = attributes[:'ContainsFinancialLiability']
+      end
+
+      if attributes.has_key?(:'ContainsSensitiveInformationCollection')
+        self.contains_sensitive_information_collection = attributes[:'ContainsSensitiveInformationCollection']
+      end
+
+      if attributes.has_key?(:'ContainsAssetTransfer')
+        self.contains_asset_transfer = attributes[:'ContainsAssetTransfer']
+      end
+
+      if attributes.has_key?(:'ContainsPurchaseAgreement')
+        self.contains_purchase_agreement = attributes[:'ContainsPurchaseAgreement']
+      end
+
+      if attributes.has_key?(:'ContainsEmploymentAgreement')
+        self.contains_employment_agreement = attributes[:'ContainsEmploymentAgreement']
+      end
+
+      if attributes.has_key?(:'AnalysisRationale')
+        self.analysis_rationale = attributes[:'AnalysisRationale']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          clean_result == o.clean_result &&
+          fraud_risk_level == o.fraud_risk_level &&
+          contains_financial_liability == o.contains_financial_liability &&
+          contains_sensitive_information_collection == o.contains_sensitive_information_collection &&
+          contains_asset_transfer == o.contains_asset_transfer &&
+          contains_purchase_agreement == o.contains_purchase_agreement &&
+          contains_employment_agreement == o.contains_employment_agreement &&
+          analysis_rationale == o.analysis_rationale
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, clean_result, fraud_risk_level, contains_financial_liability, contains_sensitive_information_collection, contains_asset_transfer, contains_purchase_agreement, contains_employment_agreement, analysis_rationale].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveFrauddetectionApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-frauddetection-api-client/models/fraud_detection_result.rb

@@ -0,0 +1,256 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveFrauddetectionApiClient
+  # Result of performing fraud detection on a document
+  class FraudDetectionResult
+    # True if successful, false otherwise
+    attr_accessor :successful
+
+    # True if the document is clean, false if fraud threats were found
+    attr_accessor :clean_result
+
+    # Overall fraud risk level between 0.0 and 1.0
+    attr_accessor :fraud_risk_level
+
+    # True if the document contains financial liability
+    attr_accessor :contains_financial_liability
+
+    # True if the document contains sensitive data collection from the recipient
+    attr_accessor :contains_sensitive_information_collection
+
+    # True if the document contains an asset transfer
+    attr_accessor :contains_asset_transfer
+
+    # True if the document contains a purchase agreement
+    attr_accessor :contains_purchase_agreement
+
+    # True if the document contains an employment agreement
+    attr_accessor :contains_employment_agreement
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'clean_result' => :'CleanResult',
+        :'fraud_risk_level' => :'FraudRiskLevel',
+        :'contains_financial_liability' => :'ContainsFinancialLiability',
+        :'contains_sensitive_information_collection' => :'ContainsSensitiveInformationCollection',
+        :'contains_asset_transfer' => :'ContainsAssetTransfer',
+        :'contains_purchase_agreement' => :'ContainsPurchaseAgreement',
+        :'contains_employment_agreement' => :'ContainsEmploymentAgreement'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'clean_result' => :'BOOLEAN',
+        :'fraud_risk_level' => :'Float',
+        :'contains_financial_liability' => :'BOOLEAN',
+        :'contains_sensitive_information_collection' => :'BOOLEAN',
+        :'contains_asset_transfer' => :'BOOLEAN',
+        :'contains_purchase_agreement' => :'BOOLEAN',
+        :'contains_employment_agreement' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'FraudRiskLevel')
+        self.fraud_risk_level = attributes[:'FraudRiskLevel']
+      end
+
+      if attributes.has_key?(:'ContainsFinancialLiability')
+        self.contains_financial_liability = attributes[:'ContainsFinancialLiability']
+      end
+
+      if attributes.has_key?(:'ContainsSensitiveInformationCollection')
+        self.contains_sensitive_information_collection = attributes[:'ContainsSensitiveInformationCollection']
+      end
+
+      if attributes.has_key?(:'ContainsAssetTransfer')
+        self.contains_asset_transfer = attributes[:'ContainsAssetTransfer']
+      end
+
+      if attributes.has_key?(:'ContainsPurchaseAgreement')
+        self.contains_purchase_agreement = attributes[:'ContainsPurchaseAgreement']
+      end
+
+      if attributes.has_key?(:'ContainsEmploymentAgreement')
+        self.contains_employment_agreement = attributes[:'ContainsEmploymentAgreement']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          clean_result == o.clean_result &&
+          fraud_risk_level == o.fraud_risk_level &&
+          contains_financial_liability == o.contains_financial_liability &&
+          contains_sensitive_information_collection == o.contains_sensitive_information_collection &&
+          contains_asset_transfer == o.contains_asset_transfer &&
+          contains_purchase_agreement == o.contains_purchase_agreement &&
+          contains_employment_agreement == o.contains_employment_agreement
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, clean_result, fraud_risk_level, contains_financial_liability, contains_sensitive_information_collection, contains_asset_transfer, contains_purchase_agreement, contains_employment_agreement].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveFrauddetectionApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-frauddetection-api-client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+module CloudmersiveFrauddetectionApiClient
+  VERSION = '2.0.0'
+end

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

@@ -0,0 +1,42 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-frauddetection-api-client/api_client'
+require 'cloudmersive-frauddetection-api-client/api_error'
+require 'cloudmersive-frauddetection-api-client/version'
+require 'cloudmersive-frauddetection-api-client/configuration'
+
+# Models
+require 'cloudmersive-frauddetection-api-client/models/advanced_fraud_detection_result'
+require 'cloudmersive-frauddetection-api-client/models/fraud_detection_result'
+
+# APIs
+require 'cloudmersive-frauddetection-api-client/api/fraud_detection_api'
+
+module CloudmersiveFrauddetectionApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveFrauddetectionApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/fraud_detection_api_spec.rb

@@ -0,0 +1,61 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CloudmersiveFrauddetectionApiClient::FraudDetectionApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FraudDetectionApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveFrauddetectionApiClient::FraudDetectionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FraudDetectionApi' do
+    it 'should create an instance of FraudDetectionApi' do
+      expect(@instance).to be_instance_of(CloudmersiveFrauddetectionApiClient::FraudDetectionApi)
+    end
+  end
+
+  # unit tests for document_detect_fraud
+  # AI Fraud Detection for Documents
+  # Perform fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+  # @return [FraudDetectionResult]
+  describe 'document_detect_fraud test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for document_detect_fraud_advanced
+  # Advanced AI Fraud Detection for Documents
+  # Perform advanced fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_email_address User email address for context (optional)
+  # @option opts [BOOLEAN] :user_email_address_verified True if the user's email address was verified (optional)
+  # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+  # @return [AdvancedFraudDetectionResult]
+  describe 'document_detect_fraud_advanced test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end