walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/inbound_plan.rb

@@ -0,0 +1,207 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Inbound plan containing details of the WFS inbound workflow.
+  class InboundPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The time at which the inbound plan was created. In ISO 8601 datetime
+    # format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Identifier of an inbound plan.
+    # @return [String]
+    attr_accessor :inbound_plan_id
+
+    # The time at which the inbound plan was last updated. In ISO 8601 datetime
+    # format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # A list of Walmart marketplace IDs.
+    # @return [Array[String]]
+    attr_accessor :marketplace_ids
+
+    # Human-readable name of the inbound plan.
+    # @return [String]
+    attr_accessor :name
+
+    # Packing options for the inbound plan. Populated after generation via the
+    # corresponding operation.
+    # @return [Array[PackingOptionSummary]]
+    attr_accessor :packing_options
+
+    # Placement options for the inbound plan. Populated after generation via the
+    # corresponding operation.
+    # @return [Array[PlacementOptionSummary]]
+    attr_accessor :placement_options
+
+    # A list of shipment IDs for the inbound plan. Populated after
+    # `confirmPlacementOptions`.
+    # @return [Array[ShipmentSummary]]
+    attr_accessor :shipments
+
+    # Specific details to identify a place.
+    # @return [Address]
+    attr_accessor :source_address
+
+    # Current status of the inbound plan. Possible values: `ACTIVE`, `VOIDED`,
+    # `SHIPPED`, `ERRORED`.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'createdAt'
+      @_hash['inbound_plan_id'] = 'inboundPlanId'
+      @_hash['last_updated_at'] = 'lastUpdatedAt'
+      @_hash['marketplace_ids'] = 'marketplaceIds'
+      @_hash['name'] = 'name'
+      @_hash['packing_options'] = 'packingOptions'
+      @_hash['placement_options'] = 'placementOptions'
+      @_hash['shipments'] = 'shipments'
+      @_hash['source_address'] = 'sourceAddress'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        packing_options
+        placement_options
+        shipments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at:, inbound_plan_id:, last_updated_at:,
+                   marketplace_ids:, name:, source_address:, status:,
+                   packing_options: SKIP, placement_options: SKIP,
+                   shipments: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at
+      @inbound_plan_id = inbound_plan_id
+      @last_updated_at = last_updated_at
+      @marketplace_ids = marketplace_ids
+      @name = name
+      @packing_options = packing_options unless packing_options == SKIP
+      @placement_options = placement_options unless placement_options == SKIP
+      @shipments = shipments unless shipments == SKIP
+      @source_address = source_address
+      @status = status
+      @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.
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   end
+      inbound_plan_id = hash.key?('inboundPlanId') ? hash['inboundPlanId'] : nil
+      last_updated_at = if hash.key?('lastUpdatedAt')
+                          (DateTimeHelper.from_rfc3339(hash['lastUpdatedAt']) if hash['lastUpdatedAt'])
+                        end
+      marketplace_ids =
+        hash.key?('marketplaceIds') ? hash['marketplaceIds'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      source_address = Address.from_hash(hash['sourceAddress']) if hash['sourceAddress']
+      status = hash.key?('status') ? hash['status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      packing_options = nil
+      unless hash['packingOptions'].nil?
+        packing_options = []
+        hash['packingOptions'].each do |structure|
+          packing_options << (PackingOptionSummary.from_hash(structure) if structure)
+        end
+      end
+
+      packing_options = SKIP unless hash.key?('packingOptions')
+      # Parameter is an array, so we need to iterate through it
+      placement_options = nil
+      unless hash['placementOptions'].nil?
+        placement_options = []
+        hash['placementOptions'].each do |structure|
+          placement_options << (PlacementOptionSummary.from_hash(structure) if structure)
+        end
+      end
+
+      placement_options = SKIP unless hash.key?('placementOptions')
+      # Parameter is an array, so we need to iterate through it
+      shipments = nil
+      unless hash['shipments'].nil?
+        shipments = []
+        hash['shipments'].each do |structure|
+          shipments << (ShipmentSummary.from_hash(structure) if structure)
+        end
+      end
+
+      shipments = SKIP unless hash.key?('shipments')
+
+      # 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.
+      InboundPlan.new(created_at: created_at,
+                      inbound_plan_id: inbound_plan_id,
+                      last_updated_at: last_updated_at,
+                      marketplace_ids: marketplace_ids,
+                      name: name,
+                      source_address: source_address,
+                      status: status,
+                      packing_options: packing_options,
+                      placement_options: placement_options,
+                      shipments: shipments,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, inbound_plan_id: #{@inbound_plan_id},"\
+      " last_updated_at: #{@last_updated_at}, marketplace_ids: #{@marketplace_ids}, name:"\
+      " #{@name}, packing_options: #{@packing_options}, placement_options: #{@placement_options},"\
+      " shipments: #{@shipments}, source_address: #{@source_address}, status: #{@status},"\
+      " 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} created_at: #{@created_at.inspect}, inbound_plan_id:"\
+      " #{@inbound_plan_id.inspect}, last_updated_at: #{@last_updated_at.inspect},"\
+      " marketplace_ids: #{@marketplace_ids.inspect}, name: #{@name.inspect}, packing_options:"\
+      " #{@packing_options.inspect}, placement_options: #{@placement_options.inspect}, shipments:"\
+      " #{@shipments.inspect}, source_address: #{@source_address.inspect}, status:"\
+      " #{@status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/inbound_plan_summary.rb

@@ -0,0 +1,146 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # A light-weight inbound plan.
+  class InboundPlanSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The time at which the inbound plan was created. In ISO 8601 datetime
+    # format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Identifier of an inbound plan.
+    # @return [String]
+    attr_accessor :inbound_plan_id
+
+    # The time at which the inbound plan was last updated. In ISO 8601 datetime
+    # format with pattern `yyyy-MM-ddTHH:mm:ssZ`.
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # A list of Walmart marketplace IDs associated with this inbound plan.
+    # @return [Array[String]]
+    attr_accessor :marketplace_ids
+
+    # Human-readable name of the inbound plan.
+    # @return [String]
+    attr_accessor :name
+
+    # Specific details to identify a place.
+    # @return [Address]
+    attr_accessor :source_address
+
+    # The current status of the inbound plan. Possible values: `ACTIVE`,
+    # `VOIDED`, `SHIPPED`, `ERRORED`.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'createdAt'
+      @_hash['inbound_plan_id'] = 'inboundPlanId'
+      @_hash['last_updated_at'] = 'lastUpdatedAt'
+      @_hash['marketplace_ids'] = 'marketplaceIds'
+      @_hash['name'] = 'name'
+      @_hash['source_address'] = 'sourceAddress'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at:, inbound_plan_id:, last_updated_at:,
+                   marketplace_ids:, name:, source_address:, status:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at
+      @inbound_plan_id = inbound_plan_id
+      @last_updated_at = last_updated_at
+      @marketplace_ids = marketplace_ids
+      @name = name
+      @source_address = source_address
+      @status = status
+      @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.
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   end
+      inbound_plan_id = hash.key?('inboundPlanId') ? hash['inboundPlanId'] : nil
+      last_updated_at = if hash.key?('lastUpdatedAt')
+                          (DateTimeHelper.from_rfc3339(hash['lastUpdatedAt']) if hash['lastUpdatedAt'])
+                        end
+      marketplace_ids =
+        hash.key?('marketplaceIds') ? hash['marketplaceIds'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      source_address = Address.from_hash(hash['sourceAddress']) if hash['sourceAddress']
+      status = hash.key?('status') ? hash['status'] : 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.
+      InboundPlanSummary.new(created_at: created_at,
+                             inbound_plan_id: inbound_plan_id,
+                             last_updated_at: last_updated_at,
+                             marketplace_ids: marketplace_ids,
+                             name: name,
+                             source_address: source_address,
+                             status: status,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, inbound_plan_id: #{@inbound_plan_id},"\
+      " last_updated_at: #{@last_updated_at}, marketplace_ids: #{@marketplace_ids}, name:"\
+      " #{@name}, source_address: #{@source_address}, status: #{@status}, 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} created_at: #{@created_at.inspect}, inbound_plan_id:"\
+      " #{@inbound_plan_id.inspect}, last_updated_at: #{@last_updated_at.inspect},"\
+      " marketplace_ids: #{@marketplace_ids.inspect}, name: #{@name.inspect}, source_address:"\
+      " #{@source_address.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/incentive.rb

@@ -0,0 +1,101 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains details about cost related modifications to the placement cost.
+  class Incentive < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of the incentive.
+    # @return [String]
+    attr_accessor :description
+
+    # Target of the incentive. Possible values: 'Placement Services',
+    # 'Fulfillment Fee Discount'.
+    # @return [String]
+    attr_accessor :target
+
+    # Type of incentive. Possible values: `FEE`, `DISCOUNT`.
+    # @return [String]
+    attr_accessor :type
+
+    # The type and amount of currency.
+    # @return [Currency]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['target'] = 'target'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description:, target:, type:, value:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description
+      @target = target
+      @type = type
+      @value = value
+      @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.
+      description = hash.key?('description') ? hash['description'] : nil
+      target = hash.key?('target') ? hash['target'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      value = Currency.from_hash(hash['value']) if hash['value']
+
+      # 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.
+      Incentive.new(description: description,
+                    target: target,
+                    type: type,
+                    value: value,
+                    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} description: #{@description}, target: #{@target}, type: #{@type}, value:"\
+      " #{@value}, 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} description: #{@description.inspect}, target: #{@target.inspect}, type:"\
+      " #{@type.inspect}, value: #{@value.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/included_datum.rb

@@ -0,0 +1,56 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # includedDatum.
+  class IncludedDatum
+    INCLUDED_DATUM = [
+      # TODO: Write general description for ATTRIBUTES
+      ATTRIBUTES = 'attributes'.freeze,
+
+      # TODO: Write general description for DIMENSIONS
+      DIMENSIONS = 'dimensions'.freeze,
+
+      # TODO: Write general description for IDENTIFIERS
+      IDENTIFIERS = 'identifiers'.freeze,
+
+      # TODO: Write general description for IMAGES
+      IMAGES = 'images'.freeze,
+
+      # TODO: Write general description for PRODUCTTYPES
+      PRODUCTTYPES = 'productTypes'.freeze,
+
+      # TODO: Write general description for RELATIONSHIPS
+      RELATIONSHIPS = 'relationships'.freeze,
+
+      # TODO: Write general description for SALESRANKS
+      SALESRANKS = 'salesRanks'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INCLUDED_DATUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ATTRIBUTES)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'attributes' then ATTRIBUTES
+      when 'dimensions' then DIMENSIONS
+      when 'identifiers' then IDENTIFIERS
+      when 'images' then IMAGES
+      when 'producttypes' then PRODUCTTYPES
+      when 'relationships' then RELATIONSHIPS
+      when 'salesranks' then SALESRANKS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/included_datum1.rb

@@ -0,0 +1,52 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # includedDatum1.
+  class IncludedDatum1
+    INCLUDED_DATUM1 = [
+      # TODO: Write general description for SUMMARIES
+      SUMMARIES = 'summaries'.freeze,
+
+      # TODO: Write general description for ATTRIBUTES
+      ATTRIBUTES = 'attributes'.freeze,
+
+      # TODO: Write general description for ISSUES
+      ISSUES = 'issues'.freeze,
+
+      # TODO: Write general description for OFFERS
+      OFFERS = 'offers'.freeze,
+
+      # TODO: Write general description for FULFILLMENTAVAILABILITY
+      FULFILLMENTAVAILABILITY = 'fulfillmentAvailability'.freeze,
+
+      # TODO: Write general description for PROCUREMENT
+      PROCUREMENT = 'procurement'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INCLUDED_DATUM1.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUMMARIES)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'summaries' then SUMMARIES
+      when 'attributes' then ATTRIBUTES
+      when 'issues' then ISSUES
+      when 'offers' then OFFERS
+      when 'fulfillmentavailability' then FULFILLMENTAVAILABILITY
+      when 'procurement' then PROCUREMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/included_datum2.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # IncludedDatum2.
+  class IncludedDatum2
+    INCLUDED_DATUM2 = [
+      # TODO: Write general description for FEATUREDBUYINGOPTIONS
+      FEATUREDBUYINGOPTIONS = 'featuredBuyingOptions'.freeze,
+
+      # TODO: Write general description for REFERENCEPRICES
+      REFERENCEPRICES = 'referencePrices'.freeze,
+
+      # TODO: Write general description for LOWESTPRICEDOFFERS
+      LOWESTPRICEDOFFERS = 'lowestPricedOffers'.freeze,
+
+      # TODO: Write general description for SIMILARITEMS
+      SIMILARITEMS = 'similarItems'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INCLUDED_DATUM2.include?(value)
+    end
+
+    def self.from_value(value, default_value = FEATUREDBUYINGOPTIONS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'featuredbuyingoptions' then FEATUREDBUYINGOPTIONS
+      when 'referenceprices' then REFERENCEPRICES
+      when 'lowestpricedoffers' then LOWESTPRICEDOFFERS
+      when 'similaritems' then SIMILARITEMS
+      else
+        default_value
+      end
+    end
+  end
+end