Module mailslurp_client.models.user_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 UserDto (id=None, api_key=None, email_address=None, email_address_md5=None, created=None, user_type=None, organization=None, verified=None, has_password=None, is_frozen=None, frozen_message=None, add_new_contacts=None, sso_provider=None, customer_id=None, has_onboarded=None, imap_username=None, imap_password=None, smtp_username=None, smtp_password=None, charge_pending=None, enable_sms=None, vendor_email_address=None, unsubscribed=None, api_access_token=None, phone_number=None, verified_phone=None, account_region=None, name=None, access_link_send_result=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.

UserDto - a model defined in OpenAPI

Expand source code

class UserDto(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 = {
        'id': 'str',
        'api_key': 'str',
        'email_address': 'str',
        'email_address_md5': 'str',
        'created': 'datetime',
        'user_type': 'str',
        'organization': 'str',
        'verified': 'str',
        'has_password': 'bool',
        'is_frozen': 'bool',
        'frozen_message': 'str',
        'add_new_contacts': 'bool',
        'sso_provider': 'str',
        'customer_id': 'str',
        'has_onboarded': 'bool',
        'imap_username': 'str',
        'imap_password': 'str',
        'smtp_username': 'str',
        'smtp_password': 'str',
        'charge_pending': 'bool',
        'enable_sms': 'bool',
        'vendor_email_address': 'str',
        'unsubscribed': 'bool',
        'api_access_token': 'TemporaryAccessKeyDto',
        'phone_number': 'str',
        'verified_phone': 'str',
        'account_region': 'str',
        'name': 'str',
        'access_link_send_result': 'AccessLinkSendResultDto'
    }

    attribute_map = {
        'id': 'id',
        'api_key': 'apiKey',
        'email_address': 'emailAddress',
        'email_address_md5': 'emailAddressMd5',
        'created': 'created',
        'user_type': 'userType',
        'organization': 'organization',
        'verified': 'verified',
        'has_password': 'hasPassword',
        'is_frozen': 'isFrozen',
        'frozen_message': 'frozenMessage',
        'add_new_contacts': 'addNewContacts',
        'sso_provider': 'ssoProvider',
        'customer_id': 'customerId',
        'has_onboarded': 'hasOnboarded',
        'imap_username': 'imapUsername',
        'imap_password': 'imapPassword',
        'smtp_username': 'smtpUsername',
        'smtp_password': 'smtpPassword',
        'charge_pending': 'chargePending',
        'enable_sms': 'enableSms',
        'vendor_email_address': 'vendorEmailAddress',
        'unsubscribed': 'unsubscribed',
        'api_access_token': 'apiAccessToken',
        'phone_number': 'phoneNumber',
        'verified_phone': 'verifiedPhone',
        'account_region': 'accountRegion',
        'name': 'name',
        'access_link_send_result': 'accessLinkSendResult'
    }

    def __init__(self, id=None, api_key=None, email_address=None, email_address_md5=None, created=None, user_type=None, organization=None, verified=None, has_password=None, is_frozen=None, frozen_message=None, add_new_contacts=None, sso_provider=None, customer_id=None, has_onboarded=None, imap_username=None, imap_password=None, smtp_username=None, smtp_password=None, charge_pending=None, enable_sms=None, vendor_email_address=None, unsubscribed=None, api_access_token=None, phone_number=None, verified_phone=None, account_region=None, name=None, access_link_send_result=None, local_vars_configuration=None):  # noqa: E501
        """UserDto - 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._id = None
        self._api_key = None
        self._email_address = None
        self._email_address_md5 = None
        self._created = None
        self._user_type = None
        self._organization = None
        self._verified = None
        self._has_password = None
        self._is_frozen = None
        self._frozen_message = None
        self._add_new_contacts = None
        self._sso_provider = None
        self._customer_id = None
        self._has_onboarded = None
        self._imap_username = None
        self._imap_password = None
        self._smtp_username = None
        self._smtp_password = None
        self._charge_pending = None
        self._enable_sms = None
        self._vendor_email_address = None
        self._unsubscribed = None
        self._api_access_token = None
        self._phone_number = None
        self._verified_phone = None
        self._account_region = None
        self._name = None
        self._access_link_send_result = None
        self.discriminator = None

        self.id = id
        self.api_key = api_key
        self.email_address = email_address
        self.email_address_md5 = email_address_md5
        self.created = created
        self.user_type = user_type
        self.organization = organization
        self.verified = verified
        self.has_password = has_password
        self.is_frozen = is_frozen
        self.frozen_message = frozen_message
        self.add_new_contacts = add_new_contacts
        self.sso_provider = sso_provider
        self.customer_id = customer_id
        self.has_onboarded = has_onboarded
        self.imap_username = imap_username
        self.imap_password = imap_password
        self.smtp_username = smtp_username
        self.smtp_password = smtp_password
        self.charge_pending = charge_pending
        self.enable_sms = enable_sms
        self.vendor_email_address = vendor_email_address
        self.unsubscribed = unsubscribed
        self.api_access_token = api_access_token
        self.phone_number = phone_number
        self.verified_phone = verified_phone
        self.account_region = account_region
        self.name = name
        self.access_link_send_result = access_link_send_result

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


        :return: The id of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """Sets the id of this UserDto.


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

        self._id = id

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

        Deprecate api key use entity instead  # noqa: E501

        :return: The api_key of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._api_key

    @api_key.setter
    def api_key(self, api_key):
        """Sets the api_key of this UserDto.

        Deprecate api key use entity instead  # noqa: E501

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

        self._api_key = api_key

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


        :return: The email_address of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._email_address

    @email_address.setter
    def email_address(self, email_address):
        """Sets the email_address of this UserDto.


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

        self._email_address = email_address

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


        :return: The email_address_md5 of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._email_address_md5

    @email_address_md5.setter
    def email_address_md5(self, email_address_md5):
        """Sets the email_address_md5 of this UserDto.


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

        self._email_address_md5 = email_address_md5

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


        :return: The created of this UserDto.  # noqa: E501
        :rtype: datetime
        """
        return self._created

    @created.setter
    def created(self, created):
        """Sets the created of this UserDto.


        :param created: The created of this UserDto.  # noqa: E501
        :type: datetime
        """

        self._created = created

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


        :return: The user_type of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._user_type

    @user_type.setter
    def user_type(self, user_type):
        """Sets the user_type of this UserDto.


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

        self._user_type = user_type

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

        Does user belong to an organization  # noqa: E501

        :return: The organization of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._organization

    @organization.setter
    def organization(self, organization):
        """Sets the organization of this UserDto.

        Does user belong to an organization  # noqa: E501

        :param organization: The organization of this UserDto.  # noqa: E501
        :type: str
        """

        self._organization = organization

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

        Has user accepted an organization invite  # noqa: E501

        :return: The verified of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._verified

    @verified.setter
    def verified(self, verified):
        """Sets the verified of this UserDto.

        Has user accepted an organization invite  # noqa: E501

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

        self._verified = verified

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


        :return: The has_password of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._has_password

    @has_password.setter
    def has_password(self, has_password):
        """Sets the has_password of this UserDto.


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

        self._has_password = has_password

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


        :return: The is_frozen of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._is_frozen

    @is_frozen.setter
    def is_frozen(self, is_frozen):
        """Sets the is_frozen of this UserDto.


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

        self._is_frozen = is_frozen

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


        :return: The frozen_message of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._frozen_message

    @frozen_message.setter
    def frozen_message(self, frozen_message):
        """Sets the frozen_message of this UserDto.


        :param frozen_message: The frozen_message of this UserDto.  # noqa: E501
        :type: str
        """

        self._frozen_message = frozen_message

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


        :return: The add_new_contacts of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._add_new_contacts

    @add_new_contacts.setter
    def add_new_contacts(self, add_new_contacts):
        """Sets the add_new_contacts of this UserDto.


        :param add_new_contacts: The add_new_contacts of this UserDto.  # noqa: E501
        :type: bool
        """

        self._add_new_contacts = add_new_contacts

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


        :return: The sso_provider of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._sso_provider

    @sso_provider.setter
    def sso_provider(self, sso_provider):
        """Sets the sso_provider of this UserDto.


        :param sso_provider: The sso_provider of this UserDto.  # noqa: E501
        :type: str
        """

        self._sso_provider = sso_provider

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


        :return: The customer_id of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._customer_id

    @customer_id.setter
    def customer_id(self, customer_id):
        """Sets the customer_id of this UserDto.


        :param customer_id: The customer_id of this UserDto.  # noqa: E501
        :type: str
        """

        self._customer_id = customer_id

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


        :return: The has_onboarded of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._has_onboarded

    @has_onboarded.setter
    def has_onboarded(self, has_onboarded):
        """Sets the has_onboarded of this UserDto.


        :param has_onboarded: The has_onboarded of this UserDto.  # noqa: E501
        :type: bool
        """

        self._has_onboarded = has_onboarded

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


        :return: The imap_username of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._imap_username

    @imap_username.setter
    def imap_username(self, imap_username):
        """Sets the imap_username of this UserDto.


        :param imap_username: The imap_username of this UserDto.  # noqa: E501
        :type: str
        """

        self._imap_username = imap_username

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


        :return: The imap_password of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._imap_password

    @imap_password.setter
    def imap_password(self, imap_password):
        """Sets the imap_password of this UserDto.


        :param imap_password: The imap_password of this UserDto.  # noqa: E501
        :type: str
        """

        self._imap_password = imap_password

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


        :return: The smtp_username of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._smtp_username

    @smtp_username.setter
    def smtp_username(self, smtp_username):
        """Sets the smtp_username of this UserDto.


        :param smtp_username: The smtp_username of this UserDto.  # noqa: E501
        :type: str
        """

        self._smtp_username = smtp_username

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


        :return: The smtp_password of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._smtp_password

    @smtp_password.setter
    def smtp_password(self, smtp_password):
        """Sets the smtp_password of this UserDto.


        :param smtp_password: The smtp_password of this UserDto.  # noqa: E501
        :type: str
        """

        self._smtp_password = smtp_password

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


        :return: The charge_pending of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._charge_pending

    @charge_pending.setter
    def charge_pending(self, charge_pending):
        """Sets the charge_pending of this UserDto.


        :param charge_pending: The charge_pending of this UserDto.  # noqa: E501
        :type: bool
        """

        self._charge_pending = charge_pending

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


        :return: The enable_sms of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._enable_sms

    @enable_sms.setter
    def enable_sms(self, enable_sms):
        """Sets the enable_sms of this UserDto.


        :param enable_sms: The enable_sms of this UserDto.  # noqa: E501
        :type: bool
        """

        self._enable_sms = enable_sms

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


        :return: The vendor_email_address of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._vendor_email_address

    @vendor_email_address.setter
    def vendor_email_address(self, vendor_email_address):
        """Sets the vendor_email_address of this UserDto.


        :param vendor_email_address: The vendor_email_address of this UserDto.  # noqa: E501
        :type: str
        """

        self._vendor_email_address = vendor_email_address

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


        :return: The unsubscribed of this UserDto.  # noqa: E501
        :rtype: bool
        """
        return self._unsubscribed

    @unsubscribed.setter
    def unsubscribed(self, unsubscribed):
        """Sets the unsubscribed of this UserDto.


        :param unsubscribed: The unsubscribed of this UserDto.  # noqa: E501
        :type: bool
        """

        self._unsubscribed = unsubscribed

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


        :return: The api_access_token of this UserDto.  # noqa: E501
        :rtype: TemporaryAccessKeyDto
        """
        return self._api_access_token

    @api_access_token.setter
    def api_access_token(self, api_access_token):
        """Sets the api_access_token of this UserDto.


        :param api_access_token: The api_access_token of this UserDto.  # noqa: E501
        :type: TemporaryAccessKeyDto
        """

        self._api_access_token = api_access_token

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


        :return: The phone_number of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._phone_number

    @phone_number.setter
    def phone_number(self, phone_number):
        """Sets the phone_number of this UserDto.


        :param phone_number: The phone_number of this UserDto.  # noqa: E501
        :type: str
        """

        self._phone_number = phone_number

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

        Has user accepted an organization invite  # noqa: E501

        :return: The verified_phone of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._verified_phone

    @verified_phone.setter
    def verified_phone(self, verified_phone):
        """Sets the verified_phone of this UserDto.

        Has user accepted an organization invite  # noqa: E501

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

        self._verified_phone = verified_phone

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

        Default account region  # noqa: E501

        :return: The account_region of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._account_region

    @account_region.setter
    def account_region(self, account_region):
        """Sets the account_region of this UserDto.

        Default account region  # noqa: E501

        :param account_region: The account_region of this UserDto.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"US_WEST_2_ACCOUNT_STAGING", "US_EAST_1_ACCOUNT_STAGING", "EU_WEST_1_ACCOUNT_STAGING", "US_WEST_2_ACCOUNT_SES_1", "US_EAST_1_ACCOUNT_SES_1", "EU_WEST_1_ACCOUNT_SES_1", "US_WEST_2_ACCOUNT_SES_2", "EU_WEST_1_ACCOUNT_SES_2", "US_WEST_2_ACCOUNT_SES_3", "US_WEST_2_ACCOUNT_BYTEWISE", "EU_WEST_1_ACCOUNT_BYTEWISE", "US_WEST_2", "EU_WEST_1", "US_EAST_1"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and account_region not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `account_region` ({0}), must be one of {1}"  # noqa: E501
                .format(account_region, allowed_values)
            )

        self._account_region = account_region

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

        User display name  # noqa: E501

        :return: The name of this UserDto.  # noqa: E501
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """Sets the name of this UserDto.

        User display name  # noqa: E501

        :param name: The name of this UserDto.  # noqa: E501
        :type: str
        """

        self._name = name

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


        :return: The access_link_send_result of this UserDto.  # noqa: E501
        :rtype: AccessLinkSendResultDto
        """
        return self._access_link_send_result

    @access_link_send_result.setter
    def access_link_send_result(self, access_link_send_result):
        """Sets the access_link_send_result of this UserDto.


        :param access_link_send_result: The access_link_send_result of this UserDto.  # noqa: E501
        :type: AccessLinkSendResultDto
        """

        self._access_link_send_result = access_link_send_result

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop access_link_send_result

Gets the access_link_send_result of this UserDto. # noqa: E501

:return: The access_link_send_result of this UserDto. # noqa: E501 :rtype: AccessLinkSendResultDto

Expand source code

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


    :return: The access_link_send_result of this UserDto.  # noqa: E501
    :rtype: AccessLinkSendResultDto
    """
    return self._access_link_send_result

prop account_region

Gets the account_region of this UserDto. # noqa: E501

Default account region # noqa: E501

:return: The account_region of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    Default account region  # noqa: E501

    :return: The account_region of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._account_region

prop add_new_contacts

Gets the add_new_contacts of this UserDto. # noqa: E501

:return: The add_new_contacts of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The add_new_contacts of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._add_new_contacts

prop api_access_token

Gets the api_access_token of this UserDto. # noqa: E501

:return: The api_access_token of this UserDto. # noqa: E501 :rtype: TemporaryAccessKeyDto

Expand source code

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


    :return: The api_access_token of this UserDto.  # noqa: E501
    :rtype: TemporaryAccessKeyDto
    """
    return self._api_access_token

prop api_key

Gets the api_key of this UserDto. # noqa: E501

Deprecate api key use entity instead # noqa: E501

:return: The api_key of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    Deprecate api key use entity instead  # noqa: E501

    :return: The api_key of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._api_key

prop charge_pending

Gets the charge_pending of this UserDto. # noqa: E501

:return: The charge_pending of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The charge_pending of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._charge_pending

prop created

Gets the created of this UserDto. # noqa: E501

:return: The created of this UserDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The created of this UserDto.  # noqa: E501
    :rtype: datetime
    """
    return self._created

prop customer_id

Gets the customer_id of this UserDto. # noqa: E501

:return: The customer_id of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The customer_id of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._customer_id

prop email_address

Gets the email_address of this UserDto. # noqa: E501

:return: The email_address of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The email_address of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._email_address

prop email_address_md5

Gets the email_address_md5 of this UserDto. # noqa: E501

:return: The email_address_md5 of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The email_address_md5 of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._email_address_md5

prop enable_sms

Gets the enable_sms of this UserDto. # noqa: E501

:return: The enable_sms of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The enable_sms of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._enable_sms

prop frozen_message

Gets the frozen_message of this UserDto. # noqa: E501

:return: The frozen_message of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The frozen_message of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._frozen_message

prop has_onboarded

Gets the has_onboarded of this UserDto. # noqa: E501

:return: The has_onboarded of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The has_onboarded of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._has_onboarded

prop has_password

Gets the has_password of this UserDto. # noqa: E501

:return: The has_password of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The has_password of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._has_password

prop id

Gets the id of this UserDto. # noqa: E501

:return: The id of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The id of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._id

prop imap_password

Gets the imap_password of this UserDto. # noqa: E501

:return: The imap_password of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The imap_password of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._imap_password

prop imap_username

Gets the imap_username of this UserDto. # noqa: E501

:return: The imap_username of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The imap_username of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._imap_username

prop is_frozen

Gets the is_frozen of this UserDto. # noqa: E501

:return: The is_frozen of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The is_frozen of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._is_frozen

prop name

Gets the name of this UserDto. # noqa: E501

User display name # noqa: E501

:return: The name of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    User display name  # noqa: E501

    :return: The name of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._name

prop organization

Gets the organization of this UserDto. # noqa: E501

Does user belong to an organization # noqa: E501

:return: The organization of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    Does user belong to an organization  # noqa: E501

    :return: The organization of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._organization

prop phone_number

Gets the phone_number of this UserDto. # noqa: E501

:return: The phone_number of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_number of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._phone_number

prop smtp_password

Gets the smtp_password of this UserDto. # noqa: E501

:return: The smtp_password of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The smtp_password of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._smtp_password

prop smtp_username

Gets the smtp_username of this UserDto. # noqa: E501

:return: The smtp_username of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The smtp_username of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._smtp_username

prop sso_provider

Gets the sso_provider of this UserDto. # noqa: E501

:return: The sso_provider of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sso_provider of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._sso_provider

prop unsubscribed

Gets the unsubscribed of this UserDto. # noqa: E501

:return: The unsubscribed of this UserDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The unsubscribed of this UserDto.  # noqa: E501
    :rtype: bool
    """
    return self._unsubscribed

prop user_type

Gets the user_type of this UserDto. # noqa: E501

:return: The user_type of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The user_type of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._user_type

prop vendor_email_address

Gets the vendor_email_address of this UserDto. # noqa: E501

:return: The vendor_email_address of this UserDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The vendor_email_address of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._vendor_email_address

prop verified

Gets the verified of this UserDto. # noqa: E501

Has user accepted an organization invite # noqa: E501

:return: The verified of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    Has user accepted an organization invite  # noqa: E501

    :return: The verified of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._verified

prop verified_phone

Gets the verified_phone of this UserDto. # noqa: E501

Has user accepted an organization invite # noqa: E501

:return: The verified_phone of this UserDto. # noqa: E501 :rtype: str

Expand source code

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

    Has user accepted an organization invite  # noqa: E501

    :return: The verified_phone of this UserDto.  # noqa: E501
    :rtype: str
    """
    return self._verified_phone

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model