walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/fulfillment_channel1.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Indicates whether the item is fulfilled by WFS or the seller.
+  class FulfillmentChannel1
+    FULFILLMENT_CHANNEL1 = [
+      # 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_CHANNEL1.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/fulfillment_channel_code.rb

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

data/lib/walmart_ap_is/models/fulfillment_channel_type.rb

@@ -0,0 +1,37 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Indicates whether the item is fulfilled by the seller or by Walmart
+  # Fulfillment Services.
+  class FulfillmentChannelType
+    FULFILLMENT_CHANNEL_TYPE = [
+      # 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_CHANNEL_TYPE.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/fulfillment_option.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FulfillmentOption.
+  class FulfillmentOption
+    FULFILLMENT_OPTION = [
+      # TODO: Write general description for S2H
+      S2H = 'S2H'.freeze,
+
+      # TODO: Write general description for S2S
+      S2S = 'S2S'.freeze,
+
+      # TODO: Write general description for PICKUP_TODAY
+      PICKUP_TODAY = 'PICKUP_TODAY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_OPTION.include?(value)
+    end
+
+    def self.from_value(value, default_value = S2H)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 's2h' then S2H
+      when 's2s' then S2S
+      when 'pickup_today' then PICKUP_TODAY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_order.rb

@@ -0,0 +1,200 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # FulfillmentOrder Model.
+  class FulfillmentOrder < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Seller-defined order ID
+    # @return [String]
+    attr_accessor :seller_fulfillment_order_id
+
+    # Seller-defined order ID
+    # @return [String]
+    attr_accessor :marketplace_id
+
+    # Order ID shown to the recipient
+    # @return [String]
+    attr_accessor :displayable_order_id
+
+    # Order ID shown to the recipient
+    # @return [DateTime]
+    attr_accessor :displayable_order_date
+
+    # Order ID shown to the recipient
+    # @return [String]
+    attr_accessor :displayable_order_comment
+
+    # Order ID shown to the recipient
+    # @return [ShippingSpeedCategory]
+    attr_accessor :shipping_speed_category
+
+    # Order ID shown to the recipient
+    # @return [Address1]
+    attr_accessor :destination_address
+
+    # Order ID shown to the recipient
+    # @return [FulfillmentOrderStatus]
+    attr_accessor :fulfillment_order_status
+
+    # Order ID shown to the recipient
+    # @return [DateTime]
+    attr_accessor :status_updated_at
+
+    # Order ID shown to the recipient
+    # @return [Array[String]]
+    attr_accessor :notification_emails
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['seller_fulfillment_order_id'] = 'sellerFulfillmentOrderId'
+      @_hash['marketplace_id'] = 'marketplaceId'
+      @_hash['displayable_order_id'] = 'displayableOrderId'
+      @_hash['displayable_order_date'] = 'displayableOrderDate'
+      @_hash['displayable_order_comment'] = 'displayableOrderComment'
+      @_hash['shipping_speed_category'] = 'shippingSpeedCategory'
+      @_hash['destination_address'] = 'destinationAddress'
+      @_hash['fulfillment_order_status'] = 'fulfillmentOrderStatus'
+      @_hash['status_updated_at'] = 'statusUpdatedAt'
+      @_hash['notification_emails'] = 'notificationEmails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marketplace_id
+        displayable_order_date
+        displayable_order_comment
+        shipping_speed_category
+        destination_address
+        status_updated_at
+        notification_emails
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(seller_fulfillment_order_id:, displayable_order_id:,
+                   fulfillment_order_status:, marketplace_id: SKIP,
+                   displayable_order_date: SKIP,
+                   displayable_order_comment: SKIP,
+                   shipping_speed_category: SKIP, destination_address: SKIP,
+                   status_updated_at: SKIP, notification_emails: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @seller_fulfillment_order_id = seller_fulfillment_order_id
+      @marketplace_id = marketplace_id unless marketplace_id == SKIP
+      @displayable_order_id = displayable_order_id
+      @displayable_order_date = displayable_order_date unless displayable_order_date == SKIP
+      unless displayable_order_comment == SKIP
+        @displayable_order_comment =
+          displayable_order_comment
+      end
+      @shipping_speed_category = shipping_speed_category unless shipping_speed_category == SKIP
+      @destination_address = destination_address unless destination_address == SKIP
+      @fulfillment_order_status = fulfillment_order_status
+      @status_updated_at = status_updated_at unless status_updated_at == SKIP
+      @notification_emails = notification_emails unless notification_emails == 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.
+      seller_fulfillment_order_id =
+        hash.key?('sellerFulfillmentOrderId') ? hash['sellerFulfillmentOrderId'] : nil
+      displayable_order_id =
+        hash.key?('displayableOrderId') ? hash['displayableOrderId'] : nil
+      fulfillment_order_status =
+        hash.key?('fulfillmentOrderStatus') ? hash['fulfillmentOrderStatus'] : nil
+      marketplace_id = hash.key?('marketplaceId') ? hash['marketplaceId'] : SKIP
+      displayable_order_date = if hash.key?('displayableOrderDate')
+                                 (DateTimeHelper.from_rfc3339(hash['displayableOrderDate']) if hash['displayableOrderDate'])
+                               else
+                                 SKIP
+                               end
+      displayable_order_comment =
+        hash.key?('displayableOrderComment') ? hash['displayableOrderComment'] : SKIP
+      shipping_speed_category =
+        hash.key?('shippingSpeedCategory') ? hash['shippingSpeedCategory'] : SKIP
+      destination_address = Address1.from_hash(hash['destinationAddress']) if
+        hash['destinationAddress']
+      status_updated_at = if hash.key?('statusUpdatedAt')
+                            (DateTimeHelper.from_rfc3339(hash['statusUpdatedAt']) if hash['statusUpdatedAt'])
+                          else
+                            SKIP
+                          end
+      notification_emails =
+        hash.key?('notificationEmails') ? hash['notificationEmails'] : 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.
+      FulfillmentOrder.new(seller_fulfillment_order_id: seller_fulfillment_order_id,
+                           displayable_order_id: displayable_order_id,
+                           fulfillment_order_status: fulfillment_order_status,
+                           marketplace_id: marketplace_id,
+                           displayable_order_date: displayable_order_date,
+                           displayable_order_comment: displayable_order_comment,
+                           shipping_speed_category: shipping_speed_category,
+                           destination_address: destination_address,
+                           status_updated_at: status_updated_at,
+                           notification_emails: notification_emails,
+                           additional_properties: additional_properties)
+    end
+
+    def to_custom_displayable_order_date
+      DateTimeHelper.to_rfc3339(displayable_order_date)
+    end
+
+    def to_custom_status_updated_at
+      DateTimeHelper.to_rfc3339(status_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} seller_fulfillment_order_id: #{@seller_fulfillment_order_id},"\
+      " marketplace_id: #{@marketplace_id}, displayable_order_id: #{@displayable_order_id},"\
+      " displayable_order_date: #{@displayable_order_date}, displayable_order_comment:"\
+      " #{@displayable_order_comment}, shipping_speed_category: #{@shipping_speed_category},"\
+      " destination_address: #{@destination_address}, fulfillment_order_status:"\
+      " #{@fulfillment_order_status}, status_updated_at: #{@status_updated_at},"\
+      " notification_emails: #{@notification_emails}, 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} seller_fulfillment_order_id: #{@seller_fulfillment_order_id.inspect},"\
+      " marketplace_id: #{@marketplace_id.inspect}, displayable_order_id:"\
+      " #{@displayable_order_id.inspect}, displayable_order_date:"\
+      " #{@displayable_order_date.inspect}, displayable_order_comment:"\
+      " #{@displayable_order_comment.inspect}, shipping_speed_category:"\
+      " #{@shipping_speed_category.inspect}, destination_address: #{@destination_address.inspect},"\
+      " fulfillment_order_status: #{@fulfillment_order_status.inspect}, status_updated_at:"\
+      " #{@status_updated_at.inspect}, notification_emails: #{@notification_emails.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_order_item.rb

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

data/lib/walmart_ap_is/models/fulfillment_order_status.rb

@@ -0,0 +1,60 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FulfillmentOrderStatus.
+  class FulfillmentOrderStatus
+    FULFILLMENT_ORDER_STATUS = [
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'RECEIVED'.freeze,
+
+      # TODO: Write general description for INVALID
+      INVALID = 'INVALID'.freeze,
+
+      # TODO: Write general description for PLANNING
+      PLANNING = 'PLANNING'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for COMPLETE
+      COMPLETE = 'COMPLETE'.freeze,
+
+      # TODO: Write general description for COMPLETE_PARTIALLED
+      COMPLETE_PARTIALLED = 'COMPLETE_PARTIALLED'.freeze,
+
+      # TODO: Write general description for UNFULFILLABLE
+      UNFULFILLABLE = 'UNFULFILLABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FULFILLMENT_ORDER_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'received' then RECEIVED
+      when 'invalid' then INVALID
+      when 'planning' then PLANNING
+      when 'processing' then PROCESSING
+      when 'cancelled' then CANCELLED
+      when 'complete' then COMPLETE
+      when 'complete_partialled' then COMPLETE_PARTIALLED
+      when 'unfulfillable' then UNFULFILLABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/fulfillment_preview.rb

@@ -0,0 +1,141 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FulfillmentPreview Model.
+  class FulfillmentPreview < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ShippingSpeedCategory]
+    attr_accessor :shipping_speed_category
+
+    # TODO: Write general description for this method
+    # @return [Array[FulfillmentPreviewShipment]]
+    attr_accessor :fulfillment_preview_shipments
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fulfillable
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_cod_capable
+
+    # TODO: Write general description for this method
+    # @return [Array[Fee]]
+    attr_accessor :estimated_fees
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipping_speed_category'] = 'shippingSpeedCategory'
+      @_hash['fulfillment_preview_shipments'] = 'fulfillmentPreviewShipments'
+      @_hash['is_fulfillable'] = 'isFulfillable'
+      @_hash['is_cod_capable'] = 'isCODCapable'
+      @_hash['estimated_fees'] = 'estimatedFees'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipping_speed_category
+        fulfillment_preview_shipments
+        is_fulfillable
+        is_cod_capable
+        estimated_fees
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipping_speed_category: SKIP,
+                   fulfillment_preview_shipments: SKIP, is_fulfillable: SKIP,
+                   is_cod_capable: SKIP, estimated_fees: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @shipping_speed_category = shipping_speed_category unless shipping_speed_category == SKIP
+      unless fulfillment_preview_shipments == SKIP
+        @fulfillment_preview_shipments =
+          fulfillment_preview_shipments
+      end
+      @is_fulfillable = is_fulfillable unless is_fulfillable == SKIP
+      @is_cod_capable = is_cod_capable unless is_cod_capable == SKIP
+      @estimated_fees = estimated_fees unless estimated_fees == 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_speed_category =
+        hash.key?('shippingSpeedCategory') ? hash['shippingSpeedCategory'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fulfillment_preview_shipments = nil
+      unless hash['fulfillmentPreviewShipments'].nil?
+        fulfillment_preview_shipments = []
+        hash['fulfillmentPreviewShipments'].each do |structure|
+          fulfillment_preview_shipments << (FulfillmentPreviewShipment.from_hash(structure) if structure)
+        end
+      end
+
+      fulfillment_preview_shipments = SKIP unless hash.key?('fulfillmentPreviewShipments')
+      is_fulfillable = hash.key?('isFulfillable') ? hash['isFulfillable'] : SKIP
+      is_cod_capable = hash.key?('isCODCapable') ? hash['isCODCapable'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      estimated_fees = nil
+      unless hash['estimatedFees'].nil?
+        estimated_fees = []
+        hash['estimatedFees'].each do |structure|
+          estimated_fees << (Fee.from_hash(structure) if structure)
+        end
+      end
+
+      estimated_fees = SKIP unless hash.key?('estimatedFees')
+
+      # 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.
+      FulfillmentPreview.new(shipping_speed_category: shipping_speed_category,
+                             fulfillment_preview_shipments: fulfillment_preview_shipments,
+                             is_fulfillable: is_fulfillable,
+                             is_cod_capable: is_cod_capable,
+                             estimated_fees: estimated_fees,
+                             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_speed_category: #{@shipping_speed_category},"\
+      " fulfillment_preview_shipments: #{@fulfillment_preview_shipments}, is_fulfillable:"\
+      " #{@is_fulfillable}, is_cod_capable: #{@is_cod_capable}, estimated_fees:"\
+      " #{@estimated_fees}, 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_speed_category: #{@shipping_speed_category.inspect},"\
+      " fulfillment_preview_shipments: #{@fulfillment_preview_shipments.inspect}, is_fulfillable:"\
+      " #{@is_fulfillable.inspect}, is_cod_capable: #{@is_cod_capable.inspect}, estimated_fees:"\
+      " #{@estimated_fees.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end