visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/processor_information2.rb

@@ -0,0 +1,247 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation2 Model.
+  class ProcessorInformation2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorization code. Returned only when the processor returns this value.
+    # The length of this value depends on your processor.
+    # Returned by authorization service.
+    # #### PIN debit
+    # Authorization code that is returned by the processor.
+    # Returned by PIN debit credit.
+    # #### Elavon Encrypted Account Number Program
+    # The returned value is OFFLINE.
+    # #### TSYS Acquiring Solutions
+    # The returned value for a successful zero amount authorization is 000000.
+    # @return [String]
+    attr_accessor :approval_code
+
+    # Network transaction identifier (TID). You can use this value to identify a
+    # specific transaction when you are
+    # discussing the transaction with your processor. Not all processors provide
+    # this value.
+    # Returned by the authorization service.
+    # #### PIN debit
+    # Transaction identifier generated by the processor.
+    # Returned by PIN debit credit.
+    # #### GPX
+    # Processor transaction ID.
+    # #### Cielo
+    # For Cielo, this value is the non-sequential unit (NSU) and is supported
+    # for all transactions. The value is generated by Cielo or the issuing bank.
+    # #### Comercio Latino
+    # For Comercio Latino, this value is the proof of sale or non-sequential
+    # unit (NSU) number generated by the acquirers Cielo and Rede, or the
+    # issuing bank.
+    # #### Visa Acceptance through VisaNet and GPN
+    # For details about this value for Visa Acceptance through VisaNet and GPN,
+    # see "processorInformation.networkTransactionId" in [REST API Fields](
+    # #### Moneris
+    # This value identifies the transaction on a host system. It contains the
+    # following information:
+    # - Terminal used to process the transaction
+    # - Shift during which the transaction took place
+    # - Batch number
+    # - Transaction number within the batch
+    # You must store this value. If you give the customer a receipt, display
+    # this value on the receipt.
+    # **Example** For the value
+    # 66012345001069003:
+    # - Terminal ID = 66012345
+    # - Shift number = 001
+    # - Batch number = 069
+    # - Transaction number = 003
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Same value as `processorInformation.transactionId`
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # For most processors, this is the error message sent directly from the
+    # bank. Returned only when the processor
+    # returns this value.
+    # **Important** Do not use this field to evaluate the result of the
+    # authorization.
+    # #### PIN debit
+    # Response value that is returned by the processor or bank.
+    # **Important** Do not use this field to evaluate the results of the
+    # transaction request.
+    # Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal.
+    # #### AIBMS
+    # If this value is `08`, you can accept the transaction if the customer
+    # provides you with identification.
+    # #### Atos
+    # This value is the response code sent from Atos and it might also include
+    # the response code from the bank.
+    # Format: `aa,bb` with the two values separated by a comma and where:
+    # - `aa` is the two-digit error message from Atos.
+    # - `bb` is the optional two-digit error message from the bank.
+    # #### Comercio Latino
+    # This value is the status code and the error or response code received from
+    # the processor separated by a colon.
+    # Format: [status code]:E[error code] or [status code]:R[response code]
+    # Example `2:R06`
+    # #### JCN Gateway
+    # Processor-defined detail error code. The associated response category code
+    # is in the `processorInformation.responseCategoryCode` field.
+    # String (3)
+    # #### paypalgateway
+    # Processor generated ID for the itemized detail.
+    # @return [String]
+    attr_accessor :response_code
+
+    # This field is returned only for **American Express Direct** and **Visa
+    # Acceptance through VisaNet**.
+    # Returned by authorization and incremental authorization services.
+    # #### American Express Direct
+    # System trace audit number (STAN). This value identifies the transaction
+    # and is useful when investigating a
+    # chargeback dispute.
+    # #### Visa Acceptance through VisaNet
+    # System trace number that must be printed on the customer’s receipt.
+    # @return [String]
+    attr_accessor :system_trace_audit_number
+
+    # This field might contain information about a decline. This field is
+    # supported only for **Visa Acceptance through
+    # VisaNet**.
+    # @return [String]
+    attr_accessor :response_details
+
+    # This field might contain information about a decline. This field is
+    # supported only for **Visa Acceptance through
+    # VisaNet**.
+    # @return [MerchantAdvice]
+    attr_accessor :merchant_advice
+
+    # Mastercard is introducing the Merchant Risk Predict Service in the middle
+    # East/Africa Region.
+    # A newly launched service comprised of seven independent artificial
+    # intelligence (AI)-powered scores intended to augment existing merchant
+    # risk management practices.
+    # @return [String]
+    attr_accessor :merchant_risk_prediction
+
+    # Mastercard is introducing the Merchant Risk Predict Service in the middle
+    # East/Africa Region.
+    # A newly launched service comprised of seven independent artificial
+    # intelligence (AI)-powered scores intended to augment existing merchant
+    # risk management practices.
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approval_code'] = 'approvalCode'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['network_transaction_id'] = 'networkTransactionId'
+      @_hash['response_code'] = 'responseCode'
+      @_hash['system_trace_audit_number'] = 'systemTraceAuditNumber'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash['merchant_advice'] = 'merchantAdvice'
+      @_hash['merchant_risk_prediction'] = 'merchantRiskPrediction'
+      @_hash['seller_protection'] = 'sellerProtection'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approval_code
+        transaction_id
+        network_transaction_id
+        response_code
+        system_trace_audit_number
+        response_details
+        merchant_advice
+        merchant_risk_prediction
+        seller_protection
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approval_code = SKIP, transaction_id = SKIP,
+                   network_transaction_id = SKIP, response_code = SKIP,
+                   system_trace_audit_number = SKIP, response_details = SKIP,
+                   merchant_advice = SKIP, merchant_risk_prediction = SKIP,
+                   seller_protection = SKIP)
+      @approval_code = approval_code unless approval_code == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      @response_code = response_code unless response_code == SKIP
+      unless system_trace_audit_number == SKIP
+        @system_trace_audit_number =
+          system_trace_audit_number
+      end
+      @response_details = response_details unless response_details == SKIP
+      @merchant_advice = merchant_advice unless merchant_advice == SKIP
+      @merchant_risk_prediction = merchant_risk_prediction unless merchant_risk_prediction == SKIP
+      @seller_protection = seller_protection unless seller_protection == 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.
+      approval_code = hash.key?('approvalCode') ? hash['approvalCode'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      network_transaction_id =
+        hash.key?('networkTransactionId') ? hash['networkTransactionId'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      system_trace_audit_number =
+        hash.key?('systemTraceAuditNumber') ? hash['systemTraceAuditNumber'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+      merchant_advice = MerchantAdvice.from_hash(hash['merchantAdvice']) if hash['merchantAdvice']
+      merchant_risk_prediction =
+        hash.key?('merchantRiskPrediction') ? hash['merchantRiskPrediction'] : SKIP
+      seller_protection = SellerProtection.from_hash(hash['sellerProtection']) if
+        hash['sellerProtection']
+
+      # Create object from extracted values.
+      ProcessorInformation2.new(approval_code,
+                                transaction_id,
+                                network_transaction_id,
+                                response_code,
+                                system_trace_audit_number,
+                                response_details,
+                                merchant_advice,
+                                merchant_risk_prediction,
+                                seller_protection)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} approval_code: #{@approval_code}, transaction_id: #{@transaction_id},"\
+      " network_transaction_id: #{@network_transaction_id}, response_code: #{@response_code},"\
+      " system_trace_audit_number: #{@system_trace_audit_number}, response_details:"\
+      " #{@response_details}, merchant_advice: #{@merchant_advice}, merchant_risk_prediction:"\
+      " #{@merchant_risk_prediction}, seller_protection: #{@seller_protection}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} approval_code: #{@approval_code.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, network_transaction_id: #{@network_transaction_id.inspect},"\
+      " response_code: #{@response_code.inspect}, system_trace_audit_number:"\
+      " #{@system_trace_audit_number.inspect}, response_details: #{@response_details.inspect},"\
+      " merchant_advice: #{@merchant_advice.inspect}, merchant_risk_prediction:"\
+      " #{@merchant_risk_prediction.inspect}, seller_protection: #{@seller_protection.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information20.rb

@@ -0,0 +1,140 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation20 Model.
+  class ProcessorInformation20 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Network transaction identifier (TID). You can use this value to identify a
+    # specific transaction when you are
+    # discussing the transaction with your processor. Not all processors provide
+    # this value.
+    # Returned by the authorization service.
+    # #### PIN debit
+    # Transaction identifier generated by the processor.
+    # Returned by PIN debit credit.
+    # #### GPX
+    # Processor transaction ID.
+    # #### Cielo
+    # For Cielo, this value is the non-sequential unit (NSU) and is supported
+    # for all transactions. The value is generated by Cielo or the issuing bank.
+    # #### Comercio Latino
+    # For Comercio Latino, this value is the proof of sale or non-sequential
+    # unit (NSU) number generated by the acquirers Cielo and Rede, or the
+    # issuing bank.
+    # #### Visa Acceptance through VisaNet and GPN
+    # For details about this value for Visa Acceptance through VisaNet and GPN,
+    # see "processorInformation.networkTransactionId" in [REST API Fields](
+    # #### Moneris
+    # This value identifies the transaction on a host system. It contains the
+    # following information:
+    # - Terminal used to process the transaction
+    # - Shift during which the transaction took place
+    # - Batch number
+    # - Transaction number within the batch
+    # You must store this value. If you give the customer a receipt, display
+    # this value on the receipt.
+    # **Example** For the value
+    # 66012345001069003:
+    # - Terminal ID = 66012345
+    # - Shift number = 001
+    # - Batch number = 069
+    # - Transaction number = 003
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Direct the customer to this URL to complete the payment.
+    # @return [String]
+    attr_accessor :payment_url
+
+    # This field might contain information about a decline. This field is
+    # supported only for **Visa Acceptance through
+    # VisaNet**.
+    # @return [String]
+    attr_accessor :response_details
+
+    # Payment gateway/processor assigned session token.
+    # @return [String]
+    attr_accessor :token
+
+    # Transaction status from the processor.
+    # @return [String]
+    attr_accessor :response_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['payment_url'] = 'paymentUrl'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash['token'] = 'token'
+      @_hash['response_code'] = 'responseCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        payment_url
+        response_details
+        token
+        response_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP, payment_url = SKIP,
+                   response_details = SKIP, token = SKIP, response_code = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @payment_url = payment_url unless payment_url == SKIP
+      @response_details = response_details unless response_details == SKIP
+      @token = token unless token == SKIP
+      @response_code = response_code unless response_code == 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_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      payment_url = hash.key?('paymentUrl') ? hash['paymentUrl'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation20.new(transaction_id,
+                                 payment_url,
+                                 response_details,
+                                 token,
+                                 response_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id}, payment_url: #{@payment_url},"\
+      " response_details: #{@response_details}, token: #{@token}, response_code:"\
+      " #{@response_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id.inspect}, payment_url:"\
+      " #{@payment_url.inspect}, response_details: #{@response_details.inspect}, token:"\
+      " #{@token.inspect}, response_code: #{@response_code.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information22.rb

@@ -0,0 +1,118 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation22 Model.
+  class ProcessorInformation22 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Network transaction identifier (TID). You can use this value to identify a
+    # specific transaction when you are
+    # discussing the transaction with your processor. Not all processors provide
+    # this value.
+    # Returned by the authorization service.
+    # #### PIN debit
+    # Transaction identifier generated by the processor.
+    # Returned by PIN debit credit.
+    # #### GPX
+    # Processor transaction ID.
+    # #### Cielo
+    # For Cielo, this value is the non-sequential unit (NSU) and is supported
+    # for all transactions. The value is generated by Cielo or the issuing bank.
+    # #### Comercio Latino
+    # For Comercio Latino, this value is the proof of sale or non-sequential
+    # unit (NSU) number generated by the acquirers Cielo and Rede, or the
+    # issuing bank.
+    # #### Visa Acceptance through VisaNet and GPN
+    # For details about this value for Visa Acceptance through VisaNet and GPN,
+    # see "processorInformation.networkTransactionId" in [REST API Fields](
+    # #### Moneris
+    # This value identifies the transaction on a host system. It contains the
+    # following information:
+    # - Terminal used to process the transaction
+    # - Shift during which the transaction took place
+    # - Batch number
+    # - Transaction number within the batch
+    # You must store this value. If you give the customer a receipt, display
+    # this value on the receipt.
+    # **Example** For the value
+    # 66012345001069003:
+    # - Terminal ID = 66012345
+    # - Shift number = 001
+    # - Batch number = 069
+    # - Transaction number = 003
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Same value as `processorInformation.transactionId`
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # Direct the customer to this URL to complete the payment.
+    # @return [String]
+    attr_accessor :payment_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['network_transaction_id'] = 'networkTransactionId'
+      @_hash['payment_url'] = 'paymentUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        network_transaction_id
+        payment_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP, network_transaction_id = SKIP,
+                   payment_url = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      @payment_url = payment_url unless payment_url == 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_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      network_transaction_id =
+        hash.key?('networkTransactionId') ? hash['networkTransactionId'] : SKIP
+      payment_url = hash.key?('paymentUrl') ? hash['paymentUrl'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation22.new(transaction_id,
+                                 network_transaction_id,
+                                 payment_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id}, network_transaction_id:"\
+      " #{@network_transaction_id}, payment_url: #{@payment_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id.inspect}, network_transaction_id:"\
+      " #{@network_transaction_id.inspect}, payment_url: #{@payment_url.inspect}>"
+    end
+  end
+end