docusign_esign.models.envelope_form_data

  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 EnvelopeFormData(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_subject': 'str',
 37        'envelope_id': 'str',
 38        'form_data': 'list[FormDataItem]',
 39        'prefill_form_data': 'PrefillFormData',
 40        'recipient_form_data': 'list[RecipientFormData]',
 41        'sent_date_time': 'str',
 42        'status': 'str'
 43    }
 44
 45    attribute_map = {
 46        'email_subject': 'emailSubject',
 47        'envelope_id': 'envelopeId',
 48        'form_data': 'formData',
 49        'prefill_form_data': 'prefillFormData',
 50        'recipient_form_data': 'recipientFormData',
 51        'sent_date_time': 'sentDateTime',
 52        'status': 'status'
 53    }
 54
 55    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 56        """EnvelopeFormData - a model defined in Swagger"""  # noqa: E501
 57        if _configuration is None:
 58            _configuration = Configuration()
 59        self._configuration = _configuration
 60
 61        self._email_subject = None
 62        self._envelope_id = None
 63        self._form_data = None
 64        self._prefill_form_data = None
 65        self._recipient_form_data = None
 66        self._sent_date_time = None
 67        self._status = None
 68        self.discriminator = None
 69
 70        setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None))
 71        setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
 72        setattr(self, "_{}".format('form_data'), kwargs.get('form_data', None))
 73        setattr(self, "_{}".format('prefill_form_data'), kwargs.get('prefill_form_data', None))
 74        setattr(self, "_{}".format('recipient_form_data'), kwargs.get('recipient_form_data', None))
 75        setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None))
 76        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 77
 78    @property
 79    def email_subject(self):
 80        """Gets the email_subject of this EnvelopeFormData.  # noqa: E501
 81
 82        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
 83
 84        :return: The email_subject of this EnvelopeFormData.  # noqa: E501
 85        :rtype: str
 86        """
 87        return self._email_subject
 88
 89    @email_subject.setter
 90    def email_subject(self, email_subject):
 91        """Sets the email_subject of this EnvelopeFormData.
 92
 93        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
 94
 95        :param email_subject: The email_subject of this EnvelopeFormData.  # noqa: E501
 96        :type: str
 97        """
 98
 99        self._email_subject = email_subject
100
101    @property
102    def envelope_id(self):
103        """Gets the envelope_id of this EnvelopeFormData.  # noqa: E501
104
105        The envelope ID of the envelope status that failed to post.  # noqa: E501
106
107        :return: The envelope_id of this EnvelopeFormData.  # noqa: E501
108        :rtype: str
109        """
110        return self._envelope_id
111
112    @envelope_id.setter
113    def envelope_id(self, envelope_id):
114        """Sets the envelope_id of this EnvelopeFormData.
115
116        The envelope ID of the envelope status that failed to post.  # noqa: E501
117
118        :param envelope_id: The envelope_id of this EnvelopeFormData.  # noqa: E501
119        :type: str
120        """
121
122        self._envelope_id = envelope_id
123
124    @property
125    def form_data(self):
126        """Gets the form_data of this EnvelopeFormData.  # noqa: E501
127
128          # noqa: E501
129
130        :return: The form_data of this EnvelopeFormData.  # noqa: E501
131        :rtype: list[FormDataItem]
132        """
133        return self._form_data
134
135    @form_data.setter
136    def form_data(self, form_data):
137        """Sets the form_data of this EnvelopeFormData.
138
139          # noqa: E501
140
141        :param form_data: The form_data of this EnvelopeFormData.  # noqa: E501
142        :type: list[FormDataItem]
143        """
144
145        self._form_data = form_data
146
147    @property
148    def prefill_form_data(self):
149        """Gets the prefill_form_data of this EnvelopeFormData.  # noqa: E501
150
151        An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).   # noqa: E501
152
153        :return: The prefill_form_data of this EnvelopeFormData.  # noqa: E501
154        :rtype: PrefillFormData
155        """
156        return self._prefill_form_data
157
158    @prefill_form_data.setter
159    def prefill_form_data(self, prefill_form_data):
160        """Sets the prefill_form_data of this EnvelopeFormData.
161
162        An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).   # noqa: E501
163
164        :param prefill_form_data: The prefill_form_data of this EnvelopeFormData.  # noqa: E501
165        :type: PrefillFormData
166        """
167
168        self._prefill_form_data = prefill_form_data
169
170    @property
171    def recipient_form_data(self):
172        """Gets the recipient_form_data of this EnvelopeFormData.  # noqa: E501
173
174          # noqa: E501
175
176        :return: The recipient_form_data of this EnvelopeFormData.  # noqa: E501
177        :rtype: list[RecipientFormData]
178        """
179        return self._recipient_form_data
180
181    @recipient_form_data.setter
182    def recipient_form_data(self, recipient_form_data):
183        """Sets the recipient_form_data of this EnvelopeFormData.
184
185          # noqa: E501
186
187        :param recipient_form_data: The recipient_form_data of this EnvelopeFormData.  # noqa: E501
188        :type: list[RecipientFormData]
189        """
190
191        self._recipient_form_data = recipient_form_data
192
193    @property
194    def sent_date_time(self):
195        """Gets the sent_date_time of this EnvelopeFormData.  # noqa: E501
196
197        The date and time the envelope was sent.  # noqa: E501
198
199        :return: The sent_date_time of this EnvelopeFormData.  # noqa: E501
200        :rtype: str
201        """
202        return self._sent_date_time
203
204    @sent_date_time.setter
205    def sent_date_time(self, sent_date_time):
206        """Sets the sent_date_time of this EnvelopeFormData.
207
208        The date and time the envelope was sent.  # noqa: E501
209
210        :param sent_date_time: The sent_date_time of this EnvelopeFormData.  # noqa: E501
211        :type: str
212        """
213
214        self._sent_date_time = sent_date_time
215
216    @property
217    def status(self):
218        """Gets the status of this EnvelopeFormData.  # noqa: E501
219
220        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
221
222        :return: The status of this EnvelopeFormData.  # noqa: E501
223        :rtype: str
224        """
225        return self._status
226
227    @status.setter
228    def status(self, status):
229        """Sets the status of this EnvelopeFormData.
230
231        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
232
233        :param status: The status of this EnvelopeFormData.  # noqa: E501
234        :type: str
235        """
236
237        self._status = status
238
239    def to_dict(self):
240        """Returns the model properties as a dict"""
241        result = {}
242
243        for attr, _ in six.iteritems(self.swagger_types):
244            value = getattr(self, attr)
245            if isinstance(value, list):
246                result[attr] = list(map(
247                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
248                    value
249                ))
250            elif hasattr(value, "to_dict"):
251                result[attr] = value.to_dict()
252            elif isinstance(value, dict):
253                result[attr] = dict(map(
254                    lambda item: (item[0], item[1].to_dict())
255                    if hasattr(item[1], "to_dict") else item,
256                    value.items()
257                ))
258            else:
259                result[attr] = value
260        if issubclass(EnvelopeFormData, dict):
261            for key, value in self.items():
262                result[key] = value
263
264        return result
265
266    def to_str(self):
267        """Returns the string representation of the model"""
268        return pprint.pformat(self.to_dict())
269
270    def __repr__(self):
271        """For `print` and `pprint`"""
272        return self.to_str()
273
274    def __eq__(self, other):
275        """Returns true if both objects are equal"""
276        if not isinstance(other, EnvelopeFormData):
277            return False
278
279        return self.to_dict() == other.to_dict()
280
281    def __ne__(self, other):
282        """Returns true if both objects are not equal"""
283        if not isinstance(other, EnvelopeFormData):
284            return True
285
286        return self.to_dict() != other.to_dict()