walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/fulfillment_preview_shipment.rb

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

data/lib/walmart_ap_is/models/fulfillment_shipment.rb

@@ -0,0 +1,164 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # FulfillmentShipment Model.
+  class FulfillmentShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :walmart_shipment_id
+
+    # Walmart Ship Node ID
+    # @return [String]
+    attr_accessor :fulfillment_center_id
+
+    # Walmart Ship Node ID
+    # @return [FulfillmentShipmentStatus]
+    attr_accessor :fulfillment_shipment_status
+
+    # Walmart Ship Node ID
+    # @return [DateTime]
+    attr_accessor :shipping_date
+
+    # Walmart Ship Node ID
+    # @return [DateTime]
+    attr_accessor :estimated_arrival_date
+
+    # Walmart Ship Node ID
+    # @return [String]
+    attr_accessor :tracking_number
+
+    # Walmart Ship Node ID
+    # @return [String]
+    attr_accessor :carrier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['walmart_shipment_id'] = 'walmartShipmentId'
+      @_hash['fulfillment_center_id'] = 'fulfillmentCenterId'
+      @_hash['fulfillment_shipment_status'] = 'fulfillmentShipmentStatus'
+      @_hash['shipping_date'] = 'shippingDate'
+      @_hash['estimated_arrival_date'] = 'estimatedArrivalDate'
+      @_hash['tracking_number'] = 'trackingNumber'
+      @_hash['carrier'] = 'carrier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        walmart_shipment_id
+        fulfillment_center_id
+        fulfillment_shipment_status
+        shipping_date
+        estimated_arrival_date
+        tracking_number
+        carrier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(walmart_shipment_id: SKIP, fulfillment_center_id: SKIP,
+                   fulfillment_shipment_status: SKIP, shipping_date: SKIP,
+                   estimated_arrival_date: SKIP, tracking_number: SKIP,
+                   carrier: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @walmart_shipment_id = walmart_shipment_id unless walmart_shipment_id == SKIP
+      @fulfillment_center_id = fulfillment_center_id unless fulfillment_center_id == SKIP
+      unless fulfillment_shipment_status == SKIP
+        @fulfillment_shipment_status =
+          fulfillment_shipment_status
+      end
+      @shipping_date = shipping_date unless shipping_date == SKIP
+      @estimated_arrival_date = estimated_arrival_date unless estimated_arrival_date == SKIP
+      @tracking_number = tracking_number unless tracking_number == SKIP
+      @carrier = carrier unless carrier == 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.
+      walmart_shipment_id =
+        hash.key?('walmartShipmentId') ? hash['walmartShipmentId'] : SKIP
+      fulfillment_center_id =
+        hash.key?('fulfillmentCenterId') ? hash['fulfillmentCenterId'] : SKIP
+      fulfillment_shipment_status =
+        hash.key?('fulfillmentShipmentStatus') ? hash['fulfillmentShipmentStatus'] : SKIP
+      shipping_date = if hash.key?('shippingDate')
+                        (DateTimeHelper.from_rfc3339(hash['shippingDate']) if hash['shippingDate'])
+                      else
+                        SKIP
+                      end
+      estimated_arrival_date = if hash.key?('estimatedArrivalDate')
+                                 (DateTimeHelper.from_rfc3339(hash['estimatedArrivalDate']) if hash['estimatedArrivalDate'])
+                               else
+                                 SKIP
+                               end
+      tracking_number =
+        hash.key?('trackingNumber') ? hash['trackingNumber'] : SKIP
+      carrier = hash.key?('carrier') ? hash['carrier'] : 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.
+      FulfillmentShipment.new(walmart_shipment_id: walmart_shipment_id,
+                              fulfillment_center_id: fulfillment_center_id,
+                              fulfillment_shipment_status: fulfillment_shipment_status,
+                              shipping_date: shipping_date,
+                              estimated_arrival_date: estimated_arrival_date,
+                              tracking_number: tracking_number,
+                              carrier: carrier,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_shipping_date
+      DateTimeHelper.to_rfc3339(shipping_date)
+    end
+
+    def to_custom_estimated_arrival_date
+      DateTimeHelper.to_rfc3339(estimated_arrival_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} walmart_shipment_id: #{@walmart_shipment_id}, fulfillment_center_id:"\
+      " #{@fulfillment_center_id}, fulfillment_shipment_status: #{@fulfillment_shipment_status},"\
+      " shipping_date: #{@shipping_date}, estimated_arrival_date: #{@estimated_arrival_date},"\
+      " tracking_number: #{@tracking_number}, carrier: #{@carrier}, 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} walmart_shipment_id: #{@walmart_shipment_id.inspect},"\
+      " fulfillment_center_id: #{@fulfillment_center_id.inspect}, fulfillment_shipment_status:"\
+      " #{@fulfillment_shipment_status.inspect}, shipping_date: #{@shipping_date.inspect},"\
+      " estimated_arrival_date: #{@estimated_arrival_date.inspect}, tracking_number:"\
+      " #{@tracking_number.inspect}, carrier: #{@carrier.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_shipment_status.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FulfillmentShipmentStatus.
+  class FulfillmentShipmentStatus
+    FULFILLMENT_SHIPMENT_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for SHIPPED
+      SHIPPED = 'SHIPPED'.freeze,
+
+      # TODO: Write general description for CANCELLED_BY_FULFILLER
+      CANCELLED_BY_FULFILLER = 'CANCELLED_BY_FULFILLER'.freeze,
+
+      # TODO: Write general description for CANCELLED_BY_SELLER
+      CANCELLED_BY_SELLER = 'CANCELLED_BY_SELLER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_SHIPMENT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'shipped' then SHIPPED
+      when 'cancelled_by_fulfiller' then CANCELLED_BY_FULFILLER
+      when 'cancelled_by_seller' then CANCELLED_BY_SELLER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_type.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FulfillmentType.
+  class FulfillmentType
+    FULFILLMENT_TYPE = [
+      # TODO: Write general description for SELLERFULFILLED
+      SELLERFULFILLED = 'SellerFulfilled'.freeze,
+
+      # TODO: Write general description for WFS
+      WFS = 'WFS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SELLERFULFILLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sellerfulfilled' then SELLERFULFILLED
+      when 'wfs' then WFS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_type1.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The fulfillment type for the offer. Possible values: WFS, SELLER.
+  class FulfillmentType1
+    FULFILLMENT_TYPE1 = [
+      # TODO: Write general description for WFS
+      WFS = 'WFS'.freeze,
+
+      # TODO: Write general description for SELLER
+      SELLER = 'SELLER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = WFS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'wfs' then WFS
+      when 'seller' then SELLER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/generate_placement_options_request.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The `generatePlacementOptions` request.
+  class GeneratePlacementOptionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Custom placement options to add to the plan.
+    # @return [Array[CustomPlacementInput]]
+    attr_accessor :custom_placement
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['custom_placement'] = 'customPlacement'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        custom_placement
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(custom_placement: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @custom_placement = custom_placement unless custom_placement == 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
+      custom_placement = nil
+      unless hash['customPlacement'].nil?
+        custom_placement = []
+        hash['customPlacement'].each do |structure|
+          custom_placement << (CustomPlacementInput.from_hash(structure) if structure)
+        end
+      end
+
+      custom_placement = SKIP unless hash.key?('customPlacement')
+
+      # 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.
+      GeneratePlacementOptionsRequest.new(custom_placement: custom_placement,
+                                          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} custom_placement: #{@custom_placement}, 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} custom_placement: #{@custom_placement.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/generate_self_ship_appointment_slots_request.rb

@@ -0,0 +1,103 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # The `generateSelfShipAppointmentSlots` request.
+  class GenerateSelfShipAppointmentSlotsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The desired end date. In ISO 8601 datetime format.
+    # @return [DateTime]
+    attr_accessor :desired_end_date
+
+    # The desired start date. In ISO 8601 datetime format.
+    # @return [DateTime]
+    attr_accessor :desired_start_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['desired_end_date'] = 'desiredEndDate'
+      @_hash['desired_start_date'] = 'desiredStartDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        desired_end_date
+        desired_start_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(desired_end_date: SKIP, desired_start_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @desired_end_date = desired_end_date unless desired_end_date == SKIP
+      @desired_start_date = desired_start_date unless desired_start_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.
+      desired_end_date = if hash.key?('desiredEndDate')
+                           (DateTimeHelper.from_rfc3339(hash['desiredEndDate']) if hash['desiredEndDate'])
+                         else
+                           SKIP
+                         end
+      desired_start_date = if hash.key?('desiredStartDate')
+                             (DateTimeHelper.from_rfc3339(hash['desiredStartDate']) if hash['desiredStartDate'])
+                           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.
+      GenerateSelfShipAppointmentSlotsRequest.new(desired_end_date: desired_end_date,
+                                                  desired_start_date: desired_start_date,
+                                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_desired_end_date
+      DateTimeHelper.to_rfc3339(desired_end_date)
+    end
+
+    def to_custom_desired_start_date
+      DateTimeHelper.to_rfc3339(desired_start_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} desired_end_date: #{@desired_end_date}, desired_start_date:"\
+      " #{@desired_start_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} desired_end_date: #{@desired_end_date.inspect}, desired_start_date:"\
+      " #{@desired_start_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end