Module mailslurp_client.models.postmaster_traffic_stats_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 PostmasterTrafficStatsDto (name=None, domain=None, report_date=None, user_reported_spam_ratio=None, domain_reputation=None, ip_reputations=None, spf_success_ratio=None, dkim_success_ratio=None, dmarc_success_ratio=None, outbound_encryption_ratio=None, inbound_encryption_ratio=None, payload=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.

PostmasterTrafficStatsDto - a model defined in OpenAPI

Expand source code

class PostmasterTrafficStatsDto(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 = {
        'name': 'str',
        'domain': 'str',
        'report_date': 'date',
        'user_reported_spam_ratio': 'float',
        'domain_reputation': 'str',
        'ip_reputations': 'list[PostmasterIpReputationDto]',
        'spf_success_ratio': 'float',
        'dkim_success_ratio': 'float',
        'dmarc_success_ratio': 'float',
        'outbound_encryption_ratio': 'float',
        'inbound_encryption_ratio': 'float',
        'payload': 'object'
    }

    attribute_map = {
        'name': 'name',
        'domain': 'domain',
        'report_date': 'reportDate',
        'user_reported_spam_ratio': 'userReportedSpamRatio',
        'domain_reputation': 'domainReputation',
        'ip_reputations': 'ipReputations',
        'spf_success_ratio': 'spfSuccessRatio',
        'dkim_success_ratio': 'dkimSuccessRatio',
        'dmarc_success_ratio': 'dmarcSuccessRatio',
        'outbound_encryption_ratio': 'outboundEncryptionRatio',
        'inbound_encryption_ratio': 'inboundEncryptionRatio',
        'payload': 'payload'
    }

    def __init__(self, name=None, domain=None, report_date=None, user_reported_spam_ratio=None, domain_reputation=None, ip_reputations=None, spf_success_ratio=None, dkim_success_ratio=None, dmarc_success_ratio=None, outbound_encryption_ratio=None, inbound_encryption_ratio=None, payload=None, local_vars_configuration=None):  # noqa: E501
        """PostmasterTrafficStatsDto - 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._name = None
        self._domain = None
        self._report_date = None
        self._user_reported_spam_ratio = None
        self._domain_reputation = None
        self._ip_reputations = None
        self._spf_success_ratio = None
        self._dkim_success_ratio = None
        self._dmarc_success_ratio = None
        self._outbound_encryption_ratio = None
        self._inbound_encryption_ratio = None
        self._payload = None
        self.discriminator = None

        self.name = name
        self.domain = domain
        self.report_date = report_date
        self.user_reported_spam_ratio = user_reported_spam_ratio
        self.domain_reputation = domain_reputation
        self.ip_reputations = ip_reputations
        self.spf_success_ratio = spf_success_ratio
        self.dkim_success_ratio = dkim_success_ratio
        self.dmarc_success_ratio = dmarc_success_ratio
        self.outbound_encryption_ratio = outbound_encryption_ratio
        self.inbound_encryption_ratio = inbound_encryption_ratio
        self.payload = payload

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


        :return: The name of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """Sets the name of this PostmasterTrafficStatsDto.


        :param name: The name of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: str
        """

        self._name = name

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


        :return: The domain of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: str
        """
        return self._domain

    @domain.setter
    def domain(self, domain):
        """Sets the domain of this PostmasterTrafficStatsDto.


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

        self._domain = domain

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


        :return: The report_date of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: date
        """
        return self._report_date

    @report_date.setter
    def report_date(self, report_date):
        """Sets the report_date of this PostmasterTrafficStatsDto.


        :param report_date: The report_date of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: date
        """

        self._report_date = report_date

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


        :return: The user_reported_spam_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._user_reported_spam_ratio

    @user_reported_spam_ratio.setter
    def user_reported_spam_ratio(self, user_reported_spam_ratio):
        """Sets the user_reported_spam_ratio of this PostmasterTrafficStatsDto.


        :param user_reported_spam_ratio: The user_reported_spam_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._user_reported_spam_ratio = user_reported_spam_ratio

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


        :return: The domain_reputation of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: str
        """
        return self._domain_reputation

    @domain_reputation.setter
    def domain_reputation(self, domain_reputation):
        """Sets the domain_reputation of this PostmasterTrafficStatsDto.


        :param domain_reputation: The domain_reputation of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: str
        """

        self._domain_reputation = domain_reputation

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


        :return: The ip_reputations of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: list[PostmasterIpReputationDto]
        """
        return self._ip_reputations

    @ip_reputations.setter
    def ip_reputations(self, ip_reputations):
        """Sets the ip_reputations of this PostmasterTrafficStatsDto.


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

        self._ip_reputations = ip_reputations

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


        :return: The spf_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._spf_success_ratio

    @spf_success_ratio.setter
    def spf_success_ratio(self, spf_success_ratio):
        """Sets the spf_success_ratio of this PostmasterTrafficStatsDto.


        :param spf_success_ratio: The spf_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._spf_success_ratio = spf_success_ratio

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


        :return: The dkim_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._dkim_success_ratio

    @dkim_success_ratio.setter
    def dkim_success_ratio(self, dkim_success_ratio):
        """Sets the dkim_success_ratio of this PostmasterTrafficStatsDto.


        :param dkim_success_ratio: The dkim_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._dkim_success_ratio = dkim_success_ratio

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


        :return: The dmarc_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._dmarc_success_ratio

    @dmarc_success_ratio.setter
    def dmarc_success_ratio(self, dmarc_success_ratio):
        """Sets the dmarc_success_ratio of this PostmasterTrafficStatsDto.


        :param dmarc_success_ratio: The dmarc_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._dmarc_success_ratio = dmarc_success_ratio

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


        :return: The outbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._outbound_encryption_ratio

    @outbound_encryption_ratio.setter
    def outbound_encryption_ratio(self, outbound_encryption_ratio):
        """Sets the outbound_encryption_ratio of this PostmasterTrafficStatsDto.


        :param outbound_encryption_ratio: The outbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._outbound_encryption_ratio = outbound_encryption_ratio

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


        :return: The inbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: float
        """
        return self._inbound_encryption_ratio

    @inbound_encryption_ratio.setter
    def inbound_encryption_ratio(self, inbound_encryption_ratio):
        """Sets the inbound_encryption_ratio of this PostmasterTrafficStatsDto.


        :param inbound_encryption_ratio: The inbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
        :type: float
        """

        self._inbound_encryption_ratio = inbound_encryption_ratio

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


        :return: The payload of this PostmasterTrafficStatsDto.  # noqa: E501
        :rtype: object
        """
        return self._payload

    @payload.setter
    def payload(self, payload):
        """Sets the payload of this PostmasterTrafficStatsDto.


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

        self._payload = payload

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop dkim_success_ratio

Gets the dkim_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The dkim_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The dkim_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._dkim_success_ratio

prop dmarc_success_ratio

Gets the dmarc_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The dmarc_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The dmarc_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._dmarc_success_ratio

prop domain

Gets the domain of this PostmasterTrafficStatsDto. # noqa: E501

:return: The domain of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The domain of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: str
    """
    return self._domain

prop domain_reputation

Gets the domain_reputation of this PostmasterTrafficStatsDto. # noqa: E501

:return: The domain_reputation of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The domain_reputation of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: str
    """
    return self._domain_reputation

prop inbound_encryption_ratio

Gets the inbound_encryption_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The inbound_encryption_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The inbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._inbound_encryption_ratio

prop ip_reputations

Gets the ip_reputations of this PostmasterTrafficStatsDto. # noqa: E501

:return: The ip_reputations of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: list[PostmasterIpReputationDto]

Expand source code

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


    :return: The ip_reputations of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: list[PostmasterIpReputationDto]
    """
    return self._ip_reputations

prop name

Gets the name of this PostmasterTrafficStatsDto. # noqa: E501

:return: The name of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The name of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: str
    """
    return self._name

prop outbound_encryption_ratio

Gets the outbound_encryption_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The outbound_encryption_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The outbound_encryption_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._outbound_encryption_ratio

prop payload

Gets the payload of this PostmasterTrafficStatsDto. # noqa: E501

:return: The payload of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: object

Expand source code

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


    :return: The payload of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: object
    """
    return self._payload

prop report_date

Gets the report_date of this PostmasterTrafficStatsDto. # noqa: E501

:return: The report_date of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: date

Expand source code

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


    :return: The report_date of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: date
    """
    return self._report_date

prop spf_success_ratio

Gets the spf_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The spf_success_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The spf_success_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._spf_success_ratio

prop user_reported_spam_ratio

Gets the user_reported_spam_ratio of this PostmasterTrafficStatsDto. # noqa: E501

:return: The user_reported_spam_ratio of this PostmasterTrafficStatsDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The user_reported_spam_ratio of this PostmasterTrafficStatsDto.  # noqa: E501
    :rtype: float
    """
    return self._user_reported_spam_ratio

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model