hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_action_partial_settle.rb

@@ -0,0 +1,73 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Partially settle the payment. See
+  # [details](../payments-lifecycle/partialsettle) including what to add in the
+  # request body.
+  class PaymentsActionPartialSettle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, method = 'POST')
+      @href = href unless href == SKIP
+      @method = method unless method == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      method = hash['method'] ||= 'POST'
+
+      # Create object from extracted values.
+      PaymentsActionPartialSettle.new(href,
+                                      method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_action_refund.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Fully refund the payment. See [details](../payments-lifecycle/refund)
+  class PaymentsActionRefund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, method = 'POST')
+      @href = href unless href == SKIP
+      @method = method unless method == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      method = hash['method'] ||= 'POST'
+
+      # Create object from extracted values.
+      PaymentsActionRefund.new(href,
+                               method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_action_settle.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Fully settle the payment. See [details](../payments-lifecycle/settle)
+  class PaymentsActionSettle < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, method = 'POST')
+      @href = href unless href == SKIP
+      @method = method unless method == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      method = hash['method'] ||= 'POST'
+
+      # Create object from extracted values.
+      PaymentsActionSettle.new(href,
+                               method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_action_supply3ds_device_data.rb

@@ -0,0 +1,73 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Supply the 3DS device data collectionReference (SessionId) to continue the
+  # payment. See [details](../3ds-actions/supply3dsdevicedata) including what to
+  # add in the request body.
+  class PaymentsActionSupply3dsDeviceData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, method = 'POST')
+      @href = href unless href == SKIP
+      @method = method unless method == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      method = hash['method'] ||= 'POST'
+
+      # Create object from extracted values.
+      PaymentsActionSupply3dsDeviceData.new(href,
+                                            method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_bank_account.rb

@@ -0,0 +1,119 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_recipient_account'
+
+module Payments
+  # PaymentsBankAccount Model.
+  class PaymentsBankAccount < PaymentsRecipientAccount
+    # TODO: Write general description for this method
+    # @return [IdentifierTypeEnum]
+    attr_accessor :identifier_type
+
+    # The International Bank Account Number (IBAN) of the recipient. Required if
+    # `identifierType` is `iban`
+    # @return [String]
+    attr_accessor :iban
+
+    # The account number of the recipient. Required if `identifierType` is
+    # `routingNumber` or `swift`
+    # @return [String]
+    attr_accessor :account_number
+
+    # The SWIFT Bank Identification Code (BIC) of the recipient. Required if
+    # `identifierType` is `swift`. Must be either 8 or 11 alphanumeric
+    # characters.
+    # @return [String]
+    attr_accessor :swift_bic
+
+    # The ABA (American Bankers Association) Routing Transit Number (RTN).
+    # Identifies the Financial Insititution of the recipient's account. Required
+    # if `identifierType` is `routingNumber`. Must be 9 numeric characters.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier_type'] = 'identifierType'
+      @_hash['iban'] = 'iban'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['swift_bic'] = 'swiftBic'
+      @_hash['routing_number'] = 'routingNumber'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        iban
+        account_number
+        swift_bic
+        routing_number
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(identifier_type = nil, iban = SKIP, account_number = SKIP,
+                   swift_bic = SKIP, routing_number = SKIP,
+                   type = 'bankAccount')
+      @identifier_type = identifier_type
+      @iban = iban unless iban == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @swift_bic = swift_bic unless swift_bic == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+
+      # Call the constructor of the base class
+      super(type)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      identifier_type =
+        hash.key?('identifierType') ? hash['identifierType'] : nil
+      iban = hash.key?('iban') ? hash['iban'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      swift_bic = hash.key?('swiftBic') ? hash['swiftBic'] : SKIP
+      routing_number = hash.key?('routingNumber') ? hash['routingNumber'] : SKIP
+      type = hash['type'] ||= 'bankAccount'
+
+      # Create object from extracted values.
+      PaymentsBankAccount.new(identifier_type,
+                              iban,
+                              account_number,
+                              swift_bic,
+                              routing_number,
+                              type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, identifier_type: #{@identifier_type}, iban: #{@iban},"\
+      " account_number: #{@account_number}, swift_bic: #{@swift_bic}, routing_number:"\
+      " #{@routing_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, identifier_type: #{@identifier_type.inspect}, iban:"\
+      " #{@iban.inspect}, account_number: #{@account_number.inspect}, swift_bic:"\
+      " #{@swift_bic.inspect}, routing_number: #{@routing_number.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_cancel.rb

@@ -0,0 +1,72 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Next action links.
+  class PaymentsCancel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Next action links.
+    # @return [String]
+    attr_accessor :href
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP)
+      @href = href unless href == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsCancel.new(href)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsCancel | 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} href: #{@href}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_card_account.rb

@@ -0,0 +1,69 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_recipient_account'
+
+module Payments
+  # PaymentsCardAccount Model.
+  class PaymentsCardAccount < PaymentsRecipientAccount
+    # Recipient's card number.
+    # @return [String]
+    attr_accessor :card_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_number'] = 'cardNumber'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(card_number = nil, type = 'card')
+      @card_number = card_number
+
+      # Call the constructor of the base class
+      super(type)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : nil
+      type = hash['type'] ||= 'card'
+
+      # Create object from extracted values.
+      PaymentsCardAccount.new(card_number,
+                              type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, card_number: #{@card_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, card_number: #{@card_number.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_card_on_file_customer_agreement.rb

@@ -0,0 +1,85 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_customer_agreement'
+
+module Payments
+  # PaymentsCardOnFileCustomerAgreement Model.
+  class PaymentsCardOnFileCustomerAgreement < PaymentsCustomerAgreement
+    # Set to `first` to store a card or `subsequent` to use a previously stored
+    # card.
+    # @return [StoredCardUsageEnum]
+    attr_accessor :stored_card_usage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['stored_card_usage'] = 'storedCardUsage'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(stored_card_usage = nil, type = 'cardOnFile')
+      @stored_card_usage = stored_card_usage
+
+      # Call the constructor of the base class
+      super(type)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      stored_card_usage =
+        hash.key?('storedCardUsage') ? hash['storedCardUsage'] : nil
+      type = hash['type'] ||= 'cardOnFile'
+
+      # Create object from extracted values.
+      PaymentsCardOnFileCustomerAgreement.new(stored_card_usage,
+                                              type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsCardOnFileCustomerAgreement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.stored_card_usage,
+                                     ->(val) { StoredCardUsageEnum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['storedCardUsage'],
+                            ->(val) { StoredCardUsageEnum.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, stored_card_usage: #{@stored_card_usage}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, stored_card_usage: #{@stored_card_usage.inspect}>"
+    end
+  end
+end