visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/merchant_information3.rb

@@ -0,0 +1,153 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInformation3 Model.
+  class MerchantInformation3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MerchantDescriptor]
+    attr_accessor :merchant_descriptor
+
+    # Reference number that facilitates card acceptor/corporation communication
+    # and record keeping.
+    # @return [String]
+    attr_accessor :card_acceptor_reference_number
+
+    # The value for this field is a four-digit number that the payment card
+    # industry uses to classify
+    # merchants into market segments. A payment card company assigned one or
+    # more of these values to your business when you started
+    # accepting the payment card company’s cards. When you do not include this
+    # field in your request, Visa Acceptance uses the value in your
+    # Visa Acceptance account.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP01 TCR4
+    # - Position: 150-153
+    # - Field: Merchant Category Code
+    # @return [Integer]
+    attr_accessor :category_code
+
+    # Your government-assigned tax identification number.
+    # #### Tax Calculation
+    # Required field for value added tax only. Not applicable to U.S. and
+    # Canadian taxes.
+    # #### Visa Acceptance through VisaNet
+    # For CtV processors, the maximum length is 20.
+    # @return [String]
+    attr_accessor :vat_registration_number
+
+    # Your government-assigned tax identification number.
+    # #### Tax Calculation
+    # Required field for value added tax only. Not applicable to U.S. and
+    # Canadian taxes.
+    # #### Visa Acceptance through VisaNet
+    # For CtV processors, the maximum length is 20.
+    # @return [ServiceFeeDescriptor]
+    attr_accessor :service_fee_descriptor
+
+    # Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number.
+    # This field is supported only for BNDES transactions on Visa Acceptance
+    # through VisaNet.
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP07 TCR6
+    # - Position: 40-59
+    # - Field: BNDES Reference Field 1
+    # @return [String]
+    attr_accessor :tax_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_descriptor'] = 'merchantDescriptor'
+      @_hash['card_acceptor_reference_number'] = 'cardAcceptorReferenceNumber'
+      @_hash['category_code'] = 'categoryCode'
+      @_hash['vat_registration_number'] = 'vatRegistrationNumber'
+      @_hash['service_fee_descriptor'] = 'serviceFeeDescriptor'
+      @_hash['tax_id'] = 'taxId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_descriptor
+        card_acceptor_reference_number
+        category_code
+        vat_registration_number
+        service_fee_descriptor
+        tax_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_descriptor = SKIP,
+                   card_acceptor_reference_number = SKIP, category_code = SKIP,
+                   vat_registration_number = SKIP,
+                   service_fee_descriptor = SKIP, tax_id = SKIP)
+      @merchant_descriptor = merchant_descriptor unless merchant_descriptor == SKIP
+      unless card_acceptor_reference_number == SKIP
+        @card_acceptor_reference_number =
+          card_acceptor_reference_number
+      end
+      @category_code = category_code unless category_code == SKIP
+      @vat_registration_number = vat_registration_number unless vat_registration_number == SKIP
+      @service_fee_descriptor = service_fee_descriptor unless service_fee_descriptor == SKIP
+      @tax_id = tax_id unless tax_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.
+      merchant_descriptor = MerchantDescriptor.from_hash(hash['merchantDescriptor']) if
+        hash['merchantDescriptor']
+      card_acceptor_reference_number =
+        hash.key?('cardAcceptorReferenceNumber') ? hash['cardAcceptorReferenceNumber'] : SKIP
+      category_code = hash.key?('categoryCode') ? hash['categoryCode'] : SKIP
+      vat_registration_number =
+        hash.key?('vatRegistrationNumber') ? hash['vatRegistrationNumber'] : SKIP
+      service_fee_descriptor = ServiceFeeDescriptor.from_hash(hash['serviceFeeDescriptor']) if
+        hash['serviceFeeDescriptor']
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInformation3.new(merchant_descriptor,
+                               card_acceptor_reference_number,
+                               category_code,
+                               vat_registration_number,
+                               service_fee_descriptor,
+                               tax_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor},"\
+      " card_acceptor_reference_number: #{@card_acceptor_reference_number}, category_code:"\
+      " #{@category_code}, vat_registration_number: #{@vat_registration_number},"\
+      " service_fee_descriptor: #{@service_fee_descriptor}, tax_id: #{@tax_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor.inspect},"\
+      " card_acceptor_reference_number: #{@card_acceptor_reference_number.inspect}, category_code:"\
+      " #{@category_code.inspect}, vat_registration_number: #{@vat_registration_number.inspect},"\
+      " service_fee_descriptor: #{@service_fee_descriptor.inspect}, tax_id: #{@tax_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_information35.rb

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

data/lib/visa_acceptance_merged_spec/models/merchant_information4.rb

@@ -0,0 +1,136 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInformation4 Model.
+  class MerchantInformation4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MerchantDescriptor]
+    attr_accessor :merchant_descriptor
+
+    # The value for this field is a four-digit number that the payment card
+    # industry uses to classify
+    # merchants into market segments. A payment card company assigned one or
+    # more of these values to your business when you started
+    # accepting the payment card company’s cards. When you do not include this
+    # field in your request, Visa Acceptance uses the value in your
+    # Visa Acceptance account.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP01 TCR4
+    # - Position: 150-153
+    # - Field: Merchant Category Code
+    # @return [Integer]
+    attr_accessor :category_code
+
+    # Your government-assigned tax identification number.
+    # #### Tax Calculation
+    # Required field for value added tax only. Not applicable to U.S. and
+    # Canadian taxes.
+    # #### Visa Acceptance through VisaNet
+    # For CtV processors, the maximum length is 20.
+    # @return [String]
+    attr_accessor :vat_registration_number
+
+    # Reference number that facilitates card acceptor/corporation communication
+    # and record keeping.
+    # @return [String]
+    attr_accessor :card_acceptor_reference_number
+
+    # Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number.
+    # This field is supported only for BNDES transactions on Visa Acceptance
+    # through VisaNet.
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP07 TCR6
+    # - Position: 40-59
+    # - Field: BNDES Reference Field 1
+    # @return [String]
+    attr_accessor :tax_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_descriptor'] = 'merchantDescriptor'
+      @_hash['category_code'] = 'categoryCode'
+      @_hash['vat_registration_number'] = 'vatRegistrationNumber'
+      @_hash['card_acceptor_reference_number'] = 'cardAcceptorReferenceNumber'
+      @_hash['tax_id'] = 'taxId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_descriptor
+        category_code
+        vat_registration_number
+        card_acceptor_reference_number
+        tax_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_descriptor = SKIP, category_code = SKIP,
+                   vat_registration_number = SKIP,
+                   card_acceptor_reference_number = SKIP, tax_id = SKIP)
+      @merchant_descriptor = merchant_descriptor unless merchant_descriptor == SKIP
+      @category_code = category_code unless category_code == SKIP
+      @vat_registration_number = vat_registration_number unless vat_registration_number == SKIP
+      unless card_acceptor_reference_number == SKIP
+        @card_acceptor_reference_number =
+          card_acceptor_reference_number
+      end
+      @tax_id = tax_id unless tax_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.
+      merchant_descriptor = MerchantDescriptor.from_hash(hash['merchantDescriptor']) if
+        hash['merchantDescriptor']
+      category_code = hash.key?('categoryCode') ? hash['categoryCode'] : SKIP
+      vat_registration_number =
+        hash.key?('vatRegistrationNumber') ? hash['vatRegistrationNumber'] : SKIP
+      card_acceptor_reference_number =
+        hash.key?('cardAcceptorReferenceNumber') ? hash['cardAcceptorReferenceNumber'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInformation4.new(merchant_descriptor,
+                               category_code,
+                               vat_registration_number,
+                               card_acceptor_reference_number,
+                               tax_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor}, category_code:"\
+      " #{@category_code}, vat_registration_number: #{@vat_registration_number},"\
+      " card_acceptor_reference_number: #{@card_acceptor_reference_number}, tax_id: #{@tax_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_descriptor: #{@merchant_descriptor.inspect}, category_code:"\
+      " #{@category_code.inspect}, vat_registration_number: #{@vat_registration_number.inspect},"\
+      " card_acceptor_reference_number: #{@card_acceptor_reference_number.inspect}, tax_id:"\
+      " #{@tax_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_information7.rb

@@ -0,0 +1,68 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInformation7 Model.
+  class MerchantInformation7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Local Time of the transaction
+    # Set the timestamp for the exchange rate by ISO 8601 UTC format.
+    # Format: “YYYYMMdd’T’HHmmss’Z’”  (20151103T123456Z)
+    # @return [String]
+    attr_accessor :transaction_local_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_local_date_time'] = 'transactionLocalDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_local_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_local_date_time = SKIP)
+      unless transaction_local_date_time == SKIP
+        @transaction_local_date_time =
+          transaction_local_date_time
+      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.
+      transaction_local_date_time =
+        hash.key?('transactionLocalDateTime') ? hash['transactionLocalDateTime'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInformation7.new(transaction_local_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_local_date_time: #{@transaction_local_date_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_local_date_time: #{@transaction_local_date_time.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_initiated_transaction.rb

@@ -0,0 +1,134 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInitiatedTransaction Model.
+  class MerchantInitiatedTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Reason for the merchant-initiated transaction or incremental
+    # authorization. Possible values:
+    # - `1`: Resubmission
+    # - `2`: Delayed charge
+    # - `3`: Reauthorization for split shipment
+    # - `4`: No show
+    # - `5`: Account top up
+    # This field is required only for the five kinds of transactions in the
+    # preceding list.
+    # This field is supported only for merchant-initiated transactions and
+    # incremental authorizations.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file5:
+    # - Record: CP01 TCR0
+    # - Position: 160-163
+    # - Field: Message Reason Code
+    # @return [String]
+    attr_accessor :reason
+
+    # Network transaction identifier that was returned in the payment response
+    # field _processorInformation.transactionID_
+    # in the reply message for either the original merchant-initiated payment in
+    # the series or the previous
+    # merchant-initiated payment in the series.
+    # If the current payment request includes a token instead of an account
+    # number, the following time limits apply for the value of this field:
+    # - For a **resubmission**, the transaction ID must be less than 14 days
+    # old.
+    # - For a **delayed charge** or **reauthorization**, the transaction ID must
+    # be less than 30 days old.
+    # **NOTE**: The value for this field does not correspond to any data in the
+    # TC 33 capture file5. This field is supported
+    # only for Visa transactions on Visa Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :previous_transaction_id
+
+    # Amount of the original authorization.
+    # This field is supported only for Apple Pay, Google Pay, and Samsung Pay
+    # transactions with Discover on FDC Nashville Global and Chase Paymentech.
+    # @return [String]
+    attr_accessor :original_authorized_amount
+
+    # An API to carry the agreement ID generated for recurring and unscheduled
+    # Card on file transaction. the merchant generates this per card holder or
+    # per payment agreement and shares the generated unique ID in the subsequent
+    # transactions. This can contain foreign/arabic character set also. Visa
+    # Acceptance forwards this value to the Saudi Payment processor.
+    # @return [String]
+    attr_accessor :agreement_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['previous_transaction_id'] = 'previousTransactionId'
+      @_hash['original_authorized_amount'] = 'originalAuthorizedAmount'
+      @_hash['agreement_id'] = 'agreementId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        previous_transaction_id
+        original_authorized_amount
+        agreement_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = SKIP, previous_transaction_id = SKIP,
+                   original_authorized_amount = SKIP, agreement_id = SKIP)
+      @reason = reason unless reason == SKIP
+      @previous_transaction_id = previous_transaction_id unless previous_transaction_id == SKIP
+      unless original_authorized_amount == SKIP
+        @original_authorized_amount =
+          original_authorized_amount
+      end
+      @agreement_id = agreement_id unless agreement_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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      previous_transaction_id =
+        hash.key?('previousTransactionId') ? hash['previousTransactionId'] : SKIP
+      original_authorized_amount =
+        hash.key?('originalAuthorizedAmount') ? hash['originalAuthorizedAmount'] : SKIP
+      agreement_id = hash.key?('agreementId') ? hash['agreementId'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInitiatedTransaction.new(reason,
+                                       previous_transaction_id,
+                                       original_authorized_amount,
+                                       agreement_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}, previous_transaction_id: #{@previous_transaction_id},"\
+      " original_authorized_amount: #{@original_authorized_amount}, agreement_id:"\
+      " #{@agreement_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}, previous_transaction_id:"\
+      " #{@previous_transaction_id.inspect}, original_authorized_amount:"\
+      " #{@original_authorized_amount.inspect}, agreement_id: #{@agreement_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_initiated_transaction1.rb

@@ -0,0 +1,83 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantInitiatedTransaction1 Model.
+  class MerchantInitiatedTransaction1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Network transaction identifier that was returned in the payment response
+    # field _processorInformation.transactionID_
+    # in the reply message for either the original merchant-initiated payment in
+    # the series or the previous
+    # merchant-initiated payment in the series.
+    # @return [String]
+    attr_accessor :previous_transaction_id
+
+    # Amount of the original authorization.
+    # @return [String]
+    attr_accessor :original_authorized_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['previous_transaction_id'] = 'previousTransactionId'
+      @_hash['original_authorized_amount'] = 'originalAuthorizedAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        previous_transaction_id
+        original_authorized_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(previous_transaction_id = SKIP,
+                   original_authorized_amount = SKIP)
+      @previous_transaction_id = previous_transaction_id unless previous_transaction_id == SKIP
+      unless original_authorized_amount == SKIP
+        @original_authorized_amount =
+          original_authorized_amount
+      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.
+      previous_transaction_id =
+        hash.key?('previousTransactionId') ? hash['previousTransactionId'] : SKIP
+      original_authorized_amount =
+        hash.key?('originalAuthorizedAmount') ? hash['originalAuthorizedAmount'] : SKIP
+
+      # Create object from extracted values.
+      MerchantInitiatedTransaction1.new(previous_transaction_id,
+                                        original_authorized_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} previous_transaction_id: #{@previous_transaction_id},"\
+      " original_authorized_amount: #{@original_authorized_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} previous_transaction_id: #{@previous_transaction_id.inspect},"\
+      " original_authorized_amount: #{@original_authorized_amount.inspect}>"
+    end
+  end
+end