Module mailslurp_client.models.email_warmup_program_analytics_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 EmailWarmupProgramAnalyticsDto (program_id=None, from_date=None, through_date=None, progress=None, total_scheduled_sends=None, total_accepted_sends=None, total_observed_sends=None, total_failed_sends=None, attention_required_sends=None, daily_activity=None, placement_checks=None, readiness=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.

EmailWarmupProgramAnalyticsDto - a model defined in OpenAPI

Expand source code

class EmailWarmupProgramAnalyticsDto(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',
        'from_date': 'date',
        'through_date': 'date',
        'progress': 'EmailWarmupProgramProgressDto',
        'total_scheduled_sends': 'int',
        'total_accepted_sends': 'int',
        'total_observed_sends': 'int',
        'total_failed_sends': 'int',
        'attention_required_sends': 'int',
        'daily_activity': 'list[EmailWarmupDailyActivityDto]',
        'placement_checks': 'list[EmailWarmupPlacementCheckDto]',
        'readiness': 'EmailWarmupReadinessDto'
    }

    attribute_map = {
        'program_id': 'programId',
        'from_date': 'fromDate',
        'through_date': 'throughDate',
        'progress': 'progress',
        'total_scheduled_sends': 'totalScheduledSends',
        'total_accepted_sends': 'totalAcceptedSends',
        'total_observed_sends': 'totalObservedSends',
        'total_failed_sends': 'totalFailedSends',
        'attention_required_sends': 'attentionRequiredSends',
        'daily_activity': 'dailyActivity',
        'placement_checks': 'placementChecks',
        'readiness': 'readiness'
    }

    def __init__(self, program_id=None, from_date=None, through_date=None, progress=None, total_scheduled_sends=None, total_accepted_sends=None, total_observed_sends=None, total_failed_sends=None, attention_required_sends=None, daily_activity=None, placement_checks=None, readiness=None, local_vars_configuration=None):  # noqa: E501
        """EmailWarmupProgramAnalyticsDto - 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._from_date = None
        self._through_date = None
        self._progress = None
        self._total_scheduled_sends = None
        self._total_accepted_sends = None
        self._total_observed_sends = None
        self._total_failed_sends = None
        self._attention_required_sends = None
        self._daily_activity = None
        self._placement_checks = None
        self._readiness = None
        self.discriminator = None

        self.program_id = program_id
        self.from_date = from_date
        self.through_date = through_date
        self.progress = progress
        self.total_scheduled_sends = total_scheduled_sends
        self.total_accepted_sends = total_accepted_sends
        self.total_observed_sends = total_observed_sends
        self.total_failed_sends = total_failed_sends
        self.attention_required_sends = attention_required_sends
        self.daily_activity = daily_activity
        self.placement_checks = placement_checks
        self.readiness = readiness

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


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

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


        :param program_id: The program_id of this EmailWarmupProgramAnalyticsDto.  # 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 from_date(self):
        """Gets the from_date of this EmailWarmupProgramAnalyticsDto.  # noqa: E501


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

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


        :param from_date: The from_date of this EmailWarmupProgramAnalyticsDto.  # 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 EmailWarmupProgramAnalyticsDto.  # noqa: E501


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

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


        :param through_date: The through_date of this EmailWarmupProgramAnalyticsDto.  # 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 progress(self):
        """Gets the progress of this EmailWarmupProgramAnalyticsDto.  # noqa: E501


        :return: The progress of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: EmailWarmupProgramProgressDto
        """
        return self._progress

    @progress.setter
    def progress(self, progress):
        """Sets the progress of this EmailWarmupProgramAnalyticsDto.


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

        self._progress = progress

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


        :return: The total_scheduled_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: int
        """
        return self._total_scheduled_sends

    @total_scheduled_sends.setter
    def total_scheduled_sends(self, total_scheduled_sends):
        """Sets the total_scheduled_sends of this EmailWarmupProgramAnalyticsDto.


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

        self._total_scheduled_sends = total_scheduled_sends

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


        :return: The total_accepted_sends of this EmailWarmupProgramAnalyticsDto.  # 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 EmailWarmupProgramAnalyticsDto.


        :param total_accepted_sends: The total_accepted_sends of this EmailWarmupProgramAnalyticsDto.  # 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

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


        :return: The total_observed_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: int
        """
        return self._total_observed_sends

    @total_observed_sends.setter
    def total_observed_sends(self, total_observed_sends):
        """Sets the total_observed_sends of this EmailWarmupProgramAnalyticsDto.


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

        self._total_observed_sends = total_observed_sends

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


        :return: The total_failed_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: int
        """
        return self._total_failed_sends

    @total_failed_sends.setter
    def total_failed_sends(self, total_failed_sends):
        """Sets the total_failed_sends of this EmailWarmupProgramAnalyticsDto.


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

        self._total_failed_sends = total_failed_sends

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


        :return: The attention_required_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: int
        """
        return self._attention_required_sends

    @attention_required_sends.setter
    def attention_required_sends(self, attention_required_sends):
        """Sets the attention_required_sends of this EmailWarmupProgramAnalyticsDto.


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

        self._attention_required_sends = attention_required_sends

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


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

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


        :param daily_activity: The daily_activity of this EmailWarmupProgramAnalyticsDto.  # 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 placement_checks(self):
        """Gets the placement_checks of this EmailWarmupProgramAnalyticsDto.  # noqa: E501


        :return: The placement_checks of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: list[EmailWarmupPlacementCheckDto]
        """
        return self._placement_checks

    @placement_checks.setter
    def placement_checks(self, placement_checks):
        """Sets the placement_checks of this EmailWarmupProgramAnalyticsDto.


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

        self._placement_checks = placement_checks

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


        :return: The readiness of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :rtype: EmailWarmupReadinessDto
        """
        return self._readiness

    @readiness.setter
    def readiness(self, readiness):
        """Sets the readiness of this EmailWarmupProgramAnalyticsDto.


        :param readiness: The readiness of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
        :type: EmailWarmupReadinessDto
        """

        self._readiness = readiness

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop attention_required_sends

Gets the attention_required_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The attention_required_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The attention_required_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: int
    """
    return self._attention_required_sends

prop daily_activity

Gets the daily_activity of this EmailWarmupProgramAnalyticsDto. # noqa: E501

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

Expand source code

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


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

prop from_date

Gets the from_date of this EmailWarmupProgramAnalyticsDto. # noqa: E501

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

Expand source code

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


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

prop placement_checks

Gets the placement_checks of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The placement_checks of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: list[EmailWarmupPlacementCheckDto]

Expand source code

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


    :return: The placement_checks of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: list[EmailWarmupPlacementCheckDto]
    """
    return self._placement_checks

prop program_id

Gets the program_id of this EmailWarmupProgramAnalyticsDto. # noqa: E501

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

Expand source code

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


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

prop progress

Gets the progress of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The progress of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: EmailWarmupProgramProgressDto

Expand source code

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


    :return: The progress of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: EmailWarmupProgramProgressDto
    """
    return self._progress

prop readiness

Gets the readiness of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The readiness of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: EmailWarmupReadinessDto

Expand source code

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


    :return: The readiness of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: EmailWarmupReadinessDto
    """
    return self._readiness

prop through_date

Gets the through_date of this EmailWarmupProgramAnalyticsDto. # noqa: E501

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

Expand source code

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


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

prop total_accepted_sends

Gets the total_accepted_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501

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

Expand source code

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


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

prop total_failed_sends

Gets the total_failed_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The total_failed_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_failed_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: int
    """
    return self._total_failed_sends

prop total_observed_sends

Gets the total_observed_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The total_observed_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_observed_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: int
    """
    return self._total_observed_sends

prop total_scheduled_sends

Gets the total_scheduled_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501

:return: The total_scheduled_sends of this EmailWarmupProgramAnalyticsDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_scheduled_sends of this EmailWarmupProgramAnalyticsDto.  # noqa: E501
    :rtype: int
    """
    return self._total_scheduled_sends

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model