Module mailslurp_client.models.create_inbox_retention_policy_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 CreateInboxRetentionPolicyOptions (name=None, scope=None, retention_days=None, inbox_id=None, domain_id=None, enabled=None, excluded_inbox_ids=None, excluded_domain_ids=None, excluded_inbox_email_address_patterns=None, excluded_domain_name_patterns=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.

CreateInboxRetentionPolicyOptions - a model defined in OpenAPI

Expand source code

class CreateInboxRetentionPolicyOptions(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 = {
        'name': 'str',
        'scope': 'str',
        'retention_days': 'int',
        'inbox_id': 'str',
        'domain_id': 'str',
        'enabled': 'bool',
        'excluded_inbox_ids': 'list[str]',
        'excluded_domain_ids': 'list[str]',
        'excluded_inbox_email_address_patterns': 'list[str]',
        'excluded_domain_name_patterns': 'list[str]'
    }

    attribute_map = {
        'name': 'name',
        'scope': 'scope',
        'retention_days': 'retentionDays',
        'inbox_id': 'inboxId',
        'domain_id': 'domainId',
        'enabled': 'enabled',
        'excluded_inbox_ids': 'excludedInboxIds',
        'excluded_domain_ids': 'excludedDomainIds',
        'excluded_inbox_email_address_patterns': 'excludedInboxEmailAddressPatterns',
        'excluded_domain_name_patterns': 'excludedDomainNamePatterns'
    }

    def __init__(self, name=None, scope=None, retention_days=None, inbox_id=None, domain_id=None, enabled=None, excluded_inbox_ids=None, excluded_domain_ids=None, excluded_inbox_email_address_patterns=None, excluded_domain_name_patterns=None, local_vars_configuration=None):  # noqa: E501
        """CreateInboxRetentionPolicyOptions - 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._name = None
        self._scope = None
        self._retention_days = None
        self._inbox_id = None
        self._domain_id = None
        self._enabled = None
        self._excluded_inbox_ids = None
        self._excluded_domain_ids = None
        self._excluded_inbox_email_address_patterns = None
        self._excluded_domain_name_patterns = None
        self.discriminator = None

        self.name = name
        self.scope = scope
        self.retention_days = retention_days
        self.inbox_id = inbox_id
        self.domain_id = domain_id
        self.enabled = enabled
        self.excluded_inbox_ids = excluded_inbox_ids
        self.excluded_domain_ids = excluded_domain_ids
        self.excluded_inbox_email_address_patterns = excluded_inbox_email_address_patterns
        self.excluded_domain_name_patterns = excluded_domain_name_patterns

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


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

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


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

        self._name = name

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


        :return: The scope of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: str
        """
        return self._scope

    @scope.setter
    def scope(self, scope):
        """Sets the scope of this CreateInboxRetentionPolicyOptions.


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

        self._scope = scope

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


        :return: The retention_days of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: int
        """
        return self._retention_days

    @retention_days.setter
    def retention_days(self, retention_days):
        """Sets the retention_days of this CreateInboxRetentionPolicyOptions.


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

        self._retention_days = retention_days

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


        :return: The inbox_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: str
        """
        return self._inbox_id

    @inbox_id.setter
    def inbox_id(self, inbox_id):
        """Sets the inbox_id of this CreateInboxRetentionPolicyOptions.


        :param inbox_id: The inbox_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :type: str
        """

        self._inbox_id = inbox_id

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


        :return: The domain_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: str
        """
        return self._domain_id

    @domain_id.setter
    def domain_id(self, domain_id):
        """Sets the domain_id of this CreateInboxRetentionPolicyOptions.


        :param domain_id: The domain_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :type: str
        """

        self._domain_id = domain_id

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


        :return: The enabled of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: bool
        """
        return self._enabled

    @enabled.setter
    def enabled(self, enabled):
        """Sets the enabled of this CreateInboxRetentionPolicyOptions.


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

        self._enabled = enabled

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


        :return: The excluded_inbox_ids of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._excluded_inbox_ids

    @excluded_inbox_ids.setter
    def excluded_inbox_ids(self, excluded_inbox_ids):
        """Sets the excluded_inbox_ids of this CreateInboxRetentionPolicyOptions.


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

        self._excluded_inbox_ids = excluded_inbox_ids

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


        :return: The excluded_domain_ids of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._excluded_domain_ids

    @excluded_domain_ids.setter
    def excluded_domain_ids(self, excluded_domain_ids):
        """Sets the excluded_domain_ids of this CreateInboxRetentionPolicyOptions.


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

        self._excluded_domain_ids = excluded_domain_ids

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


        :return: The excluded_inbox_email_address_patterns of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._excluded_inbox_email_address_patterns

    @excluded_inbox_email_address_patterns.setter
    def excluded_inbox_email_address_patterns(self, excluded_inbox_email_address_patterns):
        """Sets the excluded_inbox_email_address_patterns of this CreateInboxRetentionPolicyOptions.


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

        self._excluded_inbox_email_address_patterns = excluded_inbox_email_address_patterns

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


        :return: The excluded_domain_name_patterns of this CreateInboxRetentionPolicyOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._excluded_domain_name_patterns

    @excluded_domain_name_patterns.setter
    def excluded_domain_name_patterns(self, excluded_domain_name_patterns):
        """Sets the excluded_domain_name_patterns of this CreateInboxRetentionPolicyOptions.


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

        self._excluded_domain_name_patterns = excluded_domain_name_patterns

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop domain_id

Gets the domain_id of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The domain_id of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The domain_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: str
    """
    return self._domain_id

prop enabled

Gets the enabled of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The enabled of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The enabled of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: bool
    """
    return self._enabled

prop excluded_domain_ids

Gets the excluded_domain_ids of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The excluded_domain_ids of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The excluded_domain_ids of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._excluded_domain_ids

prop excluded_domain_name_patterns

Gets the excluded_domain_name_patterns of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The excluded_domain_name_patterns of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The excluded_domain_name_patterns of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._excluded_domain_name_patterns

prop excluded_inbox_email_address_patterns

Gets the excluded_inbox_email_address_patterns of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The excluded_inbox_email_address_patterns of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The excluded_inbox_email_address_patterns of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._excluded_inbox_email_address_patterns

prop excluded_inbox_ids

Gets the excluded_inbox_ids of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The excluded_inbox_ids of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The excluded_inbox_ids of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._excluded_inbox_ids

prop inbox_id

Gets the inbox_id of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The inbox_id of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The inbox_id of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: str
    """
    return self._inbox_id

prop name

Gets the name of this CreateInboxRetentionPolicyOptions. # noqa: E501

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

Expand source code

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


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

prop retention_days

Gets the retention_days of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The retention_days of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The retention_days of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: int
    """
    return self._retention_days

prop scope

Gets the scope of this CreateInboxRetentionPolicyOptions. # noqa: E501

:return: The scope of this CreateInboxRetentionPolicyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The scope of this CreateInboxRetentionPolicyOptions.  # noqa: E501
    :rtype: str
    """
    return self._scope

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model