module Octokit::Client::RepositoryInvitations
Methods for the Repository
Invitations API
Public Instance Methods
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 83 def accept_repository_invitation(invitation_id, options = {}) options = ensure_api_media_type(:repository_invitations, options) patch "/user/repository_invitations/#{invitation_id}", options end
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 96 def decline_repository_invitation(invitation_id, options = {}) options = ensure_api_media_type(:repository_invitations, options) boolean_from_response :delete, "/user/repository_invitations/#{invitation_id}", options end
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 44 def delete_repository_invitation(repo, invitation_id, options = {}) options = ensure_api_media_type(:repository_invitations, options) boolean_from_response :delete, "#{Repository.path repo}/invitations/#{invitation_id}", options end
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/invitations/#invite-a-user-to-a-repository
# File lib/octokit/client/repository_invitations.rb, line 17 def invite_user_to_repository(repo, user, options = {}) options = ensure_api_media_type(:repository_invitations, options) put "#{Repository.path repo}/collaborators/#{user}", options end
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 30 def repository_invitations(repo, options = {}) options = ensure_api_media_type(:repository_invitations, options) paginate "#{Repository.path repo}/invitations", options end
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 58 def update_repository_invitation(repo, invitation_id, options = {}) options = ensure_api_media_type(:repository_invitations, options) patch "#{Repository.path repo}/invitations/#{invitation_id}", options end
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 70 def user_repository_invitations(options = {}) options = ensure_api_media_type(:repository_invitations, options) paginate "/user/repository_invitations", options end