Module mailslurp_client.models.email_warmup_program_progress_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 EmailWarmupProgramProgressDto (program_id=None, current_ramp_day=None, ramp_duration_days=None, progress_percent=None, total_accepted_sends=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.

EmailWarmupProgramProgressDto - a model defined in OpenAPI

Expand source code

class EmailWarmupProgramProgressDto(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 = {
        'program_id': 'str',
        'current_ramp_day': 'int',
        'ramp_duration_days': 'int',
        'progress_percent': 'int',
        'total_accepted_sends': 'int'
    }

    attribute_map = {
        'program_id': 'programId',
        'current_ramp_day': 'currentRampDay',
        'ramp_duration_days': 'rampDurationDays',
        'progress_percent': 'progressPercent',
        'total_accepted_sends': 'totalAcceptedSends'
    }

    def __init__(self, program_id=None, current_ramp_day=None, ramp_duration_days=None, progress_percent=None, total_accepted_sends=None, local_vars_configuration=None):  # noqa: E501
        """EmailWarmupProgramProgressDto - 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._program_id = None
        self._current_ramp_day = None
        self._ramp_duration_days = None
        self._progress_percent = None
        self._total_accepted_sends = None
        self.discriminator = None

        self.program_id = program_id
        self.current_ramp_day = current_ramp_day
        self.ramp_duration_days = ramp_duration_days
        self.progress_percent = progress_percent
        self.total_accepted_sends = total_accepted_sends

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


        :return: The program_id of this EmailWarmupProgramProgressDto.  # noqa: E501
        :rtype: str
        """
        return self._program_id

    @program_id.setter
    def program_id(self, program_id):
        """Sets the program_id of this EmailWarmupProgramProgressDto.


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

        self._program_id = program_id

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


        :return: The current_ramp_day of this EmailWarmupProgramProgressDto.  # noqa: E501
        :rtype: int
        """
        return self._current_ramp_day

    @current_ramp_day.setter
    def current_ramp_day(self, current_ramp_day):
        """Sets the current_ramp_day of this EmailWarmupProgramProgressDto.


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

        self._current_ramp_day = current_ramp_day

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


        :return: The ramp_duration_days of this EmailWarmupProgramProgressDto.  # noqa: E501
        :rtype: int
        """
        return self._ramp_duration_days

    @ramp_duration_days.setter
    def ramp_duration_days(self, ramp_duration_days):
        """Sets the ramp_duration_days of this EmailWarmupProgramProgressDto.


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

        self._ramp_duration_days = ramp_duration_days

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


        :return: The progress_percent of this EmailWarmupProgramProgressDto.  # noqa: E501
        :rtype: int
        """
        return self._progress_percent

    @progress_percent.setter
    def progress_percent(self, progress_percent):
        """Sets the progress_percent of this EmailWarmupProgramProgressDto.


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

        self._progress_percent = progress_percent

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


        :return: The total_accepted_sends of this EmailWarmupProgramProgressDto.  # noqa: E501
        :rtype: int
        """
        return self._total_accepted_sends

    @total_accepted_sends.setter
    def total_accepted_sends(self, total_accepted_sends):
        """Sets the total_accepted_sends of this EmailWarmupProgramProgressDto.


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

        self._total_accepted_sends = total_accepted_sends

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop current_ramp_day

Gets the current_ramp_day of this EmailWarmupProgramProgressDto. # noqa: E501

:return: The current_ramp_day of this EmailWarmupProgramProgressDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The current_ramp_day of this EmailWarmupProgramProgressDto.  # noqa: E501
    :rtype: int
    """
    return self._current_ramp_day

prop program_id

Gets the program_id of this EmailWarmupProgramProgressDto. # noqa: E501

:return: The program_id of this EmailWarmupProgramProgressDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The program_id of this EmailWarmupProgramProgressDto.  # noqa: E501
    :rtype: str
    """
    return self._program_id

prop progress_percent

Gets the progress_percent of this EmailWarmupProgramProgressDto. # noqa: E501

:return: The progress_percent of this EmailWarmupProgramProgressDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The progress_percent of this EmailWarmupProgramProgressDto.  # noqa: E501
    :rtype: int
    """
    return self._progress_percent

prop ramp_duration_days

Gets the ramp_duration_days of this EmailWarmupProgramProgressDto. # noqa: E501

:return: The ramp_duration_days of this EmailWarmupProgramProgressDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The ramp_duration_days of this EmailWarmupProgramProgressDto.  # noqa: E501
    :rtype: int
    """
    return self._ramp_duration_days

prop total_accepted_sends

Gets the total_accepted_sends of this EmailWarmupProgramProgressDto. # noqa: E501

:return: The total_accepted_sends of this EmailWarmupProgramProgressDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_accepted_sends of this EmailWarmupProgramProgressDto.  # noqa: E501
    :rtype: int
    """
    return self._total_accepted_sends

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model