Module mailslurp_client.models.create_inbox_placement_test_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 CreateInboxPlacementTestOptions (seedlist_profile=None, requested_segment=None, sender_domain=None, from_email=None, public_share_requested=None, address_format=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.

CreateInboxPlacementTestOptions - a model defined in OpenAPI

Expand source code

class CreateInboxPlacementTestOptions(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 = {
        'seedlist_profile': 'str',
        'requested_segment': 'str',
        'sender_domain': 'str',
        'from_email': 'str',
        'public_share_requested': 'bool',
        'address_format': 'str'
    }

    attribute_map = {
        'seedlist_profile': 'seedlistProfile',
        'requested_segment': 'requestedSegment',
        'sender_domain': 'senderDomain',
        'from_email': 'fromEmail',
        'public_share_requested': 'publicShareRequested',
        'address_format': 'addressFormat'
    }

    def __init__(self, seedlist_profile=None, requested_segment=None, sender_domain=None, from_email=None, public_share_requested=None, address_format=None, local_vars_configuration=None):  # noqa: E501
        """CreateInboxPlacementTestOptions - 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._seedlist_profile = None
        self._requested_segment = None
        self._sender_domain = None
        self._from_email = None
        self._public_share_requested = None
        self._address_format = None
        self.discriminator = None

        self.seedlist_profile = seedlist_profile
        self.requested_segment = requested_segment
        self.sender_domain = sender_domain
        self.from_email = from_email
        self.public_share_requested = public_share_requested
        self.address_format = address_format

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


        :return: The seedlist_profile of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._seedlist_profile

    @seedlist_profile.setter
    def seedlist_profile(self, seedlist_profile):
        """Sets the seedlist_profile of this CreateInboxPlacementTestOptions.


        :param seedlist_profile: The seedlist_profile of this CreateInboxPlacementTestOptions.  # noqa: E501
        :type: str
        """

        self._seedlist_profile = seedlist_profile

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


        :return: The requested_segment of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._requested_segment

    @requested_segment.setter
    def requested_segment(self, requested_segment):
        """Sets the requested_segment of this CreateInboxPlacementTestOptions.


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

        self._requested_segment = requested_segment

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


        :return: The sender_domain of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._sender_domain

    @sender_domain.setter
    def sender_domain(self, sender_domain):
        """Sets the sender_domain of this CreateInboxPlacementTestOptions.


        :param sender_domain: The sender_domain of this CreateInboxPlacementTestOptions.  # noqa: E501
        :type: str
        """

        self._sender_domain = sender_domain

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


        :return: The from_email of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._from_email

    @from_email.setter
    def from_email(self, from_email):
        """Sets the from_email of this CreateInboxPlacementTestOptions.


        :param from_email: The from_email of this CreateInboxPlacementTestOptions.  # noqa: E501
        :type: str
        """

        self._from_email = from_email

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


        :return: The public_share_requested of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: bool
        """
        return self._public_share_requested

    @public_share_requested.setter
    def public_share_requested(self, public_share_requested):
        """Sets the public_share_requested of this CreateInboxPlacementTestOptions.


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

        self._public_share_requested = public_share_requested

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


        :return: The address_format of this CreateInboxPlacementTestOptions.  # noqa: E501
        :rtype: str
        """
        return self._address_format

    @address_format.setter
    def address_format(self, address_format):
        """Sets the address_format of this CreateInboxPlacementTestOptions.


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

        self._address_format = address_format

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop address_format

Gets the address_format of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The address_format of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The address_format of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._address_format

prop from_email

Gets the from_email of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The from_email of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The from_email of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._from_email

prop public_share_requested

Gets the public_share_requested of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The public_share_requested of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The public_share_requested of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: bool
    """
    return self._public_share_requested

prop requested_segment

Gets the requested_segment of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The requested_segment of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The requested_segment of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._requested_segment

prop seedlist_profile

Gets the seedlist_profile of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The seedlist_profile of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The seedlist_profile of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._seedlist_profile

prop sender_domain

Gets the sender_domain of this CreateInboxPlacementTestOptions. # noqa: E501

:return: The sender_domain of this CreateInboxPlacementTestOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sender_domain of this CreateInboxPlacementTestOptions.  # noqa: E501
    :rtype: str
    """
    return self._sender_domain

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model