Module mailslurp_client.models.email_warmup_readiness_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 EmailWarmupReadinessDto (status=None, summary=None, ready_for_daily_volume=None, goal_daily_volume=None, estimated_ready_at=None, today=None, pacing=None, placement_deltas=None, domain_health=None, postmaster_signals=None, recommendations=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.

EmailWarmupReadinessDto - a model defined in OpenAPI

Expand source code

class EmailWarmupReadinessDto(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 = {
        'status': 'str',
        'summary': 'str',
        'ready_for_daily_volume': 'int',
        'goal_daily_volume': 'int',
        'estimated_ready_at': 'date',
        'today': 'EmailWarmupTodayDto',
        'pacing': 'EmailWarmupPacingDto',
        'placement_deltas': 'list[EmailWarmupPlacementDeltaDto]',
        'domain_health': 'EmailWarmupDomainHealthDto',
        'postmaster_signals': 'EmailWarmupPostmasterSignalsDto',
        'recommendations': 'list[str]'
    }

    attribute_map = {
        'status': 'status',
        'summary': 'summary',
        'ready_for_daily_volume': 'readyForDailyVolume',
        'goal_daily_volume': 'goalDailyVolume',
        'estimated_ready_at': 'estimatedReadyAt',
        'today': 'today',
        'pacing': 'pacing',
        'placement_deltas': 'placementDeltas',
        'domain_health': 'domainHealth',
        'postmaster_signals': 'postmasterSignals',
        'recommendations': 'recommendations'
    }

    def __init__(self, status=None, summary=None, ready_for_daily_volume=None, goal_daily_volume=None, estimated_ready_at=None, today=None, pacing=None, placement_deltas=None, domain_health=None, postmaster_signals=None, recommendations=None, local_vars_configuration=None):  # noqa: E501
        """EmailWarmupReadinessDto - 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._status = None
        self._summary = None
        self._ready_for_daily_volume = None
        self._goal_daily_volume = None
        self._estimated_ready_at = None
        self._today = None
        self._pacing = None
        self._placement_deltas = None
        self._domain_health = None
        self._postmaster_signals = None
        self._recommendations = None
        self.discriminator = None

        self.status = status
        self.summary = summary
        self.ready_for_daily_volume = ready_for_daily_volume
        self.goal_daily_volume = goal_daily_volume
        self.estimated_ready_at = estimated_ready_at
        self.today = today
        self.pacing = pacing
        self.placement_deltas = placement_deltas
        self.domain_health = domain_health
        self.postmaster_signals = postmaster_signals
        self.recommendations = recommendations

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


        :return: The status of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: str
        """
        return self._status

    @status.setter
    def status(self, status):
        """Sets the status of this EmailWarmupReadinessDto.


        :param status: The status of this EmailWarmupReadinessDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and status is None:  # noqa: E501
            raise ValueError("Invalid value for `status`, must not be `None`")  # noqa: E501
        allowed_values = ["PREPARING", "IMPROVING", "READY", "NEEDS_ATTENTION"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and status not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `status` ({0}), must be one of {1}"  # noqa: E501
                .format(status, allowed_values)
            )

        self._status = status

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


        :return: The summary of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: str
        """
        return self._summary

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


        :param summary: The summary of this EmailWarmupReadinessDto.  # noqa: E501
        :type: str
        """
        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 ready_for_daily_volume(self):
        """Gets the ready_for_daily_volume of this EmailWarmupReadinessDto.  # noqa: E501


        :return: The ready_for_daily_volume of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: int
        """
        return self._ready_for_daily_volume

    @ready_for_daily_volume.setter
    def ready_for_daily_volume(self, ready_for_daily_volume):
        """Sets the ready_for_daily_volume of this EmailWarmupReadinessDto.


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

        self._ready_for_daily_volume = ready_for_daily_volume

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


        :return: The goal_daily_volume of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: int
        """
        return self._goal_daily_volume

    @goal_daily_volume.setter
    def goal_daily_volume(self, goal_daily_volume):
        """Sets the goal_daily_volume of this EmailWarmupReadinessDto.


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

        self._goal_daily_volume = goal_daily_volume

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


        :return: The estimated_ready_at of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: date
        """
        return self._estimated_ready_at

    @estimated_ready_at.setter
    def estimated_ready_at(self, estimated_ready_at):
        """Sets the estimated_ready_at of this EmailWarmupReadinessDto.


        :param estimated_ready_at: The estimated_ready_at of this EmailWarmupReadinessDto.  # noqa: E501
        :type: date
        """

        self._estimated_ready_at = estimated_ready_at

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


        :return: The today of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: EmailWarmupTodayDto
        """
        return self._today

    @today.setter
    def today(self, today):
        """Sets the today of this EmailWarmupReadinessDto.


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

        self._today = today

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


        :return: The pacing of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: EmailWarmupPacingDto
        """
        return self._pacing

    @pacing.setter
    def pacing(self, pacing):
        """Sets the pacing of this EmailWarmupReadinessDto.


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

        self._pacing = pacing

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


        :return: The placement_deltas of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: list[EmailWarmupPlacementDeltaDto]
        """
        return self._placement_deltas

    @placement_deltas.setter
    def placement_deltas(self, placement_deltas):
        """Sets the placement_deltas of this EmailWarmupReadinessDto.


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

        self._placement_deltas = placement_deltas

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


        :return: The domain_health of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: EmailWarmupDomainHealthDto
        """
        return self._domain_health

    @domain_health.setter
    def domain_health(self, domain_health):
        """Sets the domain_health of this EmailWarmupReadinessDto.


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

        self._domain_health = domain_health

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


        :return: The postmaster_signals of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: EmailWarmupPostmasterSignalsDto
        """
        return self._postmaster_signals

    @postmaster_signals.setter
    def postmaster_signals(self, postmaster_signals):
        """Sets the postmaster_signals of this EmailWarmupReadinessDto.


        :param postmaster_signals: The postmaster_signals of this EmailWarmupReadinessDto.  # noqa: E501
        :type: EmailWarmupPostmasterSignalsDto
        """

        self._postmaster_signals = postmaster_signals

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


        :return: The recommendations of this EmailWarmupReadinessDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._recommendations

    @recommendations.setter
    def recommendations(self, recommendations):
        """Sets the recommendations of this EmailWarmupReadinessDto.


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

        self._recommendations = recommendations

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop domain_health

Gets the domain_health of this EmailWarmupReadinessDto. # noqa: E501

:return: The domain_health of this EmailWarmupReadinessDto. # noqa: E501 :rtype: EmailWarmupDomainHealthDto

Expand source code

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


    :return: The domain_health of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: EmailWarmupDomainHealthDto
    """
    return self._domain_health

prop estimated_ready_at

Gets the estimated_ready_at of this EmailWarmupReadinessDto. # noqa: E501

:return: The estimated_ready_at of this EmailWarmupReadinessDto. # noqa: E501 :rtype: date

Expand source code

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


    :return: The estimated_ready_at of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: date
    """
    return self._estimated_ready_at

prop goal_daily_volume

Gets the goal_daily_volume of this EmailWarmupReadinessDto. # noqa: E501

:return: The goal_daily_volume of this EmailWarmupReadinessDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The goal_daily_volume of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: int
    """
    return self._goal_daily_volume

prop pacing

Gets the pacing of this EmailWarmupReadinessDto. # noqa: E501

:return: The pacing of this EmailWarmupReadinessDto. # noqa: E501 :rtype: EmailWarmupPacingDto

Expand source code

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


    :return: The pacing of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: EmailWarmupPacingDto
    """
    return self._pacing

prop placement_deltas

Gets the placement_deltas of this EmailWarmupReadinessDto. # noqa: E501

:return: The placement_deltas of this EmailWarmupReadinessDto. # noqa: E501 :rtype: list[EmailWarmupPlacementDeltaDto]

Expand source code

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


    :return: The placement_deltas of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: list[EmailWarmupPlacementDeltaDto]
    """
    return self._placement_deltas

prop postmaster_signals

Gets the postmaster_signals of this EmailWarmupReadinessDto. # noqa: E501

:return: The postmaster_signals of this EmailWarmupReadinessDto. # noqa: E501 :rtype: EmailWarmupPostmasterSignalsDto

Expand source code

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


    :return: The postmaster_signals of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: EmailWarmupPostmasterSignalsDto
    """
    return self._postmaster_signals

prop ready_for_daily_volume

Gets the ready_for_daily_volume of this EmailWarmupReadinessDto. # noqa: E501

:return: The ready_for_daily_volume of this EmailWarmupReadinessDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The ready_for_daily_volume of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: int
    """
    return self._ready_for_daily_volume

prop recommendations

Gets the recommendations of this EmailWarmupReadinessDto. # noqa: E501

:return: The recommendations of this EmailWarmupReadinessDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The recommendations of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._recommendations

prop status

Gets the status of this EmailWarmupReadinessDto. # noqa: E501

:return: The status of this EmailWarmupReadinessDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The status of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: str
    """
    return self._status

prop summary

Gets the summary of this EmailWarmupReadinessDto. # noqa: E501

:return: The summary of this EmailWarmupReadinessDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The summary of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: str
    """
    return self._summary

prop today

Gets the today of this EmailWarmupReadinessDto. # noqa: E501

:return: The today of this EmailWarmupReadinessDto. # noqa: E501 :rtype: EmailWarmupTodayDto

Expand source code

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


    :return: The today of this EmailWarmupReadinessDto.  # noqa: E501
    :rtype: EmailWarmupTodayDto
    """
    return self._today

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model