walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/competitive_pricing_type.rb

@@ -0,0 +1,113 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Competitive pricing information for the item.
+  class CompetitivePricingType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of competitive pricing information.
+    # @return [Array[CompetitivePriceType]]
+    attr_accessor :competitive_prices
+
+    # The number of active offer listings for the item, by condition.
+    # @return [Array[OfferListingCountType]]
+    attr_accessor :number_of_offer_listings
+
+    # Currency type and monetary value.
+    # @return [MoneyType]
+    attr_accessor :trade_in_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['competitive_prices'] = 'CompetitivePrices'
+      @_hash['number_of_offer_listings'] = 'NumberOfOfferListings'
+      @_hash['trade_in_value'] = 'TradeInValue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trade_in_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(competitive_prices:, number_of_offer_listings:,
+                   trade_in_value: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @competitive_prices = competitive_prices
+      @number_of_offer_listings = number_of_offer_listings
+      @trade_in_value = trade_in_value unless trade_in_value == 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
+      competitive_prices = nil
+      unless hash['CompetitivePrices'].nil?
+        competitive_prices = []
+        hash['CompetitivePrices'].each do |structure|
+          competitive_prices << (CompetitivePriceType.from_hash(structure) if structure)
+        end
+      end
+
+      competitive_prices = nil unless hash.key?('CompetitivePrices')
+      # Parameter is an array, so we need to iterate through it
+      number_of_offer_listings = nil
+      unless hash['NumberOfOfferListings'].nil?
+        number_of_offer_listings = []
+        hash['NumberOfOfferListings'].each do |structure|
+          number_of_offer_listings << (OfferListingCountType.from_hash(structure) if structure)
+        end
+      end
+
+      number_of_offer_listings = nil unless hash.key?('NumberOfOfferListings')
+      trade_in_value = MoneyType.from_hash(hash['TradeInValue']) if hash['TradeInValue']
+
+      # 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.
+      CompetitivePricingType.new(competitive_prices: competitive_prices,
+                                 number_of_offer_listings: number_of_offer_listings,
+                                 trade_in_value: trade_in_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} competitive_prices: #{@competitive_prices}, number_of_offer_listings:"\
+      " #{@number_of_offer_listings}, trade_in_value: #{@trade_in_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} competitive_prices: #{@competitive_prices.inspect},"\
+      " number_of_offer_listings: #{@number_of_offer_listings.inspect}, trade_in_value:"\
+      " #{@trade_in_value.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/competitive_summary_batch_request.rb

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

data/lib/walmart_ap_is/models/competitive_summary_batch_response.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The response schema for the getCompetitiveSummary operation.
+  class CompetitiveSummaryBatchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A batched list of competitive summary responses.
+    # @return [Array[CompetitiveSummaryResponse]]
+    attr_accessor :responses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['responses'] = 'responses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        responses
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(responses: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @responses = responses unless responses == 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
+      responses = nil
+      unless hash['responses'].nil?
+        responses = []
+        hash['responses'].each do |structure|
+          responses << (CompetitiveSummaryResponse.from_hash(structure) if structure)
+        end
+      end
+
+      responses = SKIP unless hash.key?('responses')
+
+      # 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.
+      CompetitiveSummaryBatchResponse.new(responses: responses,
+                                          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} responses: #{@responses}, 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} responses: #{@responses.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/competitive_summary_request.rb

@@ -0,0 +1,92 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # An individual competitive summary request.
+  class CompetitiveSummaryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Walmart Item ID of the item (see ADR-029).
+    # @return [String]
+    attr_accessor :walmart_item_id
+
+    # A marketplace identifier.
+    # @return [String]
+    attr_accessor :marketplace_id
+
+    # The list of requested competitive pricing data for the product.
+    # @return [Array[IncludedDatum2]]
+    attr_accessor :included_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['walmart_item_id'] = 'walmartItemId'
+      @_hash['marketplace_id'] = 'marketplaceId'
+      @_hash['included_data'] = 'includedData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(walmart_item_id:, marketplace_id:, included_data:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @walmart_item_id = walmart_item_id
+      @marketplace_id = marketplace_id
+      @included_data = included_data
+      @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.
+      walmart_item_id = hash.key?('walmartItemId') ? hash['walmartItemId'] : nil
+      marketplace_id = hash.key?('marketplaceId') ? hash['marketplaceId'] : nil
+      included_data = hash.key?('includedData') ? hash['includedData'] : 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.
+      CompetitiveSummaryRequest.new(walmart_item_id: walmart_item_id,
+                                    marketplace_id: marketplace_id,
+                                    included_data: included_data,
+                                    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} walmart_item_id: #{@walmart_item_id}, marketplace_id: #{@marketplace_id},"\
+      " included_data: #{@included_data}, 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} walmart_item_id: #{@walmart_item_id.inspect}, marketplace_id:"\
+      " #{@marketplace_id.inspect}, included_data: #{@included_data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/competitive_summary_response.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # An individual competitive summary response.
+  class CompetitiveSummaryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The HTTP status line associated with the response.
+    # @return [GetOffersHttpStatusLine]
+    attr_accessor :status
+
+    # The body of a competitive summary response.
+    # @return [CompetitiveSummaryResponseBody]
+    attr_accessor :body
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['body'] = 'body'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        body
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, body: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @body = body unless body == 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.
+      status = GetOffersHttpStatusLine.from_hash(hash['status']) if hash['status']
+      body = CompetitiveSummaryResponseBody.from_hash(hash['body']) if hash['body']
+
+      # 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.
+      CompetitiveSummaryResponse.new(status: status,
+                                     body: body,
+                                     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} status: #{@status}, body: #{@body}, 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} status: #{@status.inspect}, body: #{@body.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/competitive_summary_response_body.rb

@@ -0,0 +1,122 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The body of a competitive summary response.
+  class CompetitiveSummaryResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Walmart Item ID of the item.
+    # @return [String]
+    attr_accessor :walmart_item_id
+
+    # A marketplace identifier.
+    # @return [String]
+    attr_accessor :marketplace_id
+
+    # A list of featured buying options.
+    # @return [Array[Object]]
+    attr_accessor :featured_buying_options
+
+    # A list of lowest priced offers by condition.
+    # @return [Array[Object]]
+    attr_accessor :lowest_priced_offers
+
+    # A list of reference prices.
+    # @return [Array[Object]]
+    attr_accessor :reference_prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['walmart_item_id'] = 'walmartItemId'
+      @_hash['marketplace_id'] = 'marketplaceId'
+      @_hash['featured_buying_options'] = 'featuredBuyingOptions'
+      @_hash['lowest_priced_offers'] = 'lowestPricedOffers'
+      @_hash['reference_prices'] = 'referencePrices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        walmart_item_id
+        marketplace_id
+        featured_buying_options
+        lowest_priced_offers
+        reference_prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(walmart_item_id: SKIP, marketplace_id: SKIP,
+                   featured_buying_options: SKIP, lowest_priced_offers: SKIP,
+                   reference_prices: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @walmart_item_id = walmart_item_id unless walmart_item_id == SKIP
+      @marketplace_id = marketplace_id unless marketplace_id == SKIP
+      @featured_buying_options = featured_buying_options unless featured_buying_options == SKIP
+      @lowest_priced_offers = lowest_priced_offers unless lowest_priced_offers == SKIP
+      @reference_prices = reference_prices unless reference_prices == 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.
+      walmart_item_id =
+        hash.key?('walmartItemId') ? hash['walmartItemId'] : SKIP
+      marketplace_id = hash.key?('marketplaceId') ? hash['marketplaceId'] : SKIP
+      featured_buying_options =
+        hash.key?('featuredBuyingOptions') ? hash['featuredBuyingOptions'] : SKIP
+      lowest_priced_offers =
+        hash.key?('lowestPricedOffers') ? hash['lowestPricedOffers'] : SKIP
+      reference_prices =
+        hash.key?('referencePrices') ? hash['referencePrices'] : 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.
+      CompetitiveSummaryResponseBody.new(walmart_item_id: walmart_item_id,
+                                         marketplace_id: marketplace_id,
+                                         featured_buying_options: featured_buying_options,
+                                         lowest_priced_offers: lowest_priced_offers,
+                                         reference_prices: reference_prices,
+                                         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} walmart_item_id: #{@walmart_item_id}, marketplace_id: #{@marketplace_id},"\
+      " featured_buying_options: #{@featured_buying_options}, lowest_priced_offers:"\
+      " #{@lowest_priced_offers}, reference_prices: #{@reference_prices}, 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} walmart_item_id: #{@walmart_item_id.inspect}, marketplace_id:"\
+      " #{@marketplace_id.inspect}, featured_buying_options: #{@featured_buying_options.inspect},"\
+      " lowest_priced_offers: #{@lowest_priced_offers.inspect}, reference_prices:"\
+      " #{@reference_prices.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/compliance_detail.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains item identifiers and related tax information.
+  class ComplianceDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant SKU, a merchant-supplied identifier for a specific SKU.
+    # @return [String]
+    attr_accessor :msku
+
+    # Information used to determine the tax compliance.
+    # @return [TaxDetails]
+    attr_accessor :tax_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['msku'] = 'msku'
+      @_hash['tax_details'] = 'taxDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        msku
+        tax_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(msku: SKIP, tax_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @msku = msku unless msku == SKIP
+      @tax_details = tax_details unless tax_details == 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.
+      msku = hash.key?('msku') ? hash['msku'] : SKIP
+      tax_details = TaxDetails.from_hash(hash['taxDetails']) if hash['taxDetails']
+
+      # 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.
+      ComplianceDetail.new(msku: msku,
+                           tax_details: tax_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} msku: #{@msku}, tax_details: #{@tax_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} msku: #{@msku.inspect}, tax_details: #{@tax_details.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/compression_algorithm.rb

@@ -0,0 +1,26 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Compression applied to the document; decompress before parsing if present
+  class CompressionAlgorithm
+    COMPRESSION_ALGORITHM = [
+      # TODO: Write general description for GZIP
+      GZIP = 'GZIP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      COMPRESSION_ALGORITHM.include?(value)
+    end
+
+    def self.from_value(value, default_value = GZIP)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end