Module mailslurp_client.models.email_audit_check

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 EmailAuditCheck (id=None, category=None, status=None, title=None, message=None, recommendation=None, evidence=None, reference_url=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.

EmailAuditCheck - a model defined in OpenAPI

Expand source code

class EmailAuditCheck(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',
        'category': 'str',
        'status': 'str',
        'title': 'str',
        'message': 'str',
        'recommendation': 'str',
        'evidence': 'list[str]',
        'reference_url': 'str'
    }

    attribute_map = {
        'id': 'id',
        'category': 'category',
        'status': 'status',
        'title': 'title',
        'message': 'message',
        'recommendation': 'recommendation',
        'evidence': 'evidence',
        'reference_url': 'referenceUrl'
    }

    def __init__(self, id=None, category=None, status=None, title=None, message=None, recommendation=None, evidence=None, reference_url=None, local_vars_configuration=None):  # noqa: E501
        """EmailAuditCheck - 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._category = None
        self._status = None
        self._title = None
        self._message = None
        self._recommendation = None
        self._evidence = None
        self._reference_url = None
        self.discriminator = None

        self.id = id
        self.category = category
        self.status = status
        self.title = title
        self.message = message
        self.recommendation = recommendation
        self.evidence = evidence
        self.reference_url = reference_url

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


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

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


        :param id: The id of this EmailAuditCheck.  # 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 category(self):
        """Gets the category of this EmailAuditCheck.  # noqa: E501

        Email audit check category  # noqa: E501

        :return: The category of this EmailAuditCheck.  # noqa: E501
        :rtype: str
        """
        return self._category

    @category.setter
    def category(self, category):
        """Sets the category of this EmailAuditCheck.

        Email audit check category  # noqa: E501

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

        self._category = category

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

        Outcome of an automated email check; REVIEW requires human verification and is not a compliance verdict  # noqa: E501

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

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

        Outcome of an automated email check; REVIEW requires human verification and is not a compliance verdict  # noqa: E501

        :param status: The status of this EmailAuditCheck.  # 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 = ["PASS", "WARN", "FAIL", "REVIEW", "NOT_APPLICABLE"]  # 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 title(self):
        """Gets the title of this EmailAuditCheck.  # noqa: E501


        :return: The title of this EmailAuditCheck.  # noqa: E501
        :rtype: str
        """
        return self._title

    @title.setter
    def title(self, title):
        """Sets the title of this EmailAuditCheck.


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

        self._title = title

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


        :return: The message of this EmailAuditCheck.  # noqa: E501
        :rtype: str
        """
        return self._message

    @message.setter
    def message(self, message):
        """Sets the message of this EmailAuditCheck.


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

        self._message = message

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


        :return: The recommendation of this EmailAuditCheck.  # noqa: E501
        :rtype: str
        """
        return self._recommendation

    @recommendation.setter
    def recommendation(self, recommendation):
        """Sets the recommendation of this EmailAuditCheck.


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

        self._recommendation = recommendation

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


        :return: The evidence of this EmailAuditCheck.  # noqa: E501
        :rtype: list[str]
        """
        return self._evidence

    @evidence.setter
    def evidence(self, evidence):
        """Sets the evidence of this EmailAuditCheck.


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

        self._evidence = evidence

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


        :return: The reference_url of this EmailAuditCheck.  # noqa: E501
        :rtype: str
        """
        return self._reference_url

    @reference_url.setter
    def reference_url(self, reference_url):
        """Sets the reference_url of this EmailAuditCheck.


        :param reference_url: The reference_url of this EmailAuditCheck.  # noqa: E501
        :type: str
        """

        self._reference_url = reference_url

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop category

Gets the category of this EmailAuditCheck. # noqa: E501

Email audit check category # noqa: E501

:return: The category of this EmailAuditCheck. # noqa: E501 :rtype: str

Expand source code

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

    Email audit check category  # noqa: E501

    :return: The category of this EmailAuditCheck.  # noqa: E501
    :rtype: str
    """
    return self._category

prop evidence

Gets the evidence of this EmailAuditCheck. # noqa: E501

:return: The evidence of this EmailAuditCheck. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The evidence of this EmailAuditCheck.  # noqa: E501
    :rtype: list[str]
    """
    return self._evidence

prop id

Gets the id of this EmailAuditCheck. # noqa: E501

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

Expand source code

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


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

prop message

Gets the message of this EmailAuditCheck. # noqa: E501

:return: The message of this EmailAuditCheck. # noqa: E501 :rtype: str

Expand source code

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


    :return: The message of this EmailAuditCheck.  # noqa: E501
    :rtype: str
    """
    return self._message

prop recommendation

Gets the recommendation of this EmailAuditCheck. # noqa: E501

:return: The recommendation of this EmailAuditCheck. # noqa: E501 :rtype: str

Expand source code

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


    :return: The recommendation of this EmailAuditCheck.  # noqa: E501
    :rtype: str
    """
    return self._recommendation

prop reference_url

Gets the reference_url of this EmailAuditCheck. # noqa: E501

:return: The reference_url of this EmailAuditCheck. # noqa: E501 :rtype: str

Expand source code

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


    :return: The reference_url of this EmailAuditCheck.  # noqa: E501
    :rtype: str
    """
    return self._reference_url

prop status

Gets the status of this EmailAuditCheck. # noqa: E501

Outcome of an automated email check; REVIEW requires human verification and is not a compliance verdict # noqa: E501

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

Expand source code

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

    Outcome of an automated email check; REVIEW requires human verification and is not a compliance verdict  # noqa: E501

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

prop title

Gets the title of this EmailAuditCheck. # noqa: E501

:return: The title of this EmailAuditCheck. # noqa: E501 :rtype: str

Expand source code

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


    :return: The title of this EmailAuditCheck.  # noqa: E501
    :rtype: str
    """
    return self._title

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model