visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/sub_merchant1.rb

@@ -0,0 +1,232 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # SubMerchant1 Model.
+  class SubMerchant1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sub-merchant’s business name.
+    # #### American Express Direct
+    # The maximum length of the sub-merchant name depends on the length of the
+    # aggregator name. The combined length for both values must not exceed 36
+    # characters.
+    # #### Visa Acceptance through VisaNet
+    # With American Express, the maximum length of the sub-merchant name depends
+    # on the length of the aggregator name. The combined length for both values
+    # must not exceed 36 characters. The value for this field does not map to
+    # the TC 33 capture file5.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # #### FDC Nashville Global
+    # With Mastercard, the maximum length of the sub-merchant name depends on
+    # the length of the aggregator name:
+    # - If aggregator name length is 1 through 3, maximum sub-merchant name
+    # length is 21.
+    # - If aggregator name length is 4 through 7, maximum sub-merchant name
+    # length is 17.
+    # - If aggregator name length is 8 through 12, maximum sub-merchant name
+    # length is 12.
+    # @return [String]
+    attr_accessor :name
+
+    # First line of the sub-merchant’s street address.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field does not map to the TC 33 capture file5.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # @return [String]
+    attr_accessor :address1
+
+    # Sub-merchant’s city.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field does not map to the TC 33 capture file5.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # @return [String]
+    attr_accessor :locality
+
+    # Sub-merchant’s state or province.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field does not map to the TC 33 capture file5.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # @return [String]
+    attr_accessor :administrative_area
+
+    # Partial postal code for the sub-merchant’s address.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field does not map to the TC 33 capture file5.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Sub-merchant’s country. Use the [ISO Standard Country Codes](
+    # #### Visa Acceptance through VisaNet
+    # The value for this field does not map to the TC 33 capture file.
+    # #### FDC Compass
+    # This value must consist of uppercase characters.
+    # @return [String]
+    attr_accessor :country
+
+    # Sub-merchant’s email address.
+    # **Maximum length for processors**
+    #  - American Express Direct: 40
+    #  - Visa Acceptance through VisaNet: 40
+    #  - FDC Compass: 40
+    #  - FDC Nashville Global: 19
+    # #### Visa Acceptance through VisaNet
+    # With American Express, the value for this field corresponds to the
+    # following data in the TC 33 capture file:
+    # - Record: CP01 TCRB
+    # - Position: 25-64
+    # - Field: American Express Seller E-mail Address
+    # **Note** The TC 33 Capture file contains information about the purchases
+    # and refunds that a merchant submits to Visa Acceptance. Visa Acceptance
+    # through VisaNet creates the TC 33 Capture file at the end of the day and
+    # sends it to the merchant’s acquirer, who uses this information to
+    # facilitate end-of-day clearing processing with payment card companies.
+    # @return [String]
+    attr_accessor :email
+
+    # Sub-merchant’s telephone number.
+    # **Maximum length for procesors**
+    #  - American Express Direct: 20
+    #  - Visa Acceptance through VisaNet: 20
+    #  - FDC Compass: 13
+    #  - FDC Nashville Global: 10
+    # #### Visa Acceptance through VisaNet
+    # With American Express, the value for this field corresponds to the
+    # following data in the TC 33 capture file5:
+    # - Record: CP01 TCRB
+    # - Position: 5-24
+    # - Field: American Express Seller Telephone Number
+    # **FDC Compass**\
+    # This value must consist of uppercase characters. Use one of these
+    # recommended formats:\
+    # `NNN-NNN-NNNN`\
+    # `NNN-AAAAAAA`
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The ID you assigned to your sub-merchant.
+    # Visa Acceptance through VisaNet: For American Express transaction, the
+    # value for this field corresponds to the following data in the TC 33
+    # capture file:
+    # - Record: CP01 TCRB
+    # - Position: 65-84
+    # - Field: American Express Seller ID
+    # For  Mastercard transactions, the value for this field corresponds to the
+    # following data in the TC 33 capture file:
+    # - Record: CP01 TCR6
+    # - Position: 117-131
+    # - Field: Sub-Merchant ID
+    # FDC Compass: This value must consist of uppercase characters.
+    # American Express Direct: String (20)
+    # Visa Acceptance through VisaNet with American Express: String (20)
+    # Visa Acceptance through VisaNet with Visa,Mastercard and Discover: String
+    # (15)
+    # FDC Compass: String (20)
+    # FDC Nashville Global: String (14)
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address1'] = 'address1'
+      @_hash['locality'] = 'locality'
+      @_hash['administrative_area'] = 'administrativeArea'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash['email'] = 'email'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        address1
+        locality
+        administrative_area
+        postal_code
+        country
+        email
+        phone_number
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, address1 = SKIP, locality = SKIP,
+                   administrative_area = SKIP, postal_code = SKIP,
+                   country = SKIP, email = SKIP, phone_number = SKIP, id = SKIP)
+      @name = name unless name == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @locality = locality unless locality == SKIP
+      @administrative_area = administrative_area unless administrative_area == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @email = email unless email == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @id = id unless 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      locality = hash.key?('locality') ? hash['locality'] : SKIP
+      administrative_area =
+        hash.key?('administrativeArea') ? hash['administrativeArea'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      SubMerchant1.new(name,
+                       address1,
+                       locality,
+                       administrative_area,
+                       postal_code,
+                       country,
+                       email,
+                       phone_number,
+                       id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, address1: #{@address1}, locality: #{@locality},"\
+      " administrative_area: #{@administrative_area}, postal_code: #{@postal_code}, country:"\
+      " #{@country}, email: #{@email}, phone_number: #{@phone_number}, id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, address1: #{@address1.inspect}, locality:"\
+      " #{@locality.inspect}, administrative_area: #{@administrative_area.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, email: #{@email.inspect},"\
+      " phone_number: #{@phone_number.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/surcharge.rb

@@ -0,0 +1,84 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Surcharge Model.
+  class Surcharge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The surcharge amount is included in the total transaction amount but is
+    # passed in a separate field to the issuer and acquirer for tracking. The
+    # issuer can provide information about the surcharge amount to the customer.
+    # If the amount is positive, then it is a debit for the customer.
+    # If the amount is negative, then it is a credit for the customer.
+    # **NOTE**: This field is supported only for Visa Acceptance through VisaNet
+    # (CtV) for Payouts. For CtV, the maximum string length is 8.
+    # #### PIN debit
+    # Surcharge amount that you are charging the customer for this transaction.
+    # If you include a surcharge amount
+    # in the request, you must also include the surcharge amount in the value
+    # for `orderInformation.amountDetails.totalAmount`.
+    # Optional field for transactions that use PIN debit credit or PIN debit
+    # purchase.
+    # @return [String]
+    attr_accessor :amount
+
+    # Merchant-defined field for describing the surcharge amount.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP, description = SKIP)
+      @amount = amount unless amount == SKIP
+      @description = description unless description == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      Surcharge.new(amount,
+                    description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, description: #{@description.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/surcharge1.rb

@@ -0,0 +1,75 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Surcharge1 Model.
+  class Surcharge1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The surcharge amount is included in the total transaction amount but is
+    # passed in a separate field to the issuer and acquirer for tracking. The
+    # issuer can provide information about the surcharge amount to the customer.
+    # If the amount is positive, then it is a debit for the customer.
+    # If the amount is negative, then it is a credit for the customer.
+    # **NOTE**: This field is supported only for Visa Acceptance through VisaNet
+    # (CtV) for Payouts. For CtV, the maximum string length is 8.
+    # #### PIN debit
+    # Surcharge amount that you are charging the customer for this transaction.
+    # If you include a surcharge amount
+    # in the request, you must also include the surcharge amount in the value
+    # for `orderInformation.amountDetails.totalAmount`.
+    # Optional field for transactions that use PIN debit credit or PIN debit
+    # purchase.
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP)
+      @amount = amount unless amount == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # Create object from extracted values.
+      Surcharge1.new(amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/tax_detail.rb

@@ -0,0 +1,170 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # TaxDetail Model.
+  class TaxDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the type of tax data for the _taxDetails_ object.
+    # Possible values:
+    # - `alternate`
+    # - `local`
+    # - `national`
+    # - `vat`
+    # - `other`
+    # - `green`
+    # @return [String]
+    attr_accessor :type
+
+    # Indicates the amount of tax based on the `type` field as described in the
+    # table below:
+    # | type      | type description |
+    # | ------------- |:-------------:|
+    # | `alternate` | Total amount of alternate tax for the order. |
+    # | `local`     | Sales tax for the order. |
+    # | `national`  | National tax for the order. |
+    # | `vat`       | Total amount of value added tax (VAT) included in the
+    # order. |
+    # | `other`     | Other tax. |
+    # | `green`     | Green tax amount for Korean Processing. |
+    # @return [String]
+    attr_accessor :amount
+
+    # Rate of VAT or other tax for the order.
+    # Example 0.040 (=4%)
+    # Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values
+    # accepted; values with additional
+    # decimal places will be truncated)
+    # @return [String]
+    attr_accessor :rate
+
+    # Type of tax being applied to the item.
+    # #### FDC Nashville Global
+    # - `alternate_tax_type_applied`
+    # - `alternate_tax_type_identifier`
+    # #### Worldpay VAP
+    # - `alternate_tax_type_identifier`
+    # #### RBS WorldPay Atlanta
+    # - `tax_type_applied`
+    # #### TSYS Acquiring Solutions
+    # - `tax_type_applied`
+    # - `local_tax_indicator`
+    # #### Chase Paymentech Solutions
+    # - `tax_type_applied`
+    # #### Elavon Americas
+    # - `local_tax_indicator`
+    # #### FDC Compass
+    # - `tax_type_applied`
+    # #### OmniPay Direct
+    # - `local_tax_indicator`
+    # @return [String]
+    attr_accessor :code
+
+    # Your tax ID number to use for the alternate tax amount. Required if you
+    # set alternate tax amount to any value,
+    # including zero. You may send this field without sending alternate tax
+    # amount.
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Flag that indicates whether the alternate tax amount
+    # (`orderInformation.amountDetails.taxDetails[].amount`) is
+    # included in the request.
+    # Possible values:
+    # - `false`: alternate tax amount is not included in the request.
+    # - `true`: alternate tax amount is included in the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :applied
+
+    # Status code for exemption from sales and use tax. This field is a
+    # pass-through, which means that
+    # Visa Acceptance does not verify the value or modify it in any way before
+    # sending it to the processor.
+    # @return [String]
+    attr_accessor :exemption_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['amount'] = 'amount'
+      @_hash['rate'] = 'rate'
+      @_hash['code'] = 'code'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['applied'] = 'applied'
+      @_hash['exemption_code'] = 'exemptionCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        amount
+        rate
+        code
+        tax_id
+        applied
+        exemption_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, amount = SKIP, rate = SKIP, code = SKIP,
+                   tax_id = SKIP, applied = SKIP, exemption_code = SKIP)
+      @type = type unless type == SKIP
+      @amount = amount unless amount == SKIP
+      @rate = rate unless rate == SKIP
+      @code = code unless code == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @applied = applied unless applied == SKIP
+      @exemption_code = exemption_code unless exemption_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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      rate = hash.key?('rate') ? hash['rate'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      applied = hash.key?('applied') ? hash['applied'] : SKIP
+      exemption_code = hash.key?('exemptionCode') ? hash['exemptionCode'] : SKIP
+
+      # Create object from extracted values.
+      TaxDetail.new(type,
+                    amount,
+                    rate,
+                    code,
+                    tax_id,
+                    applied,
+                    exemption_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, amount: #{@amount}, rate: #{@rate}, code: #{@code}, tax_id:"\
+      " #{@tax_id}, applied: #{@applied}, exemption_code: #{@exemption_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, amount: #{@amount.inspect}, rate: #{@rate.inspect},"\
+      " code: #{@code.inspect}, tax_id: #{@tax_id.inspect}, applied: #{@applied.inspect},"\
+      " exemption_code: #{@exemption_code.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/tax_details.rb

@@ -0,0 +1,125 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # TaxDetails Model.
+  class TaxDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the amount of tax based on the `type` field as described in the
+    # table below:
+    # @return [String]
+    attr_accessor :amount
+
+    # Rate of VAT or other tax for the order.
+    # Example 0.040 (=4%)
+    # Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values
+    # accepted; values with additional
+    # decimal places will be truncated)
+    # @return [String]
+    attr_accessor :rate
+
+    # Flag that indicates whether the tax amount
+    # (`travelInformation.autoRental.taxDetails.amount`) is
+    # included in the request.
+    # Possible values:
+    # - `false`: tax amount is not included in the request.
+    # - `true`:  tax amount is included in the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :applied
+
+    # Status code for exemption from sales and use tax. This field is a
+    # pass-through, which means that
+    # Visa Acceptance does not verify the value or modify it in any way before
+    # sending it to the processor.
+    # @return [String]
+    attr_accessor :exemption_code
+
+    # Different taxes the rental agency applies to the rental agreement such as
+    # tourist tax, airport tax, or rental tax.
+    # @return [String]
+    attr_accessor :tax_type
+
+    # Summary of all tax types
+    # @return [String]
+    attr_accessor :tax_summary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['rate'] = 'rate'
+      @_hash['applied'] = 'applied'
+      @_hash['exemption_code'] = 'exemptionCode'
+      @_hash['tax_type'] = 'taxType'
+      @_hash['tax_summary'] = 'taxSummary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        rate
+        applied
+        exemption_code
+        tax_type
+        tax_summary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP, rate = SKIP, applied = SKIP,
+                   exemption_code = SKIP, tax_type = SKIP, tax_summary = SKIP)
+      @amount = amount unless amount == SKIP
+      @rate = rate unless rate == SKIP
+      @applied = applied unless applied == SKIP
+      @exemption_code = exemption_code unless exemption_code == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      @tax_summary = tax_summary unless tax_summary == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      rate = hash.key?('rate') ? hash['rate'] : SKIP
+      applied = hash.key?('applied') ? hash['applied'] : SKIP
+      exemption_code = hash.key?('exemptionCode') ? hash['exemptionCode'] : SKIP
+      tax_type = hash.key?('taxType') ? hash['taxType'] : SKIP
+      tax_summary = hash.key?('taxSummary') ? hash['taxSummary'] : SKIP
+
+      # Create object from extracted values.
+      TaxDetails.new(amount,
+                     rate,
+                     applied,
+                     exemption_code,
+                     tax_type,
+                     tax_summary)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, rate: #{@rate}, applied: #{@applied}, exemption_code:"\
+      " #{@exemption_code}, tax_type: #{@tax_type}, tax_summary: #{@tax_summary}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, rate: #{@rate.inspect}, applied:"\
+      " #{@applied.inspect}, exemption_code: #{@exemption_code.inspect}, tax_type:"\
+      " #{@tax_type.inspect}, tax_summary: #{@tax_summary.inspect}>"
+    end
+  end
+end