Module mailslurp_client.models.create_automated_inbox_placement_schedule_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 CreateAutomatedInboxPlacementScheduleOptions (connection_id=None, name=None, interval_minutes=None, enabled=None, requested_segment=None, seedlist_profile=None, subject_template=None, text_body_template=None, html_body_template=None, source_run_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.

CreateAutomatedInboxPlacementScheduleOptions - a model defined in OpenAPI

Expand source code

class CreateAutomatedInboxPlacementScheduleOptions(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 = {
        'connection_id': 'str',
        'name': 'str',
        'interval_minutes': 'int',
        'enabled': 'bool',
        'requested_segment': 'str',
        'seedlist_profile': 'str',
        'subject_template': 'str',
        'text_body_template': 'str',
        'html_body_template': 'str',
        'source_run_id': 'str'
    }

    attribute_map = {
        'connection_id': 'connectionId',
        'name': 'name',
        'interval_minutes': 'intervalMinutes',
        'enabled': 'enabled',
        'requested_segment': 'requestedSegment',
        'seedlist_profile': 'seedlistProfile',
        'subject_template': 'subjectTemplate',
        'text_body_template': 'textBodyTemplate',
        'html_body_template': 'htmlBodyTemplate',
        'source_run_id': 'sourceRunId'
    }

    def __init__(self, connection_id=None, name=None, interval_minutes=None, enabled=None, requested_segment=None, seedlist_profile=None, subject_template=None, text_body_template=None, html_body_template=None, source_run_id=None, local_vars_configuration=None):  # noqa: E501
        """CreateAutomatedInboxPlacementScheduleOptions - 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._connection_id = None
        self._name = None
        self._interval_minutes = None
        self._enabled = None
        self._requested_segment = None
        self._seedlist_profile = None
        self._subject_template = None
        self._text_body_template = None
        self._html_body_template = None
        self._source_run_id = None
        self.discriminator = None

        self.connection_id = connection_id
        self.name = name
        self.interval_minutes = interval_minutes
        self.enabled = enabled
        self.requested_segment = requested_segment
        self.seedlist_profile = seedlist_profile
        self.subject_template = subject_template
        self.text_body_template = text_body_template
        self.html_body_template = html_body_template
        self.source_run_id = source_run_id

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


        :return: The connection_id of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._connection_id

    @connection_id.setter
    def connection_id(self, connection_id):
        """Sets the connection_id of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._connection_id = connection_id

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


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

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


        :param name: The name of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and name is None:  # noqa: E501
            raise ValueError("Invalid value for `name`, must not be `None`")  # noqa: E501
        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 interval_minutes(self):
        """Gets the interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501


        :return: The interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: int
        """
        return self._interval_minutes

    @interval_minutes.setter
    def interval_minutes(self, interval_minutes):
        """Sets the interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._interval_minutes = interval_minutes

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


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

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


        :param enabled: The enabled of this CreateAutomatedInboxPlacementScheduleOptions.  # 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 requested_segment(self):
        """Gets the requested_segment of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501


        :return: The requested_segment of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._requested_segment

    @requested_segment.setter
    def requested_segment(self, requested_segment):
        """Sets the requested_segment of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._requested_segment = requested_segment

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


        :return: The seedlist_profile of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._seedlist_profile

    @seedlist_profile.setter
    def seedlist_profile(self, seedlist_profile):
        """Sets the seedlist_profile of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._seedlist_profile = seedlist_profile

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


        :return: The subject_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._subject_template

    @subject_template.setter
    def subject_template(self, subject_template):
        """Sets the subject_template of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._subject_template = subject_template

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


        :return: The text_body_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._text_body_template

    @text_body_template.setter
    def text_body_template(self, text_body_template):
        """Sets the text_body_template of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._text_body_template = text_body_template

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


        :return: The html_body_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._html_body_template

    @html_body_template.setter
    def html_body_template(self, html_body_template):
        """Sets the html_body_template of this CreateAutomatedInboxPlacementScheduleOptions.


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

        self._html_body_template = html_body_template

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


        :return: The source_run_id of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :rtype: str
        """
        return self._source_run_id

    @source_run_id.setter
    def source_run_id(self, source_run_id):
        """Sets the source_run_id of this CreateAutomatedInboxPlacementScheduleOptions.


        :param source_run_id: The source_run_id of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
        :type: str
        """

        self._source_run_id = source_run_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, CreateAutomatedInboxPlacementScheduleOptions):
            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, CreateAutomatedInboxPlacementScheduleOptions):
            return True

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop connection_id

Gets the connection_id of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The connection_id of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The connection_id of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._connection_id

prop enabled

Gets the enabled of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

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

Expand source code

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


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

prop html_body_template

Gets the html_body_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The html_body_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The html_body_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._html_body_template

prop interval_minutes

Gets the interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The interval_minutes of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: int
    """
    return self._interval_minutes

prop name

Gets the name of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

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

Expand source code

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


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

prop requested_segment

Gets the requested_segment of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The requested_segment of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The requested_segment of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._requested_segment

prop seedlist_profile

Gets the seedlist_profile of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The seedlist_profile of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The seedlist_profile of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._seedlist_profile

prop source_run_id

Gets the source_run_id of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The source_run_id of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The source_run_id of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._source_run_id

prop subject_template

Gets the subject_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The subject_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The subject_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._subject_template

prop text_body_template

Gets the text_body_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501

:return: The text_body_template of this CreateAutomatedInboxPlacementScheduleOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The text_body_template of this CreateAutomatedInboxPlacementScheduleOptions.  # noqa: E501
    :rtype: str
    """
    return self._text_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