<?php
/**
 * Result of a channel send attempt.
 *
 * @package Bookline
 */

declare( strict_types=1 );

namespace Bookline\Domain\Notification;

/**
 * Immutable send outcome.
 *
 * @since 0.1.0
 */
final class SendResult {

	/**
	 * Constructor.
	 *
	 * @param bool        $success      Whether delivery succeeded.
	 * @param string|null $provider_id  Provider message id.
	 * @param bool        $retryable    Whether a failure may be retried.
	 * @param string|null $error        Error detail (no secrets).
	 */
	public function __construct(
		private readonly bool $success,
		private readonly ?string $provider_id = null,
		private readonly bool $retryable = false,
		private readonly ?string $error = null,
	) {}

	/**
	 * Successful send.
	 *
	 * @param string|null $provider_id Provider id.
	 *
	 * @since 0.1.0
	 */
	public static function ok( ?string $provider_id = null ): self {
		return new self( true, $provider_id, false, null );
	}

	/**
	 * Failed send.
	 *
	 * @param string $error     Error.
	 * @param bool   $retryable Retryable flag.
	 *
	 * @since 0.1.0
	 */
	public static function fail( string $error, bool $retryable ): self {
		return new self( false, null, $retryable, $error );
	}

	/**
	 * Success.
	 *
	 * @since 0.1.0
	 */
	public function success(): bool {
		return $this->success;
	}

	/**
	 * Provider id.
	 *
	 * @since 0.1.0
	 */
	public function provider_id(): ?string {
		return $this->provider_id;
	}

	/**
	 * Retryable.
	 *
	 * @since 0.1.0
	 */
	public function retryable(): bool {
		return $this->retryable;
	}

	/**
	 * Error.
	 *
	 * @since 0.1.0
	 */
	public function error(): ?string {
		return $this->error;
	}
}