Module mailslurp_client.models.update_email_warmup_program_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 UpdateEmailWarmupProgramOptions (expected_version=None, name=None, goal_daily_volume=None, schedule_preset=None, ramp_duration_days=None, maintenance_enabled=None, maintenance_daily_volume=None, send_window_start=None, send_window_end=None, time_zone=None, content=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.

UpdateEmailWarmupProgramOptions - a model defined in OpenAPI

Expand source code

class UpdateEmailWarmupProgramOptions(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 = {
        'expected_version': 'int',
        'name': 'str',
        'goal_daily_volume': 'int',
        'schedule_preset': 'str',
        'ramp_duration_days': 'int',
        'maintenance_enabled': 'bool',
        'maintenance_daily_volume': 'int',
        'send_window_start': 'str',
        'send_window_end': 'str',
        'time_zone': 'str',
        'content': 'EmailWarmupContentOptions'
    }

    attribute_map = {
        'expected_version': 'expectedVersion',
        'name': 'name',
        'goal_daily_volume': 'goalDailyVolume',
        'schedule_preset': 'schedulePreset',
        'ramp_duration_days': 'rampDurationDays',
        'maintenance_enabled': 'maintenanceEnabled',
        'maintenance_daily_volume': 'maintenanceDailyVolume',
        'send_window_start': 'sendWindowStart',
        'send_window_end': 'sendWindowEnd',
        'time_zone': 'timeZone',
        'content': 'content'
    }

    def __init__(self, expected_version=None, name=None, goal_daily_volume=None, schedule_preset=None, ramp_duration_days=None, maintenance_enabled=None, maintenance_daily_volume=None, send_window_start=None, send_window_end=None, time_zone=None, content=None, local_vars_configuration=None):  # noqa: E501
        """UpdateEmailWarmupProgramOptions - 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._expected_version = None
        self._name = None
        self._goal_daily_volume = None
        self._schedule_preset = None
        self._ramp_duration_days = None
        self._maintenance_enabled = None
        self._maintenance_daily_volume = None
        self._send_window_start = None
        self._send_window_end = None
        self._time_zone = None
        self._content = None
        self.discriminator = None

        self.expected_version = expected_version
        self.name = name
        self.goal_daily_volume = goal_daily_volume
        self.schedule_preset = schedule_preset
        self.ramp_duration_days = ramp_duration_days
        self.maintenance_enabled = maintenance_enabled
        self.maintenance_daily_volume = maintenance_daily_volume
        self.send_window_start = send_window_start
        self.send_window_end = send_window_end
        self.time_zone = time_zone
        self.content = content

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


        :return: The expected_version of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: int
        """
        return self._expected_version

    @expected_version.setter
    def expected_version(self, expected_version):
        """Sets the expected_version of this UpdateEmailWarmupProgramOptions.


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

        self._expected_version = expected_version

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


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

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


        :param name: The name of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :type: str
        """
        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) < 1):
            raise ValueError("Invalid value for `name`, length must be greater than or equal to `1`")  # noqa: E501

        self._name = name

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


        :return: The goal_daily_volume of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: int
        """
        return self._goal_daily_volume

    @goal_daily_volume.setter
    def goal_daily_volume(self, goal_daily_volume):
        """Sets the goal_daily_volume of this UpdateEmailWarmupProgramOptions.


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

        self._goal_daily_volume = goal_daily_volume

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


        :return: The schedule_preset of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: str
        """
        return self._schedule_preset

    @schedule_preset.setter
    def schedule_preset(self, schedule_preset):
        """Sets the schedule_preset of this UpdateEmailWarmupProgramOptions.


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

        self._schedule_preset = schedule_preset

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


        :return: The ramp_duration_days of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: int
        """
        return self._ramp_duration_days

    @ramp_duration_days.setter
    def ramp_duration_days(self, ramp_duration_days):
        """Sets the ramp_duration_days of this UpdateEmailWarmupProgramOptions.


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

        self._ramp_duration_days = ramp_duration_days

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


        :return: The maintenance_enabled of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: bool
        """
        return self._maintenance_enabled

    @maintenance_enabled.setter
    def maintenance_enabled(self, maintenance_enabled):
        """Sets the maintenance_enabled of this UpdateEmailWarmupProgramOptions.


        :param maintenance_enabled: The maintenance_enabled of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :type: bool
        """

        self._maintenance_enabled = maintenance_enabled

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


        :return: The maintenance_daily_volume of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: int
        """
        return self._maintenance_daily_volume

    @maintenance_daily_volume.setter
    def maintenance_daily_volume(self, maintenance_daily_volume):
        """Sets the maintenance_daily_volume of this UpdateEmailWarmupProgramOptions.


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

        self._maintenance_daily_volume = maintenance_daily_volume

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


        :return: The send_window_start of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: str
        """
        return self._send_window_start

    @send_window_start.setter
    def send_window_start(self, send_window_start):
        """Sets the send_window_start of this UpdateEmailWarmupProgramOptions.


        :param send_window_start: The send_window_start of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :type: str
        """

        self._send_window_start = send_window_start

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


        :return: The send_window_end of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: str
        """
        return self._send_window_end

    @send_window_end.setter
    def send_window_end(self, send_window_end):
        """Sets the send_window_end of this UpdateEmailWarmupProgramOptions.


        :param send_window_end: The send_window_end of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :type: str
        """

        self._send_window_end = send_window_end

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


        :return: The time_zone of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: str
        """
        return self._time_zone

    @time_zone.setter
    def time_zone(self, time_zone):
        """Sets the time_zone of this UpdateEmailWarmupProgramOptions.


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

        self._time_zone = time_zone

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


        :return: The content of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :rtype: EmailWarmupContentOptions
        """
        return self._content

    @content.setter
    def content(self, content):
        """Sets the content of this UpdateEmailWarmupProgramOptions.


        :param content: The content of this UpdateEmailWarmupProgramOptions.  # noqa: E501
        :type: EmailWarmupContentOptions
        """

        self._content = content

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop content

Gets the content of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The content of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: EmailWarmupContentOptions

Expand source code

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


    :return: The content of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: EmailWarmupContentOptions
    """
    return self._content

prop expected_version

Gets the expected_version of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The expected_version of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The expected_version of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: int
    """
    return self._expected_version

prop goal_daily_volume

Gets the goal_daily_volume of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The goal_daily_volume of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The goal_daily_volume of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: int
    """
    return self._goal_daily_volume

prop maintenance_daily_volume

Gets the maintenance_daily_volume of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The maintenance_daily_volume of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The maintenance_daily_volume of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: int
    """
    return self._maintenance_daily_volume

prop maintenance_enabled

Gets the maintenance_enabled of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The maintenance_enabled of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The maintenance_enabled of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: bool
    """
    return self._maintenance_enabled

prop name

Gets the name of this UpdateEmailWarmupProgramOptions. # noqa: E501

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

Expand source code

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


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

prop ramp_duration_days

Gets the ramp_duration_days of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The ramp_duration_days of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: int

Expand source code

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


    :return: The ramp_duration_days of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: int
    """
    return self._ramp_duration_days

prop schedule_preset

Gets the schedule_preset of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The schedule_preset of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The schedule_preset of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: str
    """
    return self._schedule_preset

prop send_window_end

Gets the send_window_end of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The send_window_end of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The send_window_end of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: str
    """
    return self._send_window_end

prop send_window_start

Gets the send_window_start of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The send_window_start of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The send_window_start of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: str
    """
    return self._send_window_start

prop time_zone

Gets the time_zone of this UpdateEmailWarmupProgramOptions. # noqa: E501

:return: The time_zone of this UpdateEmailWarmupProgramOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The time_zone of this UpdateEmailWarmupProgramOptions.  # noqa: E501
    :rtype: str
    """
    return self._time_zone

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model