digitalcz / digisign

src/Endpoint/EnvelopeTemplateDocumentsEndpoint.php

<?php

declare(strict_types=1);

namespace DigitalCz\DigiSign\Endpoint;

use DigitalCz\DigiSign\Endpoint\Traits\CRUDEndpointTrait;
use DigitalCz\DigiSign\Resource\EnvelopeTemplate;
use DigitalCz\DigiSign\Resource\EnvelopeTemplateDocument;
use DigitalCz\DigiSign\Stream\FileResponse;

/**
 * @extends ResourceEndpoint<EnvelopeTemplateDocument>
 * @method EnvelopeTemplateDocument get(string $id)
 * @method EnvelopeTemplateDocument create(array $body)
 * @method EnvelopeTemplateDocument update(string $id, array $body)
 */
final class EnvelopeTemplateDocumentsEndpoint extends ResourceEndpoint
{
    /** @use CRUDEndpointTrait<EnvelopeTemplateDocument> */
    use CRUDEndpointTrait;

    /**
     * @param EnvelopeTemplate|string $template
     */
    public function __construct(EnvelopeTemplatesEndpoint $parent, $template)
    {
        parent::__construct(
            $parent,
            '/{template}/documents',
            EnvelopeTemplateDocument::class,
            ['template' => $template]
        );
    }

    /**
     * @param mixed[] $query
     */
    public function download(string $id, array $query = []): FileResponse
    {
        return $this->stream(self::METHOD_GET, '/{id}/download', ['id' => $id, 'query' => $query]);
    }

    /**
     * @param mixed[] $body
     */
    public function positions(array $body): void
    {
        $this->putRequest('/positions', ['json' => $body]);
    }

    /**
     * @param EnvelopeTemplateDocument|string $document
     * @param mixed[] $body
     */
    public function replaceFile($document, array $body): EnvelopeTemplateDocument
    {
        return $this->makeResource(

The expression return $this->makeResource($this->postRequest('/{document}/replace-file', array('document' => $document, 'json' => $body))) returns the type DigitalCz\DigiSign\Resource\ResourceInterface which includes types incompatible with the type-hinted return DigitalCz\DigiSign\Resource\EnvelopeTemplateDocument.

            $this->postRequest('/{document}/replace-file', ['document' => $document, 'json' => $body])
        );
    }
}