Contents

module ForemanApi
  module Resources
    class Setting < ForemanApi::Base
      def self.doc
        @doc ||= ForemanApi.doc['resources']["settings"]
      end
      
      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] order Sort results
      # @option params [String] page Paginate results
      # @option params [String] per_page Number of entries per request
      # @option params [String] search Filter results
      #
      # @param [Hash] headers additional http headers
      def index(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/settings", params
        call(:"get", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] id 
      #
      # @param [Hash] headers additional http headers
      def show(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/settings/:id", params
        call(:"get", url, params, headers)
      end

      # @param [Hash] params a hash of params to be passed to the service
      # @option params [String] id 
      # @option params [Hash] setting 
      #   allowed keys are: 
      #   * value [String],
      #
      # @param [Hash] headers additional http headers
      def update(params = { }, headers = { })
        check_params params, :allowed => true, :method => __method__
        url, params = fill_params_in_url "/api/settings/:id", params
        call(:"put", url, params, headers)
      end

    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
foreman_api-0.1.1	lib/foreman_api/resources/setting.rb
foreman_api-0.1.0	lib/foreman_api/resources/setting.rb