module Octokit::Client::RepositoryInvitations

Methods for the Repository Invitations API

@see developer.github.com/v3/repos/invitations/

Public Instance Methods

accept_repo_invitation(invitation_id, options = {})
accept_repository_invitation(invitation_id, options = {}) click to toggle source

Accept a repository invitation

Requires authenticated client

@param invitation_id [Integer] The id of the invitation @return [Boolean] True if the acceptance of the invitation was successful @see developer.github.com/v3/repos/invitations/#accept-a-repository-invitation

# File lib/octokit/client/repository_invitations.rb, line 78
def accept_repository_invitation(invitation_id, options = {})
  patch "/user/repository_invitations/#{invitation_id}", options
end
Also aliased as: accept_repo_invitation
decline_invitation(invitation_id, options = {})
decline_repository_invitation(invitation_id, options = {}) click to toggle source

Decline a repository invitation

Requires authenticated client

@param invitation_id [Integer] The id of the invitation @return [Boolean] True if the acceptance of the invitation was successful @see developer.github.com/v3/repos/invitations/#decline-a-repository-invitation

# File lib/octokit/client/repository_invitations.rb, line 90
def decline_repository_invitation(invitation_id, options = {})
  boolean_from_response :delete, "/user/repository_invitations/#{invitation_id}", options
end
Also aliased as: decline_invitation
delete_repo_invitation(repo, invitation_id, options = {})
delete_repository_invitation(repo, invitation_id, options = {}) click to toggle source

Delete an invitation for a repository

Requires authenticated client

@param repo [Integer, String, Repository, Hash] A GitHub repository @param invitation_id [Integer] The id of the invitation @return [Boolean] True if the invitation was successfully deleted @see developer.github.com/v3/repos/invitations/#delete-a-repository-invitation

# File lib/octokit/client/repository_invitations.rb, line 42
def delete_repository_invitation(repo, invitation_id, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/invitations/#{invitation_id}", options
end
Also aliased as: delete_repo_invitation
invite_user_to_repo(repo, user, options = {})
invite_user_to_repository(repo, user, options = {}) click to toggle source

Invite a user to a repository

Requires authenticated client

@param repo [Integer, String, Hash, Repository] A GitHub repository @param user [String] User GitHub username to add @return [Sawyer::Resource] The repository invitation @see developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator

# File lib/octokit/client/repository_invitations.rb, line 17
def invite_user_to_repository(repo, user, options = {})
  put "#{Repository.path repo}/collaborators/#{user}", options
end
Also aliased as: invite_user_to_repo
repo_invitations(repo, options = {})
repository_invitations(repo, options = {}) click to toggle source

List all invitations for a repository

Requires authenticated client

@param repo [Integer, String, Repository, Hash] A GitHub repository @return [Array<Sawyer::Resource>] A list of invitations @see developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository

# File lib/octokit/client/repository_invitations.rb, line 29
def repository_invitations(repo, options = {})
  paginate "#{Repository.path repo}/invitations", options
end
Also aliased as: repo_invitations
update_repo_invitation(repo, invitation_id, options = {})
update_repository_invitation(repo, invitation_id, options = {}) click to toggle source

Update an invitation for a repository

Requires authenticated client

@param repo [Integer, String, Repository, Hash] A GitHub repository @param invitation_id [Integer] The id of the invitation @return [Sawyer::Resource] The updated repository invitation @see developer.github.com/v3/repos/invitations/#update-a-repository-invitation

# File lib/octokit/client/repository_invitations.rb, line 55
def update_repository_invitation(repo, invitation_id, options = {})
  patch "#{Repository.path repo}/invitations/#{invitation_id}", options
end
Also aliased as: update_repo_invitation
user_repo_invitations(options = {})
user_repository_invitations(options = {}) click to toggle source

List all repository invitations for the user

Requires authenticated client

@return [Array<Sawyer::Resource>] The users repository invitations @see developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations

# File lib/octokit/client/repository_invitations.rb, line 66
def user_repository_invitations(options = {})
  paginate "/user/repository_invitations", options
end
Also aliased as: user_repo_invitations