Module mailslurp_client.models.sms_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 SmsDto (id=None, user_id=None, phone_number=None, from_number=None, to_number=None, favourite=None, body=None, read=None, created_at=None, updated_at=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.

SmsDto - a model defined in OpenAPI

Expand source code

class SmsDto(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',
        'user_id': 'str',
        'phone_number': 'str',
        'from_number': 'str',
        'to_number': 'str',
        'favourite': 'bool',
        'body': 'str',
        'read': 'bool',
        'created_at': 'datetime',
        'updated_at': 'datetime'
    }

    attribute_map = {
        'id': 'id',
        'user_id': 'userId',
        'phone_number': 'phoneNumber',
        'from_number': 'fromNumber',
        'to_number': 'toNumber',
        'favourite': 'favourite',
        'body': 'body',
        'read': 'read',
        'created_at': 'createdAt',
        'updated_at': 'updatedAt'
    }

    def __init__(self, id=None, user_id=None, phone_number=None, from_number=None, to_number=None, favourite=None, body=None, read=None, created_at=None, updated_at=None, local_vars_configuration=None):  # noqa: E501
        """SmsDto - 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._user_id = None
        self._phone_number = None
        self._from_number = None
        self._to_number = None
        self._favourite = None
        self._body = None
        self._read = None
        self._created_at = None
        self._updated_at = None
        self.discriminator = None

        self.id = id
        self.user_id = user_id
        self.phone_number = phone_number
        self.from_number = from_number
        if to_number is not None:
            self.to_number = to_number
        self.favourite = favourite
        self.body = body
        self.read = read
        self.created_at = created_at
        self.updated_at = updated_at

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


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

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


        :param id: The id of this SmsDto.  # 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 user_id(self):
        """Gets the user_id of this SmsDto.  # noqa: E501


        :return: The user_id of this SmsDto.  # noqa: E501
        :rtype: str
        """
        return self._user_id

    @user_id.setter
    def user_id(self, user_id):
        """Sets the user_id of this SmsDto.


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

        self._user_id = user_id

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


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

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


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

        self._phone_number = phone_number

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


        :return: The from_number of this SmsDto.  # noqa: E501
        :rtype: str
        """
        return self._from_number

    @from_number.setter
    def from_number(self, from_number):
        """Sets the from_number of this SmsDto.


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

        self._from_number = from_number

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


        :return: The to_number of this SmsDto.  # noqa: E501
        :rtype: str
        """
        return self._to_number

    @to_number.setter
    def to_number(self, to_number):
        """Sets the to_number of this SmsDto.


        :param to_number: The to_number of this SmsDto.  # noqa: E501
        :type: str
        """

        self._to_number = to_number

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


        :return: The favourite of this SmsDto.  # noqa: E501
        :rtype: bool
        """
        return self._favourite

    @favourite.setter
    def favourite(self, favourite):
        """Sets the favourite of this SmsDto.


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

        self._favourite = favourite

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


        :return: The body of this SmsDto.  # noqa: E501
        :rtype: str
        """
        return self._body

    @body.setter
    def body(self, body):
        """Sets the body of this SmsDto.


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

        self._body = body

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


        :return: The read of this SmsDto.  # noqa: E501
        :rtype: bool
        """
        return self._read

    @read.setter
    def read(self, read):
        """Sets the read of this SmsDto.


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

        self._read = read

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


        :return: The created_at of this SmsDto.  # noqa: E501
        :rtype: datetime
        """
        return self._created_at

    @created_at.setter
    def created_at(self, created_at):
        """Sets the created_at of this SmsDto.


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

        self._created_at = created_at

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


        :return: The updated_at of this SmsDto.  # noqa: E501
        :rtype: datetime
        """
        return self._updated_at

    @updated_at.setter
    def updated_at(self, updated_at):
        """Sets the updated_at of this SmsDto.


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

        self._updated_at = updated_at

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop body

Gets the body of this SmsDto. # noqa: E501

:return: The body of this SmsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The body of this SmsDto.  # noqa: E501
    :rtype: str
    """
    return self._body

prop created_at

Gets the created_at of this SmsDto. # noqa: E501

:return: The created_at of this SmsDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The created_at of this SmsDto.  # noqa: E501
    :rtype: datetime
    """
    return self._created_at

prop favourite

Gets the favourite of this SmsDto. # noqa: E501

:return: The favourite of this SmsDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The favourite of this SmsDto.  # noqa: E501
    :rtype: bool
    """
    return self._favourite

prop from_number

Gets the from_number of this SmsDto. # noqa: E501

:return: The from_number of this SmsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The from_number of this SmsDto.  # noqa: E501
    :rtype: str
    """
    return self._from_number

prop id

Gets the id of this SmsDto. # noqa: E501

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

Expand source code

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


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

prop phone_number

Gets the phone_number of this SmsDto. # noqa: E501

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

Expand source code

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


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

prop read

Gets the read of this SmsDto. # noqa: E501

:return: The read of this SmsDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The read of this SmsDto.  # noqa: E501
    :rtype: bool
    """
    return self._read

prop to_number

Gets the to_number of this SmsDto. # noqa: E501

:return: The to_number of this SmsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The to_number of this SmsDto.  # noqa: E501
    :rtype: str
    """
    return self._to_number

prop updated_at

Gets the updated_at of this SmsDto. # noqa: E501

:return: The updated_at of this SmsDto. # noqa: E501 :rtype: datetime

Expand source code

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


    :return: The updated_at of this SmsDto.  # noqa: E501
    :rtype: datetime
    """
    return self._updated_at

prop user_id

Gets the user_id of this SmsDto. # noqa: E501

:return: The user_id of this SmsDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The user_id of this SmsDto.  # noqa: E501
    :rtype: str
    """
    return self._user_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model