visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/point_of_sale_information1.rb

@@ -0,0 +1,148 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PointOfSaleInformation1 Model.
+  class PointOfSaleInformation1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Emv1]
+    attr_accessor :emv
+
+    # Point-of-sale details for the transaction. This value is returned only for
+    # **American Express Direct**.
+    # Visa Acceptance generates this value, which consists of a series of codes
+    # that identify terminal capability,
+    # security data, and specific conditions present at the time the transaction
+    # occurred. To comply with the CAPN
+    # requirements, this value must be included in all subsequent follow-on
+    # requests, such as captures and follow-on
+    # credits.
+    # When you perform authorizations, captures, and credits through Visa
+    # Acceptance, Visa Acceptance passes this value from
+    # the authorization service to the subsequent services for you. However,
+    # when you perform authorizations through
+    # Visa Acceptance and perform subsequent services through other financial
+    # institutions, you must ensure that your
+    # requests for captures and credits include this value.
+    # @return [String]
+    attr_accessor :amex_capn_data
+
+    # Identifier for the terminal at your retail location. You can define this
+    # value yourself, but consult the processor for requirements.
+    # #### Visa Acceptance through VisaNet
+    # A list of all possible values is stored in your Visa Acceptance account.
+    # If terminal ID validation is enabled for
+    # your Visa Acceptance account, the value you send for this field is
+    # validated against the list each time you include
+    # the field in a request. To enable or disable terminal ID validation,
+    # contact Visa Acceptance Customer Support.
+    # When you do not include this field in a request, Visa Acceptance uses the
+    # default value that is defined in your Visa Acceptance account.
+    # #### FDC Nashville Global
+    # To have your account configured to support this field, contact Visa
+    # Acceptance Customer Support. This value must be a value that FDC Nashville
+    # Global issued to you.
+    # #### For Payouts
+    # This field is applicable for Visa Acceptance through VisaNet.
+    # #### GPX
+    # Identifier for the terminal at your retail location. A list of all
+    # possible values is stored in your account.
+    # If terminal ID validation is enabled for your account, the value you send
+    # for this field is validated against
+    # the list each time you include the field in a request. To enable or
+    # disable terminal ID validation, contact
+    # customer support.
+    # When you do not include this field in a request, the default value that is
+    # defined in your account is used.
+    # Optional for authorizations.
+    # #### Used by
+    # **Authorization**
+    # Optional for the following processors. When you do not include this field
+    # in a request, the default value that is
+    # defined in your account is used.
+    #   - American Express Direct
+    #   - Credit Mutuel-CIC
+    #   - FDC Nashville Global
+    #   - SIX
+    # - Chase Paymentech Solutions: Optional field. If you include this field in
+    # your request, you must also include `pointOfSaleInformation.catLevel`.
+    # - FDMS Nashville: The default value that is defined in your account is
+    # used.
+    # - GPX
+    # - OmniPay Direct: Optional field.
+    # For the following processors, this field is not used.
+    # - GPN
+    # - JCN Gateway
+    # - RBS WorldPay Atlanta
+    # - TSYS Acquiring Solutions
+    # - Worldpay VAP
+    # #### Card Present reply
+    # Terminal identifier assigned by the acquirer. This value must be printed
+    # on the receipt.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emv'] = 'emv'
+      @_hash['amex_capn_data'] = 'amexCapnData'
+      @_hash['terminal_id'] = 'terminalId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emv
+        amex_capn_data
+        terminal_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emv = SKIP, amex_capn_data = SKIP, terminal_id = SKIP)
+      @emv = emv unless emv == SKIP
+      @amex_capn_data = amex_capn_data unless amex_capn_data == SKIP
+      @terminal_id = terminal_id unless terminal_id == 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.
+      emv = Emv1.from_hash(hash['emv']) if hash['emv']
+      amex_capn_data = hash.key?('amexCapnData') ? hash['amexCapnData'] : SKIP
+      terminal_id = hash.key?('terminalId') ? hash['terminalId'] : SKIP
+
+      # Create object from extracted values.
+      PointOfSaleInformation1.new(emv,
+                                  amex_capn_data,
+                                  terminal_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emv: #{@emv}, amex_capn_data: #{@amex_capn_data}, terminal_id:"\
+      " #{@terminal_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emv: #{@emv.inspect}, amex_capn_data: #{@amex_capn_data.inspect},"\
+      " terminal_id: #{@terminal_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/point_of_sale_information14.rb

@@ -0,0 +1,219 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PointOfSaleInformation14 Model.
+  class PointOfSaleInformation14 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for the terminal at your retail location. You can define this
+    # value yourself, but consult the processor for requirements.
+    # #### Visa Acceptance through VisaNet
+    # A list of all possible values is stored in your Visa Acceptance account.
+    # If terminal ID validation is enabled for
+    # your Visa Acceptance account, the value you send for this field is
+    # validated against the list each time you include
+    # the field in a request. To enable or disable terminal ID validation,
+    # contact Visa Acceptance Customer Support.
+    # When you do not include this field in a request, Visa Acceptance uses the
+    # default value that is defined in your Visa Acceptance account.
+    # #### FDC Nashville Global
+    # To have your account configured to support this field, contact Visa
+    # Acceptance Customer Support. This value must be a value that FDC Nashville
+    # Global issued to you.
+    # #### For Payouts
+    # This field is applicable for Visa Acceptance through VisaNet.
+    # #### GPX
+    # Identifier for the terminal at your retail location. A list of all
+    # possible values is stored in your account.
+    # If terminal ID validation is enabled for your account, the value you send
+    # for this field is validated against
+    # the list each time you include the field in a request. To enable or
+    # disable terminal ID validation, contact
+    # customer support.
+    # When you do not include this field in a request, the default value that is
+    # defined in your account is used.
+    # Optional for authorizations.
+    # #### Used by
+    # **Authorization**
+    # Optional for the following processors. When you do not include this field
+    # in a request, the default value that is
+    # defined in your account is used.
+    #   - American Express Direct
+    #   - Credit Mutuel-CIC
+    #   - FDC Nashville Global
+    #   - SIX
+    # - Chase Paymentech Solutions: Optional field. If you include this field in
+    # your request, you must also include `pointOfSaleInformation.catLevel`.
+    # - FDMS Nashville: The default value that is defined in your account is
+    # used.
+    # - GPX
+    # - OmniPay Direct: Optional field.
+    # For the following processors, this field is not used.
+    # - GPN
+    # - JCN Gateway
+    # - RBS WorldPay Atlanta
+    # - TSYS Acquiring Solutions
+    # - Worldpay VAP
+    # #### Card Present reply
+    # Terminal identifier assigned by the acquirer. This value must be printed
+    # on the receipt.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # Method of entering payment card information into the POS terminal.
+    # Possible values:
+    #  - `contact`: Read from direct contact with chip card.
+    #  - `contactless`: Read from a contactless interface using chip data.
+    #  - `keyed`: Manually keyed into POS terminal. This value is not supported
+    # on OmniPay Direct.
+    #  - `msd`: Read from a contactless interface using magnetic stripe data
+    # (MSD). This value is not supported on OmniPay Direct.
+    #  - `swiped`: Read from credit card magnetic stripe.
+    # The `contact`, `contactless`, and `msd` values are supported only for EMV
+    # transactions.
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # #### Card Present
+    # Card present information about EMV applies only to credit card processing
+    # and PIN debit processing. All other
+    # card present information applies only to credit card processing.
+    # #### PIN debit
+    # Required for a PIN debit purchase and a PIN debit credit request.
+    # @return [String]
+    attr_accessor :entry_mode
+
+    # POS terminal’s capability. Possible values:
+    #  - `1`: Terminal has a magnetic stripe reader only.
+    #  - `2`: Terminal has a magnetic stripe reader and manual entry capability.
+    #  - `3`: Terminal has manual entry capability only.
+    #  - `4`: Terminal can read chip cards.
+    #  - `5`: Terminal can read contactless chip cards; cannot use contact to
+    # read chip cards.
+    # For an EMV transaction, the value of this field must be `4` or `5`.
+    # #### PIN debit
+    # Required for PIN debit purchase and PIN debit credit request.
+    # #### Used by
+    # **Authorization**
+    # Required for the following processors:
+    # - American Express Direct
+    # - Chase Paymentech Solutions
+    # - Credit Mutuel-CIC
+    # - FDC Nashville Global
+    # - FDMS Nashville
+    # - OmniPay Direct
+    # - SIX
+    # - Worldpay VAP
+    # Optional for the following processors:
+    # - Visa Acceptance through VisaNet
+    # - GPN
+    # - GPX
+    # - JCN Gateway
+    # - RBS WorldPay Atlanta
+    # - TSYS Acquiring Solutions
+    # @return [Integer]
+    attr_accessor :terminal_capability
+
+    # Method that was used to verify the cardholder's identity. Possible values:
+    #   - `0`: No verification
+    #   - `1`: Signature
+    #   - `2`: PIN
+    #   - `3`: Cardholder device CVM
+    #   - `4`: Biometric
+    #   - `5`: OTP
+    # @return [Integer]
+    attr_accessor :cardholder_verification_method_used
+
+    # Method that was used to verify the cardholder's identity. Possible values:
+    #   - `0`: No verification
+    #   - `1`: Signature
+    #   - `2`: PIN
+    #   - `3`: Cardholder device CVM
+    #   - `4`: Biometric
+    #   - `5`: OTP
+    # @return [Emv2]
+    attr_accessor :emv
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['terminal_id'] = 'terminalId'
+      @_hash['entry_mode'] = 'entryMode'
+      @_hash['terminal_capability'] = 'terminalCapability'
+      @_hash['cardholder_verification_method_used'] =
+        'cardholderVerificationMethodUsed'
+      @_hash['emv'] = 'emv'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        terminal_id
+        entry_mode
+        terminal_capability
+        cardholder_verification_method_used
+        emv
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(terminal_id = SKIP, entry_mode = SKIP,
+                   terminal_capability = SKIP,
+                   cardholder_verification_method_used = SKIP, emv = SKIP)
+      @terminal_id = terminal_id unless terminal_id == SKIP
+      @entry_mode = entry_mode unless entry_mode == SKIP
+      @terminal_capability = terminal_capability unless terminal_capability == SKIP
+      unless cardholder_verification_method_used == SKIP
+        @cardholder_verification_method_used =
+          cardholder_verification_method_used
+      end
+      @emv = emv unless emv == 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.
+      terminal_id = hash.key?('terminalId') ? hash['terminalId'] : SKIP
+      entry_mode = hash.key?('entryMode') ? hash['entryMode'] : SKIP
+      terminal_capability =
+        hash.key?('terminalCapability') ? hash['terminalCapability'] : SKIP
+      cardholder_verification_method_used =
+        hash.key?('cardholderVerificationMethodUsed') ? hash['cardholderVerificationMethodUsed'] : SKIP
+      emv = Emv2.from_hash(hash['emv']) if hash['emv']
+
+      # Create object from extracted values.
+      PointOfSaleInformation14.new(terminal_id,
+                                   entry_mode,
+                                   terminal_capability,
+                                   cardholder_verification_method_used,
+                                   emv)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terminal_id: #{@terminal_id}, entry_mode: #{@entry_mode},"\
+      " terminal_capability: #{@terminal_capability}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used}, emv: #{@emv}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terminal_id: #{@terminal_id.inspect}, entry_mode: #{@entry_mode.inspect},"\
+      " terminal_capability: #{@terminal_capability.inspect}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used.inspect}, emv: #{@emv.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/point_of_sale_information2.rb

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

data/lib/visa_acceptance_merged_spec/models/point_of_sale_information6.rb

@@ -0,0 +1,86 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PointOfSaleInformation6 Model.
+  class PointOfSaleInformation6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Emv6]
+    attr_accessor :emv
+
+    # Point-of-sale details for the transaction. This value is returned only for
+    # **American Express Direct**.
+    # Visa Acceptance generates this value, which consists of a series of codes
+    # that identify terminal capability,
+    # security data, and specific conditions present at the time the transaction
+    # occurred. To comply with the CAPN
+    # requirements, this value must be included in all subsequent follow-on
+    # requests, such as captures and follow-on
+    # credits.
+    # When you perform authorizations, captures, and credits through Visa
+    # Acceptance, Visa Acceptance passes this value from
+    # the authorization service to the subsequent services for you. However,
+    # when you perform authorizations through
+    # Visa Acceptance and perform subsequent services through other financial
+    # institutions, you must ensure that your
+    # requests for captures and credits include this value.
+    # @return [String]
+    attr_accessor :amex_capn_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emv'] = 'emv'
+      @_hash['amex_capn_data'] = 'amexCapnData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emv
+        amex_capn_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emv = SKIP, amex_capn_data = SKIP)
+      @emv = emv unless emv == SKIP
+      @amex_capn_data = amex_capn_data unless amex_capn_data == 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.
+      emv = Emv6.from_hash(hash['emv']) if hash['emv']
+      amex_capn_data = hash.key?('amexCapnData') ? hash['amexCapnData'] : SKIP
+
+      # Create object from extracted values.
+      PointOfSaleInformation6.new(emv,
+                                  amex_capn_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emv: #{@emv}, amex_capn_data: #{@amex_capn_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} emv: #{@emv.inspect}, amex_capn_data: #{@amex_capn_data.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/point_of_sale_information7.rb

@@ -0,0 +1,113 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PointOfSaleInformation7 Model.
+  class PointOfSaleInformation7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for the terminal at your retail location. You can define this
+    # value yourself, but consult the processor for requirements.
+    # #### Visa Acceptance through VisaNet
+    # A list of all possible values is stored in your Visa Acceptance account.
+    # If terminal ID validation is enabled for
+    # your Visa Acceptance account, the value you send for this field is
+    # validated against the list each time you include
+    # the field in a request. To enable or disable terminal ID validation,
+    # contact Visa Acceptance Customer Support.
+    # When you do not include this field in a request, Visa Acceptance uses the
+    # default value that is defined in your Visa Acceptance account.
+    # #### FDC Nashville Global
+    # To have your account configured to support this field, contact Visa
+    # Acceptance Customer Support. This value must be a value that FDC Nashville
+    # Global issued to you.
+    # #### For Payouts
+    # This field is applicable for Visa Acceptance through VisaNet.
+    # #### GPX
+    # Identifier for the terminal at your retail location. A list of all
+    # possible values is stored in your account.
+    # If terminal ID validation is enabled for your account, the value you send
+    # for this field is validated against
+    # the list each time you include the field in a request. To enable or
+    # disable terminal ID validation, contact
+    # customer support.
+    # When you do not include this field in a request, the default value that is
+    # defined in your account is used.
+    # Optional for authorizations.
+    # #### Used by
+    # **Authorization**
+    # Optional for the following processors. When you do not include this field
+    # in a request, the default value that is
+    # defined in your account is used.
+    #   - American Express Direct
+    #   - Credit Mutuel-CIC
+    #   - FDC Nashville Global
+    #   - SIX
+    # - Chase Paymentech Solutions: Optional field. If you include this field in
+    # your request, you must also include `pointOfSaleInformation.catLevel`.
+    # - FDMS Nashville: The default value that is defined in your account is
+    # used.
+    # - GPX
+    # - OmniPay Direct: Optional field.
+    # For the following processors, this field is not used.
+    # - GPN
+    # - JCN Gateway
+    # - RBS WorldPay Atlanta
+    # - TSYS Acquiring Solutions
+    # - Worldpay VAP
+    # #### Card Present reply
+    # Terminal identifier assigned by the acquirer. This value must be printed
+    # on the receipt.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['terminal_id'] = 'terminalId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        terminal_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(terminal_id = SKIP)
+      @terminal_id = terminal_id unless terminal_id == 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.
+      terminal_id = hash.key?('terminalId') ? hash['terminalId'] : SKIP
+
+      # Create object from extracted values.
+      PointOfSaleInformation7.new(terminal_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terminal_id: #{@terminal_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} terminal_id: #{@terminal_id.inspect}>"
+    end
+  end
+end