Module mailslurp_client.models.ai_messages_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 AIMessagesResult (evaluation_id=None, status=None, results=None, usage=None, elapsed_ms=None, summary=None, successful=None, unsatisfied_expectation_ids=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.

AIMessagesResult - a model defined in OpenAPI

Expand source code

class AIMessagesResult(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 = {
        'evaluation_id': 'str',
        'status': 'str',
        'results': 'list[AIMessageExpectationResult]',
        'usage': 'AIMessageUsage',
        'elapsed_ms': 'int',
        'summary': 'str',
        'successful': 'bool',
        'unsatisfied_expectation_ids': 'list[str]'
    }

    attribute_map = {
        'evaluation_id': 'evaluationId',
        'status': 'status',
        'results': 'results',
        'usage': 'usage',
        'elapsed_ms': 'elapsedMs',
        'summary': 'summary',
        'successful': 'successful',
        'unsatisfied_expectation_ids': 'unsatisfiedExpectationIds'
    }

    def __init__(self, evaluation_id=None, status=None, results=None, usage=None, elapsed_ms=None, summary=None, successful=None, unsatisfied_expectation_ids=None, local_vars_configuration=None):  # noqa: E501
        """AIMessagesResult - 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._evaluation_id = None
        self._status = None
        self._results = None
        self._usage = None
        self._elapsed_ms = None
        self._summary = None
        self._successful = None
        self._unsatisfied_expectation_ids = None
        self.discriminator = None

        self.evaluation_id = evaluation_id
        self.status = status
        self.results = results
        self.usage = usage
        self.elapsed_ms = elapsed_ms
        self.summary = summary
        self.successful = successful
        self.unsatisfied_expectation_ids = unsatisfied_expectation_ids

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


        :return: The evaluation_id of this AIMessagesResult.  # noqa: E501
        :rtype: str
        """
        return self._evaluation_id

    @evaluation_id.setter
    def evaluation_id(self, evaluation_id):
        """Sets the evaluation_id of this AIMessagesResult.


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

        self._evaluation_id = evaluation_id

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


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

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


        :param status: The status of this AIMessagesResult.  # 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 = ["MATCHED", "PASS", "FAIL", "EXTRACTED", "INCONCLUSIVE", "TIMED_OUT", "TOKEN_LIMIT", "CANDIDATE_LIMIT", "PROVIDER_ERROR", "PROVIDER_TIMEOUT", "INVALID_OUTPUT"]  # 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 results(self):
        """Gets the results of this AIMessagesResult.  # noqa: E501


        :return: The results of this AIMessagesResult.  # noqa: E501
        :rtype: list[AIMessageExpectationResult]
        """
        return self._results

    @results.setter
    def results(self, results):
        """Sets the results of this AIMessagesResult.


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

        self._results = results

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


        :return: The usage of this AIMessagesResult.  # noqa: E501
        :rtype: AIMessageUsage
        """
        return self._usage

    @usage.setter
    def usage(self, usage):
        """Sets the usage of this AIMessagesResult.


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

        self._usage = usage

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


        :return: The elapsed_ms of this AIMessagesResult.  # noqa: E501
        :rtype: int
        """
        return self._elapsed_ms

    @elapsed_ms.setter
    def elapsed_ms(self, elapsed_ms):
        """Sets the elapsed_ms of this AIMessagesResult.


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

        self._elapsed_ms = elapsed_ms

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


        :return: The summary of this AIMessagesResult.  # noqa: E501
        :rtype: str
        """
        return self._summary

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


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


        :return: The successful of this AIMessagesResult.  # noqa: E501
        :rtype: bool
        """
        return self._successful

    @successful.setter
    def successful(self, successful):
        """Sets the successful of this AIMessagesResult.


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

        self._successful = successful

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


        :return: The unsatisfied_expectation_ids of this AIMessagesResult.  # noqa: E501
        :rtype: list[str]
        """
        return self._unsatisfied_expectation_ids

    @unsatisfied_expectation_ids.setter
    def unsatisfied_expectation_ids(self, unsatisfied_expectation_ids):
        """Sets the unsatisfied_expectation_ids of this AIMessagesResult.


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

        self._unsatisfied_expectation_ids = unsatisfied_expectation_ids

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop elapsed_ms

Gets the elapsed_ms of this AIMessagesResult. # noqa: E501

:return: The elapsed_ms of this AIMessagesResult. # noqa: E501 :rtype: int

Expand source code

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


    :return: The elapsed_ms of this AIMessagesResult.  # noqa: E501
    :rtype: int
    """
    return self._elapsed_ms

prop evaluation_id

Gets the evaluation_id of this AIMessagesResult. # noqa: E501

:return: The evaluation_id of this AIMessagesResult. # noqa: E501 :rtype: str

Expand source code

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


    :return: The evaluation_id of this AIMessagesResult.  # noqa: E501
    :rtype: str
    """
    return self._evaluation_id

prop results

Gets the results of this AIMessagesResult. # noqa: E501

:return: The results of this AIMessagesResult. # noqa: E501 :rtype: list[AIMessageExpectationResult]

Expand source code

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


    :return: The results of this AIMessagesResult.  # noqa: E501
    :rtype: list[AIMessageExpectationResult]
    """
    return self._results

prop status

Gets the status of this AIMessagesResult. # noqa: E501

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

Expand source code

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


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

prop successful

Gets the successful of this AIMessagesResult. # noqa: E501

:return: The successful of this AIMessagesResult. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The successful of this AIMessagesResult.  # noqa: E501
    :rtype: bool
    """
    return self._successful

prop summary

Gets the summary of this AIMessagesResult. # noqa: E501

:return: The summary of this AIMessagesResult. # noqa: E501 :rtype: str

Expand source code

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


    :return: The summary of this AIMessagesResult.  # noqa: E501
    :rtype: str
    """
    return self._summary

prop unsatisfied_expectation_ids

Gets the unsatisfied_expectation_ids of this AIMessagesResult. # noqa: E501

:return: The unsatisfied_expectation_ids of this AIMessagesResult. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The unsatisfied_expectation_ids of this AIMessagesResult.  # noqa: E501
    :rtype: list[str]
    """
    return self._unsatisfied_expectation_ids

prop usage

Gets the usage of this AIMessagesResult. # noqa: E501

:return: The usage of this AIMessagesResult. # noqa: E501 :rtype: AIMessageUsage

Expand source code

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


    :return: The usage of this AIMessagesResult.  # noqa: E501
    :rtype: AIMessageUsage
    """
    return self._usage

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model