fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/line_item.rb

@@ -0,0 +1,246 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # LineItem Model.
+  class LineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Tax identification number of the merchant that reported the alternate tax
+    # amount.
+    # @return [String]
+    attr_accessor :alternate_tax_id
+
+    # Indicator used to reflect debit (D) or credit (C) transaction. Allowed
+    # values: “D”, “C”.
+    # @return [DebitCreditEnum]
+    attr_accessor :debit_credit
+
+    # Description of the item.
+    # @return [String]
+    attr_accessor :description
+
+    # Total discount amount applied against the line item total ,Can accept Two
+    # (2) decimal places.
+    # @return [Integer]
+    attr_accessor :discount_amount
+
+    # Discount rate for the line item ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :discount_rate
+
+    # Merchant-defined description code of the item.
+    # @return [String]
+    attr_accessor :product_code
+
+    # Quantity of the item, can accept Four (4) decimal places.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Amount of any value added taxes, can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :tax_amount
+
+    # Tax rate used to calculate the sales tax amount, can accept 2 decimal
+    # places.
+    # @return [Integer]
+    attr_accessor :tax_rate
+
+    # Type of value-added taxes that are being used (Conditional If tax amount
+    # is supplied)
+    # >This field is only required when Merchant is directed to include by
+    # Mastercard.
+    # >
+    # @return [String]
+    attr_accessor :tax_type_applied
+
+    # Indicates the type of tax collected in relationship to a specific tax
+    # amount (Conditional If tax amount is supplied)
+    # @return [String]
+    attr_accessor :tax_type_id
+
+    # Units of measurement as used in international trade. (See Codes for Units
+    # of Measurement below for unit code abbreviations)
+    # @return [String]
+    attr_accessor :unit_code
+
+    # Unit cost of the item ,Can accept Four (4) decimal places.
+    # @return [Integer]
+    attr_accessor :unit_cost
+
+    # An international description code of the individual good or service being
+    # supplied.
+    # @return [String]
+    attr_accessor :commodity_code
+
+    # Used if city or multiple county taxes need to be broken out separately
+    # ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :other_tax_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alternate_tax_id'] = 'alternate_tax_id'
+      @_hash['debit_credit'] = 'debit_credit'
+      @_hash['description'] = 'description'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['discount_rate'] = 'discount_rate'
+      @_hash['product_code'] = 'product_code'
+      @_hash['quantity'] = 'quantity'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['tax_rate'] = 'tax_rate'
+      @_hash['tax_type_applied'] = 'tax_type_applied'
+      @_hash['tax_type_id'] = 'tax_type_id'
+      @_hash['unit_code'] = 'unit_code'
+      @_hash['unit_cost'] = 'unit_cost'
+      @_hash['commodity_code'] = 'commodity_code'
+      @_hash['other_tax_amount'] = 'other_tax_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alternate_tax_id
+        debit_credit
+        description
+        discount_amount
+        discount_rate
+        product_code
+        quantity
+        tax_amount
+        tax_rate
+        tax_type_applied
+        tax_type_id
+        unit_code
+        unit_cost
+        commodity_code
+        other_tax_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        alternate_tax_id
+        debit_credit
+        discount_amount
+        discount_rate
+        quantity
+        tax_amount
+        tax_rate
+        tax_type_applied
+        tax_type_id
+        commodity_code
+        other_tax_amount
+      ]
+    end
+
+    def initialize(alternate_tax_id = SKIP, debit_credit = SKIP,
+                   description = SKIP, discount_amount = SKIP,
+                   discount_rate = SKIP, product_code = SKIP, quantity = SKIP,
+                   tax_amount = SKIP, tax_rate = SKIP, tax_type_applied = SKIP,
+                   tax_type_id = SKIP, unit_code = SKIP, unit_cost = SKIP,
+                   commodity_code = SKIP, other_tax_amount = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @alternate_tax_id = alternate_tax_id unless alternate_tax_id == SKIP
+      @debit_credit = debit_credit unless debit_credit == SKIP
+      @description = description unless description == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @discount_rate = discount_rate unless discount_rate == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @tax_rate = tax_rate unless tax_rate == SKIP
+      @tax_type_applied = tax_type_applied unless tax_type_applied == SKIP
+      @tax_type_id = tax_type_id unless tax_type_id == SKIP
+      @unit_code = unit_code unless unit_code == SKIP
+      @unit_cost = unit_cost unless unit_cost == SKIP
+      @commodity_code = commodity_code unless commodity_code == SKIP
+      @other_tax_amount = other_tax_amount unless other_tax_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.
+      alternate_tax_id =
+        hash.key?('alternate_tax_id') ? hash['alternate_tax_id'] : SKIP
+      debit_credit = hash.key?('debit_credit') ? hash['debit_credit'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+      discount_rate = hash.key?('discount_rate') ? hash['discount_rate'] : SKIP
+      product_code = hash.key?('product_code') ? hash['product_code'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      tax_rate = hash.key?('tax_rate') ? hash['tax_rate'] : SKIP
+      tax_type_applied =
+        hash.key?('tax_type_applied') ? hash['tax_type_applied'] : SKIP
+      tax_type_id = hash.key?('tax_type_id') ? hash['tax_type_id'] : SKIP
+      unit_code = hash.key?('unit_code') ? hash['unit_code'] : SKIP
+      unit_cost = hash.key?('unit_cost') ? hash['unit_cost'] : SKIP
+      commodity_code =
+        hash.key?('commodity_code') ? hash['commodity_code'] : SKIP
+      other_tax_amount =
+        hash.key?('other_tax_amount') ? hash['other_tax_amount'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      LineItem.new(alternate_tax_id,
+                   debit_credit,
+                   description,
+                   discount_amount,
+                   discount_rate,
+                   product_code,
+                   quantity,
+                   tax_amount,
+                   tax_rate,
+                   tax_type_applied,
+                   tax_type_id,
+                   unit_code,
+                   unit_cost,
+                   commodity_code,
+                   other_tax_amount,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alternate_tax_id: #{@alternate_tax_id}, debit_credit: #{@debit_credit},"\
+      " description: #{@description}, discount_amount: #{@discount_amount}, discount_rate:"\
+      " #{@discount_rate}, product_code: #{@product_code}, quantity: #{@quantity}, tax_amount:"\
+      " #{@tax_amount}, tax_rate: #{@tax_rate}, tax_type_applied: #{@tax_type_applied},"\
+      " tax_type_id: #{@tax_type_id}, unit_code: #{@unit_code}, unit_cost: #{@unit_cost},"\
+      " commodity_code: #{@commodity_code}, other_tax_amount: #{@other_tax_amount},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alternate_tax_id: #{@alternate_tax_id.inspect}, debit_credit:"\
+      " #{@debit_credit.inspect}, description: #{@description.inspect}, discount_amount:"\
+      " #{@discount_amount.inspect}, discount_rate: #{@discount_rate.inspect}, product_code:"\
+      " #{@product_code.inspect}, quantity: #{@quantity.inspect}, tax_amount:"\
+      " #{@tax_amount.inspect}, tax_rate: #{@tax_rate.inspect}, tax_type_applied:"\
+      " #{@tax_type_applied.inspect}, tax_type_id: #{@tax_type_id.inspect}, unit_code:"\
+      " #{@unit_code.inspect}, unit_cost: #{@unit_cost.inspect}, commodity_code:"\
+      " #{@commodity_code.inspect}, other_tax_amount: #{@other_tax_amount.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/line_item13.rb

@@ -0,0 +1,245 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # LineItem13 Model.
+  class LineItem13 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of the item.
+    # @return [String]
+    attr_accessor :description
+
+    # An international description code of the individual good or service being
+    # supplied.
+    # @return [String]
+    attr_accessor :commodity_code
+
+    # Total discount amount applied against the line item total ,Can accept Two
+    # (2) decimal places.
+    # @return [Integer]
+    attr_accessor :discount_amount
+
+    # Used if city or multiple county taxes need to be broken out separately
+    # ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :other_tax_amount
+
+    # Merchant-defined description code of the item.
+    # @return [String]
+    attr_accessor :product_code
+
+    # Quantity of the item, can accept Four (4) decimal places.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Amount of any value added taxes, can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :tax_amount
+
+    # Tax rate used to calculate the sales tax amount, can accept 2 decimal
+    # places.
+    # @return [Integer]
+    attr_accessor :tax_rate
+
+    # Units of measurement as used in international trade. (See Codes for Units
+    # of Measurement below for unit code abbreviations)
+    # @return [String]
+    attr_accessor :unit_code
+
+    # Unit cost of the item ,Can accept Four (4) decimal places.
+    # @return [Integer]
+    attr_accessor :unit_cost
+
+    # Tax identification number of the merchant that reported the alternate tax
+    # amount.
+    # @return [String]
+    attr_accessor :alternate_tax_id
+
+    # Indicator used to reflect debit (D) or credit (C) transaction. Allowed
+    # values: “D”, “C”.
+    # @return [DebitCreditEnum]
+    attr_accessor :debit_credit
+
+    # Discount rate for the line item ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :discount_rate
+
+    # Type of value-added taxes that are being used (Conditional If tax amount
+    # is supplied)
+    # >This field is only required when Merchant is directed to include by
+    # Mastercard.
+    # >
+    # @return [String]
+    attr_accessor :tax_type_applied
+
+    # Indicates the type of tax collected in relationship to a specific tax
+    # amount (Conditional If tax amount is supplied)
+    # @return [String]
+    attr_accessor :tax_type_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['commodity_code'] = 'commodity_code'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['other_tax_amount'] = 'other_tax_amount'
+      @_hash['product_code'] = 'product_code'
+      @_hash['quantity'] = 'quantity'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['tax_rate'] = 'tax_rate'
+      @_hash['unit_code'] = 'unit_code'
+      @_hash['unit_cost'] = 'unit_cost'
+      @_hash['alternate_tax_id'] = 'alternate_tax_id'
+      @_hash['debit_credit'] = 'debit_credit'
+      @_hash['discount_rate'] = 'discount_rate'
+      @_hash['tax_type_applied'] = 'tax_type_applied'
+      @_hash['tax_type_id'] = 'tax_type_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        commodity_code
+        discount_amount
+        other_tax_amount
+        product_code
+        quantity
+        tax_amount
+        tax_rate
+        unit_code
+        unit_cost
+        alternate_tax_id
+        debit_credit
+        discount_rate
+        tax_type_applied
+        tax_type_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discount_amount
+        other_tax_amount
+        quantity
+        tax_amount
+        tax_rate
+        alternate_tax_id
+        debit_credit
+        discount_rate
+        tax_type_applied
+        tax_type_id
+      ]
+    end
+
+    def initialize(description = SKIP, commodity_code = SKIP,
+                   discount_amount = SKIP, other_tax_amount = SKIP,
+                   product_code = SKIP, quantity = SKIP, tax_amount = SKIP,
+                   tax_rate = SKIP, unit_code = SKIP, unit_cost = SKIP,
+                   alternate_tax_id = SKIP, debit_credit = SKIP,
+                   discount_rate = SKIP, tax_type_applied = SKIP,
+                   tax_type_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @description = description unless description == SKIP
+      @commodity_code = commodity_code unless commodity_code == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @other_tax_amount = other_tax_amount unless other_tax_amount == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @tax_rate = tax_rate unless tax_rate == SKIP
+      @unit_code = unit_code unless unit_code == SKIP
+      @unit_cost = unit_cost unless unit_cost == SKIP
+      @alternate_tax_id = alternate_tax_id unless alternate_tax_id == SKIP
+      @debit_credit = debit_credit unless debit_credit == SKIP
+      @discount_rate = discount_rate unless discount_rate == SKIP
+      @tax_type_applied = tax_type_applied unless tax_type_applied == SKIP
+      @tax_type_id = tax_type_id unless tax_type_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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      commodity_code =
+        hash.key?('commodity_code') ? hash['commodity_code'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+      other_tax_amount =
+        hash.key?('other_tax_amount') ? hash['other_tax_amount'] : SKIP
+      product_code = hash.key?('product_code') ? hash['product_code'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      tax_rate = hash.key?('tax_rate') ? hash['tax_rate'] : SKIP
+      unit_code = hash.key?('unit_code') ? hash['unit_code'] : SKIP
+      unit_cost = hash.key?('unit_cost') ? hash['unit_cost'] : SKIP
+      alternate_tax_id =
+        hash.key?('alternate_tax_id') ? hash['alternate_tax_id'] : SKIP
+      debit_credit = hash.key?('debit_credit') ? hash['debit_credit'] : SKIP
+      discount_rate = hash.key?('discount_rate') ? hash['discount_rate'] : SKIP
+      tax_type_applied =
+        hash.key?('tax_type_applied') ? hash['tax_type_applied'] : SKIP
+      tax_type_id = hash.key?('tax_type_id') ? hash['tax_type_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      LineItem13.new(description,
+                     commodity_code,
+                     discount_amount,
+                     other_tax_amount,
+                     product_code,
+                     quantity,
+                     tax_amount,
+                     tax_rate,
+                     unit_code,
+                     unit_cost,
+                     alternate_tax_id,
+                     debit_credit,
+                     discount_rate,
+                     tax_type_applied,
+                     tax_type_id,
+                     additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, commodity_code: #{@commodity_code},"\
+      " discount_amount: #{@discount_amount}, other_tax_amount: #{@other_tax_amount},"\
+      " product_code: #{@product_code}, quantity: #{@quantity}, tax_amount: #{@tax_amount},"\
+      " tax_rate: #{@tax_rate}, unit_code: #{@unit_code}, unit_cost: #{@unit_cost},"\
+      " alternate_tax_id: #{@alternate_tax_id}, debit_credit: #{@debit_credit}, discount_rate:"\
+      " #{@discount_rate}, tax_type_applied: #{@tax_type_applied}, tax_type_id: #{@tax_type_id},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, commodity_code:"\
+      " #{@commodity_code.inspect}, discount_amount: #{@discount_amount.inspect},"\
+      " other_tax_amount: #{@other_tax_amount.inspect}, product_code: #{@product_code.inspect},"\
+      " quantity: #{@quantity.inspect}, tax_amount: #{@tax_amount.inspect}, tax_rate:"\
+      " #{@tax_rate.inspect}, unit_code: #{@unit_code.inspect}, unit_cost: #{@unit_cost.inspect},"\
+      " alternate_tax_id: #{@alternate_tax_id.inspect}, debit_credit: #{@debit_credit.inspect},"\
+      " discount_rate: #{@discount_rate.inspect}, tax_type_applied: #{@tax_type_applied.inspect},"\
+      " tax_type_id: #{@tax_type_id.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end