<?php
/*
 * WebhookRepositoryInterface.php
 * Copyright (c) 2021 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Repositories\Webhook;

use FireflyIII\Models\Webhook;
use FireflyIII\Models\WebhookAttempt;
use FireflyIII\Models\WebhookMessage;
use FireflyIII\User;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Support\Collection;

/**
 * Interface WebhookRepositoryInterface
 */
interface WebhookRepositoryInterface
{
    /**
     * Return all webhooks.
     *
     * @return Collection
     */
    public function all(): Collection;

    /**
     * @param  Webhook  $webhook
     */
    public function destroy(Webhook $webhook): void;

    /**
     * @param  WebhookAttempt  $attempt
     */
    public function destroyAttempt(WebhookAttempt $attempt): void;

    /**
     * @param  WebhookMessage  $message
     */
    public function destroyMessage(WebhookMessage $message): void;

    /**
     * @param  WebhookMessage  $webhookMessage
     *
     * @return Collection
     */
    public function getAttempts(WebhookMessage $webhookMessage): Collection;

    /**
     * @param  Webhook  $webhook
     *
     * @return Collection
     */
    public function getMessages(Webhook $webhook): Collection;

    /**
     * @param  Webhook  $webhook
     *
     * @return Collection
     */
    public function getReadyMessages(Webhook $webhook): Collection;

    /**
     * @param  User|Authenticatable|null  $user
     */
    public function setUser(User|Authenticatable|null $user): void;

    /**
     * @param  array  $data
     *
     * @return Webhook
     */
    public function store(array $data): Webhook;

    /**
     * @param  Webhook  $webhook
     * @param  array  $data
     *
     * @return Webhook
     */
    public function update(Webhook $webhook, array $data): Webhook;
}