Module mailslurp_client.models.inbox_placement_sender_breakdown_dto

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 InboxPlacementSenderBreakdownDto (key=None, label=None, sender_domain=None, from_email=None, run_count=None, last_run_at=None, metrics=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.

InboxPlacementSenderBreakdownDto - a model defined in OpenAPI

Expand source code
class InboxPlacementSenderBreakdownDto(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 = {
        'key': 'str',
        'label': 'str',
        'sender_domain': 'str',
        'from_email': 'str',
        'run_count': 'int',
        'last_run_at': 'datetime',
        'metrics': 'InboxPlacementAnalyticsSummaryDto'
    }

    attribute_map = {
        'key': 'key',
        'label': 'label',
        'sender_domain': 'senderDomain',
        'from_email': 'fromEmail',
        'run_count': 'runCount',
        'last_run_at': 'lastRunAt',
        'metrics': 'metrics'
    }

    def __init__(self, key=None, label=None, sender_domain=None, from_email=None, run_count=None, last_run_at=None, metrics=None, local_vars_configuration=None):  # noqa: E501
        """InboxPlacementSenderBreakdownDto - 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._key = None
        self._label = None
        self._sender_domain = None
        self._from_email = None
        self._run_count = None
        self._last_run_at = None
        self._metrics = None
        self.discriminator = None

        self.key = key
        self.label = label
        self.sender_domain = sender_domain
        self.from_email = from_email
        self.run_count = run_count
        self.last_run_at = last_run_at
        self.metrics = metrics

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


        :return: The key of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: str
        """
        return self._key

    @key.setter
    def key(self, key):
        """Sets the key of this InboxPlacementSenderBreakdownDto.


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

        self._key = key

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


        :return: The label of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: str
        """
        return self._label

    @label.setter
    def label(self, label):
        """Sets the label of this InboxPlacementSenderBreakdownDto.


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

        self._label = label

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


        :return: The sender_domain of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: str
        """
        return self._sender_domain

    @sender_domain.setter
    def sender_domain(self, sender_domain):
        """Sets the sender_domain of this InboxPlacementSenderBreakdownDto.


        :param sender_domain: The sender_domain of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :type: str
        """

        self._sender_domain = sender_domain

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


        :return: The from_email of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: str
        """
        return self._from_email

    @from_email.setter
    def from_email(self, from_email):
        """Sets the from_email of this InboxPlacementSenderBreakdownDto.


        :param from_email: The from_email of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :type: str
        """

        self._from_email = from_email

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


        :return: The run_count of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: int
        """
        return self._run_count

    @run_count.setter
    def run_count(self, run_count):
        """Sets the run_count of this InboxPlacementSenderBreakdownDto.


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

        self._run_count = run_count

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


        :return: The last_run_at of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: datetime
        """
        return self._last_run_at

    @last_run_at.setter
    def last_run_at(self, last_run_at):
        """Sets the last_run_at of this InboxPlacementSenderBreakdownDto.


        :param last_run_at: The last_run_at of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :type: datetime
        """

        self._last_run_at = last_run_at

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


        :return: The metrics of this InboxPlacementSenderBreakdownDto.  # noqa: E501
        :rtype: InboxPlacementAnalyticsSummaryDto
        """
        return self._metrics

    @metrics.setter
    def metrics(self, metrics):
        """Sets the metrics of this InboxPlacementSenderBreakdownDto.


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

        self._metrics = metrics

    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, InboxPlacementSenderBreakdownDto):
            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, InboxPlacementSenderBreakdownDto):
            return True

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

Class variables

var attribute_map
var openapi_types

Instance variables

prop from_email

Gets the from_email of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The from_email of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: str

Expand source code
@property
def from_email(self):
    """Gets the from_email of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The from_email of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: str
    """
    return self._from_email
prop key

Gets the key of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The key of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: str

Expand source code
@property
def key(self):
    """Gets the key of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The key of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: str
    """
    return self._key
prop label

Gets the label of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The label of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: str

Expand source code
@property
def label(self):
    """Gets the label of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The label of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: str
    """
    return self._label
prop last_run_at

Gets the last_run_at of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The last_run_at of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: datetime

Expand source code
@property
def last_run_at(self):
    """Gets the last_run_at of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The last_run_at of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: datetime
    """
    return self._last_run_at
prop metrics

Gets the metrics of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The metrics of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: InboxPlacementAnalyticsSummaryDto

Expand source code
@property
def metrics(self):
    """Gets the metrics of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The metrics of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: InboxPlacementAnalyticsSummaryDto
    """
    return self._metrics
prop run_count

Gets the run_count of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The run_count of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: int

Expand source code
@property
def run_count(self):
    """Gets the run_count of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The run_count of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: int
    """
    return self._run_count
prop sender_domain

Gets the sender_domain of this InboxPlacementSenderBreakdownDto. # noqa: E501

:return: The sender_domain of this InboxPlacementSenderBreakdownDto. # noqa: E501 :rtype: str

Expand source code
@property
def sender_domain(self):
    """Gets the sender_domain of this InboxPlacementSenderBreakdownDto.  # noqa: E501


    :return: The sender_domain of this InboxPlacementSenderBreakdownDto.  # noqa: E501
    :rtype: str
    """
    return self._sender_domain

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model