Module mailslurp_client.models.inbox_retention_policy_run_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 InboxRetentionPolicyRunDto (id=None, status=None, source=None, matched_policies=None, applied_policies=None, error_message=None, started_at=None, completed_at=None, created_at=None, updated_at=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.

InboxRetentionPolicyRunDto - a model defined in OpenAPI

Expand source code
class InboxRetentionPolicyRunDto(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 = {
        'id': 'str',
        'status': 'str',
        'source': 'str',
        'matched_policies': 'int',
        'applied_policies': 'int',
        'error_message': 'str',
        'started_at': 'datetime',
        'completed_at': 'datetime',
        'created_at': 'datetime',
        'updated_at': 'datetime'
    }

    attribute_map = {
        'id': 'id',
        'status': 'status',
        'source': 'source',
        'matched_policies': 'matchedPolicies',
        'applied_policies': 'appliedPolicies',
        'error_message': 'errorMessage',
        'started_at': 'startedAt',
        'completed_at': 'completedAt',
        'created_at': 'createdAt',
        'updated_at': 'updatedAt'
    }

    def __init__(self, id=None, status=None, source=None, matched_policies=None, applied_policies=None, error_message=None, started_at=None, completed_at=None, created_at=None, updated_at=None, local_vars_configuration=None):  # noqa: E501
        """InboxRetentionPolicyRunDto - 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._id = None
        self._status = None
        self._source = None
        self._matched_policies = None
        self._applied_policies = None
        self._error_message = None
        self._started_at = None
        self._completed_at = None
        self._created_at = None
        self._updated_at = None
        self.discriminator = None

        self.id = id
        self.status = status
        self.source = source
        self.matched_policies = matched_policies
        self.applied_policies = applied_policies
        self.error_message = error_message
        self.started_at = started_at
        self.completed_at = completed_at
        self.created_at = created_at
        self.updated_at = updated_at

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


        :return: The id of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """Sets the id of this InboxRetentionPolicyRunDto.


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

        self._id = id

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


        :return: The status of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: str
        """
        return self._status

    @status.setter
    def status(self, status):
        """Sets the status of this InboxRetentionPolicyRunDto.


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

        self._status = status

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


        :return: The source of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: str
        """
        return self._source

    @source.setter
    def source(self, source):
        """Sets the source of this InboxRetentionPolicyRunDto.


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

        self._source = source

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


        :return: The matched_policies of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: int
        """
        return self._matched_policies

    @matched_policies.setter
    def matched_policies(self, matched_policies):
        """Sets the matched_policies of this InboxRetentionPolicyRunDto.


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

        self._matched_policies = matched_policies

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


        :return: The applied_policies of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: int
        """
        return self._applied_policies

    @applied_policies.setter
    def applied_policies(self, applied_policies):
        """Sets the applied_policies of this InboxRetentionPolicyRunDto.


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

        self._applied_policies = applied_policies

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


        :return: The error_message of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: str
        """
        return self._error_message

    @error_message.setter
    def error_message(self, error_message):
        """Sets the error_message of this InboxRetentionPolicyRunDto.


        :param error_message: The error_message of this InboxRetentionPolicyRunDto.  # noqa: E501
        :type: str
        """

        self._error_message = error_message

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


        :return: The started_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: datetime
        """
        return self._started_at

    @started_at.setter
    def started_at(self, started_at):
        """Sets the started_at of this InboxRetentionPolicyRunDto.


        :param started_at: The started_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :type: datetime
        """

        self._started_at = started_at

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


        :return: The completed_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: datetime
        """
        return self._completed_at

    @completed_at.setter
    def completed_at(self, completed_at):
        """Sets the completed_at of this InboxRetentionPolicyRunDto.


        :param completed_at: The completed_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :type: datetime
        """

        self._completed_at = completed_at

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


        :return: The created_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: datetime
        """
        return self._created_at

    @created_at.setter
    def created_at(self, created_at):
        """Sets the created_at of this InboxRetentionPolicyRunDto.


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

        self._created_at = created_at

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


        :return: The updated_at of this InboxRetentionPolicyRunDto.  # noqa: E501
        :rtype: datetime
        """
        return self._updated_at

    @updated_at.setter
    def updated_at(self, updated_at):
        """Sets the updated_at of this InboxRetentionPolicyRunDto.


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

        self._updated_at = updated_at

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

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

Class variables

var attribute_map
var openapi_types

Instance variables

prop applied_policies

Gets the applied_policies of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The applied_policies of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: int

Expand source code
@property
def applied_policies(self):
    """Gets the applied_policies of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The applied_policies of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: int
    """
    return self._applied_policies
prop completed_at

Gets the completed_at of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The completed_at of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: datetime

Expand source code
@property
def completed_at(self):
    """Gets the completed_at of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The completed_at of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: datetime
    """
    return self._completed_at
prop created_at

Gets the created_at of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The created_at of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: datetime

Expand source code
@property
def created_at(self):
    """Gets the created_at of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The created_at of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: datetime
    """
    return self._created_at
prop error_message

Gets the error_message of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The error_message of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: str

Expand source code
@property
def error_message(self):
    """Gets the error_message of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The error_message of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: str
    """
    return self._error_message
prop id

Gets the id of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The id of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: str

Expand source code
@property
def id(self):
    """Gets the id of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The id of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: str
    """
    return self._id
prop matched_policies

Gets the matched_policies of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The matched_policies of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: int

Expand source code
@property
def matched_policies(self):
    """Gets the matched_policies of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The matched_policies of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: int
    """
    return self._matched_policies
prop source

Gets the source of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The source of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: str

Expand source code
@property
def source(self):
    """Gets the source of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The source of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: str
    """
    return self._source
prop started_at

Gets the started_at of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The started_at of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: datetime

Expand source code
@property
def started_at(self):
    """Gets the started_at of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The started_at of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: datetime
    """
    return self._started_at
prop status

Gets the status of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The status of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: str

Expand source code
@property
def status(self):
    """Gets the status of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The status of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: str
    """
    return self._status
prop updated_at

Gets the updated_at of this InboxRetentionPolicyRunDto. # noqa: E501

:return: The updated_at of this InboxRetentionPolicyRunDto. # noqa: E501 :rtype: datetime

Expand source code
@property
def updated_at(self):
    """Gets the updated_at of this InboxRetentionPolicyRunDto.  # noqa: E501


    :return: The updated_at of this InboxRetentionPolicyRunDto.  # noqa: E501
    :rtype: datetime
    """
    return self._updated_at

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model