walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/operation_problem.rb

@@ -0,0 +1,102 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # A problem with additional properties persisted to an operation.
+  class OperationProblem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An error code that identifies the type of error that occurred.
+    # @return [String]
+    attr_accessor :code
+
+    # Additional details that can help the caller understand or fix the issue.
+    # @return [String]
+    attr_accessor :details
+
+    # A message that describes the error condition.
+    # @return [String]
+    attr_accessor :message
+
+    # The severity of the problem. Possible values: `WARNING`, `ERROR`.
+    # @return [String]
+    attr_accessor :severity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['details'] = 'details'
+      @_hash['message'] = 'message'
+      @_hash['severity'] = 'severity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, message:, severity:, details: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      @details = details unless details == SKIP
+      @message = message
+      @severity = severity
+      @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.
+      code = hash.key?('code') ? hash['code'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+      severity = hash.key?('severity') ? hash['severity'] : nil
+      details = hash.key?('details') ? hash['details'] : 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.
+      OperationProblem.new(code: code,
+                           message: message,
+                           severity: severity,
+                           details: 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} code: #{@code}, details: #{@details}, message: #{@message}, severity:"\
+      " #{@severity}, 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} code: #{@code.inspect}, details: #{@details.inspect}, message:"\
+      " #{@message.inspect}, severity: #{@severity.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/operation_status.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The status of an operation.
+  class OperationStatus
+    OPERATION_STATUS = [
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'SUCCESS'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'success' then SUCCESS
+      when 'failed' then FAILED
+      when 'in_progress' then IN_PROGRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/optional_fulfillment_program.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Optional fulfillment program override for WFS items.
+  class OptionalFulfillmentProgram
+    OPTIONAL_FULFILLMENT_PROGRAM = [
+      # TODO: Write general description for WFS_STANDARD
+      WFS_STANDARD = 'WFS_STANDARD'.freeze,
+
+      # TODO: Write general description for WFS_EXPEDITED
+      WFS_EXPEDITED = 'WFS_EXPEDITED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPTIONAL_FULFILLMENT_PROGRAM.include?(value)
+    end
+
+    def self.from_value(value, default_value = WFS_STANDARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'wfs_standard' then WFS_STANDARD
+      when 'wfs_expedited' then WFS_EXPEDITED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/order.rb

@@ -0,0 +1,192 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Order Model.
+  class Order < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Walmart-assigned Purchase Order ID
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # Customer-facing order reference
+    # @return [String]
+    attr_accessor :customer_order_id
+
+    # Customer-facing order reference
+    # @return [String]
+    attr_accessor :seller_id
+
+    # Customer-facing order reference
+    # @return [OrderStatus]
+    attr_accessor :order_status
+
+    # Customer-facing order reference
+    # @return [FulfillmentType]
+    attr_accessor :fulfillment_type
+
+    # Customer-facing order reference
+    # @return [DateTime]
+    attr_accessor :purchase_date
+
+    # Customer-facing order reference
+    # @return [DateTime]
+    attr_accessor :last_updated_date
+
+    # Customer-facing order reference
+    # @return [Money]
+    attr_accessor :order_total
+
+    # Customer-facing order reference
+    # @return [Address3]
+    attr_accessor :shipping_address
+
+    # Customer-facing order reference
+    # @return [Array[OrderLine]]
+    attr_accessor :order_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash['customer_order_id'] = 'customerOrderId'
+      @_hash['seller_id'] = 'sellerId'
+      @_hash['order_status'] = 'orderStatus'
+      @_hash['fulfillment_type'] = 'fulfillmentType'
+      @_hash['purchase_date'] = 'purchaseDate'
+      @_hash['last_updated_date'] = 'lastUpdatedDate'
+      @_hash['order_total'] = 'orderTotal'
+      @_hash['shipping_address'] = 'shippingAddress'
+      @_hash['order_lines'] = 'orderLines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_order_id
+        fulfillment_type
+        last_updated_date
+        order_total
+        shipping_address
+        order_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_order_id:, seller_id:, order_status:,
+                   purchase_date:, customer_order_id: SKIP,
+                   fulfillment_type: SKIP, last_updated_date: SKIP,
+                   order_total: SKIP, shipping_address: SKIP, order_lines: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @purchase_order_id = purchase_order_id
+      @customer_order_id = customer_order_id unless customer_order_id == SKIP
+      @seller_id = seller_id
+      @order_status = order_status
+      @fulfillment_type = fulfillment_type unless fulfillment_type == SKIP
+      @purchase_date = purchase_date
+      @last_updated_date = last_updated_date unless last_updated_date == SKIP
+      @order_total = order_total unless order_total == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @order_lines = order_lines unless order_lines == 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'] : nil
+      seller_id = hash.key?('sellerId') ? hash['sellerId'] : nil
+      order_status = hash.key?('orderStatus') ? hash['orderStatus'] : nil
+      purchase_date = if hash.key?('purchaseDate')
+                        (DateTimeHelper.from_rfc3339(hash['purchaseDate']) if hash['purchaseDate'])
+                      end
+      customer_order_id =
+        hash.key?('customerOrderId') ? hash['customerOrderId'] : SKIP
+      fulfillment_type =
+        hash.key?('fulfillmentType') ? hash['fulfillmentType'] : SKIP
+      last_updated_date = if hash.key?('lastUpdatedDate')
+                            (DateTimeHelper.from_rfc3339(hash['lastUpdatedDate']) if hash['lastUpdatedDate'])
+                          else
+                            SKIP
+                          end
+      order_total = Money.from_hash(hash['orderTotal']) if hash['orderTotal']
+      shipping_address = Address3.from_hash(hash['shippingAddress']) if hash['shippingAddress']
+      # 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 << (OrderLine.from_hash(structure) if structure)
+        end
+      end
+
+      order_lines = SKIP 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.
+      Order.new(purchase_order_id: purchase_order_id,
+                seller_id: seller_id,
+                order_status: order_status,
+                purchase_date: purchase_date,
+                customer_order_id: customer_order_id,
+                fulfillment_type: fulfillment_type,
+                last_updated_date: last_updated_date,
+                order_total: order_total,
+                shipping_address: shipping_address,
+                order_lines: order_lines,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_purchase_date
+      DateTimeHelper.to_rfc3339(purchase_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} purchase_order_id: #{@purchase_order_id}, customer_order_id:"\
+      " #{@customer_order_id}, seller_id: #{@seller_id}, order_status: #{@order_status},"\
+      " fulfillment_type: #{@fulfillment_type}, purchase_date: #{@purchase_date},"\
+      " last_updated_date: #{@last_updated_date}, order_total: #{@order_total}, shipping_address:"\
+      " #{@shipping_address}, 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} purchase_order_id: #{@purchase_order_id.inspect}, customer_order_id:"\
+      " #{@customer_order_id.inspect}, seller_id: #{@seller_id.inspect}, order_status:"\
+      " #{@order_status.inspect}, fulfillment_type: #{@fulfillment_type.inspect}, purchase_date:"\
+      " #{@purchase_date.inspect}, last_updated_date: #{@last_updated_date.inspect}, order_total:"\
+      " #{@order_total.inspect}, shipping_address: #{@shipping_address.inspect}, order_lines:"\
+      " #{@order_lines.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/order_item_disposition.rb

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

data/lib/walmart_ap_is/models/order_line.rb

@@ -0,0 +1,155 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # OrderLine Model.
+  class OrderLine < 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 [String]
+    attr_accessor :seller_sku
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :walmart_item_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [QuantityWithUnit]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :item_price
+
+    # TODO: Write general description for this method
+    # @return [LineStatus]
+    attr_accessor :line_status
+
+    # Walmart Ship Node identifier for WFS orders
+    # @return [String]
+    attr_accessor :ship_node
+
+    # Walmart Ship Node identifier for WFS orders
+    # @return [FulfillmentOption]
+    attr_accessor :fulfillment_option
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_number'] = 'lineNumber'
+      @_hash['seller_sku'] = 'sellerSku'
+      @_hash['walmart_item_id'] = 'walmartItemId'
+      @_hash['product_name'] = 'productName'
+      @_hash['quantity'] = 'quantity'
+      @_hash['item_price'] = 'itemPrice'
+      @_hash['line_status'] = 'lineStatus'
+      @_hash['ship_node'] = 'shipNode'
+      @_hash['fulfillment_option'] = 'fulfillmentOption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        walmart_item_id
+        product_name
+        line_status
+        ship_node
+        fulfillment_option
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_number:, seller_sku:, quantity:, item_price:,
+                   walmart_item_id: SKIP, product_name: SKIP, line_status: SKIP,
+                   ship_node: SKIP, fulfillment_option: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line_number = line_number
+      @seller_sku = seller_sku
+      @walmart_item_id = walmart_item_id unless walmart_item_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @quantity = quantity
+      @item_price = item_price
+      @line_status = line_status unless line_status == SKIP
+      @ship_node = ship_node unless ship_node == SKIP
+      @fulfillment_option = fulfillment_option unless fulfillment_option == 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
+      seller_sku = hash.key?('sellerSku') ? hash['sellerSku'] : nil
+      quantity = QuantityWithUnit.from_hash(hash['quantity']) if hash['quantity']
+      item_price = Money.from_hash(hash['itemPrice']) if hash['itemPrice']
+      walmart_item_id =
+        hash.key?('walmartItemId') ? hash['walmartItemId'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      line_status = hash.key?('lineStatus') ? hash['lineStatus'] : SKIP
+      ship_node = hash.key?('shipNode') ? hash['shipNode'] : SKIP
+      fulfillment_option =
+        hash.key?('fulfillmentOption') ? hash['fulfillmentOption'] : 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.
+      OrderLine.new(line_number: line_number,
+                    seller_sku: seller_sku,
+                    quantity: quantity,
+                    item_price: item_price,
+                    walmart_item_id: walmart_item_id,
+                    product_name: product_name,
+                    line_status: line_status,
+                    ship_node: ship_node,
+                    fulfillment_option: fulfillment_option,
+                    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}, seller_sku: #{@seller_sku}, walmart_item_id:"\
+      " #{@walmart_item_id}, product_name: #{@product_name}, quantity: #{@quantity}, item_price:"\
+      " #{@item_price}, line_status: #{@line_status}, ship_node: #{@ship_node},"\
+      " fulfillment_option: #{@fulfillment_option}, 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}, seller_sku: #{@seller_sku.inspect},"\
+      " walmart_item_id: #{@walmart_item_id.inspect}, product_name: #{@product_name.inspect},"\
+      " quantity: #{@quantity.inspect}, item_price: #{@item_price.inspect}, line_status:"\
+      " #{@line_status.inspect}, ship_node: #{@ship_node.inspect}, fulfillment_option:"\
+      " #{@fulfillment_option.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/order_status.rb

@@ -0,0 +1,52 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # OrderStatus.
+  class OrderStatus
+    ORDER_STATUS = [
+      # TODO: Write general description for CREATED
+      CREATED = 'Created'.freeze,
+
+      # TODO: Write general description for ACKNOWLEDGED
+      ACKNOWLEDGED = 'Acknowledged'.freeze,
+
+      # TODO: Write general description for SHIPPED
+      SHIPPED = 'Shipped'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'Delivered'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'Cancelled'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'Refunded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'acknowledged' then ACKNOWLEDGED
+      when 'shipped' then SHIPPED
+      when 'delivered' then DELIVERED
+      when 'cancelled' then CANCELLED
+      when 'refunded' then REFUNDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/owner_constraint.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # A constraint that can apply to an individual owner.
+  class OwnerConstraint
+    OWNER_CONSTRAINT = [
+      # TODO: Write general description for SELLER_ONLY
+      SELLER_ONLY = 'SELLER_ONLY'.freeze,
+
+      # TODO: Write general description for NONE_ONLY
+      NONE_ONLY = 'NONE_ONLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OWNER_CONSTRAINT.include?(value)
+    end
+
+    def self.from_value(value, default_value = SELLER_ONLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'seller_only' then SELLER_ONLY
+      when 'none_only' then NONE_ONLY
+      else
+        default_value
+      end
+    end
+  end
+end