Module mailslurp_client.models.complete_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 CompleteAgentWorkItemOptions (source_email_id=None, reply=None, idempotency_key=None, expected_conversation_version=None, expected_latest_email_id=None, claim_id=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.

CompleteAgentWorkItemOptions - a model defined in OpenAPI

Expand source code

class CompleteAgentWorkItemOptions(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 = {
        'source_email_id': 'str',
        'reply': 'ReplyToEmailOptions',
        'idempotency_key': 'str',
        'expected_conversation_version': 'int',
        'expected_latest_email_id': 'str',
        'claim_id': 'str'
    }

    attribute_map = {
        'source_email_id': 'sourceEmailId',
        'reply': 'reply',
        'idempotency_key': 'idempotencyKey',
        'expected_conversation_version': 'expectedConversationVersion',
        'expected_latest_email_id': 'expectedLatestEmailId',
        'claim_id': 'claimId'
    }

    def __init__(self, source_email_id=None, reply=None, idempotency_key=None, expected_conversation_version=None, expected_latest_email_id=None, claim_id=None, local_vars_configuration=None):  # noqa: E501
        """CompleteAgentWorkItemOptions - 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._source_email_id = None
        self._reply = None
        self._idempotency_key = None
        self._expected_conversation_version = None
        self._expected_latest_email_id = None
        self._claim_id = None
        self.discriminator = None

        self.source_email_id = source_email_id
        self.reply = reply
        self.idempotency_key = idempotency_key
        self.expected_conversation_version = expected_conversation_version
        self.expected_latest_email_id = expected_latest_email_id
        self.claim_id = claim_id

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


        :return: The source_email_id of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._source_email_id

    @source_email_id.setter
    def source_email_id(self, source_email_id):
        """Sets the source_email_id of this CompleteAgentWorkItemOptions.


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

        self._source_email_id = source_email_id

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


        :return: The reply of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: ReplyToEmailOptions
        """
        return self._reply

    @reply.setter
    def reply(self, reply):
        """Sets the reply of this CompleteAgentWorkItemOptions.


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

        self._reply = reply

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


        :return: The idempotency_key of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._idempotency_key

    @idempotency_key.setter
    def idempotency_key(self, idempotency_key):
        """Sets the idempotency_key of this CompleteAgentWorkItemOptions.


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

        self._idempotency_key = idempotency_key

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


        :return: The expected_conversation_version of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: int
        """
        return self._expected_conversation_version

    @expected_conversation_version.setter
    def expected_conversation_version(self, expected_conversation_version):
        """Sets the expected_conversation_version of this CompleteAgentWorkItemOptions.


        :param expected_conversation_version: The expected_conversation_version of this CompleteAgentWorkItemOptions.  # noqa: E501
        :type: int
        """

        self._expected_conversation_version = expected_conversation_version

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


        :return: The expected_latest_email_id of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._expected_latest_email_id

    @expected_latest_email_id.setter
    def expected_latest_email_id(self, expected_latest_email_id):
        """Sets the expected_latest_email_id of this CompleteAgentWorkItemOptions.


        :param expected_latest_email_id: The expected_latest_email_id of this CompleteAgentWorkItemOptions.  # noqa: E501
        :type: str
        """

        self._expected_latest_email_id = expected_latest_email_id

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


        :return: The claim_id of this CompleteAgentWorkItemOptions.  # noqa: E501
        :rtype: str
        """
        return self._claim_id

    @claim_id.setter
    def claim_id(self, claim_id):
        """Sets the claim_id of this CompleteAgentWorkItemOptions.


        :param claim_id: The claim_id of this CompleteAgentWorkItemOptions.  # noqa: E501
        :type: str
        """

        self._claim_id = claim_id

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop claim_id

Gets the claim_id of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The claim_id of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The claim_id of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._claim_id

prop expected_conversation_version

Gets the expected_conversation_version of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The expected_conversation_version of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The expected_conversation_version of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: int
    """
    return self._expected_conversation_version

prop expected_latest_email_id

Gets the expected_latest_email_id of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The expected_latest_email_id of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The expected_latest_email_id of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._expected_latest_email_id

prop idempotency_key

Gets the idempotency_key of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The idempotency_key of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The idempotency_key of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._idempotency_key

prop reply

Gets the reply of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The reply of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: ReplyToEmailOptions

Expand source code

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


    :return: The reply of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: ReplyToEmailOptions
    """
    return self._reply

prop source_email_id

Gets the source_email_id of this CompleteAgentWorkItemOptions. # noqa: E501

:return: The source_email_id of this CompleteAgentWorkItemOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The source_email_id of this CompleteAgentWorkItemOptions.  # noqa: E501
    :rtype: str
    """
    return self._source_email_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model