adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/delivery_address.rb

@@ -0,0 +1,138 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # DeliveryAddress Model.
+  class DeliveryAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :city
+
+    # The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
+    # > If you don't know the country or are not collecting the country from the
+    # shopper, provide `country` as `ZZ`.
+    # @return [String]
+    attr_accessor :country
+
+    # The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
+    # > If you don't know the country or are not collecting the country from the
+    # shopper, provide `country` as `ZZ`.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The number or name of the house. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :house_number_or_name
+
+    # The number or name of the house. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :last_name
+
+    # A maximum of five digits for an address in the US, or a maximum of ten
+    # characters for an address in all other countries.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The two-character ISO 3166-2 state or province code. For example, **CA**
+    # in the US or **ON** in Canada.
+    # > Required for the US and Canada.
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # The name of the street. Maximum length: 3000 characters.
+    # > The house number should not be included in this field; it should be
+    # separately provided via `houseNumberOrName`.
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['first_name'] = 'firstName'
+      @_hash['house_number_or_name'] = 'houseNumberOrName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        state_or_province
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city:, country:, house_number_or_name:, postal_code:,
+                   street:, first_name: SKIP, last_name: SKIP,
+                   state_or_province: SKIP)
+      @city = city
+      @country = country
+      @first_name = first_name unless first_name == SKIP
+      @house_number_or_name = house_number_or_name
+      @last_name = last_name unless last_name == SKIP
+      @postal_code = postal_code
+      @state_or_province = state_or_province unless state_or_province == SKIP
+      @street = street
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      city = hash.key?('city') ? hash['city'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      house_number_or_name =
+        hash.key?('houseNumberOrName') ? hash['houseNumberOrName'] : nil
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryAddress.new(city: city,
+                          country: country,
+                          house_number_or_name: house_number_or_name,
+                          postal_code: postal_code,
+                          street: street,
+                          first_name: first_name,
+                          last_name: last_name,
+                          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}, first_name: #{@first_name},"\
+      " house_number_or_name: #{@house_number_or_name}, last_name: #{@last_name}, postal_code:"\
+      " #{@postal_code}, state_or_province: #{@state_or_province}, street: #{@street}>"
+    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}, first_name:"\
+      " #{@first_name.inspect}, house_number_or_name: #{@house_number_or_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, postal_code: #{@postal_code.inspect}, state_or_province:"\
+      " #{@state_or_province.inspect}, street: #{@street.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/delivery_address1.rb

@@ -0,0 +1,172 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The address where the purchased goods should be delivered.
+  class DeliveryAddress1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :city
+
+    # The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
+    # > If you don't know the country or are not collecting the country from the
+    # shopper, provide `country` as `ZZ`.
+    # @return [String]
+    attr_accessor :country
+
+    # The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
+    # > If you don't know the country or are not collecting the country from the
+    # shopper, provide `country` as `ZZ`.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The number or name of the house. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :house_number_or_name
+
+    # The number or name of the house. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :last_name
+
+    # A maximum of five digits for an address in the US, or a maximum of ten
+    # characters for an address in all other countries.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The two-character ISO 3166-2 state or province code. For example, **CA**
+    # in the US or **ON** in Canada.
+    # > Required for the US and Canada.
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # The name of the street. Maximum length: 3000 characters.
+    # > The house number should not be included in this field; it should be
+    # separately provided via `houseNumberOrName`.
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['first_name'] = 'firstName'
+      @_hash['house_number_or_name'] = 'houseNumberOrName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        state_or_province
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city:, country:, house_number_or_name:, postal_code:,
+                   street:, first_name: SKIP, last_name: SKIP,
+                   state_or_province: SKIP)
+      @city = city
+      @country = country
+      @first_name = first_name unless first_name == SKIP
+      @house_number_or_name = house_number_or_name
+      @last_name = last_name unless last_name == SKIP
+      @postal_code = postal_code
+      @state_or_province = state_or_province unless state_or_province == SKIP
+      @street = street
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      city = hash.key?('city') ? hash['city'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      house_number_or_name =
+        hash.key?('houseNumberOrName') ? hash['houseNumberOrName'] : nil
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryAddress1.new(city: city,
+                           country: country,
+                           house_number_or_name: house_number_or_name,
+                           postal_code: postal_code,
+                           street: street,
+                           first_name: first_name,
+                           last_name: last_name,
+                           state_or_province: state_or_province)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DeliveryAddress1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.city,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.house_number_or_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.postal_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.street,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['city'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['country'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['houseNumberOrName'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['postalCode'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['street'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}, first_name: #{@first_name},"\
+      " house_number_or_name: #{@house_number_or_name}, last_name: #{@last_name}, postal_code:"\
+      " #{@postal_code}, state_or_province: #{@state_or_province}, street: #{@street}>"
+    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}, first_name:"\
+      " #{@first_name.inspect}, house_number_or_name: #{@house_number_or_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, postal_code: #{@postal_code.inspect}, state_or_province:"\
+      " #{@state_or_province.inspect}, street: #{@street.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/delivery_address_indicator.rb

@@ -0,0 +1,58 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicator regarding the delivery address. Allowed values: *
+  # `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` *
+  # `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other`
+  class DeliveryAddressIndicator
+    DELIVERY_ADDRESS_INDICATOR = [
+      # TODO: Write general description for SHIPTOBILLINGADDRESS
+      SHIPTOBILLINGADDRESS = 'shipToBillingAddress'.freeze,
+
+      # TODO: Write general description for SHIPTOVERIFIEDADDRESS
+      SHIPTOVERIFIEDADDRESS = 'shipToVerifiedAddress'.freeze,
+
+      # TODO: Write general description for SHIPTONEWADDRESS
+      SHIPTONEWADDRESS = 'shipToNewAddress'.freeze,
+
+      # TODO: Write general description for SHIPTOSTORE
+      SHIPTOSTORE = 'shipToStore'.freeze,
+
+      # TODO: Write general description for DIGITALGOODS
+      DIGITALGOODS = 'digitalGoods'.freeze,
+
+      # TODO: Write general description for GOODSNOTSHIPPED
+      GOODSNOTSHIPPED = 'goodsNotShipped'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DELIVERY_ADDRESS_INDICATOR.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHIPTOBILLINGADDRESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shiptobillingaddress' then SHIPTOBILLINGADDRESS
+      when 'shiptoverifiedaddress' then SHIPTOVERIFIEDADDRESS
+      when 'shiptonewaddress' then SHIPTONEWADDRESS
+      when 'shiptostore' then SHIPTOSTORE
+      when 'digitalgoods' then DIGITALGOODS
+      when 'goodsnotshipped' then GOODSNOTSHIPPED
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/delivery_address_usage_indicator.rb

@@ -0,0 +1,46 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicator for the length of time since this delivery address was first used.
+  # Allowed values: * thisTransaction * lessThan30Days * from30To60Days *
+  # moreThan60Days
+  class DeliveryAddressUsageIndicator
+    DELIVERY_ADDRESS_USAGE_INDICATOR = [
+      # TODO: Write general description for THISTRANSACTION
+      THISTRANSACTION = 'thisTransaction'.freeze,
+
+      # TODO: Write general description for LESSTHAN30DAYS
+      LESSTHAN30DAYS = 'lessThan30Days'.freeze,
+
+      # TODO: Write general description for FROM30TO60DAYS
+      FROM30TO60DAYS = 'from30To60Days'.freeze,
+
+      # TODO: Write general description for MORETHAN60DAYS
+      MORETHAN60DAYS = 'moreThan60Days'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DELIVERY_ADDRESS_USAGE_INDICATOR.include?(value)
+    end
+
+    def self.from_value(value, default_value = THISTRANSACTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'thistransaction' then THISTRANSACTION
+      when 'lessthan30days' then LESSTHAN30DAYS
+      when 'from30to60days' then FROM30TO60DAYS
+      when 'morethan60days' then MORETHAN60DAYS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/delivery_method.rb

@@ -0,0 +1,103 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # DeliveryMethod Model.
+  class DeliveryMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The cost of this delivery method.
+    # @return [Amount23]
+    attr_accessor :amount
+
+    # The name of the delivery method as shown to the shopper.
+    # @return [String]
+    attr_accessor :description
+
+    # The reference of the delivery method.
+    # @return [String]
+    attr_accessor :reference
+
+    # If you display the PayPal lightbox with delivery methods, set to **true**
+    # for the delivery method that is selected. Only one delivery method can be
+    # selected at a time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :selected
+
+    # The type of the delivery method.
+    # @return [Type18]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['reference'] = 'reference'
+      @_hash['selected'] = 'selected'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        description
+        reference
+        selected
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, description: SKIP, reference: SKIP,
+                   selected: SKIP, type: SKIP)
+      @amount = amount unless amount == SKIP
+      @description = description unless description == SKIP
+      @reference = reference unless reference == SKIP
+      @selected = selected unless selected == SKIP
+      @type = type unless type == 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.
+      amount = Amount23.from_hash(hash['amount']) if hash['amount']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      selected = hash.key?('selected') ? hash['selected'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryMethod.new(amount: amount,
+                         description: description,
+                         reference: reference,
+                         selected: selected,
+                         type: type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, description: #{@description}, reference: #{@reference},"\
+      " selected: #{@selected}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, description: #{@description.inspect},"\
+      " reference: #{@reference.inspect}, selected: #{@selected.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/delivery_timeframe.rb

@@ -0,0 +1,46 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The estimated delivery time for the shopper to receive the goods. Allowed
+  # values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` *
+  # `twoOrMoreDaysShipping`
+  class DeliveryTimeframe
+    DELIVERY_TIMEFRAME = [
+      # TODO: Write general description for ELECTRONICDELIVERY
+      ELECTRONICDELIVERY = 'electronicDelivery'.freeze,
+
+      # TODO: Write general description for SAMEDAYSHIPPING
+      SAMEDAYSHIPPING = 'sameDayShipping'.freeze,
+
+      # TODO: Write general description for OVERNIGHTSHIPPING
+      OVERNIGHTSHIPPING = 'overnightShipping'.freeze,
+
+      # TODO: Write general description for TWOORMOREDAYSSHIPPING
+      TWOORMOREDAYSSHIPPING = 'twoOrMoreDaysShipping'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DELIVERY_TIMEFRAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = ELECTRONICDELIVERY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'electronicdelivery' then ELECTRONICDELIVERY
+      when 'samedayshipping' then SAMEDAYSHIPPING
+      when 'overnightshipping' then OVERNIGHTSHIPPING
+      when 'twoormoredaysshipping' then TWOORMOREDAYSSHIPPING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/destination.rb

@@ -0,0 +1,100 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Destination Model.
+  class Destination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The two-letter [ISO 3166-1
+    # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) or three-letter
+    # [ISO 3166-1 alpha-3 country
+    # code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the
+    # destination address. 
+    #  * Encoding: ASCII  
+    #  * Min length: 2 characters 
+    #  * Max length: 3 characters
+    # @return [String]
+    attr_accessor :country_code
+
+    # The postal code of the destination address.
+    # * Encoding: ASCII
+    # * Max length: 10 characters
+    # * Must not start with a space.
+    # * For the US, it must be in five or nine digits format. For example, 10001
+    # or 10001-0000.
+    # * For Canada, it must be in 6 digits format. For example, M4B 1G5.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state or province code of the destination address.
+    # * Encoding: ASCII
+    # * Max length: 3 characters
+    # * Must not start with a space.
+    # @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['country_code'] = 'countryCode'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+        postal_code
+        state_or_province
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code: SKIP, postal_code: SKIP,
+                   state_or_province: SKIP)
+      @country_code = country_code unless country_code == 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_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+
+      # Create object from extracted values.
+      Destination.new(country_code: country_code,
+                      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} country_code: #{@country_code}, 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} country_code: #{@country_code.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, state_or_province: #{@state_or_province.inspect}>"
+    end
+  end
+end