### Home Classes Methods

### In Files

- lib/github_api/orgs.rb

### Parent

API

### Namespace

- CLASS Github::Orgs::Members
- CLASS Github::Orgs::Teams

### Methods

- #all
- #edit
- #find
- #get
- #list
- #members
- #teams

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Orgs

### Constants

VALID_ORG_PARAM_NAMES

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
edit(*args) click to toggle source

Edit organization

# Parameters

`:billing_email` - Optional string - Billing email address. This address is not publicized. `:company` - Optional string `:email` - Optional string `:location` - Optional string `:name` - Optional string

# Examples

    github = Github.new oauth_token: '...'
    github.orgs.edit 'github',
      "billing_email": "support@github.com",
      "blog": "https://github.com/blog",
      "company": "GitHub",
      "email": "support@github.com",
      "location": "San Francisco",
      "name": "github"

    # File lib/github_api/orgs.rb, line 85
    def edit(*args)
      arguments(args, :required => [:org_name]) do
        sift VALID_ORG_PARAM_NAMES
      end

      patch_request("/orgs/#{org_name}", arguments.params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get properties for a single organization

# Examples

    github = Github.new
    github.orgs.get 'github'

    # File lib/github_api/orgs.rb, line 59
    def get(*args)
      arguments(args, :required => [:org_name])

      get_request("/orgs/#{org_name}", arguments.params)
    end

Also aliased as: find
list(*args) click to toggle source

List all public organizations for a user.

# Examples

    github = Github.new
    github.orgs.list user: 'user-name'

List public and private organizations for the authenticated user.

    github = Github.new oauth_token: '..'
    github.orgs.list

    # File lib/github_api/orgs.rb, line 39
    def list(*args)
      params = arguments(args).params

      response = if (user_name = params.delete("user"))
        get_request("/users/#{user_name}/orgs", params)
      else
        # For the authenticated user
        get_request("/user/orgs", params)
      end
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all
members(options={}, &block) click to toggle source

Access to Orgs::Members API

    # File lib/github_api/orgs.rb, line 19
    def members(options={}, &block)
      @members ||= ApiFactory.new('Orgs::Members', current_options.merge(options), &block)
    end

teams(options={}, &block) click to toggle source

Access to Orgs::Teams API

    # File lib/github_api/orgs.rb, line 24
    def teams(options={}, &block)
      @teams ||= ApiFactory.new('Orgs::Teams', current_options.merge(options), &block)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.