Module mailslurp_client.models.sending_connection_provider_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 SendingConnectionProviderDto (provider_preset=None, provider=None, display_name=None, category=None, availability=None, setup_type=None, native_integration=None, smtp_defaults=None, supported_api_regions=None, requires_sending_domain=None, setup_notes=None, credential_type=None, capabilities=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.

SendingConnectionProviderDto - a model defined in OpenAPI

Expand source code

class SendingConnectionProviderDto(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 = {
        'provider_preset': 'str',
        'provider': 'str',
        'display_name': 'str',
        'category': 'str',
        'availability': 'str',
        'setup_type': 'str',
        'native_integration': 'bool',
        'smtp_defaults': 'SendingConnectionSmtpDefaults',
        'supported_api_regions': 'list[str]',
        'requires_sending_domain': 'bool',
        'setup_notes': 'list[str]',
        'credential_type': 'str',
        'capabilities': 'list[str]'
    }

    attribute_map = {
        'provider_preset': 'providerPreset',
        'provider': 'provider',
        'display_name': 'displayName',
        'category': 'category',
        'availability': 'availability',
        'setup_type': 'setupType',
        'native_integration': 'nativeIntegration',
        'smtp_defaults': 'smtpDefaults',
        'supported_api_regions': 'supportedApiRegions',
        'requires_sending_domain': 'requiresSendingDomain',
        'setup_notes': 'setupNotes',
        'credential_type': 'credentialType',
        'capabilities': 'capabilities'
    }

    def __init__(self, provider_preset=None, provider=None, display_name=None, category=None, availability=None, setup_type=None, native_integration=None, smtp_defaults=None, supported_api_regions=None, requires_sending_domain=None, setup_notes=None, credential_type=None, capabilities=None, local_vars_configuration=None):  # noqa: E501
        """SendingConnectionProviderDto - 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._provider_preset = None
        self._provider = None
        self._display_name = None
        self._category = None
        self._availability = None
        self._setup_type = None
        self._native_integration = None
        self._smtp_defaults = None
        self._supported_api_regions = None
        self._requires_sending_domain = None
        self._setup_notes = None
        self._credential_type = None
        self._capabilities = None
        self.discriminator = None

        self.provider_preset = provider_preset
        self.provider = provider
        self.display_name = display_name
        self.category = category
        self.availability = availability
        self.setup_type = setup_type
        self.native_integration = native_integration
        self.smtp_defaults = smtp_defaults
        self.supported_api_regions = supported_api_regions
        self.requires_sending_domain = requires_sending_domain
        self.setup_notes = setup_notes
        self.credential_type = credential_type
        self.capabilities = capabilities

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


        :return: The provider_preset of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._provider_preset

    @provider_preset.setter
    def provider_preset(self, provider_preset):
        """Sets the provider_preset of this SendingConnectionProviderDto.


        :param provider_preset: The provider_preset of this SendingConnectionProviderDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and provider_preset is None:  # noqa: E501
            raise ValueError("Invalid value for `provider_preset`, must not be `None`")  # noqa: E501
        allowed_values = ["GENERIC_SMTP", "GMAIL", "GOOGLE_WORKSPACE", "MICROSOFT_365", "OUTLOOK_COM", "YAHOO_MAIL", "APPLE_ICLOUD", "FASTMAIL", "ZOHO_MAIL", "AOL_MAIL", "GMX_MAIL", "MAIL_COM", "PROTON_MAIL", "AMAZON_SES", "SENDGRID", "RESEND", "MAILGUN", "POSTMARK", "BREVO", "MAILJET", "SPARKPOST", "SMTP2GO", "SENDPULSE", "SOCKETLABS", "MAILERSEND", "MANDRILL", "ELASTIC_EMAIL"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and provider_preset not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `provider_preset` ({0}), must be one of {1}"  # noqa: E501
                .format(provider_preset, allowed_values)
            )

        self._provider_preset = provider_preset

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


        :return: The provider of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._provider

    @provider.setter
    def provider(self, provider):
        """Sets the provider of this SendingConnectionProviderDto.


        :param provider: The provider of this SendingConnectionProviderDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and provider is None:  # noqa: E501
            raise ValueError("Invalid value for `provider`, must not be `None`")  # noqa: E501
        allowed_values = ["SMTP", "AMAZON_SES", "SENDGRID", "RESEND", "MAILGUN", "POSTMARK"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and provider not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `provider` ({0}), must be one of {1}"  # noqa: E501
                .format(provider, allowed_values)
            )

        self._provider = provider

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


        :return: The display_name of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._display_name

    @display_name.setter
    def display_name(self, display_name):
        """Sets the display_name of this SendingConnectionProviderDto.


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

        self._display_name = display_name

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


        :return: The category of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._category

    @category.setter
    def category(self, category):
        """Sets the category of this SendingConnectionProviderDto.


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

        self._category = category

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


        :return: The availability of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._availability

    @availability.setter
    def availability(self, availability):
        """Sets the availability of this SendingConnectionProviderDto.


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

        self._availability = availability

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


        :return: The setup_type of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._setup_type

    @setup_type.setter
    def setup_type(self, setup_type):
        """Sets the setup_type of this SendingConnectionProviderDto.


        :param setup_type: The setup_type of this SendingConnectionProviderDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and setup_type is None:  # noqa: E501
            raise ValueError("Invalid value for `setup_type`, must not be `None`")  # noqa: E501
        allowed_values = ["SMTP", "API_KEY", "AWS_CREDENTIALS", "OAUTH", "UNAVAILABLE"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and setup_type not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `setup_type` ({0}), must be one of {1}"  # noqa: E501
                .format(setup_type, allowed_values)
            )

        self._setup_type = setup_type

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


        :return: The native_integration of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: bool
        """
        return self._native_integration

    @native_integration.setter
    def native_integration(self, native_integration):
        """Sets the native_integration of this SendingConnectionProviderDto.


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

        self._native_integration = native_integration

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


        :return: The smtp_defaults of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: SendingConnectionSmtpDefaults
        """
        return self._smtp_defaults

    @smtp_defaults.setter
    def smtp_defaults(self, smtp_defaults):
        """Sets the smtp_defaults of this SendingConnectionProviderDto.


        :param smtp_defaults: The smtp_defaults of this SendingConnectionProviderDto.  # noqa: E501
        :type: SendingConnectionSmtpDefaults
        """

        self._smtp_defaults = smtp_defaults

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


        :return: The supported_api_regions of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._supported_api_regions

    @supported_api_regions.setter
    def supported_api_regions(self, supported_api_regions):
        """Sets the supported_api_regions of this SendingConnectionProviderDto.


        :param supported_api_regions: The supported_api_regions of this SendingConnectionProviderDto.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and supported_api_regions is None:  # noqa: E501
            raise ValueError("Invalid value for `supported_api_regions`, must not be `None`")  # noqa: E501
        allowed_values = ["US", "EU"]  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                not set(supported_api_regions).issubset(set(allowed_values))):  # noqa: E501
            raise ValueError(
                "Invalid values for `supported_api_regions` [{0}], must be a subset of [{1}]"  # noqa: E501
                .format(", ".join(map(str, set(supported_api_regions) - set(allowed_values))),  # noqa: E501
                        ", ".join(map(str, allowed_values)))
            )

        self._supported_api_regions = supported_api_regions

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


        :return: The requires_sending_domain of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: bool
        """
        return self._requires_sending_domain

    @requires_sending_domain.setter
    def requires_sending_domain(self, requires_sending_domain):
        """Sets the requires_sending_domain of this SendingConnectionProviderDto.


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

        self._requires_sending_domain = requires_sending_domain

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


        :return: The setup_notes of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._setup_notes

    @setup_notes.setter
    def setup_notes(self, setup_notes):
        """Sets the setup_notes of this SendingConnectionProviderDto.


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

        self._setup_notes = setup_notes

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


        :return: The credential_type of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: str
        """
        return self._credential_type

    @credential_type.setter
    def credential_type(self, credential_type):
        """Sets the credential_type of this SendingConnectionProviderDto.


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

        self._credential_type = credential_type

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


        :return: The capabilities of this SendingConnectionProviderDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._capabilities

    @capabilities.setter
    def capabilities(self, capabilities):
        """Sets the capabilities of this SendingConnectionProviderDto.


        :param capabilities: The capabilities of this SendingConnectionProviderDto.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and capabilities is None:  # noqa: E501
            raise ValueError("Invalid value for `capabilities`, must not be `None`")  # noqa: E501
        allowed_values = ["SEND_EMAIL", "VERIFY_CONNECTION", "ROTATE_CREDENTIALS", "DELIVERY_PROBE"]  # noqa: E501
        if (self.local_vars_configuration.client_side_validation and
                not set(capabilities).issubset(set(allowed_values))):  # noqa: E501
            raise ValueError(
                "Invalid values for `capabilities` [{0}], must be a subset of [{1}]"  # noqa: E501
                .format(", ".join(map(str, set(capabilities) - set(allowed_values))),  # noqa: E501
                        ", ".join(map(str, allowed_values)))
            )

        self._capabilities = capabilities

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop availability

Gets the availability of this SendingConnectionProviderDto. # noqa: E501

:return: The availability of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The availability of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._availability

prop capabilities

Gets the capabilities of this SendingConnectionProviderDto. # noqa: E501

:return: The capabilities of this SendingConnectionProviderDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The capabilities of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._capabilities

prop category

Gets the category of this SendingConnectionProviderDto. # noqa: E501

:return: The category of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The category of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._category

prop credential_type

Gets the credential_type of this SendingConnectionProviderDto. # noqa: E501

:return: The credential_type of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The credential_type of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._credential_type

prop display_name

Gets the display_name of this SendingConnectionProviderDto. # noqa: E501

:return: The display_name of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The display_name of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._display_name

prop native_integration

Gets the native_integration of this SendingConnectionProviderDto. # noqa: E501

:return: The native_integration of this SendingConnectionProviderDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The native_integration of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: bool
    """
    return self._native_integration

prop provider

Gets the provider of this SendingConnectionProviderDto. # noqa: E501

:return: The provider of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The provider of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._provider

prop provider_preset

Gets the provider_preset of this SendingConnectionProviderDto. # noqa: E501

:return: The provider_preset of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The provider_preset of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._provider_preset

prop requires_sending_domain

Gets the requires_sending_domain of this SendingConnectionProviderDto. # noqa: E501

:return: The requires_sending_domain of this SendingConnectionProviderDto. # noqa: E501 :rtype: bool

Expand source code

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


    :return: The requires_sending_domain of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: bool
    """
    return self._requires_sending_domain

prop setup_notes

Gets the setup_notes of this SendingConnectionProviderDto. # noqa: E501

:return: The setup_notes of this SendingConnectionProviderDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The setup_notes of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._setup_notes

prop setup_type

Gets the setup_type of this SendingConnectionProviderDto. # noqa: E501

:return: The setup_type of this SendingConnectionProviderDto. # noqa: E501 :rtype: str

Expand source code

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


    :return: The setup_type of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: str
    """
    return self._setup_type

prop smtp_defaults

Gets the smtp_defaults of this SendingConnectionProviderDto. # noqa: E501

:return: The smtp_defaults of this SendingConnectionProviderDto. # noqa: E501 :rtype: SendingConnectionSmtpDefaults

Expand source code

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


    :return: The smtp_defaults of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: SendingConnectionSmtpDefaults
    """
    return self._smtp_defaults

prop supported_api_regions

Gets the supported_api_regions of this SendingConnectionProviderDto. # noqa: E501

:return: The supported_api_regions of this SendingConnectionProviderDto. # noqa: E501 :rtype: list[str]

Expand source code

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


    :return: The supported_api_regions of this SendingConnectionProviderDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._supported_api_regions

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model