class Freshdesk::Api::Client::Discussion
Constants
- CATEGORIES
- FORUMS
- POSTS
- TOPICS
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/discussion.rb, line 13 def initialize base_url, api_key @connection = Freshdesk::Api::Client::Request.new base_url, api_key end
Public Instance Methods
create_category(payload)
click to toggle source
Create a category by passing payload. Please refer freshdesk.com/api#forum
# File lib/freshdesk/api/client/discussion.rb, line 33 def create_category payload Freshdesk::Api::Client.convert_to_hash( @connection.post CATEGORIES, payload ) end
create_forum(payload)
click to toggle source
Create a forum by passing payload. Please refer freshdesk.com/api#forum
# File lib/freshdesk/api/client/discussion.rb, line 38 def create_forum payload Freshdesk::Api::Client.convert_to_hash( @connection.post FORUMS, payload ) end
create_post(topic_id, payload)
click to toggle source
Create a post by passing payload. Please refer freshdesk.com/api#forum
# File lib/freshdesk/api/client/discussion.rb, line 48 def create_post topic_id, payload Freshdesk::Api::Client.convert_to_hash( @connection.post POSTS, payload, topic_id, nil, "create_post" ) end
create_topic(payload)
click to toggle source
Create a topic by passing payload. Please refer freshdesk.com/api#forum
# File lib/freshdesk/api/client/discussion.rb, line 43 def create_topic payload Freshdesk::Api::Client.convert_to_hash( @connection.post TOPICS, payload ) end
delete_category(id)
click to toggle source
Delete category by passing its id.
# File lib/freshdesk/api/client/discussion.rb, line 58 def delete_category id Freshdesk::Api::Client.delete_status_wrapper do ( @connection.delete CATEGORIES, id ).code end end
delete_forum(id)
click to toggle source
Delete Forum by passing its id.
# File lib/freshdesk/api/client/discussion.rb, line 65 def delete_forum id Freshdesk::Api::Client.delete_status_wrapper do ( @connection.delete FORUMS, id ).code end end
delete_topic(id)
click to toggle source
Delete Post by passing its id. A Post cannot be deleted alone.
# File lib/freshdesk/api/client/discussion.rb, line 72 def delete_topic id Freshdesk::Api::Client.delete_status_wrapper do ( @connection.delete TOPICS, id ).code end end
get_category(id)
click to toggle source
Get category by passing its id.
# File lib/freshdesk/api/client/discussion.rb, line 18 def get_category id Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES, id ) end
get_forum(id)
click to toggle source
Get Forum by passing its id.
# File lib/freshdesk/api/client/discussion.rb, line 23 def get_forum id Freshdesk::Api::Client.convert_to_hash( @connection.get FORUMS, id ) end
get_topic(id)
click to toggle source
Get topic by passing its id.
# File lib/freshdesk/api/client/discussion.rb, line 28 def get_topic id Freshdesk::Api::Client.convert_to_hash( @connection.get TOPICS, id ) end
list_categories()
click to toggle source
Lists all categories
# File lib/freshdesk/api/client/discussion.rb, line 53 def list_categories Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES ) end