<?php

declare(strict_types=1);

namespace Drupal\sms\Message;

/**
 * Contains information about an SMS message.
 */
interface SmsDeliveryReportInterface {

  /**
   * Gets the gateway tracking ID for the message.
   *
   * @return string|null
   *   The gateway tracking ID for the message, or NULL if there is no tracking
   *   ID.
   */
  public function getMessageId();

  /**
   * Sets the gateway tracking ID for the message.
   *
   * @param string|null $message_id
   *   The gateway tracking ID for the message, or NULL if there is no tracking
   *   ID.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setMessageId($message_id);

  /**
   * Gets the recipient for the message.
   *
   * @return string
   *   The recipient for the message.
   */
  public function getRecipient();

  /**
   * Sets the recipient for the message.
   *
   * @param string $recipient
   *   The recipient for the message.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setRecipient($recipient);

  /**
   * Gets the status of the message.
   *
   * @return string|null
   *   A status code from \Drupal\sms\Message\SmsMessageReportStatus, or NULL if
   *   unknown.
   */
  public function getStatus();

  /**
   * Sets the status of the message.
   *
   * @param string|null $status
   *   A status code from \Drupal\sms\Message\SmsMessageReportStatus, or NULL if
   *   unknown.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setStatus($status);

  /**
   * Gets the status message.
   *
   * @return string
   *   The status message as provided by the gateway API.
   */
  public function getStatusMessage();

  /**
   * Sets the status message.
   *
   * @param string $message
   *   The status message as provided by the gateway API.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setStatusMessage($message);

  /**
   * Gets the time the message was queued.
   *
   * @return int|null
   *   The timestamp when the message was queued, or NULL if unknown.
   */
  public function getTimeQueued();

  /**
   * Sets the time the message was queued.
   *
   * @param int|null $time
   *   The timestamp when the message was queued, or NULL if unknown.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setTimeQueued($time);

  /**
   * Gets the time the message was delivered to the recipient.
   *
   * @return int|null
   *   The timestamp when the message was delivered to the recipient, or NULL if
   *   unknown.
   */
  public function getTimeDelivered();

  /**
   * Sets the time the message was delivered to the recipient.
   *
   * @param int|null $time
   *   The timestamp when the message was delivered to the recipient, or NULL if
   *   unknown.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setTimeDelivered($time);

  /**
   * Gets the gateway-provided timestamp for the current status.
   *
   * @return int
   *   A UNIX timestamp.
   */
  public function getStatusTime();

  /**
   * Sets the gateway-provided timestamp for the current status.
   *
   * @param int $time
   *   A UNIX timestamp provided by the SMS gateway.
   *
   * @return $this
   *   Returns this report object for chaining.
   */
  public function setStatusTime($time);

}
