Module mailslurp_client.models.upload_attachment_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 UploadAttachmentOptions (content_id=None, content_type=None, filename=None, base64_contents=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.

UploadAttachmentOptions - a model defined in OpenAPI

Expand source code

class UploadAttachmentOptions(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 = {
        'content_id': 'str',
        'content_type': 'str',
        'filename': 'str',
        'base64_contents': 'str'
    }

    attribute_map = {
        'content_id': 'contentId',
        'content_type': 'contentType',
        'filename': 'filename',
        'base64_contents': 'base64Contents'
    }

    def __init__(self, content_id=None, content_type=None, filename=None, base64_contents=None, local_vars_configuration=None):  # noqa: E501
        """UploadAttachmentOptions - 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._content_id = None
        self._content_type = None
        self._filename = None
        self._base64_contents = None
        self.discriminator = None

        self.content_id = content_id
        self.content_type = content_type
        self.filename = filename
        self.base64_contents = base64_contents

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

        Optional contentId for file.  # noqa: E501

        :return: The content_id of this UploadAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._content_id

    @content_id.setter
    def content_id(self, content_id):
        """Sets the content_id of this UploadAttachmentOptions.

        Optional contentId for file.  # noqa: E501

        :param content_id: The content_id of this UploadAttachmentOptions.  # noqa: E501
        :type: str
        """

        self._content_id = content_id

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

        Optional contentType for file. For instance `application/pdf`  # noqa: E501

        :return: The content_type of this UploadAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._content_type

    @content_type.setter
    def content_type(self, content_type):
        """Sets the content_type of this UploadAttachmentOptions.

        Optional contentType for file. For instance `application/pdf`  # noqa: E501

        :param content_type: The content_type of this UploadAttachmentOptions.  # noqa: E501
        :type: str
        """

        self._content_type = content_type

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

        Optional filename to save upload with. Will be the name that is shown in email clients  # noqa: E501

        :return: The filename of this UploadAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._filename

    @filename.setter
    def filename(self, filename):
        """Sets the filename of this UploadAttachmentOptions.

        Optional filename to save upload with. Will be the name that is shown in email clients  # noqa: E501

        :param filename: The filename of this UploadAttachmentOptions.  # noqa: E501
        :type: str
        """

        self._filename = filename

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

        Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/  # noqa: E501

        :return: The base64_contents of this UploadAttachmentOptions.  # noqa: E501
        :rtype: str
        """
        return self._base64_contents

    @base64_contents.setter
    def base64_contents(self, base64_contents):
        """Sets the base64_contents of this UploadAttachmentOptions.

        Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/  # noqa: E501

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

        self._base64_contents = base64_contents

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

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

Class variables

var attribute_map

var openapi_types

Instance variables

prop base64_contents

Gets the base64_contents of this UploadAttachmentOptions. # noqa: E501

Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/ # noqa: E501

:return: The base64_contents of this UploadAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/  # noqa: E501

    :return: The base64_contents of this UploadAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._base64_contents

prop content_id

Gets the content_id of this UploadAttachmentOptions. # noqa: E501

Optional contentId for file. # noqa: E501

:return: The content_id of this UploadAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional contentId for file.  # noqa: E501

    :return: The content_id of this UploadAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._content_id

prop content_type

Gets the content_type of this UploadAttachmentOptions. # noqa: E501

Optional contentType for file. For instance application/pdf # noqa: E501

:return: The content_type of this UploadAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional contentType for file. For instance `application/pdf`  # noqa: E501

    :return: The content_type of this UploadAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._content_type

prop filename

Gets the filename of this UploadAttachmentOptions. # noqa: E501

Optional filename to save upload with. Will be the name that is shown in email clients # noqa: E501

:return: The filename of this UploadAttachmentOptions. # noqa: E501 :rtype: str

Expand source code

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

    Optional filename to save upload with. Will be the name that is shown in email clients  # noqa: E501

    :return: The filename of this UploadAttachmentOptions.  # noqa: E501
    :rtype: str
    """
    return self._filename

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model