acceptance-api-sdk 0.0.1

data/lib/visa_acceptance_merged_spec/models/processor_information7.rb

@@ -0,0 +1,264 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorInformation7 Model.
+  class ProcessorInformation7 < 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
+
+    # Processor transaction ID.
+    # This value identifies the transaction on a host system. This value is
+    # supported only for Moneris. It contains
+    # this 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
+
+    # Name of the Japanese acquirer that processed the transaction. Returned
+    # only for JCN Gateway.
+    # Please contact the Visa Acceptance Japan Support Group for more
+    # information.
+    # @return [String]
+    attr_accessor :forwarded_acquirer_code
+
+    # Identifier that was assigned to you by your acquirer. This value must be
+    # printed on the receipt.
+    # #### Returned by
+    # Authorizations and Credits.
+    # This reply field is only supported by merchants who have installed client
+    # software on their POS terminals and
+    # use these processors:
+    # - American Express Direct
+    # - Credit Mutuel-CIC
+    # - FDC Nashville Global
+    # - OmniPay Direct
+    # - SIX
+    # @return [String]
+    attr_accessor :merchant_number
+
+    # 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
+
+    # 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 [AchVerification]
+    attr_accessor :ach_verification
+
+    # Same value as `processorInformation.transactionId`
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # Field contains a settlement date. The date is in mmdd format, where: mm =
+    # month and dd = day.
+    # @return [String]
+    attr_accessor :settlement_date
+
+    # The date and time when the transaction was last updated, in Internet date
+    # and time format.
+    # @return [String]
+    attr_accessor :update_time_utc
+
+    # 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['forwarded_acquirer_code'] = 'forwardedAcquirerCode'
+      @_hash['merchant_number'] = 'merchantNumber'
+      @_hash['response_code'] = 'responseCode'
+      @_hash['ach_verification'] = 'achVerification'
+      @_hash['network_transaction_id'] = 'networkTransactionId'
+      @_hash['settlement_date'] = 'settlementDate'
+      @_hash['update_time_utc'] = 'updateTimeUtc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approval_code
+        transaction_id
+        forwarded_acquirer_code
+        merchant_number
+        response_code
+        ach_verification
+        network_transaction_id
+        settlement_date
+        update_time_utc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(approval_code: SKIP, transaction_id: SKIP,
+                   forwarded_acquirer_code: SKIP, merchant_number: SKIP,
+                   response_code: SKIP, ach_verification: SKIP,
+                   network_transaction_id: SKIP, settlement_date: SKIP,
+                   update_time_utc: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @approval_code = approval_code unless approval_code == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @forwarded_acquirer_code = forwarded_acquirer_code unless forwarded_acquirer_code == SKIP
+      @merchant_number = merchant_number unless merchant_number == SKIP
+      @response_code = response_code unless response_code == SKIP
+      @ach_verification = ach_verification unless ach_verification == SKIP
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      @settlement_date = settlement_date unless settlement_date == SKIP
+      @update_time_utc = update_time_utc unless update_time_utc == SKIP
+      @additional_properties = additional_properties
+    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
+      forwarded_acquirer_code =
+        hash.key?('forwardedAcquirerCode') ? hash['forwardedAcquirerCode'] : SKIP
+      merchant_number =
+        hash.key?('merchantNumber') ? hash['merchantNumber'] : SKIP
+      response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      ach_verification = AchVerification.from_hash(hash['achVerification']) if
+        hash['achVerification']
+      network_transaction_id =
+        hash.key?('networkTransactionId') ? hash['networkTransactionId'] : SKIP
+      settlement_date =
+        hash.key?('settlementDate') ? hash['settlementDate'] : SKIP
+      update_time_utc =
+        hash.key?('updateTimeUtc') ? hash['updateTimeUtc'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ProcessorInformation7.new(approval_code: approval_code,
+                                transaction_id: transaction_id,
+                                forwarded_acquirer_code: forwarded_acquirer_code,
+                                merchant_number: merchant_number,
+                                response_code: response_code,
+                                ach_verification: ach_verification,
+                                network_transaction_id: network_transaction_id,
+                                settlement_date: settlement_date,
+                                update_time_utc: update_time_utc,
+                                additional_properties: additional_properties)
+    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},"\
+      " forwarded_acquirer_code: #{@forwarded_acquirer_code}, merchant_number:"\
+      " #{@merchant_number}, response_code: #{@response_code}, ach_verification:"\
+      " #{@ach_verification}, network_transaction_id: #{@network_transaction_id}, settlement_date:"\
+      " #{@settlement_date}, update_time_utc: #{@update_time_utc}, additional_properties:"\
+      " #{@additional_properties}>"
+    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}, forwarded_acquirer_code: #{@forwarded_acquirer_code.inspect},"\
+      " merchant_number: #{@merchant_number.inspect}, response_code: #{@response_code.inspect},"\
+      " ach_verification: #{@ach_verification.inspect}, network_transaction_id:"\
+      " #{@network_transaction_id.inspect}, settlement_date: #{@settlement_date.inspect},"\
+      " update_time_utc: #{@update_time_utc.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_results.rb

@@ -0,0 +1,108 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorResults Model.
+  class ProcessorResults < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of filter. Possible values:
+    # - ACCEPT
+    # - PENDING
+    # - DENY
+    # - REPORT
+    # @return [String]
+    attr_accessor :fraud_decision
+
+    # possible values
+    # - AVS_NO_MATCH
+    # - AVS_PARTIAL_MATCH
+    # - AVS_UNAVAILABLE_OR_UNSUPPORTED
+    # - CARD_SECURITY_CODE_MISMATCH
+    # - MAXIMUM_TRANSACTION_AMOUNT
+    # - UNCONFIRMED_ADDRESS
+    # - COUNTRY_MONITOR
+    # - LARGE_ORDER_NUMBER
+    # - BILLING_OR_SHIPPING_ADDRESS_MISMATCH
+    # - RISKY_ZIP_CODE
+    # - SUSPECTED_FREIGHT_FORWARDER_CHECK
+    # - TOTAL_PURCHASE_PRICE_MINIMUM
+    # - IP_ADDRESS_VELOCITY
+    # - RISKY_EMAIL_ADDRESS_DOMAIN_CHECK
+    # - RISKY_BANK_IDENTIFICATION_NUMBER_CHECK,
+    # RISKY_IP_ADDRESS_RANGE
+    # - PAYPAL_FRAUD_MODEL
+    # @return [String]
+    attr_accessor :fraud_decision_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fraud_decision'] = 'fraudDecision'
+      @_hash['fraud_decision_reason'] = 'fraudDecisionReason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fraud_decision
+        fraud_decision_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fraud_decision: SKIP, fraud_decision_reason: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fraud_decision = fraud_decision unless fraud_decision == SKIP
+      @fraud_decision_reason = fraud_decision_reason unless fraud_decision_reason == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fraud_decision = hash.key?('fraudDecision') ? hash['fraudDecision'] : SKIP
+      fraud_decision_reason =
+        hash.key?('fraudDecisionReason') ? hash['fraudDecisionReason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ProcessorResults.new(fraud_decision: fraud_decision,
+                           fraud_decision_reason: fraud_decision_reason,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_decision: #{@fraud_decision}, fraud_decision_reason:"\
+      " #{@fraud_decision_reason}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fraud_decision: #{@fraud_decision.inspect}, fraud_decision_reason:"\
+      " #{@fraud_decision_reason.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processor_results1.rb

@@ -0,0 +1,77 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessorResults1 Model.
+  class ProcessorResults1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Risk score returned by the processor. Possible
+    # values of 0-10. A value of 10 indicates a high risk.
+    # @return [String]
+    attr_accessor :risk_score
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['risk_score'] = 'riskScore'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        risk_score
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(risk_score: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @risk_score = risk_score unless risk_score == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      risk_score = hash.key?('riskScore') ? hash['riskScore'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ProcessorResults1.new(risk_score: risk_score,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} risk_score: #{@risk_score}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} risk_score: #{@risk_score.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/profile.rb

@@ -0,0 +1,80 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Identifies a risk profile.
+  class Profile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the active profile chosen by the profile selector. If no profile
+    # selector exists,
+    # the default active profile is chosen.
+    # **Note** By default, your default profile is the active profile, or the
+    # Profile Selector chooses the active profile. Use this field
+    # only if you want to specify the name of a different profile. The passed-in
+    # profile will then become the active profile.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Profile.new(name: name,
+                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/profile1.rb

@@ -0,0 +1,106 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Profile1 Model.
+  class Profile1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the active profile chosen by the profile selector. If no profile
+    # selector exists,
+    # the default active profile is chosen.
+    # **Note** By default, your default profile is the active profile, or the
+    # Profile Selector chooses the active profile. Use this field
+    # only if you want to specify the name of a different profile. The passed-in
+    # profile will then become the active profile.
+    # @return [String]
+    attr_accessor :name
+
+    # Name of the queue where orders that are not automatically accepted are
+    # sent.
+    # @return [String]
+    attr_accessor :desination_queue
+
+    # Name of the profile selector rule that chooses the profile to use for the
+    # transaction. If no profile selector exists, the value is Default Active
+    # Profile.
+    # @return [String]
+    attr_accessor :selector_rule
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['desination_queue'] = 'desinationQueue'
+      @_hash['selector_rule'] = 'selectorRule'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        desination_queue
+        selector_rule
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, desination_queue: SKIP, selector_rule: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @desination_queue = desination_queue unless desination_queue == SKIP
+      @selector_rule = selector_rule unless selector_rule == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      desination_queue =
+        hash.key?('desinationQueue') ? hash['desinationQueue'] : SKIP
+      selector_rule = hash.key?('selectorRule') ? hash['selectorRule'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Profile1.new(name: name,
+                   desination_queue: desination_queue,
+                   selector_rule: selector_rule,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, desination_queue: #{@desination_queue}, selector_rule:"\
+      " #{@selector_rule}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, desination_queue: #{@desination_queue.inspect},"\
+      " selector_rule: #{@selector_rule.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end