ApiKeyRequestAuthentication

19class ApiKeyRequestAuthentication extends AbstractDataTransferObject implements RequestAuthenticationInterface20{21    public const KEY_API_KEY = 'apiKey';22    /**23     * @var string The API key used for authentication.24     */25    protected string $apiKey;26    /**27     * Constructor.28     *29     * @since 0.1.030     *31     * @param string $apiKey The API key used for authentication.32     */33    public function __construct(string $apiKey)34    {35        $this->apiKey = $apiKey;36    }37    /**38     * {@inheritDoc}39     *40     * @since 0.1.041     */42    public function authenticateRequest(\WordPress\AiClient\Providers\Http\DTO\Request $request): \WordPress\AiClient\Providers\Http\DTO\Request43    {44        // Add the API key to the request headers.45        return $request->withHeader('Authorization', 'Bearer ' . $this->apiKey);46    }47    /**48     * Gets the API key.49     *50     * @since 0.1.051     *52     * @return string The API key.53     */54    public function getApiKey(): string55    {56        return $this->apiKey;57    }58    /**59     * {@inheritDoc}60     *61     * @since 0.1.062     *63     * @since 0.1.064     *65     * @return ApiKeyRequestAuthenticationArrayShape66     */67    public function toArray(): array68    {69        return [self::KEY_API_KEY => $this->apiKey];70    }71    /**72     * {@inheritDoc}73     *74     * @since 0.1.075     *76     * @since 0.1.077     */78    public static function fromArray(array $array): self79    {80        static::validateFromArrayData($array, [self::KEY_API_KEY]);81        return new self($array[self::KEY_API_KEY]);82    }83    /**84     * {@inheritDoc}85     *86     * @since 0.1.087     */88    public static function getJsonSchema(): array89    {90        return ['type' => 'object', 'properties' => [self::KEY_API_KEY => ['type' => 'string', 'title' => 'API Key', 'description' => 'The API key used for authentication.']], 'required' => [self::KEY_API_KEY]];91    }92}