newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/routing_insights_routing_strategy1.rb

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

data/lib/new_store_api/models/routing_insights_service_levels.rb

@@ -0,0 +1,83 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingInsightsServiceLevels Model.
+  class RoutingInsightsServiceLevels < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Service level with which the order was fulfilled
+    # @return [String]
+    attr_accessor :current
+
+    # Service level with which the order was created
+    # @return [String]
+    attr_accessor :original
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current'] = 'current'
+      @_hash['original'] = 'original'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        current
+        original
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        current
+      ]
+    end
+
+    def initialize(current = SKIP, original = SKIP)
+      @current = current unless current == SKIP
+      @original = original unless original == 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.
+      current = hash.key?('current') ? hash['current'] : SKIP
+      original = hash.key?('original') ? hash['original'] : SKIP
+
+      # Create object from extracted values.
+      RoutingInsightsServiceLevels.new(current,
+                                       original)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingInsightsServiceLevels | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} current: #{@current}, original: #{@original}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} current: #{@current.inspect}, original: #{@original.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_insights_strategy_type_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingInsightsStrategyType.
+  class RoutingInsightsStrategyTypeEnum
+    ROUTING_INSIGHTS_STRATEGY_TYPE_ENUM = [
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'external'.freeze,
+
+      # TODO: Write general description for PREROUTED
+      PREROUTED = 'prerouted'.freeze,
+
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'manual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ROUTING_INSIGHTS_STRATEGY_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXTERNAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'external' then EXTERNAL
+      when 'prerouted' then PREROUTED
+      when 'default' then DEFAULT
+      when 'manual' then MANUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/routing_options_request.rb

@@ -0,0 +1,123 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Call to get a list of routing options. Also, colloquially known as 'soft
+  # routing'.
+  class RoutingOptionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Destination country and the zip code where the ordered products are to be
+    # delivered.
+    # @return [DeliveryDestination]
+    attr_accessor :delivery_destination
+
+    # List of line items to be routed.
+    # @return [Array[LineItem21]]
+    attr_accessor :line_items
+
+    # List of line items to be routed.
+    # @return [Object]
+    attr_accessor :routing_strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_destination'] = 'delivery_destination'
+      @_hash['line_items'] = 'line_items'
+      @_hash['routing_strategy'] = 'routing_strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        routing_strategy
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(delivery_destination = nil, line_items = nil,
+                   routing_strategy = SKIP)
+      @delivery_destination = delivery_destination
+      @line_items = line_items
+      @routing_strategy = routing_strategy unless routing_strategy == 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.
+      delivery_destination = DeliveryDestination.from_hash(hash['delivery_destination']) if
+        hash['delivery_destination']
+      # 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 << (LineItem21.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      routing_strategy = hash.key?('routing_strategy') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:RoutingOptionsRequestRoutingStrategy), hash['routing_strategy']
+      ) : SKIP
+
+      # Create object from extracted values.
+      RoutingOptionsRequest.new(delivery_destination,
+                                line_items,
+                                routing_strategy)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RoutingOptionsRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.delivery_destination,
+                                ->(val) { DeliveryDestination.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.line_items,
+                                  ->(val) { LineItem21.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['delivery_destination'],
+                              ->(val) { DeliveryDestination.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['line_items'],
+                                ->(val) { LineItem21.validate(val) },
+                                is_model_hash: true,
+                                is_inner_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} delivery_destination: #{@delivery_destination}, line_items: #{@line_items},"\
+      " routing_strategy: #{@routing_strategy}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} delivery_destination: #{@delivery_destination.inspect}, line_items:"\
+      " #{@line_items.inspect}, routing_strategy: #{@routing_strategy.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_options_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
+  # Represents a list of possible routing options. Also, colloquially known as
+  # the result of 'soft routing'.
+  class RoutingOptionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[FulfillmentNodeAssignment]]
+    attr_accessor :routing_options
+
+    # TODO: Write general description for this method
+    # @return [Status21Enum]
+    attr_accessor :status
+
+    # Contains the list of unavailable products
+    # @return [Array[String]]
+    attr_accessor :unavailable_products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['routing_options'] = 'routing_options'
+      @_hash['status'] = 'status'
+      @_hash['unavailable_products'] = 'unavailable_products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unavailable_products
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(routing_options = nil, status = nil,
+                   unavailable_products = SKIP)
+      @routing_options = routing_options
+      @status = status
+      @unavailable_products = unavailable_products unless unavailable_products == 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
+      routing_options = nil
+      unless hash['routing_options'].nil?
+        routing_options = []
+        hash['routing_options'].each do |structure|
+          routing_options << (FulfillmentNodeAssignment.from_hash(structure) if structure)
+        end
+      end
+
+      routing_options = nil unless hash.key?('routing_options')
+      status = hash.key?('status') ? hash['status'] : nil
+      unavailable_products =
+        hash.key?('unavailable_products') ? hash['unavailable_products'] : SKIP
+
+      # Create object from extracted values.
+      RoutingOptionsResponse.new(routing_options,
+                                 status,
+                                 unavailable_products)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routing_options: #{@routing_options}, status: #{@status},"\
+      " unavailable_products: #{@unavailable_products}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routing_options: #{@routing_options.inspect}, status: #{@status.inspect},"\
+      " unavailable_products: #{@unavailable_products.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_ruleset.rb

@@ -0,0 +1,95 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingRuleset Model.
+  class RoutingRuleset < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location groups identifiers
+    # @return [Hash[String, Object]]
+    attr_accessor :location_groups
+
+    # Routing rules specification
+    # @return [Array[RoutesV1]]
+    attr_accessor :routes
+
+    # Service levels priority. This is ordered according to which service level
+    # will be taken first
+    # @return [Array[String]]
+    attr_accessor :sl_levels_priority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_groups'] = 'location_groups'
+      @_hash['routes'] = 'routes'
+      @_hash['sl_levels_priority'] = 'sl_levels_priority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_groups
+        routes
+        sl_levels_priority
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location_groups = SKIP, routes = SKIP,
+                   sl_levels_priority = SKIP)
+      @location_groups = location_groups unless location_groups == SKIP
+      @routes = routes unless routes == SKIP
+      @sl_levels_priority = sl_levels_priority unless sl_levels_priority == 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.
+      location_groups =
+        hash.key?('location_groups') ? hash['location_groups'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      routes = nil
+      unless hash['routes'].nil?
+        routes = []
+        hash['routes'].each do |structure|
+          routes << (RoutesV1.from_hash(structure) if structure)
+        end
+      end
+
+      routes = SKIP unless hash.key?('routes')
+      sl_levels_priority =
+        hash.key?('sl_levels_priority') ? hash['sl_levels_priority'] : SKIP
+
+      # Create object from extracted values.
+      RoutingRuleset.new(location_groups,
+                         routes,
+                         sl_levels_priority)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_groups: #{@location_groups}, routes: #{@routes},"\
+      " sl_levels_priority: #{@sl_levels_priority}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_groups: #{@location_groups.inspect}, routes: #{@routes.inspect},"\
+      " sl_levels_priority: #{@sl_levels_priority.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/routing_ruleset1.rb

@@ -0,0 +1,122 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RoutingRuleset1 Model.
+  class RoutingRuleset1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location groups identifiers
+    # @return [Hash[String, Object]]
+    attr_accessor :location_groups
+
+    # Specifies which locations within each group the routing engine should try
+    # first before falling back to the remaining locations in that group. The
+    # key is the location group identifier, the value is an ordered list of
+    # location IDs to prefer within this group.
+    # @return [Hash[String, Object]]
+    attr_accessor :preferred_locations
+
+    # Routing rules specification
+    # @return [Array[Routes]]
+    attr_accessor :routes
+
+    # Service levels priority. This is ordered according to which service level
+    # will be taken first
+    # @return [Array[String]]
+    attr_accessor :sl_levels_priority
+
+    # Zip code groups, in order to facilitate the identification routes per
+    # regions
+    # @return [Hash[String, Object]]
+    attr_accessor :zip_code_regions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_groups'] = 'location_groups'
+      @_hash['preferred_locations'] = 'preferred_locations'
+      @_hash['routes'] = 'routes'
+      @_hash['sl_levels_priority'] = 'sl_levels_priority'
+      @_hash['zip_code_regions'] = 'zip_code_regions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_groups
+        preferred_locations
+        routes
+        sl_levels_priority
+        zip_code_regions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location_groups = SKIP, preferred_locations = SKIP,
+                   routes = SKIP, sl_levels_priority = SKIP,
+                   zip_code_regions = SKIP)
+      @location_groups = location_groups unless location_groups == SKIP
+      @preferred_locations = preferred_locations unless preferred_locations == SKIP
+      @routes = routes unless routes == SKIP
+      @sl_levels_priority = sl_levels_priority unless sl_levels_priority == SKIP
+      @zip_code_regions = zip_code_regions unless zip_code_regions == 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.
+      location_groups =
+        hash.key?('location_groups') ? hash['location_groups'] : SKIP
+      preferred_locations =
+        hash.key?('preferred_locations') ? hash['preferred_locations'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      routes = nil
+      unless hash['routes'].nil?
+        routes = []
+        hash['routes'].each do |structure|
+          routes << (Routes.from_hash(structure) if structure)
+        end
+      end
+
+      routes = SKIP unless hash.key?('routes')
+      sl_levels_priority =
+        hash.key?('sl_levels_priority') ? hash['sl_levels_priority'] : SKIP
+      zip_code_regions =
+        hash.key?('zip_code_regions') ? hash['zip_code_regions'] : SKIP
+
+      # Create object from extracted values.
+      RoutingRuleset1.new(location_groups,
+                          preferred_locations,
+                          routes,
+                          sl_levels_priority,
+                          zip_code_regions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_groups: #{@location_groups}, preferred_locations:"\
+      " #{@preferred_locations}, routes: #{@routes}, sl_levels_priority: #{@sl_levels_priority},"\
+      " zip_code_regions: #{@zip_code_regions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_groups: #{@location_groups.inspect}, preferred_locations:"\
+      " #{@preferred_locations.inspect}, routes: #{@routes.inspect}, sl_levels_priority:"\
+      " #{@sl_levels_priority.inspect}, zip_code_regions: #{@zip_code_regions.inspect}>"
+    end
+  end
+end