module Bugsnag::Api::Client::Projects

Methods for the Projects API

@see docs.bugsnagapiv2.apiary.io/#reference/projects

Public Instance Methods

create_project(org_id, name, type, options = {}) click to toggle source

Create a Project in an Organization

@return [Sawyer::Resource] New Project @see docs.bugsnagapiv2.apiary.io/#reference/projects/projects/create-a-project-in-an-organization

# File lib/bugsnag/api/client/projects.rb, line 13
def create_project(org_id, name, type, options = {})
  post "organizations/#{org_id}/projects", options.merge({:name => name, :type => type})
end
delete_project(id, options = {}) click to toggle source

Delete a Project

@return @see docs.bugsnagapiv2.apiary.io/#reference/organizations/organizations/delete-an-organization

# File lib/bugsnag/api/client/projects.rb, line 55
def delete_project(id, options = {})
  boolean_from_response :delete, "projects/#{id}", options
end
project(id, options = {}) click to toggle source

View a Project

@return [Sawyer::Resource] Requested Project @see docs.bugsnagapiv2.apiary.io/#reference/projects/projects/view-a-project

# File lib/bugsnag/api/client/projects.rb, line 21
def project(id, options = {})
  get "projects/#{id}", options
end
regenerate_api_key(id, options = {}) click to toggle source

Regenerate a Project’s notifier API key

@return @see docs.bugsnagapiv2.apiary.io/#reference/projects/projects/regenerate-a-project’s-notifier-api-key

# File lib/bugsnag/api/client/projects.rb, line 47
def regenerate_api_key(id, options = {})
  delete "projects/#{id}/api_key", options
end
update_project(id, options = {}) click to toggle source

Update a Project

@option name [String] A name for the project @option global_grouping [Array<String>] A list of error classes, which will be grouped by class @option location_grouping [Array<String>] A list of error classes, which will be grouped by context @option discarded_app_versions [Array<String>] A list of app versions whose events will be ignored @option discarded_errors [Array<String>] A list of error classes that will be ignored @option url_whitelist [Array<String>] If configured only errors from whitelisted URLs will be processed @option ignore_old_browsers [Boolean] Set to ignore events from old web browsers @option ignored_browser_versions [Object] A mapping of browser name to ignored versions @option resolve_on_deploy [Boolean] Set all errors to resolved once a new deployment has been notified @option collaborator_ids [Array<String>] Update the collaborators in the project to only these ids @return [Sawyer::Resource] Updated Project @see docs.bugsnagapiv2.apiary.io/#reference/projects/projects/update-a-project

# File lib/bugsnag/api/client/projects.rb, line 39
def update_project(id, options = {})
  patch "projects/#{id}", options
end