visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/processor_information10.rb

@@ -0,0 +1,121 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation10 Model.
+  class ProcessorInformation10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # The reason for when the transaction status is Pending or Reversed.
+    # Possible values:
+    # - `PAYER_SHIPPING_UNCONFIRMED`
+    # - `MULTI_CURRENCY`
+    # - `RISK_REVIEW`
+    # - `REGULATORY_REVIEW`
+    # - `VERIFICATION_REQUIRED`
+    # - `ORDER`
+    # - `OTHER`
+    # @return [String]
+    attr_accessor :response_details
+
+    # Identifier of the order transaction.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_code'] = 'responseCode'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_code
+        response_details
+        transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response_code = SKIP, response_details = SKIP,
+                   transaction_id = SKIP)
+      @response_code = response_code unless response_code == SKIP
+      @response_details = response_details unless response_details == SKIP
+      @transaction_id = transaction_id unless transaction_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.
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation10.new(response_code,
+                                 response_details,
+                                 transaction_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_code: #{@response_code}, response_details: #{@response_details},"\
+      " transaction_id: #{@transaction_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_code: #{@response_code.inspect}, response_details:"\
+      " #{@response_details.inspect}, transaction_id: #{@transaction_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information15.rb

@@ -0,0 +1,174 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation15 Model.
+  class ProcessorInformation15 < 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
+
+    # The description for this field is not available.
+    # @return [String]
+    attr_accessor :trade_number
+
+    # This field is set to the value of failure reason returned by the
+    # processor.
+    # @return [String]
+    attr_accessor :raw_response
+
+    # This field is set to the value of failure reason returned by the processor
+    # in the local language of the processor.
+    # @return [String]
+    attr_accessor :raw_response_local
+
+    # This field might contain information about a decline.
+    # @return [String]
+    attr_accessor :response_details
+
+    # This field is set to the value of response code returned by the processor.
+    # @return [String]
+    attr_accessor :response_code
+
+    # This field is set to the value of response code returned by the processor.
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # This field is set to the value of response code returned by the processor.
+    # @return [Avs1]
+    attr_accessor :avs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['trade_number'] = 'tradeNumber'
+      @_hash['raw_response'] = 'rawResponse'
+      @_hash['raw_response_local'] = 'rawResponseLocal'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash['response_code'] = 'responseCode'
+      @_hash['seller_protection'] = 'sellerProtection'
+      @_hash['avs'] = 'avs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        trade_number
+        raw_response
+        raw_response_local
+        response_details
+        response_code
+        seller_protection
+        avs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP, trade_number = SKIP,
+                   raw_response = SKIP, raw_response_local = SKIP,
+                   response_details = SKIP, response_code = SKIP,
+                   seller_protection = SKIP, avs = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @trade_number = trade_number unless trade_number == SKIP
+      @raw_response = raw_response unless raw_response == SKIP
+      @raw_response_local = raw_response_local unless raw_response_local == SKIP
+      @response_details = response_details unless response_details == SKIP
+      @response_code = response_code unless response_code == SKIP
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @avs = avs unless avs == 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
+      trade_number = hash.key?('tradeNumber') ? hash['tradeNumber'] : SKIP
+      raw_response = hash.key?('rawResponse') ? hash['rawResponse'] : SKIP
+      raw_response_local =
+        hash.key?('rawResponseLocal') ? hash['rawResponseLocal'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      seller_protection = SellerProtection.from_hash(hash['sellerProtection']) if
+        hash['sellerProtection']
+      avs = Avs1.from_hash(hash['avs']) if hash['avs']
+
+      # Create object from extracted values.
+      ProcessorInformation15.new(transaction_id,
+                                 trade_number,
+                                 raw_response,
+                                 raw_response_local,
+                                 response_details,
+                                 response_code,
+                                 seller_protection,
+                                 avs)
+    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}, trade_number: #{@trade_number},"\
+      " raw_response: #{@raw_response}, raw_response_local: #{@raw_response_local},"\
+      " response_details: #{@response_details}, response_code: #{@response_code},"\
+      " seller_protection: #{@seller_protection}, avs: #{@avs}>"
+    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}, trade_number:"\
+      " #{@trade_number.inspect}, raw_response: #{@raw_response.inspect}, raw_response_local:"\
+      " #{@raw_response_local.inspect}, response_details: #{@response_details.inspect},"\
+      " response_code: #{@response_code.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, avs: #{@avs.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information16.rb

@@ -0,0 +1,146 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation16 Model.
+  class ProcessorInformation16 < 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
+
+    # 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.
+    # #### SEPA/BACS
+    # Response code from the processor. Possible values: 00000–99999. See
+    # Appendix C,
+    # "Reason Codes and Processor Response
+    # Codes," on page 42.
+    # #### 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)
+    # @return [String]
+    attr_accessor :response_code
+
+    # Transaction ID assigned by the processor.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Response code indicating that creating the agreement failed
+    # @return [String]
+    attr_accessor :response_details
+
+    # Numeric value corresponding to the result of the request.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approval_code'] = 'approvalCode'
+      @_hash['response_code'] = 'responseCode'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approval_code
+        response_code
+        transaction_id
+        response_details
+        reason_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approval_code = SKIP, response_code = SKIP,
+                   transaction_id = SKIP, response_details = SKIP,
+                   reason_code = SKIP)
+      @approval_code = approval_code unless approval_code == SKIP
+      @response_code = response_code unless response_code == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @response_details = response_details unless response_details == SKIP
+      @reason_code = reason_code unless reason_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.
+      approval_code = hash.key?('approvalCode') ? hash['approvalCode'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation16.new(approval_code,
+                                 response_code,
+                                 transaction_id,
+                                 response_details,
+                                 reason_code)
+    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}, response_code: #{@response_code},"\
+      " transaction_id: #{@transaction_id}, response_details: #{@response_details}, reason_code:"\
+      " #{@reason_code}>"
+    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}, response_code:"\
+      " #{@response_code.inspect}, transaction_id: #{@transaction_id.inspect}, response_details:"\
+      " #{@response_details.inspect}, reason_code: #{@reason_code.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information18.rb

@@ -0,0 +1,110 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation18 Model.
+  class ProcessorInformation18 < 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
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approval_code'] = 'approvalCode'
+      @_hash['response_code'] = 'responseCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approval_code
+        response_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approval_code = SKIP, response_code = SKIP)
+      @approval_code = approval_code unless approval_code == 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.
+      approval_code = hash.key?('approvalCode') ? hash['approvalCode'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation18.new(approval_code,
+                                 response_code)
+    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}, 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} approval_code: #{@approval_code.inspect}, response_code:"\
+      " #{@response_code.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_information19.rb

@@ -0,0 +1,131 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation19 Model.
+  class ProcessorInformation19 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SellerProtection3]
+    attr_accessor :seller_protection
+
+    # TODO: Write general description for this method
+    # @return [Avs1]
+    attr_accessor :avs
+
+    # 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
+
+    # This field might contain information about a decline. This field is
+    # supported only for **Visa Acceptance through
+    # VisaNet**.
+    # @return [String]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['seller_protection'] = 'sellerProtection'
+      @_hash['avs'] = 'avs'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        seller_protection
+        avs
+        transaction_id
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(seller_protection = SKIP, avs = SKIP, transaction_id = SKIP,
+                   response_details = SKIP)
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @avs = avs unless avs == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @response_details = response_details unless response_details == 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.
+      seller_protection = SellerProtection3.from_hash(hash['sellerProtection']) if
+        hash['sellerProtection']
+      avs = Avs1.from_hash(hash['avs']) if hash['avs']
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      response_details =
+        hash.key?('responseDetails') ? hash['responseDetails'] : SKIP
+
+      # Create object from extracted values.
+      ProcessorInformation19.new(seller_protection,
+                                 avs,
+                                 transaction_id,
+                                 response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} seller_protection: #{@seller_protection}, avs: #{@avs}, transaction_id:"\
+      " #{@transaction_id}, response_details: #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} seller_protection: #{@seller_protection.inspect}, avs: #{@avs.inspect},"\
+      " transaction_id: #{@transaction_id.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end