visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/tax_details1.rb

@@ -0,0 +1,170 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # TaxDetails1 Model.
+  class TaxDetails1 < 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.
+      TaxDetails1.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/ticket_issuer.rb

@@ -0,0 +1,132 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # TicketIssuer Model.
+  class TicketIssuer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # IATA2 airline code.
+    # Format: English characters only.
+    # Required for Mastercard; optional for all other card types.
+    # @return [String]
+    attr_accessor :code
+
+    # Name of the ticket issuer. If you do not include this field,
+    # Visa Acceptance uses the value for your merchant name that is in the Visa
+    # Acceptance merchant configuration database.
+    # @return [String]
+    attr_accessor :name
+
+    # Address of the company issuing the ticket.
+    # @return [String]
+    attr_accessor :address
+
+    # City in which the transaction occurred.
+    # If the name of the city exceeds 18 characters, use meaningful
+    # abbreviations.
+    # Format: English characters only.
+    # Optional request field.
+    # @return [String]
+    attr_accessor :locality
+
+    # State in which transaction occured.
+    # @return [String]
+    attr_accessor :administrative_area
+
+    # Zip code of the city in which transaction occured.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country in which transaction occured.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['locality'] = 'locality'
+      @_hash['administrative_area'] = 'administrativeArea'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        name
+        address
+        locality
+        administrative_area
+        postal_code
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, name = SKIP, address = SKIP, locality = SKIP,
+                   administrative_area = SKIP, postal_code = SKIP,
+                   country = SKIP)
+      @code = code unless code == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == 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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = hash.key?('address') ? hash['address'] : 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
+
+      # Create object from extracted values.
+      TicketIssuer.new(code,
+                       name,
+                       address,
+                       locality,
+                       administrative_area,
+                       postal_code,
+                       country)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, name: #{@name}, address: #{@address}, locality:"\
+      " #{@locality}, administrative_area: #{@administrative_area}, postal_code: #{@postal_code},"\
+      " country: #{@country}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, locality: #{@locality.inspect}, administrative_area:"\
+      " #{@administrative_area.inspect}, postal_code: #{@postal_code.inspect}, country:"\
+      " #{@country.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/tms_authorization_options.rb

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

data/lib/visa_acceptance_merged_spec/models/tms_bin_lookup.rb

@@ -0,0 +1,81 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Bin Information of the PAN provided by BinLookUp Service. This is only
+  # retrieved when retrieveBinDetails=true is passed as a query parameter.
+  class TmsBinLookup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PaymentAccountInformation1]
+    attr_accessor :payment_account_information
+
+    # TODO: Write general description for this method
+    # @return [IssuerInformation6]
+    attr_accessor :issuer_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_account_information'] = 'paymentAccountInformation'
+      @_hash['issuer_information'] = 'issuerInformation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_account_information
+        issuer_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_account_information = SKIP,
+                   issuer_information = SKIP)
+      unless payment_account_information == SKIP
+        @payment_account_information =
+          payment_account_information
+      end
+      @issuer_information = issuer_information unless issuer_information == 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.
+      if hash['paymentAccountInformation']
+        payment_account_information = PaymentAccountInformation1.from_hash(hash['paymentAccountInformation'])
+      end
+      issuer_information = IssuerInformation6.from_hash(hash['issuerInformation']) if
+        hash['issuerInformation']
+
+      # Create object from extracted values.
+      TmsBinLookup.new(payment_account_information,
+                       issuer_information)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_account_information: #{@payment_account_information},"\
+      " issuer_information: #{@issuer_information}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_account_information: #{@payment_account_information.inspect},"\
+      " issuer_information: #{@issuer_information.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/tms_card_art.rb

@@ -0,0 +1,107 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Card art associated with the tokenized card.
+  class TmsCardArt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card foreground color.
+    # @return [String]
+    attr_accessor :foreground_color
+
+    # Combined card art asset associated with the tokenized card.
+    # @return [CombinedAsset]
+    attr_accessor :combined_asset
+
+    # Brand logo card art asset associated with the tokenized card.
+    # @return [BrandLogoAsset]
+    attr_accessor :brand_logo_asset
+
+    # Issuer logo card art asset associated with the tokenized card.
+    # @return [IssuerLogoAsset]
+    attr_accessor :issuer_logo_asset
+
+    # Icon card art asset associated with the tokenized card.
+    # @return [IconAsset]
+    attr_accessor :icon_asset
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['foreground_color'] = 'foregroundColor'
+      @_hash['combined_asset'] = 'combinedAsset'
+      @_hash['brand_logo_asset'] = 'brandLogoAsset'
+      @_hash['issuer_logo_asset'] = 'issuerLogoAsset'
+      @_hash['icon_asset'] = 'iconAsset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        foreground_color
+        combined_asset
+        brand_logo_asset
+        issuer_logo_asset
+        icon_asset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(foreground_color = SKIP, combined_asset = SKIP,
+                   brand_logo_asset = SKIP, issuer_logo_asset = SKIP,
+                   icon_asset = SKIP)
+      @foreground_color = foreground_color unless foreground_color == SKIP
+      @combined_asset = combined_asset unless combined_asset == SKIP
+      @brand_logo_asset = brand_logo_asset unless brand_logo_asset == SKIP
+      @issuer_logo_asset = issuer_logo_asset unless issuer_logo_asset == SKIP
+      @icon_asset = icon_asset unless icon_asset == 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.
+      foreground_color =
+        hash.key?('foregroundColor') ? hash['foregroundColor'] : SKIP
+      combined_asset = CombinedAsset.from_hash(hash['combinedAsset']) if hash['combinedAsset']
+      brand_logo_asset = BrandLogoAsset.from_hash(hash['brandLogoAsset']) if
+        hash['brandLogoAsset']
+      issuer_logo_asset = IssuerLogoAsset.from_hash(hash['issuerLogoAsset']) if
+        hash['issuerLogoAsset']
+      icon_asset = IconAsset.from_hash(hash['iconAsset']) if hash['iconAsset']
+
+      # Create object from extracted values.
+      TmsCardArt.new(foreground_color,
+                     combined_asset,
+                     brand_logo_asset,
+                     issuer_logo_asset,
+                     icon_asset)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} foreground_color: #{@foreground_color}, combined_asset: #{@combined_asset},"\
+      " brand_logo_asset: #{@brand_logo_asset}, issuer_logo_asset: #{@issuer_logo_asset},"\
+      " icon_asset: #{@icon_asset}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} foreground_color: #{@foreground_color.inspect}, combined_asset:"\
+      " #{@combined_asset.inspect}, brand_logo_asset: #{@brand_logo_asset.inspect},"\
+      " issuer_logo_asset: #{@issuer_logo_asset.inspect}, icon_asset: #{@icon_asset.inspect}>"
+    end
+  end
+end