walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/cancellation_status.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # CancellationStatus.
+  class CancellationStatus
+    CANCELLATION_STATUS = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CANCELLATION_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CANCELLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancelled' then CANCELLED
+      when 'pending' then PENDING
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/carrier.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The carrier for the inbound shipment.
+  class Carrier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The carrier code. For example, USPS or DHLEX.
+    # @return [String]
+    attr_accessor :alpha_code
+
+    # The name of the carrier.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alpha_code'] = 'alphaCode'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alpha_code
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alpha_code: SKIP, name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @alpha_code = alpha_code unless alpha_code == SKIP
+      @name = name unless name == 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.
+      alpha_code = hash.key?('alphaCode') ? hash['alphaCode'] : SKIP
+      name = hash.key?('name') ? hash['name'] : 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.
+      Carrier.new(alpha_code: alpha_code,
+                  name: name,
+                  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} alpha_code: #{@alpha_code}, name: #{@name}, 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} alpha_code: #{@alpha_code.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/carrier1.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Carrier1 Model.
+  class Carrier1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # Carrier display name. Walmart-specific enum-widening for
+    # internally-fulfilled carriers (e.g. WALMART_GROUND) is
+    # captured by leaving this as a free string rather than a
+    # closed enum.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Carrier1.new(id: id,
+                   name: name,
+                   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} id: #{@id}, name: #{@name}, 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} id: #{@id.inspect}, name: #{@name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/carrier_name.rb

@@ -0,0 +1,56 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # CarrierName.
+  class CarrierName
+    CARRIER_NAME = [
+      # TODO: Write general description for UPS
+      UPS = 'UPS'.freeze,
+
+      # TODO: Write general description for USPS
+      USPS = 'USPS'.freeze,
+
+      # TODO: Write general description for FEDEX
+      FEDEX = 'FedEx'.freeze,
+
+      # TODO: Write general description for ONTRAC
+      ONTRAC = 'OnTrac'.freeze,
+
+      # TODO: Write general description for LASERSHIP
+      LASERSHIP = 'LaserShip'.freeze,
+
+      # TODO: Write general description for WALMART_GROUND
+      WALMART_GROUND = 'WALMART_GROUND'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARRIER_NAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = UPS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ups' then UPS
+      when 'usps' then USPS
+      when 'fedex' then FEDEX
+      when 'ontrac' then ONTRAC
+      when 'lasership' then LASERSHIP
+      when 'walmart_ground' then WALMART_GROUND
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/carrier_will_pick_up_option.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # CarrierWillPickUpOption.
+  class CarrierWillPickUpOption
+    CARRIER_WILL_PICK_UP_OPTION = [
+      # TODO: Write general description for CARRIERCONTACT
+      CARRIERCONTACT = 'CarrierContact'.freeze,
+
+      # TODO: Write general description for SELLERCONTACT
+      SELLERCONTACT = 'SellerContact'.freeze,
+
+      # TODO: Write general description for NOPREFERENCE
+      NOPREFERENCE = 'NoPreference'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARRIER_WILL_PICK_UP_OPTION.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARRIERCONTACT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'carriercontact' then CARRIERCONTACT
+      when 'sellercontact' then SELLERCONTACT
+      when 'nopreference' then NOPREFERENCE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/channel.rb

@@ -0,0 +1,146 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Channel Model.
+  class Channel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :channel_owner
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :channel_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :webhook_config
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :channel_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :created_timestamp
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :last_modified_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['channel_owner'] = 'channelOwner'
+      @_hash['channel_name'] = 'channelName'
+      @_hash['type'] = 'type'
+      @_hash['webhook_config'] = 'webhookConfig'
+      @_hash['status'] = 'status'
+      @_hash['channel_id'] = 'channelId'
+      @_hash['created_timestamp'] = 'createdTimestamp'
+      @_hash['last_modified_timestamp'] = 'lastModifiedTimestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook_config
+        status
+        channel_id
+        created_timestamp
+        last_modified_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(channel_owner:, channel_name:, type:, webhook_config: SKIP,
+                   status: SKIP, channel_id: SKIP, created_timestamp: SKIP,
+                   last_modified_timestamp: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @channel_owner = channel_owner
+      @channel_name = channel_name
+      @type = type
+      @webhook_config = webhook_config unless webhook_config == SKIP
+      @status = status unless status == SKIP
+      @channel_id = channel_id unless channel_id == SKIP
+      @created_timestamp = created_timestamp unless created_timestamp == SKIP
+      @last_modified_timestamp = last_modified_timestamp unless last_modified_timestamp == 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.
+      channel_owner = hash.key?('channelOwner') ? hash['channelOwner'] : nil
+      channel_name = hash.key?('channelName') ? hash['channelName'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      webhook_config = hash.key?('webhookConfig') ? hash['webhookConfig'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      channel_id = hash.key?('channelId') ? hash['channelId'] : SKIP
+      created_timestamp =
+        hash.key?('createdTimestamp') ? hash['createdTimestamp'] : SKIP
+      last_modified_timestamp =
+        hash.key?('lastModifiedTimestamp') ? hash['lastModifiedTimestamp'] : 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.
+      Channel.new(channel_owner: channel_owner,
+                  channel_name: channel_name,
+                  type: type,
+                  webhook_config: webhook_config,
+                  status: status,
+                  channel_id: channel_id,
+                  created_timestamp: created_timestamp,
+                  last_modified_timestamp: last_modified_timestamp,
+                  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} channel_owner: #{@channel_owner}, channel_name: #{@channel_name}, type:"\
+      " #{@type}, webhook_config: #{@webhook_config}, status: #{@status}, channel_id:"\
+      " #{@channel_id}, created_timestamp: #{@created_timestamp}, last_modified_timestamp:"\
+      " #{@last_modified_timestamp}, 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} channel_owner: #{@channel_owner.inspect}, channel_name:"\
+      " #{@channel_name.inspect}, type: #{@type.inspect}, webhook_config:"\
+      " #{@webhook_config.inspect}, status: #{@status.inspect}, channel_id:"\
+      " #{@channel_id.inspect}, created_timestamp: #{@created_timestamp.inspect},"\
+      " last_modified_timestamp: #{@last_modified_timestamp.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/channel_details.rb

@@ -0,0 +1,113 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ChannelDetails Model.
+  class ChannelDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sales-channel hint that lets shipping-v4 route differently for
+    # WFS-fulfilled orders, marketplace-seller-fulfilled orders, and
+    # external (off-Walmart) orders.
+    # @return [ChannelType]
+    attr_accessor :channel_type
+
+    # Marketplace-side order context for orders originating on the
+    # Walmart Marketplace surface. Equivalent in shape to industry
+    # SP-API's order-details block; renamed to be vendor-neutral.
+    # @return [MarketplaceOrderDetails]
+    attr_accessor :marketplace_order_details
+
+    # Marketplace-side shipment context. Renamed from the industry
+    # SP-API "vendor-shipment-details" block to be vendor-neutral.
+    # @return [MarketplaceShipmentDetails]
+    attr_accessor :marketplace_shipment_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['channel_type'] = 'channelType'
+      @_hash['marketplace_order_details'] = 'marketplaceOrderDetails'
+      @_hash['marketplace_shipment_details'] = 'marketplaceShipmentDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marketplace_order_details
+        marketplace_shipment_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(channel_type:, marketplace_order_details: SKIP,
+                   marketplace_shipment_details: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @channel_type = channel_type
+      unless marketplace_order_details == SKIP
+        @marketplace_order_details =
+          marketplace_order_details
+      end
+      unless marketplace_shipment_details == SKIP
+        @marketplace_shipment_details =
+          marketplace_shipment_details
+      end
+      @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.
+      channel_type = hash.key?('channelType') ? hash['channelType'] : nil
+      if hash['marketplaceOrderDetails']
+        marketplace_order_details = MarketplaceOrderDetails.from_hash(hash['marketplaceOrderDetails'])
+      end
+      if hash['marketplaceShipmentDetails']
+        marketplace_shipment_details = MarketplaceShipmentDetails.from_hash(hash['marketplaceShipmentDetails'])
+      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.
+      ChannelDetails.new(channel_type: channel_type,
+                         marketplace_order_details: marketplace_order_details,
+                         marketplace_shipment_details: marketplace_shipment_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} channel_type: #{@channel_type}, marketplace_order_details:"\
+      " #{@marketplace_order_details}, marketplace_shipment_details:"\
+      " #{@marketplace_shipment_details}, 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} channel_type: #{@channel_type.inspect}, marketplace_order_details:"\
+      " #{@marketplace_order_details.inspect}, marketplace_shipment_details:"\
+      " #{@marketplace_shipment_details.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/channel_list.rb

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

data/lib/walmart_ap_is/models/channel_type.rb

@@ -0,0 +1,42 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Sales-channel hint that lets shipping-v4 route differently for WFS-fulfilled
+  # orders, marketplace-seller-fulfilled orders, and external (off-Walmart)
+  # orders.
+  class ChannelType
+    CHANNEL_TYPE = [
+      # TODO: Write general description for WALMART_MARKETPLACE
+      WALMART_MARKETPLACE = 'WALMART_MARKETPLACE'.freeze,
+
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'EXTERNAL'.freeze,
+
+      # TODO: Write general description for WFS
+      WFS = 'WFS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = WALMART_MARKETPLACE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'walmart_marketplace' then WALMART_MARKETPLACE
+      when 'external' then EXTERNAL
+      when 'wfs' then WFS
+      else
+        default_value
+      end
+    end
+  end
+end