Module: SentryApi::Client::Teams

Included in:
SentryApi::Client
Defined in:
lib/sentry-api/client/teams.rb

Instance Method Summary collapse

Instance Method Details

#create_project(team_slug, options = {}) ⇒ SentryApi::ObjectifiedHash

Create a new project bound to a team.

Examples:

SentryApi.create_project('team-slug', {name:'team-name'})

Parameters:

  • team_slug (String) —

    the slug of the team

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

    A customizable set of options.

Options Hash (options):

  • :name (String) —

    the name for the new project.

  • :slug (String) —

    optionally a slug for the new project. If it’s not provided a slug is generated from the name.

Returns:



15
16
17
 
# File 'lib/sentry-api/client/teams.rb', line 15

def create_project(team_slug, options={})
  post("/teams/#{@default_org_slug}/#{team_slug}/projects/", body: options)
end

#delete_team(team_slug) ⇒ Object

Schedules a team for deletion

Examples:

SentryApi.delete_team('team-slug')

Parameters:

  • team_slug (String) —

    the slug of the team



25
26
27
 
# File 'lib/sentry-api/client/teams.rb', line 25

def delete_team(team_slug)
  delete("/teams/#{@default_org_slug}/#{team_slug}/")
end

#team(team_slug) ⇒ SentryApi::ObjectifiedHash

Return details on an individual team.

Examples:

SentryApi.team_projects('team-slug')

Parameters:

  • team_slug (String) —

    the slug of the team

Returns:



47
48
49
 
# File 'lib/sentry-api/client/teams.rb', line 47

def team(team_slug)
  get("/teams/#{@default_org_slug}/#{team_slug}/")
end

#team_projects(team_slug) ⇒ Array<SentryApi::ObjectifiedHash>

Return a list of projects bound to a team

Examples:

SentryApi.delete_team('team-slug')

Parameters:

  • team_slug (String) —

    the slug of the team

Returns:



36
37
38
 
# File 'lib/sentry-api/client/teams.rb', line 36

def team_projects(team_slug)
  get("/teams/#{@default_org_slug}/#{team_slug}/projects/")
end

#update_team(team_slug, options = {}) ⇒ SentryApi::ObjectifiedHash

Update various attributes and configurable settings for the given team.

Examples:

SentryApi.update_team('team-slug', {name:'team-name'})

Parameters:

  • team_slug (String) —

    the slug of the team

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

    A customizable set of options.

Options Hash (options):

  • :name (String) —

    the name for the new project.

  • :slug (String) —

    optionally a slug for the new project. If it’s not provided a slug is generated from the name.

Returns:



61
62
63
 
# File 'lib/sentry-api/client/teams.rb', line 61

def update_team(team_slug, options={})
  get("/teams/#{@default_org_slug}/#{team_slug}/", body: options)
end