newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/fulfillment_config_get_routing_rules_section_sample_response2.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FulfillmentConfigGetRoutingRulesSectionSampleResponse2 Model.
+  class FulfillmentConfigGetRoutingRulesSectionSampleResponse2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location groups identifiers
+    # @return [Hash[String, Object]]
+    attr_accessor :location_groups
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_groups'] = 'location_groups'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location_groups = nil)
+      @location_groups = location_groups
+    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'] : nil
+
+      # Create object from extracted values.
+      FulfillmentConfigGetRoutingRulesSectionSampleResponse2.new(location_groups)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfillmentConfigGetRoutingRulesSectionSampleResponse2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.location_groups,
+                                     ->(val) { val.instance_of? Object })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['location_groups'],
+                            ->(val) { val.instance_of? Object })
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_get_routing_rules_section_sample_response3.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
+  # FulfillmentConfigGetRoutingRulesSectionSampleResponse3 Model.
+  class FulfillmentConfigGetRoutingRulesSectionSampleResponse3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['zip_code_regions'] = 'zip_code_regions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(zip_code_regions = nil)
+      @zip_code_regions = zip_code_regions
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      zip_code_regions =
+        hash.key?('zip_code_regions') ? hash['zip_code_regions'] : nil
+
+      # Create object from extracted values.
+      FulfillmentConfigGetRoutingRulesSectionSampleResponse3.new(zip_code_regions)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfillmentConfigGetRoutingRulesSectionSampleResponse3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.zip_code_regions,
+                                     ->(val) { val.instance_of? Object })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['zip_code_regions'],
+                            ->(val) { val.instance_of? Object })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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} zip_code_regions: #{@zip_code_regions.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_route.rb

@@ -0,0 +1,73 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Single fulfillment config route entry (Routes.json).
+  class FulfillmentConfigRoute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Destination region for a fulfillment config route (Routes.json).
+    # @return [FulfillmentConfigDestinationRegion]
+    attr_accessor :destination_region
+
+    # Service level identifiers mapped to location group IDs that may serve each
+    # level for the route.
+    # @return [Hash[String, Object]]
+    attr_accessor :fulfilled_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_region'] = 'destination_region'
+      @_hash['fulfilled_by'] = 'fulfilled_by'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination_region = nil, fulfilled_by = nil)
+      @destination_region = destination_region
+      @fulfilled_by = fulfilled_by
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['destination_region']
+        destination_region = FulfillmentConfigDestinationRegion.from_hash(hash['destination_region'])
+      end
+      fulfilled_by = hash.key?('fulfilled_by') ? hash['fulfilled_by'] : nil
+
+      # Create object from extracted values.
+      FulfillmentConfigRoute.new(destination_region,
+                                 fulfilled_by)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region}, fulfilled_by:"\
+      " #{@fulfilled_by}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination_region: #{@destination_region.inspect}, fulfilled_by:"\
+      " #{@fulfilled_by.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_config_routing_rules.rb

@@ -0,0 +1,116 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Mirrors fulfillment_config FulfillmentConfigRoutingRules (routing ruleset).
+  class FulfillmentConfigRoutingRules < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location group identifiers mapped to ordered location IDs.
+    # @return [Hash[String, Object]]
+    attr_accessor :location_groups
+
+    # Preferred location IDs within each location group, tried before others in
+    # the group.
+    # @return [Hash[String, Object]]
+    attr_accessor :preferred_locations
+
+    # Routing rules specification.
+    # @return [Array[FulfillmentConfigRoute]]
+    attr_accessor :routes
+
+    # Service levels in priority order (first is preferred).
+    # @return [Array[String]]
+    attr_accessor :sl_levels_priority
+
+    # Zip code region identifiers mapped to zip code patterns.
+    # @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[
+        preferred_locations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        preferred_locations
+      ]
+    end
+
+    def initialize(location_groups = nil, routes = nil,
+                   sl_levels_priority = nil, zip_code_regions = nil,
+                   preferred_locations = SKIP)
+      @location_groups = location_groups
+      @preferred_locations = preferred_locations unless preferred_locations == SKIP
+      @routes = routes
+      @sl_levels_priority = sl_levels_priority
+      @zip_code_regions = zip_code_regions
+    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'] : nil
+      # Parameter is an array, so we need to iterate through it
+      routes = nil
+      unless hash['routes'].nil?
+        routes = []
+        hash['routes'].each do |structure|
+          routes << (FulfillmentConfigRoute.from_hash(structure) if structure)
+        end
+      end
+
+      routes = nil unless hash.key?('routes')
+      sl_levels_priority =
+        hash.key?('sl_levels_priority') ? hash['sl_levels_priority'] : nil
+      zip_code_regions =
+        hash.key?('zip_code_regions') ? hash['zip_code_regions'] : nil
+      preferred_locations =
+        hash.key?('preferred_locations') ? hash['preferred_locations'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentConfigRoutingRules.new(location_groups,
+                                        routes,
+                                        sl_levels_priority,
+                                        zip_code_regions,
+                                        preferred_locations)
+    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

data/lib/new_store_api/models/fulfillment_config_v2_body.rb

@@ -0,0 +1,61 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fulfillment configuration supplied inline for the simulation.
+  class FulfillmentConfigV2Body < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mirrors fulfillment_config FulfillmentConfigRoutingRules (routing
+    # ruleset).
+    # @return [FulfillmentConfigRoutingRules]
+    attr_accessor :routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['routing'] = 'routing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(routing = nil)
+      @routing = routing
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      routing = FulfillmentConfigRoutingRules.from_hash(hash['routing']) if hash['routing']
+
+      # Create object from extracted values.
+      FulfillmentConfigV2Body.new(routing)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routing: #{@routing}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} routing: #{@routing.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fulfillment type
+  class FulfillmentEnum
+    FULFILLMENT_ENUM = [
+      # TODO: Write general description for SHIPPING
+      SHIPPING = 'SHIPPING'.freeze,
+
+      # TODO: Write general description for IN_STORE_HANDOVER
+      IN_STORE_HANDOVER = 'IN_STORE_HANDOVER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHIPPING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping' then SHIPPING
+      when 'in_store_handover' then IN_STORE_HANDOVER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_node_assignment.rb

@@ -0,0 +1,103 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A fulfillment node assigned to fulfill products in an order at a certain
+  # service level. And products which can be routed with this service level
+  class FulfillmentNodeAssignment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # Line items in this fulfillment node assignment
+    # @return [Array[LineItem3]]
+    attr_accessor :line_items
+
+    # Line items in this fulfillment node assignment
+    # @return [String]
+    attr_accessor :service_level_identifier
+
+    # Shows if this FF node assignment available right now (regular), or can be
+    # fulfilled in the future (pre-order)
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # 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['line_items'] = 'line_items'
+      @_hash['service_level_identifier'] = 'service_level_identifier'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_node_id = nil, line_items = nil,
+                   service_level_identifier = nil, type = SKIP)
+      @fulfillment_node_id = fulfillment_node_id
+      @line_items = line_items
+      @service_level_identifier = service_level_identifier
+      @type = type unless type == 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.
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      # 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 << (LineItem3.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      service_level_identifier =
+        hash.key?('service_level_identifier') ? hash['service_level_identifier'] : nil
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentNodeAssignment.new(fulfillment_node_id,
+                                    line_items,
+                                    service_level_identifier,
+                                    type)
+    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}, line_items: #{@line_items},"\
+      " service_level_identifier: #{@service_level_identifier}, type: #{@type}>"
+    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}, line_items:"\
+      " #{@line_items.inspect}, service_level_identifier: #{@service_level_identifier.inspect},"\
+      " type: #{@type.inspect}>"
+    end
+  end
+end

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

data/lib/new_store_api/models/fulfillment_node_customs_info_value.rb

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