docusign_esign.models.recipient_email_notification

  1# coding: utf-8
  2
  3"""
  4    Docusign eSignature REST API
  5
  6    The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class RecipientEmailNotification(object):
 23    """NOTE: This class is auto generated by the swagger code generator program.
 24
 25    Do not edit the class manually.
 26    """
 27
 28    """
 29    Attributes:
 30      swagger_types (dict): The key is attribute name
 31                            and the value is attribute type.
 32      attribute_map (dict): The key is attribute name
 33                            and the value is json key in definition.
 34    """
 35    swagger_types = {
 36        'email_body': 'str',
 37        'email_body_metadata': 'PropertyMetadata',
 38        'email_subject': 'str',
 39        'email_subject_metadata': 'PropertyMetadata',
 40        'supported_language': 'str',
 41        'supported_language_metadata': 'PropertyMetadata'
 42    }
 43
 44    attribute_map = {
 45        'email_body': 'emailBody',
 46        'email_body_metadata': 'emailBodyMetadata',
 47        'email_subject': 'emailSubject',
 48        'email_subject_metadata': 'emailSubjectMetadata',
 49        'supported_language': 'supportedLanguage',
 50        'supported_language_metadata': 'supportedLanguageMetadata'
 51    }
 52
 53    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 54        """RecipientEmailNotification - a model defined in Swagger"""  # noqa: E501
 55        if _configuration is None:
 56            _configuration = Configuration()
 57        self._configuration = _configuration
 58
 59        self._email_body = None
 60        self._email_body_metadata = None
 61        self._email_subject = None
 62        self._email_subject_metadata = None
 63        self._supported_language = None
 64        self._supported_language_metadata = None
 65        self.discriminator = None
 66
 67        setattr(self, "_{}".format('email_body'), kwargs.get('email_body', None))
 68        setattr(self, "_{}".format('email_body_metadata'), kwargs.get('email_body_metadata', None))
 69        setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None))
 70        setattr(self, "_{}".format('email_subject_metadata'), kwargs.get('email_subject_metadata', None))
 71        setattr(self, "_{}".format('supported_language'), kwargs.get('supported_language', None))
 72        setattr(self, "_{}".format('supported_language_metadata'), kwargs.get('supported_language_metadata', None))
 73
 74    @property
 75    def email_body(self):
 76        """Gets the email_body of this RecipientEmailNotification.  # noqa: E501
 77
 78        Specifies the email body of the message sent to the recipient.   Maximum length: 10000 characters.   # noqa: E501
 79
 80        :return: The email_body of this RecipientEmailNotification.  # noqa: E501
 81        :rtype: str
 82        """
 83        return self._email_body
 84
 85    @email_body.setter
 86    def email_body(self, email_body):
 87        """Sets the email_body of this RecipientEmailNotification.
 88
 89        Specifies the email body of the message sent to the recipient.   Maximum length: 10000 characters.   # noqa: E501
 90
 91        :param email_body: The email_body of this RecipientEmailNotification.  # noqa: E501
 92        :type: str
 93        """
 94
 95        self._email_body = email_body
 96
 97    @property
 98    def email_body_metadata(self):
 99        """Gets the email_body_metadata of this RecipientEmailNotification.  # noqa: E501
100
101        Metadata that indicates whether the `emailBody` property can be edited.  # noqa: E501
102
103        :return: The email_body_metadata of this RecipientEmailNotification.  # noqa: E501
104        :rtype: PropertyMetadata
105        """
106        return self._email_body_metadata
107
108    @email_body_metadata.setter
109    def email_body_metadata(self, email_body_metadata):
110        """Sets the email_body_metadata of this RecipientEmailNotification.
111
112        Metadata that indicates whether the `emailBody` property can be edited.  # noqa: E501
113
114        :param email_body_metadata: The email_body_metadata of this RecipientEmailNotification.  # noqa: E501
115        :type: PropertyMetadata
116        """
117
118        self._email_body_metadata = email_body_metadata
119
120    @property
121    def email_subject(self):
122        """Gets the email_subject of this RecipientEmailNotification.  # noqa: E501
123
124        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.  # noqa: E501
125
126        :return: The email_subject of this RecipientEmailNotification.  # noqa: E501
127        :rtype: str
128        """
129        return self._email_subject
130
131    @email_subject.setter
132    def email_subject(self, email_subject):
133        """Sets the email_subject of this RecipientEmailNotification.
134
135        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.  # noqa: E501
136
137        :param email_subject: The email_subject of this RecipientEmailNotification.  # noqa: E501
138        :type: str
139        """
140
141        self._email_subject = email_subject
142
143    @property
144    def email_subject_metadata(self):
145        """Gets the email_subject_metadata of this RecipientEmailNotification.  # noqa: E501
146
147        Metadata that indicates whether the `emailSubject` property can be edited.  # noqa: E501
148
149        :return: The email_subject_metadata of this RecipientEmailNotification.  # noqa: E501
150        :rtype: PropertyMetadata
151        """
152        return self._email_subject_metadata
153
154    @email_subject_metadata.setter
155    def email_subject_metadata(self, email_subject_metadata):
156        """Sets the email_subject_metadata of this RecipientEmailNotification.
157
158        Metadata that indicates whether the `emailSubject` property can be edited.  # noqa: E501
159
160        :param email_subject_metadata: The email_subject_metadata of this RecipientEmailNotification.  # noqa: E501
161        :type: PropertyMetadata
162        """
163
164        self._email_subject_metadata = email_subject_metadata
165
166    @property
167    def supported_language(self):
168        """Gets the supported_language of this RecipientEmailNotification.  # noqa: E501
169
170        A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).  # noqa: E501
171
172        :return: The supported_language of this RecipientEmailNotification.  # noqa: E501
173        :rtype: str
174        """
175        return self._supported_language
176
177    @supported_language.setter
178    def supported_language(self, supported_language):
179        """Sets the supported_language of this RecipientEmailNotification.
180
181        A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).  # noqa: E501
182
183        :param supported_language: The supported_language of this RecipientEmailNotification.  # noqa: E501
184        :type: str
185        """
186
187        self._supported_language = supported_language
188
189    @property
190    def supported_language_metadata(self):
191        """Gets the supported_language_metadata of this RecipientEmailNotification.  # noqa: E501
192
193        Metadata that indicates whether the `supportedLanguage` property can be edited.  # noqa: E501
194
195        :return: The supported_language_metadata of this RecipientEmailNotification.  # noqa: E501
196        :rtype: PropertyMetadata
197        """
198        return self._supported_language_metadata
199
200    @supported_language_metadata.setter
201    def supported_language_metadata(self, supported_language_metadata):
202        """Sets the supported_language_metadata of this RecipientEmailNotification.
203
204        Metadata that indicates whether the `supportedLanguage` property can be edited.  # noqa: E501
205
206        :param supported_language_metadata: The supported_language_metadata of this RecipientEmailNotification.  # noqa: E501
207        :type: PropertyMetadata
208        """
209
210        self._supported_language_metadata = supported_language_metadata
211
212    def to_dict(self):
213        """Returns the model properties as a dict"""
214        result = {}
215
216        for attr, _ in six.iteritems(self.swagger_types):
217            value = getattr(self, attr)
218            if isinstance(value, list):
219                result[attr] = list(map(
220                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
221                    value
222                ))
223            elif hasattr(value, "to_dict"):
224                result[attr] = value.to_dict()
225            elif isinstance(value, dict):
226                result[attr] = dict(map(
227                    lambda item: (item[0], item[1].to_dict())
228                    if hasattr(item[1], "to_dict") else item,
229                    value.items()
230                ))
231            else:
232                result[attr] = value
233        if issubclass(RecipientEmailNotification, dict):
234            for key, value in self.items():
235                result[key] = value
236
237        return result
238
239    def to_str(self):
240        """Returns the string representation of the model"""
241        return pprint.pformat(self.to_dict())
242
243    def __repr__(self):
244        """For `print` and `pprint`"""
245        return self.to_str()
246
247    def __eq__(self, other):
248        """Returns true if both objects are equal"""
249        if not isinstance(other, RecipientEmailNotification):
250            return False
251
252        return self.to_dict() == other.to_dict()
253
254    def __ne__(self, other):
255        """Returns true if both objects are not equal"""
256        if not isinstance(other, RecipientEmailNotification):
257            return True
258
259        return self.to_dict() != other.to_dict()