newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/enriched_quotation_tax_rate_dto.rb

@@ -0,0 +1,123 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EnrichedQuotationTaxRateDto Model.
+  class EnrichedQuotationTaxRateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Monetary tax amount for the unit price corresponding to this tax_rate
+    # item's percent value, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Country of jurisdiction for the applied tax.
+    # @return [String]
+    attr_accessor :country_code
+
+    # The item net amount which has been tax exempt, in the currency's minor
+    # unit.
+    # @return [Integer]
+    attr_accessor :exempt_amount
+
+    # Tax percent value for this tax rate item, e.g. 0.19 means 19% tax.
+    # @return [Float]
+    attr_accessor :rate
+
+    # Name of the applied tax.
+    # @return [String]
+    attr_accessor :tax_name
+
+    # Name of the applied tax.
+    # @return [TaxStatusEnum]
+    attr_accessor :tax_status
+
+    # The taxable item net amount on which the tax is chargeable, in the
+    # currency's minor unit.
+    # @return [Integer]
+    attr_accessor :taxable_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['country_code'] = 'country_code'
+      @_hash['exempt_amount'] = 'exempt_amount'
+      @_hash['rate'] = 'rate'
+      @_hash['tax_name'] = 'tax_name'
+      @_hash['tax_status'] = 'tax_status'
+      @_hash['taxable_amount'] = 'taxable_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        exempt_amount
+        tax_status
+        taxable_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, country_code = nil, rate = nil, tax_name = nil,
+                   exempt_amount = SKIP, tax_status = SKIP,
+                   taxable_amount = SKIP)
+      @amount = amount
+      @country_code = country_code
+      @exempt_amount = exempt_amount unless exempt_amount == SKIP
+      @rate = rate
+      @tax_name = tax_name
+      @tax_status = tax_status unless tax_status == SKIP
+      @taxable_amount = taxable_amount unless taxable_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'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      tax_name = hash.key?('tax_name') ? hash['tax_name'] : nil
+      exempt_amount = hash.key?('exempt_amount') ? hash['exempt_amount'] : SKIP
+      tax_status = hash.key?('tax_status') ? hash['tax_status'] : SKIP
+      taxable_amount =
+        hash.key?('taxable_amount') ? hash['taxable_amount'] : SKIP
+
+      # Create object from extracted values.
+      EnrichedQuotationTaxRateDto.new(amount,
+                                      country_code,
+                                      rate,
+                                      tax_name,
+                                      exempt_amount,
+                                      tax_status,
+                                      taxable_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}, country_code: #{@country_code}, exempt_amount:"\
+      " #{@exempt_amount}, rate: #{@rate}, tax_name: #{@tax_name}, tax_status: #{@tax_status},"\
+      " taxable_amount: #{@taxable_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}, country_code: #{@country_code.inspect},"\
+      " exempt_amount: #{@exempt_amount.inspect}, rate: #{@rate.inspect}, tax_name:"\
+      " #{@tax_name.inspect}, tax_status: #{@tax_status.inspect}, taxable_amount:"\
+      " #{@taxable_amount.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/enriched_transaction_address_dto.rb

@@ -0,0 +1,134 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EnrichedTransactionAddressDto Model.
+  class EnrichedTransactionAddressDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location address line 1.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Location address line 2.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # Location city.
+    # @return [String]
+    attr_accessor :city
+
+    # Location city.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Location province.
+    # @return [String]
+    attr_accessor :province
+
+    # Location state.
+    # @return [String]
+    attr_accessor :state
+
+    # NewStore Store ID of the address.
+    # @return [String]
+    attr_accessor :store_id
+
+    # Location ZIP code.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['city'] = 'city'
+      @_hash['country_code'] = 'country_code'
+      @_hash['province'] = 'province'
+      @_hash['state'] = 'state'
+      @_hash['store_id'] = 'store_id'
+      @_hash['zip_code'] = 'zip_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_1
+        address_line_2
+        city
+        country_code
+        province
+        state
+        store_id
+        zip_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_line_1 = SKIP, address_line_2 = SKIP, city = SKIP,
+                   country_code = SKIP, province = SKIP, state = SKIP,
+                   store_id = SKIP, zip_code = SKIP)
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @city = city unless city == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @province = province unless province == SKIP
+      @state = state unless state == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @zip_code = zip_code unless zip_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.
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      province = hash.key?('province') ? hash['province'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      zip_code = hash.key?('zip_code') ? hash['zip_code'] : SKIP
+
+      # Create object from extracted values.
+      EnrichedTransactionAddressDto.new(address_line_1,
+                                        address_line_2,
+                                        city,
+                                        country_code,
+                                        province,
+                                        state,
+                                        store_id,
+                                        zip_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_line_1: #{@address_line_1}, address_line_2: #{@address_line_2},"\
+      " city: #{@city}, country_code: #{@country_code}, province: #{@province}, state: #{@state},"\
+      " store_id: #{@store_id}, zip_code: #{@zip_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_line_1: #{@address_line_1.inspect}, address_line_2:"\
+      " #{@address_line_2.inspect}, city: #{@city.inspect}, country_code:"\
+      " #{@country_code.inspect}, province: #{@province.inspect}, state: #{@state.inspect},"\
+      " store_id: #{@store_id.inspect}, zip_code: #{@zip_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/enriched_transaction_dto.rb

@@ -0,0 +1,188 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # EnrichedTransactionDto Model.
+  class EnrichedTransactionDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CalculationModeEnum]
+    attr_accessor :calculation_mode
+
+    # The documentId of the created tax transaction.
+    # @return [String]
+    attr_accessor :document_id
+
+    # The documentId of the created tax transaction.
+    # @return [ExemptionClassEnum]
+    attr_accessor :exemption_class
+
+    # The number of the customer's exemption certificate.
+    # * The given value can be verified by the auditors in the event of a tax
+    # audit.
+    # @return [String]
+    attr_accessor :exemption_number
+
+    # The optional error of the original tax provider execution that triggered
+    # the execution of the fall-back tax provider. Will be returned when the
+    # orignal tax provider failure occurs.
+    # @return [FallbackErrorDto]
+    attr_accessor :fallback_error
+
+    # A list of the items sold/returned in the transaction, enriched with the
+    # tax amounts.
+    # @return [Array[EnrichedTransactionItemDto]]
+    attr_accessor :items
+
+    # The order ID that will be used as a reference to link the order to the
+    # created tax transaction in the tax provider records.
+    # * In case the order ID is not provided then a randomly generated
+    # identifier will be used instead.
+    # * The tax transaction will be stored by using the given value.
+    # @return [String]
+    attr_accessor :order_id
+
+    # The return ID that will be used as a reference to link the order to the
+    # created tax transaction in the tax provider records.
+    # * The tax transaction for returns will be stored by using the given value.
+    # * If the value is not set, the return transaction will not be stored.
+    # @return [String]
+    attr_accessor :return_id
+
+    # Defines the tax exemption status of the transaction.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # The transaction total amounts.
+    # @return [TaxTotalsDto]
+    attr_accessor :totals
+
+    # The transaction total amounts.
+    # @return [TransactionTypeEnum]
+    attr_accessor :transaction_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['calculation_mode'] = 'calculation_mode'
+      @_hash['document_id'] = 'document_id'
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['exemption_number'] = 'exemption_number'
+      @_hash['fallback_error'] = 'fallback_error'
+      @_hash['items'] = 'items'
+      @_hash['order_id'] = 'order_id'
+      @_hash['return_id'] = 'return_id'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['totals'] = 'totals'
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        calculation_mode
+        exemption_class
+        exemption_number
+        fallback_error
+        order_id
+        return_id
+        tax_exempt
+        transaction_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(document_id = nil, items = nil, totals = nil,
+                   calculation_mode = SKIP, exemption_class = SKIP,
+                   exemption_number = SKIP, fallback_error = SKIP,
+                   order_id = SKIP, return_id = SKIP, tax_exempt = false,
+                   transaction_type = SKIP)
+      @calculation_mode = calculation_mode unless calculation_mode == SKIP
+      @document_id = document_id
+      @exemption_class = exemption_class unless exemption_class == SKIP
+      @exemption_number = exemption_number unless exemption_number == SKIP
+      @fallback_error = fallback_error unless fallback_error == SKIP
+      @items = items
+      @order_id = order_id unless order_id == SKIP
+      @return_id = return_id unless return_id == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      @totals = totals
+      @transaction_type = transaction_type unless transaction_type == 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.
+      document_id = hash.key?('document_id') ? hash['document_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (EnrichedTransactionItemDto.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      totals = TaxTotalsDto.from_hash(hash['totals']) if hash['totals']
+      calculation_mode =
+        hash.key?('calculation_mode') ? hash['calculation_mode'] : SKIP
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : SKIP
+      exemption_number =
+        hash.key?('exemption_number') ? hash['exemption_number'] : SKIP
+      fallback_error = FallbackErrorDto.from_hash(hash['fallback_error']) if
+        hash['fallback_error']
+      order_id = hash.key?('order_id') ? hash['order_id'] : SKIP
+      return_id = hash.key?('return_id') ? hash['return_id'] : SKIP
+      tax_exempt = hash['tax_exempt'] ||= false
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+
+      # Create object from extracted values.
+      EnrichedTransactionDto.new(document_id,
+                                 items,
+                                 totals,
+                                 calculation_mode,
+                                 exemption_class,
+                                 exemption_number,
+                                 fallback_error,
+                                 order_id,
+                                 return_id,
+                                 tax_exempt,
+                                 transaction_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} calculation_mode: #{@calculation_mode}, document_id: #{@document_id},"\
+      " exemption_class: #{@exemption_class}, exemption_number: #{@exemption_number},"\
+      " fallback_error: #{@fallback_error}, items: #{@items}, order_id: #{@order_id}, return_id:"\
+      " #{@return_id}, tax_exempt: #{@tax_exempt}, totals: #{@totals}, transaction_type:"\
+      " #{@transaction_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} calculation_mode: #{@calculation_mode.inspect}, document_id:"\
+      " #{@document_id.inspect}, exemption_class: #{@exemption_class.inspect}, exemption_number:"\
+      " #{@exemption_number.inspect}, fallback_error: #{@fallback_error.inspect}, items:"\
+      " #{@items.inspect}, order_id: #{@order_id.inspect}, return_id: #{@return_id.inspect},"\
+      " tax_exempt: #{@tax_exempt.inspect}, totals: #{@totals.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}>"
+    end
+  end
+end