visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/processing_information3.rb

@@ -0,0 +1,212 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessingInformation3 Model.
+  class ProcessingInformation3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of digital payment solution for the transaction. Possible Values:
+    #  - `visacheckout`: Visa Checkout. This value is required for Visa Checkout
+    # transactions. For details, see `payment_solution` field description in
+    # [Visa Checkout Using the REST API.](
+    #  - `001`: Apple Pay.
+    #  - `004`: Visa Acceptance In-App Solution.
+    #  - `005`: Masterpass. This value is required for Masterpass transactions
+    # on OmniPay Direct. 
+    #  - `006`: Android Pay.
+    #  - `007`: Chase Pay.
+    #  - `008`: Samsung Pay.
+    #  - `012`: Google Pay.
+    #  - `013`: Visa Acceptance P2PE Decryption
+    #  - `014`: Mastercard credential on file (COF) payment network token.
+    # Returned in authorizations that use a payment network token associated
+    # with a TMS token.
+    #  - `015`: Visa credential on file (COF) payment network token. Returned in
+    # authorizations that use a payment network token associated with a TMS
+    # token.
+    #  - `027`: Click to Pay.
+    # @return [String]
+    attr_accessor :payment_solution
+
+    # Please check with Visa Acceptance customer support to see if your merchant
+    # account is configured correctly so you
+    # can include this field in your request.
+    # * For Payouts: max length for FDCCompass is String (22).
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # Value that links the current authorization request to the original
+    # authorization request. Set this value
+    # to the ID that was returned in the reply message from the original
+    # authorization request.
+    # This value is used for:
+    # - Partial authorizations
+    # - Split shipments
+    # @return [String]
+    attr_accessor :link_id
+
+    # Attribute that lets you define custom grouping for your processor reports.
+    # This field is supported only for **Worldpay VAP**.
+    # @return [String]
+    attr_accessor :report_group
+
+    # Identifier for the **Visa Checkout** order. Visa Checkout provides a
+    # unique order ID for every transaction in
+    # the Visa Checkout **callID** field.
+    # @return [String]
+    attr_accessor :visa_checkout_id
+
+    # Identifier for the **Visa Checkout** order. Visa Checkout provides a
+    # unique order ID for every transaction in
+    # the Visa Checkout **callID** field.
+    # @return [Issuer]
+    attr_accessor :issuer
+
+    # Array of actions (one or more) to be included in the reversal
+    # Possible value:
+    # - `AP_AUTH_REVERSAL`: Use this when you want to reverse an Alternative
+    # Payment Authorization.
+    # @return [Array[String]]
+    attr_accessor :action_list
+
+    # This field is used identify the type of payment transaction taking place.
+    # This field is applicable for MasterCard transactions only.
+    # Possible values:
+    # - 201- Mastercard Rebate
+    # - 202- rePower Load Value
+    # - 203- Gaming Re-pay
+    # - 204- General Person-to-Person
+    # - 205- General Transfer to Own Account
+    # - 206- Agent Cash Out
+    # - 207- Payment of Own Credit Card Bill
+    # - 208- Business Disbursement
+    # - 209- Government/Non-Profit Disbursement
+    # - 210- Rapid Merchant Settlement
+    # - 211- Cash in at ATM (Usage limited to specific countries)
+    # - 212- Cash in at Point of Sale (Usage limited to specific countries)
+    # - 213- General Business to Business Transfer
+    # - 214- Mastercard Merchant Presented QR
+    # - 215- Mastercard Merchant Presented QR Refund Payment
+    # - 216- Utility Payments (for Brazil domestic use only)
+    # - 217- Government Services (for Brazil domestic use only)
+    # - 218- Mobile phone top-ups (for Brazil domestic use only)
+    # - 219- Coupon booklet payments (for Brazil domestic use only)
+    # - 220- General Person-to-Person Transfer
+    # - 221- Person-to-Person Transfer to Card Account
+    # - 222- General Transfer to Own Account
+    # - 223- Agent Cash Out
+    # - 224- Payment of Own Credit Card Bill
+    # - 225- Business Disbursement
+    # - 226- Transfer to Own Staged Digital Wallet Account
+    # - 227- Transfer to Own Debit or Prepaid Account
+    # - 228- General Business-to-Business Transfer
+    # - 229- Installment-based repayment
+    # - 230- Mastercard ATM Cash Pick-Up Transaction
+    # - 231- Cryptocurrency
+    # - 232- High-risk Securities
+    # @return [String]
+    attr_accessor :transaction_type_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_solution'] = 'paymentSolution'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['link_id'] = 'linkId'
+      @_hash['report_group'] = 'reportGroup'
+      @_hash['visa_checkout_id'] = 'visaCheckoutId'
+      @_hash['issuer'] = 'issuer'
+      @_hash['action_list'] = 'actionList'
+      @_hash['transaction_type_indicator'] = 'transactionTypeIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_solution
+        reconciliation_id
+        link_id
+        report_group
+        visa_checkout_id
+        issuer
+        action_list
+        transaction_type_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_solution = SKIP, reconciliation_id = SKIP,
+                   link_id = SKIP, report_group = SKIP, visa_checkout_id = SKIP,
+                   issuer = SKIP, action_list = SKIP,
+                   transaction_type_indicator = SKIP)
+      @payment_solution = payment_solution unless payment_solution == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @link_id = link_id unless link_id == SKIP
+      @report_group = report_group unless report_group == SKIP
+      @visa_checkout_id = visa_checkout_id unless visa_checkout_id == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @action_list = action_list unless action_list == SKIP
+      unless transaction_type_indicator == SKIP
+        @transaction_type_indicator =
+          transaction_type_indicator
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_solution =
+        hash.key?('paymentSolution') ? hash['paymentSolution'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      link_id = hash.key?('linkId') ? hash['linkId'] : SKIP
+      report_group = hash.key?('reportGroup') ? hash['reportGroup'] : SKIP
+      visa_checkout_id =
+        hash.key?('visaCheckoutId') ? hash['visaCheckoutId'] : SKIP
+      issuer = Issuer.from_hash(hash['issuer']) if hash['issuer']
+      action_list = hash.key?('actionList') ? hash['actionList'] : SKIP
+      transaction_type_indicator =
+        hash.key?('transactionTypeIndicator') ? hash['transactionTypeIndicator'] : SKIP
+
+      # Create object from extracted values.
+      ProcessingInformation3.new(payment_solution,
+                                 reconciliation_id,
+                                 link_id,
+                                 report_group,
+                                 visa_checkout_id,
+                                 issuer,
+                                 action_list,
+                                 transaction_type_indicator)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_solution: #{@payment_solution}, reconciliation_id:"\
+      " #{@reconciliation_id}, link_id: #{@link_id}, report_group: #{@report_group},"\
+      " visa_checkout_id: #{@visa_checkout_id}, issuer: #{@issuer}, action_list: #{@action_list},"\
+      " transaction_type_indicator: #{@transaction_type_indicator}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_solution: #{@payment_solution.inspect}, reconciliation_id:"\
+      " #{@reconciliation_id.inspect}, link_id: #{@link_id.inspect}, report_group:"\
+      " #{@report_group.inspect}, visa_checkout_id: #{@visa_checkout_id.inspect}, issuer:"\
+      " #{@issuer.inspect}, action_list: #{@action_list.inspect}, transaction_type_indicator:"\
+      " #{@transaction_type_indicator.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/processing_information5.rb

@@ -0,0 +1,348 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # ProcessingInformation5 Model.
+  class ProcessingInformation5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of digital payment solution for the transaction. Possible Values:
+    #  - `visacheckout`: Visa Checkout. This value is required for Visa Checkout
+    # transactions. For details, see `payment_solution` field description in
+    # [Visa Checkout Using the REST API.](
+    #  - `001`: Apple Pay.
+    #  - `004`: Visa Acceptance In-App Solution.
+    #  - `005`: Masterpass. This value is required for Masterpass transactions
+    # on OmniPay Direct. 
+    #  - `006`: Android Pay.
+    #  - `007`: Chase Pay.
+    #  - `008`: Samsung Pay.
+    #  - `012`: Google Pay.
+    #  - `013`: Visa Acceptance P2PE Decryption
+    #  - `014`: Mastercard credential on file (COF) payment network token.
+    # Returned in authorizations that use a payment network token associated
+    # with a TMS token.
+    #  - `015`: Visa credential on file (COF) payment network token. Returned in
+    # authorizations that use a payment network token associated with a TMS
+    # token.
+    #  - `027`: Click to Pay.
+    # @return [String]
+    attr_accessor :payment_solution
+
+    # Please check with Visa Acceptance customer support to see if your merchant
+    # account is configured correctly so you
+    # can include this field in your request.
+    # * For Payouts: max length for FDCCompass is String (22).
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # Value that links the current authorization request to the original
+    # authorization request. Set this value
+    # to the ID that was returned in the reply message from the original
+    # authorization request.
+    # This value is used for:
+    # - Partial authorizations
+    # - Split shipments
+    # @return [String]
+    attr_accessor :link_id
+
+    # Attribute that lets you define custom grouping for your processor reports.
+    # This field is supported only for **Worldpay VAP**.
+    # @return [String]
+    attr_accessor :report_group
+
+    # Identifier for the **Visa Checkout** order. Visa Checkout provides a
+    # unique order ID for every transaction in
+    # the Visa Checkout **callID** field.
+    # @return [String]
+    attr_accessor :visa_checkout_id
+
+    # Set this field to 3 to indicate that the request includes Level III data.
+    # @return [String]
+    attr_accessor :purchase_level
+
+    # Indicates that the transaction includes industry-specific data.
+    # Possible Values:
+    # - `airline`
+    # - `restaurant`
+    # - `lodging`
+    # - `auto_rental`
+    # - `transit`
+    # - `healthcare_medical`
+    # - `healthcare_transit`
+    # - `transit`
+    # #### Card Present, Airlines and Auto Rental
+    # You must set this field to `airline` in order for airline data to be sent
+    # to the processor. For example, if this
+    # field is not set to `airline` or is not included in the request, no
+    # airline data is sent to the processor.
+    # You must set this field to `restaurant` in order for restaurant data to be
+    # sent to the processor. When this field
+    # is not set to `restaurant` or is not included in the request, no
+    # restaurant data is sent to the processor.
+    # You must set this field to `auto_rental` in order for auto rental data to
+    # be sent to the processor. For example, if this
+    # field is not set to `auto_rental` or is not included in the request, no
+    # auto rental data is sent to the processor.
+    # Restaurant data is supported only on Visa Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :industry_data_type
+
+    # Indicates that the transaction includes industry-specific data.
+    # Possible Values:
+    # - `airline`
+    # - `restaurant`
+    # - `lodging`
+    # - `auto_rental`
+    # - `transit`
+    # - `healthcare_medical`
+    # - `healthcare_transit`
+    # - `transit`
+    # #### Card Present, Airlines and Auto Rental
+    # You must set this field to `airline` in order for airline data to be sent
+    # to the processor. For example, if this
+    # field is not set to `airline` or is not included in the request, no
+    # airline data is sent to the processor.
+    # You must set this field to `restaurant` in order for restaurant data to be
+    # sent to the processor. When this field
+    # is not set to `restaurant` or is not included in the request, no
+    # restaurant data is sent to the processor.
+    # You must set this field to `auto_rental` in order for auto rental data to
+    # be sent to the processor. For example, if this
+    # field is not set to `auto_rental` or is not included in the request, no
+    # auto rental data is sent to the processor.
+    # Restaurant data is supported only on Visa Acceptance through VisaNet.
+    # @return [Issuer]
+    attr_accessor :issuer
+
+    # Indicates that the transaction includes industry-specific data.
+    # Possible Values:
+    # - `airline`
+    # - `restaurant`
+    # - `lodging`
+    # - `auto_rental`
+    # - `transit`
+    # - `healthcare_medical`
+    # - `healthcare_transit`
+    # - `transit`
+    # #### Card Present, Airlines and Auto Rental
+    # You must set this field to `airline` in order for airline data to be sent
+    # to the processor. For example, if this
+    # field is not set to `airline` or is not included in the request, no
+    # airline data is sent to the processor.
+    # You must set this field to `restaurant` in order for restaurant data to be
+    # sent to the processor. When this field
+    # is not set to `restaurant` or is not included in the request, no
+    # restaurant data is sent to the processor.
+    # You must set this field to `auto_rental` in order for auto rental data to
+    # be sent to the processor. For example, if this
+    # field is not set to `auto_rental` or is not included in the request, no
+    # auto rental data is sent to the processor.
+    # Restaurant data is supported only on Visa Acceptance through VisaNet.
+    # @return [AuthorizationOptions4]
+    attr_accessor :authorization_options
+
+    # Indicates that the transaction includes industry-specific data.
+    # Possible Values:
+    # - `airline`
+    # - `restaurant`
+    # - `lodging`
+    # - `auto_rental`
+    # - `transit`
+    # - `healthcare_medical`
+    # - `healthcare_transit`
+    # - `transit`
+    # #### Card Present, Airlines and Auto Rental
+    # You must set this field to `airline` in order for airline data to be sent
+    # to the processor. For example, if this
+    # field is not set to `airline` or is not included in the request, no
+    # airline data is sent to the processor.
+    # You must set this field to `restaurant` in order for restaurant data to be
+    # sent to the processor. When this field
+    # is not set to `restaurant` or is not included in the request, no
+    # restaurant data is sent to the processor.
+    # You must set this field to `auto_rental` in order for auto rental data to
+    # be sent to the processor. For example, if this
+    # field is not set to `auto_rental` or is not included in the request, no
+    # auto rental data is sent to the processor.
+    # Restaurant data is supported only on Visa Acceptance through VisaNet.
+    # @return [CaptureOptions2]
+    attr_accessor :capture_options
+
+    # Indicates that the transaction includes industry-specific data.
+    # Possible Values:
+    # - `airline`
+    # - `restaurant`
+    # - `lodging`
+    # - `auto_rental`
+    # - `transit`
+    # - `healthcare_medical`
+    # - `healthcare_transit`
+    # - `transit`
+    # #### Card Present, Airlines and Auto Rental
+    # You must set this field to `airline` in order for airline data to be sent
+    # to the processor. For example, if this
+    # field is not set to `airline` or is not included in the request, no
+    # airline data is sent to the processor.
+    # You must set this field to `restaurant` in order for restaurant data to be
+    # sent to the processor. When this field
+    # is not set to `restaurant` or is not included in the request, no
+    # restaurant data is sent to the processor.
+    # You must set this field to `auto_rental` in order for auto rental data to
+    # be sent to the processor. For example, if this
+    # field is not set to `auto_rental` or is not included in the request, no
+    # auto rental data is sent to the processor.
+    # Restaurant data is supported only on Visa Acceptance through VisaNet.
+    # @return [LoanOptions]
+    attr_accessor :loan_options
+
+    # Flag that indicates if the transaction is pay by points transaction
+    # true: Transaction uses loyalty points
+    # false: Transaction does not use loyalty points
+    # Default: false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pay_by_points_indicator
+
+    # Array of actions (one or more) to be included in the capture to invoke
+    # bundled services along with capture.
+    # Possible values :
+    #  - `AP_CAPTURE`: Use this when Alternative Payment Capture service is
+    # requested.
+    # @return [Array[String]]
+    attr_accessor :action_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_solution'] = 'paymentSolution'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['link_id'] = 'linkId'
+      @_hash['report_group'] = 'reportGroup'
+      @_hash['visa_checkout_id'] = 'visaCheckoutId'
+      @_hash['purchase_level'] = 'purchaseLevel'
+      @_hash['industry_data_type'] = 'industryDataType'
+      @_hash['issuer'] = 'issuer'
+      @_hash['authorization_options'] = 'authorizationOptions'
+      @_hash['capture_options'] = 'captureOptions'
+      @_hash['loan_options'] = 'loanOptions'
+      @_hash['pay_by_points_indicator'] = 'payByPointsIndicator'
+      @_hash['action_list'] = 'actionList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_solution
+        reconciliation_id
+        link_id
+        report_group
+        visa_checkout_id
+        purchase_level
+        industry_data_type
+        issuer
+        authorization_options
+        capture_options
+        loan_options
+        pay_by_points_indicator
+        action_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_solution = SKIP, reconciliation_id = SKIP,
+                   link_id = SKIP, report_group = SKIP, visa_checkout_id = SKIP,
+                   purchase_level = SKIP, industry_data_type = SKIP,
+                   issuer = SKIP, authorization_options = SKIP,
+                   capture_options = SKIP, loan_options = SKIP,
+                   pay_by_points_indicator = SKIP, action_list = SKIP)
+      @payment_solution = payment_solution unless payment_solution == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @link_id = link_id unless link_id == SKIP
+      @report_group = report_group unless report_group == SKIP
+      @visa_checkout_id = visa_checkout_id unless visa_checkout_id == SKIP
+      @purchase_level = purchase_level unless purchase_level == SKIP
+      @industry_data_type = industry_data_type unless industry_data_type == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @authorization_options = authorization_options unless authorization_options == SKIP
+      @capture_options = capture_options unless capture_options == SKIP
+      @loan_options = loan_options unless loan_options == SKIP
+      @pay_by_points_indicator = pay_by_points_indicator unless pay_by_points_indicator == SKIP
+      @action_list = action_list unless action_list == 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.
+      payment_solution =
+        hash.key?('paymentSolution') ? hash['paymentSolution'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      link_id = hash.key?('linkId') ? hash['linkId'] : SKIP
+      report_group = hash.key?('reportGroup') ? hash['reportGroup'] : SKIP
+      visa_checkout_id =
+        hash.key?('visaCheckoutId') ? hash['visaCheckoutId'] : SKIP
+      purchase_level = hash.key?('purchaseLevel') ? hash['purchaseLevel'] : SKIP
+      industry_data_type =
+        hash.key?('industryDataType') ? hash['industryDataType'] : SKIP
+      issuer = Issuer.from_hash(hash['issuer']) if hash['issuer']
+      authorization_options = AuthorizationOptions4.from_hash(hash['authorizationOptions']) if
+        hash['authorizationOptions']
+      capture_options = CaptureOptions2.from_hash(hash['captureOptions']) if
+        hash['captureOptions']
+      loan_options = LoanOptions.from_hash(hash['loanOptions']) if hash['loanOptions']
+      pay_by_points_indicator =
+        hash.key?('payByPointsIndicator') ? hash['payByPointsIndicator'] : SKIP
+      action_list = hash.key?('actionList') ? hash['actionList'] : SKIP
+
+      # Create object from extracted values.
+      ProcessingInformation5.new(payment_solution,
+                                 reconciliation_id,
+                                 link_id,
+                                 report_group,
+                                 visa_checkout_id,
+                                 purchase_level,
+                                 industry_data_type,
+                                 issuer,
+                                 authorization_options,
+                                 capture_options,
+                                 loan_options,
+                                 pay_by_points_indicator,
+                                 action_list)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_solution: #{@payment_solution}, reconciliation_id:"\
+      " #{@reconciliation_id}, link_id: #{@link_id}, report_group: #{@report_group},"\
+      " visa_checkout_id: #{@visa_checkout_id}, purchase_level: #{@purchase_level},"\
+      " industry_data_type: #{@industry_data_type}, issuer: #{@issuer}, authorization_options:"\
+      " #{@authorization_options}, capture_options: #{@capture_options}, loan_options:"\
+      " #{@loan_options}, pay_by_points_indicator: #{@pay_by_points_indicator}, action_list:"\
+      " #{@action_list}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_solution: #{@payment_solution.inspect}, reconciliation_id:"\
+      " #{@reconciliation_id.inspect}, link_id: #{@link_id.inspect}, report_group:"\
+      " #{@report_group.inspect}, visa_checkout_id: #{@visa_checkout_id.inspect}, purchase_level:"\
+      " #{@purchase_level.inspect}, industry_data_type: #{@industry_data_type.inspect}, issuer:"\
+      " #{@issuer.inspect}, authorization_options: #{@authorization_options.inspect},"\
+      " capture_options: #{@capture_options.inspect}, loan_options: #{@loan_options.inspect},"\
+      " pay_by_points_indicator: #{@pay_by_points_indicator.inspect}, action_list:"\
+      " #{@action_list.inspect}>"
+    end
+  end
+end