Module mailslurp_client.models.email_warmup_pacing_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 EmailWarmupPacingDto (configured_daily_target=None, effective_daily_target=None, action=None, reason_code=None, explanation=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.

EmailWarmupPacingDto - a model defined in OpenAPI

Expand source code

class EmailWarmupPacingDto(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 = {
        'configured_daily_target': 'int',
        'effective_daily_target': 'int',
        'action': 'str',
        'reason_code': 'str',
        'explanation': 'str'
    }

    attribute_map = {
        'configured_daily_target': 'configuredDailyTarget',
        'effective_daily_target': 'effectiveDailyTarget',
        'action': 'action',
        'reason_code': 'reasonCode',
        'explanation': 'explanation'
    }

    def __init__(self, configured_daily_target=None, effective_daily_target=None, action=None, reason_code=None, explanation=None, local_vars_configuration=None):  # noqa: E501
        """EmailWarmupPacingDto - 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._configured_daily_target = None
        self._effective_daily_target = None
        self._action = None
        self._reason_code = None
        self._explanation = None
        self.discriminator = None

        self.configured_daily_target = configured_daily_target
        self.effective_daily_target = effective_daily_target
        self.action = action
        self.reason_code = reason_code
        self.explanation = explanation

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


        :return: The configured_daily_target of this EmailWarmupPacingDto.  # noqa: E501
        :rtype: int
        """
        return self._configured_daily_target

    @configured_daily_target.setter
    def configured_daily_target(self, configured_daily_target):
        """Sets the configured_daily_target of this EmailWarmupPacingDto.


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

        self._configured_daily_target = configured_daily_target

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


        :return: The effective_daily_target of this EmailWarmupPacingDto.  # noqa: E501
        :rtype: int
        """
        return self._effective_daily_target

    @effective_daily_target.setter
    def effective_daily_target(self, effective_daily_target):
        """Sets the effective_daily_target of this EmailWarmupPacingDto.


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

        self._effective_daily_target = effective_daily_target

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


        :return: The action of this EmailWarmupPacingDto.  # noqa: E501
        :rtype: str
        """
        return self._action

    @action.setter
    def action(self, action):
        """Sets the action of this EmailWarmupPacingDto.


        :param action: The action of this EmailWarmupPacingDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and action is None:  # noqa: E501
            raise ValueError("Invalid value for `action`, must not be `None`")  # noqa: E501
        allowed_values = ["INCREASE", "HOLD", "REDUCE"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and action not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `action` ({0}), must be one of {1}"  # noqa: E501
                .format(action, allowed_values)
            )

        self._action = action

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


        :return: The reason_code of this EmailWarmupPacingDto.  # noqa: E501
        :rtype: str
        """
        return self._reason_code

    @reason_code.setter
    def reason_code(self, reason_code):
        """Sets the reason_code of this EmailWarmupPacingDto.


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

        self._reason_code = reason_code

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


        :return: The explanation of this EmailWarmupPacingDto.  # noqa: E501
        :rtype: str
        """
        return self._explanation

    @explanation.setter
    def explanation(self, explanation):
        """Sets the explanation of this EmailWarmupPacingDto.


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

        self._explanation = explanation

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop action

Gets the action of this EmailWarmupPacingDto. # noqa: E501

:return: The action of this EmailWarmupPacingDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The action of this EmailWarmupPacingDto.  # noqa: E501
    :rtype: str
    """
    return self._action

prop configured_daily_target

Gets the configured_daily_target of this EmailWarmupPacingDto. # noqa: E501

:return: The configured_daily_target of this EmailWarmupPacingDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The configured_daily_target of this EmailWarmupPacingDto.  # noqa: E501
    :rtype: int
    """
    return self._configured_daily_target

prop effective_daily_target

Gets the effective_daily_target of this EmailWarmupPacingDto. # noqa: E501

:return: The effective_daily_target of this EmailWarmupPacingDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The effective_daily_target of this EmailWarmupPacingDto.  # noqa: E501
    :rtype: int
    """
    return self._effective_daily_target

prop explanation

Gets the explanation of this EmailWarmupPacingDto. # noqa: E501

:return: The explanation of this EmailWarmupPacingDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The explanation of this EmailWarmupPacingDto.  # noqa: E501
    :rtype: str
    """
    return self._explanation

prop reason_code

Gets the reason_code of this EmailWarmupPacingDto. # noqa: E501

:return: The reason_code of this EmailWarmupPacingDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The reason_code of this EmailWarmupPacingDto.  # noqa: E501
    :rtype: str
    """
    return self._reason_code

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model