class Github::Client::Orgs

Organizations API

def edit(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :description (String) --
  • :name (String) --
  • :location (String) --
  • :email (String) --
  • :company (String) --
  • :billing_email (String) --

Parameters:
  • params (Hash) --

Other tags:
    See: https://developer.github.com/v3/orgs/#edit-an-organization -
def edit(*args)
  arguments(args, required: [:org_name])
  patch_request("/orgs/#{arguments.org_name}", arguments.params)
end

def get(*args)

Other tags:
    Api: - public

Other tags:
    See: https://developer.github.com/v3/orgs/#get-an-organization -
def get(*args)
  arguments(args, required: [:org_name])
  get_request("/orgs/#{arguments.org_name}", arguments.params)
end

def list(*args)

Other tags:
    Api: - public

Other tags:
    See: https://developer.github.com/v3/orgs/#list-user-organizations -
    See: https://developer.github.com/v3/orgs/#list-all-organizations -

Options Hash: (**params)
  • :since (String) --

Parameters:
  • params (Hash) --
def list(*args)
  params = arguments(args).params
  if (user_name = params.delete('user'))
    response = get_request("/users/#{user_name}/orgs", params)
  elsif args.map(&:to_s).include?('every')
    response = get_request('/organizations', params)
  else
    # For the authenticated user
    response = get_request('/user/orgs', params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end