Module mailslurp_client.models.sending_connection_api_key_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 SendingConnectionApiKeyOptions (api_key=None, sending_domain=None, region=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.

SendingConnectionApiKeyOptions - a model defined in OpenAPI

Expand source code

class SendingConnectionApiKeyOptions(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 = {
        'api_key': 'str',
        'sending_domain': 'str',
        'region': 'str'
    }

    attribute_map = {
        'api_key': 'apiKey',
        'sending_domain': 'sendingDomain',
        'region': 'region'
    }

    def __init__(self, api_key=None, sending_domain=None, region=None, local_vars_configuration=None):  # noqa: E501
        """SendingConnectionApiKeyOptions - 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._api_key = None
        self._sending_domain = None
        self._region = None
        self.discriminator = None

        self.api_key = api_key
        self.sending_domain = sending_domain
        self.region = region

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


        :return: The api_key of this SendingConnectionApiKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._api_key

    @api_key.setter
    def api_key(self, api_key):
        """Sets the api_key of this SendingConnectionApiKeyOptions.


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

        self._api_key = api_key

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


        :return: The sending_domain of this SendingConnectionApiKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._sending_domain

    @sending_domain.setter
    def sending_domain(self, sending_domain):
        """Sets the sending_domain of this SendingConnectionApiKeyOptions.


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

        self._sending_domain = sending_domain

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


        :return: The region of this SendingConnectionApiKeyOptions.  # noqa: E501
        :rtype: str
        """
        return self._region

    @region.setter
    def region(self, region):
        """Sets the region of this SendingConnectionApiKeyOptions.


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

        self._region = region

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop api_key

Gets the api_key of this SendingConnectionApiKeyOptions. # noqa: E501

:return: The api_key of this SendingConnectionApiKeyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The api_key of this SendingConnectionApiKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._api_key

prop region

Gets the region of this SendingConnectionApiKeyOptions. # noqa: E501

:return: The region of this SendingConnectionApiKeyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The region of this SendingConnectionApiKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._region

prop sending_domain

Gets the sending_domain of this SendingConnectionApiKeyOptions. # noqa: E501

:return: The sending_domain of this SendingConnectionApiKeyOptions. # noqa: E501 :rtype: str

Expand source code

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


    :return: The sending_domain of this SendingConnectionApiKeyOptions.  # noqa: E501
    :rtype: str
    """
    return self._sending_domain

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model