adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/split_configuration.rb

@@ -0,0 +1,90 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SplitConfiguration Model.
+  class SplitConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your description for the split configuration.
+    # @return [String]
+    attr_accessor :description
+
+    # Array of rules that define the split configuration behavior.
+    # @return [Array[SplitConfigurationRule]]
+    attr_accessor :rules
+
+    # Unique identifier of the split configuration.
+    # @return [String]
+    attr_accessor :split_configuration_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['rules'] = 'rules'
+      @_hash['split_configuration_id'] = 'splitConfigurationId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        split_configuration_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description:, rules:, split_configuration_id: SKIP)
+      @description = description
+      @rules = rules
+      @split_configuration_id = split_configuration_id unless split_configuration_id == 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.
+      description = hash.key?('description') ? hash['description'] : nil
+      # Parameter is an array, so we need to iterate through it
+      rules = nil
+      unless hash['rules'].nil?
+        rules = []
+        hash['rules'].each do |structure|
+          rules << (SplitConfigurationRule.from_hash(structure) if structure)
+        end
+      end
+
+      rules = nil unless hash.key?('rules')
+      split_configuration_id =
+        hash.key?('splitConfigurationId') ? hash['splitConfigurationId'] : SKIP
+
+      # Create object from extracted values.
+      SplitConfiguration.new(description: description,
+                             rules: rules,
+                             split_configuration_id: split_configuration_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, rules: #{@rules}, split_configuration_id:"\
+      " #{@split_configuration_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, rules: #{@rules.inspect},"\
+      " split_configuration_id: #{@split_configuration_id.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/split_configuration_list.rb

@@ -0,0 +1,72 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SplitConfigurationList Model.
+  class SplitConfigurationList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of split configurations applied to the stores under the merchant
+    # account.
+    # @return [Array[SplitConfiguration]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data: SKIP)
+      @data = data unless 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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (SplitConfiguration.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # Create object from extracted values.
+      SplitConfigurationList.new(data: data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/split_configuration_logic.rb

@@ -0,0 +1,313 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SplitConfigurationLogic Model.
+  class SplitConfigurationLogic < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deducts the acquiring fees (the aggregated amount of interchange and
+    # scheme fee) from the specified balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [AcquiringFees]
+    attr_accessor :acquiring_fees
+
+    # Defines whether to book an additional commission for payments to your
+    # user's balance account. The commission amount can be defined as a fixed
+    # amount (specified in minor units), a percentage (specified in basis
+    # points), or both.
+    # @return [AdditionalCommission1]
+    attr_accessor :additional_commission
+
+    # Deducts the transaction fee due to Adyen under [blended
+    # rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/
+    # get-the-best-from-your-card-processing) from the specified balance
+    # account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [AdyenCommission]
+    attr_accessor :adyen_commission
+
+    # Deducts the fees due to Adyen (markup or commission) from the specified
+    # balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [AdyenFees]
+    attr_accessor :adyen_fees
+
+    # Deducts the transaction fee due to Adyen under [Interchange ++
+    # pricing](https://www.adyen.com/what-is-interchange) from the specified
+    # balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [AdyenMarkup]
+    attr_accessor :adyen_markup
+
+    # Specifies how and from which balance account(s) to deduct the chargeback
+    # amount.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
+    # @return [Behavior]
+    attr_accessor :chargeback
+
+    # Deducts the chargeback costs from the specified balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**
+    # @return [ChargebackCostAllocation]
+    attr_accessor :chargeback_cost_allocation
+
+    # Defines your platform's commission for the processed payments as a fixed
+    # amount (specified in minor units), a percentage (specified in basis
+    # points), or both. The commission is booked to your platform's liable
+    # balance account.
+    # @return [Commission1]
+    attr_accessor :commission
+
+    # Deducts the interchange fee from specified balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [Interchange]
+    attr_accessor :interchange
+
+    # Deducts all transaction fees incurred by the payment from the specified
+    # balance account. The transaction fees include the acquiring fees
+    # (interchange and scheme fee), and the fees due to Adyen (markup or
+    # commission). You can book any and all these fees to different balance
+    # account by specifying other transaction fee parameters in your split
+    # configuration profile:
+    # -
+    # [`adyenCommission`](https://docs.adyen.com/api-explorer/Management/latest/
+    # post/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-a
+    # dyenCommission): The transaction fee due to Adyen under [blended
+    # rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained#inte
+    # rchange-vs-blended).
+    # -
+    # [`adyenMarkup`](https://docs.adyen.com/api-explorer/Management/latest/post
+    # /merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyen
+    # Markup): The transaction fee due to Adyen under [Interchange ++
+    # pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained#in
+    # terchange-vs-blended).
+    # -
+    # [`schemeFee`](https://docs.adyen.com/api-explorer/Management/latest/post/m
+    # erchants/(merchantId)/splitConfigurations#request-rules-splitLogic-schemeF
+    # ee): The fee paid to the card scheme for using their network.
+    # -
+    # [`interchange`](https://docs.adyen.com/api-explorer/Management/latest/post
+    # /merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-inter
+    # change): The fee paid to the issuer for each payment transaction made with
+    # the card network.
+    # -
+    # [`adyenFees`](https://docs.adyen.com/api-explorer/Management/latest/post/m
+    # erchants/(merchantId)/splitConfigurations#request-rules-splitLogic-adyenFe
+    # es): The aggregated amount of Adyen's commission and markup.
+    # -
+    # [`acquiringFees`](https://docs.adyen.com/api-explorer/Management/latest/po
+    # st/merchants/(merchantId)/splitConfigurations#request-rules-splitLogic-acq
+    # uiringFees): The aggregated amount of the interchange and scheme fees.
+    # If you don't include at least one transaction fee type in the `splitLogic`
+    # object, Adyen updates the payment request with the `paymentFee` parameter,
+    # booking all transaction fees to your platform's liable balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [PaymentFee]
+    attr_accessor :payment_fee
+
+    # Specifies how and from which balance account(s) to deduct the refund
+    # amount.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**
+    # @return [Behavior]
+    attr_accessor :refund
+
+    # Deducts the refund costs from the specified balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**
+    # @return [RefundCostAllocation]
+    attr_accessor :refund_cost_allocation
+
+    # Books the amount left over after currency conversion to the specified
+    # balance account.
+    # Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
+    # @return [Remainder]
+    attr_accessor :remainder
+
+    # Deducts the scheme fee from the specified balance account.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**.
+    # @return [SchemeFee]
+    attr_accessor :scheme_fee
+
+    # Unique identifier of the collection of split instructions that are applied
+    # when the rule conditions are met.
+    # @return [String]
+    attr_accessor :split_logic_id
+
+    # Books the surcharge amount to the specified balance account.
+    # Possible values: **addToLiableAccount**, **addToOneBalanceAccount**
+    # @return [Surcharge3]
+    attr_accessor :surcharge
+
+    # Books the tips (gratuity) to the specified balance account.
+    # Possible values: **addToLiableAccount**, **addToOneBalanceAccount**.
+    # @return [Tip]
+    attr_accessor :tip
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['acquiring_fees'] = 'acquiringFees'
+      @_hash['additional_commission'] = 'additionalCommission'
+      @_hash['adyen_commission'] = 'adyenCommission'
+      @_hash['adyen_fees'] = 'adyenFees'
+      @_hash['adyen_markup'] = 'adyenMarkup'
+      @_hash['chargeback'] = 'chargeback'
+      @_hash['chargeback_cost_allocation'] = 'chargebackCostAllocation'
+      @_hash['commission'] = 'commission'
+      @_hash['interchange'] = 'interchange'
+      @_hash['payment_fee'] = 'paymentFee'
+      @_hash['refund'] = 'refund'
+      @_hash['refund_cost_allocation'] = 'refundCostAllocation'
+      @_hash['remainder'] = 'remainder'
+      @_hash['scheme_fee'] = 'schemeFee'
+      @_hash['split_logic_id'] = 'splitLogicId'
+      @_hash['surcharge'] = 'surcharge'
+      @_hash['tip'] = 'tip'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        acquiring_fees
+        additional_commission
+        adyen_commission
+        adyen_fees
+        adyen_markup
+        chargeback
+        chargeback_cost_allocation
+        interchange
+        payment_fee
+        refund
+        refund_cost_allocation
+        remainder
+        scheme_fee
+        split_logic_id
+        surcharge
+        tip
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(commission:, acquiring_fees: SKIP,
+                   additional_commission: SKIP, adyen_commission: SKIP,
+                   adyen_fees: SKIP, adyen_markup: SKIP, chargeback: SKIP,
+                   chargeback_cost_allocation: SKIP, interchange: SKIP,
+                   payment_fee: SKIP, refund: SKIP,
+                   refund_cost_allocation: SKIP, remainder: SKIP,
+                   scheme_fee: SKIP, split_logic_id: SKIP, surcharge: SKIP,
+                   tip: SKIP)
+      @acquiring_fees = acquiring_fees unless acquiring_fees == SKIP
+      @additional_commission = additional_commission unless additional_commission == SKIP
+      @adyen_commission = adyen_commission unless adyen_commission == SKIP
+      @adyen_fees = adyen_fees unless adyen_fees == SKIP
+      @adyen_markup = adyen_markup unless adyen_markup == SKIP
+      @chargeback = chargeback unless chargeback == SKIP
+      unless chargeback_cost_allocation == SKIP
+        @chargeback_cost_allocation =
+          chargeback_cost_allocation
+      end
+      @commission = commission
+      @interchange = interchange unless interchange == SKIP
+      @payment_fee = payment_fee unless payment_fee == SKIP
+      @refund = refund unless refund == SKIP
+      @refund_cost_allocation = refund_cost_allocation unless refund_cost_allocation == SKIP
+      @remainder = remainder unless remainder == SKIP
+      @scheme_fee = scheme_fee unless scheme_fee == SKIP
+      @split_logic_id = split_logic_id unless split_logic_id == SKIP
+      @surcharge = surcharge unless surcharge == SKIP
+      @tip = tip unless tip == 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.
+      commission = Commission1.from_hash(hash['commission']) if hash['commission']
+      acquiring_fees = hash.key?('acquiringFees') ? hash['acquiringFees'] : SKIP
+      additional_commission = AdditionalCommission1.from_hash(hash['additionalCommission']) if
+        hash['additionalCommission']
+      adyen_commission =
+        hash.key?('adyenCommission') ? hash['adyenCommission'] : SKIP
+      adyen_fees = hash.key?('adyenFees') ? hash['adyenFees'] : SKIP
+      adyen_markup = hash.key?('adyenMarkup') ? hash['adyenMarkup'] : SKIP
+      chargeback = hash.key?('chargeback') ? hash['chargeback'] : SKIP
+      chargeback_cost_allocation =
+        hash.key?('chargebackCostAllocation') ? hash['chargebackCostAllocation'] : SKIP
+      interchange = hash.key?('interchange') ? hash['interchange'] : SKIP
+      payment_fee = hash.key?('paymentFee') ? hash['paymentFee'] : SKIP
+      refund = hash.key?('refund') ? hash['refund'] : SKIP
+      refund_cost_allocation =
+        hash.key?('refundCostAllocation') ? hash['refundCostAllocation'] : SKIP
+      remainder = hash.key?('remainder') ? hash['remainder'] : SKIP
+      scheme_fee = hash.key?('schemeFee') ? hash['schemeFee'] : SKIP
+      split_logic_id = hash.key?('splitLogicId') ? hash['splitLogicId'] : SKIP
+      surcharge = hash.key?('surcharge') ? hash['surcharge'] : SKIP
+      tip = hash.key?('tip') ? hash['tip'] : SKIP
+
+      # Create object from extracted values.
+      SplitConfigurationLogic.new(commission: commission,
+                                  acquiring_fees: acquiring_fees,
+                                  additional_commission: additional_commission,
+                                  adyen_commission: adyen_commission,
+                                  adyen_fees: adyen_fees,
+                                  adyen_markup: adyen_markup,
+                                  chargeback: chargeback,
+                                  chargeback_cost_allocation: chargeback_cost_allocation,
+                                  interchange: interchange,
+                                  payment_fee: payment_fee,
+                                  refund: refund,
+                                  refund_cost_allocation: refund_cost_allocation,
+                                  remainder: remainder,
+                                  scheme_fee: scheme_fee,
+                                  split_logic_id: split_logic_id,
+                                  surcharge: surcharge,
+                                  tip: tip)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} acquiring_fees: #{@acquiring_fees}, additional_commission:"\
+      " #{@additional_commission}, adyen_commission: #{@adyen_commission}, adyen_fees:"\
+      " #{@adyen_fees}, adyen_markup: #{@adyen_markup}, chargeback: #{@chargeback},"\
+      " chargeback_cost_allocation: #{@chargeback_cost_allocation}, commission: #{@commission},"\
+      " interchange: #{@interchange}, payment_fee: #{@payment_fee}, refund: #{@refund},"\
+      " refund_cost_allocation: #{@refund_cost_allocation}, remainder: #{@remainder}, scheme_fee:"\
+      " #{@scheme_fee}, split_logic_id: #{@split_logic_id}, surcharge: #{@surcharge}, tip:"\
+      " #{@tip}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} acquiring_fees: #{@acquiring_fees.inspect}, additional_commission:"\
+      " #{@additional_commission.inspect}, adyen_commission: #{@adyen_commission.inspect},"\
+      " adyen_fees: #{@adyen_fees.inspect}, adyen_markup: #{@adyen_markup.inspect}, chargeback:"\
+      " #{@chargeback.inspect}, chargeback_cost_allocation:"\
+      " #{@chargeback_cost_allocation.inspect}, commission: #{@commission.inspect}, interchange:"\
+      " #{@interchange.inspect}, payment_fee: #{@payment_fee.inspect}, refund: #{@refund.inspect},"\
+      " refund_cost_allocation: #{@refund_cost_allocation.inspect}, remainder:"\
+      " #{@remainder.inspect}, scheme_fee: #{@scheme_fee.inspect}, split_logic_id:"\
+      " #{@split_logic_id.inspect}, surcharge: #{@surcharge.inspect}, tip: #{@tip.inspect}>"
+    end
+  end
+end