docusign_esign.models.recipient_form_data

Docusign eSignature REST API

The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501

OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git

  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 RecipientFormData(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        'declined_time': 'str',
 37        'delivered_time': 'str',
 38        'email': 'str',
 39        'form_data': 'list[FormDataItem]',
 40        'name': 'str',
 41        'recipient_id': 'str',
 42        'sent_time': 'str',
 43        'signed_time': 'str'
 44    }
 45
 46    attribute_map = {
 47        'declined_time': 'DeclinedTime',
 48        'delivered_time': 'DeliveredTime',
 49        'email': 'email',
 50        'form_data': 'formData',
 51        'name': 'name',
 52        'recipient_id': 'recipientId',
 53        'sent_time': 'SentTime',
 54        'signed_time': 'SignedTime'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """RecipientFormData - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._declined_time = None
 64        self._delivered_time = None
 65        self._email = None
 66        self._form_data = None
 67        self._name = None
 68        self._recipient_id = None
 69        self._sent_time = None
 70        self._signed_time = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('declined_time'), kwargs.get('declined_time', None))
 74        setattr(self, "_{}".format('delivered_time'), kwargs.get('delivered_time', None))
 75        setattr(self, "_{}".format('email'), kwargs.get('email', None))
 76        setattr(self, "_{}".format('form_data'), kwargs.get('form_data', None))
 77        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 78        setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
 79        setattr(self, "_{}".format('sent_time'), kwargs.get('sent_time', None))
 80        setattr(self, "_{}".format('signed_time'), kwargs.get('signed_time', None))
 81
 82    @property
 83    def declined_time(self):
 84        """Gets the declined_time of this RecipientFormData.  # noqa: E501
 85
 86          # noqa: E501
 87
 88        :return: The declined_time of this RecipientFormData.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._declined_time
 92
 93    @declined_time.setter
 94    def declined_time(self, declined_time):
 95        """Sets the declined_time of this RecipientFormData.
 96
 97          # noqa: E501
 98
 99        :param declined_time: The declined_time of this RecipientFormData.  # noqa: E501
100        :type: str
101        """
102
103        self._declined_time = declined_time
104
105    @property
106    def delivered_time(self):
107        """Gets the delivered_time of this RecipientFormData.  # noqa: E501
108
109          # noqa: E501
110
111        :return: The delivered_time of this RecipientFormData.  # noqa: E501
112        :rtype: str
113        """
114        return self._delivered_time
115
116    @delivered_time.setter
117    def delivered_time(self, delivered_time):
118        """Sets the delivered_time of this RecipientFormData.
119
120          # noqa: E501
121
122        :param delivered_time: The delivered_time of this RecipientFormData.  # noqa: E501
123        :type: str
124        """
125
126        self._delivered_time = delivered_time
127
128    @property
129    def email(self):
130        """Gets the email of this RecipientFormData.  # noqa: E501
131
132          # noqa: E501
133
134        :return: The email of this RecipientFormData.  # noqa: E501
135        :rtype: str
136        """
137        return self._email
138
139    @email.setter
140    def email(self, email):
141        """Sets the email of this RecipientFormData.
142
143          # noqa: E501
144
145        :param email: The email of this RecipientFormData.  # noqa: E501
146        :type: str
147        """
148
149        self._email = email
150
151    @property
152    def form_data(self):
153        """Gets the form_data of this RecipientFormData.  # noqa: E501
154
155          # noqa: E501
156
157        :return: The form_data of this RecipientFormData.  # noqa: E501
158        :rtype: list[FormDataItem]
159        """
160        return self._form_data
161
162    @form_data.setter
163    def form_data(self, form_data):
164        """Sets the form_data of this RecipientFormData.
165
166          # noqa: E501
167
168        :param form_data: The form_data of this RecipientFormData.  # noqa: E501
169        :type: list[FormDataItem]
170        """
171
172        self._form_data = form_data
173
174    @property
175    def name(self):
176        """Gets the name of this RecipientFormData.  # noqa: E501
177
178          # noqa: E501
179
180        :return: The name of this RecipientFormData.  # noqa: E501
181        :rtype: str
182        """
183        return self._name
184
185    @name.setter
186    def name(self, name):
187        """Sets the name of this RecipientFormData.
188
189          # noqa: E501
190
191        :param name: The name of this RecipientFormData.  # noqa: E501
192        :type: str
193        """
194
195        self._name = name
196
197    @property
198    def recipient_id(self):
199        """Gets the recipient_id of this RecipientFormData.  # noqa: E501
200
201        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
202
203        :return: The recipient_id of this RecipientFormData.  # noqa: E501
204        :rtype: str
205        """
206        return self._recipient_id
207
208    @recipient_id.setter
209    def recipient_id(self, recipient_id):
210        """Sets the recipient_id of this RecipientFormData.
211
212        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
213
214        :param recipient_id: The recipient_id of this RecipientFormData.  # noqa: E501
215        :type: str
216        """
217
218        self._recipient_id = recipient_id
219
220    @property
221    def sent_time(self):
222        """Gets the sent_time of this RecipientFormData.  # noqa: E501
223
224          # noqa: E501
225
226        :return: The sent_time of this RecipientFormData.  # noqa: E501
227        :rtype: str
228        """
229        return self._sent_time
230
231    @sent_time.setter
232    def sent_time(self, sent_time):
233        """Sets the sent_time of this RecipientFormData.
234
235          # noqa: E501
236
237        :param sent_time: The sent_time of this RecipientFormData.  # noqa: E501
238        :type: str
239        """
240
241        self._sent_time = sent_time
242
243    @property
244    def signed_time(self):
245        """Gets the signed_time of this RecipientFormData.  # noqa: E501
246
247          # noqa: E501
248
249        :return: The signed_time of this RecipientFormData.  # noqa: E501
250        :rtype: str
251        """
252        return self._signed_time
253
254    @signed_time.setter
255    def signed_time(self, signed_time):
256        """Sets the signed_time of this RecipientFormData.
257
258          # noqa: E501
259
260        :param signed_time: The signed_time of this RecipientFormData.  # noqa: E501
261        :type: str
262        """
263
264        self._signed_time = signed_time
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(RecipientFormData, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, RecipientFormData):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, RecipientFormData):
311            return True
312
313        return self.to_dict() != other.to_dict()
class RecipientFormData:
 23class RecipientFormData(object):
 24    """NOTE: This class is auto generated by the swagger code generator program.
 25
 26    Do not edit the class manually.
 27    """
 28
 29    """
 30    Attributes:
 31      swagger_types (dict): The key is attribute name
 32                            and the value is attribute type.
 33      attribute_map (dict): The key is attribute name
 34                            and the value is json key in definition.
 35    """
 36    swagger_types = {
 37        'declined_time': 'str',
 38        'delivered_time': 'str',
 39        'email': 'str',
 40        'form_data': 'list[FormDataItem]',
 41        'name': 'str',
 42        'recipient_id': 'str',
 43        'sent_time': 'str',
 44        'signed_time': 'str'
 45    }
 46
 47    attribute_map = {
 48        'declined_time': 'DeclinedTime',
 49        'delivered_time': 'DeliveredTime',
 50        'email': 'email',
 51        'form_data': 'formData',
 52        'name': 'name',
 53        'recipient_id': 'recipientId',
 54        'sent_time': 'SentTime',
 55        'signed_time': 'SignedTime'
 56    }
 57
 58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 59        """RecipientFormData - a model defined in Swagger"""  # noqa: E501
 60        if _configuration is None:
 61            _configuration = Configuration()
 62        self._configuration = _configuration
 63
 64        self._declined_time = None
 65        self._delivered_time = None
 66        self._email = None
 67        self._form_data = None
 68        self._name = None
 69        self._recipient_id = None
 70        self._sent_time = None
 71        self._signed_time = None
 72        self.discriminator = None
 73
 74        setattr(self, "_{}".format('declined_time'), kwargs.get('declined_time', None))
 75        setattr(self, "_{}".format('delivered_time'), kwargs.get('delivered_time', None))
 76        setattr(self, "_{}".format('email'), kwargs.get('email', None))
 77        setattr(self, "_{}".format('form_data'), kwargs.get('form_data', None))
 78        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 79        setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
 80        setattr(self, "_{}".format('sent_time'), kwargs.get('sent_time', None))
 81        setattr(self, "_{}".format('signed_time'), kwargs.get('signed_time', None))
 82
 83    @property
 84    def declined_time(self):
 85        """Gets the declined_time of this RecipientFormData.  # noqa: E501
 86
 87          # noqa: E501
 88
 89        :return: The declined_time of this RecipientFormData.  # noqa: E501
 90        :rtype: str
 91        """
 92        return self._declined_time
 93
 94    @declined_time.setter
 95    def declined_time(self, declined_time):
 96        """Sets the declined_time of this RecipientFormData.
 97
 98          # noqa: E501
 99
100        :param declined_time: The declined_time of this RecipientFormData.  # noqa: E501
101        :type: str
102        """
103
104        self._declined_time = declined_time
105
106    @property
107    def delivered_time(self):
108        """Gets the delivered_time of this RecipientFormData.  # noqa: E501
109
110          # noqa: E501
111
112        :return: The delivered_time of this RecipientFormData.  # noqa: E501
113        :rtype: str
114        """
115        return self._delivered_time
116
117    @delivered_time.setter
118    def delivered_time(self, delivered_time):
119        """Sets the delivered_time of this RecipientFormData.
120
121          # noqa: E501
122
123        :param delivered_time: The delivered_time of this RecipientFormData.  # noqa: E501
124        :type: str
125        """
126
127        self._delivered_time = delivered_time
128
129    @property
130    def email(self):
131        """Gets the email of this RecipientFormData.  # noqa: E501
132
133          # noqa: E501
134
135        :return: The email of this RecipientFormData.  # noqa: E501
136        :rtype: str
137        """
138        return self._email
139
140    @email.setter
141    def email(self, email):
142        """Sets the email of this RecipientFormData.
143
144          # noqa: E501
145
146        :param email: The email of this RecipientFormData.  # noqa: E501
147        :type: str
148        """
149
150        self._email = email
151
152    @property
153    def form_data(self):
154        """Gets the form_data of this RecipientFormData.  # noqa: E501
155
156          # noqa: E501
157
158        :return: The form_data of this RecipientFormData.  # noqa: E501
159        :rtype: list[FormDataItem]
160        """
161        return self._form_data
162
163    @form_data.setter
164    def form_data(self, form_data):
165        """Sets the form_data of this RecipientFormData.
166
167          # noqa: E501
168
169        :param form_data: The form_data of this RecipientFormData.  # noqa: E501
170        :type: list[FormDataItem]
171        """
172
173        self._form_data = form_data
174
175    @property
176    def name(self):
177        """Gets the name of this RecipientFormData.  # noqa: E501
178
179          # noqa: E501
180
181        :return: The name of this RecipientFormData.  # noqa: E501
182        :rtype: str
183        """
184        return self._name
185
186    @name.setter
187    def name(self, name):
188        """Sets the name of this RecipientFormData.
189
190          # noqa: E501
191
192        :param name: The name of this RecipientFormData.  # noqa: E501
193        :type: str
194        """
195
196        self._name = name
197
198    @property
199    def recipient_id(self):
200        """Gets the recipient_id of this RecipientFormData.  # noqa: E501
201
202        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
203
204        :return: The recipient_id of this RecipientFormData.  # noqa: E501
205        :rtype: str
206        """
207        return self._recipient_id
208
209    @recipient_id.setter
210    def recipient_id(self, recipient_id):
211        """Sets the recipient_id of this RecipientFormData.
212
213        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
214
215        :param recipient_id: The recipient_id of this RecipientFormData.  # noqa: E501
216        :type: str
217        """
218
219        self._recipient_id = recipient_id
220
221    @property
222    def sent_time(self):
223        """Gets the sent_time of this RecipientFormData.  # noqa: E501
224
225          # noqa: E501
226
227        :return: The sent_time of this RecipientFormData.  # noqa: E501
228        :rtype: str
229        """
230        return self._sent_time
231
232    @sent_time.setter
233    def sent_time(self, sent_time):
234        """Sets the sent_time of this RecipientFormData.
235
236          # noqa: E501
237
238        :param sent_time: The sent_time of this RecipientFormData.  # noqa: E501
239        :type: str
240        """
241
242        self._sent_time = sent_time
243
244    @property
245    def signed_time(self):
246        """Gets the signed_time of this RecipientFormData.  # noqa: E501
247
248          # noqa: E501
249
250        :return: The signed_time of this RecipientFormData.  # noqa: E501
251        :rtype: str
252        """
253        return self._signed_time
254
255    @signed_time.setter
256    def signed_time(self, signed_time):
257        """Sets the signed_time of this RecipientFormData.
258
259          # noqa: E501
260
261        :param signed_time: The signed_time of this RecipientFormData.  # noqa: E501
262        :type: str
263        """
264
265        self._signed_time = signed_time
266
267    def to_dict(self):
268        """Returns the model properties as a dict"""
269        result = {}
270
271        for attr, _ in six.iteritems(self.swagger_types):
272            value = getattr(self, attr)
273            if isinstance(value, list):
274                result[attr] = list(map(
275                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
276                    value
277                ))
278            elif hasattr(value, "to_dict"):
279                result[attr] = value.to_dict()
280            elif isinstance(value, dict):
281                result[attr] = dict(map(
282                    lambda item: (item[0], item[1].to_dict())
283                    if hasattr(item[1], "to_dict") else item,
284                    value.items()
285                ))
286            else:
287                result[attr] = value
288        if issubclass(RecipientFormData, dict):
289            for key, value in self.items():
290                result[key] = value
291
292        return result
293
294    def to_str(self):
295        """Returns the string representation of the model"""
296        return pprint.pformat(self.to_dict())
297
298    def __repr__(self):
299        """For `print` and `pprint`"""
300        return self.to_str()
301
302    def __eq__(self, other):
303        """Returns true if both objects are equal"""
304        if not isinstance(other, RecipientFormData):
305            return False
306
307        return self.to_dict() == other.to_dict()
308
309    def __ne__(self, other):
310        """Returns true if both objects are not equal"""
311        if not isinstance(other, RecipientFormData):
312            return True
313
314        return self.to_dict() != other.to_dict()

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

RecipientFormData(_configuration=None, **kwargs)
58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
59        """RecipientFormData - a model defined in Swagger"""  # noqa: E501
60        if _configuration is None:
61            _configuration = Configuration()
62        self._configuration = _configuration
63
64        self._declined_time = None
65        self._delivered_time = None
66        self._email = None
67        self._form_data = None
68        self._name = None
69        self._recipient_id = None
70        self._sent_time = None
71        self._signed_time = None
72        self.discriminator = None
73
74        setattr(self, "_{}".format('declined_time'), kwargs.get('declined_time', None))
75        setattr(self, "_{}".format('delivered_time'), kwargs.get('delivered_time', None))
76        setattr(self, "_{}".format('email'), kwargs.get('email', None))
77        setattr(self, "_{}".format('form_data'), kwargs.get('form_data', None))
78        setattr(self, "_{}".format('name'), kwargs.get('name', None))
79        setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
80        setattr(self, "_{}".format('sent_time'), kwargs.get('sent_time', None))
81        setattr(self, "_{}".format('signed_time'), kwargs.get('signed_time', None))

RecipientFormData - a model defined in Swagger

swagger_types = {'declined_time': 'str', 'delivered_time': 'str', 'email': 'str', 'form_data': 'list[FormDataItem]', 'name': 'str', 'recipient_id': 'str', 'sent_time': 'str', 'signed_time': 'str'}
attribute_map = {'declined_time': 'DeclinedTime', 'delivered_time': 'DeliveredTime', 'email': 'email', 'form_data': 'formData', 'name': 'name', 'recipient_id': 'recipientId', 'sent_time': 'SentTime', 'signed_time': 'SignedTime'}
declined_time

Gets the declined_time of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The declined_time of this RecipientFormData. # noqa: E501

delivered_time

Gets the delivered_time of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The delivered_time of this RecipientFormData. # noqa: E501

email

Gets the email of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The email of this RecipientFormData. # noqa: E501

form_data

Gets the form_data of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The form_data of this RecipientFormData. # noqa: E501

name

Gets the name of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The name of this RecipientFormData. # noqa: E501

recipient_id

Gets the recipient_id of this RecipientFormData. # noqa: E501

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501

Returns

The recipient_id of this RecipientFormData. # noqa: E501

sent_time

Gets the sent_time of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The sent_time of this RecipientFormData. # noqa: E501

signed_time

Gets the signed_time of this RecipientFormData. # noqa: E501

# noqa: E501

Returns

The signed_time of this RecipientFormData. # noqa: E501

def to_dict(self)
267    def to_dict(self):
268        """Returns the model properties as a dict"""
269        result = {}
270
271        for attr, _ in six.iteritems(self.swagger_types):
272            value = getattr(self, attr)
273            if isinstance(value, list):
274                result[attr] = list(map(
275                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
276                    value
277                ))
278            elif hasattr(value, "to_dict"):
279                result[attr] = value.to_dict()
280            elif isinstance(value, dict):
281                result[attr] = dict(map(
282                    lambda item: (item[0], item[1].to_dict())
283                    if hasattr(item[1], "to_dict") else item,
284                    value.items()
285                ))
286            else:
287                result[attr] = value
288        if issubclass(RecipientFormData, dict):
289            for key, value in self.items():
290                result[key] = value
291
292        return result

Returns the model properties as a dict

def to_str(self)
294    def to_str(self):
295        """Returns the string representation of the model"""
296        return pprint.pformat(self.to_dict())

Returns the string representation of the model