Module: Bugsnag::Api::Client::Comments

Included in:

Bugsnag::Api::Client

Defined in:

lib/bugsnag/api/client/comments.rb

Overview

Methods for the Errors API

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/comments

Instance Method Summary

• #comment(id, options = {}) ⇒ Sawyer::Resource

  View an Comment.

• #comments(project_id, error_id, options = {}) ⇒ Array<Sawyer::Resource>

  List Comments on an Error.

• #create_comment(project_id, error_id, message, options = {}) ⇒ Sawyer::Resource

  Create a Comment on an Error.

• #delete_comment(id, options = {}) ⇒ Object

  Delete a Comment.

• #update_comment(id, message, options = {}) ⇒ Sawyer::Resource

  Update a Comment.

Instance Method Details

#comment(id, options = {}) ⇒ Sawyer::Resource

View an Comment

Returns:

• (Sawyer::Resource) —

  Requested Comment

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/view-a-comment

# File 'lib/bugsnag/api/client/comments.rb', line 25

def comment(id, options = {})
  get "comments/#{id}", options
end

#comments(project_id, error_id, options = {}) ⇒ Array<Sawyer::Resource>

List Comments on an Error

Parameters:

• offset (Hash) —

  a customizable set of options

• sort (Hash) —

  a customizable set of options

• direction (Hash) —

  a customizable set of options

• per_page (Hash) —

  a customizable set of options

Returns:

• (Array<Sawyer::Resource>) —

  List of Error Comments

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/list-comments-on-an-error

# File 'lib/bugsnag/api/client/comments.rb', line 17

def comments(project_id, error_id, options = {})
  paginate "projects/#{project_id}/errors/#{error_id}/comments", options
end

#create_comment(project_id, error_id, message, options = {}) ⇒ Sawyer::Resource

Create a Comment on an Error

Returns:

• (Sawyer::Resource) —

  The new Comment

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/create-a-comment-on-an-error

# File 'lib/bugsnag/api/client/comments.rb', line 33

def create_comment(project_id, error_id, message, options = {})
  post "projects/#{project_id}/errors/#{error_id}/comments", options.merge({:message => message})
end

#delete_comment(id, options = {}) ⇒ Object

Delete a Comment

Returns:

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/delete-a-comment

# File 'lib/bugsnag/api/client/comments.rb', line 49

def delete_comment(id, options = {})
  boolean_from_response :delete, "comments/#{id}", options
end

#update_comment(id, message, options = {}) ⇒ Sawyer::Resource

Update a Comment

Returns:

• (Sawyer::Resource) —

  The updated Comment

See Also:

• http://docs.bugsnagapiv2.apiary.io/#reference/errors/comments/update-a-comment

# File 'lib/bugsnag/api/client/comments.rb', line 41

def update_comment(id, message, options = {})
  patch "comments/#{id}", options.merge({:message => message})
end