hamza-payments-query-sdk 1.0.0

data/lib/payments/models/shipping.rb

@@ -0,0 +1,130 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Shipping Model.
+  class Shipping < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The shipping method used.
+    # @return [MethodEnum]
+    attr_accessor :method
+
+    # The shipping method used.
+    # @return [TimeFrameEnum]
+    attr_accessor :time_frame
+
+    # The email address used for an electronic delivery.
+    # @return [String]
+    attr_accessor :email
+
+    # The phone number used for delivery.
+    # @return [String]
+    attr_accessor :phone
+
+    # First name used on the shipping address.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Last name used on the shipping address.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Last name used on the shipping address.
+    # @return [PaymentsShippingAddress]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['time_frame'] = 'timeFrame'
+      @_hash['email'] = 'email'
+      @_hash['phone'] = 'phone'
+      @_hash['first_name'] = 'firstName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+        time_frame
+        email
+        phone
+        first_name
+        last_name
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method = SKIP, time_frame = SKIP, email = SKIP, phone = SKIP,
+                   first_name = SKIP, last_name = SKIP, address = SKIP)
+      @method = method unless method == SKIP
+      @time_frame = time_frame unless time_frame == SKIP
+      @email = email unless email == SKIP
+      @phone = phone unless phone == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @address = address unless 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.
+      method = hash.key?('method') ? hash['method'] : SKIP
+      time_frame = hash.key?('timeFrame') ? hash['timeFrame'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      address = PaymentsShippingAddress.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      Shipping.new(method,
+                   time_frame,
+                   email,
+                   phone,
+                   first_name,
+                   last_name,
+                   address)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Shipping | 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} method: #{@method}, time_frame: #{@time_frame}, email: #{@email}, phone:"\
+      " #{@phone}, first_name: #{@first_name}, last_name: #{@last_name}, address: #{@address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, time_frame: #{@time_frame.inspect}, email:"\
+      " #{@email.inspect}, phone: #{@phone.inspect}, first_name: #{@first_name.inspect},"\
+      " last_name: #{@last_name.inspect}, address: #{@address.inspect}>"
+    end
+  end
+end

data/lib/payments/models/stored_card_usage1_enum.rb

@@ -0,0 +1,24 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Set to `first` to store a card or `subsequent` to use a previously stored
+  # card. Mandatory for `merchant` installment type.
+  class StoredCardUsage1Enum
+    STORED_CARD_USAGE1_ENUM = [
+      # TODO: Write general description for FIRST
+      FIRST = 'first'.freeze,
+
+      # TODO: Write general description for SUBSEQUENT
+      SUBSEQUENT = 'subsequent'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STORED_CARD_USAGE1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/stored_card_usage_enum.rb

@@ -0,0 +1,24 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Set to `first` to store a card or `subsequent` to use a previously stored
+  # card.
+  class StoredCardUsageEnum
+    STORED_CARD_USAGE_ENUM = [
+      # TODO: Write general description for FIRST
+      FIRST = 'first'.freeze,
+
+      # TODO: Write general description for SUBSEQUENT
+      SUBSEQUENT = 'subsequent'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STORED_CARD_USAGE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/time_frame_enum.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # TimeFrame.
+  class TimeFrameEnum
+    TIME_FRAME_ENUM = [
+      # TODO: Write general description for ELECTRONIC
+      ELECTRONIC = 'electronic'.freeze,
+
+      # TODO: Write general description for SAMEDAY
+      SAMEDAY = 'sameDay'.freeze,
+
+      # TODO: Write general description for NEXTDAY
+      NEXTDAY = 'nextDay'.freeze,
+
+      # TODO: Write general description for TWODAYSPLUS
+      TWODAYSPLUS = 'twoDaysPlus'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TIME_FRAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/token.rb

@@ -0,0 +1,168 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details of the token created
+  class Token < 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 :token_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :token_expiry_date_time
+
+    # 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
+
+    # Contains your customer's card or token expiry date.
+    # @return [String]
+    attr_accessor :bin
+
+    # Contains your customer's card or token expiry date.
+    # @return [String]
+    attr_accessor :funding_type
+
+    # Contains your customer's card or token expiry date.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Contains your customer's card or token expiry date.
+    # @return [String]
+    attr_accessor :scheme_reference
+
+    # Contains your customer's card or token expiry date.
+    # @return [TokenResponseConflicts]
+    attr_accessor :conflicts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['token_id'] = 'tokenId'
+      @_hash['token_expiry_date_time'] = 'tokenExpiryDateTime'
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['card_expiry'] = 'cardExpiry'
+      @_hash['bin'] = 'bin'
+      @_hash['funding_type'] = 'fundingType'
+      @_hash['country_code'] = 'countryCode'
+      @_hash['scheme_reference'] = 'schemeReference'
+      @_hash['conflicts'] = 'conflicts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        token_id
+        token_expiry_date_time
+        card_number
+        card_holder_name
+        card_expiry
+        bin
+        funding_type
+        country_code
+        scheme_reference
+        conflicts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, token_id = SKIP, token_expiry_date_time = SKIP,
+                   card_number = SKIP, card_holder_name = SKIP,
+                   card_expiry = SKIP, bin = SKIP, funding_type = SKIP,
+                   country_code = SKIP, scheme_reference = SKIP,
+                   conflicts = SKIP)
+      @href = href unless href == SKIP
+      @token_id = token_id unless token_id == SKIP
+      @token_expiry_date_time = token_expiry_date_time unless token_expiry_date_time == SKIP
+      @card_number = card_number unless card_number == SKIP
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @card_expiry = card_expiry unless card_expiry == SKIP
+      @bin = bin unless bin == SKIP
+      @funding_type = funding_type unless funding_type == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @scheme_reference = scheme_reference unless scheme_reference == SKIP
+      @conflicts = conflicts unless conflicts == 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
+      token_id = hash.key?('tokenId') ? hash['tokenId'] : SKIP
+      token_expiry_date_time =
+        hash.key?('tokenExpiryDateTime') ? hash['tokenExpiryDateTime'] : SKIP
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      card_expiry = ExpiryDate.from_hash(hash['cardExpiry']) if hash['cardExpiry']
+      bin = hash.key?('bin') ? hash['bin'] : SKIP
+      funding_type = hash.key?('fundingType') ? hash['fundingType'] : SKIP
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+      conflicts = TokenResponseConflicts.from_hash(hash['conflicts']) if hash['conflicts']
+
+      # Create object from extracted values.
+      Token.new(href,
+                token_id,
+                token_expiry_date_time,
+                card_number,
+                card_holder_name,
+                card_expiry,
+                bin,
+                funding_type,
+                country_code,
+                scheme_reference,
+                conflicts)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, token_id: #{@token_id}, token_expiry_date_time:"\
+      " #{@token_expiry_date_time}, card_number: #{@card_number}, card_holder_name:"\
+      " #{@card_holder_name}, card_expiry: #{@card_expiry}, bin: #{@bin}, funding_type:"\
+      " #{@funding_type}, country_code: #{@country_code}, scheme_reference: #{@scheme_reference},"\
+      " conflicts: #{@conflicts}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, token_id: #{@token_id.inspect},"\
+      " token_expiry_date_time: #{@token_expiry_date_time.inspect}, card_number:"\
+      " #{@card_number.inspect}, card_holder_name: #{@card_holder_name.inspect}, card_expiry:"\
+      " #{@card_expiry.inspect}, bin: #{@bin.inspect}, funding_type: #{@funding_type.inspect},"\
+      " country_code: #{@country_code.inspect}, scheme_reference: #{@scheme_reference.inspect},"\
+      " conflicts: #{@conflicts.inspect}>"
+    end
+  end
+end

data/lib/payments/models/token_creation.rb

@@ -0,0 +1,95 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Use this object if you want to create a token after the payment. Can only be
+  # used with paymentInstrument.type: card/plain & checkout.
+  class TokenCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # A namespace is used to group up to 16 cards, e.g. for one customer. A card
+    # can exist in more than one namespace.
+    # @return [String]
+    attr_accessor :namespace
+
+    # A description of your token. If not supplied, a default description is
+    # created for you.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['namespace'] = 'namespace'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        namespace
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(namespace = SKIP, description = SKIP)
+      @type = 'worldpay'
+      @namespace = namespace unless namespace == SKIP
+      @description = description unless description == 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.
+      namespace = hash.key?('namespace') ? hash['namespace'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      TokenCreation.new(namespace,
+                        description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TokenCreation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(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} type: #{@type}, namespace: #{@namespace}, description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, namespace: #{@namespace.inspect}, description:"\
+      " #{@description.inspect}>"
+    end
+  end
+end

data/lib/payments/models/token_payment_instrument.rb

@@ -0,0 +1,118 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_payment_instrument'
+
+module Payments
+  # TokenPaymentInstrument Model.
+  class TokenPaymentInstrument < PaymentsPaymentInstrument
+    # An http address that contains your link to an Access Token.
+    # @return [String]
+    attr_accessor :href
+
+    # 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
+
+    # 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
+
+    # An object containing specific routing preferences.
+    # @return [Routing]
+    attr_accessor :routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['cvc'] = 'cvc'
+      @_hash['cvc_session_href'] = 'cvcSessionHref'
+      @_hash['routing'] = 'routing'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        cvc
+        cvc_session_href
+        routing
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(href = nil, cvc = SKIP, cvc_session_href = SKIP,
+                   routing = SKIP, type = 'token')
+      @href = href
+      @cvc = cvc unless cvc == SKIP
+      @cvc_session_href = cvc_session_href unless cvc_session_href == SKIP
+      @routing = routing unless routing == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      cvc = hash.key?('cvc') ? hash['cvc'] : SKIP
+      cvc_session_href =
+        hash.key?('cvcSessionHref') ? hash['cvcSessionHref'] : SKIP
+      routing = Routing.from_hash(hash['routing']) if hash['routing']
+      type = hash['type'] ||= 'token'
+
+      # Create object from extracted values.
+      TokenPaymentInstrument.new(href,
+                                 cvc,
+                                 cvc_session_href,
+                                 routing,
+                                 type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TokenPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.href,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['href'],
+                            ->(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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, href: #{@href}, cvc: #{@cvc}, cvc_session_href:"\
+      " #{@cvc_session_href}, routing: #{@routing}>"
+    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}, href: #{@href.inspect}, cvc: #{@cvc.inspect},"\
+      " cvc_session_href: #{@cvc_session_href.inspect}, routing: #{@routing.inspect}>"
+    end
+  end
+end

data/lib/payments/models/token_response_conflicts.rb

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