Module mailslurp_client.models.deliverability_simulation_job_config_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 DeliverabilitySimulationJobConfigDto (sender_inbox_id=None, sender_phone_id=None, email_subject=None, email_from_override=None, email_body_template=None, sms_body_template=None, delay_ms=None, batch_size=None, sends_per_target=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.

DeliverabilitySimulationJobConfigDto - a model defined in OpenAPI

Expand source code

class DeliverabilitySimulationJobConfigDto(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 = {
        'sender_inbox_id': 'str',
        'sender_phone_id': 'str',
        'email_subject': 'str',
        'email_from_override': 'str',
        'email_body_template': 'str',
        'sms_body_template': 'str',
        'delay_ms': 'int',
        'batch_size': 'int',
        'sends_per_target': 'int'
    }

    attribute_map = {
        'sender_inbox_id': 'senderInboxId',
        'sender_phone_id': 'senderPhoneId',
        'email_subject': 'emailSubject',
        'email_from_override': 'emailFromOverride',
        'email_body_template': 'emailBodyTemplate',
        'sms_body_template': 'smsBodyTemplate',
        'delay_ms': 'delayMs',
        'batch_size': 'batchSize',
        'sends_per_target': 'sendsPerTarget'
    }

    def __init__(self, sender_inbox_id=None, sender_phone_id=None, email_subject=None, email_from_override=None, email_body_template=None, sms_body_template=None, delay_ms=None, batch_size=None, sends_per_target=None, local_vars_configuration=None):  # noqa: E501
        """DeliverabilitySimulationJobConfigDto - 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._sender_inbox_id = None
        self._sender_phone_id = None
        self._email_subject = None
        self._email_from_override = None
        self._email_body_template = None
        self._sms_body_template = None
        self._delay_ms = None
        self._batch_size = None
        self._sends_per_target = None
        self.discriminator = None

        self.sender_inbox_id = sender_inbox_id
        self.sender_phone_id = sender_phone_id
        self.email_subject = email_subject
        self.email_from_override = email_from_override
        self.email_body_template = email_body_template
        self.sms_body_template = sms_body_template
        self.delay_ms = delay_ms
        self.batch_size = batch_size
        self.sends_per_target = sends_per_target

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


        :return: The sender_inbox_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._sender_inbox_id

    @sender_inbox_id.setter
    def sender_inbox_id(self, sender_inbox_id):
        """Sets the sender_inbox_id of this DeliverabilitySimulationJobConfigDto.


        :param sender_inbox_id: The sender_inbox_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._sender_inbox_id = sender_inbox_id

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


        :return: The sender_phone_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._sender_phone_id

    @sender_phone_id.setter
    def sender_phone_id(self, sender_phone_id):
        """Sets the sender_phone_id of this DeliverabilitySimulationJobConfigDto.


        :param sender_phone_id: The sender_phone_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._sender_phone_id = sender_phone_id

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


        :return: The email_subject of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._email_subject

    @email_subject.setter
    def email_subject(self, email_subject):
        """Sets the email_subject of this DeliverabilitySimulationJobConfigDto.


        :param email_subject: The email_subject of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._email_subject = email_subject

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


        :return: The email_from_override of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._email_from_override

    @email_from_override.setter
    def email_from_override(self, email_from_override):
        """Sets the email_from_override of this DeliverabilitySimulationJobConfigDto.


        :param email_from_override: The email_from_override of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._email_from_override = email_from_override

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


        :return: The email_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._email_body_template

    @email_body_template.setter
    def email_body_template(self, email_body_template):
        """Sets the email_body_template of this DeliverabilitySimulationJobConfigDto.


        :param email_body_template: The email_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._email_body_template = email_body_template

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


        :return: The sms_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: str
        """
        return self._sms_body_template

    @sms_body_template.setter
    def sms_body_template(self, sms_body_template):
        """Sets the sms_body_template of this DeliverabilitySimulationJobConfigDto.


        :param sms_body_template: The sms_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :type: str
        """

        self._sms_body_template = sms_body_template

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


        :return: The delay_ms of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: int
        """
        return self._delay_ms

    @delay_ms.setter
    def delay_ms(self, delay_ms):
        """Sets the delay_ms of this DeliverabilitySimulationJobConfigDto.


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

        self._delay_ms = delay_ms

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


        :return: The batch_size of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: int
        """
        return self._batch_size

    @batch_size.setter
    def batch_size(self, batch_size):
        """Sets the batch_size of this DeliverabilitySimulationJobConfigDto.


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

        self._batch_size = batch_size

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


        :return: The sends_per_target of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
        :rtype: int
        """
        return self._sends_per_target

    @sends_per_target.setter
    def sends_per_target(self, sends_per_target):
        """Sets the sends_per_target of this DeliverabilitySimulationJobConfigDto.


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

        self._sends_per_target = sends_per_target

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop batch_size

Gets the batch_size of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The batch_size of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The batch_size of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: int
    """
    return self._batch_size

prop delay_ms

Gets the delay_ms of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The delay_ms of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The delay_ms of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: int
    """
    return self._delay_ms

prop email_body_template

Gets the email_body_template of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The email_body_template of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The email_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._email_body_template

prop email_from_override

Gets the email_from_override of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The email_from_override of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The email_from_override of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._email_from_override

prop email_subject

Gets the email_subject of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The email_subject of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The email_subject of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._email_subject

prop sender_inbox_id

Gets the sender_inbox_id of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The sender_inbox_id of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sender_inbox_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._sender_inbox_id

prop sender_phone_id

Gets the sender_phone_id of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The sender_phone_id of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sender_phone_id of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._sender_phone_id

prop sends_per_target

Gets the sends_per_target of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The sends_per_target of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The sends_per_target of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: int
    """
    return self._sends_per_target

prop sms_body_template

Gets the sms_body_template of this DeliverabilitySimulationJobConfigDto. # noqa: E501

:return: The sms_body_template of this DeliverabilitySimulationJobConfigDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sms_body_template of this DeliverabilitySimulationJobConfigDto.  # noqa: E501
    :rtype: str
    """
    return self._sms_body_template

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model