Module mailslurp_client.models.auth_bootstrap_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 AuthBootstrapDto (access_token=None, account=None, user_permissions=None, effective_user_permissions=None, home_experience=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.

AuthBootstrapDto - a model defined in OpenAPI

Expand source code

class AuthBootstrapDto(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 = {
        'access_token': 'TemporaryAccessKeyDto',
        'account': 'AccountDto',
        'user_permissions': 'list[UserPermissionDto]',
        'effective_user_permissions': 'list[str]',
        'home_experience': 'HomeExperienceDto'
    }

    attribute_map = {
        'access_token': 'accessToken',
        'account': 'account',
        'user_permissions': 'userPermissions',
        'effective_user_permissions': 'effectiveUserPermissions',
        'home_experience': 'homeExperience'
    }

    def __init__(self, access_token=None, account=None, user_permissions=None, effective_user_permissions=None, home_experience=None, local_vars_configuration=None):  # noqa: E501
        """AuthBootstrapDto - 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._access_token = None
        self._account = None
        self._user_permissions = None
        self._effective_user_permissions = None
        self._home_experience = None
        self.discriminator = None

        self.access_token = access_token
        self.account = account
        self.user_permissions = user_permissions
        self.effective_user_permissions = effective_user_permissions
        self.home_experience = home_experience

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


        :return: The access_token of this AuthBootstrapDto.  # noqa: E501
        :rtype: TemporaryAccessKeyDto
        """
        return self._access_token

    @access_token.setter
    def access_token(self, access_token):
        """Sets the access_token of this AuthBootstrapDto.


        :param access_token: The access_token of this AuthBootstrapDto.  # noqa: E501
        :type: TemporaryAccessKeyDto
        """

        self._access_token = access_token

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


        :return: The account of this AuthBootstrapDto.  # noqa: E501
        :rtype: AccountDto
        """
        return self._account

    @account.setter
    def account(self, account):
        """Sets the account of this AuthBootstrapDto.


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

        self._account = account

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


        :return: The user_permissions of this AuthBootstrapDto.  # noqa: E501
        :rtype: list[UserPermissionDto]
        """
        return self._user_permissions

    @user_permissions.setter
    def user_permissions(self, user_permissions):
        """Sets the user_permissions of this AuthBootstrapDto.


        :param user_permissions: The user_permissions of this AuthBootstrapDto.  # noqa: E501
        :type: list[UserPermissionDto]
        """
        if self.local_vars_configuration.client_side_validation and user_permissions is None:  # noqa: E501
            raise ValueError("Invalid value for `user_permissions`, must not be `None`")  # noqa: E501

        self._user_permissions = user_permissions

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


        :return: The effective_user_permissions of this AuthBootstrapDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._effective_user_permissions

    @effective_user_permissions.setter
    def effective_user_permissions(self, effective_user_permissions):
        """Sets the effective_user_permissions of this AuthBootstrapDto.


        :param effective_user_permissions: The effective_user_permissions of this AuthBootstrapDto.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and effective_user_permissions is None:  # noqa: E501
            raise ValueError("Invalid value for `effective_user_permissions`, must not be `None`")  # noqa: E501
        allowed_values = ["CREATE_INBOX", "DELETE_INBOX", "DELETE_EMAIL", "DELETE_ATTACHMENT", "DELETE_SMS", "UPDATE_INBOX", "READ_EMAIL", "READ_EMAIL_DRAFT", "READ_SMS", "REPLY_EMAIL", "CREATE_EMAIL_DRAFT", "UPDATE_EMAIL_DRAFT", "DELETE_EMAIL_DRAFT", "SEND_EMAIL_DRAFT", "AGENT_READ_EMAIL", "AGENT_REPLY_EMAIL", "AGENT_READ_EMAIL_DRAFT", "AGENT_CREATE_EMAIL_DRAFT", "AGENT_UPDATE_EMAIL_DRAFT", "AGENT_DELETE_EMAIL_DRAFT", "AGENT_SEND_EMAIL_DRAFT", "AGENT_CREATE_INBOX", "AGENT_UPDATE_INBOX", "AGENT_READ_TOTP_DEVICE", "AGENT_CREATE_TOTP_DEVICE", "AGENT_UPDATE_TOTP_DEVICE", "AGENT_DELETE_TOTP_DEVICE", "AGENT_GENERATE_TOTP_CODE", "AGENT_READ_SMS", "AGENT_SEND_SMS", "REPLY_SMS", "ACCESS_EMAIL", "ACCESS_SMS", "ACCESS_EMAIL_SMS", "CREATE_TEAM_USER", "READ_TEAM_USER", "DELETE_TEAM_USER", "UPDATE_TEAM_USER", "MANAGE_ORGANIZATION", "MANAGE_ORGANIZATION_SETTINGS", "MANAGE_ORGANIZATION_SAML", "MANAGE_ACCOUNT_SETTINGS", "MANAGE_BILLING", "MANAGE_API_KEYS", "MANAGE_EXPORTS", "MANAGE_NOTIFICATIONS"]  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                not set(effective_user_permissions).issubset(set(allowed_values))):  # noqa: E501
            raise ValueError(
                "Invalid values for `effective_user_permissions` [{0}], must be a subset of [{1}]"  # noqa: E501
                .format(", ".join(map(str, set(effective_user_permissions) - set(allowed_values))),  # noqa: E501
                        ", ".join(map(str, allowed_values)))
            )

        self._effective_user_permissions = effective_user_permissions

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


        :return: The home_experience of this AuthBootstrapDto.  # noqa: E501
        :rtype: HomeExperienceDto
        """
        return self._home_experience

    @home_experience.setter
    def home_experience(self, home_experience):
        """Sets the home_experience of this AuthBootstrapDto.


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

        self._home_experience = home_experience

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop access_token

Gets the access_token of this AuthBootstrapDto. # noqa: E501

:return: The access_token of this AuthBootstrapDto. # noqa: E501 :rtype: TemporaryAccessKeyDto

Expand source code

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


    :return: The access_token of this AuthBootstrapDto.  # noqa: E501
    :rtype: TemporaryAccessKeyDto
    """
    return self._access_token

prop account

Gets the account of this AuthBootstrapDto. # noqa: E501

:return: The account of this AuthBootstrapDto. # noqa: E501 :rtype: AccountDto

Expand source code

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


    :return: The account of this AuthBootstrapDto.  # noqa: E501
    :rtype: AccountDto
    """
    return self._account

prop effective_user_permissions

Gets the effective_user_permissions of this AuthBootstrapDto. # noqa: E501

:return: The effective_user_permissions of this AuthBootstrapDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The effective_user_permissions of this AuthBootstrapDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._effective_user_permissions

prop home_experience

Gets the home_experience of this AuthBootstrapDto. # noqa: E501

:return: The home_experience of this AuthBootstrapDto. # noqa: E501 :rtype: HomeExperienceDto

Expand source code

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


    :return: The home_experience of this AuthBootstrapDto.  # noqa: E501
    :rtype: HomeExperienceDto
    """
    return self._home_experience

prop user_permissions

Gets the user_permissions of this AuthBootstrapDto. # noqa: E501

:return: The user_permissions of this AuthBootstrapDto. # noqa: E501 :rtype: list[UserPermissionDto]

Expand source code

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


    :return: The user_permissions of this AuthBootstrapDto.  # noqa: E501
    :rtype: list[UserPermissionDto]
    """
    return self._user_permissions

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model