Edit organization
@param [Hash] params @input params [String] :billing_email
Billing email address. This address is not publicized.
@input params [String] :company
The company name
@input params [String] :email
The publicly visible email address
@input params [String] :location
The location
@input params [String] :name
The shorthand name of the company.
@example
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"
@api public
# File lib/github_api/client/orgs.rb, line 89 def edit(*args) arguments(args, required: [:org_name]) do permit VALID_ORG_PARAM_NAMES end patch_request("/orgs/#{arguments.org_name}", arguments.params) end
Get properties for a single organization
@example
github = Github.new github.orgs.get 'github'
@api public
# File lib/github_api/client/orgs.rb, line 57 def get(*args) arguments(args, required: [:org_name]) get_request("/orgs/#{arguments.org_name}", arguments.params) end
List all public organizations for a user.
@example
github = Github.new github.orgs.list user: 'user-name'
List public and private organizations for the authenticated user.
@example
github = Github.new oauth_token: '..' github.orgs.list
@api public
# File lib/github_api/client/orgs.rb, line 36 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
Generated with the Darkfish Rdoc Generator 2.