Module mailslurp_client.models.webhook_email_opened_payload

MailSlurp API

MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501

The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech

Classes

class WebhookEmailOpenedPayload (message_id=None, webhook_id=None, event_name=None, webhook_name=None, inbox_id=None, pixel_id=None, sent_email_id=None, recipient=None, created_at=None, local_vars_configuration=None)

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

WebhookEmailOpenedPayload - a model defined in OpenAPI

Expand source code

class WebhookEmailOpenedPayload(object):
    """NOTE: This class is auto generated by OpenAPI Generator.
    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'message_id': 'str',
        'webhook_id': 'str',
        'event_name': 'str',
        'webhook_name': 'str',
        'inbox_id': 'str',
        'pixel_id': 'str',
        'sent_email_id': 'str',
        'recipient': 'str',
        'created_at': 'datetime'
    }

    attribute_map = {
        'message_id': 'messageId',
        'webhook_id': 'webhookId',
        'event_name': 'eventName',
        'webhook_name': 'webhookName',
        'inbox_id': 'inboxId',
        'pixel_id': 'pixelId',
        'sent_email_id': 'sentEmailId',
        'recipient': 'recipient',
        'created_at': 'createdAt'
    }

    def __init__(self, message_id=None, webhook_id=None, event_name=None, webhook_name=None, inbox_id=None, pixel_id=None, sent_email_id=None, recipient=None, created_at=None, local_vars_configuration=None):  # noqa: E501
        """WebhookEmailOpenedPayload - a model defined in OpenAPI"""  # noqa: E501
        if local_vars_configuration is None:
            local_vars_configuration = Configuration()
        self.local_vars_configuration = local_vars_configuration

        self._message_id = None
        self._webhook_id = None
        self._event_name = None
        self._webhook_name = None
        self._inbox_id = None
        self._pixel_id = None
        self._sent_email_id = None
        self._recipient = None
        self._created_at = None
        self.discriminator = None

        self.message_id = message_id
        self.webhook_id = webhook_id
        self.event_name = event_name
        self.webhook_name = webhook_name
        self.inbox_id = inbox_id
        self.pixel_id = pixel_id
        self.sent_email_id = sent_email_id
        self.recipient = recipient
        self.created_at = created_at

    @property
    def message_id(self):
        """Gets the message_id of this WebhookEmailOpenedPayload.  # noqa: E501

        Idempotent message ID. Store this ID locally or in a database to prevent message duplication.  # noqa: E501

        :return: The message_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._message_id

    @message_id.setter
    def message_id(self, message_id):
        """Sets the message_id of this WebhookEmailOpenedPayload.

        Idempotent message ID. Store this ID locally or in a database to prevent message duplication.  # noqa: E501

        :param message_id: The message_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and message_id is None:  # noqa: E501
            raise ValueError("Invalid value for `message_id`, must not be `None`")  # noqa: E501

        self._message_id = message_id

    @property
    def webhook_id(self):
        """Gets the webhook_id of this WebhookEmailOpenedPayload.  # noqa: E501

        ID of webhook entity being triggered  # noqa: E501

        :return: The webhook_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._webhook_id

    @webhook_id.setter
    def webhook_id(self, webhook_id):
        """Sets the webhook_id of this WebhookEmailOpenedPayload.

        ID of webhook entity being triggered  # noqa: E501

        :param webhook_id: The webhook_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and webhook_id is None:  # noqa: E501
            raise ValueError("Invalid value for `webhook_id`, must not be `None`")  # noqa: E501

        self._webhook_id = webhook_id

    @property
    def event_name(self):
        """Gets the event_name of this WebhookEmailOpenedPayload.  # noqa: E501

        Name of the event type webhook is being triggered for.  # noqa: E501

        :return: The event_name of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._event_name

    @event_name.setter
    def event_name(self, event_name):
        """Sets the event_name of this WebhookEmailOpenedPayload.

        Name of the event type webhook is being triggered for.  # noqa: E501

        :param event_name: The event_name of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and event_name is None:  # noqa: E501
            raise ValueError("Invalid value for `event_name`, must not be `None`")  # noqa: E501
        allowed_values = ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS", "NEW_GUEST_USER"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and event_name not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `event_name` ({0}), must be one of {1}"  # noqa: E501
                .format(event_name, allowed_values)
            )

        self._event_name = event_name

    @property
    def webhook_name(self):
        """Gets the webhook_name of this WebhookEmailOpenedPayload.  # noqa: E501

        Name of the webhook being triggered  # noqa: E501

        :return: The webhook_name of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._webhook_name

    @webhook_name.setter
    def webhook_name(self, webhook_name):
        """Sets the webhook_name of this WebhookEmailOpenedPayload.

        Name of the webhook being triggered  # noqa: E501

        :param webhook_name: The webhook_name of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """

        self._webhook_name = webhook_name

    @property
    def inbox_id(self):
        """Gets the inbox_id of this WebhookEmailOpenedPayload.  # noqa: E501

        Id of the inbox  # noqa: E501

        :return: The inbox_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._inbox_id

    @inbox_id.setter
    def inbox_id(self, inbox_id):
        """Sets the inbox_id of this WebhookEmailOpenedPayload.

        Id of the inbox  # noqa: E501

        :param inbox_id: The inbox_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and inbox_id is None:  # noqa: E501
            raise ValueError("Invalid value for `inbox_id`, must not be `None`")  # noqa: E501

        self._inbox_id = inbox_id

    @property
    def pixel_id(self):
        """Gets the pixel_id of this WebhookEmailOpenedPayload.  # noqa: E501

        ID of the tracking pixel  # noqa: E501

        :return: The pixel_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._pixel_id

    @pixel_id.setter
    def pixel_id(self, pixel_id):
        """Sets the pixel_id of this WebhookEmailOpenedPayload.

        ID of the tracking pixel  # noqa: E501

        :param pixel_id: The pixel_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and pixel_id is None:  # noqa: E501
            raise ValueError("Invalid value for `pixel_id`, must not be `None`")  # noqa: E501

        self._pixel_id = pixel_id

    @property
    def sent_email_id(self):
        """Gets the sent_email_id of this WebhookEmailOpenedPayload.  # noqa: E501

        ID of sent email  # noqa: E501

        :return: The sent_email_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._sent_email_id

    @sent_email_id.setter
    def sent_email_id(self, sent_email_id):
        """Sets the sent_email_id of this WebhookEmailOpenedPayload.

        ID of sent email  # noqa: E501

        :param sent_email_id: The sent_email_id of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and sent_email_id is None:  # noqa: E501
            raise ValueError("Invalid value for `sent_email_id`, must not be `None`")  # noqa: E501

        self._sent_email_id = sent_email_id

    @property
    def recipient(self):
        """Gets the recipient of this WebhookEmailOpenedPayload.  # noqa: E501

        Email address for the recipient of the tracking pixel  # noqa: E501

        :return: The recipient of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: str
        """
        return self._recipient

    @recipient.setter
    def recipient(self, recipient):
        """Sets the recipient of this WebhookEmailOpenedPayload.

        Email address for the recipient of the tracking pixel  # noqa: E501

        :param recipient: The recipient of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and recipient is None:  # noqa: E501
            raise ValueError("Invalid value for `recipient`, must not be `None`")  # noqa: E501

        self._recipient = recipient

    @property
    def created_at(self):
        """Gets the created_at of this WebhookEmailOpenedPayload.  # noqa: E501

        Date time of event creation  # noqa: E501

        :return: The created_at of this WebhookEmailOpenedPayload.  # noqa: E501
        :rtype: datetime
        """
        return self._created_at

    @created_at.setter
    def created_at(self, created_at):
        """Sets the created_at of this WebhookEmailOpenedPayload.

        Date time of event creation  # noqa: E501

        :param created_at: The created_at of this WebhookEmailOpenedPayload.  # noqa: E501
        :type: datetime
        """
        if self.local_vars_configuration.client_side_validation and created_at is None:  # noqa: E501
            raise ValueError("Invalid value for `created_at`, must not be `None`")  # noqa: E501

        self._created_at = created_at

    def to_dict(self):
        """Returns the model properties as a dict"""
        result = {}

        for attr, _ in six.iteritems(self.openapi_types):
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Returns the string representation of the model"""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`"""
        return self.to_str()

    def __eq__(self, other):
        """Returns true if both objects are equal"""
        if not isinstance(other, WebhookEmailOpenedPayload):
            return False

        return self.to_dict() == other.to_dict()

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        if not isinstance(other, WebhookEmailOpenedPayload):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop created_at

Gets the created_at of this WebhookEmailOpenedPayload. # noqa: E501

Date time of event creation # noqa: E501

:return: The created_at of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: datetime

Expand source code

@property
def created_at(self):
    """Gets the created_at of this WebhookEmailOpenedPayload.  # noqa: E501

    Date time of event creation  # noqa: E501

    :return: The created_at of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: datetime
    """
    return self._created_at

prop event_name

Gets the event_name of this WebhookEmailOpenedPayload. # noqa: E501

Name of the event type webhook is being triggered for. # noqa: E501

:return: The event_name of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def event_name(self):
    """Gets the event_name of this WebhookEmailOpenedPayload.  # noqa: E501

    Name of the event type webhook is being triggered for.  # noqa: E501

    :return: The event_name of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._event_name

prop inbox_id

Gets the inbox_id of this WebhookEmailOpenedPayload. # noqa: E501

Id of the inbox # noqa: E501

:return: The inbox_id of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def inbox_id(self):
    """Gets the inbox_id of this WebhookEmailOpenedPayload.  # noqa: E501

    Id of the inbox  # noqa: E501

    :return: The inbox_id of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._inbox_id

prop message_id

Gets the message_id of this WebhookEmailOpenedPayload. # noqa: E501

Idempotent message ID. Store this ID locally or in a database to prevent message duplication. # noqa: E501

:return: The message_id of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def message_id(self):
    """Gets the message_id of this WebhookEmailOpenedPayload.  # noqa: E501

    Idempotent message ID. Store this ID locally or in a database to prevent message duplication.  # noqa: E501

    :return: The message_id of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._message_id

prop pixel_id

Gets the pixel_id of this WebhookEmailOpenedPayload. # noqa: E501

ID of the tracking pixel # noqa: E501

:return: The pixel_id of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def pixel_id(self):
    """Gets the pixel_id of this WebhookEmailOpenedPayload.  # noqa: E501

    ID of the tracking pixel  # noqa: E501

    :return: The pixel_id of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._pixel_id

prop recipient

Gets the recipient of this WebhookEmailOpenedPayload. # noqa: E501

Email address for the recipient of the tracking pixel # noqa: E501

:return: The recipient of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def recipient(self):
    """Gets the recipient of this WebhookEmailOpenedPayload.  # noqa: E501

    Email address for the recipient of the tracking pixel  # noqa: E501

    :return: The recipient of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._recipient

prop sent_email_id

Gets the sent_email_id of this WebhookEmailOpenedPayload. # noqa: E501

ID of sent email # noqa: E501

:return: The sent_email_id of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def sent_email_id(self):
    """Gets the sent_email_id of this WebhookEmailOpenedPayload.  # noqa: E501

    ID of sent email  # noqa: E501

    :return: The sent_email_id of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._sent_email_id

prop webhook_id

Gets the webhook_id of this WebhookEmailOpenedPayload. # noqa: E501

ID of webhook entity being triggered # noqa: E501

:return: The webhook_id of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def webhook_id(self):
    """Gets the webhook_id of this WebhookEmailOpenedPayload.  # noqa: E501

    ID of webhook entity being triggered  # noqa: E501

    :return: The webhook_id of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._webhook_id

prop webhook_name

Gets the webhook_name of this WebhookEmailOpenedPayload. # noqa: E501

Name of the webhook being triggered # noqa: E501

:return: The webhook_name of this WebhookEmailOpenedPayload. # noqa: E501 :rtype: str

Expand source code

@property
def webhook_name(self):
    """Gets the webhook_name of this WebhookEmailOpenedPayload.  # noqa: E501

    Name of the webhook being triggered  # noqa: E501

    :return: The webhook_name of this WebhookEmailOpenedPayload.  # noqa: E501
    :rtype: str
    """
    return self._webhook_name

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model