Module mailslurp_client.models.phone_number_projection

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 PhoneNumberProjection (name=None, id=None, tags=None, user_id=None, phone_country=None, phone_number=None, created_at=None, provider_label=None, line_type=None, carrier_name=None, mobile_country_code=None, mobile_network_code=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.

PhoneNumberProjection - a model defined in OpenAPI

Expand source code
class PhoneNumberProjection(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 = {
        'name': 'str',
        'id': 'str',
        'tags': 'list[str]',
        'user_id': 'str',
        'phone_country': 'str',
        'phone_number': 'str',
        'created_at': 'datetime',
        'provider_label': 'str',
        'line_type': 'str',
        'carrier_name': 'str',
        'mobile_country_code': 'str',
        'mobile_network_code': 'str'
    }

    attribute_map = {
        'name': 'name',
        'id': 'id',
        'tags': 'tags',
        'user_id': 'userId',
        'phone_country': 'phoneCountry',
        'phone_number': 'phoneNumber',
        'created_at': 'createdAt',
        'provider_label': 'providerLabel',
        'line_type': 'lineType',
        'carrier_name': 'carrierName',
        'mobile_country_code': 'mobileCountryCode',
        'mobile_network_code': 'mobileNetworkCode'
    }

    def __init__(self, name=None, id=None, tags=None, user_id=None, phone_country=None, phone_number=None, created_at=None, provider_label=None, line_type=None, carrier_name=None, mobile_country_code=None, mobile_network_code=None, local_vars_configuration=None):  # noqa: E501
        """PhoneNumberProjection - 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._name = None
        self._id = None
        self._tags = None
        self._user_id = None
        self._phone_country = None
        self._phone_number = None
        self._created_at = None
        self._provider_label = None
        self._line_type = None
        self._carrier_name = None
        self._mobile_country_code = None
        self._mobile_network_code = None
        self.discriminator = None

        self.name = name
        self.id = id
        self.tags = tags
        self.user_id = user_id
        self.phone_country = phone_country
        self.phone_number = phone_number
        self.created_at = created_at
        self.provider_label = provider_label
        self.line_type = line_type
        self.carrier_name = carrier_name
        self.mobile_country_code = mobile_country_code
        self.mobile_network_code = mobile_network_code

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


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

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


        :param name: The name of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._name = name

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


        :return: The id of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """Sets the id of this PhoneNumberProjection.


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

        self._id = id

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


        :return: The tags of this PhoneNumberProjection.  # noqa: E501
        :rtype: list[str]
        """
        return self._tags

    @tags.setter
    def tags(self, tags):
        """Sets the tags of this PhoneNumberProjection.


        :param tags: The tags of this PhoneNumberProjection.  # noqa: E501
        :type: list[str]
        """

        self._tags = tags

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


        :return: The user_id of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._user_id

    @user_id.setter
    def user_id(self, user_id):
        """Sets the user_id of this PhoneNumberProjection.


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

        self._user_id = user_id

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


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

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


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


        :return: The phone_number of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._phone_number

    @phone_number.setter
    def phone_number(self, phone_number):
        """Sets the phone_number of this PhoneNumberProjection.


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

        self._phone_number = phone_number

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


        :return: The created_at of this PhoneNumberProjection.  # noqa: E501
        :rtype: datetime
        """
        return self._created_at

    @created_at.setter
    def created_at(self, created_at):
        """Sets the created_at of this PhoneNumberProjection.


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

        self._created_at = created_at

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


        :return: The provider_label of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._provider_label

    @provider_label.setter
    def provider_label(self, provider_label):
        """Sets the provider_label of this PhoneNumberProjection.


        :param provider_label: The provider_label of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._provider_label = provider_label

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


        :return: The line_type of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._line_type

    @line_type.setter
    def line_type(self, line_type):
        """Sets the line_type of this PhoneNumberProjection.


        :param line_type: The line_type of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._line_type = line_type

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


        :return: The carrier_name of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._carrier_name

    @carrier_name.setter
    def carrier_name(self, carrier_name):
        """Sets the carrier_name of this PhoneNumberProjection.


        :param carrier_name: The carrier_name of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._carrier_name = carrier_name

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


        :return: The mobile_country_code of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._mobile_country_code

    @mobile_country_code.setter
    def mobile_country_code(self, mobile_country_code):
        """Sets the mobile_country_code of this PhoneNumberProjection.


        :param mobile_country_code: The mobile_country_code of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._mobile_country_code = mobile_country_code

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


        :return: The mobile_network_code of this PhoneNumberProjection.  # noqa: E501
        :rtype: str
        """
        return self._mobile_network_code

    @mobile_network_code.setter
    def mobile_network_code(self, mobile_network_code):
        """Sets the mobile_network_code of this PhoneNumberProjection.


        :param mobile_network_code: The mobile_network_code of this PhoneNumberProjection.  # noqa: E501
        :type: str
        """

        self._mobile_network_code = mobile_network_code

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

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

Class variables

var attribute_map
var openapi_types

Instance variables

prop carrier_name

Gets the carrier_name of this PhoneNumberProjection. # noqa: E501

:return: The carrier_name of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def carrier_name(self):
    """Gets the carrier_name of this PhoneNumberProjection.  # noqa: E501


    :return: The carrier_name of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._carrier_name
prop created_at

Gets the created_at of this PhoneNumberProjection. # noqa: E501

:return: The created_at of this PhoneNumberProjection. # noqa: E501 :rtype: datetime

Expand source code
@property
def created_at(self):
    """Gets the created_at of this PhoneNumberProjection.  # noqa: E501


    :return: The created_at of this PhoneNumberProjection.  # noqa: E501
    :rtype: datetime
    """
    return self._created_at
prop id

Gets the id of this PhoneNumberProjection. # noqa: E501

:return: The id of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def id(self):
    """Gets the id of this PhoneNumberProjection.  # noqa: E501


    :return: The id of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._id
prop line_type

Gets the line_type of this PhoneNumberProjection. # noqa: E501

:return: The line_type of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def line_type(self):
    """Gets the line_type of this PhoneNumberProjection.  # noqa: E501


    :return: The line_type of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._line_type
prop mobile_country_code

Gets the mobile_country_code of this PhoneNumberProjection. # noqa: E501

:return: The mobile_country_code of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def mobile_country_code(self):
    """Gets the mobile_country_code of this PhoneNumberProjection.  # noqa: E501


    :return: The mobile_country_code of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._mobile_country_code
prop mobile_network_code

Gets the mobile_network_code of this PhoneNumberProjection. # noqa: E501

:return: The mobile_network_code of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def mobile_network_code(self):
    """Gets the mobile_network_code of this PhoneNumberProjection.  # noqa: E501


    :return: The mobile_network_code of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._mobile_network_code
prop name

Gets the name of this PhoneNumberProjection. # noqa: E501

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

Expand source code
@property
def name(self):
    """Gets the name of this PhoneNumberProjection.  # noqa: E501


    :return: The name of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._name
prop phone_country

Gets the phone_country of this PhoneNumberProjection. # noqa: E501

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

Expand source code
@property
def phone_country(self):
    """Gets the phone_country of this PhoneNumberProjection.  # noqa: E501


    :return: The phone_country of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._phone_country
prop phone_number

Gets the phone_number of this PhoneNumberProjection. # noqa: E501

:return: The phone_number of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def phone_number(self):
    """Gets the phone_number of this PhoneNumberProjection.  # noqa: E501


    :return: The phone_number of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._phone_number
prop provider_label

Gets the provider_label of this PhoneNumberProjection. # noqa: E501

:return: The provider_label of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def provider_label(self):
    """Gets the provider_label of this PhoneNumberProjection.  # noqa: E501


    :return: The provider_label of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._provider_label
prop tags

Gets the tags of this PhoneNumberProjection. # noqa: E501

:return: The tags of this PhoneNumberProjection. # noqa: E501 :rtype: list[str]

Expand source code
@property
def tags(self):
    """Gets the tags of this PhoneNumberProjection.  # noqa: E501


    :return: The tags of this PhoneNumberProjection.  # noqa: E501
    :rtype: list[str]
    """
    return self._tags
prop user_id

Gets the user_id of this PhoneNumberProjection. # noqa: E501

:return: The user_id of this PhoneNumberProjection. # noqa: E501 :rtype: str

Expand source code
@property
def user_id(self):
    """Gets the user_id of this PhoneNumberProjection.  # noqa: E501


    :return: The user_id of this PhoneNumberProjection.  # noqa: E501
    :rtype: str
    """
    return self._user_id

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model