walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/ship_order_lines_request.rb

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

data/lib/walmart_ap_is/models/ship_order_lines_response.rb

@@ -0,0 +1,96 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # ShipOrderLinesResponse Model.
+  class ShipOrderLinesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :shipped_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash['shipped_at'] = 'shippedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_order_id
+        shipped_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_order_id: SKIP, shipped_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @purchase_order_id = purchase_order_id unless purchase_order_id == SKIP
+      @shipped_at = shipped_at unless shipped_at == 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.
+      purchase_order_id =
+        hash.key?('purchaseOrderId') ? hash['purchaseOrderId'] : SKIP
+      shipped_at = if hash.key?('shippedAt')
+                     (DateTimeHelper.from_rfc3339(hash['shippedAt']) if hash['shippedAt'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      ShipOrderLinesResponse.new(purchase_order_id: purchase_order_id,
+                                 shipped_at: shipped_at,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_shipped_at
+      DateTimeHelper.to_rfc3339(shipped_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_order_id: #{@purchase_order_id}, shipped_at: #{@shipped_at},"\
+      " 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} purchase_order_id: #{@purchase_order_id.inspect}, shipped_at:"\
+      " #{@shipped_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/ship_package.rb

@@ -0,0 +1,120 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShipPackage Model.
+  class ShipPackage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Caller-supplied stable identifier for this physical package.
+    # Optional — server falls back to the package's tracking
+    # number when echoed in the response.
+    # @return [String]
+    attr_accessor :package_id
+
+    # Caller-supplied stable identifier for this physical package.
+    # Optional — server falls back to the package's tracking
+    # number when echoed in the response.
+    # @return [TrackingInfo]
+    attr_accessor :tracking_info
+
+    # 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.
+    # @return [PackageDimensions1]
+    attr_accessor :dimensions
+
+    # 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.
+    # @return [Array[ShipPackageLine]]
+    attr_accessor :lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['package_id'] = 'packageId'
+      @_hash['tracking_info'] = 'trackingInfo'
+      @_hash['dimensions'] = 'dimensions'
+      @_hash['lines'] = 'lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        package_id
+        dimensions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracking_info:, lines:, package_id: SKIP, dimensions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @package_id = package_id unless package_id == SKIP
+      @tracking_info = tracking_info
+      @dimensions = dimensions unless dimensions == SKIP
+      @lines = lines
+      @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.
+      tracking_info = TrackingInfo.from_hash(hash['trackingInfo']) if hash['trackingInfo']
+      # Parameter is an array, so we need to iterate through it
+      lines = nil
+      unless hash['lines'].nil?
+        lines = []
+        hash['lines'].each do |structure|
+          lines << (ShipPackageLine.from_hash(structure) if structure)
+        end
+      end
+
+      lines = nil unless hash.key?('lines')
+      package_id = hash.key?('packageId') ? hash['packageId'] : SKIP
+      dimensions = PackageDimensions1.from_hash(hash['dimensions']) if hash['dimensions']
+
+      # 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.
+      ShipPackage.new(tracking_info: tracking_info,
+                      lines: lines,
+                      package_id: package_id,
+                      dimensions: dimensions,
+                      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_id: #{@package_id}, tracking_info: #{@tracking_info}, dimensions:"\
+      " #{@dimensions}, lines: #{@lines}, 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_id: #{@package_id.inspect}, tracking_info:"\
+      " #{@tracking_info.inspect}, dimensions: #{@dimensions.inspect}, lines: #{@lines.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/ship_package_line.rb

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

data/lib/walmart_ap_is/models/shipment.rb

@@ -0,0 +1,235 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information pertaining to a shipment in an inbound plan.
+  class Shipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The seller's contact information.
+    # @return [ContactInformation]
+    attr_accessor :contact_information
+
+    # Specifies the date that the seller expects their shipment will be shipped.
+    # @return [Dates]
+    attr_accessor :dates
+
+    # The Walmart Ship Node address and warehouse ID.
+    # @return [ShipmentDestination]
+    attr_accessor :destination
+
+    # Freight information describes the SKUs that are in transit.
+    # @return [FreightInformation]
+    attr_accessor :freight_information
+
+    # The name of the shipment.
+    # @return [String]
+    attr_accessor :name
+
+    # The identifier of a placement option.
+    # @return [String]
+    attr_accessor :placement_option_id
+
+    # Selected delivery window attributes.
+    # @return [SelectedDeliveryWindow]
+    attr_accessor :selected_delivery_window
+
+    # Identifier of a transportation option.
+    # @return [String]
+    attr_accessor :selected_transportation_option_id
+
+    # List of self ship appointment details.
+    # @return [Array[SelfShipAppointmentDetails]]
+    attr_accessor :self_ship_appointment_details
+
+    # The confirmed shipment ID which shows up on labels.
+    # @return [String]
+    attr_accessor :shipment_confirmation_id
+
+    # Identifier of a shipment.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # Specifies the 'ship from' address for the shipment.
+    # @return [ShipmentSource]
+    attr_accessor :source
+
+    # The status of a shipment. Possible values: `ABANDONED`, `CANCELLED`,
+    # `CHECKED_IN`, `CLOSED`, `DELETED`, `DELIVERED`, `IN_TRANSIT`, `MIXED`,
+    # `READY_TO_SHIP`, `RECEIVING`, `SHIPPED`, `UNCONFIRMED`, `WORKING`.
+    # @return [String]
+    attr_accessor :status
+
+    # Tracking information for LTL and SPD shipments.
+    # @return [TrackingDetails]
+    attr_accessor :tracking_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_information'] = 'contactInformation'
+      @_hash['dates'] = 'dates'
+      @_hash['destination'] = 'destination'
+      @_hash['freight_information'] = 'freightInformation'
+      @_hash['name'] = 'name'
+      @_hash['placement_option_id'] = 'placementOptionId'
+      @_hash['selected_delivery_window'] = 'selectedDeliveryWindow'
+      @_hash['selected_transportation_option_id'] =
+        'selectedTransportationOptionId'
+      @_hash['self_ship_appointment_details'] = 'selfShipAppointmentDetails'
+      @_hash['shipment_confirmation_id'] = 'shipmentConfirmationId'
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash['source'] = 'source'
+      @_hash['status'] = 'status'
+      @_hash['tracking_details'] = 'trackingDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_information
+        dates
+        freight_information
+        name
+        selected_delivery_window
+        selected_transportation_option_id
+        self_ship_appointment_details
+        shipment_confirmation_id
+        status
+        tracking_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination:, placement_option_id:, shipment_id:, source:,
+                   contact_information: SKIP, dates: SKIP,
+                   freight_information: SKIP, name: SKIP,
+                   selected_delivery_window: SKIP,
+                   selected_transportation_option_id: SKIP,
+                   self_ship_appointment_details: SKIP,
+                   shipment_confirmation_id: SKIP, status: SKIP,
+                   tracking_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact_information = contact_information unless contact_information == SKIP
+      @dates = dates unless dates == SKIP
+      @destination = destination
+      @freight_information = freight_information unless freight_information == SKIP
+      @name = name unless name == SKIP
+      @placement_option_id = placement_option_id
+      @selected_delivery_window = selected_delivery_window unless selected_delivery_window == SKIP
+      unless selected_transportation_option_id == SKIP
+        @selected_transportation_option_id =
+          selected_transportation_option_id
+      end
+      unless self_ship_appointment_details == SKIP
+        @self_ship_appointment_details =
+          self_ship_appointment_details
+      end
+      @shipment_confirmation_id = shipment_confirmation_id unless shipment_confirmation_id == SKIP
+      @shipment_id = shipment_id
+      @source = source
+      @status = status unless status == SKIP
+      @tracking_details = tracking_details unless tracking_details == 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.
+      destination = ShipmentDestination.from_hash(hash['destination']) if hash['destination']
+      placement_option_id =
+        hash.key?('placementOptionId') ? hash['placementOptionId'] : nil
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      source = ShipmentSource.from_hash(hash['source']) if hash['source']
+      contact_information = ContactInformation.from_hash(hash['contactInformation']) if
+        hash['contactInformation']
+      dates = Dates.from_hash(hash['dates']) if hash['dates']
+      freight_information = FreightInformation.from_hash(hash['freightInformation']) if
+        hash['freightInformation']
+      name = hash.key?('name') ? hash['name'] : SKIP
+      selected_delivery_window = SelectedDeliveryWindow.from_hash(hash['selectedDeliveryWindow']) if
+        hash['selectedDeliveryWindow']
+      selected_transportation_option_id =
+        hash.key?('selectedTransportationOptionId') ? hash['selectedTransportationOptionId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      self_ship_appointment_details = nil
+      unless hash['selfShipAppointmentDetails'].nil?
+        self_ship_appointment_details = []
+        hash['selfShipAppointmentDetails'].each do |structure|
+          self_ship_appointment_details << (SelfShipAppointmentDetails.from_hash(structure) if structure)
+        end
+      end
+
+      self_ship_appointment_details = SKIP unless hash.key?('selfShipAppointmentDetails')
+      shipment_confirmation_id =
+        hash.key?('shipmentConfirmationId') ? hash['shipmentConfirmationId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      tracking_details = TrackingDetails.from_hash(hash['trackingDetails']) if
+        hash['trackingDetails']
+
+      # 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.
+      Shipment.new(destination: destination,
+                   placement_option_id: placement_option_id,
+                   shipment_id: shipment_id,
+                   source: source,
+                   contact_information: contact_information,
+                   dates: dates,
+                   freight_information: freight_information,
+                   name: name,
+                   selected_delivery_window: selected_delivery_window,
+                   selected_transportation_option_id: selected_transportation_option_id,
+                   self_ship_appointment_details: self_ship_appointment_details,
+                   shipment_confirmation_id: shipment_confirmation_id,
+                   status: status,
+                   tracking_details: tracking_details,
+                   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} contact_information: #{@contact_information}, dates: #{@dates},"\
+      " destination: #{@destination}, freight_information: #{@freight_information}, name:"\
+      " #{@name}, placement_option_id: #{@placement_option_id}, selected_delivery_window:"\
+      " #{@selected_delivery_window}, selected_transportation_option_id:"\
+      " #{@selected_transportation_option_id}, self_ship_appointment_details:"\
+      " #{@self_ship_appointment_details}, shipment_confirmation_id: #{@shipment_confirmation_id},"\
+      " shipment_id: #{@shipment_id}, source: #{@source}, status: #{@status}, tracking_details:"\
+      " #{@tracking_details}, 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} contact_information: #{@contact_information.inspect}, dates:"\
+      " #{@dates.inspect}, destination: #{@destination.inspect}, freight_information:"\
+      " #{@freight_information.inspect}, name: #{@name.inspect}, placement_option_id:"\
+      " #{@placement_option_id.inspect}, selected_delivery_window:"\
+      " #{@selected_delivery_window.inspect}, selected_transportation_option_id:"\
+      " #{@selected_transportation_option_id.inspect}, self_ship_appointment_details:"\
+      " #{@self_ship_appointment_details.inspect}, shipment_confirmation_id:"\
+      " #{@shipment_confirmation_id.inspect}, shipment_id: #{@shipment_id.inspect}, source:"\
+      " #{@source.inspect}, status: #{@status.inspect}, tracking_details:"\
+      " #{@tracking_details.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end