Module mailslurp_client.models.deliverability_analytics_series_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 DeliverabilityAnalyticsSeriesDto (since=None, before=None, scope=None, bucket=None, summary=None, runs=None, points=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.

DeliverabilityAnalyticsSeriesDto - a model defined in OpenAPI

Expand source code

class DeliverabilityAnalyticsSeriesDto(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 = {
        'since': 'datetime',
        'before': 'datetime',
        'scope': 'str',
        'bucket': 'str',
        'summary': 'DeliverabilityAnalyticsSummaryDto',
        'runs': 'list[DeliverabilityAnalyticsRunDto]',
        'points': 'list[DeliverabilityAnalyticsSeriesPointDto]'
    }

    attribute_map = {
        'since': 'since',
        'before': 'before',
        'scope': 'scope',
        'bucket': 'bucket',
        'summary': 'summary',
        'runs': 'runs',
        'points': 'points'
    }

    def __init__(self, since=None, before=None, scope=None, bucket=None, summary=None, runs=None, points=None, local_vars_configuration=None):  # noqa: E501
        """DeliverabilityAnalyticsSeriesDto - 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._since = None
        self._before = None
        self._scope = None
        self._bucket = None
        self._summary = None
        self._runs = None
        self._points = None
        self.discriminator = None

        self.since = since
        self.before = before
        self.scope = scope
        self.bucket = bucket
        self.summary = summary
        self.runs = runs
        self.points = points

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


        :return: The since of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: datetime
        """
        return self._since

    @since.setter
    def since(self, since):
        """Sets the since of this DeliverabilityAnalyticsSeriesDto.


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

        self._since = since

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


        :return: The before of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: datetime
        """
        return self._before

    @before.setter
    def before(self, before):
        """Sets the before of this DeliverabilityAnalyticsSeriesDto.


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

        self._before = before

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


        :return: The scope of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: str
        """
        return self._scope

    @scope.setter
    def scope(self, scope):
        """Sets the scope of this DeliverabilityAnalyticsSeriesDto.


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

        self._scope = scope

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


        :return: The bucket of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: str
        """
        return self._bucket

    @bucket.setter
    def bucket(self, bucket):
        """Sets the bucket of this DeliverabilityAnalyticsSeriesDto.


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

        self._bucket = bucket

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


        :return: The summary of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: DeliverabilityAnalyticsSummaryDto
        """
        return self._summary

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


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


        :return: The runs of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: list[DeliverabilityAnalyticsRunDto]
        """
        return self._runs

    @runs.setter
    def runs(self, runs):
        """Sets the runs of this DeliverabilityAnalyticsSeriesDto.


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

        self._runs = runs

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


        :return: The points of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
        :rtype: list[DeliverabilityAnalyticsSeriesPointDto]
        """
        return self._points

    @points.setter
    def points(self, points):
        """Sets the points of this DeliverabilityAnalyticsSeriesDto.


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

        self._points = points

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop before

Gets the before of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The before of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The before of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: datetime
    """
    return self._before

prop bucket

Gets the bucket of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The bucket of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The bucket of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: str
    """
    return self._bucket

prop points

Gets the points of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The points of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: list[DeliverabilityAnalyticsSeriesPointDto]

Expand source code

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


    :return: The points of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: list[DeliverabilityAnalyticsSeriesPointDto]
    """
    return self._points

prop runs

Gets the runs of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The runs of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: list[DeliverabilityAnalyticsRunDto]

Expand source code

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


    :return: The runs of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: list[DeliverabilityAnalyticsRunDto]
    """
    return self._runs

prop scope

Gets the scope of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The scope of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The scope of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: str
    """
    return self._scope

prop since

Gets the since of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The since of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The since of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: datetime
    """
    return self._since

prop summary

Gets the summary of this DeliverabilityAnalyticsSeriesDto. # noqa: E501

:return: The summary of this DeliverabilityAnalyticsSeriesDto. # noqa: E501 :rtype: DeliverabilityAnalyticsSummaryDto

Expand source code

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


    :return: The summary of this DeliverabilityAnalyticsSeriesDto.  # noqa: E501
    :rtype: DeliverabilityAnalyticsSummaryDto
    """
    return self._summary

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model