adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/installments2.rb

@@ -0,0 +1,110 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Contains installment settings. For more information, refer to
+  # [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-inst
+  # allments).
+  class Installments2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines the bonus percentage, refund percentage or if the transaction is
+    # Buy now Pay later.
+    # Used for [card installments in
+    # Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installme
+    # nts/#getting-paid-mexico)
+    # @return [Integer]
+    attr_accessor :extra
+
+    # The installment plan, used for [card installments in
+    # Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installmen
+    # ts#make-a-payment-japan).
+    # and
+    # [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installm
+    # ents/#getting-paid-mexico).
+    # By default, this is set to **regular**.
+    # @return [Plan]
+    attr_accessor :plan
+
+    # Defines the number of installments.
+    # Usually, the maximum allowed number of installments is capped. For
+    # example, it may not be possible to split a payment in more than 24
+    # installments. The acquirer sets this upper limit, so its value may vary.
+    # This value can be zero for Installments processed in Mexico.
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['extra'] = 'extra'
+      @_hash['plan'] = 'plan'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extra
+        plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:, extra: SKIP, plan: SKIP)
+      @extra = extra unless extra == SKIP
+      @plan = plan unless plan == SKIP
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      value = hash.key?('value') ? hash['value'] : nil
+      extra = hash.key?('extra') ? hash['extra'] : SKIP
+      plan = hash.key?('plan') ? hash['plan'] : SKIP
+
+      # Create object from extracted values.
+      Installments2.new(value: value,
+                        extra: extra,
+                        plan: plan)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Installments2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.value,
+                                     ->(val) { val.instance_of? Integer })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['value'],
+                            ->(val) { val.instance_of? Integer })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extra: #{@extra}, plan: #{@plan}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extra: #{@extra.inspect}, plan: #{@plan.inspect}, value:"\
+      " #{@value.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/interchange.rb

@@ -0,0 +1,37 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Deducts the interchange fee from specified balance account. Possible values:
+  # **deductFromLiableAccount**, **deductFromOneBalanceAccount**.
+  class Interchange
+    INTERCHANGE = [
+      # TODO: Write general description for DEDUCTFROMLIABLEACCOUNT
+      DEDUCTFROMLIABLEACCOUNT = 'deductFromLiableAccount'.freeze,
+
+      # TODO: Write general description for DEDUCTFROMONEBALANCEACCOUNT
+      DEDUCTFROMONEBALANCEACCOUNT = 'deductFromOneBalanceAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INTERCHANGE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEDUCTFROMLIABLEACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deductfromliableaccount' then DEDUCTFROMLIABLEACCOUNT
+      when 'deductfromonebalanceaccount' then DEDUCTFROMONEBALANCEACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/invalid_field.rb

@@ -0,0 +1,90 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # InvalidField Model.
+  class InvalidField < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field that has an invalid value.
+    # @return [String]
+    attr_accessor :name
+
+    # The invalid value.
+    # @return [String]
+    attr_accessor :value
+
+    # Description of the validation error.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, value:, message:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @value = value
+      @message = message
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # 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.
+      InvalidField.new(name: name,
+                       value: value,
+                       message: message,
+                       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} name: #{@name}, value: #{@value}, message: #{@message},"\
+      " 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} name: #{@name.inspect}, value: #{@value.inspect}, message:"\
+      " #{@message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/item.rb

@@ -0,0 +1,71 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Item Model.
+  class Item < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value to provide in the result.
+    # @return [String]
+    attr_accessor :id
+
+    # The display name.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      Item.new(id: id,
+               name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/item_detail_line.rb

@@ -0,0 +1,190 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # ItemDetailLine Model.
+  class ItemDetailLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code that identifies the item in a standardized commodity coding
+    # scheme. There are different commodity coding schemes:
+    # * [UNSPSC commodity codes](https://www.ungm.org/public/unspsc)
+    # * [HS commodity
+    # codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx)
+    # * [NAICS commodity codes](https://www.census.gov/naics/)
+    # * [NAPCS commodity codes](https://www.census.gov/naics/napcs/)
+    # * Encoding: ASCII
+    # * Max length: 12 characters
+    # * Must not start with a space or be all spaces.
+    # * Must not be all zeros.
+    # @return [String]
+    attr_accessor :commodity_code
+
+    # A description of the item, that provides details about the purchase.
+    #  For Visa transactions with level 3 ESD, the description must not be the
+    # same or very similar to your merchant name, or, consist only of common
+    # words like "product", or "service".
+    # * Encoding: ASCII
+    # * Max length: 26 characters
+    # * Must not be a single character.
+    # * Must not be blank.
+    # * Must not be all special characters.
+    # * Must not start with a space or be all spaces.
+    # * Must not be all zeros.
+    # @return [String]
+    attr_accessor :description
+
+    # The discount amount, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * For example, 2000 means USD 20.00.
+    # * Encoding: Numeric
+    # * Max value: 10000000000
+    # @return [Integer]
+    attr_accessor :discount_amount
+
+    # The product code. Must be a unique product code associated with the item
+    # or service. This can be your unique code for the item, or the
+    # manufacturer's product code. 
+    # * Encoding: ASCII.
+    # * Max length: 12 characters
+    # @return [String]
+    attr_accessor :product_code
+
+    # The number of items. Must be an integer greater than zero.
+    # * Encoding: Numeric
+    # * Max value: 9999
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The total amount for the line item, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * For example, 2000 means USD 20.00.
+    # * Encoding: Numeric
+    # * Max value: 10000000000
+    # See [Amount requirements for level 2/3
+    # ESD](https://docs.adyen.com//payment-methods/cards/enhanced-scheme-data/l2
+    # -l3#amount-requirements) to learn more about how to calculate the line
+    # item total.
+    # @return [Integer]
+    attr_accessor :total_amount
+
+    # The unit of measurement for an item.
+    # * Encoding: ASCII
+    # * Max length: 3 characters
+    # @return [String]
+    attr_accessor :unit_of_measure
+
+    # The unit price, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes).
+    # * For example, 2000 means USD 20.00.
+    # * Encoding: Numeric
+    # * Max value: 10000000000
+    # @return [Integer]
+    attr_accessor :unit_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['commodity_code'] = 'commodityCode'
+      @_hash['description'] = 'description'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['product_code'] = 'productCode'
+      @_hash['quantity'] = 'quantity'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['unit_of_measure'] = 'unitOfMeasure'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        commodity_code
+        description
+        discount_amount
+        product_code
+        quantity
+        total_amount
+        unit_of_measure
+        unit_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(commodity_code: SKIP, description: SKIP,
+                   discount_amount: SKIP, product_code: SKIP, quantity: SKIP,
+                   total_amount: SKIP, unit_of_measure: SKIP, unit_price: SKIP)
+      @commodity_code = commodity_code unless commodity_code == SKIP
+      @description = description unless description == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @unit_of_measure = unit_of_measure unless unit_of_measure == SKIP
+      @unit_price = unit_price unless unit_price == 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.
+      commodity_code = hash.key?('commodityCode') ? hash['commodityCode'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+      product_code = hash.key?('productCode') ? hash['productCode'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      unit_of_measure =
+        hash.key?('unitOfMeasure') ? hash['unitOfMeasure'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+
+      # Create object from extracted values.
+      ItemDetailLine.new(commodity_code: commodity_code,
+                         description: description,
+                         discount_amount: discount_amount,
+                         product_code: product_code,
+                         quantity: quantity,
+                         total_amount: total_amount,
+                         unit_of_measure: unit_of_measure,
+                         unit_price: unit_price)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ItemDetailLine | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commodity_code: #{@commodity_code}, description: #{@description},"\
+      " discount_amount: #{@discount_amount}, product_code: #{@product_code}, quantity:"\
+      " #{@quantity}, total_amount: #{@total_amount}, unit_of_measure: #{@unit_of_measure},"\
+      " unit_price: #{@unit_price}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commodity_code: #{@commodity_code.inspect}, description:"\
+      " #{@description.inspect}, discount_amount: #{@discount_amount.inspect}, product_code:"\
+      " #{@product_code.inspect}, quantity: #{@quantity.inspect}, total_amount:"\
+      " #{@total_amount.inspect}, unit_of_measure: #{@unit_of_measure.inspect}, unit_price:"\
+      " #{@unit_price.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/jcb_info.rb

@@ -0,0 +1,114 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # JcbInfo Model.
+  class JcbInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # MID (Merchant ID) number. Required for merchants operating in Japan or
+    # merchants operating in Canada, Australia and New Zealand when requesting
+    # `gatewayContract` or `paymentDesignatorContract` service levels.Format: 14
+    # numeric characters for Japan, 10 numeric characters for Canada, Australia
+    # and New Zealand.
+    # @return [String]
+    attr_accessor :mid_number
+
+    # Indicates whether the JCB Merchant ID is reused from a previously setup
+    # JCB payment method. 
+    # The default value is **false**.For merchants operating in Japan, this
+    # field is required and must be set to **true**.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reuse_mid_number
+
+    # Specifies the service level (settlement type) of this payment method.
+    # Required for merchants operating in Japan.
+    # Possible values:
+    # * **noContract**: Adyen holds the contract with JCB for merchants
+    # operating in Japan or American Express for merchants operating in Canada,
+    # Australia and New Zealand.
+    # * **gatewayContract**: JCB or American Express receives the settlement and
+    # handles disputes, then pays out to you or your sub-merchant directly.
+    # * **paymentDesignatorContract**: Available only for merchants operating in
+    # Canada, Australia and New Zealand. Adyen receives the settlement, and
+    # handles disputes and payouts.
+    # @return [ServiceLevel2]
+    attr_accessor :service_level
+
+    # Information regarding the transaction description.
+    # > You cannot configure the transaction description in the test
+    # environment.
+    # @return [TransactionDescriptionInfo1]
+    attr_accessor :transaction_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mid_number'] = 'midNumber'
+      @_hash['reuse_mid_number'] = 'reuseMidNumber'
+      @_hash['service_level'] = 'serviceLevel'
+      @_hash['transaction_description'] = 'transactionDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mid_number
+        reuse_mid_number
+        service_level
+        transaction_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mid_number: SKIP, reuse_mid_number: false,
+                   service_level: SKIP, transaction_description: SKIP)
+      @mid_number = mid_number unless mid_number == SKIP
+      @reuse_mid_number = reuse_mid_number unless reuse_mid_number == SKIP
+      @service_level = service_level unless service_level == SKIP
+      @transaction_description = transaction_description unless transaction_description == 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.
+      mid_number = hash.key?('midNumber') ? hash['midNumber'] : SKIP
+      reuse_mid_number = hash['reuseMidNumber'] ||= false
+      service_level = hash.key?('serviceLevel') ? hash['serviceLevel'] : SKIP
+      if hash['transactionDescription']
+        transaction_description = TransactionDescriptionInfo1.from_hash(hash['transactionDescription'])
+      end
+
+      # Create object from extracted values.
+      JcbInfo.new(mid_number: mid_number,
+                  reuse_mid_number: reuse_mid_number,
+                  service_level: service_level,
+                  transaction_description: transaction_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mid_number: #{@mid_number}, reuse_mid_number: #{@reuse_mid_number},"\
+      " service_level: #{@service_level}, transaction_description: #{@transaction_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mid_number: #{@mid_number.inspect}, reuse_mid_number:"\
+      " #{@reuse_mid_number.inspect}, service_level: #{@service_level.inspect},"\
+      " transaction_description: #{@transaction_description.inspect}>"
+    end
+  end
+end