require 'peddler/client'

module MWS
  # The Recommendations API enables you to programmatically retrieve Amazon
  # Selling Coach recommendations by recommendation category. A recommendation
  # is an actionable, timely, and personalized opportunity to increase your
  # sales and performance.
  class Recommendations < ::Peddler::Client
    path 'Recommendations/2013-04-01'

    # Checks whether there are active recommendations for each category for the
    # given marketplace, and if there are, returns the time when recommendations
    # were last updated for each category
    #
    # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_GetLastUpdatedTimeForRecommendations.html
    # @param marketplace_id [String]
    # @return [Peddler::XMLParser]
    def get_last_updated_time_for_recommendations(marketplace_id = marketplace_id)
      operation('GetLastUpdatedTimeForRecommendations')
        .add('MarketplaceId' => marketplace_id)

      run
    end

    # Lists active recommendations for a specific category or for all categories
    # for a specific marketplace
    #
    # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendations.html
    # @overload list_recommendations(opts = { marketplace_id: marketplace_id })
    #   @param opts [Hash]
    #   @option opts [String] :marketplace_id
    #   @option opts [String] :recommendation_category
    #   @option opts [String] :category_query_list
    # @return [Peddler::XMLParser]
    def list_recommendations(opts = {})
      opts[:marketplace_id] ||= marketplace_id

      operation('ListRecommendations')
        .add(opts)
        .structure!('CategoryQueryList', 'CategoryQuery', '1', 'FilterOptions', 'FilterOption')

      run
    end

    # Lists the next page of active recommendations
    #
    # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendationsByNextToken.html
    # @param next_token [String]
    # @return [Peddler::XMLParser]
    def list_recommendations_by_next_token(next_token)
      operation('ListRecommendationsByNextToken')
        .add('NextToken' => next_token)

      run
    end

    # Gets the service status of the API
    #
    # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_GetServiceStatus.html
    # @return [Peddler::XMLParser]
    def get_service_status
      operation('GetServiceStatus')
      run
    end
  end
end