walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/batch_request_method.rb

@@ -0,0 +1,49 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The HTTP method associated with the individual APIs being called as part of
+  # the batch request.
+  class BatchRequestMethod
+    BATCH_REQUEST_METHOD = [
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze,
+
+      # TODO: Write general description for PATCH
+      PATCH = 'PATCH'.freeze,
+
+      # TODO: Write general description for DELETE
+      DELETE = 'DELETE'.freeze,
+
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BATCH_REQUEST_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = GET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'get' then GET
+      when 'put' then PUT
+      when 'patch' then PATCH
+      when 'delete' then DELETE
+      when 'post' then POST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/box.rb

@@ -0,0 +1,204 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information about a box used in the inbound plan.
+  class Box < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID provided by Walmart that identifies a given box.
+    # @return [String]
+    attr_accessor :box_id
+
+    # Indication of how box content is meant to be provided.
+    # @return [BoxContentInformationSource]
+    attr_accessor :content_information_source
+
+    # Representation of a location used within the inbounding experience.
+    # @return [Region]
+    attr_accessor :destination_region
+
+    # Measurement of a package's dimensions.
+    # @return [Dimensions]
+    attr_accessor :dimensions
+
+    # The external identifier for this container / box.
+    # @return [String]
+    attr_accessor :external_container_identifier
+
+    # Type of the external identifier used. Can be: `WALMART`, `SSCC`.
+    # @return [String]
+    attr_accessor :external_container_identifier_type
+
+    # Items contained within the box.
+    # @return [Array[Item1]]
+    attr_accessor :items
+
+    # Primary key to uniquely identify a Package (Box or Pallet).
+    # @return [String]
+    attr_accessor :package_id
+
+    # The number of containers where all other properties like weight or
+    # dimensions are identical.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Template name of the box.
+    # @return [String]
+    attr_accessor :template_name
+
+    # The weight of a package.
+    # @return [Weight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['box_id'] = 'boxId'
+      @_hash['content_information_source'] = 'contentInformationSource'
+      @_hash['destination_region'] = 'destinationRegion'
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['external_container_identifier'] = 'externalContainerIdentifier'
+      @_hash['external_container_identifier_type'] =
+        'externalContainerIdentifierType'
+      @_hash['items'] = 'items'
+      @_hash['package_id'] = 'packageId'
+      @_hash['quantity'] = 'quantity'
+      @_hash['template_name'] = 'templateName'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        box_id
+        content_information_source
+        destination_region
+        dimensions
+        external_container_identifier
+        external_container_identifier_type
+        items
+        quantity
+        template_name
+        weight
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(package_id:, box_id: SKIP, content_information_source: SKIP,
+                   destination_region: SKIP, dimensions: SKIP,
+                   external_container_identifier: SKIP,
+                   external_container_identifier_type: SKIP, items: SKIP,
+                   quantity: SKIP, template_name: SKIP, weight: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @box_id = box_id unless box_id == SKIP
+      unless content_information_source == SKIP
+        @content_information_source =
+          content_information_source
+      end
+      @destination_region = destination_region unless destination_region == SKIP
+      @dimensions = dimensions unless dimensions == SKIP
+      unless external_container_identifier == SKIP
+        @external_container_identifier =
+          external_container_identifier
+      end
+      unless external_container_identifier_type == SKIP
+        @external_container_identifier_type =
+          external_container_identifier_type
+      end
+      @items = items unless items == SKIP
+      @package_id = package_id
+      @quantity = quantity unless quantity == SKIP
+      @template_name = template_name unless template_name == SKIP
+      @weight = weight unless weight == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      package_id = hash.key?('packageId') ? hash['packageId'] : nil
+      box_id = hash.key?('boxId') ? hash['boxId'] : SKIP
+      content_information_source =
+        hash.key?('contentInformationSource') ? hash['contentInformationSource'] : SKIP
+      destination_region = Region.from_hash(hash['destinationRegion']) if
+        hash['destinationRegion']
+      dimensions = Dimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      external_container_identifier =
+        hash.key?('externalContainerIdentifier') ? hash['externalContainerIdentifier'] : SKIP
+      external_container_identifier_type =
+        hash.key?('externalContainerIdentifierType') ? hash['externalContainerIdentifierType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item1.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      template_name = hash.key?('templateName') ? hash['templateName'] : SKIP
+      weight = Weight.from_hash(hash['weight']) if hash['weight']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Box.new(package_id: package_id,
+              box_id: box_id,
+              content_information_source: content_information_source,
+              destination_region: destination_region,
+              dimensions: dimensions,
+              external_container_identifier: external_container_identifier,
+              external_container_identifier_type: external_container_identifier_type,
+              items: items,
+              quantity: quantity,
+              template_name: template_name,
+              weight: weight,
+              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} box_id: #{@box_id}, content_information_source:"\
+      " #{@content_information_source}, destination_region: #{@destination_region}, dimensions:"\
+      " #{@dimensions}, external_container_identifier: #{@external_container_identifier},"\
+      " external_container_identifier_type: #{@external_container_identifier_type}, items:"\
+      " #{@items}, package_id: #{@package_id}, quantity: #{@quantity}, template_name:"\
+      " #{@template_name}, weight: #{@weight}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} box_id: #{@box_id.inspect}, content_information_source:"\
+      " #{@content_information_source.inspect}, destination_region:"\
+      " #{@destination_region.inspect}, dimensions: #{@dimensions.inspect},"\
+      " external_container_identifier: #{@external_container_identifier.inspect},"\
+      " external_container_identifier_type: #{@external_container_identifier_type.inspect}, items:"\
+      " #{@items.inspect}, package_id: #{@package_id.inspect}, quantity: #{@quantity.inspect},"\
+      " template_name: #{@template_name.inspect}, weight: #{@weight.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/box_content_information_source.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Indication of how box content is meant to be provided.
+  class BoxContentInformationSource
+    BOX_CONTENT_INFORMATION_SOURCE = [
+      # TODO: Write general description for BOX_CONTENT_PROVIDED
+      BOX_CONTENT_PROVIDED = 'BOX_CONTENT_PROVIDED'.freeze,
+
+      # TODO: Write general description for MANUAL_PROCESS
+      MANUAL_PROCESS = 'MANUAL_PROCESS'.freeze,
+
+      # TODO: Write general description for BARCODE_2D
+      BARCODE_2D = 'BARCODE_2D'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BOX_CONTENT_INFORMATION_SOURCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = BOX_CONTENT_PROVIDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'box_content_provided' then BOX_CONTENT_PROVIDED
+      when 'manual_process' then MANUAL_PROCESS
+      when 'barcode_2d' then BARCODE_2D
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/box_input.rb

@@ -0,0 +1,124 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Input information for a given box.
+  class BoxInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indication of how box content is meant to be provided.
+    # @return [BoxContentInformationSource]
+    attr_accessor :content_information_source
+
+    # Measurement of a package's dimensions.
+    # @return [Dimensions]
+    attr_accessor :dimensions
+
+    # The items and their quantity in the box. This must be empty if the box
+    # `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
+    # @return [Array[ItemInput]]
+    attr_accessor :items
+
+    # The number of containers where all other properties like weight or
+    # dimensions are identical.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The weight of a package.
+    # @return [Weight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content_information_source'] = 'contentInformationSource'
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['items'] = 'items'
+      @_hash['quantity'] = 'quantity'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content_information_source:, dimensions:, quantity:, weight:,
+                   items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content_information_source = content_information_source
+      @dimensions = dimensions
+      @items = items unless items == SKIP
+      @quantity = quantity
+      @weight = weight
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      content_information_source =
+        hash.key?('contentInformationSource') ? hash['contentInformationSource'] : nil
+      dimensions = Dimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      weight = Weight.from_hash(hash['weight']) if hash['weight']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (ItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      BoxInput.new(content_information_source: content_information_source,
+                   dimensions: dimensions,
+                   quantity: quantity,
+                   weight: weight,
+                   items: items,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content_information_source: #{@content_information_source}, dimensions:"\
+      " #{@dimensions}, items: #{@items}, quantity: #{@quantity}, weight: #{@weight},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content_information_source: #{@content_information_source.inspect},"\
+      " dimensions: #{@dimensions.inspect}, items: #{@items.inspect}, quantity:"\
+      " #{@quantity.inspect}, weight: #{@weight.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/box_requirements.rb

@@ -0,0 +1,73 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The requirements for a box in the packing option.
+  class BoxRequirements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The range of weights that are allowed for a package.
+    # @return [WeightRange]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(weight:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @weight = weight
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      weight = WeightRange.from_hash(hash['weight']) if hash['weight']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      BoxRequirements.new(weight: weight,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} weight: #{@weight}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} weight: #{@weight.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/box_update_input.rb

@@ -0,0 +1,135 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Input information for updating a box.
+  class BoxUpdateInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indication of how box content is meant to be provided.
+    # @return [BoxContentInformationSource]
+    attr_accessor :content_information_source
+
+    # Measurement of a package's dimensions.
+    # @return [Dimensions]
+    attr_accessor :dimensions
+
+    # The items and their quantity in the box. This must be empty if the box
+    # `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
+    # @return [Array[ItemInput]]
+    attr_accessor :items
+
+    # Primary key to uniquely identify a Box Package. Provide to update an
+    # existing box; omit to add a new box. Any existing packageIds not provided
+    # will be treated as to-be-removed.
+    # @return [String]
+    attr_accessor :package_id
+
+    # The number of containers where all other properties like weight or
+    # dimensions are identical.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The weight of a package.
+    # @return [Weight]
+    attr_accessor :weight
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content_information_source'] = 'contentInformationSource'
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['items'] = 'items'
+      @_hash['package_id'] = 'packageId'
+      @_hash['quantity'] = 'quantity'
+      @_hash['weight'] = 'weight'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        package_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content_information_source:, dimensions:, quantity:, weight:,
+                   items: SKIP, package_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content_information_source = content_information_source
+      @dimensions = dimensions
+      @items = items unless items == SKIP
+      @package_id = package_id unless package_id == SKIP
+      @quantity = quantity
+      @weight = weight
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      content_information_source =
+        hash.key?('contentInformationSource') ? hash['contentInformationSource'] : nil
+      dimensions = Dimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      weight = Weight.from_hash(hash['weight']) if hash['weight']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (ItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      package_id = hash.key?('packageId') ? hash['packageId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      BoxUpdateInput.new(content_information_source: content_information_source,
+                         dimensions: dimensions,
+                         quantity: quantity,
+                         weight: weight,
+                         items: items,
+                         package_id: package_id,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content_information_source: #{@content_information_source}, dimensions:"\
+      " #{@dimensions}, items: #{@items}, package_id: #{@package_id}, quantity: #{@quantity},"\
+      " weight: #{@weight}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content_information_source: #{@content_information_source.inspect},"\
+      " dimensions: #{@dimensions.inspect}, items: #{@items.inspect}, package_id:"\
+      " #{@package_id.inspect}, quantity: #{@quantity.inspect}, weight: #{@weight.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end