Module mailslurp_client.models.email_warmup_overview_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 EmailWarmupOverviewDto (from_date=None, through_date=None, total_programs=None, active_programs=None, ramping_programs=None, maintenance_programs=None, paused_programs=None, attention_required_programs=None, accepted_sends=None, failed_sends=None, daily_activity=None, program_progress=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.

EmailWarmupOverviewDto - a model defined in OpenAPI

Expand source code

class EmailWarmupOverviewDto(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 = {
        'from_date': 'date',
        'through_date': 'date',
        'total_programs': 'int',
        'active_programs': 'int',
        'ramping_programs': 'int',
        'maintenance_programs': 'int',
        'paused_programs': 'int',
        'attention_required_programs': 'int',
        'accepted_sends': 'int',
        'failed_sends': 'int',
        'daily_activity': 'list[EmailWarmupDailyActivityDto]',
        'program_progress': 'list[EmailWarmupProgramProgressDto]'
    }

    attribute_map = {
        'from_date': 'fromDate',
        'through_date': 'throughDate',
        'total_programs': 'totalPrograms',
        'active_programs': 'activePrograms',
        'ramping_programs': 'rampingPrograms',
        'maintenance_programs': 'maintenancePrograms',
        'paused_programs': 'pausedPrograms',
        'attention_required_programs': 'attentionRequiredPrograms',
        'accepted_sends': 'acceptedSends',
        'failed_sends': 'failedSends',
        'daily_activity': 'dailyActivity',
        'program_progress': 'programProgress'
    }

    def __init__(self, from_date=None, through_date=None, total_programs=None, active_programs=None, ramping_programs=None, maintenance_programs=None, paused_programs=None, attention_required_programs=None, accepted_sends=None, failed_sends=None, daily_activity=None, program_progress=None, local_vars_configuration=None):  # noqa: E501
        """EmailWarmupOverviewDto - 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._from_date = None
        self._through_date = None
        self._total_programs = None
        self._active_programs = None
        self._ramping_programs = None
        self._maintenance_programs = None
        self._paused_programs = None
        self._attention_required_programs = None
        self._accepted_sends = None
        self._failed_sends = None
        self._daily_activity = None
        self._program_progress = None
        self.discriminator = None

        self.from_date = from_date
        self.through_date = through_date
        self.total_programs = total_programs
        self.active_programs = active_programs
        self.ramping_programs = ramping_programs
        self.maintenance_programs = maintenance_programs
        self.paused_programs = paused_programs
        self.attention_required_programs = attention_required_programs
        self.accepted_sends = accepted_sends
        self.failed_sends = failed_sends
        self.daily_activity = daily_activity
        self.program_progress = program_progress

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


        :return: The from_date of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: date
        """
        return self._from_date

    @from_date.setter
    def from_date(self, from_date):
        """Sets the from_date of this EmailWarmupOverviewDto.


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

        self._from_date = from_date

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


        :return: The through_date of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: date
        """
        return self._through_date

    @through_date.setter
    def through_date(self, through_date):
        """Sets the through_date of this EmailWarmupOverviewDto.


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

        self._through_date = through_date

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


        :return: The total_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._total_programs

    @total_programs.setter
    def total_programs(self, total_programs):
        """Sets the total_programs of this EmailWarmupOverviewDto.


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

        self._total_programs = total_programs

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


        :return: The active_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._active_programs

    @active_programs.setter
    def active_programs(self, active_programs):
        """Sets the active_programs of this EmailWarmupOverviewDto.


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

        self._active_programs = active_programs

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


        :return: The ramping_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._ramping_programs

    @ramping_programs.setter
    def ramping_programs(self, ramping_programs):
        """Sets the ramping_programs of this EmailWarmupOverviewDto.


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

        self._ramping_programs = ramping_programs

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


        :return: The maintenance_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._maintenance_programs

    @maintenance_programs.setter
    def maintenance_programs(self, maintenance_programs):
        """Sets the maintenance_programs of this EmailWarmupOverviewDto.


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

        self._maintenance_programs = maintenance_programs

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


        :return: The paused_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._paused_programs

    @paused_programs.setter
    def paused_programs(self, paused_programs):
        """Sets the paused_programs of this EmailWarmupOverviewDto.


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

        self._paused_programs = paused_programs

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


        :return: The attention_required_programs of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._attention_required_programs

    @attention_required_programs.setter
    def attention_required_programs(self, attention_required_programs):
        """Sets the attention_required_programs of this EmailWarmupOverviewDto.


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

        self._attention_required_programs = attention_required_programs

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


        :return: The accepted_sends of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._accepted_sends

    @accepted_sends.setter
    def accepted_sends(self, accepted_sends):
        """Sets the accepted_sends of this EmailWarmupOverviewDto.


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

        self._accepted_sends = accepted_sends

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


        :return: The failed_sends of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: int
        """
        return self._failed_sends

    @failed_sends.setter
    def failed_sends(self, failed_sends):
        """Sets the failed_sends of this EmailWarmupOverviewDto.


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

        self._failed_sends = failed_sends

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


        :return: The daily_activity of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: list[EmailWarmupDailyActivityDto]
        """
        return self._daily_activity

    @daily_activity.setter
    def daily_activity(self, daily_activity):
        """Sets the daily_activity of this EmailWarmupOverviewDto.


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

        self._daily_activity = daily_activity

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


        :return: The program_progress of this EmailWarmupOverviewDto.  # noqa: E501
        :rtype: list[EmailWarmupProgramProgressDto]
        """
        return self._program_progress

    @program_progress.setter
    def program_progress(self, program_progress):
        """Sets the program_progress of this EmailWarmupOverviewDto.


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

        self._program_progress = program_progress

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop accepted_sends

Gets the accepted_sends of this EmailWarmupOverviewDto. # noqa: E501

:return: The accepted_sends of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The accepted_sends of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._accepted_sends

prop active_programs

Gets the active_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The active_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The active_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._active_programs

prop attention_required_programs

Gets the attention_required_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The attention_required_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The attention_required_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._attention_required_programs

prop daily_activity

Gets the daily_activity of this EmailWarmupOverviewDto. # noqa: E501

:return: The daily_activity of this EmailWarmupOverviewDto. # noqa: E501 :rtype: list[EmailWarmupDailyActivityDto]

Expand source code

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


    :return: The daily_activity of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: list[EmailWarmupDailyActivityDto]
    """
    return self._daily_activity

prop failed_sends

Gets the failed_sends of this EmailWarmupOverviewDto. # noqa: E501

:return: The failed_sends of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The failed_sends of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._failed_sends

prop from_date

Gets the from_date of this EmailWarmupOverviewDto. # noqa: E501

:return: The from_date of this EmailWarmupOverviewDto. # noqa: E501 :rtype: date

Expand source code

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


    :return: The from_date of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: date
    """
    return self._from_date

prop maintenance_programs

Gets the maintenance_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The maintenance_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The maintenance_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._maintenance_programs

prop paused_programs

Gets the paused_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The paused_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The paused_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._paused_programs

prop program_progress

Gets the program_progress of this EmailWarmupOverviewDto. # noqa: E501

:return: The program_progress of this EmailWarmupOverviewDto. # noqa: E501 :rtype: list[EmailWarmupProgramProgressDto]

Expand source code

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


    :return: The program_progress of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: list[EmailWarmupProgramProgressDto]
    """
    return self._program_progress

prop ramping_programs

Gets the ramping_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The ramping_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The ramping_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._ramping_programs

prop through_date

Gets the through_date of this EmailWarmupOverviewDto. # noqa: E501

:return: The through_date of this EmailWarmupOverviewDto. # noqa: E501 :rtype: date

Expand source code

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


    :return: The through_date of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: date
    """
    return self._through_date

prop total_programs

Gets the total_programs of this EmailWarmupOverviewDto. # noqa: E501

:return: The total_programs of this EmailWarmupOverviewDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_programs of this EmailWarmupOverviewDto.  # noqa: E501
    :rtype: int
    """
    return self._total_programs

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model