newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/tax_information.rb

@@ -0,0 +1,69 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Metadata about the tax of the order.
+  class TaxInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If the tax was exempted for this order. In case of external orders, the
+    # flag will always return false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_exempt
+
+    # Method of calculation of the taxes, can be vat_included or vat_excluded.
+    # @return [SalesOrderTaxMethodEnum]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_exempt'] = 'is_exempt'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(is_exempt = nil, method = nil)
+      @is_exempt = is_exempt
+      @method = method
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      is_exempt = hash.key?('is_exempt') ? hash['is_exempt'] : nil
+      method = hash.key?('method') ? hash['method'] : nil
+
+      # Create object from extracted values.
+      TaxInformation.new(is_exempt,
+                         method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_exempt: #{@is_exempt}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_exempt: #{@is_exempt.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/tax_line.rb

@@ -0,0 +1,116 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A single tax applied to a line item, itemising part of its `price_tax`.
+  class TaxLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The tax amount, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The country of the tax in ISO 3166 ALPHA-2 format, e.g. GB, DE or US.
+    # @return [String]
+    attr_accessor :country_code
+
+    # A description of the tax type.
+    # @return [String]
+    attr_accessor :name
+
+    # The tax rate, as a ratio between 0 and 1 (not a percentage).
+    # @return [Float]
+    attr_accessor :rate
+
+    # 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['name'] = 'name'
+      @_hash['rate'] = 'rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        country_code
+      ]
+    end
+
+    def initialize(amount = nil, name = nil, rate = nil, country_code = SKIP)
+      @amount = amount
+      @country_code = country_code unless country_code == SKIP
+      @name = name
+      @rate = rate
+    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
+      name = hash.key?('name') ? hash['name'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+
+      # Create object from extracted values.
+      TaxLine.new(amount,
+                  name,
+                  rate,
+                  country_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TaxLine | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.rate,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['rate'],
+                                ->(val) { val.instance_of? Float })
+      )
+    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}, name: #{@name}, rate:"\
+      " #{@rate}>"
+    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}, name:"\
+      " #{@name.inspect}, rate: #{@rate.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/tax_rate_dto.rb

@@ -0,0 +1,121 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TaxRateDto Model.
+  class TaxRateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Monetary tax amount for the unit price corresponding to this tax_rate
+    # item's percent value, e.g. 3.37.
+    # @return [Float]
+    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.
+    # @return [Float]
+    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.
+    # @return [Float]
+    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.
+      TaxRateDto.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/tax_service_error_code_enum.rb

@@ -0,0 +1,117 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The error code from the underlying tax provider.
+  class TaxServiceErrorCodeEnum
+    TAX_SERVICE_ERROR_CODE_ENUM = [
+      # TODO: Write general description for TAXES_UNEXPECTED_ERROR
+      TAXES_UNEXPECTED_ERROR = 'taxes_unexpected_error'.freeze,
+
+      # TODO: Write general description for TAXES_TENANT_MISSING
+      TAXES_TENANT_MISSING = 'taxes_tenant_missing'.freeze,
+
+      # TODO: Write general description for TAXES_CONFIG_ALREADY_EXISTS
+      TAXES_CONFIG_ALREADY_EXISTS = 'taxes_config_already_exists'.freeze,
+
+      # TODO: Write general description for TAXES_CONFIG_NOT_FOUND
+      TAXES_CONFIG_NOT_FOUND = 'taxes_config_not_found'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_CONFIG_MISSING
+      TAXES_PROVIDER_CONFIG_MISSING = 'taxes_provider_config_missing'.freeze,
+
+      # TODO: Write general description for TAXES_TENANT_CONFIG_REQUIRED
+      TAXES_TENANT_CONFIG_REQUIRED = 'taxes_tenant_config_required'.freeze,
+
+      # TODO: Write general description for TAXES_ROUNDING_FAILED
+      TAXES_ROUNDING_FAILED = 'taxes_rounding_failed'.freeze,
+
+      # TODO: Write general description for TAXES_INVALID_MINOR_UNITS
+      TAXES_INVALID_MINOR_UNITS = 'taxes_invalid_minor_units'.freeze,
+
+      # TODO: Write general description for TAXES_UNSUPPORTED_CURRENCY
+      TAXES_UNSUPPORTED_CURRENCY = 'taxes_unsupported_currency'.freeze,
+
+      # TODO: Write general description for TAXES_XML_PARSING_FAILED
+      TAXES_XML_PARSING_FAILED = 'taxes_xml_parsing_failed'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_ERROR_RESPONSE
+      TAXES_PROVIDER_ERROR_RESPONSE = 'taxes_provider_error_response'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_UNEXPECTED_RESPONSE
+      TAXES_PROVIDER_UNEXPECTED_RESPONSE = 'taxes_provider_unexpected_response'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_CLIENT_ERROR_RESPONSE
+      TAXES_PROVIDER_CLIENT_ERROR_RESPONSE = 'taxes_provider_client_error_response'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_INVALID_CREDENTIALS
+      TAXES_PROVIDER_INVALID_CREDENTIALS = 'taxes_provider_invalid_credentials'.freeze,
+
+      # TODO: Write general description for TAXES_ADDRESS_VALIDATION_FAILED
+      TAXES_ADDRESS_VALIDATION_FAILED = 'taxes_address_validation_failed'.freeze,
+
+      # TODO: Write general description for
+      # TAXES_PROVIDER_CONFIG_VALIDATION_FAILED
+      TAXES_PROVIDER_CONFIG_VALIDATION_FAILED = 'taxes_provider_config_validation_failed'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_GENERIC_ERROR
+      TAXES_PROVIDER_GENERIC_ERROR = 'taxes_provider_generic_error'.freeze,
+
+      # TODO: Write general description for TAXES_PROVIDER_INVALID_RESPONSE
+      TAXES_PROVIDER_INVALID_RESPONSE = 'taxes_provider_invalid_response'.freeze,
+
+      # TODO: Write general description for TAXES_TRANSACTION_NOT_FOUND
+      TAXES_TRANSACTION_NOT_FOUND = 'taxes_transaction_not_found'.freeze,
+
+      # TODO: Write general description for TAXES_COMMIT_INTEGRATION_ERROR
+      TAXES_COMMIT_INTEGRATION_ERROR = 'taxes_commit_integration_error'.freeze,
+
+      # TODO: Write general description for REVERSE_CALCULATION_PROVIDER_ERROR
+      REVERSE_CALCULATION_PROVIDER_ERROR = 'reverse_calculation_provider_error'.freeze,
+
+      # TODO: Write general description for TRANSACTION_MODIFICATION_NOT_ALLOWED
+      TRANSACTION_MODIFICATION_NOT_ALLOWED = 'transaction_modification_not_allowed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_SERVICE_ERROR_CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TAXES_UNEXPECTED_ERROR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'taxes_unexpected_error' then TAXES_UNEXPECTED_ERROR
+      when 'taxes_tenant_missing' then TAXES_TENANT_MISSING
+      when 'taxes_config_already_exists' then TAXES_CONFIG_ALREADY_EXISTS
+      when 'taxes_config_not_found' then TAXES_CONFIG_NOT_FOUND
+      when 'taxes_provider_config_missing' then TAXES_PROVIDER_CONFIG_MISSING
+      when 'taxes_tenant_config_required' then TAXES_TENANT_CONFIG_REQUIRED
+      when 'taxes_rounding_failed' then TAXES_ROUNDING_FAILED
+      when 'taxes_invalid_minor_units' then TAXES_INVALID_MINOR_UNITS
+      when 'taxes_unsupported_currency' then TAXES_UNSUPPORTED_CURRENCY
+      when 'taxes_xml_parsing_failed' then TAXES_XML_PARSING_FAILED
+      when 'taxes_provider_error_response' then TAXES_PROVIDER_ERROR_RESPONSE
+      when 'taxes_provider_unexpected_response' then TAXES_PROVIDER_UNEXPECTED_RESPONSE
+      when 'taxes_provider_client_error_response' then TAXES_PROVIDER_CLIENT_ERROR_RESPONSE
+      when 'taxes_provider_invalid_credentials' then TAXES_PROVIDER_INVALID_CREDENTIALS
+      when 'taxes_address_validation_failed' then TAXES_ADDRESS_VALIDATION_FAILED
+      when 'taxes_provider_config_validation_failed' then TAXES_PROVIDER_CONFIG_VALIDATION_FAILED
+      when 'taxes_provider_generic_error' then TAXES_PROVIDER_GENERIC_ERROR
+      when 'taxes_provider_invalid_response' then TAXES_PROVIDER_INVALID_RESPONSE
+      when 'taxes_transaction_not_found' then TAXES_TRANSACTION_NOT_FOUND
+      when 'taxes_commit_integration_error' then TAXES_COMMIT_INTEGRATION_ERROR
+      when 'reverse_calculation_provider_error' then REVERSE_CALCULATION_PROVIDER_ERROR
+      when 'transaction_modification_not_allowed' then TRANSACTION_MODIFICATION_NOT_ALLOWED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/tax_status_enum.rb

@@ -0,0 +1,42 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Type of the tax status applied to the tax line     * `TAXABLE`: Taxes are
+  # applied to the tax line. * `NOT_TAXABLE`: No taxes are applied to the tax
+  # line. * `EXEMPT`: Taxes are exempt for the tax line.
+  class TaxStatusEnum
+    TAX_STATUS_ENUM = [
+      # TODO: Write general description for EXEMPT
+      EXEMPT = 'EXEMPT'.freeze,
+
+      # TODO: Write general description for TAXABLE
+      TAXABLE = 'TAXABLE'.freeze,
+
+      # TODO: Write general description for NOT_TAXABLE
+      NOT_TAXABLE = 'NOT_TAXABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXEMPT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exempt' then EXEMPT
+      when 'taxable' then TAXABLE
+      when 'not_taxable' then NOT_TAXABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/tax_totals_dto.rb

@@ -0,0 +1,149 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TaxTotalsDto Model.
+  class TaxTotalsDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total discount amount.
+    # @return [Float]
+    attr_accessor :discount_total
+
+    # The amount consumer has to pay for the order.
+    # @return [Float]
+    attr_accessor :grand_total
+
+    # The sum of net prices of all the items including shipping and gift
+    # wrapping
+    # @return [Float]
+    attr_accessor :net_total
+
+    # The shipping tax amount.
+    # @return [Float]
+    attr_accessor :shipping_tax_amount
+
+    # The total shipping amount.
+    # @return [Float]
+    attr_accessor :shipping_total
+
+    # The sum of item prices incl. or excl. tax (depending on tax method).
+    # @return [Float]
+    attr_accessor :subtotal
+
+    # Summary of the tax rates applied on the line items of the transaction
+    # grouped by the tax name and tax rate.
+    # @return [Array[TaxRateDto]]
+    attr_accessor :tax_rates_summary
+
+    # Summary of the tax rates applied on the line items of the transaction
+    # grouped by the tax name and tax rate.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_strategy
+
+    # The total tax sum (grand total tax incl. shipping tax).
+    # @return [Float]
+    attr_accessor :tax_total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_total'] = 'discount_total'
+      @_hash['grand_total'] = 'grand_total'
+      @_hash['net_total'] = 'net_total'
+      @_hash['shipping_tax_amount'] = 'shipping_tax_amount'
+      @_hash['shipping_total'] = 'shipping_total'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['tax_rates_summary'] = 'tax_rates_summary'
+      @_hash['tax_strategy'] = 'tax_strategy'
+      @_hash['tax_total'] = 'tax_total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(discount_total = nil, grand_total = nil, net_total = nil,
+                   shipping_tax_amount = nil, shipping_total = nil,
+                   subtotal = nil, tax_rates_summary = nil, tax_strategy = nil,
+                   tax_total = nil)
+      @discount_total = discount_total
+      @grand_total = grand_total
+      @net_total = net_total
+      @shipping_tax_amount = shipping_tax_amount
+      @shipping_total = shipping_total
+      @subtotal = subtotal
+      @tax_rates_summary = tax_rates_summary
+      @tax_strategy = tax_strategy
+      @tax_total = tax_total
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      discount_total =
+        hash.key?('discount_total') ? hash['discount_total'] : nil
+      grand_total = hash.key?('grand_total') ? hash['grand_total'] : nil
+      net_total = hash.key?('net_total') ? hash['net_total'] : nil
+      shipping_tax_amount =
+        hash.key?('shipping_tax_amount') ? hash['shipping_tax_amount'] : nil
+      shipping_total =
+        hash.key?('shipping_total') ? hash['shipping_total'] : nil
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      # Parameter is an array, so we need to iterate through it
+      tax_rates_summary = nil
+      unless hash['tax_rates_summary'].nil?
+        tax_rates_summary = []
+        hash['tax_rates_summary'].each do |structure|
+          tax_rates_summary << (TaxRateDto.from_hash(structure) if structure)
+        end
+      end
+
+      tax_rates_summary = nil unless hash.key?('tax_rates_summary')
+      tax_strategy = hash.key?('tax_strategy') ? hash['tax_strategy'] : nil
+      tax_total = hash.key?('tax_total') ? hash['tax_total'] : nil
+
+      # Create object from extracted values.
+      TaxTotalsDto.new(discount_total,
+                       grand_total,
+                       net_total,
+                       shipping_tax_amount,
+                       shipping_total,
+                       subtotal,
+                       tax_rates_summary,
+                       tax_strategy,
+                       tax_total)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_total: #{@discount_total}, grand_total: #{@grand_total},"\
+      " net_total: #{@net_total}, shipping_tax_amount: #{@shipping_tax_amount}, shipping_total:"\
+      " #{@shipping_total}, subtotal: #{@subtotal}, tax_rates_summary: #{@tax_rates_summary},"\
+      " tax_strategy: #{@tax_strategy}, tax_total: #{@tax_total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_total: #{@discount_total.inspect}, grand_total:"\
+      " #{@grand_total.inspect}, net_total: #{@net_total.inspect}, shipping_tax_amount:"\
+      " #{@shipping_tax_amount.inspect}, shipping_total: #{@shipping_total.inspect}, subtotal:"\
+      " #{@subtotal.inspect}, tax_rates_summary: #{@tax_rates_summary.inspect}, tax_strategy:"\
+      " #{@tax_strategy.inspect}, tax_total: #{@tax_total.inspect}>"
+    end
+  end
+end