Module mailslurp_client.models.inbox_placement_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 InboxPlacementAnalyticsSeriesDto (since=None, before=None, bucket=None, group_by=None, sender_domain=None, from_email=None, summary=None, runs=None, points=None, groups=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.

InboxPlacementAnalyticsSeriesDto - a model defined in OpenAPI

Expand source code

class InboxPlacementAnalyticsSeriesDto(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',
        'bucket': 'str',
        'group_by': 'str',
        'sender_domain': 'str',
        'from_email': 'str',
        'summary': 'InboxPlacementAnalyticsSummaryDto',
        'runs': 'list[InboxPlacementAnalyticsRunDto]',
        'points': 'list[InboxPlacementAnalyticsSeriesPointDto]',
        'groups': 'list[InboxPlacementAnalyticsGroupSeriesDto]'
    }

    attribute_map = {
        'since': 'since',
        'before': 'before',
        'bucket': 'bucket',
        'group_by': 'groupBy',
        'sender_domain': 'senderDomain',
        'from_email': 'fromEmail',
        'summary': 'summary',
        'runs': 'runs',
        'points': 'points',
        'groups': 'groups'
    }

    def __init__(self, since=None, before=None, bucket=None, group_by=None, sender_domain=None, from_email=None, summary=None, runs=None, points=None, groups=None, local_vars_configuration=None):  # noqa: E501
        """InboxPlacementAnalyticsSeriesDto - 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._bucket = None
        self._group_by = None
        self._sender_domain = None
        self._from_email = None
        self._summary = None
        self._runs = None
        self._points = None
        self._groups = None
        self.discriminator = None

        self.since = since
        self.before = before
        self.bucket = bucket
        self.group_by = group_by
        self.sender_domain = sender_domain
        self.from_email = from_email
        self.summary = summary
        self.runs = runs
        self.points = points
        self.groups = groups

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


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

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


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


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

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


        :param before: The before of this InboxPlacementAnalyticsSeriesDto.  # 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 bucket(self):
        """Gets the bucket of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501


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

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


        :param bucket: The bucket of this InboxPlacementAnalyticsSeriesDto.  # 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 group_by(self):
        """Gets the group_by of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501


        :return: The group_by of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :rtype: str
        """
        return self._group_by

    @group_by.setter
    def group_by(self, group_by):
        """Sets the group_by of this InboxPlacementAnalyticsSeriesDto.


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

        self._group_by = group_by

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


        :return: The sender_domain of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :rtype: str
        """
        return self._sender_domain

    @sender_domain.setter
    def sender_domain(self, sender_domain):
        """Sets the sender_domain of this InboxPlacementAnalyticsSeriesDto.


        :param sender_domain: The sender_domain of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :type: str
        """

        self._sender_domain = sender_domain

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


        :return: The from_email of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :rtype: str
        """
        return self._from_email

    @from_email.setter
    def from_email(self, from_email):
        """Sets the from_email of this InboxPlacementAnalyticsSeriesDto.


        :param from_email: The from_email of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :type: str
        """

        self._from_email = from_email

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


        :return: The summary of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :rtype: InboxPlacementAnalyticsSummaryDto
        """
        return self._summary

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


        :param summary: The summary of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :type: InboxPlacementAnalyticsSummaryDto
        """
        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 InboxPlacementAnalyticsSeriesDto.  # noqa: E501


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

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


        :param runs: The runs of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :type: list[InboxPlacementAnalyticsRunDto]
        """
        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 InboxPlacementAnalyticsSeriesDto.  # noqa: E501


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

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


        :param points: The points of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :type: list[InboxPlacementAnalyticsSeriesPointDto]
        """
        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

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


        :return: The groups of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
        :rtype: list[InboxPlacementAnalyticsGroupSeriesDto]
        """
        return self._groups

    @groups.setter
    def groups(self, groups):
        """Sets the groups of this InboxPlacementAnalyticsSeriesDto.


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

        self._groups = groups

    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, InboxPlacementAnalyticsSeriesDto):
            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, InboxPlacementAnalyticsSeriesDto):
            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 InboxPlacementAnalyticsSeriesDto. # noqa: E501

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

Expand source code

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


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

prop bucket

Gets the bucket of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

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

Expand source code

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


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

prop from_email

Gets the from_email of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The from_email of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The from_email of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
    :rtype: str
    """
    return self._from_email

prop group_by

Gets the group_by of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The group_by of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The group_by of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
    :rtype: str
    """
    return self._group_by

prop groups

Gets the groups of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The groups of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: list[InboxPlacementAnalyticsGroupSeriesDto]

Expand source code

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


    :return: The groups of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
    :rtype: list[InboxPlacementAnalyticsGroupSeriesDto]
    """
    return self._groups

prop points

Gets the points of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The points of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: list[InboxPlacementAnalyticsSeriesPointDto]

Expand source code

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


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

prop runs

Gets the runs of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The runs of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: list[InboxPlacementAnalyticsRunDto]

Expand source code

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


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

prop sender_domain

Gets the sender_domain of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The sender_domain of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sender_domain of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
    :rtype: str
    """
    return self._sender_domain

prop since

Gets the since of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

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

Expand source code

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


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

prop summary

Gets the summary of this InboxPlacementAnalyticsSeriesDto. # noqa: E501

:return: The summary of this InboxPlacementAnalyticsSeriesDto. # noqa: E501 :rtype: InboxPlacementAnalyticsSummaryDto

Expand source code

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


    :return: The summary of this InboxPlacementAnalyticsSeriesDto.  # noqa: E501
    :rtype: InboxPlacementAnalyticsSummaryDto
    """
    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