Module mailslurp_client.models.wait_for_ai_message_options

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 WaitForAIMessageOptions (scope=None, since=None, timeout=None, before=None, unread_only=None, sort_direction=None, match=None, email_match_options=None, sms_match_options=None, assertions=None, output_schema=None, transform_id=None, instructions=None, ai_options=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.

WaitForAIMessageOptions - a model defined in OpenAPI

Expand source code

class WaitForAIMessageOptions(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 = {
        'scope': 'AIMessageScope',
        'since': 'datetime',
        'timeout': 'int',
        'before': 'datetime',
        'unread_only': 'bool',
        'sort_direction': 'str',
        'match': 'AIMessageMatchOptions',
        'email_match_options': 'MatchOptions',
        'sms_match_options': 'SmsMatchOptions',
        'assertions': 'list[AIMessageAssertion]',
        'output_schema': 'StructuredOutputSchema',
        'transform_id': 'str',
        'instructions': 'str',
        'ai_options': 'AIMessageAIOptions',
        'extraction_preset': 'str'
    }

    attribute_map = {
        'scope': 'scope',
        'since': 'since',
        'timeout': 'timeout',
        'before': 'before',
        'unread_only': 'unreadOnly',
        'sort_direction': 'sortDirection',
        'match': 'match',
        'email_match_options': 'emailMatchOptions',
        'sms_match_options': 'smsMatchOptions',
        'assertions': 'assertions',
        'output_schema': 'outputSchema',
        'transform_id': 'transformId',
        'instructions': 'instructions',
        'ai_options': 'aiOptions',
        'extraction_preset': 'extractionPreset'
    }

    def __init__(self, scope=None, since=None, timeout=None, before=None, unread_only=None, sort_direction=None, match=None, email_match_options=None, sms_match_options=None, assertions=None, output_schema=None, transform_id=None, instructions=None, ai_options=None, extraction_preset=None, local_vars_configuration=None):  # noqa: E501
        """WaitForAIMessageOptions - 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._scope = None
        self._since = None
        self._timeout = None
        self._before = None
        self._unread_only = None
        self._sort_direction = 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._ai_options = None
        self._extraction_preset = None
        self.discriminator = None

        self.scope = scope
        self.since = since
        self.timeout = timeout
        self.before = before
        self.unread_only = unread_only
        self.sort_direction = sort_direction
        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.ai_options = ai_options
        self.extraction_preset = extraction_preset

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


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

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


        :param scope: The scope of this WaitForAIMessageOptions.  # 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 since(self):
        """Gets the since of this WaitForAIMessageOptions.  # noqa: E501


        :return: The since of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: datetime
        """
        return self._since

    @since.setter
    def since(self, since):
        """Sets the since of this WaitForAIMessageOptions.


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

        self._since = since

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


        :return: The timeout of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: int
        """
        return self._timeout

    @timeout.setter
    def timeout(self, timeout):
        """Sets the timeout of this WaitForAIMessageOptions.


        :param timeout: The timeout of this WaitForAIMessageOptions.  # noqa: E501
        :type: int
        """
        if self.local_vars_configuration.client_side_validation and timeout is None:  # noqa: E501
            raise ValueError("Invalid value for `timeout`, must not be `None`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                timeout is not None and timeout > 120000):  # noqa: E501
            raise ValueError("Invalid value for `timeout`, must be a value less than or equal to `120000`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                timeout is not None and timeout < 1):  # noqa: E501
            raise ValueError("Invalid value for `timeout`, must be a value greater than or equal to `1`")  # noqa: E501

        self._timeout = timeout

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


        :return: The before of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: datetime
        """
        return self._before

    @before.setter
    def before(self, before):
        """Sets the before of this WaitForAIMessageOptions.


        :param before: The before of this WaitForAIMessageOptions.  # noqa: E501
        :type: datetime
        """

        self._before = before

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


        :return: The unread_only of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: bool
        """
        return self._unread_only

    @unread_only.setter
    def unread_only(self, unread_only):
        """Sets the unread_only of this WaitForAIMessageOptions.


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

        self._unread_only = unread_only

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


        :return: The sort_direction of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: str
        """
        return self._sort_direction

    @sort_direction.setter
    def sort_direction(self, sort_direction):
        """Sets the sort_direction of this WaitForAIMessageOptions.


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

        self._sort_direction = sort_direction

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


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

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


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

        self._match = match

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


        :return: The email_match_options of this WaitForAIMessageOptions.  # 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 WaitForAIMessageOptions.


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

        self._email_match_options = email_match_options

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


        :return: The sms_match_options of this WaitForAIMessageOptions.  # 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 WaitForAIMessageOptions.


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

        self._sms_match_options = sms_match_options

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


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

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


        :param assertions: The assertions of this WaitForAIMessageOptions.  # 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 WaitForAIMessageOptions.  # noqa: E501


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

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


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

        self._output_schema = output_schema

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


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

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


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

        self._transform_id = transform_id

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


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

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


        :param instructions: The instructions of this WaitForAIMessageOptions.  # 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 ai_options(self):
        """Gets the ai_options of this WaitForAIMessageOptions.  # noqa: E501


        :return: The ai_options of this WaitForAIMessageOptions.  # noqa: E501
        :rtype: AIMessageAIOptions
        """
        return self._ai_options

    @ai_options.setter
    def ai_options(self, ai_options):
        """Sets the ai_options of this WaitForAIMessageOptions.


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

        self._ai_options = ai_options

    @property
    def extraction_preset(self):
        """Gets the extraction_preset of this WaitForAIMessageOptions.  # 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 WaitForAIMessageOptions.  # noqa: E501
        :rtype: str
        """
        return self._extraction_preset

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

        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 WaitForAIMessageOptions.  # 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, WaitForAIMessageOptions):
            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, WaitForAIMessageOptions):
            return True

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop ai_options

Gets the ai_options of this WaitForAIMessageOptions. # noqa: E501

:return: The ai_options of this WaitForAIMessageOptions. # noqa: E501 :rtype: AIMessageAIOptions

Expand source code

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


    :return: The ai_options of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: AIMessageAIOptions
    """
    return self._ai_options

prop assertions

Gets the assertions of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop before

Gets the before of this WaitForAIMessageOptions. # noqa: E501

:return: The before of this WaitForAIMessageOptions. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The before of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: datetime
    """
    return self._before

prop email_match_options

Gets the email_match_options of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop extraction_preset

Gets the extraction_preset of this WaitForAIMessageOptions. # 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 WaitForAIMessageOptions. # noqa: E501 :rtype: str

Expand source code

@property
def extraction_preset(self):
    """Gets the extraction_preset of this WaitForAIMessageOptions.  # 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 WaitForAIMessageOptions.  # noqa: E501
    :rtype: str
    """
    return self._extraction_preset

prop instructions

Gets the instructions of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop match

Gets the match of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop output_schema

Gets the output_schema of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop scope

Gets the scope of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop since

Gets the since of this WaitForAIMessageOptions. # noqa: E501

:return: The since of this WaitForAIMessageOptions. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The since of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: datetime
    """
    return self._since

prop sms_match_options

Gets the sms_match_options of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop sort_direction

Gets the sort_direction of this WaitForAIMessageOptions. # noqa: E501

:return: The sort_direction of this WaitForAIMessageOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sort_direction of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: str
    """
    return self._sort_direction

prop timeout

Gets the timeout of this WaitForAIMessageOptions. # noqa: E501

:return: The timeout of this WaitForAIMessageOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The timeout of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: int
    """
    return self._timeout

prop transform_id

Gets the transform_id of this WaitForAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop unread_only

Gets the unread_only of this WaitForAIMessageOptions. # noqa: E501

:return: The unread_only of this WaitForAIMessageOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The unread_only of this WaitForAIMessageOptions.  # noqa: E501
    :rtype: bool
    """
    return self._unread_only

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model