src/Model/Email/Webhook/Webhook.php line 18

Open in your IDE?
  1. <?php
  3. namespace App\Model\Email\Webhook;
  5. use App\Enum\EmailMessageStatusEnum;
  6. use DateTime;
  7. use DateTimeInterface;
  8. use Symfony\Component\Serializer\Annotation\SerializedName;
  10. /**
  11.  *
  12.  * @see https://developers.brevo.com/docs/getting-started
  13.  * @see https://developers.brevo.com/docs/transactional-webhooks
  14.  * @see https://developers.brevo.com/docs/send-a-transactional-email
  15.  * @see https://developers.brevo.com/docs/send-a-transactional-email#tracking-your-transactional-activity-through-webhooks
  16.  * @see https://developers.brevo.com/reference/sendtransacemail
  17.  */
  18. class Webhook
  19. {
  20.     private string $event; // type of event (status synonym) from EmailMessageStatusEnum
  22.     /**
  23.      * @SerializedName("id")
  24.      */
  25.     private string $webhookId; // webhook id at the third party mail provider (Brevo e.g.)
  26.     private string $email; // TO (the recipient of the email)
  28.     /**
  29.      * @SerializedName("ts")
  30.      */
  31.     private string $timestamp;
  33.     /**
  34.      * @SerializedName("message-id")
  35.      */
  36.     private string $messageId; // message-id at the third party mail provider (Brevo e.g.)
  37.     private string $subject;
  38.     private ?string $link = null; // URL accessed by recipient
  39.     private ?string $deviceUsed = null; // Details about the device from which the action originated (DESKTOP, MOBILE, ...)
  40.     private ?string $reason = null; // The reason the message has been deferred, soft_bounced or hard_bounce
  42.     public function __construct()
  43.     {
  44.     }
  46.     public function getEvent(): string
  47.     {
  48.         return $this->event;
  49.     }
  51.     public function setEvent(string $event): self
  52.     {
  53.         $this->event = $event;
  54.         return $this;
  55.     }
  57.     public function getWebhookId(): string
  58.     {
  59.         return $this->webhookId;
  60.     }
  62.     public function setWebhookId(string $webhookId): self
  63.     {
  64.         $this->webhookId = $webhookId;
  65.         return $this;
  66.     }
  68.     public function getEmail(): string
  69.     {
  70.         return $this->email;
  71.     }
  73.     public function setEmail(string $email): self
  74.     {
  75.         $this->email = $email;
  76.         return $this;
  77.     }
  79.     public function getTimestamp(): string
  80.     {
  81.         return $this->timestamp;
  82.     }
  84.     public function setTimestamp(string $timestamp): self
  85.     {
  86.         $this->timestamp = $timestamp;
  87.         return $this;
  88.     }
  90.     public function getEventDatetime(): DateTimeInterface
  91.     {
  92.         $datetime = new DateTime();
  93.         return $datetime->setTimestamp($this->timestamp);
  94.     }
  96.     public function getMessageId(): string
  97.     {
  98.         return $this->messageId;
  99.     }
  101.     public function setMessageId(string $messageId): self
  102.     {
  103.         $this->messageId = $messageId;
  104.         return $this;
  105.     }
  107.     public function getSubject(): string
  108.     {
  109.         return $this->subject;
  110.     }
  112.     public function setSubject(string $subject): self
  113.     {
  114.         $this->subject = $subject;
  115.         return $this;
  116.     }
  118.     public function getLink(): ?string
  119.     {
  120.         return $this->link;
  121.     }
  123.     public function setLink(?string $link): self
  124.     {
  125.         $this->link = $link;
  126.         return $this;
  127.     }
  129.     public function getDeviceUsed(): ?string
  130.     {
  131.         return $this->deviceUsed;
  132.     }
  134.     public function setDeviceUsed(?string $deviceUsed): self
  135.     {
  136.         $this->deviceUsed = $deviceUsed;
  137.         return $this;
  138.     }
  140.     public function getReason(): ?string
  141.     {
  142.         return $this->reason;
  143.     }
  145.     public function setReason(?string $reason): self
  146.     {
  147.         $this->reason = $reason;
  148.         return $this;
  149.     }
  150. }