Module mailslurp_client.models.invoke_transformer_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 InvokeTransformerOptions (ai_transform_id=None, ai_transform_mapping_id=None, raw_input=None, entity_id=None, entity_type=None, raw_conditions=None, raw_instructions=None, raw_output_schema=None, content_selector=None, save_results=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.

InvokeTransformerOptions - a model defined in OpenAPI

Expand source code

class InvokeTransformerOptions(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 = {
        'ai_transform_id': 'str',
        'ai_transform_mapping_id': 'str',
        'raw_input': 'str',
        'entity_id': 'str',
        'entity_type': 'str',
        'raw_conditions': 'list[str]',
        'raw_instructions': 'list[str]',
        'raw_output_schema': 'StructuredOutputSchema',
        'content_selector': 'str',
        'save_results': 'bool'
    }

    attribute_map = {
        'ai_transform_id': 'aiTransformId',
        'ai_transform_mapping_id': 'aiTransformMappingId',
        'raw_input': 'rawInput',
        'entity_id': 'entityId',
        'entity_type': 'entityType',
        'raw_conditions': 'rawConditions',
        'raw_instructions': 'rawInstructions',
        'raw_output_schema': 'rawOutputSchema',
        'content_selector': 'contentSelector',
        'save_results': 'saveResults'
    }

    def __init__(self, ai_transform_id=None, ai_transform_mapping_id=None, raw_input=None, entity_id=None, entity_type=None, raw_conditions=None, raw_instructions=None, raw_output_schema=None, content_selector=None, save_results=None, local_vars_configuration=None):  # noqa: E501
        """InvokeTransformerOptions - 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._ai_transform_id = None
        self._ai_transform_mapping_id = None
        self._raw_input = None
        self._entity_id = None
        self._entity_type = None
        self._raw_conditions = None
        self._raw_instructions = None
        self._raw_output_schema = None
        self._content_selector = None
        self._save_results = None
        self.discriminator = None

        self.ai_transform_id = ai_transform_id
        self.ai_transform_mapping_id = ai_transform_mapping_id
        self.raw_input = raw_input
        self.entity_id = entity_id
        self.entity_type = entity_type
        self.raw_conditions = raw_conditions
        self.raw_instructions = raw_instructions
        self.raw_output_schema = raw_output_schema
        self.content_selector = content_selector
        self.save_results = save_results

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


        :return: The ai_transform_id of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._ai_transform_id

    @ai_transform_id.setter
    def ai_transform_id(self, ai_transform_id):
        """Sets the ai_transform_id of this InvokeTransformerOptions.


        :param ai_transform_id: The ai_transform_id of this InvokeTransformerOptions.  # noqa: E501
        :type: str
        """

        self._ai_transform_id = ai_transform_id

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


        :return: The ai_transform_mapping_id of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._ai_transform_mapping_id

    @ai_transform_mapping_id.setter
    def ai_transform_mapping_id(self, ai_transform_mapping_id):
        """Sets the ai_transform_mapping_id of this InvokeTransformerOptions.


        :param ai_transform_mapping_id: The ai_transform_mapping_id of this InvokeTransformerOptions.  # noqa: E501
        :type: str
        """

        self._ai_transform_mapping_id = ai_transform_mapping_id

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


        :return: The raw_input of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._raw_input

    @raw_input.setter
    def raw_input(self, raw_input):
        """Sets the raw_input of this InvokeTransformerOptions.


        :param raw_input: The raw_input of this InvokeTransformerOptions.  # noqa: E501
        :type: str
        """

        self._raw_input = raw_input

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


        :return: The entity_id of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._entity_id

    @entity_id.setter
    def entity_id(self, entity_id):
        """Sets the entity_id of this InvokeTransformerOptions.


        :param entity_id: The entity_id of this InvokeTransformerOptions.  # noqa: E501
        :type: str
        """

        self._entity_id = entity_id

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


        :return: The entity_type of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._entity_type

    @entity_type.setter
    def entity_type(self, entity_type):
        """Sets the entity_type of this InvokeTransformerOptions.


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

        self._entity_type = entity_type

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


        :return: The raw_conditions of this InvokeTransformerOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._raw_conditions

    @raw_conditions.setter
    def raw_conditions(self, raw_conditions):
        """Sets the raw_conditions of this InvokeTransformerOptions.


        :param raw_conditions: The raw_conditions of this InvokeTransformerOptions.  # noqa: E501
        :type: list[str]
        """

        self._raw_conditions = raw_conditions

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


        :return: The raw_instructions of this InvokeTransformerOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._raw_instructions

    @raw_instructions.setter
    def raw_instructions(self, raw_instructions):
        """Sets the raw_instructions of this InvokeTransformerOptions.


        :param raw_instructions: The raw_instructions of this InvokeTransformerOptions.  # noqa: E501
        :type: list[str]
        """

        self._raw_instructions = raw_instructions

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


        :return: The raw_output_schema of this InvokeTransformerOptions.  # noqa: E501
        :rtype: StructuredOutputSchema
        """
        return self._raw_output_schema

    @raw_output_schema.setter
    def raw_output_schema(self, raw_output_schema):
        """Sets the raw_output_schema of this InvokeTransformerOptions.


        :param raw_output_schema: The raw_output_schema of this InvokeTransformerOptions.  # noqa: E501
        :type: StructuredOutputSchema
        """

        self._raw_output_schema = raw_output_schema

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


        :return: The content_selector of this InvokeTransformerOptions.  # noqa: E501
        :rtype: str
        """
        return self._content_selector

    @content_selector.setter
    def content_selector(self, content_selector):
        """Sets the content_selector of this InvokeTransformerOptions.


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

        self._content_selector = content_selector

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


        :return: The save_results of this InvokeTransformerOptions.  # noqa: E501
        :rtype: bool
        """
        return self._save_results

    @save_results.setter
    def save_results(self, save_results):
        """Sets the save_results of this InvokeTransformerOptions.


        :param save_results: The save_results of this InvokeTransformerOptions.  # noqa: E501
        :type: bool
        """

        self._save_results = save_results

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop ai_transform_id

Gets the ai_transform_id of this InvokeTransformerOptions. # noqa: E501

:return: The ai_transform_id of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The ai_transform_id of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._ai_transform_id

prop ai_transform_mapping_id

Gets the ai_transform_mapping_id of this InvokeTransformerOptions. # noqa: E501

:return: The ai_transform_mapping_id of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The ai_transform_mapping_id of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._ai_transform_mapping_id

prop content_selector

Gets the content_selector of this InvokeTransformerOptions. # noqa: E501

:return: The content_selector of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The content_selector of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._content_selector

prop entity_id

Gets the entity_id of this InvokeTransformerOptions. # noqa: E501

:return: The entity_id of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The entity_id of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._entity_id

prop entity_type

Gets the entity_type of this InvokeTransformerOptions. # noqa: E501

:return: The entity_type of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The entity_type of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._entity_type

prop raw_conditions

Gets the raw_conditions of this InvokeTransformerOptions. # noqa: E501

:return: The raw_conditions of this InvokeTransformerOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The raw_conditions of this InvokeTransformerOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._raw_conditions

prop raw_input

Gets the raw_input of this InvokeTransformerOptions. # noqa: E501

:return: The raw_input of this InvokeTransformerOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The raw_input of this InvokeTransformerOptions.  # noqa: E501
    :rtype: str
    """
    return self._raw_input

prop raw_instructions

Gets the raw_instructions of this InvokeTransformerOptions. # noqa: E501

:return: The raw_instructions of this InvokeTransformerOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The raw_instructions of this InvokeTransformerOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._raw_instructions

prop raw_output_schema

Gets the raw_output_schema of this InvokeTransformerOptions. # noqa: E501

:return: The raw_output_schema of this InvokeTransformerOptions. # noqa: E501 :rtype: StructuredOutputSchema

Expand source code

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


    :return: The raw_output_schema of this InvokeTransformerOptions.  # noqa: E501
    :rtype: StructuredOutputSchema
    """
    return self._raw_output_schema

prop save_results

Gets the save_results of this InvokeTransformerOptions. # noqa: E501

:return: The save_results of this InvokeTransformerOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The save_results of this InvokeTransformerOptions.  # noqa: E501
    :rtype: bool
    """
    return self._save_results

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model