Module mailslurp_client.models.ai_message_expectation

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 AIMessageExpectation (id=None, scope=None, match=None, email_match_options=None, sms_match_options=None, assertions=None, output_schema=None, transform_id=None, instructions=None, extraction_preset=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.

AIMessageExpectation - a model defined in OpenAPI

Expand source code

class AIMessageExpectation(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',
        'scope': 'AIMessageScope',
        'match': 'AIMessageMatchOptions',
        'email_match_options': 'MatchOptions',
        'sms_match_options': 'SmsMatchOptions',
        'assertions': 'list[AIMessageAssertion]',
        'output_schema': 'StructuredOutputSchema',
        'transform_id': 'str',
        'instructions': 'str',
        'extraction_preset': 'str'
    }

    attribute_map = {
        'id': 'id',
        'scope': 'scope',
        'match': 'match',
        'email_match_options': 'emailMatchOptions',
        'sms_match_options': 'smsMatchOptions',
        'assertions': 'assertions',
        'output_schema': 'outputSchema',
        'transform_id': 'transformId',
        'instructions': 'instructions',
        'extraction_preset': 'extractionPreset'
    }

    def __init__(self, id=None, scope=None, match=None, email_match_options=None, sms_match_options=None, assertions=None, output_schema=None, transform_id=None, instructions=None, extraction_preset=None, local_vars_configuration=None):  # noqa: E501
        """AIMessageExpectation - 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._scope = None
        self._match = None
        self._email_match_options = None
        self._sms_match_options = None
        self._assertions = None
        self._output_schema = None
        self._transform_id = None
        self._instructions = None
        self._extraction_preset = None
        self.discriminator = None

        self.id = id
        self.scope = scope
        self.match = match
        self.email_match_options = email_match_options
        self.sms_match_options = sms_match_options
        self.assertions = assertions
        self.output_schema = output_schema
        self.transform_id = transform_id
        self.instructions = instructions
        self.extraction_preset = extraction_preset

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


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

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


        :param id: The id of this AIMessageExpectation.  # 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
        if (self.local_vars_configuration.client_side_validation and
                id is not None and len(id) > 100):
            raise ValueError("Invalid value for `id`, length must be less than or equal to `100`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                id is not None and len(id) < 0):
            raise ValueError("Invalid value for `id`, length must be greater than or equal to `0`")  # noqa: E501

        self._id = id

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


        :return: The scope of this AIMessageExpectation.  # noqa: E501
        :rtype: AIMessageScope
        """
        return self._scope

    @scope.setter
    def scope(self, scope):
        """Sets the scope of this AIMessageExpectation.


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

        self._scope = scope

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


        :return: The match of this AIMessageExpectation.  # noqa: E501
        :rtype: AIMessageMatchOptions
        """
        return self._match

    @match.setter
    def match(self, match):
        """Sets the match of this AIMessageExpectation.


        :param match: The match of this AIMessageExpectation.  # noqa: E501
        :type: AIMessageMatchOptions
        """

        self._match = match

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


        :return: The email_match_options of this AIMessageExpectation.  # noqa: E501
        :rtype: MatchOptions
        """
        return self._email_match_options

    @email_match_options.setter
    def email_match_options(self, email_match_options):
        """Sets the email_match_options of this AIMessageExpectation.


        :param email_match_options: The email_match_options of this AIMessageExpectation.  # noqa: E501
        :type: MatchOptions
        """

        self._email_match_options = email_match_options

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


        :return: The sms_match_options of this AIMessageExpectation.  # noqa: E501
        :rtype: SmsMatchOptions
        """
        return self._sms_match_options

    @sms_match_options.setter
    def sms_match_options(self, sms_match_options):
        """Sets the sms_match_options of this AIMessageExpectation.


        :param sms_match_options: The sms_match_options of this AIMessageExpectation.  # noqa: E501
        :type: SmsMatchOptions
        """

        self._sms_match_options = sms_match_options

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


        :return: The assertions of this AIMessageExpectation.  # noqa: E501
        :rtype: list[AIMessageAssertion]
        """
        return self._assertions

    @assertions.setter
    def assertions(self, assertions):
        """Sets the assertions of this AIMessageExpectation.


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

        self._assertions = assertions

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


        :return: The output_schema of this AIMessageExpectation.  # noqa: E501
        :rtype: StructuredOutputSchema
        """
        return self._output_schema

    @output_schema.setter
    def output_schema(self, output_schema):
        """Sets the output_schema of this AIMessageExpectation.


        :param output_schema: The output_schema of this AIMessageExpectation.  # noqa: E501
        :type: StructuredOutputSchema
        """

        self._output_schema = output_schema

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


        :return: The transform_id of this AIMessageExpectation.  # noqa: E501
        :rtype: str
        """
        return self._transform_id

    @transform_id.setter
    def transform_id(self, transform_id):
        """Sets the transform_id of this AIMessageExpectation.


        :param transform_id: The transform_id of this AIMessageExpectation.  # noqa: E501
        :type: str
        """

        self._transform_id = transform_id

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


        :return: The instructions of this AIMessageExpectation.  # noqa: E501
        :rtype: str
        """
        return self._instructions

    @instructions.setter
    def instructions(self, instructions):
        """Sets the instructions of this AIMessageExpectation.


        :param instructions: The instructions of this AIMessageExpectation.  # noqa: E501
        :type: str
        """
        if (self.local_vars_configuration.client_side_validation and
                instructions is not None and len(instructions) > 4000):
            raise ValueError("Invalid value for `instructions`, length must be less than or equal to `4000`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                instructions is not None and len(instructions) < 0):
            raise ValueError("Invalid value for `instructions`, length must be greater than or equal to `0`")  # noqa: E501

        self._instructions = instructions

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

        Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.  # noqa: E501

        :return: The extraction_preset of this AIMessageExpectation.  # noqa: E501
        :rtype: str
        """
        return self._extraction_preset

    @extraction_preset.setter
    def extraction_preset(self, extraction_preset):
        """Sets the extraction_preset of this AIMessageExpectation.

        Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.  # noqa: E501

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

        self._extraction_preset = extraction_preset

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop assertions

Gets the assertions of this AIMessageExpectation. # noqa: E501

:return: The assertions of this AIMessageExpectation. # noqa: E501 :rtype: list[AIMessageAssertion]

Expand source code

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


    :return: The assertions of this AIMessageExpectation.  # noqa: E501
    :rtype: list[AIMessageAssertion]
    """
    return self._assertions

prop email_match_options

Gets the email_match_options of this AIMessageExpectation. # noqa: E501

:return: The email_match_options of this AIMessageExpectation. # noqa: E501 :rtype: MatchOptions

Expand source code

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


    :return: The email_match_options of this AIMessageExpectation.  # noqa: E501
    :rtype: MatchOptions
    """
    return self._email_match_options

prop extraction_preset

Gets the extraction_preset of this AIMessageExpectation. # noqa: E501

Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE. # noqa: E501

:return: The extraction_preset of this AIMessageExpectation. # noqa: E501 :rtype: str

Expand source code

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

    Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.  # noqa: E501

    :return: The extraction_preset of this AIMessageExpectation.  # noqa: E501
    :rtype: str
    """
    return self._extraction_preset

prop id

Gets the id of this AIMessageExpectation. # noqa: E501

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

Expand source code

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


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

prop instructions

Gets the instructions of this AIMessageExpectation. # noqa: E501

:return: The instructions of this AIMessageExpectation. # noqa: E501 :rtype: str

Expand source code

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


    :return: The instructions of this AIMessageExpectation.  # noqa: E501
    :rtype: str
    """
    return self._instructions

prop match

Gets the match of this AIMessageExpectation. # noqa: E501

:return: The match of this AIMessageExpectation. # noqa: E501 :rtype: AIMessageMatchOptions

Expand source code

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


    :return: The match of this AIMessageExpectation.  # noqa: E501
    :rtype: AIMessageMatchOptions
    """
    return self._match

prop output_schema

Gets the output_schema of this AIMessageExpectation. # noqa: E501

:return: The output_schema of this AIMessageExpectation. # noqa: E501 :rtype: StructuredOutputSchema

Expand source code

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


    :return: The output_schema of this AIMessageExpectation.  # noqa: E501
    :rtype: StructuredOutputSchema
    """
    return self._output_schema

prop scope

Gets the scope of this AIMessageExpectation. # noqa: E501

:return: The scope of this AIMessageExpectation. # noqa: E501 :rtype: AIMessageScope

Expand source code

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


    :return: The scope of this AIMessageExpectation.  # noqa: E501
    :rtype: AIMessageScope
    """
    return self._scope

prop sms_match_options

Gets the sms_match_options of this AIMessageExpectation. # noqa: E501

:return: The sms_match_options of this AIMessageExpectation. # noqa: E501 :rtype: SmsMatchOptions

Expand source code

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


    :return: The sms_match_options of this AIMessageExpectation.  # noqa: E501
    :rtype: SmsMatchOptions
    """
    return self._sms_match_options

prop transform_id

Gets the transform_id of this AIMessageExpectation. # noqa: E501

:return: The transform_id of this AIMessageExpectation. # noqa: E501 :rtype: str

Expand source code

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


    :return: The transform_id of this AIMessageExpectation.  # noqa: E501
    :rtype: str
    """
    return self._transform_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model