Module: BacklogKit::Client::Issue

Included in:
BacklogKit::Client
Defined in:
lib/backlog_kit/client/issue.rb

Overview

Methods for the Issue API

Instance Method Summary collapse

Instance Method Details

#add_comment(issue_id_or_key, content, params = {}) ⇒ BacklogKit::Response

Add a comment to an issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • content (String) —

    Content of the comment

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



90
91
92
93
 
# File 'lib/backlog_kit/client/issue.rb', line 90

def add_comment(issue_id_or_key, content, params = {})
  params.merge!(content: content)
  post("issues/#{issue_id_or_key}/comments", params)
end

#add_comment_notification(issue_id_or_key, comment_id, notified_user_ids = []) ⇒ BacklogKit::Response

Add notifications to an comment

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • comment_id (Integer, String) —

    Comment id

  • notified_user_ids (Array) (defaults to: []) —

    List of notified user ids

Returns:



120
121
122
 
# File 'lib/backlog_kit/client/issue.rb', line 120

def add_comment_notification(issue_id_or_key, comment_id, notified_user_ids = [])
  post("issues/#{issue_id_or_key}/comments/#{comment_id}/notifications", notified_user_id: notified_user_ids)
end

#create_issue(summary, params = {}) ⇒ BacklogKit::Response

Create a new issue

Parameters:

  • summary (String) —

    Summary of the issue

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



36
37
38
39
 
# File 'lib/backlog_kit/client/issue.rb', line 36

def create_issue(summary, params = {})
  params.merge!(summary: summary)
  post('issues', params)
end

#delete_issue(issue_id_or_key) ⇒ BacklogKit::Response

Delete an issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

Returns:



54
55
56
 
# File 'lib/backlog_kit/client/issue.rb', line 54

def delete_issue(issue_id_or_key)
  delete("issues/#{issue_id_or_key}")
end

#download_issue_attachment(issue_id_or_key, attachment_id) ⇒ BacklogKit::Response

Download an attachment file on issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • attachment_id (Integer, String) —

    Attachment file id

Returns:



137
138
139
 
# File 'lib/backlog_kit/client/issue.rb', line 137

def download_issue_attachment(issue_id_or_key, attachment_id)
  get("issues/#{issue_id_or_key}/attachments/#{attachment_id}")
end

#get_comment(issue_id_or_key, comment_id) ⇒ BacklogKit::Response

Get a comment in issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • comment_id (Integer, String) —

    Comment id

Returns:



80
81
82
 
# File 'lib/backlog_kit/client/issue.rb', line 80

def get_comment(issue_id_or_key, comment_id)
  get("issues/#{issue_id_or_key}/comments/#{comment_id}")
end

#get_comment_count(issue_id_or_key) ⇒ BacklogKit::Response

Get number of comments in issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

Returns:



71
72
73
 
# File 'lib/backlog_kit/client/issue.rb', line 71

def get_comment_count(issue_id_or_key)
  get("issues/#{issue_id_or_key}/comments/count")
end

#get_comment_notifications(issue_id_or_key, comment_id) ⇒ BacklogKit::Response

Get list of comment notifications

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • comment_id (Integer, String) —

    Comment id

Returns:



110
111
112
 
# File 'lib/backlog_kit/client/issue.rb', line 110

def get_comment_notifications(issue_id_or_key, comment_id)
  get("issues/#{issue_id_or_key}/comments/#{comment_id}/notifications")
end

#get_comments(issue_id_or_key, params = {}) ⇒ BacklogKit::Response

Get list of comments in issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



63
64
65
 
# File 'lib/backlog_kit/client/issue.rb', line 63

def get_comments(issue_id_or_key, params = {})
  get("issues/#{issue_id_or_key}/comments", params)
end

#get_issue(issue_id_or_key) ⇒ BacklogKit::Response

Get an issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

Returns:



27
28
29
 
# File 'lib/backlog_kit/client/issue.rb', line 27

def get_issue(issue_id_or_key)
  get("issues/#{issue_id_or_key}")
end

#get_issue_attachments(issue_id_or_key) ⇒ BacklogKit::Response

Get list of attachment files on issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

Returns:



128
129
130
 
# File 'lib/backlog_kit/client/issue.rb', line 128

def get_issue_attachments(issue_id_or_key)
  get("issues/#{issue_id_or_key}/attachments")
end

#get_issue_count(params = {}) ⇒ BacklogKit::Response

Get number of issues

Parameters:

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



19
20
21
 
# File 'lib/backlog_kit/client/issue.rb', line 19

def get_issue_count(params = {})
  get('issues/count', params)
end

#get_issue_shared_files(issue_id_or_key) ⇒ BacklogKit::Response

Get list of shared files on issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

Returns:



154
155
156
 
# File 'lib/backlog_kit/client/issue.rb', line 154

def get_issue_shared_files(issue_id_or_key)
  get("issues/#{issue_id_or_key}/sharedFiles")
end

#get_issues(params = {}) ⇒ BacklogKit::Response

Get list of issues

Parameters:

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



11
12
13
 
# File 'lib/backlog_kit/client/issue.rb', line 11

def get_issues(params = {})
  get('issues', params)
end

#link_issue_shared_files(issue_id_or_key, file_ids = []) ⇒ BacklogKit::Response

Link shared files to an issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • file_ids (Array) (defaults to: []) —

    List of file ids

Returns:



163
164
165
 
# File 'lib/backlog_kit/client/issue.rb', line 163

def link_issue_shared_files(issue_id_or_key, file_ids = [])
  post("issues/#{issue_id_or_key}/sharedFiles", file_id: file_ids)
end

#remove_issue_attachment(issue_id_or_key, attachment_id) ⇒ BacklogKit::Response

Remove an attachment file from issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • attachment_id (Integer, String) —

    Attachment file id

Returns:



146
147
148
 
# File 'lib/backlog_kit/client/issue.rb', line 146

def remove_issue_attachment(issue_id_or_key, attachment_id)
  delete("issues/#{issue_id_or_key}/attachments/#{attachment_id}")
end

#unlink_issue_shared_file(issue_id_or_key, file_id) ⇒ BacklogKit::Response

Unlink a shared file on issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • file_id (Integer, String) —

    Shared file id

Returns:



172
173
174
 
# File 'lib/backlog_kit/client/issue.rb', line 172

def unlink_issue_shared_file(issue_id_or_key, file_id)
  delete("issues/#{issue_id_or_key}/sharedFiles/#{file_id}")
end

#update_comment(issue_id_or_key, comment_id, content) ⇒ BacklogKit::Response

Update a comment in issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • comment_id (Integer, String) —

    Comment id

  • content (String) —

    Content of the comment

Returns:



101
102
103
 
# File 'lib/backlog_kit/client/issue.rb', line 101

def update_comment(issue_id_or_key, comment_id, content)
  patch("issues/#{issue_id_or_key}/comments/#{comment_id}", content: content)
end

#update_issue(issue_id_or_key, params = {}) ⇒ BacklogKit::Response

Update an issue

Parameters:

  • issue_id_or_key (Integer, String) —

    Issue id or Issue key

  • params (Hash) (defaults to: {}) —

    Request parameters

Returns:



46
47
48
 
# File 'lib/backlog_kit/client/issue.rb', line 46

def update_issue(issue_id_or_key, params = {})
  patch("issues/#{issue_id_or_key}", params)
end