walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/package.rb

@@ -0,0 +1,146 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Package Model.
+  class Package < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PackageDimensions]
+    attr_accessor :dimensions
+
+    # TODO: Write general description for this method
+    # @return [Weight1]
+    attr_accessor :weight
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :insured_value
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_hazmat
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :seller_declared_value
+
+    # Seller-supplied unique id for this package within the shipment.
+    # @return [String]
+    attr_accessor :package_client_reference_id
+
+    # Seller-supplied unique id for this package within the shipment.
+    # @return [Array[Item4]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['weight'] = 'weight'
+      @_hash['insured_value'] = 'insuredValue'
+      @_hash['is_hazmat'] = 'isHazmat'
+      @_hash['seller_declared_value'] = 'sellerDeclaredValue'
+      @_hash['package_client_reference_id'] = 'packageClientReferenceId'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        insured_value
+        is_hazmat
+        seller_declared_value
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(dimensions:, weight:, package_client_reference_id:,
+                   insured_value: SKIP, is_hazmat: SKIP,
+                   seller_declared_value: SKIP, items: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @dimensions = dimensions
+      @weight = weight
+      @insured_value = insured_value unless insured_value == SKIP
+      @is_hazmat = is_hazmat unless is_hazmat == SKIP
+      @seller_declared_value = seller_declared_value unless seller_declared_value == SKIP
+      @package_client_reference_id = package_client_reference_id
+      @items = items unless items == 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.
+      dimensions = PackageDimensions.from_hash(hash['dimensions']) if hash['dimensions']
+      weight = Weight1.from_hash(hash['weight']) if hash['weight']
+      package_client_reference_id =
+        hash.key?('packageClientReferenceId') ? hash['packageClientReferenceId'] : nil
+      insured_value = Money.from_hash(hash['insuredValue']) if hash['insuredValue']
+      is_hazmat = hash.key?('isHazmat') ? hash['isHazmat'] : SKIP
+      seller_declared_value = Money.from_hash(hash['sellerDeclaredValue']) if
+        hash['sellerDeclaredValue']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item4.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.
+      Package.new(dimensions: dimensions,
+                  weight: weight,
+                  package_client_reference_id: package_client_reference_id,
+                  insured_value: insured_value,
+                  is_hazmat: is_hazmat,
+                  seller_declared_value: seller_declared_value,
+                  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} dimensions: #{@dimensions}, weight: #{@weight}, insured_value:"\
+      " #{@insured_value}, is_hazmat: #{@is_hazmat}, seller_declared_value:"\
+      " #{@seller_declared_value}, package_client_reference_id: #{@package_client_reference_id},"\
+      " items: #{@items}, 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} dimensions: #{@dimensions.inspect}, weight: #{@weight.inspect},"\
+      " insured_value: #{@insured_value.inspect}, is_hazmat: #{@is_hazmat.inspect},"\
+      " seller_declared_value: #{@seller_declared_value.inspect}, package_client_reference_id:"\
+      " #{@package_client_reference_id.inspect}, items: #{@items.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/package_dimensions.rb

@@ -0,0 +1,99 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # PackageDimensions Model.
+  class PackageDimensions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :length
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :height
+
+    # TODO: Write general description for this method
+    # @return [Unit1]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['length'] = 'length'
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(length:, width:, height:, unit:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @length = length
+      @width = width
+      @height = height
+      @unit = unit
+      @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.
+      length = hash.key?('length') ? hash['length'] : nil
+      width = hash.key?('width') ? hash['width'] : nil
+      height = hash.key?('height') ? hash['height'] : nil
+      unit = hash.key?('unit') ? hash['unit'] : nil
+
+      # 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.
+      PackageDimensions.new(length: length,
+                            width: width,
+                            height: height,
+                            unit: unit,
+                            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} length: #{@length}, width: #{@width}, height: #{@height}, unit: #{@unit},"\
+      " 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} length: #{@length.inspect}, width: #{@width.inspect}, height:"\
+      " #{@height.inspect}, unit: #{@unit.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/package_dimensions1.rb

@@ -0,0 +1,128 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Physical dimensions of a shipped package. All numeric values are
+  # non-negative; unit enums avoid the unit-ambiguity bug that bit
+  # gmp-orders-mono PayloadUtil pre-2024.
+  class PackageDimensions1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :length
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :height
+
+    # TODO: Write general description for this method
+    # @return [UnitOfMeasurement]
+    attr_accessor :dimension_unit
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :weight
+
+    # TODO: Write general description for this method
+    # @return [WeightUnit]
+    attr_accessor :weight_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['length'] = 'length'
+      @_hash['width'] = 'width'
+      @_hash['height'] = 'height'
+      @_hash['dimension_unit'] = 'dimensionUnit'
+      @_hash['weight'] = 'weight'
+      @_hash['weight_unit'] = 'weightUnit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        length
+        width
+        height
+        dimension_unit
+        weight
+        weight_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(length: SKIP, width: SKIP, height: SKIP,
+                   dimension_unit: UnitOfMeasurement::IN, weight: SKIP,
+                   weight_unit: WeightUnit::LB, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @length = length unless length == SKIP
+      @width = width unless width == SKIP
+      @height = height unless height == SKIP
+      @dimension_unit = dimension_unit unless dimension_unit == SKIP
+      @weight = weight unless weight == SKIP
+      @weight_unit = weight_unit unless weight_unit == 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.
+      length = hash.key?('length') ? hash['length'] : SKIP
+      width = hash.key?('width') ? hash['width'] : SKIP
+      height = hash.key?('height') ? hash['height'] : SKIP
+      dimension_unit = hash['dimensionUnit'] ||= UnitOfMeasurement::IN
+      weight = hash.key?('weight') ? hash['weight'] : SKIP
+      weight_unit = hash['weightUnit'] ||= WeightUnit::LB
+
+      # 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.
+      PackageDimensions1.new(length: length,
+                             width: width,
+                             height: height,
+                             dimension_unit: dimension_unit,
+                             weight: weight,
+                             weight_unit: weight_unit,
+                             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} length: #{@length}, width: #{@width}, height: #{@height}, dimension_unit:"\
+      " #{@dimension_unit}, weight: #{@weight}, weight_unit: #{@weight_unit},"\
+      " 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} length: #{@length.inspect}, width: #{@width.inspect}, height:"\
+      " #{@height.inspect}, dimension_unit: #{@dimension_unit.inspect}, weight:"\
+      " #{@weight.inspect}, weight_unit: #{@weight_unit.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/package_document.rb

@@ -0,0 +1,90 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # PackageDocument Model.
+  class PackageDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Type1]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Format1]
+    attr_accessor :format
+
+    # Base64-encoded document bytes.
+    # @return [String]
+    attr_accessor :contents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['format'] = 'format'
+      @_hash['contents'] = 'contents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, format:, contents:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @format = format
+      @contents = contents
+      @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.
+      type = hash.key?('type') ? hash['type'] : nil
+      format = hash.key?('format') ? hash['format'] : nil
+      contents = hash.key?('contents') ? hash['contents'] : nil
+
+      # 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.
+      PackageDocument.new(type: type,
+                          format: format,
+                          contents: contents,
+                          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} type: #{@type}, format: #{@format}, contents: #{@contents},"\
+      " 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} type: #{@type.inspect}, format: #{@format.inspect}, contents:"\
+      " #{@contents.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/package_document_detail.rb

@@ -0,0 +1,105 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # PackageDocumentDetail Model.
+  class PackageDocumentDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :package_client_reference_id
+
+    # TODO: Write general description for this method
+    # @return [Array[PackageDocument]]
+    attr_accessor :package_documents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tracking_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['package_client_reference_id'] = 'packageClientReferenceId'
+      @_hash['package_documents'] = 'packageDocuments'
+      @_hash['tracking_id'] = 'trackingId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(package_client_reference_id:, package_documents:,
+                   tracking_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @package_client_reference_id = package_client_reference_id
+      @package_documents = package_documents
+      @tracking_id = tracking_id unless tracking_id == 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_client_reference_id =
+        hash.key?('packageClientReferenceId') ? hash['packageClientReferenceId'] : nil
+      # Parameter is an array, so we need to iterate through it
+      package_documents = nil
+      unless hash['packageDocuments'].nil?
+        package_documents = []
+        hash['packageDocuments'].each do |structure|
+          package_documents << (PackageDocument.from_hash(structure) if structure)
+        end
+      end
+
+      package_documents = nil unless hash.key?('packageDocuments')
+      tracking_id = hash.key?('trackingId') ? hash['trackingId'] : 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.
+      PackageDocumentDetail.new(package_client_reference_id: package_client_reference_id,
+                                package_documents: package_documents,
+                                tracking_id: tracking_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} package_client_reference_id: #{@package_client_reference_id},"\
+      " package_documents: #{@package_documents}, tracking_id: #{@tracking_id},"\
+      " 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} package_client_reference_id: #{@package_client_reference_id.inspect},"\
+      " package_documents: #{@package_documents.inspect}, tracking_id: #{@tracking_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/package_grouping_input.rb

@@ -0,0 +1,106 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Packing information for the inbound plan.
+  class PackageGroupingInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Box level information being provided.
+    # @return [Array[BoxInput]]
+    attr_accessor :boxes
+
+    # The ID of the `packingGroup` that packages are grouped according to.
+    # Provide before placement confirmation.
+    # @return [String]
+    attr_accessor :packing_group_id
+
+    # The ID of the shipment that packages are grouped according to. Provide
+    # after placement confirmation.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['boxes'] = 'boxes'
+      @_hash['packing_group_id'] = 'packingGroupId'
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        packing_group_id
+        shipment_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(boxes:, packing_group_id: SKIP, shipment_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @boxes = boxes
+      @packing_group_id = packing_group_id unless packing_group_id == SKIP
+      @shipment_id = shipment_id unless shipment_id == 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.
+      # Parameter is an array, so we need to iterate through it
+      boxes = nil
+      unless hash['boxes'].nil?
+        boxes = []
+        hash['boxes'].each do |structure|
+          boxes << (BoxInput.from_hash(structure) if structure)
+        end
+      end
+
+      boxes = nil unless hash.key?('boxes')
+      packing_group_id =
+        hash.key?('packingGroupId') ? hash['packingGroupId'] : SKIP
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : 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.
+      PackageGroupingInput.new(boxes: boxes,
+                               packing_group_id: packing_group_id,
+                               shipment_id: shipment_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} boxes: #{@boxes}, packing_group_id: #{@packing_group_id}, shipment_id:"\
+      " #{@shipment_id}, 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} boxes: #{@boxes.inspect}, packing_group_id: #{@packing_group_id.inspect},"\
+      " shipment_id: #{@shipment_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end