Module: Buildkit::Client::Organizations

Included in:

Buildkit::Client

Defined in:

lib/buildkit/client/organizations.rb

Overview

Methods for the Organizations API

See Also:

• https://buildkite.com/docs/api/organizations

Instance Method Summary

• #organization(org, options = {}) ⇒ Sawyer::Resource

  Get an organization.

• #organizations(options = {}) ⇒ Array<Sawyer::Resource>

  List organizations.

Instance Method Details

#organization(org, options = {}) ⇒ Sawyer::Resource

Get an organization

Examples:

Buildkit.organization('my-great-org')

Parameters:

• org (String) —

  Organization slug.

Returns:

• (Sawyer::Resource) —

  Hash representing Buildkite organization.

See Also:

• https://buildkite.com/docs/api/organizations#get-an-organization

# File 'lib/buildkit/client/organizations.rb', line 26

def organization(org, options = {})
  get("/v2/organizations/#{org}", options)
end

#organizations(options = {}) ⇒ Array<Sawyer::Resource>

List organizations

Examples:

Buildkit.organizations

Returns:

• (Array<Sawyer::Resource>) —

  Array of hashes representing Buildkite organizations.

See Also:

• https://buildkite.com/docs/api/organizations#list-organizations

# File 'lib/buildkit/client/organizations.rb', line 15

def organizations(options = {})
  get('/v2/organizations', options)
end