newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/routing_simulation_line_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
+  # Order line item supplied for a routing simulation run.
+  class RoutingSimulationLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the line item in the simulated order.
+    # @return [String]
+    attr_accessor :line_item_id
+
+    # Unit price used by routing reducers that depend on order amount.
+    # @return [Float]
+    attr_accessor :price
+
+    # Catalog product identifier for the line item.
+    # @return [String]
+    attr_accessor :product_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_item_id'] = 'line_item_id'
+      @_hash['price'] = 'price'
+      @_hash['product_id'] = 'product_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_item_id = nil, product_id = nil, price = 0)
+      @line_item_id = line_item_id
+      @price = price unless price == SKIP
+      @product_id = product_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.
+      line_item_id = hash.key?('line_item_id') ? hash['line_item_id'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      price = hash['price'] ||= 0
+
+      # Create object from extracted values.
+      RoutingSimulationLineItem.new(line_item_id,
+                                    product_id,
+                                    price)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_item_id: #{@line_item_id}, price: #{@price}, product_id:"\
+      " #{@product_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_item_id: #{@line_item_id.inspect}, price: #{@price.inspect},"\
+      " product_id: #{@product_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_simulation_request_payload.rb

@@ -0,0 +1,98 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Request body for a routing simulation run.
+  class RoutingSimulationRequestPayload < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Product availability rows used as ATP input for the simulation.
+    # @return [Array[AvailabilityRow]]
+    attr_accessor :availabilities
+
+    # Fulfillment configuration supplied inline for the simulation.
+    # @return [FulfillmentConfigV2Body]
+    attr_accessor :fulfillment_config
+
+    # Order line items to route in the simulation.
+    # @return [Array[RoutingSimulationLineItem]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['availabilities'] = 'availabilities'
+      @_hash['fulfillment_config'] = 'fulfillment_config'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(availabilities = nil, fulfillment_config = nil,
+                   line_items = nil)
+      @availabilities = availabilities
+      @fulfillment_config = fulfillment_config
+      @line_items = line_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
+      availabilities = nil
+      unless hash['availabilities'].nil?
+        availabilities = []
+        hash['availabilities'].each do |structure|
+          availabilities << (AvailabilityRow.from_hash(structure) if structure)
+        end
+      end
+
+      availabilities = nil unless hash.key?('availabilities')
+      fulfillment_config = FulfillmentConfigV2Body.from_hash(hash['fulfillment_config']) if
+        hash['fulfillment_config']
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (RoutingSimulationLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+
+      # Create object from extracted values.
+      RoutingSimulationRequestPayload.new(availabilities,
+                                          fulfillment_config,
+                                          line_items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} availabilities: #{@availabilities}, fulfillment_config:"\
+      " #{@fulfillment_config}, line_items: #{@line_items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} availabilities: #{@availabilities.inspect}, fulfillment_config:"\
+      " #{@fulfillment_config.inspect}, line_items: #{@line_items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_simulation_response_payload.rb

@@ -0,0 +1,111 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Response body for a routing simulation run.
+  class RoutingSimulationResponsePayload < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional decision trace explaining how routing chose placements.
+    # @return [RoutingDecisionTrace]
+    attr_accessor :decision_trace
+
+    # Flat list of routed line items with their selected locations.
+    # @return [Array[SimulationRoutedItem]]
+    attr_accessor :items
+
+    # Line items that could not be routed.
+    # @return [Array[NotRoutedItemResponse]]
+    attr_accessor :not_routed_items
+
+    # Routing result assignments grouped by location and service level.
+    # @return [Hash[String, Object]]
+    attr_accessor :result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['decision_trace'] = 'decision_trace'
+      @_hash['items'] = 'items'
+      @_hash['not_routed_items'] = 'not_routed_items'
+      @_hash['result'] = 'result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        decision_trace
+        not_routed_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        decision_trace
+      ]
+    end
+
+    def initialize(items = nil, result = nil, decision_trace = SKIP,
+                   not_routed_items = SKIP)
+      @decision_trace = decision_trace unless decision_trace == SKIP
+      @items = items
+      @not_routed_items = not_routed_items unless not_routed_items == SKIP
+      @result = result
+    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 << (SimulationRoutedItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      result = hash.key?('result') ? hash['result'] : nil
+      decision_trace = RoutingDecisionTrace.from_hash(hash['decision_trace']) if
+        hash['decision_trace']
+      # Parameter is an array, so we need to iterate through it
+      not_routed_items = nil
+      unless hash['not_routed_items'].nil?
+        not_routed_items = []
+        hash['not_routed_items'].each do |structure|
+          not_routed_items << (NotRoutedItemResponse.from_hash(structure) if structure)
+        end
+      end
+
+      not_routed_items = SKIP unless hash.key?('not_routed_items')
+
+      # Create object from extracted values.
+      RoutingSimulationResponsePayload.new(items,
+                                           result,
+                                           decision_trace,
+                                           not_routed_items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} decision_trace: #{@decision_trace}, items: #{@items}, not_routed_items:"\
+      " #{@not_routed_items}, result: #{@result}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} decision_trace: #{@decision_trace.inspect}, items: #{@items.inspect},"\
+      " not_routed_items: #{@not_routed_items.inspect}, result: #{@result.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_status_enum.rb

@@ -0,0 +1,72 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingStatus.
+  class RoutingStatusEnum
+    ROUTING_STATUS_ENUM = [
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'processed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for CONFLICT
+      CONFLICT = 'conflict'.freeze,
+
+      # TODO: Write general description for DISPATCHED
+      DISPATCHED = 'dispatched'.freeze,
+
+      # TODO: Write general description for READY_FOR_ROUTING
+      READY_FOR_ROUTING = 'ready_for_routing'.freeze,
+
+      # TODO: Write general description for READY_FOR_REROUTING
+      READY_FOR_REROUTING = 'ready_for_rerouting'.freeze,
+
+      # TODO: Write general description for REROUTING_INITIATED
+      REROUTING_INITIATED = 'rerouting_initiated'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'voided'.freeze,
+
+      # TODO: Write general description for RECALCULATING_SHIPMENTS
+      RECALCULATING_SHIPMENTS = 'recalculating_shipments'.freeze,
+
+      # TODO: Write general description for SWAPPED
+      SWAPPED = 'swapped'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ROUTING_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'processed' then PROCESSED
+      when 'cancelled' then CANCELLED
+      when 'conflict' then CONFLICT
+      when 'dispatched' then DISPATCHED
+      when 'ready_for_routing' then READY_FOR_ROUTING
+      when 'ready_for_rerouting' then READY_FOR_REROUTING
+      when 'rerouting_initiated' then REROUTING_INITIATED
+      when 'voided' then VOIDED
+      when 'recalculating_shipments' then RECALCULATING_SHIPMENTS
+      when 'swapped' then SWAPPED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/routing_strategy.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
+  # The default routing strategy
+  class RoutingStrategy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['strategy'] = 'strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(strategy = 'default')
+      @strategy = strategy
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      strategy = hash['strategy'] ||= 'default'
+
+      # Create object from extracted values.
+      RoutingStrategy.new(strategy)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingStrategy | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.strategy,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['strategy'],
+                            ->(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} strategy: #{@strategy}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} strategy: #{@strategy.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_strategy1.rb

@@ -0,0 +1,109 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Prerouted strategy. Each line item will be assigned to each fulfillment
+  # node.
+  class RoutingStrategy1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :fulfillment_node_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :service_level_identifier
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_node_ids'] = 'fulfillment_node_ids'
+      @_hash['service_level_identifier'] = 'service_level_identifier'
+      @_hash['strategy'] = 'strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_node_ids = nil, service_level_identifier = nil,
+                   strategy = 'prerouted')
+      @fulfillment_node_ids = fulfillment_node_ids
+      @service_level_identifier = service_level_identifier
+      @strategy = strategy
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fulfillment_node_ids =
+        hash.key?('fulfillment_node_ids') ? hash['fulfillment_node_ids'] : nil
+      service_level_identifier =
+        hash.key?('service_level_identifier') ? hash['service_level_identifier'] : nil
+      strategy = hash['strategy'] ||= 'prerouted'
+
+      # Create object from extracted values.
+      RoutingStrategy1.new(fulfillment_node_ids,
+                           service_level_identifier,
+                           strategy)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingStrategy1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.fulfillment_node_ids,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.service_level_identifier,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.strategy,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['fulfillment_node_ids'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['service_level_identifier'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['strategy'],
+                                ->(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} fulfillment_node_ids: #{@fulfillment_node_ids}, service_level_identifier:"\
+      " #{@service_level_identifier}, strategy: #{@strategy}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_node_ids: #{@fulfillment_node_ids.inspect},"\
+      " service_level_identifier: #{@service_level_identifier.inspect}, strategy:"\
+      " #{@strategy.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/rules.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
+  # Rules Model.
+  class Rules < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A regex pattern to match one or multiple app versions.
+    # @return [String]
+    attr_accessor :app_version
+
+    # A regex pattern to match one or multiple associateIds.
+    # @return [String]
+    attr_accessor :associate_id
+
+    # A regex pattern to match one or multiple storeIds.
+    # @return [String]
+    attr_accessor :store_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app_version'] = 'appVersion'
+      @_hash['associate_id'] = 'associateId'
+      @_hash['store_id'] = 'storeId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_id
+        store_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(app_version = nil, associate_id = SKIP, store_id = SKIP)
+      @app_version = app_version
+      @associate_id = associate_id unless associate_id == SKIP
+      @store_id = store_id unless store_id == 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.
+      app_version = hash.key?('appVersion') ? hash['appVersion'] : nil
+      associate_id = hash.key?('associateId') ? hash['associateId'] : SKIP
+      store_id = hash.key?('storeId') ? hash['storeId'] : SKIP
+
+      # Create object from extracted values.
+      Rules.new(app_version,
+                associate_id,
+                store_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_version: #{@app_version}, associate_id: #{@associate_id}, store_id:"\
+      " #{@store_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} app_version: #{@app_version.inspect}, associate_id:"\
+      " #{@associate_id.inspect}, store_id: #{@store_id.inspect}>"
+    end
+  end
+end