Module mailslurp_client.models.home_experience_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 HomeExperienceDto (version=None, home_variant=None, primary_path=None, secondary_paths=None, persona=None, team_size=None, checklist=None, first_value=None, upgrade_context=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.

HomeExperienceDto - a model defined in OpenAPI

Expand source code

class HomeExperienceDto(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 = {
        'version': 'str',
        'home_variant': 'str',
        'primary_path': 'str',
        'secondary_paths': 'list[str]',
        'persona': 'str',
        'team_size': 'str',
        'checklist': 'HomeExperienceChecklistDto',
        'first_value': 'HomeExperienceFirstValueDto',
        'upgrade_context': 'HomeExperienceUpgradeContextDto'
    }

    attribute_map = {
        'version': 'version',
        'home_variant': 'homeVariant',
        'primary_path': 'primaryPath',
        'secondary_paths': 'secondaryPaths',
        'persona': 'persona',
        'team_size': 'teamSize',
        'checklist': 'checklist',
        'first_value': 'firstValue',
        'upgrade_context': 'upgradeContext'
    }

    def __init__(self, version=None, home_variant=None, primary_path=None, secondary_paths=None, persona=None, team_size=None, checklist=None, first_value=None, upgrade_context=None, local_vars_configuration=None):  # noqa: E501
        """HomeExperienceDto - 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._version = None
        self._home_variant = None
        self._primary_path = None
        self._secondary_paths = None
        self._persona = None
        self._team_size = None
        self._checklist = None
        self._first_value = None
        self._upgrade_context = None
        self.discriminator = None

        self.version = version
        self.home_variant = home_variant
        self.primary_path = primary_path
        self.secondary_paths = secondary_paths
        self.persona = persona
        self.team_size = team_size
        self.checklist = checklist
        self.first_value = first_value
        self.upgrade_context = upgrade_context

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


        :return: The version of this HomeExperienceDto.  # noqa: E501
        :rtype: str
        """
        return self._version

    @version.setter
    def version(self, version):
        """Sets the version of this HomeExperienceDto.


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

        self._version = version

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


        :return: The home_variant of this HomeExperienceDto.  # noqa: E501
        :rtype: str
        """
        return self._home_variant

    @home_variant.setter
    def home_variant(self, home_variant):
        """Sets the home_variant of this HomeExperienceDto.


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

        self._home_variant = home_variant

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


        :return: The primary_path of this HomeExperienceDto.  # noqa: E501
        :rtype: str
        """
        return self._primary_path

    @primary_path.setter
    def primary_path(self, primary_path):
        """Sets the primary_path of this HomeExperienceDto.


        :param primary_path: The primary_path of this HomeExperienceDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and primary_path is None:  # noqa: E501
            raise ValueError("Invalid value for `primary_path`, must not be `None`")  # noqa: E501
        allowed_values = ["DEVELOPERS", "EMAIL", "TEST", "PHONE", "EXTRACT", "AUTOMATIONS", "OBSERVE", "AUTOMATIONS_AI", "UNDECIDED"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and primary_path not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `primary_path` ({0}), must be one of {1}"  # noqa: E501
                .format(primary_path, allowed_values)
            )

        self._primary_path = primary_path

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


        :return: The secondary_paths of this HomeExperienceDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._secondary_paths

    @secondary_paths.setter
    def secondary_paths(self, secondary_paths):
        """Sets the secondary_paths of this HomeExperienceDto.


        :param secondary_paths: The secondary_paths of this HomeExperienceDto.  # noqa: E501
        :type: list[str]
        """
        allowed_values = [None,"DEVELOPERS", "EMAIL", "TEST", "PHONE", "EXTRACT", "AUTOMATIONS", "OBSERVE", "AUTOMATIONS_AI", "UNDECIDED"]  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                not set(secondary_paths).issubset(set(allowed_values))):  # noqa: E501
            raise ValueError(
                "Invalid values for `secondary_paths` [{0}], must be a subset of [{1}]"  # noqa: E501
                .format(", ".join(map(str, set(secondary_paths) - set(allowed_values))),  # noqa: E501
                        ", ".join(map(str, allowed_values)))
            )

        self._secondary_paths = secondary_paths

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


        :return: The persona of this HomeExperienceDto.  # noqa: E501
        :rtype: str
        """
        return self._persona

    @persona.setter
    def persona(self, persona):
        """Sets the persona of this HomeExperienceDto.


        :param persona: The persona of this HomeExperienceDto.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"DEVELOPER", "QA", "MARKETER", "OPS", "SUPPORT", "OTHER"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and persona not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `persona` ({0}), must be one of {1}"  # noqa: E501
                .format(persona, allowed_values)
            )

        self._persona = persona

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


        :return: The team_size of this HomeExperienceDto.  # noqa: E501
        :rtype: str
        """
        return self._team_size

    @team_size.setter
    def team_size(self, team_size):
        """Sets the team_size of this HomeExperienceDto.


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

        self._team_size = team_size

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


        :return: The checklist of this HomeExperienceDto.  # noqa: E501
        :rtype: HomeExperienceChecklistDto
        """
        return self._checklist

    @checklist.setter
    def checklist(self, checklist):
        """Sets the checklist of this HomeExperienceDto.


        :param checklist: The checklist of this HomeExperienceDto.  # noqa: E501
        :type: HomeExperienceChecklistDto
        """

        self._checklist = checklist

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


        :return: The first_value of this HomeExperienceDto.  # noqa: E501
        :rtype: HomeExperienceFirstValueDto
        """
        return self._first_value

    @first_value.setter
    def first_value(self, first_value):
        """Sets the first_value of this HomeExperienceDto.


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

        self._first_value = first_value

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


        :return: The upgrade_context of this HomeExperienceDto.  # noqa: E501
        :rtype: HomeExperienceUpgradeContextDto
        """
        return self._upgrade_context

    @upgrade_context.setter
    def upgrade_context(self, upgrade_context):
        """Sets the upgrade_context of this HomeExperienceDto.


        :param upgrade_context: The upgrade_context of this HomeExperienceDto.  # noqa: E501
        :type: HomeExperienceUpgradeContextDto
        """

        self._upgrade_context = upgrade_context

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop checklist

Gets the checklist of this HomeExperienceDto. # noqa: E501

:return: The checklist of this HomeExperienceDto. # noqa: E501 :rtype: HomeExperienceChecklistDto

Expand source code

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


    :return: The checklist of this HomeExperienceDto.  # noqa: E501
    :rtype: HomeExperienceChecklistDto
    """
    return self._checklist

prop first_value

Gets the first_value of this HomeExperienceDto. # noqa: E501

:return: The first_value of this HomeExperienceDto. # noqa: E501 :rtype: HomeExperienceFirstValueDto

Expand source code

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


    :return: The first_value of this HomeExperienceDto.  # noqa: E501
    :rtype: HomeExperienceFirstValueDto
    """
    return self._first_value

prop home_variant

Gets the home_variant of this HomeExperienceDto. # noqa: E501

:return: The home_variant of this HomeExperienceDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The home_variant of this HomeExperienceDto.  # noqa: E501
    :rtype: str
    """
    return self._home_variant

prop persona

Gets the persona of this HomeExperienceDto. # noqa: E501

:return: The persona of this HomeExperienceDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The persona of this HomeExperienceDto.  # noqa: E501
    :rtype: str
    """
    return self._persona

prop primary_path

Gets the primary_path of this HomeExperienceDto. # noqa: E501

:return: The primary_path of this HomeExperienceDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The primary_path of this HomeExperienceDto.  # noqa: E501
    :rtype: str
    """
    return self._primary_path

prop secondary_paths

Gets the secondary_paths of this HomeExperienceDto. # noqa: E501

:return: The secondary_paths of this HomeExperienceDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The secondary_paths of this HomeExperienceDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._secondary_paths

prop team_size

Gets the team_size of this HomeExperienceDto. # noqa: E501

:return: The team_size of this HomeExperienceDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The team_size of this HomeExperienceDto.  # noqa: E501
    :rtype: str
    """
    return self._team_size

prop upgrade_context

Gets the upgrade_context of this HomeExperienceDto. # noqa: E501

:return: The upgrade_context of this HomeExperienceDto. # noqa: E501 :rtype: HomeExperienceUpgradeContextDto

Expand source code

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


    :return: The upgrade_context of this HomeExperienceDto.  # noqa: E501
    :rtype: HomeExperienceUpgradeContextDto
    """
    return self._upgrade_context

prop version

Gets the version of this HomeExperienceDto. # noqa: E501

:return: The version of this HomeExperienceDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The version of this HomeExperienceDto.  # noqa: E501
    :rtype: str
    """
    return self._version

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model