digitalcz / digisign

src/Endpoint/ImagesEndpoint.php

<?php

declare(strict_types=1);

namespace DigitalCz\DigiSign\Endpoint;

use DigitalCz\DigiSign\DigiSign;
use DigitalCz\DigiSign\Endpoint\Traits\GetEndpointTrait;
use DigitalCz\DigiSign\Endpoint\Traits\ListEndpointTrait;
use DigitalCz\DigiSign\Resource\Image;
use DigitalCz\DigiSign\Stream\FileResponse;
use DigitalCz\DigiSign\Stream\FileStream;

/**
 * @extends ResourceEndpoint<Image>
 * @method Image get(string $id)
 */
final class ImagesEndpoint extends ResourceEndpoint
{
    /** @use ListEndpointTrait<Image> */
    use ListEndpointTrait;
    use GetEndpointTrait;

    public function __construct(DigiSign $parent)
    {
        parent::__construct($parent, '/api/images', Image::class);
    }

    public function upload(FileStream $image, bool $public = false): Image
    {
        $multipart = ['image' => $image, 'public' => ($public ? 'true' : 'false')];

        return $this->makeResource($this->postRequest('', ['multipart' => $multipart]));

The expression return $this->makeResource($this->postRequest('', array('multipart' => $multipart))) returns the type DigitalCz\DigiSign\Resource\ResourceInterface which includes types incompatible with the type-hinted return DigitalCz\DigiSign\Resource\Image.

    }

    public function content(string $id): FileResponse
    {
        return $this->stream(self::METHOD_GET, '/{id}/content', ['id' => $id]);
    }
}