walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/stock_status.rb

@@ -0,0 +1,48 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Stock health label based on days of supply
+  class StockStatus
+    STOCK_STATUS = [
+      # TODO: Write general description for INSTOCK
+      INSTOCK = 'InStock'.freeze,
+
+      # TODO: Write general description for ATRISK
+      ATRISK = 'AtRisk'.freeze,
+
+      # TODO: Write general description for OUTOFSTOCK
+      OUTOFSTOCK = 'OutOfStock'.freeze,
+
+      # TODO: Write general description for LONGTERMOUTOFSTOCK
+      LONGTERMOUTOFSTOCK = 'LongTermOutOfStock'.freeze,
+
+      # TODO: Write general description for NEWTOWFS
+      NEWTOWFS = 'NewToWfs'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STOCK_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = INSTOCK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'instock' then INSTOCK
+      when 'atrisk' then ATRISK
+      when 'outofstock' then OUTOFSTOCK
+      when 'longtermoutofstock' then LONGTERMOUTOFSTOCK
+      when 'newtowfs' then NEWTOWFS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/submit_ndr_feedback_request.rb

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

data/lib/walmart_ap_is/models/summary.rb

@@ -0,0 +1,241 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Contains price information about the product, including LowestPrices,
+  # BuyBoxPrices, and NumberOfOffers.
+  class Summary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of unique offers contained in NumberOfOffers.
+    # @return [Integer]
+    attr_accessor :total_offer_count
+
+    # A list of the total number of offers, by condition and fulfillment
+    # channel.
+    # @return [Array[OfferCountType]]
+    attr_accessor :number_of_offers
+
+    # A list of the lowest prices.
+    # @return [Array[LowestPriceType]]
+    attr_accessor :lowest_prices
+
+    # A list of the Buy Box prices.
+    # @return [Array[BuyBoxPriceType]]
+    attr_accessor :buy_box_prices
+
+    # Currency type and monetary value.
+    # @return [MoneyType]
+    attr_accessor :list_price
+
+    # Currency type and monetary value.
+    # @return [MoneyType]
+    attr_accessor :competitive_price_threshold
+
+    # Currency type and monetary value.
+    # @return [MoneyType]
+    attr_accessor :suggested_lower_price_plus_shipping
+
+    # A list of sales rank information for the item, by category.
+    # @return [Array[SalesRankType]]
+    attr_accessor :sales_rankings
+
+    # A list of the total number of offers eligible for the Buy Box, by
+    # condition and fulfillment channel.
+    # @return [Array[OfferCountType]]
+    attr_accessor :buy_box_eligible_offers
+
+    # When the status is ActiveButTooSoonForProcessing, the time when offers
+    # will be available for processing.
+    # @return [DateTime]
+    attr_accessor :offers_available_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_offer_count'] = 'TotalOfferCount'
+      @_hash['number_of_offers'] = 'NumberOfOffers'
+      @_hash['lowest_prices'] = 'LowestPrices'
+      @_hash['buy_box_prices'] = 'BuyBoxPrices'
+      @_hash['list_price'] = 'ListPrice'
+      @_hash['competitive_price_threshold'] = 'CompetitivePriceThreshold'
+      @_hash['suggested_lower_price_plus_shipping'] =
+        'SuggestedLowerPricePlusShipping'
+      @_hash['sales_rankings'] = 'SalesRankings'
+      @_hash['buy_box_eligible_offers'] = 'BuyBoxEligibleOffers'
+      @_hash['offers_available_time'] = 'OffersAvailableTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number_of_offers
+        lowest_prices
+        buy_box_prices
+        list_price
+        competitive_price_threshold
+        suggested_lower_price_plus_shipping
+        sales_rankings
+        buy_box_eligible_offers
+        offers_available_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_offer_count:, number_of_offers: SKIP,
+                   lowest_prices: SKIP, buy_box_prices: SKIP, list_price: SKIP,
+                   competitive_price_threshold: SKIP,
+                   suggested_lower_price_plus_shipping: SKIP,
+                   sales_rankings: SKIP, buy_box_eligible_offers: SKIP,
+                   offers_available_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_offer_count = total_offer_count
+      @number_of_offers = number_of_offers unless number_of_offers == SKIP
+      @lowest_prices = lowest_prices unless lowest_prices == SKIP
+      @buy_box_prices = buy_box_prices unless buy_box_prices == SKIP
+      @list_price = list_price unless list_price == SKIP
+      unless competitive_price_threshold == SKIP
+        @competitive_price_threshold =
+          competitive_price_threshold
+      end
+      unless suggested_lower_price_plus_shipping == SKIP
+        @suggested_lower_price_plus_shipping =
+          suggested_lower_price_plus_shipping
+      end
+      @sales_rankings = sales_rankings unless sales_rankings == SKIP
+      @buy_box_eligible_offers = buy_box_eligible_offers unless buy_box_eligible_offers == SKIP
+      @offers_available_time = offers_available_time unless offers_available_time == 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.
+      total_offer_count =
+        hash.key?('TotalOfferCount') ? hash['TotalOfferCount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      number_of_offers = nil
+      unless hash['NumberOfOffers'].nil?
+        number_of_offers = []
+        hash['NumberOfOffers'].each do |structure|
+          number_of_offers << (OfferCountType.from_hash(structure) if structure)
+        end
+      end
+
+      number_of_offers = SKIP unless hash.key?('NumberOfOffers')
+      # Parameter is an array, so we need to iterate through it
+      lowest_prices = nil
+      unless hash['LowestPrices'].nil?
+        lowest_prices = []
+        hash['LowestPrices'].each do |structure|
+          lowest_prices << (LowestPriceType.from_hash(structure) if structure)
+        end
+      end
+
+      lowest_prices = SKIP unless hash.key?('LowestPrices')
+      # Parameter is an array, so we need to iterate through it
+      buy_box_prices = nil
+      unless hash['BuyBoxPrices'].nil?
+        buy_box_prices = []
+        hash['BuyBoxPrices'].each do |structure|
+          buy_box_prices << (BuyBoxPriceType.from_hash(structure) if structure)
+        end
+      end
+
+      buy_box_prices = SKIP unless hash.key?('BuyBoxPrices')
+      list_price = MoneyType.from_hash(hash['ListPrice']) if hash['ListPrice']
+      competitive_price_threshold = MoneyType.from_hash(hash['CompetitivePriceThreshold']) if
+        hash['CompetitivePriceThreshold']
+      if hash['SuggestedLowerPricePlusShipping']
+        suggested_lower_price_plus_shipping = MoneyType.from_hash(hash['SuggestedLowerPricePlusShipping'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      sales_rankings = nil
+      unless hash['SalesRankings'].nil?
+        sales_rankings = []
+        hash['SalesRankings'].each do |structure|
+          sales_rankings << (SalesRankType.from_hash(structure) if structure)
+        end
+      end
+
+      sales_rankings = SKIP unless hash.key?('SalesRankings')
+      # Parameter is an array, so we need to iterate through it
+      buy_box_eligible_offers = nil
+      unless hash['BuyBoxEligibleOffers'].nil?
+        buy_box_eligible_offers = []
+        hash['BuyBoxEligibleOffers'].each do |structure|
+          buy_box_eligible_offers << (OfferCountType.from_hash(structure) if structure)
+        end
+      end
+
+      buy_box_eligible_offers = SKIP unless hash.key?('BuyBoxEligibleOffers')
+      offers_available_time = if hash.key?('OffersAvailableTime')
+                                (DateTimeHelper.from_rfc3339(hash['OffersAvailableTime']) if hash['OffersAvailableTime'])
+                              else
+                                SKIP
+                              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.
+      Summary.new(total_offer_count: total_offer_count,
+                  number_of_offers: number_of_offers,
+                  lowest_prices: lowest_prices,
+                  buy_box_prices: buy_box_prices,
+                  list_price: list_price,
+                  competitive_price_threshold: competitive_price_threshold,
+                  suggested_lower_price_plus_shipping: suggested_lower_price_plus_shipping,
+                  sales_rankings: sales_rankings,
+                  buy_box_eligible_offers: buy_box_eligible_offers,
+                  offers_available_time: offers_available_time,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_offers_available_time
+      DateTimeHelper.to_rfc3339(offers_available_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_offer_count: #{@total_offer_count}, number_of_offers:"\
+      " #{@number_of_offers}, lowest_prices: #{@lowest_prices}, buy_box_prices:"\
+      " #{@buy_box_prices}, list_price: #{@list_price}, competitive_price_threshold:"\
+      " #{@competitive_price_threshold}, suggested_lower_price_plus_shipping:"\
+      " #{@suggested_lower_price_plus_shipping}, sales_rankings: #{@sales_rankings},"\
+      " buy_box_eligible_offers: #{@buy_box_eligible_offers}, offers_available_time:"\
+      " #{@offers_available_time}, 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} total_offer_count: #{@total_offer_count.inspect}, number_of_offers:"\
+      " #{@number_of_offers.inspect}, lowest_prices: #{@lowest_prices.inspect}, buy_box_prices:"\
+      " #{@buy_box_prices.inspect}, list_price: #{@list_price.inspect},"\
+      " competitive_price_threshold: #{@competitive_price_threshold.inspect},"\
+      " suggested_lower_price_plus_shipping: #{@suggested_lower_price_plus_shipping.inspect},"\
+      " sales_rankings: #{@sales_rankings.inspect}, buy_box_eligible_offers:"\
+      " #{@buy_box_eligible_offers.inspect}, offers_available_time:"\
+      " #{@offers_available_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/tax_details.rb

@@ -0,0 +1,104 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Information used to determine the tax compliance.
+  class TaxDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type and amount of currency.
+    # @return [Currency]
+    attr_accessor :declared_value
+
+    # Harmonized System of Nomenclature code.
+    # @return [String]
+    attr_accessor :hsn_code
+
+    # List of tax rates.
+    # @return [Array[TaxRate]]
+    attr_accessor :tax_rates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['declared_value'] = 'declaredValue'
+      @_hash['hsn_code'] = 'hsnCode'
+      @_hash['tax_rates'] = 'taxRates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        declared_value
+        hsn_code
+        tax_rates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(declared_value: SKIP, hsn_code: SKIP, tax_rates: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @declared_value = declared_value unless declared_value == SKIP
+      @hsn_code = hsn_code unless hsn_code == SKIP
+      @tax_rates = tax_rates unless tax_rates == 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.
+      declared_value = Currency.from_hash(hash['declaredValue']) if hash['declaredValue']
+      hsn_code = hash.key?('hsnCode') ? hash['hsnCode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tax_rates = nil
+      unless hash['taxRates'].nil?
+        tax_rates = []
+        hash['taxRates'].each do |structure|
+          tax_rates << (TaxRate.from_hash(structure) if structure)
+        end
+      end
+
+      tax_rates = SKIP unless hash.key?('taxRates')
+
+      # 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.
+      TaxDetails.new(declared_value: declared_value,
+                     hsn_code: hsn_code,
+                     tax_rates: tax_rates,
+                     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} declared_value: #{@declared_value}, hsn_code: #{@hsn_code}, tax_rates:"\
+      " #{@tax_rates}, 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} declared_value: #{@declared_value.inspect}, hsn_code: #{@hsn_code.inspect},"\
+      " tax_rates: #{@tax_rates.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/tax_rate.rb

@@ -0,0 +1,95 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains the type and rate of tax.
+  class TaxRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Rate of cess tax.
+    # @return [Float]
+    attr_accessor :cess_rate
+
+    # Rate of gst tax.
+    # @return [Float]
+    attr_accessor :gst_rate
+
+    # Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`.
+    # @return [String]
+    attr_accessor :tax_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cess_rate'] = 'cessRate'
+      @_hash['gst_rate'] = 'gstRate'
+      @_hash['tax_type'] = 'taxType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cess_rate
+        gst_rate
+        tax_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cess_rate: SKIP, gst_rate: SKIP, tax_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cess_rate = cess_rate unless cess_rate == SKIP
+      @gst_rate = gst_rate unless gst_rate == SKIP
+      @tax_type = tax_type unless tax_type == 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.
+      cess_rate = hash.key?('cessRate') ? hash['cessRate'] : SKIP
+      gst_rate = hash.key?('gstRate') ? hash['gstRate'] : SKIP
+      tax_type = hash.key?('taxType') ? hash['taxType'] : 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.
+      TaxRate.new(cess_rate: cess_rate,
+                  gst_rate: gst_rate,
+                  tax_type: tax_type,
+                  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} cess_rate: #{@cess_rate}, gst_rate: #{@gst_rate}, tax_type: #{@tax_type},"\
+      " 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} cess_rate: #{@cess_rate.inspect}, gst_rate: #{@gst_rate.inspect}, tax_type:"\
+      " #{@tax_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/token_endpoint_auth_method.rb

@@ -0,0 +1,41 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # `none` for public clients (PKCE), `client_secret_post`/`client_secret_basic`
+  # for confidential.
+  class TokenEndpointAuthMethod
+    TOKEN_ENDPOINT_AUTH_METHOD = [
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze,
+
+      # TODO: Write general description for CLIENT_SECRET_POST
+      CLIENT_SECRET_POST = 'client_secret_post'.freeze,
+
+      # TODO: Write general description for CLIENT_SECRET_BASIC
+      CLIENT_SECRET_BASIC = 'client_secret_basic'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TOKEN_ENDPOINT_AUTH_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'client_secret_post' then CLIENT_SECRET_POST
+      when 'client_secret_basic' then CLIENT_SECRET_BASIC
+      else
+        default_value
+      end
+    end
+  end
+end