walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/shipment1.rb

@@ -0,0 +1,237 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Shipment1 Model.
+  class Shipment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :order_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seller_order_id
+
+    # TODO: Write general description for this method
+    # @return [Array[Item3]]
+    attr_accessor :item_list
+
+    # TODO: Write general description for this method
+    # @return [Address2]
+    attr_accessor :ship_from_address
+
+    # TODO: Write general description for this method
+    # @return [Address2]
+    attr_accessor :ship_to_address
+
+    # TODO: Write general description for this method
+    # @return [PackageDimensions]
+    attr_accessor :package_dimensions
+
+    # TODO: Write general description for this method
+    # @return [Weight1]
+    attr_accessor :weight
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :insurance
+
+    # TODO: Write general description for this method
+    # @return [ShippingService]
+    attr_accessor :shipping_service
+
+    # TODO: Write general description for this method
+    # @return [Label]
+    attr_accessor :label
+
+    # TODO: Write general description for this method
+    # @return [ShipmentStatus]
+    attr_accessor :shipment_status
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :last_updated_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash['order_id'] = 'orderId'
+      @_hash['seller_order_id'] = 'sellerOrderId'
+      @_hash['item_list'] = 'itemList'
+      @_hash['ship_from_address'] = 'shipFromAddress'
+      @_hash['ship_to_address'] = 'shipToAddress'
+      @_hash['package_dimensions'] = 'packageDimensions'
+      @_hash['weight'] = 'weight'
+      @_hash['insurance'] = 'insurance'
+      @_hash['shipping_service'] = 'shippingService'
+      @_hash['label'] = 'label'
+      @_hash['shipment_status'] = 'shipmentStatus'
+      @_hash['created_date'] = 'createdDate'
+      @_hash['last_updated_date'] = 'lastUpdatedDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        seller_order_id
+        item_list
+        ship_from_address
+        ship_to_address
+        package_dimensions
+        weight
+        insurance
+        shipping_service
+        label
+        created_date
+        last_updated_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipment_id:, shipment_status:, order_id: SKIP,
+                   seller_order_id: SKIP, item_list: SKIP,
+                   ship_from_address: SKIP, ship_to_address: SKIP,
+                   package_dimensions: SKIP, weight: SKIP, insurance: SKIP,
+                   shipping_service: SKIP, label: SKIP, created_date: SKIP,
+                   last_updated_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @shipment_id = shipment_id
+      @order_id = order_id unless order_id == SKIP
+      @seller_order_id = seller_order_id unless seller_order_id == SKIP
+      @item_list = item_list unless item_list == SKIP
+      @ship_from_address = ship_from_address unless ship_from_address == SKIP
+      @ship_to_address = ship_to_address unless ship_to_address == SKIP
+      @package_dimensions = package_dimensions unless package_dimensions == SKIP
+      @weight = weight unless weight == SKIP
+      @insurance = insurance unless insurance == SKIP
+      @shipping_service = shipping_service unless shipping_service == SKIP
+      @label = label unless label == SKIP
+      @shipment_status = shipment_status
+      @created_date = created_date unless created_date == SKIP
+      @last_updated_date = last_updated_date unless last_updated_date == 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.
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      shipment_status =
+        hash.key?('shipmentStatus') ? hash['shipmentStatus'] : nil
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      seller_order_id =
+        hash.key?('sellerOrderId') ? hash['sellerOrderId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      item_list = nil
+      unless hash['itemList'].nil?
+        item_list = []
+        hash['itemList'].each do |structure|
+          item_list << (Item3.from_hash(structure) if structure)
+        end
+      end
+
+      item_list = SKIP unless hash.key?('itemList')
+      ship_from_address = Address2.from_hash(hash['shipFromAddress']) if hash['shipFromAddress']
+      ship_to_address = Address2.from_hash(hash['shipToAddress']) if hash['shipToAddress']
+      package_dimensions = PackageDimensions.from_hash(hash['packageDimensions']) if
+        hash['packageDimensions']
+      weight = Weight1.from_hash(hash['weight']) if hash['weight']
+      insurance = Money.from_hash(hash['insurance']) if hash['insurance']
+      shipping_service = ShippingService.from_hash(hash['shippingService']) if
+        hash['shippingService']
+      label = Label.from_hash(hash['label']) if hash['label']
+      created_date = if hash.key?('createdDate')
+                       (DateTimeHelper.from_rfc3339(hash['createdDate']) if hash['createdDate'])
+                     else
+                       SKIP
+                     end
+      last_updated_date = if hash.key?('lastUpdatedDate')
+                            (DateTimeHelper.from_rfc3339(hash['lastUpdatedDate']) if hash['lastUpdatedDate'])
+                          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.
+      Shipment1.new(shipment_id: shipment_id,
+                    shipment_status: shipment_status,
+                    order_id: order_id,
+                    seller_order_id: seller_order_id,
+                    item_list: item_list,
+                    ship_from_address: ship_from_address,
+                    ship_to_address: ship_to_address,
+                    package_dimensions: package_dimensions,
+                    weight: weight,
+                    insurance: insurance,
+                    shipping_service: shipping_service,
+                    label: label,
+                    created_date: created_date,
+                    last_updated_date: last_updated_date,
+                    additional_properties: additional_properties)
+    end
+
+    def to_custom_created_date
+      DateTimeHelper.to_rfc3339(created_date)
+    end
+
+    def to_custom_last_updated_date
+      DateTimeHelper.to_rfc3339(last_updated_date)
+    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}, order_id: #{@order_id}, seller_order_id:"\
+      " #{@seller_order_id}, item_list: #{@item_list}, ship_from_address: #{@ship_from_address},"\
+      " ship_to_address: #{@ship_to_address}, package_dimensions: #{@package_dimensions}, weight:"\
+      " #{@weight}, insurance: #{@insurance}, shipping_service: #{@shipping_service}, label:"\
+      " #{@label}, shipment_status: #{@shipment_status}, created_date: #{@created_date},"\
+      " last_updated_date: #{@last_updated_date}, 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}, order_id: #{@order_id.inspect},"\
+      " seller_order_id: #{@seller_order_id.inspect}, item_list: #{@item_list.inspect},"\
+      " ship_from_address: #{@ship_from_address.inspect}, ship_to_address:"\
+      " #{@ship_to_address.inspect}, package_dimensions: #{@package_dimensions.inspect}, weight:"\
+      " #{@weight.inspect}, insurance: #{@insurance.inspect}, shipping_service:"\
+      " #{@shipping_service.inspect}, label: #{@label.inspect}, shipment_status:"\
+      " #{@shipment_status.inspect}, created_date: #{@created_date.inspect}, last_updated_date:"\
+      " #{@last_updated_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_destination.rb

@@ -0,0 +1,98 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The Walmart Ship Node address and warehouse ID.
+  class ShipmentDestination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specific details to identify a place.
+    # @return [Address]
+    attr_accessor :address
+
+    # The type of destination for this shipment. Possible values:
+    # `WALMART_OPTIMIZED`, `WALMART_SHIP_NODE`.
+    # @return [String]
+    attr_accessor :destination_type
+
+    # The Ship Node that the shipment should be sent to. This can be empty if
+    # the destination type is `WALMART_OPTIMIZED`.
+    # @return [String]
+    attr_accessor :warehouse_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['destination_type'] = 'destinationType'
+      @_hash['warehouse_id'] = 'warehouseId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        warehouse_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination_type:, address: SKIP, warehouse_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @address = address unless address == SKIP
+      @destination_type = destination_type
+      @warehouse_id = warehouse_id unless warehouse_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.
+      destination_type =
+        hash.key?('destinationType') ? hash['destinationType'] : nil
+      address = Address.from_hash(hash['address']) if hash['address']
+      warehouse_id = hash.key?('warehouseId') ? hash['warehouseId'] : 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.
+      ShipmentDestination.new(destination_type: destination_type,
+                              address: address,
+                              warehouse_id: warehouse_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} address: #{@address}, destination_type: #{@destination_type}, warehouse_id:"\
+      " #{@warehouse_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} address: #{@address.inspect}, destination_type:"\
+      " #{@destination_type.inspect}, warehouse_id: #{@warehouse_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_request_details.rb

@@ -0,0 +1,171 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # ShipmentRequestDetails Model.
+  class ShipmentRequestDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Walmart Purchase Order ID
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # Walmart Purchase Order ID
+    # @return [String]
+    attr_accessor :seller_order_id
+
+    # Walmart Purchase Order ID
+    # @return [Array[Item3]]
+    attr_accessor :item_list
+
+    # Walmart Purchase Order ID
+    # @return [Address2]
+    attr_accessor :ship_from_address
+
+    # Walmart Purchase Order ID
+    # @return [Address2]
+    attr_accessor :ship_to_address
+
+    # Walmart Purchase Order ID
+    # @return [PackageDimensions]
+    attr_accessor :package_dimensions
+
+    # Walmart Purchase Order ID
+    # @return [Weight1]
+    attr_accessor :weight
+
+    # Walmart Purchase Order ID
+    # @return [DateTime]
+    attr_accessor :ship_date
+
+    # Walmart Purchase Order ID
+    # @return [ShippingServiceOptions]
+    attr_accessor :shipping_service_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash['seller_order_id'] = 'sellerOrderId'
+      @_hash['item_list'] = 'itemList'
+      @_hash['ship_from_address'] = 'shipFromAddress'
+      @_hash['ship_to_address'] = 'shipToAddress'
+      @_hash['package_dimensions'] = 'packageDimensions'
+      @_hash['weight'] = 'weight'
+      @_hash['ship_date'] = 'shipDate'
+      @_hash['shipping_service_options'] = 'shippingServiceOptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        seller_order_id
+        item_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_order_id:, ship_from_address:, ship_to_address:,
+                   package_dimensions:, weight:, ship_date:,
+                   shipping_service_options:, seller_order_id: SKIP,
+                   item_list: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @purchase_order_id = purchase_order_id
+      @seller_order_id = seller_order_id unless seller_order_id == SKIP
+      @item_list = item_list unless item_list == SKIP
+      @ship_from_address = ship_from_address
+      @ship_to_address = ship_to_address
+      @package_dimensions = package_dimensions
+      @weight = weight
+      @ship_date = ship_date
+      @shipping_service_options = shipping_service_options
+      @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'] : nil
+      ship_from_address = Address2.from_hash(hash['shipFromAddress']) if hash['shipFromAddress']
+      ship_to_address = Address2.from_hash(hash['shipToAddress']) if hash['shipToAddress']
+      package_dimensions = PackageDimensions.from_hash(hash['packageDimensions']) if
+        hash['packageDimensions']
+      weight = Weight1.from_hash(hash['weight']) if hash['weight']
+      ship_date = if hash.key?('shipDate')
+                    (DateTimeHelper.from_rfc3339(hash['shipDate']) if hash['shipDate'])
+                  end
+      shipping_service_options = ShippingServiceOptions.from_hash(hash['shippingServiceOptions']) if
+        hash['shippingServiceOptions']
+      seller_order_id =
+        hash.key?('sellerOrderId') ? hash['sellerOrderId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      item_list = nil
+      unless hash['itemList'].nil?
+        item_list = []
+        hash['itemList'].each do |structure|
+          item_list << (Item3.from_hash(structure) if structure)
+        end
+      end
+
+      item_list = SKIP unless hash.key?('itemList')
+
+      # 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.
+      ShipmentRequestDetails.new(purchase_order_id: purchase_order_id,
+                                 ship_from_address: ship_from_address,
+                                 ship_to_address: ship_to_address,
+                                 package_dimensions: package_dimensions,
+                                 weight: weight,
+                                 ship_date: ship_date,
+                                 shipping_service_options: shipping_service_options,
+                                 seller_order_id: seller_order_id,
+                                 item_list: item_list,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_ship_date
+      DateTimeHelper.to_rfc3339(ship_date)
+    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}, seller_order_id:"\
+      " #{@seller_order_id}, item_list: #{@item_list}, ship_from_address: #{@ship_from_address},"\
+      " ship_to_address: #{@ship_to_address}, package_dimensions: #{@package_dimensions}, weight:"\
+      " #{@weight}, ship_date: #{@ship_date}, shipping_service_options:"\
+      " #{@shipping_service_options}, 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}, seller_order_id:"\
+      " #{@seller_order_id.inspect}, item_list: #{@item_list.inspect}, ship_from_address:"\
+      " #{@ship_from_address.inspect}, ship_to_address: #{@ship_to_address.inspect},"\
+      " package_dimensions: #{@package_dimensions.inspect}, weight: #{@weight.inspect}, ship_date:"\
+      " #{@ship_date.inspect}, shipping_service_options: #{@shipping_service_options.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_source.rb

@@ -0,0 +1,84 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Specifies the 'ship from' address for the shipment.
+  class ShipmentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specific details to identify a place.
+    # @return [Address]
+    attr_accessor :address
+
+    # The type of source for this shipment. Possible values: `SELLER_FACILITY`.
+    # @return [String]
+    attr_accessor :source_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['source_type'] = 'sourceType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_type:, address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @address = address unless address == SKIP
+      @source_type = source_type
+      @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.
+      source_type = hash.key?('sourceType') ? hash['sourceType'] : nil
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # 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.
+      ShipmentSource.new(source_type: source_type,
+                         address: address,
+                         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} address: #{@address}, source_type: #{@source_type}, 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} address: #{@address.inspect}, source_type: #{@source_type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_status.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShipmentStatus.
+  class ShipmentStatus
+    SHIPMENT_STATUS = [
+      # TODO: Write general description for PURCHASED
+      PURCHASED = 'PURCHASED'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'REFUNDED'.freeze,
+
+      # TODO: Write general description for SHIPPED
+      SHIPPED = 'SHIPPED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIPMENT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PURCHASED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'purchased' then PURCHASED
+      when 'refunded' then REFUNDED
+      when 'shipped' then SHIPPED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipment_status1.rb

@@ -0,0 +1,46 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Non-terminal shipment-lifecycle state. Mirrors Amazon SP-API Orders v0
+  # `shipmentStatus`. For terminal `Delivered` use the dedicated `/deliver`
+  # endpoint.
+  class ShipmentStatus1
+    SHIPMENT_STATUS1 = [
+      # 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_STATUS1.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