Module mailslurp_client.models.get_next_agent_work_item_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 GetNextAgentWorkItemOptions (worker_id=None, lease_seconds=None, cursor=None, inbox_id=None, has_attachments=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.

GetNextAgentWorkItemOptions - a model defined in OpenAPI

Expand source code

class GetNextAgentWorkItemOptions(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 = {
        'worker_id': 'str',
        'lease_seconds': 'int',
        'cursor': 'str',
        'inbox_id': 'str',
        'has_attachments': 'bool'
    }

    attribute_map = {
        'worker_id': 'workerId',
        'lease_seconds': 'leaseSeconds',
        'cursor': 'cursor',
        'inbox_id': 'inboxId',
        'has_attachments': 'hasAttachments'
    }

    def __init__(self, worker_id=None, lease_seconds=None, cursor=None, inbox_id=None, has_attachments=None, local_vars_configuration=None):  # noqa: E501
        """GetNextAgentWorkItemOptions - 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._worker_id = None
        self._lease_seconds = None
        self._cursor = None
        self._inbox_id = None
        self._has_attachments = None
        self.discriminator = None

        self.worker_id = worker_id
        self.lease_seconds = lease_seconds
        self.cursor = cursor
        self.inbox_id = inbox_id
        self.has_attachments = has_attachments

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


        :return: The worker_id of this GetNextAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._worker_id

    @worker_id.setter
    def worker_id(self, worker_id):
        """Sets the worker_id of this GetNextAgentWorkItemOptions.


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

        self._worker_id = worker_id

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


        :return: The lease_seconds of this GetNextAgentWorkItemOptions.  # noqa: E501
        :rtype: int
        """
        return self._lease_seconds

    @lease_seconds.setter
    def lease_seconds(self, lease_seconds):
        """Sets the lease_seconds of this GetNextAgentWorkItemOptions.


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

        self._lease_seconds = lease_seconds

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


        :return: The cursor of this GetNextAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._cursor

    @cursor.setter
    def cursor(self, cursor):
        """Sets the cursor of this GetNextAgentWorkItemOptions.


        :param cursor: The cursor of this GetNextAgentWorkItemOptions.  # noqa: E501
        :type: str
        """

        self._cursor = cursor

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


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

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


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

        self._inbox_id = inbox_id

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


        :return: The has_attachments of this GetNextAgentWorkItemOptions.  # noqa: E501
        :rtype: bool
        """
        return self._has_attachments

    @has_attachments.setter
    def has_attachments(self, has_attachments):
        """Sets the has_attachments of this GetNextAgentWorkItemOptions.


        :param has_attachments: The has_attachments of this GetNextAgentWorkItemOptions.  # noqa: E501
        :type: bool
        """

        self._has_attachments = has_attachments

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop cursor

Gets the cursor of this GetNextAgentWorkItemOptions. # noqa: E501

:return: The cursor of this GetNextAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The cursor of this GetNextAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._cursor

prop has_attachments

Gets the has_attachments of this GetNextAgentWorkItemOptions. # noqa: E501

:return: The has_attachments of this GetNextAgentWorkItemOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The has_attachments of this GetNextAgentWorkItemOptions.  # noqa: E501
    :rtype: bool
    """
    return self._has_attachments

prop inbox_id

Gets the inbox_id of this GetNextAgentWorkItemOptions. # noqa: E501

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

Expand source code

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


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

prop lease_seconds

Gets the lease_seconds of this GetNextAgentWorkItemOptions. # noqa: E501

:return: The lease_seconds of this GetNextAgentWorkItemOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The lease_seconds of this GetNextAgentWorkItemOptions.  # noqa: E501
    :rtype: int
    """
    return self._lease_seconds

prop worker_id

Gets the worker_id of this GetNextAgentWorkItemOptions. # noqa: E501

:return: The worker_id of this GetNextAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The worker_id of this GetNextAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._worker_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model