hamza-payments-query-sdk 1.0.0

data/lib/payments/models/challenge.rb

@@ -0,0 +1,100 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing 3DS challenge preferences and configuration.
+  class Challenge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Once the customer completes the challenge page the issuer redirects/posts
+    # to the returnUrl in order for you to resume the session. It must be the
+    # full URL path.
+    # @return [String]
+    attr_accessor :return_url
+
+    # Specify the challenge window size (width x height) that the issuer should
+    # use. This is to better tailor the experience to the customers device.
+    # Default is 390x400.
+    # @return [WindowSizeEnum]
+    attr_accessor :window_size
+
+    # Set a preference for how the Issuer decides on a 3DS challenge.
+    # @return [PreferenceEnum]
+    attr_accessor :preference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['return_url'] = 'returnUrl'
+      @_hash['window_size'] = 'windowSize'
+      @_hash['preference'] = 'preference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        window_size
+        preference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(return_url = nil, window_size = WindowSizeEnum::ENUM_390X400,
+                   preference = SKIP)
+      @return_url = return_url
+      @window_size = window_size unless window_size == SKIP
+      @preference = preference unless preference == 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.
+      return_url = hash.key?('returnUrl') ? hash['returnUrl'] : nil
+      window_size = hash['windowSize'] ||= WindowSizeEnum::ENUM_390X400
+      preference = hash.key?('preference') ? hash['preference'] : SKIP
+
+      # Create object from extracted values.
+      Challenge.new(return_url,
+                    window_size,
+                    preference)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Challenge | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.return_url,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['returnUrl'],
+                            ->(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} return_url: #{@return_url}, window_size: #{@window_size}, preference:"\
+      " #{@preference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} return_url: #{@return_url.inspect}, window_size: #{@window_size.inspect},"\
+      " preference: #{@preference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/challenge_info.rb

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

data/lib/payments/models/challenge_response201.rb

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

data/lib/payments/models/challenge_response202.rb

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

data/lib/payments/models/challenged_action_list.rb

@@ -0,0 +1,65 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ChallengedActionList Model.
+  class ChallengedActionList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resume the payment following the 3DS challenge being completed by the
+    # customer. See [details](../3ds-actions/complete3dschallenge)
+    # @return [PaymentsActionComplete3dsChallenge]
+    attr_accessor :complete3ds_challenge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['complete3ds_challenge'] = 'complete3dsChallenge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        complete3ds_challenge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(complete3ds_challenge = SKIP)
+      @complete3ds_challenge = complete3ds_challenge unless complete3ds_challenge == 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.
+      if hash['complete3dsChallenge']
+        complete3ds_challenge = PaymentsActionComplete3dsChallenge.from_hash(hash['complete3dsChallenge'])
+      end
+
+      # Create object from extracted values.
+      ChallengedActionList.new(complete3ds_challenge)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} complete3ds_challenge: #{@complete3ds_challenge}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} complete3ds_challenge: #{@complete3ds_challenge.inspect}>"
+    end
+  end
+end

data/lib/payments/models/challenged_response.rb

@@ -0,0 +1,96 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # ChallengedResponse Model.
+  class ChallengedResponse < DeviceDataResponse201
+    # Object that contains authentication related information.
+    # @return [Authentication]
+    attr_accessor :authentication
+
+    # Object that contains authentication related information.
+    # @return [ChallengeInfo]
+    attr_accessor :challenge
+
+    # Object that contains authentication related information.
+    # @return [ChallengedActionList]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authentication'] = 'authentication'
+      @_hash['challenge'] = 'challenge'
+      @_hash['actions'] = '_actions'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        authentication
+        challenge
+        actions
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(authentication = SKIP, challenge = SKIP, actions = SKIP,
+                   outcome = '3dsChallenged', transaction_reference = SKIP)
+      @authentication = authentication unless authentication == SKIP
+      @challenge = challenge unless challenge == SKIP
+      @actions = actions unless actions == 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.
+      authentication = Authentication.from_hash(hash['authentication']) if hash['authentication']
+      challenge = ChallengeInfo.from_hash(hash['challenge']) if hash['challenge']
+      actions = ChallengedActionList.from_hash(hash['_actions']) if hash['_actions']
+      outcome = hash['outcome'] ||= '3dsChallenged'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      ChallengedResponse.new(authentication,
+                             challenge,
+                             actions,
+                             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}, authentication: #{@authentication}, challenge:"\
+      " #{@challenge}, actions: #{@actions}>"
+    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}, authentication: #{@authentication.inspect}, challenge:"\
+      " #{@challenge.inspect}, actions: #{@actions.inspect}>"
+    end
+  end
+end

data/lib/payments/models/channel1_enum.rb

@@ -0,0 +1,27 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # 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__.
+  class Channel1Enum
+    CHANNEL1_ENUM = [
+      # TODO: Write general description for ECOM
+      ECOM = 'ecom'.freeze,
+
+      # TODO: Write general description for MOTO
+      MOTO = 'moto'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/channel_enum.rb

@@ -0,0 +1,24 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Determines the channel that the transaction came through. `native` should
+  # only be set if using the Cardinal 3DS SDK (iOS/Android)
+  class ChannelEnum
+    CHANNEL_ENUM = [
+      # TODO: Write general description for BROWSER
+      BROWSER = 'browser'.freeze,
+
+      # TODO: Write general description for NATIVE
+      NATIVE = 'native'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/conflict_payment_instrument.rb

@@ -0,0 +1,104 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ConflictPaymentInstrument Model.
+  class ConflictPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # Contains your customer's card or token expiry date.
+    # @return [ExpiryDate]
+    attr_accessor :card_expiry_date
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # 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['card_expiry_date'] = 'cardExpiryDate'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        card_number
+        card_holder_name
+        card_expiry_date
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, card_number = SKIP, card_holder_name = SKIP,
+                   card_expiry_date = SKIP, billing_address = 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
+      @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
+      @billing_address = billing_address unless billing_address == 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
+      card_expiry_date = ExpiryDate.from_hash(hash['cardExpiryDate']) if hash['cardExpiryDate']
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+
+      # Create object from extracted values.
+      ConflictPaymentInstrument.new(type,
+                                    card_number,
+                                    card_holder_name,
+                                    card_expiry_date,
+                                    billing_address)
+    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}, card_expiry_date: #{@card_expiry_date}, billing_address:"\
+      " #{@billing_address}>"
+    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}, card_expiry_date:"\
+      " #{@card_expiry_date.inspect}, billing_address: #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/payments/models/content_type_enum.rb

@@ -0,0 +1,20 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The content type
+  class ContentTypeEnum
+    CONTENT_TYPE_ENUM = [
+      # TODO: Write general description for ENUM_APPLICATIONJSON
+      ENUM_APPLICATIONJSON = 'application/json'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONTENT_TYPE_ENUM.include?(value)
+    end
+  end
+end