Module mailslurp_client.models.inbox_placement_analytics_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 InboxPlacementAnalyticsBreakdownDto (since=None, before=None, sender_domain=None, from_email=None, summary=None, folders=None, providers=None, sender_domains=None, from_emails=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.

InboxPlacementAnalyticsBreakdownDto - a model defined in OpenAPI

Expand source code

class InboxPlacementAnalyticsBreakdownDto(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 = {
        'since': 'datetime',
        'before': 'datetime',
        'sender_domain': 'str',
        'from_email': 'str',
        'summary': 'InboxPlacementAnalyticsSummaryDto',
        'folders': 'list[InboxPlacementFolderBreakdownDto]',
        'providers': 'list[InboxPlacementProviderBreakdownDto]',
        'sender_domains': 'list[InboxPlacementSenderBreakdownDto]',
        'from_emails': 'list[InboxPlacementSenderBreakdownDto]'
    }

    attribute_map = {
        'since': 'since',
        'before': 'before',
        'sender_domain': 'senderDomain',
        'from_email': 'fromEmail',
        'summary': 'summary',
        'folders': 'folders',
        'providers': 'providers',
        'sender_domains': 'senderDomains',
        'from_emails': 'fromEmails'
    }

    def __init__(self, since=None, before=None, sender_domain=None, from_email=None, summary=None, folders=None, providers=None, sender_domains=None, from_emails=None, local_vars_configuration=None):  # noqa: E501
        """InboxPlacementAnalyticsBreakdownDto - 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._since = None
        self._before = None
        self._sender_domain = None
        self._from_email = None
        self._summary = None
        self._folders = None
        self._providers = None
        self._sender_domains = None
        self._from_emails = None
        self.discriminator = None

        self.since = since
        self.before = before
        self.sender_domain = sender_domain
        self.from_email = from_email
        self.summary = summary
        self.folders = folders
        self.providers = providers
        self.sender_domains = sender_domains
        self.from_emails = from_emails

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


        :return: The since of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: datetime
        """
        return self._since

    @since.setter
    def since(self, since):
        """Sets the since of this InboxPlacementAnalyticsBreakdownDto.


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

        self._since = since

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


        :return: The before of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: datetime
        """
        return self._before

    @before.setter
    def before(self, before):
        """Sets the before of this InboxPlacementAnalyticsBreakdownDto.


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

        self._before = before

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


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

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


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

        self._sender_domain = sender_domain

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


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

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


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

        self._from_email = from_email

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


        :return: The summary of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: InboxPlacementAnalyticsSummaryDto
        """
        return self._summary

    @summary.setter
    def summary(self, summary):
        """Sets the summary of this InboxPlacementAnalyticsBreakdownDto.


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

        self._summary = summary

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


        :return: The folders of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: list[InboxPlacementFolderBreakdownDto]
        """
        return self._folders

    @folders.setter
    def folders(self, folders):
        """Sets the folders of this InboxPlacementAnalyticsBreakdownDto.


        :param folders: The folders of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :type: list[InboxPlacementFolderBreakdownDto]
        """
        if self.local_vars_configuration.client_side_validation and folders is None:  # noqa: E501
            raise ValueError("Invalid value for `folders`, must not be `None`")  # noqa: E501

        self._folders = folders

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


        :return: The providers of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: list[InboxPlacementProviderBreakdownDto]
        """
        return self._providers

    @providers.setter
    def providers(self, providers):
        """Sets the providers of this InboxPlacementAnalyticsBreakdownDto.


        :param providers: The providers of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :type: list[InboxPlacementProviderBreakdownDto]
        """
        if self.local_vars_configuration.client_side_validation and providers is None:  # noqa: E501
            raise ValueError("Invalid value for `providers`, must not be `None`")  # noqa: E501

        self._providers = providers

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


        :return: The sender_domains of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: list[InboxPlacementSenderBreakdownDto]
        """
        return self._sender_domains

    @sender_domains.setter
    def sender_domains(self, sender_domains):
        """Sets the sender_domains of this InboxPlacementAnalyticsBreakdownDto.


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

        self._sender_domains = sender_domains

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


        :return: The from_emails of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
        :rtype: list[InboxPlacementSenderBreakdownDto]
        """
        return self._from_emails

    @from_emails.setter
    def from_emails(self, from_emails):
        """Sets the from_emails of this InboxPlacementAnalyticsBreakdownDto.


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

        self._from_emails = from_emails

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop before

Gets the before of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The before of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The before of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: datetime
    """
    return self._before

prop folders

Gets the folders of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The folders of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: list[InboxPlacementFolderBreakdownDto]

Expand source code

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


    :return: The folders of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: list[InboxPlacementFolderBreakdownDto]
    """
    return self._folders

prop from_email

Gets the from_email of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

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

Expand source code

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


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

prop from_emails

Gets the from_emails of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The from_emails of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: list[InboxPlacementSenderBreakdownDto]

Expand source code

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


    :return: The from_emails of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: list[InboxPlacementSenderBreakdownDto]
    """
    return self._from_emails

prop providers

Gets the providers of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The providers of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: list[InboxPlacementProviderBreakdownDto]

Expand source code

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


    :return: The providers of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: list[InboxPlacementProviderBreakdownDto]
    """
    return self._providers

prop sender_domain

Gets the sender_domain of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

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

Expand source code

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


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

prop sender_domains

Gets the sender_domains of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The sender_domains of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: list[InboxPlacementSenderBreakdownDto]

Expand source code

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


    :return: The sender_domains of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: list[InboxPlacementSenderBreakdownDto]
    """
    return self._sender_domains

prop since

Gets the since of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The since of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The since of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: datetime
    """
    return self._since

prop summary

Gets the summary of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501

:return: The summary of this InboxPlacementAnalyticsBreakdownDto. # noqa: E501 :rtype: InboxPlacementAnalyticsSummaryDto

Expand source code

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


    :return: The summary of this InboxPlacementAnalyticsBreakdownDto.  # noqa: E501
    :rtype: InboxPlacementAnalyticsSummaryDto
    """
    return self._summary

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model