walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/fee_detail.rb

@@ -0,0 +1,113 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Detail for a single fee component. May nest sub-fees in
+  # IncludedFeeDetailList. Mirrors SP-API FeeDetail.
+  class FeeDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fee type, e.g. ReferralFee, WFSFulfillmentFee, VariableClosingFee.
+    # @return [String]
+    attr_accessor :fee_type
+
+    # Currency amount.
+    # @return [MoneyType1]
+    attr_accessor :fee_amount
+
+    # Currency amount.
+    # @return [MoneyType1]
+    attr_accessor :fee_promotion
+
+    # Currency amount.
+    # @return [MoneyType1]
+    attr_accessor :tax_amount
+
+    # Currency amount.
+    # @return [MoneyType1]
+    attr_accessor :final_fee
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fee_type'] = 'FeeType'
+      @_hash['fee_amount'] = 'FeeAmount'
+      @_hash['fee_promotion'] = 'FeePromotion'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['final_fee'] = 'FinalFee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_promotion
+        tax_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fee_type:, fee_amount:, final_fee:, fee_promotion: SKIP,
+                   tax_amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fee_type = fee_type
+      @fee_amount = fee_amount
+      @fee_promotion = fee_promotion unless fee_promotion == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @final_fee = final_fee
+      @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.
+      fee_type = hash.key?('FeeType') ? hash['FeeType'] : nil
+      fee_amount = MoneyType1.from_hash(hash['FeeAmount']) if hash['FeeAmount']
+      final_fee = MoneyType1.from_hash(hash['FinalFee']) if hash['FinalFee']
+      fee_promotion = MoneyType1.from_hash(hash['FeePromotion']) if hash['FeePromotion']
+      tax_amount = MoneyType1.from_hash(hash['TaxAmount']) if hash['TaxAmount']
+
+      # 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.
+      FeeDetail.new(fee_type: fee_type,
+                    fee_amount: fee_amount,
+                    final_fee: final_fee,
+                    fee_promotion: fee_promotion,
+                    tax_amount: tax_amount,
+                    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} fee_type: #{@fee_type}, fee_amount: #{@fee_amount}, fee_promotion:"\
+      " #{@fee_promotion}, tax_amount: #{@tax_amount}, final_fee: #{@final_fee},"\
+      " 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} fee_type: #{@fee_type.inspect}, fee_amount: #{@fee_amount.inspect},"\
+      " fee_promotion: #{@fee_promotion.inspect}, tax_amount: #{@tax_amount.inspect}, final_fee:"\
+      " #{@final_fee.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/feed.rb

@@ -0,0 +1,182 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Feed Model.
+  class Feed < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this feed
+    # @return [String]
+    attr_accessor :feed_id
+
+    # The type of feed submitted (e.g. LISTINGS_FEED, INVENTORY_FEED)
+    # @return [String]
+    attr_accessor :feed_type
+
+    # Marketplace the feed was submitted to (e.g. WALMART_US)
+    # @return [String]
+    attr_accessor :marketplace_id
+
+    # Timestamp when the feed was received by the server
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Timestamp when feed processing began; absent until processing starts
+    # @return [DateTime]
+    attr_accessor :processing_started_at
+
+    # Timestamp when feed processing finished; absent until complete
+    # @return [DateTime]
+    attr_accessor :processing_completed_at
+
+    # Current processing status of the feed
+    # @return [ProcessingStatus1]
+    attr_accessor :processing_status
+
+    # ID of the result document; present only when processingStatus is DONE. Use
+    # with GET /feeds/v4/feeds/{feedId}/document.
+    # @return [String]
+    attr_accessor :result_feed_document_id
+
+    # Record-level processing counts; present only when processingStatus is DONE
+    # @return [FeedProcessingSummary]
+    attr_accessor :feed_processing_summary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['feed_id'] = 'feedId'
+      @_hash['feed_type'] = 'feedType'
+      @_hash['marketplace_id'] = 'marketplaceId'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['processing_started_at'] = 'processingStartedAt'
+      @_hash['processing_completed_at'] = 'processingCompletedAt'
+      @_hash['processing_status'] = 'processingStatus'
+      @_hash['result_feed_document_id'] = 'resultFeedDocumentId'
+      @_hash['feed_processing_summary'] = 'feedProcessingSummary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marketplace_id
+        processing_started_at
+        processing_completed_at
+        result_feed_document_id
+        feed_processing_summary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(feed_id:, feed_type:, created_at:, processing_status:,
+                   marketplace_id: SKIP, processing_started_at: SKIP,
+                   processing_completed_at: SKIP, result_feed_document_id: SKIP,
+                   feed_processing_summary: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @feed_id = feed_id
+      @feed_type = feed_type
+      @marketplace_id = marketplace_id unless marketplace_id == SKIP
+      @created_at = created_at
+      @processing_started_at = processing_started_at unless processing_started_at == SKIP
+      @processing_completed_at = processing_completed_at unless processing_completed_at == SKIP
+      @processing_status = processing_status
+      @result_feed_document_id = result_feed_document_id unless result_feed_document_id == SKIP
+      @feed_processing_summary = feed_processing_summary unless feed_processing_summary == 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.
+      feed_id = hash.key?('feedId') ? hash['feedId'] : nil
+      feed_type = hash.key?('feedType') ? hash['feedType'] : nil
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   end
+      processing_status =
+        hash.key?('processingStatus') ? hash['processingStatus'] : nil
+      marketplace_id = hash.key?('marketplaceId') ? hash['marketplaceId'] : SKIP
+      processing_started_at = if hash.key?('processingStartedAt')
+                                (DateTimeHelper.from_rfc3339(hash['processingStartedAt']) if hash['processingStartedAt'])
+                              else
+                                SKIP
+                              end
+      processing_completed_at = if hash.key?('processingCompletedAt')
+                                  (DateTimeHelper.from_rfc3339(hash['processingCompletedAt']) if hash['processingCompletedAt'])
+                                else
+                                  SKIP
+                                end
+      result_feed_document_id =
+        hash.key?('resultFeedDocumentId') ? hash['resultFeedDocumentId'] : SKIP
+      feed_processing_summary = FeedProcessingSummary.from_hash(hash['feedProcessingSummary']) if
+        hash['feedProcessingSummary']
+
+      # 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.
+      Feed.new(feed_id: feed_id,
+               feed_type: feed_type,
+               created_at: created_at,
+               processing_status: processing_status,
+               marketplace_id: marketplace_id,
+               processing_started_at: processing_started_at,
+               processing_completed_at: processing_completed_at,
+               result_feed_document_id: result_feed_document_id,
+               feed_processing_summary: feed_processing_summary,
+               additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_processing_started_at
+      DateTimeHelper.to_rfc3339(processing_started_at)
+    end
+
+    def to_custom_processing_completed_at
+      DateTimeHelper.to_rfc3339(processing_completed_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} feed_id: #{@feed_id}, feed_type: #{@feed_type}, marketplace_id:"\
+      " #{@marketplace_id}, created_at: #{@created_at}, processing_started_at:"\
+      " #{@processing_started_at}, processing_completed_at: #{@processing_completed_at},"\
+      " processing_status: #{@processing_status}, result_feed_document_id:"\
+      " #{@result_feed_document_id}, feed_processing_summary: #{@feed_processing_summary},"\
+      " 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} feed_id: #{@feed_id.inspect}, feed_type: #{@feed_type.inspect},"\
+      " marketplace_id: #{@marketplace_id.inspect}, created_at: #{@created_at.inspect},"\
+      " processing_started_at: #{@processing_started_at.inspect}, processing_completed_at:"\
+      " #{@processing_completed_at.inspect}, processing_status: #{@processing_status.inspect},"\
+      " result_feed_document_id: #{@result_feed_document_id.inspect}, feed_processing_summary:"\
+      " #{@feed_processing_summary.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/feed_document.rb

@@ -0,0 +1,97 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FeedDocument Model.
+  class FeedDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this feed result document
+    # @return [String]
+    attr_accessor :feed_document_id
+
+    # Pre-signed URL to download the document (valid 15 minutes) — do not log
+    # @return [String]
+    attr_accessor :url
+
+    # Compression applied to the document; decompress before parsing if present
+    # @return [CompressionAlgorithm]
+    attr_accessor :compression_algorithm
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['feed_document_id'] = 'feedDocumentId'
+      @_hash['url'] = 'url'
+      @_hash['compression_algorithm'] = 'compressionAlgorithm'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        compression_algorithm
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(feed_document_id:, url:, compression_algorithm: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @feed_document_id = feed_document_id
+      @url = url
+      @compression_algorithm = compression_algorithm unless compression_algorithm == 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.
+      feed_document_id =
+        hash.key?('feedDocumentId') ? hash['feedDocumentId'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      compression_algorithm =
+        hash.key?('compressionAlgorithm') ? hash['compressionAlgorithm'] : 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.
+      FeedDocument.new(feed_document_id: feed_document_id,
+                       url: url,
+                       compression_algorithm: compression_algorithm,
+                       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} feed_document_id: #{@feed_document_id}, url: #{@url},"\
+      " compression_algorithm: #{@compression_algorithm}, 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} feed_document_id: #{@feed_document_id.inspect}, url: #{@url.inspect},"\
+      " compression_algorithm: #{@compression_algorithm.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/feed_processing_summary.rb

@@ -0,0 +1,120 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # FeedProcessingSummary Model.
+  class FeedProcessingSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total number of records in the submitted feed
+    # @return [Integer]
+    attr_accessor :total_record_count
+
+    # Number of records processed so far
+    # @return [Integer]
+    attr_accessor :processed_record_count
+
+    # Number of records processed successfully
+    # @return [Integer]
+    attr_accessor :success_count
+
+    # Number of records that failed processing
+    # @return [Integer]
+    attr_accessor :error_count
+
+    # Number of records processed with warnings
+    # @return [Integer]
+    attr_accessor :warning_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_record_count'] = 'totalRecordCount'
+      @_hash['processed_record_count'] = 'processedRecordCount'
+      @_hash['success_count'] = 'successCount'
+      @_hash['error_count'] = 'errorCount'
+      @_hash['warning_count'] = 'warningCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_record_count
+        processed_record_count
+        success_count
+        error_count
+        warning_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_record_count: SKIP, processed_record_count: SKIP,
+                   success_count: SKIP, error_count: SKIP, warning_count: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_record_count = total_record_count unless total_record_count == SKIP
+      @processed_record_count = processed_record_count unless processed_record_count == SKIP
+      @success_count = success_count unless success_count == SKIP
+      @error_count = error_count unless error_count == SKIP
+      @warning_count = warning_count unless warning_count == 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_record_count =
+        hash.key?('totalRecordCount') ? hash['totalRecordCount'] : SKIP
+      processed_record_count =
+        hash.key?('processedRecordCount') ? hash['processedRecordCount'] : SKIP
+      success_count = hash.key?('successCount') ? hash['successCount'] : SKIP
+      error_count = hash.key?('errorCount') ? hash['errorCount'] : SKIP
+      warning_count = hash.key?('warningCount') ? hash['warningCount'] : 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.
+      FeedProcessingSummary.new(total_record_count: total_record_count,
+                                processed_record_count: processed_record_count,
+                                success_count: success_count,
+                                error_count: error_count,
+                                warning_count: warning_count,
+                                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} total_record_count: #{@total_record_count}, processed_record_count:"\
+      " #{@processed_record_count}, success_count: #{@success_count}, error_count:"\
+      " #{@error_count}, warning_count: #{@warning_count}, 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_record_count: #{@total_record_count.inspect}, processed_record_count:"\
+      " #{@processed_record_count.inspect}, success_count: #{@success_count.inspect}, error_count:"\
+      " #{@error_count.inspect}, warning_count: #{@warning_count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/feed_status.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # feedStatus.
+  class FeedStatus
+    FEED_STATUS = [
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'RECEIVED'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # TODO: Write general description for DONE
+      DONE = 'DONE'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FEED_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'received' then RECEIVED
+      when 'in_progress' then IN_PROGRESS
+      when 'done' then DONE
+      when 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/feed_type.rb

@@ -0,0 +1,60 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # feedType.
+  class FeedType
+    FEED_TYPE = [
+      # TODO: Write general description for LISTINGS_FEED
+      LISTINGS_FEED = 'LISTINGS_FEED'.freeze,
+
+      # TODO: Write general description for INVENTORY_FEED
+      INVENTORY_FEED = 'INVENTORY_FEED'.freeze,
+
+      # TODO: Write general description for PRICING_FEED
+      PRICING_FEED = 'PRICING_FEED'.freeze,
+
+      # TODO: Write general description for ITEM_SETUP_FEED
+      ITEM_SETUP_FEED = 'ITEM_SETUP_FEED'.freeze,
+
+      # TODO: Write general description for ORDER_ACKNOWLEDGEMENT_FEED
+      ORDER_ACKNOWLEDGEMENT_FEED = 'ORDER_ACKNOWLEDGEMENT_FEED'.freeze,
+
+      # TODO: Write general description for ORDER_FULFILLMENT_FEED
+      ORDER_FULFILLMENT_FEED = 'ORDER_FULFILLMENT_FEED'.freeze,
+
+      # TODO: Write general description for ORDER_CANCELLATION_FEED
+      ORDER_CANCELLATION_FEED = 'ORDER_CANCELLATION_FEED'.freeze,
+
+      # TODO: Write general description for RETIRE_ITEM_FEED
+      RETIRE_ITEM_FEED = 'RETIRE_ITEM_FEED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FEED_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = LISTINGS_FEED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'listings_feed' then LISTINGS_FEED
+      when 'inventory_feed' then INVENTORY_FEED
+      when 'pricing_feed' then PRICING_FEED
+      when 'item_setup_feed' then ITEM_SETUP_FEED
+      when 'order_acknowledgement_feed' then ORDER_ACKNOWLEDGEMENT_FEED
+      when 'order_fulfillment_feed' then ORDER_FULFILLMENT_FEED
+      when 'order_cancellation_feed' then ORDER_CANCELLATION_FEED
+      when 'retire_item_feed' then RETIRE_ITEM_FEED
+      else
+        default_value
+      end
+    end
+  end
+end