hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payment_instrument7.rb

@@ -0,0 +1,171 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentInstrument7 Model.
+  class PaymentInstrument7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of instrument.
+    # @return [Type3Enum]
+    attr_accessor :type
+
+    # Customer's card number.
+    # @return [String]
+    attr_accessor :card_number
+
+    # The name on your customer's card. Required if  instruction.tokenCreation
+    # is present. However we recommend that you supply this to improve
+    # authentication rates.
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # Contains your customer's card or token expiry date.
+    # @return [ExpiryDate]
+    attr_accessor :expiry_date
+
+    # CVC is a unique set of 3 or 4 numbers on the back of the card. Our API
+    # checks to see if the CVC supplied matches the CVC held by the issuing
+    # bank.
+    # @return [String]
+    attr_accessor :cvc
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # An object containing specific routing preferences.
+    # @return [Routing]
+    attr_accessor :routing
+
+    # An http address that contains your Checkout session providing the card
+    # details.
+    # @return [String]
+    attr_accessor :session_href
+
+    # An http address that contains your link to an Access Token.
+    # @return [String]
+    attr_accessor :href
+
+    # Href to the Checkout session providing the Card Verification Code
+    # (CVC).__Note:__ Provide a value in `cvcSessionHref` or `cvc`, never both.
+    # @return [String]
+    attr_accessor :cvc_session_href
+
+    # Href to the Checkout session providing the Card Verification Code
+    # (CVC).__Note:__ Provide a value in `cvcSessionHref` or `cvc`, never both.
+    # @return [String]
+    attr_accessor :wallet_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['cvc'] = 'cvc'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['routing'] = 'routing'
+      @_hash['session_href'] = 'sessionHref'
+      @_hash['href'] = 'href'
+      @_hash['cvc_session_href'] = 'cvcSessionHref'
+      @_hash['wallet_token'] = 'walletToken'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        card_number
+        card_holder_name
+        expiry_date
+        cvc
+        billing_address
+        routing
+        session_href
+        href
+        cvc_session_href
+        wallet_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, card_number = SKIP, card_holder_name = SKIP,
+                   expiry_date = SKIP, cvc = SKIP, billing_address = SKIP,
+                   routing = SKIP, session_href = SKIP, href = SKIP,
+                   cvc_session_href = SKIP, wallet_token = SKIP)
+      @type = type unless type == SKIP
+      @card_number = card_number unless card_number == SKIP
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @cvc = cvc unless cvc == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @routing = routing unless routing == SKIP
+      @session_href = session_href unless session_href == SKIP
+      @href = href unless href == SKIP
+      @cvc_session_href = cvc_session_href unless cvc_session_href == SKIP
+      @wallet_token = wallet_token unless wallet_token == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      expiry_date = ExpiryDate.from_hash(hash['expiryDate']) if hash['expiryDate']
+      cvc = hash.key?('cvc') ? hash['cvc'] : SKIP
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+      routing = Routing.from_hash(hash['routing']) if hash['routing']
+      session_href = hash.key?('sessionHref') ? hash['sessionHref'] : SKIP
+      href = hash.key?('href') ? hash['href'] : SKIP
+      cvc_session_href =
+        hash.key?('cvcSessionHref') ? hash['cvcSessionHref'] : SKIP
+      wallet_token = hash.key?('walletToken') ? hash['walletToken'] : SKIP
+
+      # Create object from extracted values.
+      PaymentInstrument7.new(type,
+                             card_number,
+                             card_holder_name,
+                             expiry_date,
+                             cvc,
+                             billing_address,
+                             routing,
+                             session_href,
+                             href,
+                             cvc_session_href,
+                             wallet_token)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, card_number: #{@card_number}, card_holder_name:"\
+      " #{@card_holder_name}, expiry_date: #{@expiry_date}, cvc: #{@cvc}, billing_address:"\
+      " #{@billing_address}, routing: #{@routing}, session_href: #{@session_href}, href: #{@href},"\
+      " cvc_session_href: #{@cvc_session_href}, wallet_token: #{@wallet_token}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, card_number: #{@card_number.inspect},"\
+      " card_holder_name: #{@card_holder_name.inspect}, expiry_date: #{@expiry_date.inspect}, cvc:"\
+      " #{@cvc.inspect}, billing_address: #{@billing_address.inspect}, routing:"\
+      " #{@routing.inspect}, session_href: #{@session_href.inspect}, href: #{@href.inspect},"\
+      " cvc_session_href: #{@cvc_session_href.inspect}, wallet_token: #{@wallet_token.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payment_refused_response.rb

@@ -0,0 +1,187 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # PaymentRefusedResponse Model.
+  class PaymentRefusedResponse < DeviceDataResponse201
+    # Additional context on the refusal.
+    # @return [String]
+    attr_accessor :refusal_description
+
+    # Response code for the request.
+    # @return [String]
+    attr_accessor :refusal_code
+
+    # Contains suggested next actions for this request.
+    # @return [Advice]
+    attr_accessor :advice
+
+    # Contains suggested next actions for this request.
+    # @return [PaymentsResponsePaymentInstrument]
+    attr_accessor :payment_instrument
+
+    # Details of the updated payment instrument.
+    # @return [UpdatedPaymentInstrument]
+    attr_accessor :updated_payment_instrument
+
+    # Any risk factors which have been identified for the authorization. This
+    # section will not appear if no risks are identified.
+    # @return [Array[RiskFactor]]
+    attr_accessor :risk_factors
+
+    # Details of the outcome of the Fraud assessment
+    # @return [Fraud]
+    attr_accessor :fraud
+
+    # Details of the outcome of the 3DS authentication
+    # @return [Verification]
+    attr_accessor :three_ds
+
+    # An object containing information about the exemption.
+    # @return [PaymentsExemption]
+    attr_accessor :exemption
+
+    # Details of the token created
+    # @return [Token]
+    attr_accessor :token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refusal_description'] = 'refusalDescription'
+      @_hash['refusal_code'] = 'refusalCode'
+      @_hash['advice'] = 'advice'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['updated_payment_instrument'] = 'updatedPaymentInstrument'
+      @_hash['risk_factors'] = 'riskFactors'
+      @_hash['fraud'] = 'fraud'
+      @_hash['three_ds'] = 'threeDS'
+      @_hash['exemption'] = 'exemption'
+      @_hash['token'] = 'token'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        refusal_description
+        refusal_code
+        advice
+        payment_instrument
+        updated_payment_instrument
+        risk_factors
+        fraud
+        three_ds
+        exemption
+        token
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(refusal_description = SKIP, refusal_code = SKIP,
+                   advice = SKIP, payment_instrument = SKIP,
+                   updated_payment_instrument = SKIP, risk_factors = SKIP,
+                   fraud = SKIP, three_ds = SKIP, exemption = SKIP,
+                   token = SKIP, outcome = 'refused',
+                   transaction_reference = SKIP)
+      @refusal_description = refusal_description unless refusal_description == SKIP
+      @refusal_code = refusal_code unless refusal_code == SKIP
+      @advice = advice unless advice == SKIP
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      unless updated_payment_instrument == SKIP
+        @updated_payment_instrument =
+          updated_payment_instrument
+      end
+      @risk_factors = risk_factors unless risk_factors == SKIP
+      @fraud = fraud unless fraud == SKIP
+      @three_ds = three_ds unless three_ds == SKIP
+      @exemption = exemption unless exemption == SKIP
+      @token = token unless token == SKIP
+
+      # Call the constructor of the base class
+      super(outcome,
+            transaction_reference)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      refusal_description =
+        hash.key?('refusalDescription') ? hash['refusalDescription'] : SKIP
+      refusal_code = hash.key?('refusalCode') ? hash['refusalCode'] : SKIP
+      advice = Advice.from_hash(hash['advice']) if hash['advice']
+      payment_instrument = PaymentsResponsePaymentInstrument.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      if hash['updatedPaymentInstrument']
+        updated_payment_instrument = UpdatedPaymentInstrument.from_hash(hash['updatedPaymentInstrument'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      risk_factors = nil
+      unless hash['riskFactors'].nil?
+        risk_factors = []
+        hash['riskFactors'].each do |structure|
+          risk_factors << (RiskFactor.from_hash(structure) if structure)
+        end
+      end
+
+      risk_factors = SKIP unless hash.key?('riskFactors')
+      fraud = Fraud.from_hash(hash['fraud']) if hash['fraud']
+      three_ds = Verification.from_hash(hash['threeDS']) if hash['threeDS']
+      exemption = PaymentsExemption.from_hash(hash['exemption']) if hash['exemption']
+      token = Token.from_hash(hash['token']) if hash['token']
+      outcome = hash['outcome'] ||= 'refused'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      PaymentRefusedResponse.new(refusal_description,
+                                 refusal_code,
+                                 advice,
+                                 payment_instrument,
+                                 updated_payment_instrument,
+                                 risk_factors,
+                                 fraud,
+                                 three_ds,
+                                 exemption,
+                                 token,
+                                 outcome,
+                                 transaction_reference)
+    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}, refusal_description: #{@refusal_description},"\
+      " refusal_code: #{@refusal_code}, advice: #{@advice}, payment_instrument:"\
+      " #{@payment_instrument}, updated_payment_instrument: #{@updated_payment_instrument},"\
+      " risk_factors: #{@risk_factors}, fraud: #{@fraud}, three_ds: #{@three_ds}, exemption:"\
+      " #{@exemption}, token: #{@token}>"
+    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}, refusal_description: #{@refusal_description.inspect},"\
+      " refusal_code: #{@refusal_code.inspect}, advice: #{@advice.inspect}, payment_instrument:"\
+      " #{@payment_instrument.inspect}, updated_payment_instrument:"\
+      " #{@updated_payment_instrument.inspect}, risk_factors: #{@risk_factors.inspect}, fraud:"\
+      " #{@fraud.inspect}, three_ds: #{@three_ds.inspect}, exemption: #{@exemption.inspect},"\
+      " token: #{@token.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payment_request.rb

@@ -0,0 +1,96 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentRequest Model.
+  class PaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique reference generated by you that is used to identify a payment
+    # throughout its lifecycle.
+    # @return [String]
+    attr_accessor :transaction_reference
+
+    # An object that contains information about the merchant.
+    # @return [Merchant]
+    attr_accessor :merchant
+
+    # An object that contains all information related to the payment and API
+    # configurations.
+    # @return [PaymentsInstruction]
+    attr_accessor :instruction
+
+    # Interaction between the cardholder and you. Supply a value of `ecom` to
+    # process an eCommerce authorization. Supply a value of `moto` to process an
+    # authorization as a [__Mail Order or Telephone
+    # Order__](/products/payments/enable-features/moto) transaction.
+    # __Note: 3DS authentication cannot be supplied for MOTO payments__.
+    # @return [Channel1Enum]
+    attr_accessor :channel
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_reference'] = 'transactionReference'
+      @_hash['merchant'] = 'merchant'
+      @_hash['instruction'] = 'instruction'
+      @_hash['channel'] = 'channel'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        channel
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_reference = nil, merchant = nil,
+                   instruction = nil, channel = SKIP)
+      @transaction_reference = transaction_reference
+      @merchant = merchant
+      @instruction = instruction
+      @channel = channel unless channel == 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.
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : nil
+      merchant = Merchant.from_hash(hash['merchant']) if hash['merchant']
+      instruction = PaymentsInstruction.from_hash(hash['instruction']) if hash['instruction']
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+
+      # Create object from extracted values.
+      PaymentRequest.new(transaction_reference,
+                         merchant,
+                         instruction,
+                         channel)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_reference: #{@transaction_reference}, merchant: #{@merchant},"\
+      " instruction: #{@instruction}, channel: #{@channel}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_reference: #{@transaction_reference.inspect}, merchant:"\
+      " #{@merchant.inspect}, instruction: #{@instruction.inspect}, channel: #{@channel.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_action_cancel.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Cancel the payment. See [details](../payments-lifecycle/cancel)
+  class PaymentsActionCancel < 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.
+      PaymentsActionCancel.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_complete3ds_challenge.rb

@@ -0,0 +1,72 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Resume the payment following the 3DS challenge being completed by the
+  # customer. See [details](../3ds-actions/complete3dschallenge)
+  class PaymentsActionComplete3dsChallenge < 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.
+      PaymentsActionComplete3dsChallenge.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_partial_refund.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Partially refund the payment.
+  class PaymentsActionPartialRefund < 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.
+      PaymentsActionPartialRefund.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