class ForemanApi::Resources::Bookmark

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/bookmark.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["bookmarks"]
end

Public Instance Methods

create(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [Hash] bookmark

allowed keys are:
* controller [String]
* name [String]
* public [String]
* query [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/bookmark.rb, line 37
def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
destroy(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/bookmark.rb, line 61
def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
index(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] page Paginate results @option params [String] per_page Number of entries per request

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/bookmark.rb, line 14
def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
show(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/bookmark.rb, line 23
def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
update(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id @option params [Hash] bookmark

allowed keys are:
* controller [String]
* name [String]
* public [String]
* query [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/bookmark.rb, line 52
def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end