walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/fees_estimate.rb

@@ -0,0 +1,112 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # The estimated fees broken down by component. Mirrors SP-API FeesEstimate.
+  class FeesEstimate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :time_of_fees_estimation
+
+    # Currency amount.
+    # @return [MoneyType1]
+    attr_accessor :total_fees_estimate
+
+    # Currency amount.
+    # @return [Array[FeeDetail]]
+    attr_accessor :fee_detail_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['time_of_fees_estimation'] = 'TimeOfFeesEstimation'
+      @_hash['total_fees_estimate'] = 'TotalFeesEstimate'
+      @_hash['fee_detail_list'] = 'FeeDetailList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_detail_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(time_of_fees_estimation:, total_fees_estimate:,
+                   fee_detail_list: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @time_of_fees_estimation = time_of_fees_estimation
+      @total_fees_estimate = total_fees_estimate
+      @fee_detail_list = fee_detail_list unless fee_detail_list == 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.
+      time_of_fees_estimation = if hash.key?('TimeOfFeesEstimation')
+                                  (DateTimeHelper.from_rfc3339(hash['TimeOfFeesEstimation']) if hash['TimeOfFeesEstimation'])
+                                end
+      total_fees_estimate = MoneyType1.from_hash(hash['TotalFeesEstimate']) if
+        hash['TotalFeesEstimate']
+      # Parameter is an array, so we need to iterate through it
+      fee_detail_list = nil
+      unless hash['FeeDetailList'].nil?
+        fee_detail_list = []
+        hash['FeeDetailList'].each do |structure|
+          fee_detail_list << (FeeDetail.from_hash(structure) if structure)
+        end
+      end
+
+      fee_detail_list = SKIP unless hash.key?('FeeDetailList')
+
+      # 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.
+      FeesEstimate.new(time_of_fees_estimation: time_of_fees_estimation,
+                       total_fees_estimate: total_fees_estimate,
+                       fee_detail_list: fee_detail_list,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_time_of_fees_estimation
+      DateTimeHelper.to_rfc3339(time_of_fees_estimation)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} time_of_fees_estimation: #{@time_of_fees_estimation}, total_fees_estimate:"\
+      " #{@total_fees_estimate}, fee_detail_list: #{@fee_detail_list}, 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} time_of_fees_estimation: #{@time_of_fees_estimation.inspect},"\
+      " total_fees_estimate: #{@total_fees_estimate.inspect}, fee_detail_list:"\
+      " #{@fee_detail_list.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fees_estimate_by_id_request.rb

@@ -0,0 +1,96 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # A single fee estimate request for the batch endpoint. Combines the item
+  # identifier (IdType + IdValue) with the fee estimate parameters. Mirrors
+  # SP-API FeesEstimateByIdRequest.
+  class FeesEstimateByIdRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of item identifier.
+    # @return [IdType]
+    attr_accessor :id_type
+
+    # The item identifier value (Walmart Item ID or Seller SKU).
+    # @return [String]
+    attr_accessor :id_value
+
+    # Fee estimate parameters for a single item. Used in both single-item
+    # and batch endpoints. Mirrors SP-API FeesEstimateRequest.
+    # @return [FeesEstimateRequest]
+    attr_accessor :fees_estimate_request
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id_type'] = 'IdType'
+      @_hash['id_value'] = 'IdValue'
+      @_hash['fees_estimate_request'] = 'FeesEstimateRequest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id_type:, id_value:, fees_estimate_request:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id_type = id_type
+      @id_value = id_value
+      @fees_estimate_request = fees_estimate_request
+      @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_type = hash.key?('IdType') ? hash['IdType'] : nil
+      id_value = hash.key?('IdValue') ? hash['IdValue'] : nil
+      fees_estimate_request = FeesEstimateRequest.from_hash(hash['FeesEstimateRequest']) if
+        hash['FeesEstimateRequest']
+
+      # 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.
+      FeesEstimateByIdRequest.new(id_type: id_type,
+                                  id_value: id_value,
+                                  fees_estimate_request: fees_estimate_request,
+                                  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_type: #{@id_type}, id_value: #{@id_value}, fees_estimate_request:"\
+      " #{@fees_estimate_request}, 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_type: #{@id_type.inspect}, id_value: #{@id_value.inspect},"\
+      " fees_estimate_request: #{@fees_estimate_request.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fees_estimate_error.rb

@@ -0,0 +1,99 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Error detail when a fee estimate could not be computed.
+  class FeesEstimateError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'Type'
+      @_hash['code'] = 'Code'
+      @_hash['message'] = 'Message'
+      @_hash['detail'] = 'Detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, code:, message:, detail:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @code = code
+      @message = message
+      @detail = detail
+      @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.
+      type = hash.key?('Type') ? hash['Type'] : nil
+      code = hash.key?('Code') ? hash['Code'] : nil
+      message = hash.key?('Message') ? hash['Message'] : nil
+      detail = hash.key?('Detail') ? hash['Detail'] : 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.
+      FeesEstimateError.new(type: type,
+                            code: code,
+                            message: message,
+                            detail: detail,
+                            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} type: #{@type}, code: #{@code}, message: #{@message}, detail: #{@detail},"\
+      " 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} type: #{@type.inspect}, code: #{@code.inspect}, message:"\
+      " #{@message.inspect}, detail: #{@detail.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fees_estimate_identifier.rb

@@ -0,0 +1,158 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Echoes back the item identifier and request parameters that produced this
+  # result. Mirrors SP-API FeesEstimateIdentifier.
+  class FeesEstimateIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :marketplace_id
+
+    # TODO: Write general description for this method
+    # @return [IdType1]
+    attr_accessor :id_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id_value
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_walmart_fulfilled
+
+    # Price information used to estimate fees.
+    # @return [PriceToEstimateFees]
+    attr_accessor :price_to_estimate_fees
+
+    # Price information used to estimate fees.
+    # @return [String]
+    attr_accessor :seller_id
+
+    # Echoed from the request Identifier field.
+    # @return [String]
+    attr_accessor :seller_input_identifier
+
+    # Echoed from the request Identifier field.
+    # @return [String]
+    attr_accessor :optional_fulfillment_program
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['marketplace_id'] = 'MarketplaceId'
+      @_hash['id_type'] = 'IdType'
+      @_hash['id_value'] = 'IdValue'
+      @_hash['is_walmart_fulfilled'] = 'IsWalmartFulfilled'
+      @_hash['price_to_estimate_fees'] = 'PriceToEstimateFees'
+      @_hash['seller_id'] = 'SellerId'
+      @_hash['seller_input_identifier'] = 'SellerInputIdentifier'
+      @_hash['optional_fulfillment_program'] = 'OptionalFulfillmentProgram'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marketplace_id
+        id_type
+        id_value
+        is_walmart_fulfilled
+        price_to_estimate_fees
+        seller_id
+        seller_input_identifier
+        optional_fulfillment_program
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(marketplace_id: SKIP, id_type: SKIP, id_value: SKIP,
+                   is_walmart_fulfilled: SKIP, price_to_estimate_fees: SKIP,
+                   seller_id: SKIP, seller_input_identifier: SKIP,
+                   optional_fulfillment_program: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @marketplace_id = marketplace_id unless marketplace_id == SKIP
+      @id_type = id_type unless id_type == SKIP
+      @id_value = id_value unless id_value == SKIP
+      @is_walmart_fulfilled = is_walmart_fulfilled unless is_walmart_fulfilled == SKIP
+      @price_to_estimate_fees = price_to_estimate_fees unless price_to_estimate_fees == SKIP
+      @seller_id = seller_id unless seller_id == SKIP
+      @seller_input_identifier = seller_input_identifier unless seller_input_identifier == SKIP
+      unless optional_fulfillment_program == SKIP
+        @optional_fulfillment_program =
+          optional_fulfillment_program
+      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.
+      marketplace_id = hash.key?('MarketplaceId') ? hash['MarketplaceId'] : SKIP
+      id_type = hash.key?('IdType') ? hash['IdType'] : SKIP
+      id_value = hash.key?('IdValue') ? hash['IdValue'] : SKIP
+      is_walmart_fulfilled =
+        hash.key?('IsWalmartFulfilled') ? hash['IsWalmartFulfilled'] : SKIP
+      price_to_estimate_fees = PriceToEstimateFees.from_hash(hash['PriceToEstimateFees']) if
+        hash['PriceToEstimateFees']
+      seller_id = hash.key?('SellerId') ? hash['SellerId'] : SKIP
+      seller_input_identifier =
+        hash.key?('SellerInputIdentifier') ? hash['SellerInputIdentifier'] : SKIP
+      optional_fulfillment_program =
+        hash.key?('OptionalFulfillmentProgram') ? hash['OptionalFulfillmentProgram'] : 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.
+      FeesEstimateIdentifier.new(marketplace_id: marketplace_id,
+                                 id_type: id_type,
+                                 id_value: id_value,
+                                 is_walmart_fulfilled: is_walmart_fulfilled,
+                                 price_to_estimate_fees: price_to_estimate_fees,
+                                 seller_id: seller_id,
+                                 seller_input_identifier: seller_input_identifier,
+                                 optional_fulfillment_program: optional_fulfillment_program,
+                                 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} marketplace_id: #{@marketplace_id}, id_type: #{@id_type}, id_value:"\
+      " #{@id_value}, is_walmart_fulfilled: #{@is_walmart_fulfilled}, price_to_estimate_fees:"\
+      " #{@price_to_estimate_fees}, seller_id: #{@seller_id}, seller_input_identifier:"\
+      " #{@seller_input_identifier}, optional_fulfillment_program:"\
+      " #{@optional_fulfillment_program}, 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} marketplace_id: #{@marketplace_id.inspect}, id_type: #{@id_type.inspect},"\
+      " id_value: #{@id_value.inspect}, is_walmart_fulfilled: #{@is_walmart_fulfilled.inspect},"\
+      " price_to_estimate_fees: #{@price_to_estimate_fees.inspect}, seller_id:"\
+      " #{@seller_id.inspect}, seller_input_identifier: #{@seller_input_identifier.inspect},"\
+      " optional_fulfillment_program: #{@optional_fulfillment_program.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/fees_estimate_request.rb

@@ -0,0 +1,125 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Fee estimate parameters for a single item. Used in both single-item and
+  # batch endpoints. Mirrors SP-API FeesEstimateRequest.
+  class FeesEstimateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Marketplace identifier.
+    # @return [MarketplaceId]
+    attr_accessor :marketplace_id
+
+    # true if fulfilled by Walmart Fulfillment Services (WFS); false for
+    # seller-fulfilled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_walmart_fulfilled
+
+    # Price information used to estimate fees.
+    # @return [PriceToEstimateFees]
+    attr_accessor :price_to_estimate_fees
+
+    # A caller-supplied identifier echoed back in the response for correlation.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Optional fulfillment program override for WFS items.
+    # @return [OptionalFulfillmentProgram]
+    attr_accessor :optional_fulfillment_program
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['marketplace_id'] = 'MarketplaceId'
+      @_hash['is_walmart_fulfilled'] = 'IsWalmartFulfilled'
+      @_hash['price_to_estimate_fees'] = 'PriceToEstimateFees'
+      @_hash['identifier'] = 'Identifier'
+      @_hash['optional_fulfillment_program'] = 'OptionalFulfillmentProgram'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        optional_fulfillment_program
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(marketplace_id:, is_walmart_fulfilled:,
+                   price_to_estimate_fees:, identifier: SKIP,
+                   optional_fulfillment_program: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @marketplace_id = marketplace_id
+      @is_walmart_fulfilled = is_walmart_fulfilled
+      @price_to_estimate_fees = price_to_estimate_fees
+      @identifier = identifier unless identifier == SKIP
+      unless optional_fulfillment_program == SKIP
+        @optional_fulfillment_program =
+          optional_fulfillment_program
+      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.
+      marketplace_id = hash.key?('MarketplaceId') ? hash['MarketplaceId'] : nil
+      is_walmart_fulfilled =
+        hash.key?('IsWalmartFulfilled') ? hash['IsWalmartFulfilled'] : nil
+      price_to_estimate_fees = PriceToEstimateFees.from_hash(hash['PriceToEstimateFees']) if
+        hash['PriceToEstimateFees']
+      identifier = hash.key?('Identifier') ? hash['Identifier'] : SKIP
+      optional_fulfillment_program =
+        hash.key?('OptionalFulfillmentProgram') ? hash['OptionalFulfillmentProgram'] : 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.
+      FeesEstimateRequest.new(marketplace_id: marketplace_id,
+                              is_walmart_fulfilled: is_walmart_fulfilled,
+                              price_to_estimate_fees: price_to_estimate_fees,
+                              identifier: identifier,
+                              optional_fulfillment_program: optional_fulfillment_program,
+                              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} marketplace_id: #{@marketplace_id}, is_walmart_fulfilled:"\
+      " #{@is_walmart_fulfilled}, price_to_estimate_fees: #{@price_to_estimate_fees}, identifier:"\
+      " #{@identifier}, optional_fulfillment_program: #{@optional_fulfillment_program},"\
+      " 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} marketplace_id: #{@marketplace_id.inspect}, is_walmart_fulfilled:"\
+      " #{@is_walmart_fulfilled.inspect}, price_to_estimate_fees:"\
+      " #{@price_to_estimate_fees.inspect}, identifier: #{@identifier.inspect},"\
+      " optional_fulfillment_program: #{@optional_fulfillment_program.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end