newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/sales_order_price1.rb

@@ -0,0 +1,129 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The response for retrieving price information.
+  class SalesOrderPrice1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Price of the item that contains the catalog price or the overridden price.
+    # @return [Float]
+    attr_accessor :base
+
+    # The applied discount to the item.
+    # @return [Float]
+    attr_accessor :discount
+
+    # The gross price of the item.
+    # @return [Float]
+    attr_accessor :gross
+
+    # The net price of the item.
+    # @return [Float]
+    attr_accessor :net
+
+    # The taxes of the item.
+    # @return [Float]
+    attr_accessor :tax
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['base'] = 'base'
+      @_hash['discount'] = 'discount'
+      @_hash['gross'] = 'gross'
+      @_hash['net'] = 'net'
+      @_hash['tax'] = 'tax'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(base = nil, discount = nil, gross = nil, net = nil,
+                   tax = nil)
+      @base = base
+      @discount = discount
+      @gross = gross
+      @net = net
+      @tax = tax
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      base = hash.key?('base') ? hash['base'] : nil
+      discount = hash.key?('discount') ? hash['discount'] : nil
+      gross = hash.key?('gross') ? hash['gross'] : nil
+      net = hash.key?('net') ? hash['net'] : nil
+      tax = hash.key?('tax') ? hash['tax'] : nil
+
+      # Create object from extracted values.
+      SalesOrderPrice1.new(base,
+                           discount,
+                           gross,
+                           net,
+                           tax)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SalesOrderPrice1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.base,
+                                ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.discount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.gross,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.net,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.tax,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['base'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['discount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['gross'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['net'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['tax'],
+                                ->(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} base: #{@base}, discount: #{@discount}, gross: #{@gross}, net: #{@net},"\
+      " tax: #{@tax}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} base: #{@base.inspect}, discount: #{@discount.inspect}, gross:"\
+      " #{@gross.inspect}, net: #{@net.inspect}, tax: #{@tax.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_prices_request.rb

@@ -0,0 +1,76 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The request for retrieving price information.
+  class SalesOrderPricesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    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.
+      items = hash.key?('items') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SalesOrderPricesRequestItems), hash['items']
+      ) : nil
+
+      # Create object from extracted values.
+      SalesOrderPricesRequest.new(items)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SalesOrderPricesRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:SalesOrderPricesRequestItems)
+                              .validate(value.items)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:SalesOrderPricesRequestItems)
+                     .validate(value['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/sales_order_prices_response.rb

@@ -0,0 +1,92 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The response for retrieving price information.
+  class SalesOrderPricesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency that was used to buy the order, ISO 4217.
+    # @return [String]
+    attr_accessor :currency
+
+    # The currency that was used to buy the order, ISO 4217.
+    # @return [Array[Object]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_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(currency = nil, items = nil)
+      @currency = currency
+      @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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      items = hash.key?('items') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SalesOrderPricesResponseItems), hash['items']
+      ) : nil
+
+      # Create object from extracted values.
+      SalesOrderPricesResponse.new(currency,
+                                   items)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SalesOrderPricesResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:SalesOrderPricesResponseItems)
+                           .validate(value.items)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:SalesOrderPricesResponseItems)
+                         .validate(value['items'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_product_attributes.rb

@@ -0,0 +1,114 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Additional product-related information.
+  class SalesOrderProductAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A free form field for additional product attributes.
+    # @return [String]
+    attr_accessor :additional_variant_1
+
+    # A free form field for additional product attributes.
+    # @return [String]
+    attr_accessor :additional_variant_2
+
+    # The color of the product.
+    # @return [String]
+    attr_accessor :color
+
+    # The URL to a product image.
+    # @return [String]
+    attr_accessor :image_url
+
+    # The name of the product.
+    # @return [String]
+    attr_accessor :name
+
+    # The size of the product.
+    # @return [String]
+    attr_accessor :size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_variant_1'] = 'additional_variant_1'
+      @_hash['additional_variant_2'] = 'additional_variant_2'
+      @_hash['color'] = 'color'
+      @_hash['image_url'] = 'image_url'
+      @_hash['name'] = 'name'
+      @_hash['size'] = 'size'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_variant_1
+        additional_variant_2
+        color
+        image_url
+        size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, additional_variant_1 = SKIP,
+                   additional_variant_2 = SKIP, color = SKIP, image_url = SKIP,
+                   size = SKIP)
+      @additional_variant_1 = additional_variant_1 unless additional_variant_1 == SKIP
+      @additional_variant_2 = additional_variant_2 unless additional_variant_2 == SKIP
+      @color = color unless color == SKIP
+      @image_url = image_url unless image_url == SKIP
+      @name = name
+      @size = size unless size == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      additional_variant_1 =
+        hash.key?('additional_variant_1') ? hash['additional_variant_1'] : SKIP
+      additional_variant_2 =
+        hash.key?('additional_variant_2') ? hash['additional_variant_2'] : SKIP
+      color = hash.key?('color') ? hash['color'] : SKIP
+      image_url = hash.key?('image_url') ? hash['image_url'] : SKIP
+      size = hash.key?('size') ? hash['size'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderProductAttributes.new(name,
+                                      additional_variant_1,
+                                      additional_variant_2,
+                                      color,
+                                      image_url,
+                                      size)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_variant_1: #{@additional_variant_1}, additional_variant_2:"\
+      " #{@additional_variant_2}, color: #{@color}, image_url: #{@image_url}, name: #{@name},"\
+      " size: #{@size}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_variant_1: #{@additional_variant_1.inspect},"\
+      " additional_variant_2: #{@additional_variant_2.inspect}, color: #{@color.inspect},"\
+      " image_url: #{@image_url.inspect}, name: #{@name.inspect}, size: #{@size.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_serial_numbers_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
+  # The response for adding serial number information.
+  class SalesOrderSerialNumbersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SalesOrderSerialNumbersRequestItem]]
+    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 << (SalesOrderSerialNumbersRequestItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      SalesOrderSerialNumbersRequest.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/sales_order_serial_numbers_request_item.rb

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

data/lib/new_store_api/models/sales_order_serial_numbers_request_item_epc.rb

@@ -0,0 +1,78 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The epc which should be assigned to the specified order line item.
+  class SalesOrderSerialNumbersRequestItemEpc < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The epc code.
+    # @return [String]
+    attr_accessor :code
+
+    # The external identifier for the epc.
+    # @return [String]
+    attr_accessor :external_id
+
+    # The serial number associated with the epc.
+    # @return [String]
+    attr_accessor :serial_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['external_id'] = 'external_id'
+      @_hash['serial_number'] = 'serial_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil, external_id = nil, serial_number = nil)
+      @code = code
+      @external_id = external_id
+      @serial_number = serial_number
+    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
+      external_id = hash.key?('external_id') ? hash['external_id'] : nil
+      serial_number = hash.key?('serial_number') ? hash['serial_number'] : nil
+
+      # Create object from extracted values.
+      SalesOrderSerialNumbersRequestItemEpc.new(code,
+                                                external_id,
+                                                serial_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, external_id: #{@external_id}, serial_number:"\
+      " #{@serial_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, external_id: #{@external_id.inspect},"\
+      " serial_number: #{@serial_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_status_enum.rb

@@ -0,0 +1,48 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Current status of the sales order
+  class SalesOrderStatusEnum
+    SALES_ORDER_STATUS_ENUM = [
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'closed'.freeze,
+
+      # TODO: Write general description for CREATED_FOR_BLIND_RETURN
+      CREATED_FOR_BLIND_RETURN = 'created_for_blind_return'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ON_HOLD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'on_hold' then ON_HOLD
+      when 'open' then OPEN
+      when 'closed' then CLOSED
+      when 'created_for_blind_return' then CREATED_FOR_BLIND_RETURN
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end