class Freshdesk::Api::Client::Solution

Constants

ARTICLES
CATEGORIES
FOLDERS

Public Class Methods

new(base_url, api_key) click to toggle source

Initialize with your freshdesk account url and api key.

# File lib/freshdesk/api/client/solution.rb, line 12
def initialize base_url, api_key
        @connection = Freshdesk::Api::Client::Request.new base_url, api_key
end

Public Instance Methods

create_article(category_id, topic_id, payload) click to toggle source

Create article by passing its id. Please refer freshdesk.com/api#solution-category

# File lib/freshdesk/api/client/solution.rb, line 28
def create_article category_id, topic_id, payload
        Freshdesk::Api::Client.convert_to_hash( @connection.post ARTICLES, payload, category_id, topic_id, "create_article" )
end
create_category(payload) click to toggle source

Create category by passing its id. Please refer freshdesk.com/api#solution-category

# File lib/freshdesk/api/client/solution.rb, line 17
def create_category payload
        Freshdesk::Api::Client.convert_to_hash( @connection.post CATEGORIES, payload )
end
create_folder(category_id, payload) click to toggle source

Create folder by passing its id. Please refer freshdesk.com/api#solution-category

# File lib/freshdesk/api/client/solution.rb, line 23
def create_folder category_id, payload
        Freshdesk::Api::Client.convert_to_hash( @connection.post FOLDERS, payload, category_id, nil, "create_folder" )
end
delete_category(id) click to toggle source

Delete category by its id.

# File lib/freshdesk/api/client/solution.rb, line 63
def delete_category id
        Freshdesk::Api::Client.delete_status_wrapper do
                ( @connection.delete CATEGORIES, id, "delete_category" ).code
        end
end
delete_folder(category_id, id) click to toggle source

Delete folder by category id and folder id.

# File lib/freshdesk/api/client/solution.rb, line 70
def delete_folder category_id, id
        Freshdesk::Api::Client.delete_status_wrapper do
                ( @connection.delete FOLDERS, category_id, id, "delete_folder" ).code
        end
end
get_article(id) click to toggle source

Get article by its id.

# File lib/freshdesk/api/client/solution.rb, line 43
def get_article id
        Freshdesk::Api::Client.convert_to_hash( @connection.get ARTICLES, id )
end
get_category(id) click to toggle source

Get category by its id.

# File lib/freshdesk/api/client/solution.rb, line 33
def get_category id
        Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES, id )
end
get_folder(id) click to toggle source

Get folder by its id.

# File lib/freshdesk/api/client/solution.rb, line 38
def get_folder id
        Freshdesk::Api::Client.convert_to_hash( @connection.get FOLDERS, id )
end
list_articles(category_id, folder_id) click to toggle source

List all articles by passing the category id and folder id together.

# File lib/freshdesk/api/client/solution.rb, line 48
def list_articles category_id, folder_id
        Freshdesk::Api::Client.convert_to_hash( @connection.get ARTICLES, category_id, nil, folder_id, "list_articles" )
end
list_categories() click to toggle source

List all categories.

# File lib/freshdesk/api/client/solution.rb, line 58
def list_categories 
        Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES )
end
list_folders(category_id) click to toggle source

List all folders by it category id.

# File lib/freshdesk/api/client/solution.rb, line 53
def list_folders category_id
        Freshdesk::Api::Client.convert_to_hash( @connection.get FOLDERS, category_id, nil, nil,  "list_folders" )
end