Module mailslurp_client.models.deliverability_failure_entity_hotspot_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 DeliverabilityFailureEntityHotspotDto (entity_id=None, entity_label=None, scope=None, phone_country=None, phone_variant=None, failed_run_count=None, total_run_count=None, failure_rate_percentage=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.

DeliverabilityFailureEntityHotspotDto - a model defined in OpenAPI

Expand source code

class DeliverabilityFailureEntityHotspotDto(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 = {
        'entity_id': 'str',
        'entity_label': 'str',
        'scope': 'str',
        'phone_country': 'str',
        'phone_variant': 'str',
        'failed_run_count': 'int',
        'total_run_count': 'int',
        'failure_rate_percentage': 'float'
    }

    attribute_map = {
        'entity_id': 'entityId',
        'entity_label': 'entityLabel',
        'scope': 'scope',
        'phone_country': 'phoneCountry',
        'phone_variant': 'phoneVariant',
        'failed_run_count': 'failedRunCount',
        'total_run_count': 'totalRunCount',
        'failure_rate_percentage': 'failureRatePercentage'
    }

    def __init__(self, entity_id=None, entity_label=None, scope=None, phone_country=None, phone_variant=None, failed_run_count=None, total_run_count=None, failure_rate_percentage=None, local_vars_configuration=None):  # noqa: E501
        """DeliverabilityFailureEntityHotspotDto - 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._entity_id = None
        self._entity_label = None
        self._scope = None
        self._phone_country = None
        self._phone_variant = None
        self._failed_run_count = None
        self._total_run_count = None
        self._failure_rate_percentage = None
        self.discriminator = None

        self.entity_id = entity_id
        self.entity_label = entity_label
        self.scope = scope
        self.phone_country = phone_country
        self.phone_variant = phone_variant
        self.failed_run_count = failed_run_count
        self.total_run_count = total_run_count
        self.failure_rate_percentage = failure_rate_percentage

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


        :return: The entity_id of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: str
        """
        return self._entity_id

    @entity_id.setter
    def entity_id(self, entity_id):
        """Sets the entity_id of this DeliverabilityFailureEntityHotspotDto.


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

        self._entity_id = entity_id

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


        :return: The entity_label of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: str
        """
        return self._entity_label

    @entity_label.setter
    def entity_label(self, entity_label):
        """Sets the entity_label of this DeliverabilityFailureEntityHotspotDto.


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

        self._entity_label = entity_label

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


        :return: The scope of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: str
        """
        return self._scope

    @scope.setter
    def scope(self, scope):
        """Sets the scope of this DeliverabilityFailureEntityHotspotDto.


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

        self._scope = scope

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


        :return: The phone_country of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: str
        """
        return self._phone_country

    @phone_country.setter
    def phone_country(self, phone_country):
        """Sets the phone_country of this DeliverabilityFailureEntityHotspotDto.


        :param phone_country: The phone_country of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"US", "GB", "AU", "CA", "EE", "HK", "PL", "CH", "PT", "NL", "IL", "FI", "SE"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and phone_country not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `phone_country` ({0}), must be one of {1}"  # noqa: E501
                .format(phone_country, allowed_values)
            )

        self._phone_country = phone_country

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


        :return: The phone_variant of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: str
        """
        return self._phone_variant

    @phone_variant.setter
    def phone_variant(self, phone_variant):
        """Sets the phone_variant of this DeliverabilityFailureEntityHotspotDto.


        :param phone_variant: The phone_variant of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :type: str
        """
        allowed_values = [None,"LOCAL", "MOBILE", "TOLL_FREE"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and phone_variant not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `phone_variant` ({0}), must be one of {1}"  # noqa: E501
                .format(phone_variant, allowed_values)
            )

        self._phone_variant = phone_variant

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


        :return: The failed_run_count of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: int
        """
        return self._failed_run_count

    @failed_run_count.setter
    def failed_run_count(self, failed_run_count):
        """Sets the failed_run_count of this DeliverabilityFailureEntityHotspotDto.


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

        self._failed_run_count = failed_run_count

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


        :return: The total_run_count of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: int
        """
        return self._total_run_count

    @total_run_count.setter
    def total_run_count(self, total_run_count):
        """Sets the total_run_count of this DeliverabilityFailureEntityHotspotDto.


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

        self._total_run_count = total_run_count

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


        :return: The failure_rate_percentage of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
        :rtype: float
        """
        return self._failure_rate_percentage

    @failure_rate_percentage.setter
    def failure_rate_percentage(self, failure_rate_percentage):
        """Sets the failure_rate_percentage of this DeliverabilityFailureEntityHotspotDto.


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

        self._failure_rate_percentage = failure_rate_percentage

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop entity_id

Gets the entity_id of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The entity_id of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The entity_id of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: str
    """
    return self._entity_id

prop entity_label

Gets the entity_label of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The entity_label of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The entity_label of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: str
    """
    return self._entity_label

prop failed_run_count

Gets the failed_run_count of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The failed_run_count of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The failed_run_count of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: int
    """
    return self._failed_run_count

prop failure_rate_percentage

Gets the failure_rate_percentage of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The failure_rate_percentage of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: float

Expand source code

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


    :return: The failure_rate_percentage of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: float
    """
    return self._failure_rate_percentage

prop phone_country

Gets the phone_country of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The phone_country of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_country of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: str
    """
    return self._phone_country

prop phone_variant

Gets the phone_variant of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The phone_variant of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_variant of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: str
    """
    return self._phone_variant

prop scope

Gets the scope of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The scope of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The scope of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: str
    """
    return self._scope

prop total_run_count

Gets the total_run_count of this DeliverabilityFailureEntityHotspotDto. # noqa: E501

:return: The total_run_count of this DeliverabilityFailureEntityHotspotDto. # noqa: E501 :rtype: int

Expand source code

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


    :return: The total_run_count of this DeliverabilityFailureEntityHotspotDto.  # noqa: E501
    :rtype: int
    """
    return self._total_run_count

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model