adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/mandate1.rb

@@ -0,0 +1,180 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The mandate details to initiate recurring transaction.
+  class Mandate1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing amount (in minor units) of the recurring transactions.
+    # @return [String]
+    attr_accessor :amount
+
+    # The limitation rule of the billing amount.
+    # Possible values:
+    #  * **max**: The transaction amount can not exceed the `amount`.
+    #  * **exact**: The transaction amount should be the same as the `amount`.
+    # @return [AmountRule]
+    attr_accessor :amount_rule
+
+    # The rule to specify the period, within which the recurring debit can
+    # happen, relative to the mandate recurring date.
+    # Possible values:
+    #  * **on**: On a specific date.
+    #  * **before**:  Before and on a specific date.
+    #  * **after**: On and after a specific date.
+    # @return [BillingAttemptsRule]
+    attr_accessor :billing_attempts_rule
+
+    # The number of the day, on which the recurring debit can happen. Should be
+    # within the same calendar month as the mandate recurring date.
+    # Possible values: 1-31 based on the `frequency`.
+    # @return [String]
+    attr_accessor :billing_day
+
+    # The number of transactions that can be performed within the given
+    # frequency.
+    # @return [String]
+    attr_accessor :count
+
+    # End date of the billing plan, in YYYY-MM-DD format.
+    # @return [String]
+    attr_accessor :ends_at
+
+    # The frequency with which a shopper should be charged.
+    # Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**,
+    # **monthly**, **quarterly**, **halfYearly**, **yearly**.
+    # @return [Frequency]
+    attr_accessor :frequency
+
+    # The message shown by UPI to the shopper on the approval screen.
+    # @return [String]
+    attr_accessor :remarks
+
+    # Start date of the billing plan, in YYYY-MM-DD format. By default, the
+    # transaction date.
+    # @return [String]
+    attr_accessor :starts_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['amount_rule'] = 'amountRule'
+      @_hash['billing_attempts_rule'] = 'billingAttemptsRule'
+      @_hash['billing_day'] = 'billingDay'
+      @_hash['count'] = 'count'
+      @_hash['ends_at'] = 'endsAt'
+      @_hash['frequency'] = 'frequency'
+      @_hash['remarks'] = 'remarks'
+      @_hash['starts_at'] = 'startsAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_rule
+        billing_attempts_rule
+        billing_day
+        count
+        remarks
+        starts_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, ends_at:, frequency:, amount_rule: SKIP,
+                   billing_attempts_rule: SKIP, billing_day: SKIP, count: SKIP,
+                   remarks: SKIP, starts_at: SKIP)
+      @amount = amount
+      @amount_rule = amount_rule unless amount_rule == SKIP
+      @billing_attempts_rule = billing_attempts_rule unless billing_attempts_rule == SKIP
+      @billing_day = billing_day unless billing_day == SKIP
+      @count = count unless count == SKIP
+      @ends_at = ends_at
+      @frequency = frequency
+      @remarks = remarks unless remarks == SKIP
+      @starts_at = starts_at unless starts_at == 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 = hash.key?('amount') ? hash['amount'] : nil
+      ends_at = hash.key?('endsAt') ? hash['endsAt'] : nil
+      frequency = hash.key?('frequency') ? hash['frequency'] : nil
+      amount_rule = hash.key?('amountRule') ? hash['amountRule'] : SKIP
+      billing_attempts_rule =
+        hash.key?('billingAttemptsRule') ? hash['billingAttemptsRule'] : SKIP
+      billing_day = hash.key?('billingDay') ? hash['billingDay'] : SKIP
+      count = hash.key?('count') ? hash['count'] : SKIP
+      remarks = hash.key?('remarks') ? hash['remarks'] : SKIP
+      starts_at = hash.key?('startsAt') ? hash['startsAt'] : SKIP
+
+      # Create object from extracted values.
+      Mandate1.new(amount: amount,
+                   ends_at: ends_at,
+                   frequency: frequency,
+                   amount_rule: amount_rule,
+                   billing_attempts_rule: billing_attempts_rule,
+                   billing_day: billing_day,
+                   count: count,
+                   remarks: remarks,
+                   starts_at: starts_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Mandate1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ends_at,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.frequency,
+                                  ->(val) { Frequency.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['endsAt'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['frequency'],
+                                ->(val) { Frequency.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, amount_rule: #{@amount_rule}, billing_attempts_rule:"\
+      " #{@billing_attempts_rule}, billing_day: #{@billing_day}, count: #{@count}, ends_at:"\
+      " #{@ends_at}, frequency: #{@frequency}, remarks: #{@remarks}, starts_at: #{@starts_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, amount_rule: #{@amount_rule.inspect},"\
+      " billing_attempts_rule: #{@billing_attempts_rule.inspect}, billing_day:"\
+      " #{@billing_day.inspect}, count: #{@count.inspect}, ends_at: #{@ends_at.inspect},"\
+      " frequency: #{@frequency.inspect}, remarks: #{@remarks.inspect}, starts_at:"\
+      " #{@starts_at.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/masterpass.rb

@@ -0,0 +1,123 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Masterpass Model.
+  class Masterpass < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout attempt identifier.
+    # @return [String]
+    attr_accessor :checkout_attempt_id
+
+    # The funding source that should be used when multiple sources are
+    # available. For Brazilian combo cards, by default the funding source is
+    # credit. To use debit, set this value to **debit**.
+    # @return [FundingSource]
+    attr_accessor :funding_source
+
+    # The Masterpass transaction ID.
+    # @return [String]
+    attr_accessor :masterpass_transaction_id
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :sdk_data
+
+    # **masterpass**
+    # @return [Type30]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_attempt_id'] = 'checkoutAttemptId'
+      @_hash['funding_source'] = 'fundingSource'
+      @_hash['masterpass_transaction_id'] = 'masterpassTransactionId'
+      @_hash['sdk_data'] = 'sdkData'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_attempt_id
+        funding_source
+        sdk_data
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(masterpass_transaction_id:, checkout_attempt_id: SKIP,
+                   funding_source: SKIP, sdk_data: SKIP,
+                   type: Type30::MASTERPASS)
+      @checkout_attempt_id = checkout_attempt_id unless checkout_attempt_id == SKIP
+      @funding_source = funding_source unless funding_source == SKIP
+      @masterpass_transaction_id = masterpass_transaction_id
+      @sdk_data = sdk_data unless sdk_data == 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.
+      masterpass_transaction_id =
+        hash.key?('masterpassTransactionId') ? hash['masterpassTransactionId'] : nil
+      checkout_attempt_id =
+        hash.key?('checkoutAttemptId') ? hash['checkoutAttemptId'] : SKIP
+      funding_source = hash.key?('fundingSource') ? hash['fundingSource'] : SKIP
+      sdk_data = hash.key?('sdkData') ? hash['sdkData'] : SKIP
+      type = hash['type'] ||= Type30::MASTERPASS
+
+      # Create object from extracted values.
+      Masterpass.new(masterpass_transaction_id: masterpass_transaction_id,
+                     checkout_attempt_id: checkout_attempt_id,
+                     funding_source: funding_source,
+                     sdk_data: sdk_data,
+                     type: type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Masterpass | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.masterpass_transaction_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['masterpassTransactionId'],
+                            ->(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} checkout_attempt_id: #{@checkout_attempt_id}, funding_source:"\
+      " #{@funding_source}, masterpass_transaction_id: #{@masterpass_transaction_id}, sdk_data:"\
+      " #{@sdk_data}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_attempt_id: #{@checkout_attempt_id.inspect}, funding_source:"\
+      " #{@funding_source.inspect}, masterpass_transaction_id:"\
+      " #{@masterpass_transaction_id.inspect}, sdk_data: #{@sdk_data.inspect}, type:"\
+      " #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/mb_way.rb

@@ -0,0 +1,127 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # MbWay Model.
+  class MbWay < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout attempt identifier.
+    # @return [String]
+    attr_accessor :checkout_attempt_id
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :sdk_data
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :shopper_email
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :telephone_number
+
+    # **mbway**
+    # @return [Type31]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_attempt_id'] = 'checkoutAttemptId'
+      @_hash['sdk_data'] = 'sdkData'
+      @_hash['shopper_email'] = 'shopperEmail'
+      @_hash['telephone_number'] = 'telephoneNumber'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_attempt_id
+        sdk_data
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shopper_email:, telephone_number:, checkout_attempt_id: SKIP,
+                   sdk_data: SKIP, type: Type31::MBWAY)
+      @checkout_attempt_id = checkout_attempt_id unless checkout_attempt_id == SKIP
+      @sdk_data = sdk_data unless sdk_data == SKIP
+      @shopper_email = shopper_email
+      @telephone_number = telephone_number
+      @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.
+      shopper_email = hash.key?('shopperEmail') ? hash['shopperEmail'] : nil
+      telephone_number =
+        hash.key?('telephoneNumber') ? hash['telephoneNumber'] : nil
+      checkout_attempt_id =
+        hash.key?('checkoutAttemptId') ? hash['checkoutAttemptId'] : SKIP
+      sdk_data = hash.key?('sdkData') ? hash['sdkData'] : SKIP
+      type = hash['type'] ||= Type31::MBWAY
+
+      # Create object from extracted values.
+      MbWay.new(shopper_email: shopper_email,
+                telephone_number: telephone_number,
+                checkout_attempt_id: checkout_attempt_id,
+                sdk_data: sdk_data,
+                type: type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MbWay | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.shopper_email,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.telephone_number,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['shopperEmail'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['telephoneNumber'],
+                                ->(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} checkout_attempt_id: #{@checkout_attempt_id}, sdk_data: #{@sdk_data},"\
+      " shopper_email: #{@shopper_email}, telephone_number: #{@telephone_number}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_attempt_id: #{@checkout_attempt_id.inspect}, sdk_data:"\
+      " #{@sdk_data.inspect}, shopper_email: #{@shopper_email.inspect}, telephone_number:"\
+      " #{@telephone_number.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/me_api_credential.rb

@@ -0,0 +1,169 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # MeApiCredential Model.
+  class MeApiCredential < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # References to resources linked to the API credential.
+    # @return [ApiCredentialLinks2]
+    attr_accessor :links
+
+    # Indicates if the API credential is enabled. Must be set to **true** to use
+    # the credential in your integration.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # List of IP addresses from which your client can make requests.
+    # If the list is empty, we allow requests from any IP.
+    # If the list is not empty and we get a request from an IP which is not on
+    # the list, you get a security error.
+    # @return [Array[String]]
+    attr_accessor :allowed_ip_addresses
+
+    # List containing the [allowed
+    # origins](https://docs.adyen.com/development-resources/client-side-authenti
+    # cation#allowed-origins) linked to the API credential.
+    # @return [Array[AllowedOrigin]]
+    attr_accessor :allowed_origins
+
+    # Public key used for [client-side
+    # authentication](https://docs.adyen.com/development-resources/client-side-a
+    # uthentication). The client key is required for Drop-in and Components
+    # integrations.
+    # @return [String]
+    attr_accessor :client_key
+
+    # Name of the company linked to the API credential.
+    # @return [String]
+    attr_accessor :company_name
+
+    # Description of the API credential.
+    # @return [String]
+    attr_accessor :description
+
+    # Unique identifier of the API credential.
+    # @return [String]
+    attr_accessor :id
+
+    # List of
+    # [roles](https://docs.adyen.com/development-resources/api-credentials#roles
+    # -1) for the API credential.
+    # @return [Array[String]]
+    attr_accessor :roles
+
+    # The name of the [API
+    # credential](https://docs.adyen.com/development-resources/api-credentials),
+    # for example **ws@Company.TestCompany**.
+    # @return [String]
+    attr_accessor :username
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['links'] = '_links'
+      @_hash['active'] = 'active'
+      @_hash['allowed_ip_addresses'] = 'allowedIpAddresses'
+      @_hash['allowed_origins'] = 'allowedOrigins'
+      @_hash['client_key'] = 'clientKey'
+      @_hash['company_name'] = 'companyName'
+      @_hash['description'] = 'description'
+      @_hash['id'] = 'id'
+      @_hash['roles'] = 'roles'
+      @_hash['username'] = 'username'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+        allowed_origins
+        company_name
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(active:, allowed_ip_addresses:, client_key:, id:, roles:,
+                   username:, links: SKIP, allowed_origins: SKIP,
+                   company_name: SKIP, description: SKIP)
+      @links = links unless links == SKIP
+      @active = active
+      @allowed_ip_addresses = allowed_ip_addresses
+      @allowed_origins = allowed_origins unless allowed_origins == SKIP
+      @client_key = client_key
+      @company_name = company_name unless company_name == SKIP
+      @description = description unless description == SKIP
+      @id = id
+      @roles = roles
+      @username = username
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      active = hash.key?('active') ? hash['active'] : nil
+      allowed_ip_addresses =
+        hash.key?('allowedIpAddresses') ? hash['allowedIpAddresses'] : nil
+      client_key = hash.key?('clientKey') ? hash['clientKey'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      roles = hash.key?('roles') ? hash['roles'] : nil
+      username = hash.key?('username') ? hash['username'] : nil
+      links = ApiCredentialLinks2.from_hash(hash['_links']) if hash['_links']
+      # Parameter is an array, so we need to iterate through it
+      allowed_origins = nil
+      unless hash['allowedOrigins'].nil?
+        allowed_origins = []
+        hash['allowedOrigins'].each do |structure|
+          allowed_origins << (AllowedOrigin.from_hash(structure) if structure)
+        end
+      end
+
+      allowed_origins = SKIP unless hash.key?('allowedOrigins')
+      company_name = hash.key?('companyName') ? hash['companyName'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      MeApiCredential.new(active: active,
+                          allowed_ip_addresses: allowed_ip_addresses,
+                          client_key: client_key,
+                          id: id,
+                          roles: roles,
+                          username: username,
+                          links: links,
+                          allowed_origins: allowed_origins,
+                          company_name: company_name,
+                          description: description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links}, active: #{@active}, allowed_ip_addresses:"\
+      " #{@allowed_ip_addresses}, allowed_origins: #{@allowed_origins}, client_key:"\
+      " #{@client_key}, company_name: #{@company_name}, description: #{@description}, id: #{@id},"\
+      " roles: #{@roles}, username: #{@username}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links.inspect}, active: #{@active.inspect}, allowed_ip_addresses:"\
+      " #{@allowed_ip_addresses.inspect}, allowed_origins: #{@allowed_origins.inspect},"\
+      " client_key: #{@client_key.inspect}, company_name: #{@company_name.inspect}, description:"\
+      " #{@description.inspect}, id: #{@id.inspect}, roles: #{@roles.inspect}, username:"\
+      " #{@username.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/meal_voucher_fr_info.rb

@@ -0,0 +1,79 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # MealVoucherFrInfo Model.
+  class MealVoucherFrInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Meal Voucher conecsId. Format: digits only
+    # @return [String]
+    attr_accessor :conecs_id
+
+    # Meal Voucher siret. Format: 14 digits.
+    # @return [String]
+    attr_accessor :siret
+
+    # The list of additional payment methods. Allowed values:
+    # **mealVoucher_FR_edenred**, **mealVoucher_FR_groupeup**,
+    # **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**.
+    # @return [Array[String]]
+    attr_accessor :sub_types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conecs_id'] = 'conecsId'
+      @_hash['siret'] = 'siret'
+      @_hash['sub_types'] = 'subTypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(conecs_id:, siret:, sub_types:)
+      @conecs_id = conecs_id
+      @siret = siret
+      @sub_types = sub_types
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      conecs_id = hash.key?('conecsId') ? hash['conecsId'] : nil
+      siret = hash.key?('siret') ? hash['siret'] : nil
+      sub_types = hash.key?('subTypes') ? hash['subTypes'] : nil
+
+      # Create object from extracted values.
+      MealVoucherFrInfo.new(conecs_id: conecs_id,
+                            siret: siret,
+                            sub_types: sub_types)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} conecs_id: #{@conecs_id}, siret: #{@siret}, sub_types: #{@sub_types}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} conecs_id: #{@conecs_id.inspect}, siret: #{@siret.inspect}, sub_types:"\
+      " #{@sub_types.inspect}>"
+    end
+  end
+end