Module mailslurp_client.models.create_phone_number_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 CreatePhoneNumberOptions (phone_country=None, name=None, description=None, tags=None, schedule=None, phone_number_endpoint_override=None, phone_number_variant=None, phone_provider=None, phone_line_filter=None, environment_account_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.

CreatePhoneNumberOptions - a model defined in OpenAPI

Expand source code

class CreatePhoneNumberOptions(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 = {
        'phone_country': 'str',
        'name': 'str',
        'description': 'str',
        'tags': 'list[str]',
        'schedule': 'str',
        'phone_number_endpoint_override': 'str',
        'phone_number_variant': 'str',
        'phone_provider': 'str',
        'phone_line_filter': 'str',
        'environment_account_id': 'str'
    }

    attribute_map = {
        'phone_country': 'phoneCountry',
        'name': 'name',
        'description': 'description',
        'tags': 'tags',
        'schedule': 'schedule',
        'phone_number_endpoint_override': 'phoneNumberEndpointOverride',
        'phone_number_variant': 'phoneNumberVariant',
        'phone_provider': 'phoneProvider',
        'phone_line_filter': 'phoneLineFilter',
        'environment_account_id': 'environmentAccountId'
    }

    def __init__(self, phone_country=None, name=None, description=None, tags=None, schedule=None, phone_number_endpoint_override=None, phone_number_variant=None, phone_provider=None, phone_line_filter=None, environment_account_id=None, local_vars_configuration=None):  # noqa: E501
        """CreatePhoneNumberOptions - 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._phone_country = None
        self._name = None
        self._description = None
        self._tags = None
        self._schedule = None
        self._phone_number_endpoint_override = None
        self._phone_number_variant = None
        self._phone_provider = None
        self._phone_line_filter = None
        self._environment_account_id = None
        self.discriminator = None

        self.phone_country = phone_country
        self.name = name
        self.description = description
        self.tags = tags
        self.schedule = schedule
        self.phone_number_endpoint_override = phone_number_endpoint_override
        self.phone_number_variant = phone_number_variant
        self.phone_provider = phone_provider
        self.phone_line_filter = phone_line_filter
        self.environment_account_id = environment_account_id

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


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

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


        :param phone_country: The phone_country of this CreatePhoneNumberOptions.  # 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 name(self):
        """Gets the name of this CreatePhoneNumberOptions.  # noqa: E501


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

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


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

        self._name = name

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


        :return: The description of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._description

    @description.setter
    def description(self, description):
        """Sets the description of this CreatePhoneNumberOptions.


        :param description: The description of this CreatePhoneNumberOptions.  # noqa: E501
        :type: str
        """

        self._description = description

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


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

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


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

        self._tags = tags

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


        :return: The schedule of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._schedule

    @schedule.setter
    def schedule(self, schedule):
        """Sets the schedule of this CreatePhoneNumberOptions.


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

        self._schedule = schedule

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


        :return: The phone_number_endpoint_override of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._phone_number_endpoint_override

    @phone_number_endpoint_override.setter
    def phone_number_endpoint_override(self, phone_number_endpoint_override):
        """Sets the phone_number_endpoint_override of this CreatePhoneNumberOptions.


        :param phone_number_endpoint_override: The phone_number_endpoint_override of this CreatePhoneNumberOptions.  # noqa: E501
        :type: str
        """

        self._phone_number_endpoint_override = phone_number_endpoint_override

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


        :return: The phone_number_variant of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._phone_number_variant

    @phone_number_variant.setter
    def phone_number_variant(self, phone_number_variant):
        """Sets the phone_number_variant of this CreatePhoneNumberOptions.


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

        self._phone_number_variant = phone_number_variant

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


        :return: The phone_provider of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._phone_provider

    @phone_provider.setter
    def phone_provider(self, phone_provider):
        """Sets the phone_provider of this CreatePhoneNumberOptions.


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

        self._phone_provider = phone_provider

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

        Line-quality preference for simple phone number provisioning  # noqa: E501

        :return: The phone_line_filter of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._phone_line_filter

    @phone_line_filter.setter
    def phone_line_filter(self, phone_line_filter):
        """Sets the phone_line_filter of this CreatePhoneNumberOptions.

        Line-quality preference for simple phone number provisioning  # noqa: E501

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

        self._phone_line_filter = phone_line_filter

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


        :return: The environment_account_id of this CreatePhoneNumberOptions.  # noqa: E501
        :rtype: str
        """
        return self._environment_account_id

    @environment_account_id.setter
    def environment_account_id(self, environment_account_id):
        """Sets the environment_account_id of this CreatePhoneNumberOptions.


        :param environment_account_id: The environment_account_id of this CreatePhoneNumberOptions.  # noqa: E501
        :type: str
        """

        self._environment_account_id = environment_account_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, CreatePhoneNumberOptions):
            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, CreatePhoneNumberOptions):
            return True

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop description

Gets the description of this CreatePhoneNumberOptions. # noqa: E501

:return: The description of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The description of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._description

prop environment_account_id

Gets the environment_account_id of this CreatePhoneNumberOptions. # noqa: E501

:return: The environment_account_id of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The environment_account_id of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._environment_account_id

prop name

Gets the name of this CreatePhoneNumberOptions. # noqa: E501

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

Expand source code

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


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

prop phone_country

Gets the phone_country of this CreatePhoneNumberOptions. # noqa: E501

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

Expand source code

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


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

prop phone_line_filter

Gets the phone_line_filter of this CreatePhoneNumberOptions. # noqa: E501

Line-quality preference for simple phone number provisioning # noqa: E501

:return: The phone_line_filter of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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

    Line-quality preference for simple phone number provisioning  # noqa: E501

    :return: The phone_line_filter of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._phone_line_filter

prop phone_number_endpoint_override

Gets the phone_number_endpoint_override of this CreatePhoneNumberOptions. # noqa: E501

:return: The phone_number_endpoint_override of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_number_endpoint_override of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._phone_number_endpoint_override

prop phone_number_variant

Gets the phone_number_variant of this CreatePhoneNumberOptions. # noqa: E501

:return: The phone_number_variant of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_number_variant of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._phone_number_variant

prop phone_provider

Gets the phone_provider of this CreatePhoneNumberOptions. # noqa: E501

:return: The phone_provider of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The phone_provider of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._phone_provider

prop schedule

Gets the schedule of this CreatePhoneNumberOptions. # noqa: E501

:return: The schedule of this CreatePhoneNumberOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The schedule of this CreatePhoneNumberOptions.  # noqa: E501
    :rtype: str
    """
    return self._schedule

prop tags

Gets the tags of this CreatePhoneNumberOptions. # noqa: E501

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

Expand source code

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


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

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model