visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/reward_points_details.rb

@@ -0,0 +1,141 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # RewardPointsDetails Model.
+  class RewardPointsDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Loyalty points total balance before redemption.
+    # For Example: Points, such as 100
+    # @return [String]
+    attr_accessor :points_before_redemption
+
+    # The total value of loyalty points before redemption in the default
+    # currency. Max characters is 12 excluding the "." symbol
+    # For Example: Points, such as 20.00
+    # @return [String]
+    attr_accessor :points_value_before_redemption
+
+    # Number of loyalty points that were redeemed.
+    # For Example: Points, such as 100
+    # @return [String]
+    attr_accessor :points_redeemed
+
+    # The value of the loyalty points that were redeemed in the default
+    # currency. Max characters is 12 excluding the "." symbol
+    # For Example: Points, such as 100.00
+    # @return [String]
+    attr_accessor :points_value_redeemed
+
+    # Loyalty Points remaining total balance after redemption.
+    # For Example: Points, such as 20.00
+    # @return [String]
+    attr_accessor :points_after_redemption
+
+    # The value of the remaining loyalty points after redumption in the default
+    # currency. Max characters is 12 excluding the "." symbol
+    # For Example: Points, such as 20.00
+    # @return [String]
+    attr_accessor :points_value_after_redemption
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['points_before_redemption'] = 'pointsBeforeRedemption'
+      @_hash['points_value_before_redemption'] = 'pointsValueBeforeRedemption'
+      @_hash['points_redeemed'] = 'pointsRedeemed'
+      @_hash['points_value_redeemed'] = 'pointsValueRedeemed'
+      @_hash['points_after_redemption'] = 'pointsAfterRedemption'
+      @_hash['points_value_after_redemption'] = 'pointsValueAfterRedemption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        points_before_redemption
+        points_value_before_redemption
+        points_redeemed
+        points_value_redeemed
+        points_after_redemption
+        points_value_after_redemption
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(points_before_redemption = SKIP,
+                   points_value_before_redemption = SKIP,
+                   points_redeemed = SKIP, points_value_redeemed = SKIP,
+                   points_after_redemption = SKIP,
+                   points_value_after_redemption = SKIP)
+      @points_before_redemption = points_before_redemption unless points_before_redemption == SKIP
+      unless points_value_before_redemption == SKIP
+        @points_value_before_redemption =
+          points_value_before_redemption
+      end
+      @points_redeemed = points_redeemed unless points_redeemed == SKIP
+      @points_value_redeemed = points_value_redeemed unless points_value_redeemed == SKIP
+      @points_after_redemption = points_after_redemption unless points_after_redemption == SKIP
+      unless points_value_after_redemption == SKIP
+        @points_value_after_redemption =
+          points_value_after_redemption
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      points_before_redemption =
+        hash.key?('pointsBeforeRedemption') ? hash['pointsBeforeRedemption'] : SKIP
+      points_value_before_redemption =
+        hash.key?('pointsValueBeforeRedemption') ? hash['pointsValueBeforeRedemption'] : SKIP
+      points_redeemed =
+        hash.key?('pointsRedeemed') ? hash['pointsRedeemed'] : SKIP
+      points_value_redeemed =
+        hash.key?('pointsValueRedeemed') ? hash['pointsValueRedeemed'] : SKIP
+      points_after_redemption =
+        hash.key?('pointsAfterRedemption') ? hash['pointsAfterRedemption'] : SKIP
+      points_value_after_redemption =
+        hash.key?('pointsValueAfterRedemption') ? hash['pointsValueAfterRedemption'] : SKIP
+
+      # Create object from extracted values.
+      RewardPointsDetails.new(points_before_redemption,
+                              points_value_before_redemption,
+                              points_redeemed,
+                              points_value_redeemed,
+                              points_after_redemption,
+                              points_value_after_redemption)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} points_before_redemption: #{@points_before_redemption},"\
+      " points_value_before_redemption: #{@points_value_before_redemption}, points_redeemed:"\
+      " #{@points_redeemed}, points_value_redeemed: #{@points_value_redeemed},"\
+      " points_after_redemption: #{@points_after_redemption}, points_value_after_redemption:"\
+      " #{@points_value_after_redemption}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} points_before_redemption: #{@points_before_redemption.inspect},"\
+      " points_value_before_redemption: #{@points_value_before_redemption.inspect},"\
+      " points_redeemed: #{@points_redeemed.inspect}, points_value_redeemed:"\
+      " #{@points_value_redeemed.inspect}, points_after_redemption:"\
+      " #{@points_after_redemption.inspect}, points_value_after_redemption:"\
+      " #{@points_value_after_redemption.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/risk_information.rb

@@ -0,0 +1,114 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # This object is only needed when you are requesting both payment and DM
+  # services at same time.
+  class RiskInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifies a risk profile.
+    # @return [Profile]
+    attr_accessor :profile
+
+    # Specifies one of the following types of events:
+    # - login
+    # - account_creation
+    # - account_update
+    # For regular payment transactions, do not send this field.
+    # @return [String]
+    attr_accessor :event_type
+
+    # Specifies one of the following types of events:
+    # - login
+    # - account_creation
+    # - account_update
+    # For regular payment transactions, do not send this field.
+    # @return [BuyerHistory]
+    attr_accessor :buyer_history
+
+    # Specifies one of the following types of events:
+    # - login
+    # - account_creation
+    # - account_update
+    # For regular payment transactions, do not send this field.
+    # @return [Array[AuxiliaryDatum]]
+    attr_accessor :auxiliary_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['profile'] = 'profile'
+      @_hash['event_type'] = 'eventType'
+      @_hash['buyer_history'] = 'buyerHistory'
+      @_hash['auxiliary_data'] = 'auxiliaryData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        profile
+        event_type
+        buyer_history
+        auxiliary_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(profile = SKIP, event_type = SKIP, buyer_history = SKIP,
+                   auxiliary_data = SKIP)
+      @profile = profile unless profile == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @buyer_history = buyer_history unless buyer_history == SKIP
+      @auxiliary_data = auxiliary_data unless auxiliary_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      profile = Profile.from_hash(hash['profile']) if hash['profile']
+      event_type = hash.key?('eventType') ? hash['eventType'] : SKIP
+      buyer_history = BuyerHistory.from_hash(hash['buyerHistory']) if hash['buyerHistory']
+      # Parameter is an array, so we need to iterate through it
+      auxiliary_data = nil
+      unless hash['auxiliaryData'].nil?
+        auxiliary_data = []
+        hash['auxiliaryData'].each do |structure|
+          auxiliary_data << (AuxiliaryDatum.from_hash(structure) if structure)
+        end
+      end
+
+      auxiliary_data = SKIP unless hash.key?('auxiliaryData')
+
+      # Create object from extracted values.
+      RiskInformation.new(profile,
+                          event_type,
+                          buyer_history,
+                          auxiliary_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profile: #{@profile}, event_type: #{@event_type}, buyer_history:"\
+      " #{@buyer_history}, auxiliary_data: #{@auxiliary_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profile: #{@profile.inspect}, event_type: #{@event_type.inspect},"\
+      " buyer_history: #{@buyer_history.inspect}, auxiliary_data: #{@auxiliary_data.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/risk_information1.rb

@@ -0,0 +1,205 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Contains the result of risk assessment.
+  class RiskInformation1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Profile1]
+    attr_accessor :profile
+
+    # TODO: Write general description for this method
+    # @return [Array[Rule]]
+    attr_accessor :rules
+
+    # TODO: Write general description for this method
+    # @return [InfoCodes]
+    attr_accessor :info_codes
+
+    # TODO: Write general description for this method
+    # @return [Velocity]
+    attr_accessor :velocity
+
+    # You receive this field only if you subscribe to the Enhanced Case
+    # Management service. The priority level ranges from 1 (highest) to 5
+    # (lowest); the default value is 3. If you do not assign a priority to your
+    # rules or to your profiles, the default value is given to the order.
+    # For all possible values, see the `decision_case_priority` field
+    # description in the _Decision Manager Using the SCMP API Developer Guide_
+    # on the [Visa Acceptance Business Center.]( Click **Decision Manager** >
+    # **Documentation** > **Guides** > _Decision Manager Using the SCMP API
+    # Developer Guide_ (PDF link).
+    # @return [Integer]
+    attr_accessor :case_priority
+
+    # The customer's local time (`hh:mm:ss`), which is calculated from the
+    # transaction request time and the
+    # customer's billing address.
+    # For details, see the `score_time_local` field description in the _Decision
+    # Manager Using the SCMP API Developer Guide_ on the [Visa Acceptance
+    # Business Center.](
+    # @return [String]
+    attr_accessor :local_time
+
+    # The customer's local time (`hh:mm:ss`), which is calculated from the
+    # transaction request time and the
+    # customer's billing address.
+    # For details, see the `score_time_local` field description in the _Decision
+    # Manager Using the SCMP API Developer Guide_ on the [Visa Acceptance
+    # Business Center.](
+    # @return [Score]
+    attr_accessor :score
+
+    # Contains detailed response information about the customer's IP address.
+    # @return [IpAddress]
+    attr_accessor :ip_address
+
+    # Name of the 3rd party provider, for example, Emailage.
+    # For all possible values, see the `decision_provider_#_name` field
+    # description in the _Decision Manager Using the SCMP API Developer Guide_
+    # on the [Visa Acceptance Business Center.]( Click **Decision Manager** >
+    # **Documentation** > **Guides** > _Decision Manager Using the SCMP API
+    # Developer Guide_ (PDF link).
+    # @return [Hash[String, String]]
+    attr_accessor :providers
+
+    # Name of the 3rd party provider, for example, Emailage.
+    # For all possible values, see the `decision_provider_#_name` field
+    # description in the _Decision Manager Using the SCMP API Developer Guide_
+    # on the [Visa Acceptance Business Center.]( Click **Decision Manager** >
+    # **Documentation** > **Guides** > _Decision Manager Using the SCMP API
+    # Developer Guide_ (PDF link).
+    # @return [Travel]
+    attr_accessor :travel
+
+    # Name of the 3rd party provider, for example, Emailage.
+    # For all possible values, see the `decision_provider_#_name` field
+    # description in the _Decision Manager Using the SCMP API Developer Guide_
+    # on the [Visa Acceptance Business Center.]( Click **Decision Manager** >
+    # **Documentation** > **Guides** > _Decision Manager Using the SCMP API
+    # Developer Guide_ (PDF link).
+    # @return [ProcessorResults]
+    attr_accessor :processor_results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['profile'] = 'profile'
+      @_hash['rules'] = 'rules'
+      @_hash['info_codes'] = 'infoCodes'
+      @_hash['velocity'] = 'velocity'
+      @_hash['case_priority'] = 'casePriority'
+      @_hash['local_time'] = 'localTime'
+      @_hash['score'] = 'score'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['providers'] = 'providers'
+      @_hash['travel'] = 'travel'
+      @_hash['processor_results'] = 'processorResults'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        profile
+        rules
+        info_codes
+        velocity
+        case_priority
+        local_time
+        score
+        ip_address
+        providers
+        travel
+        processor_results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(profile = SKIP, rules = SKIP, info_codes = SKIP,
+                   velocity = SKIP, case_priority = SKIP, local_time = SKIP,
+                   score = SKIP, ip_address = SKIP, providers = SKIP,
+                   travel = SKIP, processor_results = SKIP)
+      @profile = profile unless profile == SKIP
+      @rules = rules unless rules == SKIP
+      @info_codes = info_codes unless info_codes == SKIP
+      @velocity = velocity unless velocity == SKIP
+      @case_priority = case_priority unless case_priority == SKIP
+      @local_time = local_time unless local_time == SKIP
+      @score = score unless score == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @providers = providers unless providers == SKIP
+      @travel = travel unless travel == SKIP
+      @processor_results = processor_results unless processor_results == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      profile = Profile1.from_hash(hash['profile']) if hash['profile']
+      # Parameter is an array, so we need to iterate through it
+      rules = nil
+      unless hash['rules'].nil?
+        rules = []
+        hash['rules'].each do |structure|
+          rules << (Rule.from_hash(structure) if structure)
+        end
+      end
+
+      rules = SKIP unless hash.key?('rules')
+      info_codes = InfoCodes.from_hash(hash['infoCodes']) if hash['infoCodes']
+      velocity = Velocity.from_hash(hash['velocity']) if hash['velocity']
+      case_priority = hash.key?('casePriority') ? hash['casePriority'] : SKIP
+      local_time = hash.key?('localTime') ? hash['localTime'] : SKIP
+      score = Score.from_hash(hash['score']) if hash['score']
+      ip_address = IpAddress.from_hash(hash['ipAddress']) if hash['ipAddress']
+      providers = hash.key?('providers') ? hash['providers'] : SKIP
+      travel = Travel.from_hash(hash['travel']) if hash['travel']
+      processor_results = ProcessorResults.from_hash(hash['processorResults']) if
+        hash['processorResults']
+
+      # Create object from extracted values.
+      RiskInformation1.new(profile,
+                           rules,
+                           info_codes,
+                           velocity,
+                           case_priority,
+                           local_time,
+                           score,
+                           ip_address,
+                           providers,
+                           travel,
+                           processor_results)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profile: #{@profile}, rules: #{@rules}, info_codes: #{@info_codes},"\
+      " velocity: #{@velocity}, case_priority: #{@case_priority}, local_time: #{@local_time},"\
+      " score: #{@score}, ip_address: #{@ip_address}, providers: #{@providers}, travel:"\
+      " #{@travel}, processor_results: #{@processor_results}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profile: #{@profile.inspect}, rules: #{@rules.inspect}, info_codes:"\
+      " #{@info_codes.inspect}, velocity: #{@velocity.inspect}, case_priority:"\
+      " #{@case_priority.inspect}, local_time: #{@local_time.inspect}, score: #{@score.inspect},"\
+      " ip_address: #{@ip_address.inspect}, providers: #{@providers.inspect}, travel:"\
+      " #{@travel.inspect}, processor_results: #{@processor_results.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/risk_information2.rb

@@ -0,0 +1,63 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # RiskInformation2 Model.
+  class RiskInformation2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ProcessorResults1]
+    attr_accessor :processor_results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['processor_results'] = 'processorResults'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        processor_results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(processor_results = SKIP)
+      @processor_results = processor_results unless processor_results == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      processor_results = ProcessorResults1.from_hash(hash['processorResults']) if
+        hash['processorResults']
+
+      # Create object from extracted values.
+      RiskInformation2.new(processor_results)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} processor_results: #{@processor_results}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} processor_results: #{@processor_results.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/risk_information4.rb

@@ -0,0 +1,95 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # RiskInformation4 Model.
+  class RiskInformation4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of filter. Possible values:
+    # - ACCEPT
+    # - PENDING
+    # - DENY
+    # - REPORT
+    # @return [String]
+    attr_accessor :fraud_decision
+
+    # possible values
+    # - AVS_NO_MATCH
+    # - AVS_PARTIAL_MATCH
+    # - AVS_UNAVAILABLE_OR_UNSUPPORTED
+    # - CARD_SECURITY_CODE_MISMATCH
+    # - MAXIMUM_TRANSACTION_AMOUNT
+    # - UNCONFIRMED_ADDRESS
+    # - COUNTRY_MONITOR
+    # - LARGE_ORDER_NUMBER
+    # - BILLING_OR_SHIPPING_ADDRESS_MISMATCH
+    # - RISKY_ZIP_CODE
+    # - SUSPECTED_FREIGHT_FORWARDER_CHECK
+    # - TOTAL_PURCHASE_PRICE_MINIMUM
+    # - IP_ADDRESS_VELOCITY
+    # - RISKY_EMAIL_ADDRESS_DOMAIN_CHECK
+    # - RISKY_BANK_IDENTIFICATION_NUMBER_CHECK,
+    # RISKY_IP_ADDRESS_RANGE
+    # - PAYPAL_FRAUD_MODEL
+    # @return [String]
+    attr_accessor :fraud_decision_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fraud_decision'] = 'fraudDecision'
+      @_hash['fraud_decision_reason'] = 'fraudDecisionReason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fraud_decision
+        fraud_decision_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fraud_decision = SKIP, fraud_decision_reason = SKIP)
+      @fraud_decision = fraud_decision unless fraud_decision == SKIP
+      @fraud_decision_reason = fraud_decision_reason unless fraud_decision_reason == SKIP
+    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_decision = hash.key?('fraudDecision') ? hash['fraudDecision'] : SKIP
+      fraud_decision_reason =
+        hash.key?('fraudDecisionReason') ? hash['fraudDecisionReason'] : SKIP
+
+      # Create object from extracted values.
+      RiskInformation4.new(fraud_decision,
+                           fraud_decision_reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_decision: #{@fraud_decision}, fraud_decision_reason:"\
+      " #{@fraud_decision_reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_decision: #{@fraud_decision.inspect}, fraud_decision_reason:"\
+      " #{@fraud_decision_reason.inspect}>"
+    end
+  end
+end