Class: HaloMspApi::Resources::KnowledgeBase

Inherits:
Base
  • Object
show all
Defined in:
lib/halo_msp_api/resources/knowledge_base.rb

Overview

Resource class for Knowledge Base

Instance Attribute Summary

Attributes inherited from Base

#client_instance

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from HaloMspApi::Resources::Base

Instance Method Details

#article(id, params = {}) ⇒ Object

GET /KBArticle/id - Get a specific Knowledge Base Article



13
14
15
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 13

def article(id, params = {})
  get_resource('KBArticle', id, params)
end

#articles(params = {}) ⇒ Object

GET /KBArticle - List of Knowledge Base Articles



8
9
10
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 8

def articles(params = {})
  list_resource('KBArticle', params)
end

#categories(params = {}) ⇒ Object

Knowledge Base Category methods GET /KBCategory - List Knowledge Base Categories



39
40
41
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 39

def categories(params = {})
  list_resource('KBCategory', params)
end

#category(id, params = {}) ⇒ Object

GET /KBCategory/id - Get specific Knowledge Base Category



44
45
46
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 44

def category(id, params = {})
  get_resource('KBCategory', id, params)
end

#create_article(data) ⇒ Object

POST /KBArticle - Create a new Knowledge Base Article



18
19
20
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 18

def create_article(data)
  create_resource('KBArticle', data)
end

#create_category(data) ⇒ Object

POST /KBCategory - Create Knowledge Base Category



49
50
51
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 49

def create_category(data)
  create_resource('KBCategory', data)
end

#create_keyword(data) ⇒ Object

POST /KBKeywords - Create Knowledge Base Keywords



75
76
77
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 75

def create_keyword(data)
  create_resource('KBKeywords', data)
end

#delete_article(id) ⇒ Object

DELETE /KBArticle/id - Delete a Knowledge Base Article



28
29
30
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 28

def delete_article(id)
  delete_resource('KBArticle', id)
end

#delete_category(id) ⇒ Object

DELETE /KBCategory/id - Delete Knowledge Base Category



59
60
61
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 59

def delete_category(id)
  delete_resource('KBCategory', id)
end

#delete_keyword(id) ⇒ Object

DELETE /KBKeywords/id - Delete Knowledge Base Keywords



85
86
87
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 85

def delete_keyword(id)
  delete_resource('KBKeywords', id)
end

#keyword(id, params = {}) ⇒ Object

GET /KBKeywords/id - Get specific Knowledge Base Keywords



70
71
72
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 70

def keyword(id, params = {})
  get_resource('KBKeywords', id, params)
end

#keywords(params = {}) ⇒ Object

Knowledge Base Keywords methods GET /KBKeywords - List Knowledge Base Keywords



65
66
67
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 65

def keywords(params = {})
  list_resource('KBKeywords', params)
end

#search_articles(params = {}) ⇒ Object

GET /KBArticle/Search - Search Knowledge Base Articles



33
34
35
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 33

def search_articles(params = {})
  get('KBArticle/Search', params)
end

#update_article(id, data) ⇒ Object

PUT /KBArticle/id - Update a Knowledge Base Article



23
24
25
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 23

def update_article(id, data)
  update_resource('KBArticle', id, data)
end

#update_category(id, data) ⇒ Object

PUT /KBCategory/id - Update Knowledge Base Category



54
55
56
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 54

def update_category(id, data)
  update_resource('KBCategory', id, data)
end

#update_keyword(id, data) ⇒ Object

PUT /KBKeywords/id - Update Knowledge Base Keywords



80
81
82
 
# File 'lib/halo_msp_api/resources/knowledge_base.rb', line 80

def update_keyword(id, data)
  update_resource('KBKeywords', id, data)
end