Module mailslurp_client.models.generate_structured_content_attachment_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 GenerateStructuredContentAttachmentOptions (attachment_id=None, instructions=None, output_schema=None, transform_id=None, email_id=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.

GenerateStructuredContentAttachmentOptions - a model defined in OpenAPI

Expand source code

class GenerateStructuredContentAttachmentOptions(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 = {
        'attachment_id': 'str',
        'instructions': 'str',
        'output_schema': 'StructuredOutputSchema',
        'transform_id': 'str',
        'email_id': 'str'
    }

    attribute_map = {
        'attachment_id': 'attachmentId',
        'instructions': 'instructions',
        'output_schema': 'outputSchema',
        'transform_id': 'transformId',
        'email_id': 'emailId'
    }

    def __init__(self, attachment_id=None, instructions=None, output_schema=None, transform_id=None, email_id=None, local_vars_configuration=None):  # noqa: E501
        """GenerateStructuredContentAttachmentOptions - 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._attachment_id = None
        self._instructions = None
        self._output_schema = None
        self._transform_id = None
        self._email_id = None
        self.discriminator = None

        self.attachment_id = attachment_id
        self.instructions = instructions
        if output_schema is not None:
            self.output_schema = output_schema
        self.transform_id = transform_id
        self.email_id = email_id

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

        Attachment ID to read and pass to AI  # noqa: E501

        :return: The attachment_id of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._attachment_id

    @attachment_id.setter
    def attachment_id(self, attachment_id):
        """Sets the attachment_id of this GenerateStructuredContentAttachmentOptions.

        Attachment ID to read and pass to AI  # noqa: E501

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

        self._attachment_id = attachment_id

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

        Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.  # noqa: E501

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

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

        Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.  # noqa: E501

        :param instructions: The instructions of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
        :type: str
        """

        self._instructions = instructions

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


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

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


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

        self._output_schema = output_schema

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

        ID of transformer to apply  # noqa: E501

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

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

        ID of transformer to apply  # noqa: E501

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

        self._transform_id = transform_id

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

        Optional email ID for more context  # noqa: E501

        :return: The email_id of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._email_id

    @email_id.setter
    def email_id(self, email_id):
        """Sets the email_id of this GenerateStructuredContentAttachmentOptions.

        Optional email ID for more context  # noqa: E501

        :param email_id: The email_id of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
        :type: str
        """

        self._email_id = email_id

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop attachment_id

Gets the attachment_id of this GenerateStructuredContentAttachmentOptions. # noqa: E501

Attachment ID to read and pass to AI # noqa: E501

:return: The attachment_id of this GenerateStructuredContentAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Attachment ID to read and pass to AI  # noqa: E501

    :return: The attachment_id of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._attachment_id

prop email_id

Gets the email_id of this GenerateStructuredContentAttachmentOptions. # noqa: E501

Optional email ID for more context # noqa: E501

:return: The email_id of this GenerateStructuredContentAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional email ID for more context  # noqa: E501

    :return: The email_id of this GenerateStructuredContentAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._email_id

prop instructions

Gets the instructions of this GenerateStructuredContentAttachmentOptions. # noqa: E501

Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints. # noqa: E501

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

Expand source code

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

    Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.  # noqa: E501

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

prop output_schema

Gets the output_schema of this GenerateStructuredContentAttachmentOptions. # noqa: E501

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

Expand source code

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


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

prop transform_id

Gets the transform_id of this GenerateStructuredContentAttachmentOptions. # noqa: E501

ID of transformer to apply # noqa: E501

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

Expand source code

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

    ID of transformer to apply  # noqa: E501

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