Module mailslurp_client.models.ruleset_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 RulesetDto (id=None, inbox_id=None, phone_id=None, scope=None, action=None, target=None, handler=None, active=None, created_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.

RulesetDto - a model defined in OpenAPI

Expand source code

class RulesetDto(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',
        'inbox_id': 'str',
        'phone_id': 'str',
        'scope': 'str',
        'action': 'str',
        'target': 'str',
        'handler': 'str',
        'active': 'bool',
        'created_at': 'datetime'
    }

    attribute_map = {
        'id': 'id',
        'inbox_id': 'inboxId',
        'phone_id': 'phoneId',
        'scope': 'scope',
        'action': 'action',
        'target': 'target',
        'handler': 'handler',
        'active': 'active',
        'created_at': 'createdAt'
    }

    def __init__(self, id=None, inbox_id=None, phone_id=None, scope=None, action=None, target=None, handler=None, active=None, created_at=None, local_vars_configuration=None):  # noqa: E501
        """RulesetDto - 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._inbox_id = None
        self._phone_id = None
        self._scope = None
        self._action = None
        self._target = None
        self._handler = None
        self._active = None
        self._created_at = None
        self.discriminator = None

        self.id = id
        self.inbox_id = inbox_id
        self.phone_id = phone_id
        self.scope = scope
        self.action = action
        self.target = target
        self.handler = handler
        self.active = active
        self.created_at = created_at

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


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

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


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


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

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


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

        self._inbox_id = inbox_id

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


        :return: The phone_id of this RulesetDto.  # noqa: E501
        :rtype: str
        """
        return self._phone_id

    @phone_id.setter
    def phone_id(self, phone_id):
        """Sets the phone_id of this RulesetDto.


        :param phone_id: The phone_id of this RulesetDto.  # noqa: E501
        :type: str
        """

        self._phone_id = phone_id

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


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

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


        :param scope: The scope of this RulesetDto.  # 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 = ["RECEIVING_EMAILS", "SENDING_EMAILS", "RECEIVING_SMS", "SENDING_SMS"]  # 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 action(self):
        """Gets the action of this RulesetDto.  # noqa: E501


        :return: The action of this RulesetDto.  # noqa: E501
        :rtype: str
        """
        return self._action

    @action.setter
    def action(self, action):
        """Sets the action of this RulesetDto.


        :param action: The action of this RulesetDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and action is None:  # noqa: E501
            raise ValueError("Invalid value for `action`, must not be `None`")  # noqa: E501
        allowed_values = ["BLOCK", "ALLOW", "FILTER_REMOVE", "BOUNCE_SOFT", "BOUNCE_HARD"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and action not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `action` ({0}), must be one of {1}"  # noqa: E501
                .format(action, allowed_values)
            )

        self._action = action

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


        :return: The target of this RulesetDto.  # noqa: E501
        :rtype: str
        """
        return self._target

    @target.setter
    def target(self, target):
        """Sets the target of this RulesetDto.


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

        self._target = target

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


        :return: The handler of this RulesetDto.  # noqa: E501
        :rtype: str
        """
        return self._handler

    @handler.setter
    def handler(self, handler):
        """Sets the handler of this RulesetDto.


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

        self._handler = handler

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

        Whether the ruleset is active  # noqa: E501

        :return: The active of this RulesetDto.  # noqa: E501
        :rtype: bool
        """
        return self._active

    @active.setter
    def active(self, active):
        """Sets the active of this RulesetDto.

        Whether the ruleset is active  # noqa: E501

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

        self._active = active

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


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

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


        :param created_at: The created_at of this RulesetDto.  # 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

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop action

Gets the action of this RulesetDto. # noqa: E501

:return: The action of this RulesetDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The action of this RulesetDto.  # noqa: E501
    :rtype: str
    """
    return self._action

prop active

Gets the active of this RulesetDto. # noqa: E501

Whether the ruleset is active # noqa: E501

:return: The active of this RulesetDto. # noqa: E501 :rtype: bool

Expand source code

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

    Whether the ruleset is active  # noqa: E501

    :return: The active of this RulesetDto.  # noqa: E501
    :rtype: bool
    """
    return self._active

prop created_at

Gets the created_at of this RulesetDto. # noqa: E501

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

Expand source code

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


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

prop handler

Gets the handler of this RulesetDto. # noqa: E501

:return: The handler of this RulesetDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The handler of this RulesetDto.  # noqa: E501
    :rtype: str
    """
    return self._handler

prop id

Gets the id of this RulesetDto. # noqa: E501

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

Expand source code

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


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

prop inbox_id

Gets the inbox_id of this RulesetDto. # noqa: E501

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

Expand source code

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


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

prop phone_id

Gets the phone_id of this RulesetDto. # noqa: E501

:return: The phone_id of this RulesetDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_id of this RulesetDto.  # noqa: E501
    :rtype: str
    """
    return self._phone_id

prop scope

Gets the scope of this RulesetDto. # noqa: E501

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

Expand source code

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


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

prop target

Gets the target of this RulesetDto. # noqa: E501

:return: The target of this RulesetDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The target of this RulesetDto.  # noqa: E501
    :rtype: str
    """
    return self._target

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model