payrix-api-sdk 1.0.0

data/lib/payrix/models/decisions_put_request.rb

@@ -0,0 +1,517 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # DecisionsPutRequest Model.
+  class DecisionsPutRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the Login that owns this decisions resource.
+    # @return [String]
+    attr_accessor :login
+
+    # If this decision resource relates to an Org, then this field stores the
+    # identifier of the Org.
+    # @return [String]
+    attr_accessor :org
+
+    # If this decision resource relates to an Entity, then this field stores the
+    # identifier of the Entity.
+    # @return [String]
+    attr_accessor :entity
+
+    # The identifier of a linked decision resource that acts in coordination
+    # with this decision. When you define a decision attribute here, the
+    # referenced decision becomes the 'parent' resource. The action field set on
+    # the 'parent' resource determines the action that occurs if all of the
+    # linked decisions fail.
+    # @return [String]
+    attr_accessor :decision
+
+    # Identifier of the division to which the decision resource belongs.
+    # @return [String]
+    attr_accessor :division
+
+    # Identifier of the partition to which the decision resource belongs.
+    # @return [String]
+    attr_accessor :partition
+
+    # Where the action defined by this DecisionAction should apply.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `account` - **Account type Decision.**
+    # - `txn` - **Txn type Decision.**
+    # - `entity` - **Entity type Decision.**
+    # </details>
+    # @return [ApplicationEnum]
+    attr_accessor :application
+
+    # The levels of decision admin, merchant, division, partition.
+    # @return [String]
+    attr_accessor :level
+
+    # The type of check to perform.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `merchantFailureLimit` - **Exceeded the maximum number of allowed failed
+    # authorizations.**
+    # - `merchantFailureRatio` - **Exceeded the maximum ratio of allowed failed
+    # authorizations.**
+    # - `saleTotalLimit` - **Exceeded the maximum allowed sale total value.**
+    # - `refundTotalLimit` - **Exceeded the maximum allowed refund total
+    # value.**
+    # - `averageSaleCountLimit` - **Exceeded the allowed maximum payment size
+    # (individual transaction amount).**
+    # - `merchantRefundSaleRatio` - **Exceeded the maximum allowed ratio of
+    # refunds to sales.**
+    # - `merchantPaymentSuccessLimit` - **This is used to check if the merchant
+    # has charged the same payment more than X times on a given period of
+    # time.**
+    # - `ipFailureLimit` - **Exceeded the maximum allowed number of failed
+    # authorizations for a particular IP address.**
+    # - `ipFailureRatio` - **Exceeded the maximum allowed ratio of failed
+    # authorizations for a particular IP address.**
+    # - `inactiveMerchant` - **The Merchant is not active.**
+    # - `merchantPaymentFailureLimit` - **Exceeded the maximum allowed number of
+    # failed transactions.**
+    # - `merchantCaptureWithoutAuthLimit` - **Exceeded the maximum allowed
+    # number of transactions without authorizations.**
+    # - `refundWithoutSale` - **Refund transaction does not have an associated
+    # sale transaction.**
+    # - `refundWithoutSaleLimit` - **Exceeded the maximum number of refund
+    # transactions that do not have associated sale transactions.**
+    # - `captureAboveAuthLimit` - **Exceeded the maximum authorized value for
+    # transactions with failed authorizations.**
+    # - `fraudScore` - **Transaction fraud score.**
+    # - `cvv` - **CVV.**
+    # - `avs` - **AVS.**
+    # - `aavs` - **AAVS.**
+    # - `duplicateTxn` - **Duplicate transaction.**
+    # - `merchantMatch` - **Transaction matches merchant details.**
+    # - `currencyConversion` - **Transaction triggers currency conversion.**
+    # - `settledCurrencyMismatch` - **Transaction settled currency mismatch.**
+    # - `initialTxn` - **Initial transaction of this type.**
+    # - `similarTotalLimit` - **Exceeded the limit of transactions with equal
+    # totals.**
+    # - `similarTotalRatio` - **Exceeded the ratio of transactions with equal
+    # totals.**
+    # - `saleTotalMinimum` - **Minimum transaction amount.**
+    # - `limit` - **Exceeded the maximum allowed number of authorizations.**
+    # - `ratio` - **This is used to check if similar transactions have reached
+    # the ratio of auth transactions in a given period of time.**
+    # - `txnWatchlist` - **Check the transaction data against a custom
+    # watchlist.**
+    # - `balanceRefundLimit` - **This is used to check if a merchant has enough
+    # balance to process a REFUND transaction and it is within the scope of the
+    # threshold.**
+    # </details>
+    # @return [DecisionTypeEnum]
+    attr_accessor :type
+
+    # The target that this decision should apply at.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `activation` - **Terminal activation.**
+    # - `auth` - **Apply this decision during transaction authorization.**
+    # - `postauth` - **Immediately after authorization.**
+    # - `capture` - **Apply this decision during transaction capture.**
+    # - `refund` - **Apply this decision when processing a refund.**
+    # - `createEntity` - **createEntity. Process decisions during entity
+    # creation.**
+    # - `underwriting` - **Underwriting. Check the members before they are
+    # boarded.**
+    # - `preboard` - **Preboard. Check the Merchant before they are boarded.**
+    # - `postboard` - **Check the Merchant after they are boarded.**
+    # - `txn` - **Check the Merchant when they process a Transaction.**
+    # - `txnVolume` - **Check the Merchant when their transaction volume hits a
+    # certain amount.**
+    # - `payout` - **Check the Merchant when a Payout occurs.**
+    # - `payoutVolume` - **Check the Merchant when the volume of Payouts to the
+    # Merchant hits a certain amount.**
+    # </details>
+    # @return [TargetEnum]
+    attr_accessor :target
+
+    # The action to take when this check fails.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **No action.**
+    # - `1` - **Block txn, will never be processed. The Entity is sent to the
+    # manual review queue.**
+    # - `3` - **Hold txn, will not be captured.**
+    # - `4` - **Reserve txn, funds should be reserved.**
+    # - `5` - **Block current activity, no change for merchant.**
+    # - `6` - **Passed decision(s). Will not be set anywhere, will only be used
+    # for integration purposes.**
+    # - `7` - **We did not have policies to process.**
+    # - `8` - **We onboard the merchant and wait for manual check later.**
+    # - `9` - **Schedule the automatic release of the reserve.**
+    # - `10` - **Hold txn, will not be captured. Automatic release when the
+    # associated sale is done.**
+    # </details>
+    # @return [DescisionActionEnum]
+    attr_accessor :action
+
+    # A sequence number to use when applying multiple linked decisions: When two
+    # or more decisions are linked using their 'decision' fields, the checks
+    # with lower 'sequence' numbers are applied first; this field is specified
+    # as an integer.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The minimum value that the Transaction must be to target this decision,
+    # The unit of measure is determined by the type of check.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The amount that the associated Transaction should be compared against. The
+    # units for this field depend on the type of check: for checks that are
+    # based on a ratio, specify the amount as a percentage in basis points; for
+    # checks that are based on a dollar amount, specify the amount in cents; for
+    # checks that are based on a count, specify the exact value as an integer.
+    # @return [String]
+    attr_accessor :value
+
+    # A date indicator that determines how far back in time time-based checks
+    # should be checked. This field works in conjunction with the 'periodFactor'
+    # field, which multiplies this basic period.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `days` - **Days. The basic value for the date range is set in days.**
+    # - `weeks` - **Weeks. The basic value for the date range is set in weeks.**
+    # - `months` - **Months. The basic value for the date range is set in
+    # months.**
+    # - `years` - **Years. The basic value for the date range is set in years.**
+    # - `seconds` - **Seconds. The basic value for the date range is set in
+    # seconds.**
+    # - `minutes` - **Minutes. The basic value for the date range is set in
+    # minutes.**
+    # - `hours` - **Hours. The basic value for the date range is set in hours.**
+    # </details>
+    # @return [PeriodEnum]
+    attr_accessor :period
+
+    # A multiplier that you can use to adjust the basic date range set in the
+    # 'period' field, such as daily, weekly, monthly, or annually; this field is
+    # specified as an integer and its value determines how the interval is
+    # multiplied.
+    # @return [Integer]
+    attr_accessor :period_factor
+
+    # The schedule that determines when this Decision is triggered to check
+    # entities.
+    # @return [String]
+    attr_accessor :schedule
+
+    # A multiplier that you can use to adjust the schedule set in the 'schedule'
+    # field, if it is set to a duration-based trigger, such as daily, weekly,
+    # monthly, or annually. This field is specified as an integer and its value
+    # determines how the interval is multiplied.
+    # @return [Integer]
+    attr_accessor :schedule_factor
+
+    # The date on which checking of the Decision should start is specified as an
+    # eight digit string in YYYYMMDD format, for example, '20160120' for January
+    # 20, 2016; the value of this field must represent a date in the future, or
+    # the present date.
+    # @return [Integer]
+    attr_accessor :start
+
+    # The date on which checking of the Decision should end. The date is
+    # specified as an eight digit string in YYYYMMDD format, for example,
+    # '20160120' for January 20, 2016. The value of this field must represent a
+    # date in the future.
+    # @return [Integer]
+    attr_accessor :finish
+
+    # A lower cut-off value for the score in this decision; the check fails if
+    # the score is equal to or below this value.
+    # @return [Integer]
+    attr_accessor :low
+
+    # An upper cut-off value for the score in this decision; the check fails if
+    # the score is equal to or above this value.
+    # @return [Integer]
+    attr_accessor :high
+
+    # Whether to check for and use existing Verifications and Verification
+    # Results for this decision.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [UseCacheEnum]
+    attr_accessor :use_cache
+
+    # The time caching limit to check for existing verification.
+    # @return [Integer]
+    attr_accessor :cache_time
+
+    # The options for the Verification are specified as a sum of the desired
+    # options.
+    # @return [Integer]
+    attr_accessor :options
+
+    # The additionalOptions for the Verification are specified as a sum of the
+    # desired options.
+    # @return [Integer]
+    attr_accessor :additional_options
+
+    # The error message for the decision: If the field is null the error message
+    # will be a generic failure message, if the field is empty the error message
+    # will be a specific error message, if the field is set to a string the
+    # error message will be that string.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The reason for the decision. If the field is null the error message will
+    # be a generic message, if the field is set to a string the reason message
+    # will be that string.
+    # @return [String]
+    attr_accessor :reason
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['login'] = 'login'
+      @_hash['org'] = 'org'
+      @_hash['entity'] = 'entity'
+      @_hash['decision'] = 'decision'
+      @_hash['division'] = 'division'
+      @_hash['partition'] = 'partition'
+      @_hash['application'] = 'application'
+      @_hash['level'] = 'level'
+      @_hash['type'] = 'type'
+      @_hash['target'] = 'target'
+      @_hash['action'] = 'action'
+      @_hash['sequence'] = 'sequence'
+      @_hash['amount'] = 'amount'
+      @_hash['value'] = 'value'
+      @_hash['period'] = 'period'
+      @_hash['period_factor'] = 'periodFactor'
+      @_hash['schedule'] = 'schedule'
+      @_hash['schedule_factor'] = 'scheduleFactor'
+      @_hash['start'] = 'start'
+      @_hash['finish'] = 'finish'
+      @_hash['low'] = 'low'
+      @_hash['high'] = 'high'
+      @_hash['use_cache'] = 'useCache'
+      @_hash['cache_time'] = 'cacheTime'
+      @_hash['options'] = 'options'
+      @_hash['additional_options'] = 'additionalOptions'
+      @_hash['error_message'] = 'errorMessage'
+      @_hash['reason'] = 'reason'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        login
+        org
+        entity
+        decision
+        division
+        partition
+        application
+        level
+        type
+        target
+        action
+        sequence
+        amount
+        value
+        period
+        period_factor
+        schedule
+        schedule_factor
+        start
+        finish
+        low
+        high
+        use_cache
+        cache_time
+        options
+        additional_options
+        error_message
+        reason
+        inactive
+        frozen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(login = SKIP, org = SKIP, entity = SKIP, decision = SKIP,
+                   division = SKIP, partition = SKIP, application = SKIP,
+                   level = SKIP, type = SKIP, target = SKIP, action = SKIP,
+                   sequence = SKIP, amount = SKIP, value = SKIP, period = SKIP,
+                   period_factor = SKIP, schedule = SKIP,
+                   schedule_factor = SKIP, start = SKIP, finish = SKIP,
+                   low = SKIP, high = SKIP, use_cache = SKIP, cache_time = SKIP,
+                   options = SKIP, additional_options = SKIP,
+                   error_message = SKIP, reason = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN)
+      @login = login unless login == SKIP
+      @org = org unless org == SKIP
+      @entity = entity unless entity == SKIP
+      @decision = decision unless decision == SKIP
+      @division = division unless division == SKIP
+      @partition = partition unless partition == SKIP
+      @application = application unless application == SKIP
+      @level = level unless level == SKIP
+      @type = type unless type == SKIP
+      @target = target unless target == SKIP
+      @action = action unless action == SKIP
+      @sequence = sequence unless sequence == SKIP
+      @amount = amount unless amount == SKIP
+      @value = value unless value == SKIP
+      @period = period unless period == SKIP
+      @period_factor = period_factor unless period_factor == SKIP
+      @schedule = schedule unless schedule == SKIP
+      @schedule_factor = schedule_factor unless schedule_factor == SKIP
+      @start = start unless start == SKIP
+      @finish = finish unless finish == SKIP
+      @low = low unless low == SKIP
+      @high = high unless high == SKIP
+      @use_cache = use_cache unless use_cache == SKIP
+      @cache_time = cache_time unless cache_time == SKIP
+      @options = options unless options == SKIP
+      @additional_options = additional_options unless additional_options == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @reason = reason unless reason == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == 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.
+      login = hash.key?('login') ? hash['login'] : SKIP
+      org = hash.key?('org') ? hash['org'] : SKIP
+      entity = hash.key?('entity') ? hash['entity'] : SKIP
+      decision = hash.key?('decision') ? hash['decision'] : SKIP
+      division = hash.key?('division') ? hash['division'] : SKIP
+      partition = hash.key?('partition') ? hash['partition'] : SKIP
+      application = hash.key?('application') ? hash['application'] : SKIP
+      level = hash.key?('level') ? hash['level'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      target = hash.key?('target') ? hash['target'] : SKIP
+      action = hash.key?('action') ? hash['action'] : SKIP
+      sequence = hash.key?('sequence') ? hash['sequence'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      period = hash.key?('period') ? hash['period'] : SKIP
+      period_factor = hash.key?('periodFactor') ? hash['periodFactor'] : SKIP
+      schedule = hash.key?('schedule') ? hash['schedule'] : SKIP
+      schedule_factor =
+        hash.key?('scheduleFactor') ? hash['scheduleFactor'] : SKIP
+      start = hash.key?('start') ? hash['start'] : SKIP
+      finish = hash.key?('finish') ? hash['finish'] : SKIP
+      low = hash.key?('low') ? hash['low'] : SKIP
+      high = hash.key?('high') ? hash['high'] : SKIP
+      use_cache = hash.key?('useCache') ? hash['useCache'] : SKIP
+      cache_time = hash.key?('cacheTime') ? hash['cacheTime'] : SKIP
+      options = hash.key?('options') ? hash['options'] : SKIP
+      additional_options =
+        hash.key?('additionalOptions') ? hash['additionalOptions'] : SKIP
+      error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+
+      # Create object from extracted values.
+      DecisionsPutRequest.new(login,
+                              org,
+                              entity,
+                              decision,
+                              division,
+                              partition,
+                              application,
+                              level,
+                              type,
+                              target,
+                              action,
+                              sequence,
+                              amount,
+                              value,
+                              period,
+                              period_factor,
+                              schedule,
+                              schedule_factor,
+                              start,
+                              finish,
+                              low,
+                              high,
+                              use_cache,
+                              cache_time,
+                              options,
+                              additional_options,
+                              error_message,
+                              reason,
+                              inactive,
+                              frozen)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} login: #{@login}, org: #{@org}, entity: #{@entity}, decision: #{@decision},"\
+      " division: #{@division}, partition: #{@partition}, application: #{@application}, level:"\
+      " #{@level}, type: #{@type}, target: #{@target}, action: #{@action}, sequence: #{@sequence},"\
+      " amount: #{@amount}, value: #{@value}, period: #{@period}, period_factor:"\
+      " #{@period_factor}, schedule: #{@schedule}, schedule_factor: #{@schedule_factor}, start:"\
+      " #{@start}, finish: #{@finish}, low: #{@low}, high: #{@high}, use_cache: #{@use_cache},"\
+      " cache_time: #{@cache_time}, options: #{@options}, additional_options:"\
+      " #{@additional_options}, error_message: #{@error_message}, reason: #{@reason}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} login: #{@login.inspect}, org: #{@org.inspect}, entity: #{@entity.inspect},"\
+      " decision: #{@decision.inspect}, division: #{@division.inspect}, partition:"\
+      " #{@partition.inspect}, application: #{@application.inspect}, level: #{@level.inspect},"\
+      " type: #{@type.inspect}, target: #{@target.inspect}, action: #{@action.inspect}, sequence:"\
+      " #{@sequence.inspect}, amount: #{@amount.inspect}, value: #{@value.inspect}, period:"\
+      " #{@period.inspect}, period_factor: #{@period_factor.inspect}, schedule:"\
+      " #{@schedule.inspect}, schedule_factor: #{@schedule_factor.inspect}, start:"\
+      " #{@start.inspect}, finish: #{@finish.inspect}, low: #{@low.inspect}, high:"\
+      " #{@high.inspect}, use_cache: #{@use_cache.inspect}, cache_time: #{@cache_time.inspect},"\
+      " options: #{@options.inspect}, additional_options: #{@additional_options.inspect},"\
+      " error_message: #{@error_message.inspect}, reason: #{@reason.inspect}, inactive:"\
+      " #{@inactive.inspect}, frozen: #{@frozen.inspect}>"
+    end
+  end
+end