wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/models/fraud_coverage_type.rb

@@ -0,0 +1,98 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # FraudCoverageType Model.
+  class FraudCoverageType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier code.
+    # @return [String]
+    attr_accessor :code
+
+    # The short description of the code.
+    # @return [String]
+    attr_accessor :short_description
+
+    # The long description of the code.
+    # @return [String]
+    attr_accessor :long_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['short_description'] = 'shortDescription'
+      @_hash['long_description'] = 'longDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        short_description
+        long_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, short_description: SKIP, long_description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @short_description = short_description unless short_description == SKIP
+      @long_description = long_description unless long_description == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      short_description =
+        hash.key?('shortDescription') ? hash['shortDescription'] : SKIP
+      long_description =
+        hash.key?('longDescription') ? hash['longDescription'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudCoverageType.new(code: code,
+                            short_description: short_description,
+                            long_description: long_description,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, short_description: #{@short_description}, long_description:"\
+      " #{@long_description}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, short_description: #{@short_description.inspect},"\
+      " long_description: #{@long_description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_detection_stage.rb

@@ -0,0 +1,98 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # FraudDetectionStage Model.
+  class FraudDetectionStage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier code.
+    # @return [String]
+    attr_accessor :code
+
+    # The short description of the code.
+    # @return [String]
+    attr_accessor :short_description
+
+    # The long description of the code.
+    # @return [String]
+    attr_accessor :long_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['short_description'] = 'shortDescription'
+      @_hash['long_description'] = 'longDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        short_description
+        long_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, short_description: SKIP, long_description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @short_description = short_description unless short_description == SKIP
+      @long_description = long_description unless long_description == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      short_description =
+        hash.key?('shortDescription') ? hash['shortDescription'] : SKIP
+      long_description =
+        hash.key?('longDescription') ? hash['longDescription'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudDetectionStage.new(code: code,
+                              short_description: short_description,
+                              long_description: long_description,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, short_description: #{@short_description}, long_description:"\
+      " #{@long_description}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, short_description: #{@short_description.inspect},"\
+      " long_description: #{@long_description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_fields.rb

@@ -0,0 +1,99 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Metric indicating a transaction's potential fraudulent activity level.
+  class FraudFields < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FraudScore]
+    attr_accessor :fraud_score
+
+    # TODO: Write general description for this method
+    # @return [FraudResponseCode]
+    attr_accessor :fraud_response_code
+
+    # TODO: Write general description for this method
+    # @return [FraudRuleResult]
+    attr_accessor :fraud_rule_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fraud_score'] = 'fraudScore'
+      @_hash['fraud_response_code'] = 'fraudResponseCode'
+      @_hash['fraud_rule_result'] = 'fraudRuleResult'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fraud_score
+        fraud_response_code
+        fraud_rule_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fraud_score: SKIP, fraud_response_code: SKIP,
+                   fraud_rule_result: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fraud_score = fraud_score unless fraud_score == SKIP
+      @fraud_response_code = fraud_response_code unless fraud_response_code == SKIP
+      @fraud_rule_result = fraud_rule_result unless fraud_rule_result == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fraud_score = FraudScore.from_hash(hash['fraudScore']) if hash['fraudScore']
+      fraud_response_code =
+        hash.key?('fraudResponseCode') ? hash['fraudResponseCode'] : SKIP
+      fraud_rule_result =
+        hash.key?('fraudRuleResult') ? hash['fraudRuleResult'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudFields.new(fraud_score: fraud_score,
+                      fraud_response_code: fraud_response_code,
+                      fraud_rule_result: fraud_rule_result,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_score: #{@fraud_score}, fraud_response_code: #{@fraud_response_code},"\
+      " fraud_rule_result: #{@fraud_rule_result}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_score: #{@fraud_score.inspect}, fraud_response_code:"\
+      " #{@fraud_response_code.inspect}, fraud_rule_result: #{@fraud_rule_result.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_fields2.rb

@@ -0,0 +1,99 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # FraudFields2 Model.
+  class FraudFields2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FraudScore]
+    attr_accessor :fraud_score
+
+    # TODO: Write general description for this method
+    # @return [FraudResponseCode]
+    attr_accessor :fraud_response_code
+
+    # TODO: Write general description for this method
+    # @return [FraudRuleResult]
+    attr_accessor :fraud_rule_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fraud_score'] = 'fraudScore'
+      @_hash['fraud_response_code'] = 'fraudResponseCode'
+      @_hash['fraud_rule_result'] = 'fraudRuleResult'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fraud_score
+        fraud_response_code
+        fraud_rule_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fraud_score: SKIP, fraud_response_code: SKIP,
+                   fraud_rule_result: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fraud_score = fraud_score unless fraud_score == SKIP
+      @fraud_response_code = fraud_response_code unless fraud_response_code == SKIP
+      @fraud_rule_result = fraud_rule_result unless fraud_rule_result == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fraud_score = FraudScore.from_hash(hash['fraudScore']) if hash['fraudScore']
+      fraud_response_code =
+        hash.key?('fraudResponseCode') ? hash['fraudResponseCode'] : SKIP
+      fraud_rule_result =
+        hash.key?('fraudRuleResult') ? hash['fraudRuleResult'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudFields2.new(fraud_score: fraud_score,
+                       fraud_response_code: fraud_response_code,
+                       fraud_rule_result: fraud_rule_result,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_score: #{@fraud_score}, fraud_response_code: #{@fraud_response_code},"\
+      " fraud_rule_result: #{@fraud_rule_result}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_score: #{@fraud_score.inspect}, fraud_response_code:"\
+      " #{@fraud_response_code.inspect}, fraud_rule_result: #{@fraud_rule_result.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_fields_fraud_score.rb

@@ -0,0 +1,86 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Fraud score is a measure that helps gauge risk involved with orders before
+  # processing.
+  class FraudFieldsFraudScore < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The starting score for the range for fraud.
+    # @return [Float]
+    attr_accessor :from_score
+
+    # The ending score for the range for fraud.
+    # @return [Float]
+    attr_accessor :to_score
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from_score'] = 'fromScore'
+      @_hash['to_score'] = 'toScore'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        from_score
+        to_score
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_score: SKIP, to_score: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @from_score = from_score unless from_score == SKIP
+      @to_score = to_score unless to_score == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      from_score = hash.key?('fromScore') ? hash['fromScore'] : SKIP
+      to_score = hash.key?('toScore') ? hash['toScore'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudFieldsFraudScore.new(from_score: from_score,
+                                to_score: to_score,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from_score: #{@from_score}, to_score: #{@to_score}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from_score: #{@from_score.inspect}, to_score: #{@to_score.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_response_code.rb

@@ -0,0 +1,52 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Predefined set of codes that classify various types of fraudulent activity.
+  class FraudResponseCode
+    FRAUD_RESPONSE_CODE = [
+      # TODO: Write general description for FRAUD_SYSTEM_APPROVED
+      FRAUD_SYSTEM_APPROVED = 'FRAUD_SYSTEM_APPROVED'.freeze,
+
+      # TODO: Write general description for FRAUD_DECLINE
+      FRAUD_DECLINE = 'FRAUD_DECLINE'.freeze,
+
+      # TODO: Write general description for NO_RESPONSE_FRAUD_SYSTEM_TIMEOUT
+      NO_RESPONSE_FRAUD_SYSTEM_TIMEOUT = 'NO_RESPONSE_FRAUD_SYSTEM_TIMEOUT'.freeze,
+
+      # TODO: Write general description for NO_RESPONSE_COMMUNICATION_ERROR
+      NO_RESPONSE_COMMUNICATION_ERROR = 'NO_RESPONSE_COMMUNICATION_ERROR'.freeze,
+
+      # TODO: Write general description for NO_RESPONSE_FRAUD_SYSTEM_ERROR
+      NO_RESPONSE_FRAUD_SYSTEM_ERROR = 'NO_RESPONSE_FRAUD_SYSTEM_ERROR'.freeze,
+
+      # TODO: Write general description for NO_RESPONSE_AUTH_SYSTEM_ERROR
+      NO_RESPONSE_AUTH_SYSTEM_ERROR = 'NO_RESPONSE_AUTH_SYSTEM_ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FRAUD_SYSTEM_APPROVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fraud_system_approved' then FRAUD_SYSTEM_APPROVED
+      when 'fraud_decline' then FRAUD_DECLINE
+      when 'no_response_fraud_system_timeout' then NO_RESPONSE_FRAUD_SYSTEM_TIMEOUT
+      when 'no_response_communication_error' then NO_RESPONSE_COMMUNICATION_ERROR
+      when 'no_response_fraud_system_error' then NO_RESPONSE_FRAUD_SYSTEM_ERROR
+      when 'no_response_auth_system_error' then NO_RESPONSE_AUTH_SYSTEM_ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_response_code2.rb

@@ -0,0 +1,98 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # FraudResponseCode2 Model.
+  class FraudResponseCode2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier code.
+    # @return [String]
+    attr_accessor :code
+
+    # The short description of the code.
+    # @return [String]
+    attr_accessor :short_description
+
+    # The long description of the code.
+    # @return [String]
+    attr_accessor :long_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['short_description'] = 'shortDescription'
+      @_hash['long_description'] = 'longDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        short_description
+        long_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, short_description: SKIP, long_description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @short_description = short_description unless short_description == SKIP
+      @long_description = long_description unless long_description == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      short_description =
+        hash.key?('shortDescription') ? hash['shortDescription'] : SKIP
+      long_description =
+        hash.key?('longDescription') ? hash['longDescription'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FraudResponseCode2.new(code: code,
+                             short_description: short_description,
+                             long_description: long_description,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, short_description: #{@short_description}, long_description:"\
+      " #{@long_description}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, short_description: #{@short_description.inspect},"\
+      " long_description: #{@long_description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/models/fraud_rule_result.rb

@@ -0,0 +1,49 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The result of the decision made from the Fraud rule applied for the
+  # transaction.
+  class FraudRuleResult
+    FRAUD_RULE_RESULT = [
+      # TODO: Write general description for FRAUD_SIGHT_NOT_INVOKED
+      FRAUD_SIGHT_NOT_INVOKED = 'FRAUD_SIGHT_NOT_INVOKED'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'APPROVED'.freeze,
+
+      # TODO: Write general description for MANUAL_REVIEW
+      MANUAL_REVIEW = 'MANUAL_REVIEW'.freeze,
+
+      # TODO: Write general description for DECLINE
+      DECLINE = 'DECLINE'.freeze,
+
+      # TODO: Write general description for FRAUD_RULE_NOT_INVOKED
+      FRAUD_RULE_NOT_INVOKED = 'FRAUD_RULE_NOT_INVOKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FRAUD_SIGHT_NOT_INVOKED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fraud_sight_not_invoked' then FRAUD_SIGHT_NOT_INVOKED
+      when 'approved' then APPROVED
+      when 'manual_review' then MANUAL_REVIEW
+      when 'decline' then DECLINE
+      when 'fraud_rule_not_invoked' then FRAUD_RULE_NOT_INVOKED
+      else
+        default_value
+      end
+    end
+  end
+end