Invitations

use RoundlyConsulting\Teams\Facades\Teams;

// Default expiry from config, targeted at one email address.
$invite = Teams::for($team)->invites()->create(role: 'admin', email: '[email protected]');

// Every option:
$invite = Teams::for($team)->invites()->create(
    role: 'member',
    expiresAt: now()->addDays(14),    // null → invites.expires_after
    email: '[email protected]',        // null → an open invite
    invitedBy: $currentUser,          // stored as a morph
    meta: ['note' => 'design team'],
    maxUses: 1,                       // default 1; null = unlimited
);

$invite->code;         // random, invites.code_length characters
$invite->expires_at;   // Carbon

// The model shortcut takes the same parameters in the same order (role first):
$invite = $team->invite('member', now()->addDays(3), email: '[email protected]');

use RoundlyConsulting\Teams\Facades\Teams;

// 1. By code — the invite is looked up for you
$member = Teams::invites()->accept($code, $user, email: $user->email);

// 2. With a resolved invite
$member = Teams::invites()->accept($invite, $user, email: $user->email);

// 3. On the invite model — the same manager call
$member = $invite->acceptBy($user, $user->email);

Teams::invites()->find($code);   // ?Invite

$invite->isExpired();     // expires_at has passed
$invite->isExhausted();   // uses reached max_uses (never true when unlimited)

Teams::for($team)->invites()->resend($invite);   // Invite — rotates the code, extends the expiry from now
Teams::for($team)->invites()->revoke($invite);   // bool — soft-delete
Teams::for($team)->invites()->pending();         // Collection<Invite> — the team's unexpired invites

// Model shorthand, same code path:
$invite = $invite->resend();
$invite->revoke();

php artisan teams:invites:resend {code}   # prints the new code

use RoundlyConsulting\Teams\Models\Invite;

Invite::query()->pending()->get();                     // not yet expired
Invite::query()->forEmail('[email protected]')->get();
$team->invites()->pending()->get();

$invite->team;        // the Team
$invite->invitedBy;   // the inviting model (MorphTo), or null

php artisan vendor:publish --tag="teams-stubs"

// routes/teams.php — require it from routes/web.php
use App\Http\Controllers\AcceptInviteController;
use Illuminate\Support\Facades\Route;

Route::middleware(['web', 'auth', 'verified'])->group(function (): void {
    Route::get('teams/invites/{invite}', [AcceptInviteController::class, 'show'])
        ->name('teams.invites.show');

    Route::post('teams/invites/{invite}', [AcceptInviteController::class, 'store'])
        ->name('teams.invites.accept');
});

namespace App\Http\Controllers;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Blade;
use RoundlyConsulting\Teams\Facades\Teams;
use RoundlyConsulting\Teams\Models\Invite;

class AcceptInviteController extends Controller
{
    // GET — shows a confirmation form, never accepts. Swap the template for your own view.
    public function show(Invite $invite): Response
    {
        return response(Blade::render(<<<'BLADE'
            <form method="POST" action="{{ route('teams.invites.accept', $invite) }}">
                @csrf
                <p>Join {{ $invite->team?->name }} as {{ $invite->role }}?</p>
                <button type="submit">Accept invite</button>
            </form>
            BLADE, ['invite' => $invite]));
    }

    // POST — CSRF-protected by the web group; only a verified email is offered.
    public function store(Request $request, Invite $invite): RedirectResponse
    {
        $user = $request->user();

        $email = $user instanceof MustVerifyEmail && $user->hasVerifiedEmail()
            ? $user->getEmailForVerification()
            : null;

        $member = Teams::invites()->accept($invite, $user, email: $email);

        return redirect()->route('teams.show', $member->team_id);
    }
}

php artisan teams:invites:prune   # force-delete invites that expired over a month ago (= Teams::invites()->prune())
php artisan model:prune           # Invite is Prunable too — includes revoked and consumed ones