newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/quotation_result_dto.rb

@@ -0,0 +1,152 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # QuotationResultDto Model.
+  class QuotationResultDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CalculationModeEnum]
+    attr_accessor :calculation_mode
+
+    # TODO: Write general description for this method
+    # @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 quotation, enriched with the tax
+    # amounts. Monetary fields are in the currency's minor unit.
+    # @return [Array[EnrichedQuotationItemDto]]
+    attr_accessor :items
+
+    # Defines the tax exemption status of the transaction.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # The transaction total amounts, in the currency's minor unit.
+    # @return [QuotationTotalsDto]
+    attr_accessor :totals
+
+    # The transaction total amounts, in the currency's minor unit.
+    # @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['exemption_class'] = 'exemption_class'
+      @_hash['exemption_number'] = 'exemption_number'
+      @_hash['fallback_error'] = 'fallback_error'
+      @_hash['items'] = 'items'
+      @_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
+        tax_exempt
+        transaction_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = nil, totals = nil, calculation_mode = SKIP,
+                   exemption_class = SKIP, exemption_number = SKIP,
+                   fallback_error = SKIP, tax_exempt = false,
+                   transaction_type = SKIP)
+      @calculation_mode = calculation_mode unless calculation_mode == SKIP
+      @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
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (EnrichedQuotationItemDto.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      totals = QuotationTotalsDto.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']
+      tax_exempt = hash['tax_exempt'] ||= false
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+
+      # Create object from extracted values.
+      QuotationResultDto.new(items,
+                             totals,
+                             calculation_mode,
+                             exemption_class,
+                             exemption_number,
+                             fallback_error,
+                             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}, exemption_class:"\
+      " #{@exemption_class}, exemption_number: #{@exemption_number}, fallback_error:"\
+      " #{@fallback_error}, items: #{@items}, 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}, exemption_class:"\
+      " #{@exemption_class.inspect}, exemption_number: #{@exemption_number.inspect},"\
+      " fallback_error: #{@fallback_error.inspect}, items: #{@items.inspect}, tax_exempt:"\
+      " #{@tax_exempt.inspect}, totals: #{@totals.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/quotation_tax_rate_dto.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
+  # QuotationTaxRateDto Model.
+  class QuotationTaxRateDto < 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
+
+    # 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
+
+    # 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['rate'] = 'rate'
+      @_hash['tax_name'] = 'tax_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, country_code = nil, rate = nil, tax_name = nil)
+      @amount = amount
+      @country_code = country_code
+      @rate = rate
+      @tax_name = tax_name
+    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
+
+      # Create object from extracted values.
+      QuotationTaxRateDto.new(amount,
+                              country_code,
+                              rate,
+                              tax_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [QuotationTaxRateDto | 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.country_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.rate,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.tax_name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['country_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['rate'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['tax_name'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}, rate: #{@rate},"\
+      " tax_name: #{@tax_name}>"
+    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}, rate:"\
+      " #{@rate.inspect}, tax_name: #{@tax_name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/quotation_totals_dto.rb

@@ -0,0 +1,154 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # QuotationTotalsDto Model.
+  class QuotationTotalsDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total discount amount, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :discount_total
+
+    # The amount consumer has to pay for the order, in the currency's minor
+    # unit.
+    # @return [Integer]
+    attr_accessor :grand_total
+
+    # The sum of net prices of all the items including shipping and gift
+    # wrapping, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :net_total
+
+    # The shipping tax amount, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :shipping_tax_amount
+
+    # The total shipping amount, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :shipping_total
+
+    # The sum of item prices incl. or excl. tax (depending on tax method), in
+    # the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :subtotal
+
+    # Summary of the tax rates applied on the line items of the transaction
+    # grouped by the tax name and tax rate. Monetary fields are in the
+    # currency's minor unit.
+    # @return [Array[EnrichedQuotationTaxRateDto]]
+    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. Monetary fields are in the
+    # currency's minor unit.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_strategy
+
+    # The total tax sum (grand total tax incl. shipping tax), in the currency's
+    # minor unit.
+    # @return [Integer]
+    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 << (EnrichedQuotationTaxRateDto.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.
+      QuotationTotalsDto.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

data/lib/new_store_api/models/reason_code_init.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ReasonCodeInit Model.
+  class ReasonCodeInit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An identifier of the reason code, pattern is '^[^+=%]+$'
+    # @return [String]
+    attr_accessor :code
+
+    # The name of the reason code.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil, name = nil)
+      @code = code
+      @name = name
+    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'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      ReasonCodeInit.new(code,
+                         name)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/new_store_api/models/reason_code_patch.rb

@@ -0,0 +1,60 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ReasonCodePatch Model.
+  class ReasonCodePatch < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the reason code.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil)
+      @name = name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      ReasonCodePatch.new(name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/reason_enum.rb

@@ -0,0 +1,41 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The rejection reason that was provided when the fulfillment request was
+  # rejected.
+  class ReasonEnum
+    REASON_ENUM = [
+      # TODO: Write general description for RESCINDED
+      RESCINDED = 'rescinded'.freeze,
+
+      # TODO: Write general description for CANNOT_FULFILL
+      CANNOT_FULFILL = 'cannot_fulfill'.freeze,
+
+      # TODO: Write general description for NO_INVENTORY
+      NO_INVENTORY = 'no_inventory'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = RESCINDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'rescinded' then RESCINDED
+      when 'cannot_fulfill' then CANNOT_FULFILL
+      when 'no_inventory' then NO_INVENTORY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/reason_type_enum.rb

@@ -0,0 +1,37 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Whether the override cites a predefined reason code or a free-text custom
+  # reason.
+  class ReasonTypeEnum
+    REASON_TYPE_ENUM = [
+      # TODO: Write general description for REASON_CODE
+      REASON_CODE = 'reason_code'.freeze,
+
+      # TODO: Write general description for CUSTOM_REASON
+      CUSTOM_REASON = 'custom_reason'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = REASON_CODE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'reason_code' then REASON_CODE
+      when 'custom_reason' then CUSTOM_REASON
+      else
+        default_value
+      end
+    end
+  end
+end