Module mailslurp_client.models.ai_message_model_dto

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 AIMessageModelDto (model=None, provider_model=None, evaluator_version=None, moving_alias=None, token_multiplier=None, supported_message_types=None, pricing_version=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.

AIMessageModelDto - a model defined in OpenAPI

Expand source code

class AIMessageModelDto(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 = {
        'model': 'str',
        'provider_model': 'str',
        'evaluator_version': 'str',
        'moving_alias': 'bool',
        'token_multiplier': 'float',
        'supported_message_types': 'list[str]',
        'pricing_version': 'str'
    }

    attribute_map = {
        'model': 'model',
        'provider_model': 'providerModel',
        'evaluator_version': 'evaluatorVersion',
        'moving_alias': 'movingAlias',
        'token_multiplier': 'tokenMultiplier',
        'supported_message_types': 'supportedMessageTypes',
        'pricing_version': 'pricingVersion'
    }

    def __init__(self, model=None, provider_model=None, evaluator_version=None, moving_alias=None, token_multiplier=None, supported_message_types=None, pricing_version=None, local_vars_configuration=None):  # noqa: E501
        """AIMessageModelDto - 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._model = None
        self._provider_model = None
        self._evaluator_version = None
        self._moving_alias = None
        self._token_multiplier = None
        self._supported_message_types = None
        self._pricing_version = None
        self.discriminator = None

        self.model = model
        self.provider_model = provider_model
        self.evaluator_version = evaluator_version
        self.moving_alias = moving_alias
        self.token_multiplier = token_multiplier
        self.supported_message_types = supported_message_types
        self.pricing_version = pricing_version

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


        :return: The model of this AIMessageModelDto.  # noqa: E501
        :rtype: str
        """
        return self._model

    @model.setter
    def model(self, model):
        """Sets the model of this AIMessageModelDto.


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

        self._model = model

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


        :return: The provider_model of this AIMessageModelDto.  # noqa: E501
        :rtype: str
        """
        return self._provider_model

    @provider_model.setter
    def provider_model(self, provider_model):
        """Sets the provider_model of this AIMessageModelDto.


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

        self._provider_model = provider_model

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


        :return: The evaluator_version of this AIMessageModelDto.  # noqa: E501
        :rtype: str
        """
        return self._evaluator_version

    @evaluator_version.setter
    def evaluator_version(self, evaluator_version):
        """Sets the evaluator_version of this AIMessageModelDto.


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

        self._evaluator_version = evaluator_version

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


        :return: The moving_alias of this AIMessageModelDto.  # noqa: E501
        :rtype: bool
        """
        return self._moving_alias

    @moving_alias.setter
    def moving_alias(self, moving_alias):
        """Sets the moving_alias of this AIMessageModelDto.


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

        self._moving_alias = moving_alias

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


        :return: The token_multiplier of this AIMessageModelDto.  # noqa: E501
        :rtype: float
        """
        return self._token_multiplier

    @token_multiplier.setter
    def token_multiplier(self, token_multiplier):
        """Sets the token_multiplier of this AIMessageModelDto.


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

        self._token_multiplier = token_multiplier

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


        :return: The supported_message_types of this AIMessageModelDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._supported_message_types

    @supported_message_types.setter
    def supported_message_types(self, supported_message_types):
        """Sets the supported_message_types of this AIMessageModelDto.


        :param supported_message_types: The supported_message_types of this AIMessageModelDto.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and supported_message_types is None:  # noqa: E501
            raise ValueError("Invalid value for `supported_message_types`, must not be `None`")  # noqa: E501
        allowed_values = ["EMAIL", "SMS"]  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                not set(supported_message_types).issubset(set(allowed_values))):  # noqa: E501
            raise ValueError(
                "Invalid values for `supported_message_types` [{0}], must be a subset of [{1}]"  # noqa: E501
                .format(", ".join(map(str, set(supported_message_types) - set(allowed_values))),  # noqa: E501
                        ", ".join(map(str, allowed_values)))
            )

        self._supported_message_types = supported_message_types

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


        :return: The pricing_version of this AIMessageModelDto.  # noqa: E501
        :rtype: str
        """
        return self._pricing_version

    @pricing_version.setter
    def pricing_version(self, pricing_version):
        """Sets the pricing_version of this AIMessageModelDto.


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

        self._pricing_version = pricing_version

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop evaluator_version

Gets the evaluator_version of this AIMessageModelDto. # noqa: E501

:return: The evaluator_version of this AIMessageModelDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The evaluator_version of this AIMessageModelDto.  # noqa: E501
    :rtype: str
    """
    return self._evaluator_version

prop model

Gets the model of this AIMessageModelDto. # noqa: E501

:return: The model of this AIMessageModelDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The model of this AIMessageModelDto.  # noqa: E501
    :rtype: str
    """
    return self._model

prop moving_alias

Gets the moving_alias of this AIMessageModelDto. # noqa: E501

:return: The moving_alias of this AIMessageModelDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The moving_alias of this AIMessageModelDto.  # noqa: E501
    :rtype: bool
    """
    return self._moving_alias

prop pricing_version

Gets the pricing_version of this AIMessageModelDto. # noqa: E501

:return: The pricing_version of this AIMessageModelDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The pricing_version of this AIMessageModelDto.  # noqa: E501
    :rtype: str
    """
    return self._pricing_version

prop provider_model

Gets the provider_model of this AIMessageModelDto. # noqa: E501

:return: The provider_model of this AIMessageModelDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The provider_model of this AIMessageModelDto.  # noqa: E501
    :rtype: str
    """
    return self._provider_model

prop supported_message_types

Gets the supported_message_types of this AIMessageModelDto. # noqa: E501

:return: The supported_message_types of this AIMessageModelDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The supported_message_types of this AIMessageModelDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._supported_message_types

prop token_multiplier

Gets the token_multiplier of this AIMessageModelDto. # noqa: E501

:return: The token_multiplier of this AIMessageModelDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The token_multiplier of this AIMessageModelDto.  # noqa: E501
    :rtype: float
    """
    return self._token_multiplier

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model