newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/stock_product_availability_request.rb

@@ -0,0 +1,81 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Use this API to fetch ATP information, filtered by products. The response
+  # will be paginated, with a max page size of 2000 items
+  class StockProductAvailabilityRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The page number of paginated response. The page number starts at 1
+    # @return [Float]
+    attr_accessor :page_number
+
+    # The max size of the paginated response. This value should not be more than
+    # 2000.
+    # @return [Float]
+    attr_accessor :page_size
+
+    # The max size of the paginated response. This value should not be more than
+    # 2000.
+    # @return [Array[String]]
+    attr_accessor :products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page_number'] = 'page_number'
+      @_hash['page_size'] = 'page_size'
+      @_hash['products'] = 'products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page_number = nil, page_size = nil, products = nil)
+      @page_number = page_number
+      @page_size = page_size
+      @products = products
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page_number = hash.key?('page_number') ? hash['page_number'] : nil
+      page_size = hash.key?('page_size') ? hash['page_size'] : nil
+      products = hash.key?('products') ? hash['products'] : nil
+
+      # Create object from extracted values.
+      StockProductAvailabilityRequest.new(page_number,
+                                          page_size,
+                                          products)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page_number: #{@page_number}, page_size: #{@page_size}, products:"\
+      " #{@products}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page_number: #{@page_number.inspect}, page_size: #{@page_size.inspect},"\
+      " products: #{@products.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/stock_product_availability_response.rb

@@ -0,0 +1,77 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Paginated response of valid request for fetching availabilities by products.
+  class StockProductAvailabilityResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boolean value which indicates if the result has more pages to be fetched
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Boolean value which indicates if the result has more pages to be fetched
+    # @return [Array[Item5]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more'] = 'has_more'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more = nil, items = nil)
+      @has_more = has_more
+      @items = 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.
+      has_more = hash.key?('has_more') ? hash['has_more'] : 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 << (Item5.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      StockProductAvailabilityResponse.new(has_more,
+                                           items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} has_more: #{@has_more}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} has_more: #{@has_more.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/stock_unallocated_items_request.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
+  # Use this API to fetch unallocated items, filtered by ATPKeys.
+  class StockUnallocatedItemsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AtpKey]]
+    attr_accessor :atp_keys
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['atp_keys'] = 'atp_keys'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(atp_keys = nil)
+      @atp_keys = atp_keys
+    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
+      atp_keys = nil
+      unless hash['atp_keys'].nil?
+        atp_keys = []
+        hash['atp_keys'].each do |structure|
+          atp_keys << (AtpKey.from_hash(structure) if structure)
+        end
+      end
+
+      atp_keys = nil unless hash.key?('atp_keys')
+
+      # Create object from extracted values.
+      StockUnallocatedItemsRequest.new(atp_keys)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} atp_keys: #{@atp_keys}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} atp_keys: #{@atp_keys.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/stock_unallocated_items_response.rb

@@ -0,0 +1,70 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Response of valid request for fetching unallocated items count, filtered by
+  # product IDs or ATPKeys.
+  class StockUnallocatedItemsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Item6]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = nil)
+      @items = 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
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item6.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      StockUnallocatedItemsResponse.new(items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/store_config_create_dto.rb

@@ -0,0 +1,173 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # StoreConfigCreateDto Model.
+  class StoreConfigCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara configuration.
+    # * Required if the `tax_calculation_strategy` is set to `avalara`.
+    # * If the tax calculation strategy is set to `avalara`, the given
+    # configuration will be used.
+    # * If the Avalara configuration is defined, the configuration will be
+    # validated through a ping request to Avalara, which will validate the
+    # authenticity of Avalara credentials.
+    # @return [AvalaraConfigCreateDto]
+    attr_accessor :avalara
+
+    # Avalara configuration.
+    # * Required if the `tax_calculation_strategy` is set to `avalara`.
+    # * If the tax calculation strategy is set to `avalara`, the given
+    # configuration will be used.
+    # * If the Avalara configuration is defined, the configuration will be
+    # validated through a ping request to Avalara, which will validate the
+    # authenticity of Avalara credentials.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Custom provider configuration.
+    # * Required if the `tax_calculation_strategy` is set to `custom`.
+    # * If the tax calculation strategy is set to `custom`, the given
+    # configuration will be used.
+    # @return [CustomConfigCreateDto]
+    attr_accessor :custom
+
+    # Fixed rate configuration.
+    # * If the tax calculation strategy is set to `fixedrate`, the specified tax
+    # rate will be used.
+    # * For the other tax calculation strategies, the specified rate will be
+    # used as a fallback if the tax calculation fails (e.g. if the tax provider
+    # is not reachable).
+    # * The specified rate will be used as a fallback by the Associate App in
+    # offline-mode.
+    # @return [FixedRateConfigCreateDto]
+    attr_accessor :fixed_rate
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [Hash[String, FixedRateConfigCreateDto]]
+    attr_accessor :fixed_rate_per_country
+
+    # Store identifier within the NewStore platform.
+    # @return [String]
+    attr_accessor :store_id
+
+    # Store identifier within the NewStore platform.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_calculation_strategy
+
+    # Vertex configuration.
+    # * Required if the `tax_calculation_strategy` is set to `vertex`.
+    # * If the tax calculation strategy is set to `vertex`, the given
+    # configuration will be used.
+    # * If the Vertex configuration is defined, the configuration will be
+    # validated through a ping request to Vertex, which will validate the
+    # authenticity of Vertex credentials.
+    # @return [VertexConfigCreateDto]
+    attr_accessor :vertex
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avalara'] = 'avalara'
+      @_hash['country_code'] = 'country_code'
+      @_hash['custom'] = 'custom'
+      @_hash['fixed_rate'] = 'fixed_rate'
+      @_hash['fixed_rate_per_country'] = 'fixed_rate_per_country'
+      @_hash['store_id'] = 'store_id'
+      @_hash['tax_calculation_strategy'] = 'tax_calculation_strategy'
+      @_hash['vertex'] = 'vertex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avalara
+        custom
+        fixed_rate
+        fixed_rate_per_country
+        tax_calculation_strategy
+        vertex
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code = nil, store_id = nil, avalara = SKIP,
+                   custom = SKIP, fixed_rate = SKIP,
+                   fixed_rate_per_country = SKIP,
+                   tax_calculation_strategy = SKIP, vertex = SKIP)
+      @avalara = avalara unless avalara == SKIP
+      @country_code = country_code
+      @custom = custom unless custom == SKIP
+      @fixed_rate = fixed_rate unless fixed_rate == SKIP
+      @fixed_rate_per_country = fixed_rate_per_country unless fixed_rate_per_country == SKIP
+      @store_id = store_id
+      @tax_calculation_strategy = tax_calculation_strategy unless tax_calculation_strategy == SKIP
+      @vertex = vertex unless vertex == 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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      store_id = hash.key?('store_id') ? hash['store_id'] : nil
+      avalara = AvalaraConfigCreateDto.from_hash(hash['avalara']) if hash['avalara']
+      custom = CustomConfigCreateDto.from_hash(hash['custom']) if hash['custom']
+      fixed_rate = FixedRateConfigCreateDto.from_hash(hash['fixed_rate']) if hash['fixed_rate']
+      fixed_rate_per_country = FixedRateConfigCreateDto.from_hash(hash['fixed_rate_per_country']) if
+        hash['fixed_rate_per_country']
+
+      fixed_rate_per_country = SKIP unless hash.key?('fixed_rate_per_country')
+      tax_calculation_strategy =
+        hash.key?('tax_calculation_strategy') ? hash['tax_calculation_strategy'] : SKIP
+      vertex = VertexConfigCreateDto.from_hash(hash['vertex']) if hash['vertex']
+
+      # Create object from extracted values.
+      StoreConfigCreateDto.new(country_code,
+                               store_id,
+                               avalara,
+                               custom,
+                               fixed_rate,
+                               fixed_rate_per_country,
+                               tax_calculation_strategy,
+                               vertex)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara}, country_code: #{@country_code}, custom: #{@custom},"\
+      " fixed_rate: #{@fixed_rate}, fixed_rate_per_country: #{@fixed_rate_per_country}, store_id:"\
+      " #{@store_id}, tax_calculation_strategy: #{@tax_calculation_strategy}, vertex: #{@vertex}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara.inspect}, country_code: #{@country_code.inspect},"\
+      " custom: #{@custom.inspect}, fixed_rate: #{@fixed_rate.inspect}, fixed_rate_per_country:"\
+      " #{@fixed_rate_per_country.inspect}, store_id: #{@store_id.inspect},"\
+      " tax_calculation_strategy: #{@tax_calculation_strategy.inspect}, vertex:"\
+      " #{@vertex.inspect}>"
+    end
+  end
+end