fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/level3_data6.rb

@@ -0,0 +1,273 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Level 3 data object
+  class Level3Data6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of the country where the goods are being shipped.
+    # @return [String]
+    attr_accessor :destination_country_code
+
+    # Fee amount associated with the import of the purchased goods ,Can accept
+    # Two (2) decimal places
+    # @return [Integer]
+    attr_accessor :duty_amount
+
+    # Freight or shipping portion of the total transaction amount ,Can accept
+    # Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :freight_amount
+
+    # National tax for the transaction ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :national_tax
+
+    # Sales tax for the transaction ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :sales_tax
+
+    # Postal/ZIP code of the address from where the purchased goods are being
+    # shipped.
+    # @return [String]
+    attr_accessor :shipfrom_zip_code
+
+    # Postal/ZIP code of the address where purchased goods will be delivered.
+    # @return [String]
+    attr_accessor :shipto_zip_code
+
+    # Amount of any value added taxes ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :tax_amount
+
+    # Sales Tax Exempt. Allowed values: “1”, “0”.
+    # @return [TaxExemptEnum]
+    attr_accessor :tax_exempt
+
+    # Customer VAT Registration
+    # @return [String]
+    attr_accessor :customer_vat_registration
+
+    # Merchant VAT Registration
+    # @return [String]
+    attr_accessor :merchant_vat_registration
+
+    # Order Date
+    # @return [String]
+    attr_accessor :order_date
+
+    # Summary Commodity Code
+    # @return [String]
+    attr_accessor :summary_commodity_code
+
+    # Tax rate used to calculate the sales tax amount, can accept 2 decimal
+    # places.
+    # @return [Integer]
+    attr_accessor :tax_rate
+
+    # Unique VAT Reference Number
+    # @return [String]
+    attr_accessor :unique_vat_ref_number
+
+    # Array of line items in transaction
+    # @return [Array[LineItem20]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_country_code'] = 'destination_country_code'
+      @_hash['duty_amount'] = 'duty_amount'
+      @_hash['freight_amount'] = 'freight_amount'
+      @_hash['national_tax'] = 'national_tax'
+      @_hash['sales_tax'] = 'sales_tax'
+      @_hash['shipfrom_zip_code'] = 'shipfrom_zip_code'
+      @_hash['shipto_zip_code'] = 'shipto_zip_code'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['customer_vat_registration'] = 'customer_vat_registration'
+      @_hash['merchant_vat_registration'] = 'merchant_vat_registration'
+      @_hash['order_date'] = 'order_date'
+      @_hash['summary_commodity_code'] = 'summary_commodity_code'
+      @_hash['tax_rate'] = 'tax_rate'
+      @_hash['unique_vat_ref_number'] = 'unique_vat_ref_number'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination_country_code
+        duty_amount
+        freight_amount
+        national_tax
+        sales_tax
+        shipfrom_zip_code
+        shipto_zip_code
+        tax_amount
+        tax_exempt
+        customer_vat_registration
+        merchant_vat_registration
+        order_date
+        summary_commodity_code
+        tax_rate
+        unique_vat_ref_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        destination_country_code
+        duty_amount
+        freight_amount
+        national_tax
+        sales_tax
+        shipfrom_zip_code
+        shipto_zip_code
+        tax_amount
+        tax_exempt
+        customer_vat_registration
+        merchant_vat_registration
+        order_date
+        summary_commodity_code
+        tax_rate
+        unique_vat_ref_number
+      ]
+    end
+
+    def initialize(line_items = nil, destination_country_code = SKIP,
+                   duty_amount = SKIP, freight_amount = SKIP,
+                   national_tax = SKIP, sales_tax = SKIP,
+                   shipfrom_zip_code = SKIP, shipto_zip_code = SKIP,
+                   tax_amount = SKIP, tax_exempt = SKIP,
+                   customer_vat_registration = SKIP,
+                   merchant_vat_registration = SKIP, order_date = SKIP,
+                   summary_commodity_code = SKIP, tax_rate = SKIP,
+                   unique_vat_ref_number = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @destination_country_code = destination_country_code unless destination_country_code == SKIP
+      @duty_amount = duty_amount unless duty_amount == SKIP
+      @freight_amount = freight_amount unless freight_amount == SKIP
+      @national_tax = national_tax unless national_tax == SKIP
+      @sales_tax = sales_tax unless sales_tax == SKIP
+      @shipfrom_zip_code = shipfrom_zip_code unless shipfrom_zip_code == SKIP
+      @shipto_zip_code = shipto_zip_code unless shipto_zip_code == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      unless customer_vat_registration == SKIP
+        @customer_vat_registration =
+          customer_vat_registration
+      end
+      unless merchant_vat_registration == SKIP
+        @merchant_vat_registration =
+          merchant_vat_registration
+      end
+      @order_date = order_date unless order_date == SKIP
+      @summary_commodity_code = summary_commodity_code unless summary_commodity_code == SKIP
+      @tax_rate = tax_rate unless tax_rate == SKIP
+      @unique_vat_ref_number = unique_vat_ref_number unless unique_vat_ref_number == SKIP
+      @line_items = line_items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItem20.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      destination_country_code =
+        hash.key?('destination_country_code') ? hash['destination_country_code'] : SKIP
+      duty_amount = hash.key?('duty_amount') ? hash['duty_amount'] : SKIP
+      freight_amount =
+        hash.key?('freight_amount') ? hash['freight_amount'] : SKIP
+      national_tax = hash.key?('national_tax') ? hash['national_tax'] : SKIP
+      sales_tax = hash.key?('sales_tax') ? hash['sales_tax'] : SKIP
+      shipfrom_zip_code =
+        hash.key?('shipfrom_zip_code') ? hash['shipfrom_zip_code'] : SKIP
+      shipto_zip_code =
+        hash.key?('shipto_zip_code') ? hash['shipto_zip_code'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
+      customer_vat_registration =
+        hash.key?('customer_vat_registration') ? hash['customer_vat_registration'] : SKIP
+      merchant_vat_registration =
+        hash.key?('merchant_vat_registration') ? hash['merchant_vat_registration'] : SKIP
+      order_date = hash.key?('order_date') ? hash['order_date'] : SKIP
+      summary_commodity_code =
+        hash.key?('summary_commodity_code') ? hash['summary_commodity_code'] : SKIP
+      tax_rate = hash.key?('tax_rate') ? hash['tax_rate'] : SKIP
+      unique_vat_ref_number =
+        hash.key?('unique_vat_ref_number') ? hash['unique_vat_ref_number'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Level3Data6.new(line_items,
+                      destination_country_code,
+                      duty_amount,
+                      freight_amount,
+                      national_tax,
+                      sales_tax,
+                      shipfrom_zip_code,
+                      shipto_zip_code,
+                      tax_amount,
+                      tax_exempt,
+                      customer_vat_registration,
+                      merchant_vat_registration,
+                      order_date,
+                      summary_commodity_code,
+                      tax_rate,
+                      unique_vat_ref_number,
+                      additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_country_code: #{@destination_country_code}, duty_amount:"\
+      " #{@duty_amount}, freight_amount: #{@freight_amount}, national_tax: #{@national_tax},"\
+      " sales_tax: #{@sales_tax}, shipfrom_zip_code: #{@shipfrom_zip_code}, shipto_zip_code:"\
+      " #{@shipto_zip_code}, tax_amount: #{@tax_amount}, tax_exempt: #{@tax_exempt},"\
+      " customer_vat_registration: #{@customer_vat_registration}, merchant_vat_registration:"\
+      " #{@merchant_vat_registration}, order_date: #{@order_date}, summary_commodity_code:"\
+      " #{@summary_commodity_code}, tax_rate: #{@tax_rate}, unique_vat_ref_number:"\
+      " #{@unique_vat_ref_number}, line_items: #{@line_items}, 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} destination_country_code: #{@destination_country_code.inspect},"\
+      " duty_amount: #{@duty_amount.inspect}, freight_amount: #{@freight_amount.inspect},"\
+      " national_tax: #{@national_tax.inspect}, sales_tax: #{@sales_tax.inspect},"\
+      " shipfrom_zip_code: #{@shipfrom_zip_code.inspect}, shipto_zip_code:"\
+      " #{@shipto_zip_code.inspect}, tax_amount: #{@tax_amount.inspect}, tax_exempt:"\
+      " #{@tax_exempt.inspect}, customer_vat_registration: #{@customer_vat_registration.inspect},"\
+      " merchant_vat_registration: #{@merchant_vat_registration.inspect}, order_date:"\
+      " #{@order_date.inspect}, summary_commodity_code: #{@summary_commodity_code.inspect},"\
+      " tax_rate: #{@tax_rate.inspect}, unique_vat_ref_number: #{@unique_vat_ref_number.inspect},"\
+      " line_items: #{@line_items.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/level3_default.rb

@@ -0,0 +1,274 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Level3 Default
+  class Level3Default < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of the country where the goods are being shipped.
+    # @return [String]
+    attr_accessor :destination_country_code
+
+    # Fee amount associated with the import of the purchased goods ,Can accept
+    # Two (2) decimal places
+    # @return [Integer]
+    attr_accessor :duty_amount
+
+    # Freight or shipping portion of the total transaction amount ,Can accept
+    # Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :freight_amount
+
+    # National tax for the transaction ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :national_tax
+
+    # Sales tax for the transaction ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :sales_tax
+
+    # Postal/ZIP code of the address from where the purchased goods are being
+    # shipped.
+    # @return [String]
+    attr_accessor :shipfrom_zip_code
+
+    # Postal/ZIP code of the address where purchased goods will be delivered.
+    # @return [String]
+    attr_accessor :shipto_zip_code
+
+    # Amount of any value added taxes ,Can accept Two (2) decimal places.
+    # @return [Integer]
+    attr_accessor :tax_amount
+
+    # Sales Tax Exempt. Allowed values: “1”, “0”.
+    # @return [TaxExemptEnum]
+    attr_accessor :tax_exempt
+
+    # Customer VAT Registration
+    # @return [String]
+    attr_accessor :customer_vat_registration
+
+    # Merchant VAT Registration
+    # @return [String]
+    attr_accessor :merchant_vat_registration
+
+    # Order Date
+    # @return [String]
+    attr_accessor :order_date
+
+    # Summary Commodity Code
+    # @return [String]
+    attr_accessor :summary_commodity_code
+
+    # Tax rate used to calculate the sales tax amount, can accept 2 decimal
+    # places.
+    # @return [Integer]
+    attr_accessor :tax_rate
+
+    # Unique VAT Reference Number
+    # @return [String]
+    attr_accessor :unique_vat_ref_number
+
+    # Array of line items in transaction
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_country_code'] = 'destination_country_code'
+      @_hash['duty_amount'] = 'duty_amount'
+      @_hash['freight_amount'] = 'freight_amount'
+      @_hash['national_tax'] = 'national_tax'
+      @_hash['sales_tax'] = 'sales_tax'
+      @_hash['shipfrom_zip_code'] = 'shipfrom_zip_code'
+      @_hash['shipto_zip_code'] = 'shipto_zip_code'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['customer_vat_registration'] = 'customer_vat_registration'
+      @_hash['merchant_vat_registration'] = 'merchant_vat_registration'
+      @_hash['order_date'] = 'order_date'
+      @_hash['summary_commodity_code'] = 'summary_commodity_code'
+      @_hash['tax_rate'] = 'tax_rate'
+      @_hash['unique_vat_ref_number'] = 'unique_vat_ref_number'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination_country_code
+        duty_amount
+        freight_amount
+        national_tax
+        sales_tax
+        shipfrom_zip_code
+        shipto_zip_code
+        tax_amount
+        tax_exempt
+        customer_vat_registration
+        merchant_vat_registration
+        order_date
+        summary_commodity_code
+        tax_rate
+        unique_vat_ref_number
+        line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        destination_country_code
+        duty_amount
+        freight_amount
+        national_tax
+        sales_tax
+        shipfrom_zip_code
+        shipto_zip_code
+        tax_amount
+        tax_exempt
+        customer_vat_registration
+        merchant_vat_registration
+        order_date
+        summary_commodity_code
+        tax_rate
+        unique_vat_ref_number
+      ]
+    end
+
+    def initialize(destination_country_code = SKIP, duty_amount = SKIP,
+                   freight_amount = SKIP, national_tax = SKIP, sales_tax = SKIP,
+                   shipfrom_zip_code = SKIP, shipto_zip_code = SKIP,
+                   tax_amount = SKIP, tax_exempt = SKIP,
+                   customer_vat_registration = SKIP,
+                   merchant_vat_registration = SKIP, order_date = SKIP,
+                   summary_commodity_code = SKIP, tax_rate = SKIP,
+                   unique_vat_ref_number = SKIP, line_items = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @destination_country_code = destination_country_code unless destination_country_code == SKIP
+      @duty_amount = duty_amount unless duty_amount == SKIP
+      @freight_amount = freight_amount unless freight_amount == SKIP
+      @national_tax = national_tax unless national_tax == SKIP
+      @sales_tax = sales_tax unless sales_tax == SKIP
+      @shipfrom_zip_code = shipfrom_zip_code unless shipfrom_zip_code == SKIP
+      @shipto_zip_code = shipto_zip_code unless shipto_zip_code == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      unless customer_vat_registration == SKIP
+        @customer_vat_registration =
+          customer_vat_registration
+      end
+      unless merchant_vat_registration == SKIP
+        @merchant_vat_registration =
+          merchant_vat_registration
+      end
+      @order_date = order_date unless order_date == SKIP
+      @summary_commodity_code = summary_commodity_code unless summary_commodity_code == SKIP
+      @tax_rate = tax_rate unless tax_rate == SKIP
+      @unique_vat_ref_number = unique_vat_ref_number unless unique_vat_ref_number == SKIP
+      @line_items = line_items unless line_items == 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.
+      destination_country_code =
+        hash.key?('destination_country_code') ? hash['destination_country_code'] : SKIP
+      duty_amount = hash.key?('duty_amount') ? hash['duty_amount'] : SKIP
+      freight_amount =
+        hash.key?('freight_amount') ? hash['freight_amount'] : SKIP
+      national_tax = hash.key?('national_tax') ? hash['national_tax'] : SKIP
+      sales_tax = hash.key?('sales_tax') ? hash['sales_tax'] : SKIP
+      shipfrom_zip_code =
+        hash.key?('shipfrom_zip_code') ? hash['shipfrom_zip_code'] : SKIP
+      shipto_zip_code =
+        hash.key?('shipto_zip_code') ? hash['shipto_zip_code'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
+      customer_vat_registration =
+        hash.key?('customer_vat_registration') ? hash['customer_vat_registration'] : SKIP
+      merchant_vat_registration =
+        hash.key?('merchant_vat_registration') ? hash['merchant_vat_registration'] : SKIP
+      order_date = hash.key?('order_date') ? hash['order_date'] : SKIP
+      summary_commodity_code =
+        hash.key?('summary_commodity_code') ? hash['summary_commodity_code'] : SKIP
+      tax_rate = hash.key?('tax_rate') ? hash['tax_rate'] : SKIP
+      unique_vat_ref_number =
+        hash.key?('unique_vat_ref_number') ? hash['unique_vat_ref_number'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Level3Default.new(destination_country_code,
+                        duty_amount,
+                        freight_amount,
+                        national_tax,
+                        sales_tax,
+                        shipfrom_zip_code,
+                        shipto_zip_code,
+                        tax_amount,
+                        tax_exempt,
+                        customer_vat_registration,
+                        merchant_vat_registration,
+                        order_date,
+                        summary_commodity_code,
+                        tax_rate,
+                        unique_vat_ref_number,
+                        line_items,
+                        additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_country_code: #{@destination_country_code}, duty_amount:"\
+      " #{@duty_amount}, freight_amount: #{@freight_amount}, national_tax: #{@national_tax},"\
+      " sales_tax: #{@sales_tax}, shipfrom_zip_code: #{@shipfrom_zip_code}, shipto_zip_code:"\
+      " #{@shipto_zip_code}, tax_amount: #{@tax_amount}, tax_exempt: #{@tax_exempt},"\
+      " customer_vat_registration: #{@customer_vat_registration}, merchant_vat_registration:"\
+      " #{@merchant_vat_registration}, order_date: #{@order_date}, summary_commodity_code:"\
+      " #{@summary_commodity_code}, tax_rate: #{@tax_rate}, unique_vat_ref_number:"\
+      " #{@unique_vat_ref_number}, line_items: #{@line_items}, 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} destination_country_code: #{@destination_country_code.inspect},"\
+      " duty_amount: #{@duty_amount.inspect}, freight_amount: #{@freight_amount.inspect},"\
+      " national_tax: #{@national_tax.inspect}, sales_tax: #{@sales_tax.inspect},"\
+      " shipfrom_zip_code: #{@shipfrom_zip_code.inspect}, shipto_zip_code:"\
+      " #{@shipto_zip_code.inspect}, tax_amount: #{@tax_amount.inspect}, tax_exempt:"\
+      " #{@tax_exempt.inspect}, customer_vat_registration: #{@customer_vat_registration.inspect},"\
+      " merchant_vat_registration: #{@merchant_vat_registration.inspect}, order_date:"\
+      " #{@order_date.inspect}, summary_commodity_code: #{@summary_commodity_code.inspect},"\
+      " tax_rate: #{@tax_rate.inspect}, unique_vat_ref_number: #{@unique_vat_ref_number.inspect},"\
+      " line_items: #{@line_items.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end