walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/shipment_status11.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShipmentStatus11.
+  class ShipmentStatus11
+    SHIPMENT_STATUS11 = [
+      # TODO: Write general description for READY_FOR_PICKUP
+      READY_FOR_PICKUP = 'READY_FOR_PICKUP'.freeze,
+
+      # TODO: Write general description for PICKED_UP
+      PICKED_UP = 'PICKED_UP'.freeze,
+
+      # TODO: Write general description for IN_TRANSIT
+      IN_TRANSIT = 'IN_TRANSIT'.freeze,
+
+      # TODO: Write general description for OUT_FOR_DELIVERY
+      OUT_FOR_DELIVERY = 'OUT_FOR_DELIVERY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIPMENT_STATUS11.include?(value)
+    end
+
+    def self.from_value(value, default_value = READY_FOR_PICKUP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ready_for_pickup' then READY_FOR_PICKUP
+      when 'picked_up' then PICKED_UP
+      when 'in_transit' then IN_TRANSIT
+      when 'out_for_delivery' then OUT_FOR_DELIVERY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_summary.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Summary information about a shipment.
+  class ShipmentSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of a shipment. A shipment contains the boxes and units being
+    # inbounded.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipment_id:, status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @shipment_id = shipment_id
+      @status = status
+      @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.
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      status = hash.key?('status') ? hash['status'] : 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.
+      ShipmentSummary.new(shipment_id: shipment_id,
+                          status: status,
+                          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} shipment_id: #{@shipment_id}, status: #{@status}, 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} shipment_id: #{@shipment_id.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_transportation_configuration.rb

@@ -0,0 +1,128 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Details needed to generate the transportation options.
+  class ShipmentTransportationConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The seller's contact information.
+    # @return [ContactInformation]
+    attr_accessor :contact_information
+
+    # Freight information describes the SKUs that are in transit.
+    # @return [FreightInformation]
+    attr_accessor :freight_information
+
+    # List of pallet configuration inputs.
+    # @return [Array[PalletInput]]
+    attr_accessor :pallets
+
+    # Contains only a starting DateTime.
+    # @return [WindowInput]
+    attr_accessor :ready_to_ship_window
+
+    # Identifier of a shipment.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_information'] = 'contactInformation'
+      @_hash['freight_information'] = 'freightInformation'
+      @_hash['pallets'] = 'pallets'
+      @_hash['ready_to_ship_window'] = 'readyToShipWindow'
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_information
+        freight_information
+        pallets
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ready_to_ship_window:, shipment_id:,
+                   contact_information: SKIP, freight_information: SKIP,
+                   pallets: 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
+      @freight_information = freight_information unless freight_information == SKIP
+      @pallets = pallets unless pallets == SKIP
+      @ready_to_ship_window = ready_to_ship_window
+      @shipment_id = shipment_id
+      @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.
+      ready_to_ship_window = WindowInput.from_hash(hash['readyToShipWindow']) if
+        hash['readyToShipWindow']
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      contact_information = ContactInformation.from_hash(hash['contactInformation']) if
+        hash['contactInformation']
+      freight_information = FreightInformation.from_hash(hash['freightInformation']) if
+        hash['freightInformation']
+      # Parameter is an array, so we need to iterate through it
+      pallets = nil
+      unless hash['pallets'].nil?
+        pallets = []
+        hash['pallets'].each do |structure|
+          pallets << (PalletInput.from_hash(structure) if structure)
+        end
+      end
+
+      pallets = SKIP unless hash.key?('pallets')
+
+      # 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.
+      ShipmentTransportationConfiguration.new(ready_to_ship_window: ready_to_ship_window,
+                                              shipment_id: shipment_id,
+                                              contact_information: contact_information,
+                                              freight_information: freight_information,
+                                              pallets: pallets,
+                                              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}, freight_information:"\
+      " #{@freight_information}, pallets: #{@pallets}, ready_to_ship_window:"\
+      " #{@ready_to_ship_window}, 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} contact_information: #{@contact_information.inspect}, freight_information:"\
+      " #{@freight_information.inspect}, pallets: #{@pallets.inspect}, ready_to_ship_window:"\
+      " #{@ready_to_ship_window.inspect}, shipment_id: #{@shipment_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipping_configuration.rb

@@ -0,0 +1,90 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The shipping configurations supported for the packing option.
+  class ShippingConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mode of shipment transportation. Possible values: `GROUND_SMALL_PARCEL`,
+    # `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`,
+    # `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`.
+    # @return [String]
+    attr_accessor :shipping_mode
+
+    # Shipping program for the option. Possible values:
+    # `WALMART_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`.
+    # @return [String]
+    attr_accessor :shipping_solution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipping_mode'] = 'shippingMode'
+      @_hash['shipping_solution'] = 'shippingSolution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipping_mode
+        shipping_solution
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipping_mode: SKIP, shipping_solution: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @shipping_mode = shipping_mode unless shipping_mode == SKIP
+      @shipping_solution = shipping_solution unless shipping_solution == 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.
+      shipping_mode = hash.key?('shippingMode') ? hash['shippingMode'] : SKIP
+      shipping_solution =
+        hash.key?('shippingSolution') ? hash['shippingSolution'] : 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.
+      ShippingConfiguration.new(shipping_mode: shipping_mode,
+                                shipping_solution: shipping_solution,
+                                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} shipping_mode: #{@shipping_mode}, shipping_solution: #{@shipping_solution},"\
+      " 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} shipping_mode: #{@shipping_mode.inspect}, shipping_solution:"\
+      " #{@shipping_solution.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/{client_credentials_res.rb → shipping_requirements.rb}

@@ -1,82 +1,84 @@
-# walmart_ap_is
-#
-# This file was automatically generated by APIMATIC v3.0 (
-# https://www.apimatic.io ).
-
-module WalmartApIs
-  # ClientCredentialsRes Model.
-  class ClientCredentialsRes < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :summary
-
-    # TODO: Write general description for this method
-    # @return [Value]
-    attr_accessor :value
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['summary'] = 'summary'
-      @_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(summary:, value:, additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @summary = summary
-      @value = value
-      @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.
-      summary = hash.key?('summary') ? hash['summary'] : nil
-      value = Value.from_hash(hash['value']) if hash['value']
-
-      # 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.
-      ClientCredentialsRes.new(summary: summary,
-                               value: value,
-                               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} summary: #{@summary}, value: #{@value}, 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} summary: #{@summary.inspect}, value: #{@value.inspect},"\
-      " additional_properties: #{@additional_properties}>"
-    end
-  end
-end
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The possible shipping modes for the packing option for a given shipping
+  # solution.
+  class ShippingRequirements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Available shipment modes for this shipping program.
+    # @return [Array[String]]
+    attr_accessor :modes
+
+    # Shipping program for the option. Can be: `WALMART_PARTNERED_CARRIER`,
+    # `USE_YOUR_OWN_CARRIER`.
+    # @return [String]
+    attr_accessor :solution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['modes'] = 'modes'
+      @_hash['solution'] = 'solution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(modes:, solution:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @modes = modes
+      @solution = solution
+      @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.
+      modes = hash.key?('modes') ? hash['modes'] : nil
+      solution = hash.key?('solution') ? hash['solution'] : 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.
+      ShippingRequirements.new(modes: modes,
+                               solution: solution,
+                               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} modes: #{@modes}, solution: #{@solution}, 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} modes: #{@modes.inspect}, solution: #{@solution.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end