newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/item12.rb

@@ -0,0 +1,238 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Item12 Model.
+  class Item12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the refund amount for this item was adjusted.
+    # @return [String]
+    attr_accessor :adjustment_reason
+
+    # The corresponding code for the item condition.
+    # @return [Integer]
+    attr_accessor :condition_code
+
+    # External product identifiers for this return item.
+    # @return [ExternalIdentifiers1]
+    attr_accessor :external_identifiers
+
+    # The identifier of this returned item. It is the same identifier as used
+    # for this item in the original order.
+    # @return [String]
+    attr_accessor :id
+
+    # The condition of the item, checked while doing quality inspection.
+    # @return [String]
+    attr_accessor :item_condition
+
+    # Type of the returned item. For example 'product' or 'shipping'.
+    # @return [String]
+    attr_accessor :item_type
+
+    # The identifier of the corresponding product.
+    # @return [String]
+    attr_accessor :product_id
+
+    # The returned quantity (always one item per line).
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Refund amount of this item before adjustment due to return policy.
+    # @return [Float]
+    attr_accessor :refund_amount
+
+    # Refund amount of this item after adjustment due to return policy.
+    # @return [Float]
+    attr_accessor :refund_amount_adjusted
+
+    # Refund amount of this item without taxes.
+    # @return [Float]
+    attr_accessor :refund_excl_tax
+
+    # Refund tax of this item.
+    # @return [Float]
+    attr_accessor :refund_tax
+
+    # The corresponding code for the return reason.
+    # @return [Integer]
+    attr_accessor :return_code
+
+    # The reason why this item was returned.
+    # @return [String]
+    attr_accessor :return_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['adjustment_reason'] = 'adjustment_reason'
+      @_hash['condition_code'] = 'condition_code'
+      @_hash['external_identifiers'] = 'external_identifiers'
+      @_hash['id'] = 'id'
+      @_hash['item_condition'] = 'item_condition'
+      @_hash['item_type'] = 'item_type'
+      @_hash['product_id'] = 'product_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['refund_amount'] = 'refund_amount'
+      @_hash['refund_amount_adjusted'] = 'refund_amount_adjusted'
+      @_hash['refund_excl_tax'] = 'refund_excl_tax'
+      @_hash['refund_tax'] = 'refund_tax'
+      @_hash['return_code'] = 'return_code'
+      @_hash['return_reason'] = 'return_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        adjustment_reason
+        condition_code
+        external_identifiers
+        item_condition
+        item_type
+        return_code
+        return_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, product_id = nil, quantity = nil,
+                   refund_amount = nil, refund_amount_adjusted = nil,
+                   refund_excl_tax = nil, refund_tax = nil,
+                   adjustment_reason = SKIP, condition_code = SKIP,
+                   external_identifiers = SKIP, item_condition = SKIP,
+                   item_type = SKIP, return_code = SKIP, return_reason = SKIP)
+      @adjustment_reason = adjustment_reason unless adjustment_reason == SKIP
+      @condition_code = condition_code unless condition_code == SKIP
+      @external_identifiers = external_identifiers unless external_identifiers == SKIP
+      @id = id
+      @item_condition = item_condition unless item_condition == SKIP
+      @item_type = item_type unless item_type == SKIP
+      @product_id = product_id
+      @quantity = quantity
+      @refund_amount = refund_amount
+      @refund_amount_adjusted = refund_amount_adjusted
+      @refund_excl_tax = refund_excl_tax
+      @refund_tax = refund_tax
+      @return_code = return_code unless return_code == SKIP
+      @return_reason = return_reason unless return_reason == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : nil
+      refund_amount_adjusted =
+        hash.key?('refund_amount_adjusted') ? hash['refund_amount_adjusted'] : nil
+      refund_excl_tax =
+        hash.key?('refund_excl_tax') ? hash['refund_excl_tax'] : nil
+      refund_tax = hash.key?('refund_tax') ? hash['refund_tax'] : nil
+      adjustment_reason =
+        hash.key?('adjustment_reason') ? hash['adjustment_reason'] : SKIP
+      condition_code =
+        hash.key?('condition_code') ? hash['condition_code'] : SKIP
+      external_identifiers = ExternalIdentifiers1.from_hash(hash['external_identifiers']) if
+        hash['external_identifiers']
+      item_condition =
+        hash.key?('item_condition') ? hash['item_condition'] : SKIP
+      item_type = hash.key?('item_type') ? hash['item_type'] : SKIP
+      return_code = hash.key?('return_code') ? hash['return_code'] : SKIP
+      return_reason = hash.key?('return_reason') ? hash['return_reason'] : SKIP
+
+      # Create object from extracted values.
+      Item12.new(id,
+                 product_id,
+                 quantity,
+                 refund_amount,
+                 refund_amount_adjusted,
+                 refund_excl_tax,
+                 refund_tax,
+                 adjustment_reason,
+                 condition_code,
+                 external_identifiers,
+                 item_condition,
+                 item_type,
+                 return_code,
+                 return_reason)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item12 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.product_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.refund_amount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.refund_amount_adjusted,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.refund_excl_tax,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.refund_tax,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['product_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['refund_amount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['refund_amount_adjusted'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['refund_excl_tax'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['refund_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} adjustment_reason: #{@adjustment_reason}, condition_code:"\
+      " #{@condition_code}, external_identifiers: #{@external_identifiers}, id: #{@id},"\
+      " item_condition: #{@item_condition}, item_type: #{@item_type}, product_id: #{@product_id},"\
+      " quantity: #{@quantity}, refund_amount: #{@refund_amount}, refund_amount_adjusted:"\
+      " #{@refund_amount_adjusted}, refund_excl_tax: #{@refund_excl_tax}, refund_tax:"\
+      " #{@refund_tax}, return_code: #{@return_code}, return_reason: #{@return_reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} adjustment_reason: #{@adjustment_reason.inspect}, condition_code:"\
+      " #{@condition_code.inspect}, external_identifiers: #{@external_identifiers.inspect}, id:"\
+      " #{@id.inspect}, item_condition: #{@item_condition.inspect}, item_type:"\
+      " #{@item_type.inspect}, product_id: #{@product_id.inspect}, quantity: #{@quantity.inspect},"\
+      " refund_amount: #{@refund_amount.inspect}, refund_amount_adjusted:"\
+      " #{@refund_amount_adjusted.inspect}, refund_excl_tax: #{@refund_excl_tax.inspect},"\
+      " refund_tax: #{@refund_tax.inspect}, return_code: #{@return_code.inspect}, return_reason:"\
+      " #{@return_reason.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/item21.rb

@@ -0,0 +1,91 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A combination of item id (Sales Order Item UUID) and action to be taken to
+  # this item (reroute/cancel or swap).
+  class Item21 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action to be performed with the item(reroute, cancel).
+    # @return [ActionEnum]
+    attr_accessor :action
+
+    # Identifier (Sales Order Item UUID) of a single item in logistic order.
+    # @return [String]
+    attr_accessor :item_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action = nil, item_id = nil)
+      @action = action
+      @item_id = item_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      action = hash.key?('action') ? hash['action'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+
+      # Create object from extracted values.
+      Item21.new(action,
+                 item_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item21 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.action,
+                                ->(val) { ActionEnum.validate(val) }) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['action'],
+                              ->(val) { ActionEnum.validate(val) }) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(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} action: #{@action}, item_id: #{@item_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action.inspect}, item_id: #{@item_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/item211.rb

@@ -0,0 +1,104 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A combination of item id (Sales Order Item UUID) and action to be taken to
+  # this item (reroute/cancel or swap).
+  class Item211 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action to be performed with the item(swap).
+    # @return [String]
+    attr_reader :action
+
+    # Identifier (Sales Order Item UUID) of a single item in logistic order.
+    # @return [String]
+    attr_accessor :item_id
+
+    # Properties of the new item.
+    # @return [SwapTo]
+    attr_accessor :swap_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['item_id'] = 'item_id'
+      @_hash['swap_to'] = 'swap_to'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id = nil, swap_to = nil)
+      @action = 'swap'
+      @item_id = item_id
+      @swap_to = swap_to
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      swap_to = SwapTo.from_hash(hash['swap_to']) if hash['swap_to']
+
+      # Create object from extracted values.
+      Item211.new(item_id,
+                  swap_to)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item211 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.action,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.swap_to,
+                                  ->(val) { SwapTo.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['action'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['swap_to'],
+                                ->(val) { SwapTo.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action}, item_id: #{@item_id}, swap_to: #{@swap_to}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action.inspect}, item_id: #{@item_id.inspect}, swap_to:"\
+      " #{@swap_to.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/item22.rb

@@ -0,0 +1,105 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A combination of item id (Sales Order Item UUID) and action to be taken to
+  # this item (reroute/cancel or swap).
+  class Item22 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action to be performed with the item(manual_routing).
+    # @return [String]
+    attr_reader :action
+
+    # Identifier (Sales Order Item UUID) of a single item in logistic order.
+    # @return [String]
+    attr_accessor :item_id
+
+    # Contains the fulfillment node identifier where the sales order item should
+    # be routed to (used for manual routing action).
+    # @return [RouteTo]
+    attr_accessor :route_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['item_id'] = 'item_id'
+      @_hash['route_to'] = 'route_to'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id = nil, route_to = nil)
+      @action = 'manual_routing'
+      @item_id = item_id
+      @route_to = route_to
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      route_to = RouteTo.from_hash(hash['route_to']) if hash['route_to']
+
+      # Create object from extracted values.
+      Item22.new(item_id,
+                 route_to)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item22 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.action,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.route_to,
+                                  ->(val) { RouteTo.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['action'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['route_to'],
+                                ->(val) { RouteTo.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action}, item_id: #{@item_id}, route_to: #{@route_to}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action.inspect}, item_id: #{@item_id.inspect}, route_to:"\
+      " #{@route_to.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/item3.rb

@@ -0,0 +1,88 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Item3 Model.
+  class Item3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the item.
+    # @return [String]
+    attr_accessor :id
+
+    # The identifier of the item.
+    # @return [String]
+    attr_reader :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil)
+      @id = id
+      @type = 'product'
+    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
+
+      # Create object from extracted values.
+      Item3.new(id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(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} id: #{@id}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/item31.rb

@@ -0,0 +1,74 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Item31 Model.
+  class Item31 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Type11Enum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil)
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      Item31.new(type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Item31 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { Type11Enum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { Type11Enum.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}>"
+    end
+  end
+end