Module mailslurp_client.models.create_totp_device_base32_secret_key_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 CreateTotpDeviceBase32SecretKeyOptions (base32_secret_key=None, name=None, username=None, issuer=None, digits=6, period=30, algorithm=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.

CreateTotpDeviceBase32SecretKeyOptions - a model defined in OpenAPI

Expand source code

class CreateTotpDeviceBase32SecretKeyOptions(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 = {
        'base32_secret_key': 'str',
        'name': 'str',
        'username': 'str',
        'issuer': 'str',
        'digits': 'int',
        'period': 'int',
        'algorithm': 'str'
    }

    attribute_map = {
        'base32_secret_key': 'base32SecretKey',
        'name': 'name',
        'username': 'username',
        'issuer': 'issuer',
        'digits': 'digits',
        'period': 'period',
        'algorithm': 'algorithm'
    }

    def __init__(self, base32_secret_key=None, name=None, username=None, issuer=None, digits=6, period=30, algorithm=None, local_vars_configuration=None):  # noqa: E501
        """CreateTotpDeviceBase32SecretKeyOptions - 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._base32_secret_key = None
        self._name = None
        self._username = None
        self._issuer = None
        self._digits = None
        self._period = None
        self._algorithm = None
        self.discriminator = None

        self.base32_secret_key = base32_secret_key
        self.name = name
        self.username = username
        self.issuer = issuer
        self.digits = digits
        self.period = period
        self.algorithm = algorithm

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

        Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code.  # noqa: E501

        :return: The base32_secret_key of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._base32_secret_key

    @base32_secret_key.setter
    def base32_secret_key(self, base32_secret_key):
        """Sets the base32_secret_key of this CreateTotpDeviceBase32SecretKeyOptions.

        Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code.  # noqa: E501

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

        self._base32_secret_key = base32_secret_key

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

        Name for labeling the TOTP device  # noqa: E501

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

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

        Name for labeling the TOTP device  # noqa: E501

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

        self._name = name

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

        Optional username for the TOTP device  # noqa: E501

        :return: The username of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._username

    @username.setter
    def username(self, username):
        """Sets the username of this CreateTotpDeviceBase32SecretKeyOptions.

        Optional username for the TOTP device  # noqa: E501

        :param username: The username of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :type: str
        """

        self._username = username

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

        Optional issuer override for the TOTP device  # noqa: E501

        :return: The issuer of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._issuer

    @issuer.setter
    def issuer(self, issuer):
        """Sets the issuer of this CreateTotpDeviceBase32SecretKeyOptions.

        Optional issuer override for the TOTP device  # noqa: E501

        :param issuer: The issuer of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :type: str
        """

        self._issuer = issuer

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

        Optional number of digits in TOTP code  # noqa: E501

        :return: The digits of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: int
        """
        return self._digits

    @digits.setter
    def digits(self, digits):
        """Sets the digits of this CreateTotpDeviceBase32SecretKeyOptions.

        Optional number of digits in TOTP code  # noqa: E501

        :param digits: The digits of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :type: int
        """
        if (self.local_vars_configuration.client_side_validation and
                digits is not None and digits > 255):  # noqa: E501
            raise ValueError("Invalid value for `digits`, must be a value less than or equal to `255`")  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                digits is not None and digits < 0):  # noqa: E501
            raise ValueError("Invalid value for `digits`, must be a value greater than or equal to `0`")  # noqa: E501

        self._digits = digits

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

        Optional period in seconds for TOTP code expiration  # noqa: E501

        :return: The period of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: int
        """
        return self._period

    @period.setter
    def period(self, period):
        """Sets the period of this CreateTotpDeviceBase32SecretKeyOptions.

        Optional period in seconds for TOTP code expiration  # noqa: E501

        :param period: The period of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :type: int
        """

        self._period = period

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

        Optional algorithm override  # noqa: E501

        :return: The algorithm of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._algorithm

    @algorithm.setter
    def algorithm(self, algorithm):
        """Sets the algorithm of this CreateTotpDeviceBase32SecretKeyOptions.

        Optional algorithm override  # noqa: E501

        :param algorithm: The algorithm of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
        :type: str
        """

        self._algorithm = algorithm

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop algorithm

Gets the algorithm of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Optional algorithm override # noqa: E501

:return: The algorithm of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional algorithm override  # noqa: E501

    :return: The algorithm of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._algorithm

prop base32_secret_key

Gets the base32_secret_key of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code. # noqa: E501

:return: The base32_secret_key of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: str

Expand source code

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

    Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code.  # noqa: E501

    :return: The base32_secret_key of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._base32_secret_key

prop digits

Gets the digits of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Optional number of digits in TOTP code # noqa: E501

:return: The digits of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: int

Expand source code

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

    Optional number of digits in TOTP code  # noqa: E501

    :return: The digits of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: int
    """
    return self._digits

prop issuer

Gets the issuer of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Optional issuer override for the TOTP device # noqa: E501

:return: The issuer of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional issuer override for the TOTP device  # noqa: E501

    :return: The issuer of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._issuer

prop name

Gets the name of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Name for labeling the TOTP device # noqa: E501

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

Expand source code

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

    Name for labeling the TOTP device  # noqa: E501

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

prop period

Gets the period of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Optional period in seconds for TOTP code expiration # noqa: E501

:return: The period of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: int

Expand source code

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

    Optional period in seconds for TOTP code expiration  # noqa: E501

    :return: The period of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: int
    """
    return self._period

prop username

Gets the username of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501

Optional username for the TOTP device # noqa: E501

:return: The username of this CreateTotpDeviceBase32SecretKeyOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional username for the TOTP device  # noqa: E501

    :return: The username of this CreateTotpDeviceBase32SecretKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._username

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model