Module mailslurp_client.models.ai_message_match_result

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 AIMessageMatchResult (status=None, reason=None, evidence=None, confidence=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.

AIMessageMatchResult - a model defined in OpenAPI

Expand source code
class AIMessageMatchResult(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 = {
        'status': 'str',
        'reason': 'str',
        'evidence': 'list[AIMessageEvidence]',
        'confidence': 'AIMessageConfidence'
    }

    attribute_map = {
        'status': 'status',
        'reason': 'reason',
        'evidence': 'evidence',
        'confidence': 'confidence'
    }

    def __init__(self, status=None, reason=None, evidence=None, confidence=None, local_vars_configuration=None):  # noqa: E501
        """AIMessageMatchResult - 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._status = None
        self._reason = None
        self._evidence = None
        self._confidence = None
        self.discriminator = None

        self.status = status
        self.reason = reason
        self.evidence = evidence
        self.confidence = confidence

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


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

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


        :param status: The status of this AIMessageMatchResult.  # 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 = ["MATCH", "NO_MATCH", "INCONCLUSIVE"]  # 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 reason(self):
        """Gets the reason of this AIMessageMatchResult.  # noqa: E501


        :return: The reason of this AIMessageMatchResult.  # noqa: E501
        :rtype: str
        """
        return self._reason

    @reason.setter
    def reason(self, reason):
        """Sets the reason of this AIMessageMatchResult.


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

        self._reason = reason

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


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

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


        :param evidence: The evidence of this AIMessageMatchResult.  # noqa: E501
        :type: list[AIMessageEvidence]
        """
        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 confidence(self):
        """Gets the confidence of this AIMessageMatchResult.  # noqa: E501


        :return: The confidence of this AIMessageMatchResult.  # noqa: E501
        :rtype: AIMessageConfidence
        """
        return self._confidence

    @confidence.setter
    def confidence(self, confidence):
        """Sets the confidence of this AIMessageMatchResult.


        :param confidence: The confidence of this AIMessageMatchResult.  # noqa: E501
        :type: AIMessageConfidence
        """

        self._confidence = confidence

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

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

Class variables

var attribute_map
var openapi_types

Instance variables

prop confidence

Gets the confidence of this AIMessageMatchResult. # noqa: E501

:return: The confidence of this AIMessageMatchResult. # noqa: E501 :rtype: AIMessageConfidence

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


    :return: The confidence of this AIMessageMatchResult.  # noqa: E501
    :rtype: AIMessageConfidence
    """
    return self._confidence
prop evidence

Gets the evidence of this AIMessageMatchResult. # noqa: E501

:return: The evidence of this AIMessageMatchResult. # noqa: E501 :rtype: list[AIMessageEvidence]

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


    :return: The evidence of this AIMessageMatchResult.  # noqa: E501
    :rtype: list[AIMessageEvidence]
    """
    return self._evidence
prop reason

Gets the reason of this AIMessageMatchResult. # noqa: E501

:return: The reason of this AIMessageMatchResult. # noqa: E501 :rtype: str

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


    :return: The reason of this AIMessageMatchResult.  # noqa: E501
    :rtype: str
    """
    return self._reason
prop status

Gets the status of this AIMessageMatchResult. # noqa: E501

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

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


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

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model