visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/embedded2.rb

@@ -0,0 +1,63 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Embedded2 Model.
+  class Embedded2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bin Information of the PAN provided by BinLookUp Service. This is only
+    # retrieved when retrieveBinDetails=true is passed as a query parameter.
+    # @return [TmsBinLookup]
+    attr_accessor :bin_lookup
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bin_lookup'] = 'binLookup'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bin_lookup
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bin_lookup = SKIP)
+      @bin_lookup = bin_lookup unless bin_lookup == 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.
+      bin_lookup = TmsBinLookup.from_hash(hash['binLookup']) if hash['binLookup']
+
+      # Create object from extracted values.
+      Embedded2.new(bin_lookup)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bin_lookup: #{@bin_lookup}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bin_lookup: #{@bin_lookup.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/embedded20.rb

@@ -0,0 +1,71 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Payment Instrument Resources.
+  class Embedded20 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PaymentInstruments12]]
+    attr_accessor :payment_instruments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_instruments'] = 'paymentInstruments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_instruments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_instruments = SKIP)
+      @payment_instruments = payment_instruments unless payment_instruments == 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.
+      # Parameter is an array, so we need to iterate through it
+      payment_instruments = nil
+      unless hash['paymentInstruments'].nil?
+        payment_instruments = []
+        hash['paymentInstruments'].each do |structure|
+          payment_instruments << (PaymentInstruments12.from_hash(structure) if structure)
+        end
+      end
+
+      payment_instruments = SKIP unless hash.key?('paymentInstruments')
+
+      # Create object from extracted values.
+      Embedded20.new(payment_instruments)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_instruments: #{@payment_instruments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_instruments: #{@payment_instruments.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/embedded_actions.rb

@@ -0,0 +1,136 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Contains embedded actions, that includes status and response for every
+  # actions in the list.
+  class EmbeddedActions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CAPTURE1]
+    attr_accessor :capture
+
+    # TODO: Write general description for this method
+    # @return [DECISION]
+    attr_accessor :decision
+
+    # TODO: Write general description for this method
+    # @return [CONSUMERAUTHENTICATION]
+    attr_accessor :consumer_authentication
+
+    # TODO: Write general description for this method
+    # @return [VALIDATECONSUMERAUTHENTICATION]
+    attr_accessor :validate_consumer_authentication
+
+    # TODO: Write general description for this method
+    # @return [WATCHLISTSCREENING]
+    attr_accessor :watchlist_screening
+
+    # TODO: Write general description for this method
+    # @return [TOKENCREATE]
+    attr_accessor :token_create
+
+    # TODO: Write general description for this method
+    # @return [TOKENUPDATE]
+    attr_accessor :token_update
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['capture'] = 'CAPTURE'
+      @_hash['decision'] = 'DECISION'
+      @_hash['consumer_authentication'] = 'CONSUMER_AUTHENTICATION'
+      @_hash['validate_consumer_authentication'] =
+        'VALIDATE_CONSUMER_AUTHENTICATION'
+      @_hash['watchlist_screening'] = 'WATCHLIST_SCREENING'
+      @_hash['token_create'] = 'TOKEN_CREATE'
+      @_hash['token_update'] = 'TOKEN_UPDATE'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        capture
+        decision
+        consumer_authentication
+        validate_consumer_authentication
+        watchlist_screening
+        token_create
+        token_update
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(capture = SKIP, decision = SKIP,
+                   consumer_authentication = SKIP,
+                   validate_consumer_authentication = SKIP,
+                   watchlist_screening = SKIP, token_create = SKIP,
+                   token_update = SKIP)
+      @capture = capture unless capture == SKIP
+      @decision = decision unless decision == SKIP
+      @consumer_authentication = consumer_authentication unless consumer_authentication == SKIP
+      unless validate_consumer_authentication == SKIP
+        @validate_consumer_authentication =
+          validate_consumer_authentication
+      end
+      @watchlist_screening = watchlist_screening unless watchlist_screening == SKIP
+      @token_create = token_create unless token_create == SKIP
+      @token_update = token_update unless token_update == 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.
+      capture = CAPTURE1.from_hash(hash['CAPTURE']) if hash['CAPTURE']
+      decision = DECISION.from_hash(hash['DECISION']) if hash['DECISION']
+      consumer_authentication = CONSUMERAUTHENTICATION.from_hash(hash['CONSUMER_AUTHENTICATION']) if
+        hash['CONSUMER_AUTHENTICATION']
+      if hash['VALIDATE_CONSUMER_AUTHENTICATION']
+        validate_consumer_authentication = VALIDATECONSUMERAUTHENTICATION.from_hash(hash['VALIDATE_CONSUMER_AUTHENTICATION'])
+      end
+      watchlist_screening = WATCHLISTSCREENING.from_hash(hash['WATCHLIST_SCREENING']) if
+        hash['WATCHLIST_SCREENING']
+      token_create = TOKENCREATE.from_hash(hash['TOKEN_CREATE']) if hash['TOKEN_CREATE']
+      token_update = TOKENUPDATE.from_hash(hash['TOKEN_UPDATE']) if hash['TOKEN_UPDATE']
+
+      # Create object from extracted values.
+      EmbeddedActions.new(capture,
+                          decision,
+                          consumer_authentication,
+                          validate_consumer_authentication,
+                          watchlist_screening,
+                          token_create,
+                          token_update)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} capture: #{@capture}, decision: #{@decision}, consumer_authentication:"\
+      " #{@consumer_authentication}, validate_consumer_authentication:"\
+      " #{@validate_consumer_authentication}, watchlist_screening: #{@watchlist_screening},"\
+      " token_create: #{@token_create}, token_update: #{@token_update}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} capture: #{@capture.inspect}, decision: #{@decision.inspect},"\
+      " consumer_authentication: #{@consumer_authentication.inspect},"\
+      " validate_consumer_authentication: #{@validate_consumer_authentication.inspect},"\
+      " watchlist_screening: #{@watchlist_screening.inspect}, token_create:"\
+      " #{@token_create.inspect}, token_update: #{@token_update.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/embedded_actions1.rb

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

data/lib/visa_acceptance_merged_spec/models/emv.rb

@@ -0,0 +1,259 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Emv Model.
+  class Emv < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # EMV data that is transmitted from the chip card to the issuer, and from
+    # the issuer to the chip card. The EMV
+    # data is in the tag-length-value format and includes chip card tags,
+    # terminal tags, and transaction detail tags.
+    # For information about the individual tags, see the “Application
+    # Specification” section in the EMV 4.3 Specifications: 
+    # **Note** 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 processing is available only
+    # on FDC Nashville Global.
+    # **Important** The following tags contain sensitive information and **must
+    # not** be included in this field:
+    #  - `56`: Track 1 equivalent data
+    #  - `57`: Track 2 equivalent data
+    #  - `5A`: Application PAN
+    #  - `5F20`: Cardholder name
+    #  - `5F24`: Application expiration date (This sensitivity has been relaxed
+    # for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global,
+    # First Data Merchant Solutions, and SIX)
+    #  - `99`: Transaction PIN
+    #  - `9F0B`: Cardholder name (extended)
+    #  - `9F1F`: Track 1 discretionary data
+    #  - `9F20`: Track 2 discretionary data
+    # For captures, this field is required for contact EMV transactions.
+    # Otherwise, it is optional.
+    # For credits, this field is required for contact EMV stand-alone credits
+    # and contactless EMV stand-alone credits.
+    # Otherwise, it is optional.
+    # **Important** For contact EMV captures, contact EMV stand-alone credits,
+    # and contactless EMV stand-alone credits,
+    # you must include the following tags in this field. For all other types of
+    # EMV transactions, the following tags
+    # are optional.
+    #  - `95`: Terminal verification results
+    #  - `9F10`: Issuer application data
+    #  - `9F26`: Application cryptogram
+    # #### Visa Acceptance through VisaNet
+    # - In Japan: 199 bytes
+    # - In other countries: String (252)
+    # For Mastercard Transactions, Optionally Tag 9F60 (Authenticated
+    # Application Data) and 
+    # Tag 96 (Kernel Identifier - Terminal) can be included in the Field.
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # #### JCN Gateway
+    # The following tags must be included:
+    # - `4F`: Application identifier
+    # - `84`: Dedicated file name
+    # Data length: 199 bytes
+    # #### All other processors:
+    # String (999)
+    # #### Used by
+    # Authorization: Optional
+    # Authorization Reversal: Optional
+    # Credit: Optional
+    # PIN Debit processing (purchase, credit and reversal): Optional
+    # @return [String]
+    attr_accessor :tags
+
+    # Method that was used to verify the cardholder's identity.
+    # Possible values:
+    #  - `0`: No verification
+    #  - `1`: Signature
+    # This field is supported only on **American Express Direct**.
+    # @return [Integer]
+    attr_accessor :cardholder_verification_method_used
+
+    # Number assigned to a specific card when two or more cards are associated
+    # with the same primary account number.
+    # This value enables issuers to distinguish among multiple cards that are
+    # linked to the same account.
+    # This value can also act as a tracking tool when reissuing cards. 
+    # When this value is available, it is provided by the chip reader. 
+    # When the chip reader does not provide this value, do not include this
+    # field in your request.
+    # When sequence number is not provided via this API field, the value is
+    # extracted from EMV tag 5F34 for Visa and Mastercard transactions. To
+    # enable this feature please call support.
+    # **Note** 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 processing is available only on Visa Acceptance through VisaNet
+    # and FDC Nashville Global.
+    # #### Used by
+    # Authorization: Optional
+    # PIN Debit processing: Optional
+    # #### GPX
+    # This field only supports transactions from the following card types:
+    # - Visa
+    # - Mastercard
+    # - AMEX
+    # - Discover
+    # - Diners
+    # - JCB
+    # - Union Pay International
+    # @return [String]
+    attr_accessor :card_sequence_number
+
+    # Indicates whether a fallback method was used to enter credit card
+    # information into the POS terminal. When a
+    # technical problem prevents a successful exchange of information between a
+    # chip card and a chip-capable terminal:
+    #  1. Swipe the card or key the credit card information into the POS
+    # terminal.
+    #  2. Use the pointOfSaleInformation.entryMode field to indicate whether the
+    # information was swiped or keyed.
+    # Possible values:
+    # - `true`: Fallback method was used.
+    # - `false` (default): Fallback method was not used.
+    # This field is supported only on American Express Direct, Chase Paymentech
+    # Solutions, Visa Acceptance through VisaNet,
+    # FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fallback
+
+    # Reason for the EMV fallback transaction. An EMV fallback transaction
+    # occurs when an EMV transaction fails for
+    # one of these reasons:
+    #  - Technical failure: the EMV terminal or EMV card cannot read and process
+    # chip data.
+    #  - Empty candidate list failure: the EMV terminal does not have any
+    # applications in common with the EMV card.
+    #    EMV terminals are coded to determine whether the terminal and EMV card
+    # have any applications in common.
+    #    EMV terminals provide this information to you.
+    # Possible values:
+    #  - `1`: Transaction was initiated with information from a magnetic stripe,
+    # and the previous transaction at the
+    #     EMV terminal either used information from a successful chip read or it
+    # was not a chip transaction.
+    #  - `2`: Transaction was initiated with information from a magnetic stripe,
+    # and the previous transaction at the
+    #     EMV terminal was an EMV fallback transaction because the attempted
+    # chip read was unsuccessful.
+    # This field is supported only on **GPN** and **JCN Gateway**.
+    # **NOTE**: This field is required when an EMV transaction fails for a
+    # technical reason. Do not include this field
+    # when the EMV terminal does not have any applications in common with the
+    # EMV card.
+    # @return [Integer]
+    attr_accessor :fallback_condition
+
+    # #### Visa Platform Connect
+    # Value “true” indicates this transaction is intentionally duplicated . The
+    # field contains value “true” which
+    # indicates that merchant has intentionally duplicated single tap
+    # transaction. Merchant is intentionally sending
+    # a duplicate auth request for a single tap txn because the issuer requested
+    # a PIN.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_repeat
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tags'] = 'tags'
+      @_hash['cardholder_verification_method_used'] =
+        'cardholderVerificationMethodUsed'
+      @_hash['card_sequence_number'] = 'cardSequenceNumber'
+      @_hash['fallback'] = 'fallback'
+      @_hash['fallback_condition'] = 'fallbackCondition'
+      @_hash['is_repeat'] = 'isRepeat'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        cardholder_verification_method_used
+        card_sequence_number
+        fallback
+        fallback_condition
+        is_repeat
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tags = SKIP, cardholder_verification_method_used = SKIP,
+                   card_sequence_number = SKIP, fallback = SKIP,
+                   fallback_condition = SKIP, is_repeat = SKIP)
+      @tags = tags unless tags == SKIP
+      unless cardholder_verification_method_used == SKIP
+        @cardholder_verification_method_used =
+          cardholder_verification_method_used
+      end
+      @card_sequence_number = card_sequence_number unless card_sequence_number == SKIP
+      @fallback = fallback unless fallback == SKIP
+      @fallback_condition = fallback_condition unless fallback_condition == SKIP
+      @is_repeat = is_repeat unless is_repeat == 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.
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      cardholder_verification_method_used =
+        hash.key?('cardholderVerificationMethodUsed') ? hash['cardholderVerificationMethodUsed'] : SKIP
+      card_sequence_number =
+        hash.key?('cardSequenceNumber') ? hash['cardSequenceNumber'] : SKIP
+      fallback = hash.key?('fallback') ? hash['fallback'] : SKIP
+      fallback_condition =
+        hash.key?('fallbackCondition') ? hash['fallbackCondition'] : SKIP
+      is_repeat = hash.key?('isRepeat') ? hash['isRepeat'] : SKIP
+
+      # Create object from extracted values.
+      Emv.new(tags,
+              cardholder_verification_method_used,
+              card_sequence_number,
+              fallback,
+              fallback_condition,
+              is_repeat)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used}, card_sequence_number: #{@card_sequence_number},"\
+      " fallback: #{@fallback}, fallback_condition: #{@fallback_condition}, is_repeat:"\
+      " #{@is_repeat}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tags: #{@tags.inspect}, cardholder_verification_method_used:"\
+      " #{@cardholder_verification_method_used.inspect}, card_sequence_number:"\
+      " #{@card_sequence_number.inspect}, fallback: #{@fallback.inspect}, fallback_condition:"\
+      " #{@fallback_condition.inspect}, is_repeat: #{@is_repeat.inspect}>"
+    end
+  end
+end