Module mailslurp_client.models.extract_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 ExtractAIMessageOptions (message=None, output_schema=None, transform_id=None, instructions=None, timeout=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.

ExtractAIMessageOptions - a model defined in OpenAPI

Expand source code

class ExtractAIMessageOptions(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 = {
        'message': 'AIMessageReference',
        'output_schema': 'StructuredOutputSchema',
        'transform_id': 'str',
        'instructions': 'str',
        'timeout': 'int',
        'ai_options': 'AIMessageAIOptions',
        'extraction_preset': 'str'
    }

    attribute_map = {
        'message': 'message',
        'output_schema': 'outputSchema',
        'transform_id': 'transformId',
        'instructions': 'instructions',
        'timeout': 'timeout',
        'ai_options': 'aiOptions',
        'extraction_preset': 'extractionPreset'
    }

    def __init__(self, message=None, output_schema=None, transform_id=None, instructions=None, timeout=None, ai_options=None, extraction_preset=None, local_vars_configuration=None):  # noqa: E501
        """ExtractAIMessageOptions - 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._message = None
        self._output_schema = None
        self._transform_id = None
        self._instructions = None
        self._timeout = None
        self._ai_options = None
        self._extraction_preset = None
        self.discriminator = None

        self.message = message
        self.output_schema = output_schema
        self.transform_id = transform_id
        self.instructions = instructions
        self.timeout = timeout
        self.ai_options = ai_options
        self.extraction_preset = extraction_preset

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


        :return: The message of this ExtractAIMessageOptions.  # noqa: E501
        :rtype: AIMessageReference
        """
        return self._message

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


        :param message: The message of this ExtractAIMessageOptions.  # noqa: E501
        :type: AIMessageReference
        """
        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 output_schema(self):
        """Gets the output_schema of this ExtractAIMessageOptions.  # noqa: E501


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

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


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

        self._output_schema = output_schema

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


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

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


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

        self._transform_id = transform_id

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


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

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


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


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

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


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


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

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


        :param ai_options: The ai_options of this ExtractAIMessageOptions.  # 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 ExtractAIMessageOptions.  # 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 ExtractAIMessageOptions.  # noqa: E501
        :rtype: str
        """
        return self._extraction_preset

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

        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 ExtractAIMessageOptions.  # 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, ExtractAIMessageOptions):
            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, ExtractAIMessageOptions):
            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 ExtractAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop extraction_preset

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

Expand source code

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

prop instructions

Gets the instructions of this ExtractAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop message

Gets the message of this ExtractAIMessageOptions. # noqa: E501

:return: The message of this ExtractAIMessageOptions. # noqa: E501 :rtype: AIMessageReference

Expand source code

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


    :return: The message of this ExtractAIMessageOptions.  # noqa: E501
    :rtype: AIMessageReference
    """
    return self._message

prop output_schema

Gets the output_schema of this ExtractAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop timeout

Gets the timeout of this ExtractAIMessageOptions. # noqa: E501

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

Expand source code

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


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

prop transform_id

Gets the transform_id of this ExtractAIMessageOptions. # noqa: E501

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

Expand source code

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


    :return: The transform_id of this ExtractAIMessageOptions.  # 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