adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/store_creation_request.rb

@@ -0,0 +1,180 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # StoreCreationRequest Model.
+  class StoreCreationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The address of the store.
+    # @return [StoreLocation1]
+    attr_accessor :address
+
+    # The unique identifiers of the [business
+    # lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/busines
+    # sLines#responses-200-id) that the store is associated with.
+    # If not specified, the business line of the merchant account is used.
+    # Required when there are multiple business lines under the merchant
+    # account.
+    # @return [Array[String]]
+    attr_accessor :business_line_ids
+
+    # Your description of the store.
+    # @return [String]
+    attr_accessor :description
+
+    # The unique identifier of the store, used by certain payment methods and
+    # tax authorities.
+    # Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by
+    # dots, slashes, hyphens, or without separators.
+    # Optional for SIRET in France, up to 14 digits.
+    # Optional for Zip in Australia, up to 50 digits.
+    # @return [String]
+    attr_accessor :external_reference_id
+
+    # Localized information about the store.
+    # @return [LocalizedInformation2]
+    attr_accessor :localized_information
+
+    # The phone number of the store, including '+' and country code in the
+    # [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a
+    # different format, we convert and validate the phone number against E.164.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Your reference to recognize the store by. Also known as the store code.
+    #  Allowed characters: lowercase and uppercase letters without diacritics,
+    # numbers 0 through 9, hyphen (-), and underscore (_).
+    # If you do not provide a reference in your POST request, it is populated
+    # with the Adyen-generated
+    # [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#res
+    # ponses-200-id).
+    # @return [String]
+    attr_accessor :reference
+
+    # The store name to be shown on the shopper's bank or credit card statement
+    # and on the shopper receipt.
+    # Maximum length: 22 characters; can't be all numbers.
+    # @return [String]
+    attr_accessor :shopper_statement
+
+    # Rules for Adyen for Platforms merchants to split the transaction amount
+    # and fees.
+    # @return [StoreSplitConfiguration1]
+    attr_accessor :split_configuration
+
+    # The sub-merchant data relevant for registered payment facilitators
+    # transacting on standalone terminals.
+    # @return [SubMerchantData1]
+    attr_accessor :sub_merchant_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['business_line_ids'] = 'businessLineIds'
+      @_hash['description'] = 'description'
+      @_hash['external_reference_id'] = 'externalReferenceId'
+      @_hash['localized_information'] = 'localizedInformation'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['reference'] = 'reference'
+      @_hash['shopper_statement'] = 'shopperStatement'
+      @_hash['split_configuration'] = 'splitConfiguration'
+      @_hash['sub_merchant_data'] = 'subMerchantData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        business_line_ids
+        external_reference_id
+        localized_information
+        reference
+        split_configuration
+        sub_merchant_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address:, description:, phone_number:, shopper_statement:,
+                   business_line_ids: SKIP, external_reference_id: SKIP,
+                   localized_information: SKIP, reference: SKIP,
+                   split_configuration: SKIP, sub_merchant_data: SKIP)
+      @address = address
+      @business_line_ids = business_line_ids unless business_line_ids == SKIP
+      @description = description
+      @external_reference_id = external_reference_id unless external_reference_id == SKIP
+      @localized_information = localized_information unless localized_information == SKIP
+      @phone_number = phone_number
+      @reference = reference unless reference == SKIP
+      @shopper_statement = shopper_statement
+      @split_configuration = split_configuration unless split_configuration == SKIP
+      @sub_merchant_data = sub_merchant_data unless sub_merchant_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.
+      address = StoreLocation1.from_hash(hash['address']) if hash['address']
+      description = hash.key?('description') ? hash['description'] : nil
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : nil
+      shopper_statement =
+        hash.key?('shopperStatement') ? hash['shopperStatement'] : nil
+      business_line_ids =
+        hash.key?('businessLineIds') ? hash['businessLineIds'] : SKIP
+      external_reference_id =
+        hash.key?('externalReferenceId') ? hash['externalReferenceId'] : SKIP
+      localized_information = LocalizedInformation2.from_hash(hash['localizedInformation']) if
+        hash['localizedInformation']
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      split_configuration = StoreSplitConfiguration1.from_hash(hash['splitConfiguration']) if
+        hash['splitConfiguration']
+      sub_merchant_data = SubMerchantData1.from_hash(hash['subMerchantData']) if
+        hash['subMerchantData']
+
+      # Create object from extracted values.
+      StoreCreationRequest.new(address: address,
+                               description: description,
+                               phone_number: phone_number,
+                               shopper_statement: shopper_statement,
+                               business_line_ids: business_line_ids,
+                               external_reference_id: external_reference_id,
+                               localized_information: localized_information,
+                               reference: reference,
+                               split_configuration: split_configuration,
+                               sub_merchant_data: sub_merchant_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, business_line_ids: #{@business_line_ids},"\
+      " description: #{@description}, external_reference_id: #{@external_reference_id},"\
+      " localized_information: #{@localized_information}, phone_number: #{@phone_number},"\
+      " reference: #{@reference}, shopper_statement: #{@shopper_statement}, split_configuration:"\
+      " #{@split_configuration}, sub_merchant_data: #{@sub_merchant_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, business_line_ids:"\
+      " #{@business_line_ids.inspect}, description: #{@description.inspect},"\
+      " external_reference_id: #{@external_reference_id.inspect}, localized_information:"\
+      " #{@localized_information.inspect}, phone_number: #{@phone_number.inspect}, reference:"\
+      " #{@reference.inspect}, shopper_statement: #{@shopper_statement.inspect},"\
+      " split_configuration: #{@split_configuration.inspect}, sub_merchant_data:"\
+      " #{@sub_merchant_data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/store_creation_with_merchant_code_request.rb

@@ -0,0 +1,190 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # StoreCreationWithMerchantCodeRequest Model.
+  class StoreCreationWithMerchantCodeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The address of the store.
+    # @return [StoreLocation1]
+    attr_accessor :address
+
+    # The unique identifiers of the [business
+    # lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/busines
+    # sLines#responses-200-id) that the store is associated with.
+    # If not specified, the business line of the merchant account is used.
+    # Required when there are multiple business lines under the merchant
+    # account.
+    # @return [Array[String]]
+    attr_accessor :business_line_ids
+
+    # Your description of the store.
+    # @return [String]
+    attr_accessor :description
+
+    # The unique identifier of the store, used by certain payment methods and
+    # tax authorities.
+    # Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by
+    # dots, slashes, hyphens, or without separators.
+    # Optional for SIRET in France, up to 14 digits.
+    # Optional for Zip in Australia, up to 50 digits.
+    # @return [String]
+    attr_accessor :external_reference_id
+
+    # Localized information about the store.
+    # @return [LocalizedInformation2]
+    attr_accessor :localized_information
+
+    # The unique identifier of the merchant account that the store belongs to.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # The phone number of the store, including '+' and country code in the
+    # [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a
+    # different format, we convert and validate the phone number against E.164.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Your reference to recognize the store by. Also known as the store code.
+    #  Allowed characters: lowercase and uppercase letters without diacritics,
+    # numbers 0 through 9, hyphen (-), and underscore (_).
+    # If you do not provide a reference in your POST request, it is populated
+    # with the Adyen-generated
+    # [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#res
+    # ponses-200-id).
+    # @return [String]
+    attr_accessor :reference
+
+    # The store name to be shown on the shopper's bank or credit card statement
+    # and on the shopper receipt.
+    # Maximum length: 22 characters; can't be all numbers.
+    # @return [String]
+    attr_accessor :shopper_statement
+
+    # Rules for Adyen for Platforms merchants to split the transaction amount
+    # and fees.
+    # @return [StoreSplitConfiguration1]
+    attr_accessor :split_configuration
+
+    # The sub-merchant data relevant for registered payment facilitators
+    # transacting on standalone terminals.
+    # @return [SubMerchantData1]
+    attr_accessor :sub_merchant_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['business_line_ids'] = 'businessLineIds'
+      @_hash['description'] = 'description'
+      @_hash['external_reference_id'] = 'externalReferenceId'
+      @_hash['localized_information'] = 'localizedInformation'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['reference'] = 'reference'
+      @_hash['shopper_statement'] = 'shopperStatement'
+      @_hash['split_configuration'] = 'splitConfiguration'
+      @_hash['sub_merchant_data'] = 'subMerchantData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        business_line_ids
+        external_reference_id
+        localized_information
+        reference
+        split_configuration
+        sub_merchant_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address:, description:, merchant_id:, phone_number:,
+                   shopper_statement:, business_line_ids: SKIP,
+                   external_reference_id: SKIP, localized_information: SKIP,
+                   reference: SKIP, split_configuration: SKIP,
+                   sub_merchant_data: SKIP)
+      @address = address
+      @business_line_ids = business_line_ids unless business_line_ids == SKIP
+      @description = description
+      @external_reference_id = external_reference_id unless external_reference_id == SKIP
+      @localized_information = localized_information unless localized_information == SKIP
+      @merchant_id = merchant_id
+      @phone_number = phone_number
+      @reference = reference unless reference == SKIP
+      @shopper_statement = shopper_statement
+      @split_configuration = split_configuration unless split_configuration == SKIP
+      @sub_merchant_data = sub_merchant_data unless sub_merchant_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.
+      address = StoreLocation1.from_hash(hash['address']) if hash['address']
+      description = hash.key?('description') ? hash['description'] : nil
+      merchant_id = hash.key?('merchantId') ? hash['merchantId'] : nil
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : nil
+      shopper_statement =
+        hash.key?('shopperStatement') ? hash['shopperStatement'] : nil
+      business_line_ids =
+        hash.key?('businessLineIds') ? hash['businessLineIds'] : SKIP
+      external_reference_id =
+        hash.key?('externalReferenceId') ? hash['externalReferenceId'] : SKIP
+      localized_information = LocalizedInformation2.from_hash(hash['localizedInformation']) if
+        hash['localizedInformation']
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      split_configuration = StoreSplitConfiguration1.from_hash(hash['splitConfiguration']) if
+        hash['splitConfiguration']
+      sub_merchant_data = SubMerchantData1.from_hash(hash['subMerchantData']) if
+        hash['subMerchantData']
+
+      # Create object from extracted values.
+      StoreCreationWithMerchantCodeRequest.new(address: address,
+                                               description: description,
+                                               merchant_id: merchant_id,
+                                               phone_number: phone_number,
+                                               shopper_statement: shopper_statement,
+                                               business_line_ids: business_line_ids,
+                                               external_reference_id: external_reference_id,
+                                               localized_information: localized_information,
+                                               reference: reference,
+                                               split_configuration: split_configuration,
+                                               sub_merchant_data: sub_merchant_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, business_line_ids: #{@business_line_ids},"\
+      " description: #{@description}, external_reference_id: #{@external_reference_id},"\
+      " localized_information: #{@localized_information}, merchant_id: #{@merchant_id},"\
+      " phone_number: #{@phone_number}, reference: #{@reference}, shopper_statement:"\
+      " #{@shopper_statement}, split_configuration: #{@split_configuration}, sub_merchant_data:"\
+      " #{@sub_merchant_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, business_line_ids:"\
+      " #{@business_line_ids.inspect}, description: #{@description.inspect},"\
+      " external_reference_id: #{@external_reference_id.inspect}, localized_information:"\
+      " #{@localized_information.inspect}, merchant_id: #{@merchant_id.inspect}, phone_number:"\
+      " #{@phone_number.inspect}, reference: #{@reference.inspect}, shopper_statement:"\
+      " #{@shopper_statement.inspect}, split_configuration: #{@split_configuration.inspect},"\
+      " sub_merchant_data: #{@sub_merchant_data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/store_filtration_mode.rb

@@ -0,0 +1,43 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Specifies how payment methods should be filtered based on the 'store'
+  # parameter:   - 'exclusive': Only payment methods belonging to the specified
+  # 'store' are returned.   - 'inclusive': Payment methods from the 'store' and
+  # those not associated with any other store are returned.
+  class StoreFiltrationMode
+    STORE_FILTRATION_MODE = [
+      # TODO: Write general description for EXCLUSIVE
+      EXCLUSIVE = 'exclusive'.freeze,
+
+      # TODO: Write general description for INCLUSIVE
+      INCLUSIVE = 'inclusive'.freeze,
+
+      # TODO: Write general description for SKIPFILTER
+      SKIPFILTER = 'skipFilter'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STORE_FILTRATION_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXCLUSIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exclusive' then EXCLUSIVE
+      when 'inclusive' then INCLUSIVE
+      when 'skipfilter' then SKIPFILTER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/store_filtration_mode2.rb

@@ -0,0 +1,43 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Specifies how payment methods should be filtered based on the `store`
+  # parameter:   - **exclusive**: Only payment methods belonging to the
+  # specified `store` are returned.   - **inclusive**: Payment methods from the
+  # `store` and those not associated with any other store are returned.
+  class StoreFiltrationMode2
+    STORE_FILTRATION_MODE2 = [
+      # TODO: Write general description for EXCLUSIVE
+      EXCLUSIVE = 'exclusive'.freeze,
+
+      # TODO: Write general description for INCLUSIVE
+      INCLUSIVE = 'inclusive'.freeze,
+
+      # TODO: Write general description for SKIPFILTER
+      SKIPFILTER = 'skipFilter'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STORE_FILTRATION_MODE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXCLUSIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exclusive' then EXCLUSIVE
+      when 'inclusive' then INCLUSIVE
+      when 'skipfilter' then SKIPFILTER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/store_location.rb

@@ -0,0 +1,132 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # StoreLocation Model.
+  class StoreLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city.
+    # @return [String]
+    attr_accessor :city
+
+    # The two-letter country code in
+    # [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+    # format.
+    # @return [String]
+    attr_accessor :country
+
+    # The street address.
+    # @return [String]
+    attr_accessor :line1
+
+    # Second address line.
+    # @return [String]
+    attr_accessor :line2
+
+    # Third address line.
+    # @return [String]
+    attr_accessor :line3
+
+    # The postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state or province code as defined in [ISO
+    # 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for
+    # Ontario, Canada.
+    # Required for the following countries:
+    #  - Australia
+    # - Brazil
+    # - Canada
+    # - India
+    # - Mexico
+    # - New Zealand
+    # - United States
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        line1
+        line2
+        line3
+        postal_code
+        state_or_province
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country:, city: SKIP, line1: SKIP, line2: SKIP, line3: SKIP,
+                   postal_code: SKIP, state_or_province: SKIP)
+      @city = city unless city == SKIP
+      @country = country
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state_or_province = state_or_province unless state_or_province == 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.
+      country = hash.key?('country') ? hash['country'] : nil
+      city = hash.key?('city') ? hash['city'] : SKIP
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+
+      # Create object from extracted values.
+      StoreLocation.new(country: country,
+                        city: city,
+                        line1: line1,
+                        line2: line2,
+                        line3: line3,
+                        postal_code: postal_code,
+                        state_or_province: state_or_province)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, country: #{@country}, line1: #{@line1}, line2: #{@line2},"\
+      " line3: #{@line3}, postal_code: #{@postal_code}, state_or_province: #{@state_or_province}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, country: #{@country.inspect}, line1:"\
+      " #{@line1.inspect}, line2: #{@line2.inspect}, line3: #{@line3.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, state_or_province: #{@state_or_province.inspect}>"
+    end
+  end
+end