AtsEndpoint.php

<?php

declare(strict_types=1);

namespace Ashampoo\AtsClient\Enums;

use Ashampoo\AtsClient\QueryParam;

enum AtsEndpoint: string
{
    // ProjectEndpoints
    case Translations = '/api/project/{projectId}/translations';
    case LangInfo = '/api/project/{projectId}/language/info';
    case TranslationsAll = '/api/project/{projectId}/translations/all';
    case TranslationImport = '/api/project/{projectId}/import';

    // MachineTranslationEndpoints
    case MachineTranslation = '/api/machinetranslations/{projectId}/generate';
    case MachineTranslationAll = '/api/machinetranslations/{projectId}/generate/all';

    // TranslationMemoryEndpoints
    case MemoryTranslation = '/api/translationmemory/{projectId}/generate';
    case MemoryTranslationAll = '/api/translationmemory/{projectId}/generate/all';

    public function method(): string
    {
        return match ($this) {
            self::TranslationImport,
            self::MachineTranslation,
            self::MachineTranslationAll,
            self::MemoryTranslation,
            self::MemoryTranslationAll => 'POST',
            default => 'GET',
        };
    }

    public function requiresBody(): bool
    {
        return match ($this) {
            self::TranslationImport => true,
            default => false,
        };
    }

    /**
     * Substitute `{placeholder}` tokens in the endpoint path with the given values.
     *
     * Keys without a matching placeholder are ignored; placeholders without
     * a provided value are left intact in the returned path.
     *
     * @param array<string, scalar> $params
     */
    public function resolve(array $params = []): string
    {
        return \preg_replace_callback(
            '/\{(\w+)\}/',
            fn (array $matches): string => (string) ($params[$matches[1]] ?? $matches[0]),
            $this->value,
        ) ?? $this->value;
    }

    /** @return QueryParam[] */
    public function queryParams(): array
    {
        return match ($this) {
            self::Translations => [
                new QueryParam('language', required: true),
                new QueryParam('filter'),
                new QueryParam('formatId'),
                new QueryParam('contextSplitting'),
            ], 
            self::TranslationsAll => [
                new QueryParam('filter'),
                new QueryParam('formatId'),
                new QueryParam('contextSplitting'),
            ],
            self::LangInfo => [
                new QueryParam('language', required: true),
            ],
            self::MachineTranslation,
            self::MachineTranslationAll,
            self::MemoryTranslation,
            self::MemoryTranslationAll => [
                new QueryParam('language'),
            ],
            self::TranslationImport => [
                new QueryParam('language', required: true),
                new QueryParam('sourceLanguage'),
                new QueryParam('importIds', required: true),
                new QueryParam('importTranslations', required: true),
                new QueryParam('overWriteTranslations', required: true),
                new QueryParam('formatId'),
                new QueryParam('removeNotFoundIds'),
            ],
        };
    }
}