<?php

declare(strict_types=1);

namespace App\Actions\Models\List\ExternalProfile\ExternalEntry;

use App\Models\List\External\ExternalToken;
use Illuminate\Support\Facades\Crypt;

/**
 * Class BaseExternalEntryTokenAction
 *
 * This action will create the entries through the authentication method.
 */
abstract class BaseExternalEntryTokenAction
{
    /**
     * The response of the external API.
     *
     * @var array|null $response
     */
    protected ?array $response = null;

    /**
     * The id of the external user.
     *
     * @var int|null $userId
     */
    protected ?int $userId = null;

    /**
     * Create a new action instance.
     *
     * @param  ExternalToken  $token
     */
    public function __construct(protected ExternalToken $token)
    {
    }

    /**
     * Get the id of the external user.
     *
     * @return int|null
     */
    public function getUserId(): ?int
    {
        return $this->userId;
    }

    /**
     * Get the token to the request.
     *
     * @return string
     */
    public function getToken(): string
    {
        return Crypt::decrypt($this->token->access_token);
    }

    /**
     * Get the username.
     *
     * @return string|null
     */
    abstract public function getUsername(): ?string;

    /**
     * Get the entries of the response.
     *
     * @return array
     */
    abstract public function getEntries(): array;

    /**
     * Make the request to the external api.
     *
     * @return static
     */
    abstract protected function makeRequest(): static;
}