docusign_esign.models.stamp

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 Stamp(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        'adopted_date_time': 'str',
 37        'created_date_time': 'str',
 38        'custom_field': 'str',
 39        'date_stamp_properties': 'DateStampProperties',
 40        'disallow_user_resize_stamp': 'str',
 41        'error_details': 'ErrorDetails',
 42        'external_id': 'str',
 43        'image_base64': 'str',
 44        'image_type': 'str',
 45        'last_modified_date_time': 'str',
 46        'phonetic_name': 'str',
 47        'signature_name': 'str',
 48        'stamp_format': 'str',
 49        'stamp_image_uri': 'str',
 50        'stamp_size_mm': 'str',
 51        'status': 'str'
 52    }
 53
 54    attribute_map = {
 55        'adopted_date_time': 'adoptedDateTime',
 56        'created_date_time': 'createdDateTime',
 57        'custom_field': 'customField',
 58        'date_stamp_properties': 'dateStampProperties',
 59        'disallow_user_resize_stamp': 'disallowUserResizeStamp',
 60        'error_details': 'errorDetails',
 61        'external_id': 'externalID',
 62        'image_base64': 'imageBase64',
 63        'image_type': 'imageType',
 64        'last_modified_date_time': 'lastModifiedDateTime',
 65        'phonetic_name': 'phoneticName',
 66        'signature_name': 'signatureName',
 67        'stamp_format': 'stampFormat',
 68        'stamp_image_uri': 'stampImageUri',
 69        'stamp_size_mm': 'stampSizeMM',
 70        'status': 'status'
 71    }
 72
 73    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 74        """Stamp - a model defined in Swagger"""  # noqa: E501
 75        if _configuration is None:
 76            _configuration = Configuration()
 77        self._configuration = _configuration
 78
 79        self._adopted_date_time = None
 80        self._created_date_time = None
 81        self._custom_field = None
 82        self._date_stamp_properties = None
 83        self._disallow_user_resize_stamp = None
 84        self._error_details = None
 85        self._external_id = None
 86        self._image_base64 = None
 87        self._image_type = None
 88        self._last_modified_date_time = None
 89        self._phonetic_name = None
 90        self._signature_name = None
 91        self._stamp_format = None
 92        self._stamp_image_uri = None
 93        self._stamp_size_mm = None
 94        self._status = None
 95        self.discriminator = None
 96
 97        setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None))
 98        setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None))
 99        setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None))
100        setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None))
101        setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None))
102        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
103        setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None))
104        setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None))
105        setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None))
106        setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None))
107        setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None))
108        setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None))
109        setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None))
110        setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None))
111        setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None))
112        setattr(self, "_{}".format('status'), kwargs.get('status', None))
113
114    @property
115    def adopted_date_time(self):
116        """Gets the adopted_date_time of this Stamp.  # noqa: E501
117
118          # noqa: E501
119
120        :return: The adopted_date_time of this Stamp.  # noqa: E501
121        :rtype: str
122        """
123        return self._adopted_date_time
124
125    @adopted_date_time.setter
126    def adopted_date_time(self, adopted_date_time):
127        """Sets the adopted_date_time of this Stamp.
128
129          # noqa: E501
130
131        :param adopted_date_time: The adopted_date_time of this Stamp.  # noqa: E501
132        :type: str
133        """
134
135        self._adopted_date_time = adopted_date_time
136
137    @property
138    def created_date_time(self):
139        """Gets the created_date_time of this Stamp.  # noqa: E501
140
141        Indicates the date and time the item was created.  # noqa: E501
142
143        :return: The created_date_time of this Stamp.  # noqa: E501
144        :rtype: str
145        """
146        return self._created_date_time
147
148    @created_date_time.setter
149    def created_date_time(self, created_date_time):
150        """Sets the created_date_time of this Stamp.
151
152        Indicates the date and time the item was created.  # noqa: E501
153
154        :param created_date_time: The created_date_time of this Stamp.  # noqa: E501
155        :type: str
156        """
157
158        self._created_date_time = created_date_time
159
160    @property
161    def custom_field(self):
162        """Gets the custom_field of this Stamp.  # noqa: E501
163
164          # noqa: E501
165
166        :return: The custom_field of this Stamp.  # noqa: E501
167        :rtype: str
168        """
169        return self._custom_field
170
171    @custom_field.setter
172    def custom_field(self, custom_field):
173        """Sets the custom_field of this Stamp.
174
175          # noqa: E501
176
177        :param custom_field: The custom_field of this Stamp.  # noqa: E501
178        :type: str
179        """
180
181        self._custom_field = custom_field
182
183    @property
184    def date_stamp_properties(self):
185        """Gets the date_stamp_properties of this Stamp.  # noqa: E501
186
187        Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.  # noqa: E501
188
189        :return: The date_stamp_properties of this Stamp.  # noqa: E501
190        :rtype: DateStampProperties
191        """
192        return self._date_stamp_properties
193
194    @date_stamp_properties.setter
195    def date_stamp_properties(self, date_stamp_properties):
196        """Sets the date_stamp_properties of this Stamp.
197
198        Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.  # noqa: E501
199
200        :param date_stamp_properties: The date_stamp_properties of this Stamp.  # noqa: E501
201        :type: DateStampProperties
202        """
203
204        self._date_stamp_properties = date_stamp_properties
205
206    @property
207    def disallow_user_resize_stamp(self):
208        """Gets the disallow_user_resize_stamp of this Stamp.  # noqa: E501
209
210          # noqa: E501
211
212        :return: The disallow_user_resize_stamp of this Stamp.  # noqa: E501
213        :rtype: str
214        """
215        return self._disallow_user_resize_stamp
216
217    @disallow_user_resize_stamp.setter
218    def disallow_user_resize_stamp(self, disallow_user_resize_stamp):
219        """Sets the disallow_user_resize_stamp of this Stamp.
220
221          # noqa: E501
222
223        :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this Stamp.  # noqa: E501
224        :type: str
225        """
226
227        self._disallow_user_resize_stamp = disallow_user_resize_stamp
228
229    @property
230    def error_details(self):
231        """Gets the error_details of this Stamp.  # noqa: E501
232
233        Array or errors.  # noqa: E501
234
235        :return: The error_details of this Stamp.  # noqa: E501
236        :rtype: ErrorDetails
237        """
238        return self._error_details
239
240    @error_details.setter
241    def error_details(self, error_details):
242        """Sets the error_details of this Stamp.
243
244        Array or errors.  # noqa: E501
245
246        :param error_details: The error_details of this Stamp.  # noqa: E501
247        :type: ErrorDetails
248        """
249
250        self._error_details = error_details
251
252    @property
253    def external_id(self):
254        """Gets the external_id of this Stamp.  # noqa: E501
255
256          # noqa: E501
257
258        :return: The external_id of this Stamp.  # noqa: E501
259        :rtype: str
260        """
261        return self._external_id
262
263    @external_id.setter
264    def external_id(self, external_id):
265        """Sets the external_id of this Stamp.
266
267          # noqa: E501
268
269        :param external_id: The external_id of this Stamp.  # noqa: E501
270        :type: str
271        """
272
273        self._external_id = external_id
274
275    @property
276    def image_base64(self):
277        """Gets the image_base64 of this Stamp.  # noqa: E501
278
279          # noqa: E501
280
281        :return: The image_base64 of this Stamp.  # noqa: E501
282        :rtype: str
283        """
284        return self._image_base64
285
286    @image_base64.setter
287    def image_base64(self, image_base64):
288        """Sets the image_base64 of this Stamp.
289
290          # noqa: E501
291
292        :param image_base64: The image_base64 of this Stamp.  # noqa: E501
293        :type: str
294        """
295
296        self._image_base64 = image_base64
297
298    @property
299    def image_type(self):
300        """Gets the image_type of this Stamp.  # noqa: E501
301
302          # noqa: E501
303
304        :return: The image_type of this Stamp.  # noqa: E501
305        :rtype: str
306        """
307        return self._image_type
308
309    @image_type.setter
310    def image_type(self, image_type):
311        """Sets the image_type of this Stamp.
312
313          # noqa: E501
314
315        :param image_type: The image_type of this Stamp.  # noqa: E501
316        :type: str
317        """
318
319        self._image_type = image_type
320
321    @property
322    def last_modified_date_time(self):
323        """Gets the last_modified_date_time of this Stamp.  # noqa: E501
324
325        The date and time the item was last modified.  # noqa: E501
326
327        :return: The last_modified_date_time of this Stamp.  # noqa: E501
328        :rtype: str
329        """
330        return self._last_modified_date_time
331
332    @last_modified_date_time.setter
333    def last_modified_date_time(self, last_modified_date_time):
334        """Sets the last_modified_date_time of this Stamp.
335
336        The date and time the item was last modified.  # noqa: E501
337
338        :param last_modified_date_time: The last_modified_date_time of this Stamp.  # noqa: E501
339        :type: str
340        """
341
342        self._last_modified_date_time = last_modified_date_time
343
344    @property
345    def phonetic_name(self):
346        """Gets the phonetic_name of this Stamp.  # noqa: E501
347
348          # noqa: E501
349
350        :return: The phonetic_name of this Stamp.  # noqa: E501
351        :rtype: str
352        """
353        return self._phonetic_name
354
355    @phonetic_name.setter
356    def phonetic_name(self, phonetic_name):
357        """Sets the phonetic_name of this Stamp.
358
359          # noqa: E501
360
361        :param phonetic_name: The phonetic_name of this Stamp.  # noqa: E501
362        :type: str
363        """
364
365        self._phonetic_name = phonetic_name
366
367    @property
368    def signature_name(self):
369        """Gets the signature_name of this Stamp.  # noqa: E501
370
371        Specifies the user signature name.  # noqa: E501
372
373        :return: The signature_name of this Stamp.  # noqa: E501
374        :rtype: str
375        """
376        return self._signature_name
377
378    @signature_name.setter
379    def signature_name(self, signature_name):
380        """Sets the signature_name of this Stamp.
381
382        Specifies the user signature name.  # noqa: E501
383
384        :param signature_name: The signature_name of this Stamp.  # noqa: E501
385        :type: str
386        """
387
388        self._signature_name = signature_name
389
390    @property
391    def stamp_format(self):
392        """Gets the stamp_format of this Stamp.  # noqa: E501
393
394          # noqa: E501
395
396        :return: The stamp_format of this Stamp.  # noqa: E501
397        :rtype: str
398        """
399        return self._stamp_format
400
401    @stamp_format.setter
402    def stamp_format(self, stamp_format):
403        """Sets the stamp_format of this Stamp.
404
405          # noqa: E501
406
407        :param stamp_format: The stamp_format of this Stamp.  # noqa: E501
408        :type: str
409        """
410
411        self._stamp_format = stamp_format
412
413    @property
414    def stamp_image_uri(self):
415        """Gets the stamp_image_uri of this Stamp.  # noqa: E501
416
417          # noqa: E501
418
419        :return: The stamp_image_uri of this Stamp.  # noqa: E501
420        :rtype: str
421        """
422        return self._stamp_image_uri
423
424    @stamp_image_uri.setter
425    def stamp_image_uri(self, stamp_image_uri):
426        """Sets the stamp_image_uri of this Stamp.
427
428          # noqa: E501
429
430        :param stamp_image_uri: The stamp_image_uri of this Stamp.  # noqa: E501
431        :type: str
432        """
433
434        self._stamp_image_uri = stamp_image_uri
435
436    @property
437    def stamp_size_mm(self):
438        """Gets the stamp_size_mm of this Stamp.  # noqa: E501
439
440          # noqa: E501
441
442        :return: The stamp_size_mm of this Stamp.  # noqa: E501
443        :rtype: str
444        """
445        return self._stamp_size_mm
446
447    @stamp_size_mm.setter
448    def stamp_size_mm(self, stamp_size_mm):
449        """Sets the stamp_size_mm of this Stamp.
450
451          # noqa: E501
452
453        :param stamp_size_mm: The stamp_size_mm of this Stamp.  # noqa: E501
454        :type: str
455        """
456
457        self._stamp_size_mm = stamp_size_mm
458
459    @property
460    def status(self):
461        """Gets the status of this Stamp.  # noqa: E501
462
463        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
464
465        :return: The status of this Stamp.  # noqa: E501
466        :rtype: str
467        """
468        return self._status
469
470    @status.setter
471    def status(self, status):
472        """Sets the status of this Stamp.
473
474        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
475
476        :param status: The status of this Stamp.  # noqa: E501
477        :type: str
478        """
479
480        self._status = status
481
482    def to_dict(self):
483        """Returns the model properties as a dict"""
484        result = {}
485
486        for attr, _ in six.iteritems(self.swagger_types):
487            value = getattr(self, attr)
488            if isinstance(value, list):
489                result[attr] = list(map(
490                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
491                    value
492                ))
493            elif hasattr(value, "to_dict"):
494                result[attr] = value.to_dict()
495            elif isinstance(value, dict):
496                result[attr] = dict(map(
497                    lambda item: (item[0], item[1].to_dict())
498                    if hasattr(item[1], "to_dict") else item,
499                    value.items()
500                ))
501            else:
502                result[attr] = value
503        if issubclass(Stamp, dict):
504            for key, value in self.items():
505                result[key] = value
506
507        return result
508
509    def to_str(self):
510        """Returns the string representation of the model"""
511        return pprint.pformat(self.to_dict())
512
513    def __repr__(self):
514        """For `print` and `pprint`"""
515        return self.to_str()
516
517    def __eq__(self, other):
518        """Returns true if both objects are equal"""
519        if not isinstance(other, Stamp):
520            return False
521
522        return self.to_dict() == other.to_dict()
523
524    def __ne__(self, other):
525        """Returns true if both objects are not equal"""
526        if not isinstance(other, Stamp):
527            return True
528
529        return self.to_dict() != other.to_dict()
class Stamp:
 23class Stamp(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        'adopted_date_time': 'str',
 38        'created_date_time': 'str',
 39        'custom_field': 'str',
 40        'date_stamp_properties': 'DateStampProperties',
 41        'disallow_user_resize_stamp': 'str',
 42        'error_details': 'ErrorDetails',
 43        'external_id': 'str',
 44        'image_base64': 'str',
 45        'image_type': 'str',
 46        'last_modified_date_time': 'str',
 47        'phonetic_name': 'str',
 48        'signature_name': 'str',
 49        'stamp_format': 'str',
 50        'stamp_image_uri': 'str',
 51        'stamp_size_mm': 'str',
 52        'status': 'str'
 53    }
 54
 55    attribute_map = {
 56        'adopted_date_time': 'adoptedDateTime',
 57        'created_date_time': 'createdDateTime',
 58        'custom_field': 'customField',
 59        'date_stamp_properties': 'dateStampProperties',
 60        'disallow_user_resize_stamp': 'disallowUserResizeStamp',
 61        'error_details': 'errorDetails',
 62        'external_id': 'externalID',
 63        'image_base64': 'imageBase64',
 64        'image_type': 'imageType',
 65        'last_modified_date_time': 'lastModifiedDateTime',
 66        'phonetic_name': 'phoneticName',
 67        'signature_name': 'signatureName',
 68        'stamp_format': 'stampFormat',
 69        'stamp_image_uri': 'stampImageUri',
 70        'stamp_size_mm': 'stampSizeMM',
 71        'status': 'status'
 72    }
 73
 74    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 75        """Stamp - a model defined in Swagger"""  # noqa: E501
 76        if _configuration is None:
 77            _configuration = Configuration()
 78        self._configuration = _configuration
 79
 80        self._adopted_date_time = None
 81        self._created_date_time = None
 82        self._custom_field = None
 83        self._date_stamp_properties = None
 84        self._disallow_user_resize_stamp = None
 85        self._error_details = None
 86        self._external_id = None
 87        self._image_base64 = None
 88        self._image_type = None
 89        self._last_modified_date_time = None
 90        self._phonetic_name = None
 91        self._signature_name = None
 92        self._stamp_format = None
 93        self._stamp_image_uri = None
 94        self._stamp_size_mm = None
 95        self._status = None
 96        self.discriminator = None
 97
 98        setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None))
 99        setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None))
100        setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None))
101        setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None))
102        setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None))
103        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
104        setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None))
105        setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None))
106        setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None))
107        setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None))
108        setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None))
109        setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None))
110        setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None))
111        setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None))
112        setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None))
113        setattr(self, "_{}".format('status'), kwargs.get('status', None))
114
115    @property
116    def adopted_date_time(self):
117        """Gets the adopted_date_time of this Stamp.  # noqa: E501
118
119          # noqa: E501
120
121        :return: The adopted_date_time of this Stamp.  # noqa: E501
122        :rtype: str
123        """
124        return self._adopted_date_time
125
126    @adopted_date_time.setter
127    def adopted_date_time(self, adopted_date_time):
128        """Sets the adopted_date_time of this Stamp.
129
130          # noqa: E501
131
132        :param adopted_date_time: The adopted_date_time of this Stamp.  # noqa: E501
133        :type: str
134        """
135
136        self._adopted_date_time = adopted_date_time
137
138    @property
139    def created_date_time(self):
140        """Gets the created_date_time of this Stamp.  # noqa: E501
141
142        Indicates the date and time the item was created.  # noqa: E501
143
144        :return: The created_date_time of this Stamp.  # noqa: E501
145        :rtype: str
146        """
147        return self._created_date_time
148
149    @created_date_time.setter
150    def created_date_time(self, created_date_time):
151        """Sets the created_date_time of this Stamp.
152
153        Indicates the date and time the item was created.  # noqa: E501
154
155        :param created_date_time: The created_date_time of this Stamp.  # noqa: E501
156        :type: str
157        """
158
159        self._created_date_time = created_date_time
160
161    @property
162    def custom_field(self):
163        """Gets the custom_field of this Stamp.  # noqa: E501
164
165          # noqa: E501
166
167        :return: The custom_field of this Stamp.  # noqa: E501
168        :rtype: str
169        """
170        return self._custom_field
171
172    @custom_field.setter
173    def custom_field(self, custom_field):
174        """Sets the custom_field of this Stamp.
175
176          # noqa: E501
177
178        :param custom_field: The custom_field of this Stamp.  # noqa: E501
179        :type: str
180        """
181
182        self._custom_field = custom_field
183
184    @property
185    def date_stamp_properties(self):
186        """Gets the date_stamp_properties of this Stamp.  # noqa: E501
187
188        Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.  # noqa: E501
189
190        :return: The date_stamp_properties of this Stamp.  # noqa: E501
191        :rtype: DateStampProperties
192        """
193        return self._date_stamp_properties
194
195    @date_stamp_properties.setter
196    def date_stamp_properties(self, date_stamp_properties):
197        """Sets the date_stamp_properties of this Stamp.
198
199        Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.  This property contains the following information about the central rectangle:  - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.  # noqa: E501
200
201        :param date_stamp_properties: The date_stamp_properties of this Stamp.  # noqa: E501
202        :type: DateStampProperties
203        """
204
205        self._date_stamp_properties = date_stamp_properties
206
207    @property
208    def disallow_user_resize_stamp(self):
209        """Gets the disallow_user_resize_stamp of this Stamp.  # noqa: E501
210
211          # noqa: E501
212
213        :return: The disallow_user_resize_stamp of this Stamp.  # noqa: E501
214        :rtype: str
215        """
216        return self._disallow_user_resize_stamp
217
218    @disallow_user_resize_stamp.setter
219    def disallow_user_resize_stamp(self, disallow_user_resize_stamp):
220        """Sets the disallow_user_resize_stamp of this Stamp.
221
222          # noqa: E501
223
224        :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this Stamp.  # noqa: E501
225        :type: str
226        """
227
228        self._disallow_user_resize_stamp = disallow_user_resize_stamp
229
230    @property
231    def error_details(self):
232        """Gets the error_details of this Stamp.  # noqa: E501
233
234        Array or errors.  # noqa: E501
235
236        :return: The error_details of this Stamp.  # noqa: E501
237        :rtype: ErrorDetails
238        """
239        return self._error_details
240
241    @error_details.setter
242    def error_details(self, error_details):
243        """Sets the error_details of this Stamp.
244
245        Array or errors.  # noqa: E501
246
247        :param error_details: The error_details of this Stamp.  # noqa: E501
248        :type: ErrorDetails
249        """
250
251        self._error_details = error_details
252
253    @property
254    def external_id(self):
255        """Gets the external_id of this Stamp.  # noqa: E501
256
257          # noqa: E501
258
259        :return: The external_id of this Stamp.  # noqa: E501
260        :rtype: str
261        """
262        return self._external_id
263
264    @external_id.setter
265    def external_id(self, external_id):
266        """Sets the external_id of this Stamp.
267
268          # noqa: E501
269
270        :param external_id: The external_id of this Stamp.  # noqa: E501
271        :type: str
272        """
273
274        self._external_id = external_id
275
276    @property
277    def image_base64(self):
278        """Gets the image_base64 of this Stamp.  # noqa: E501
279
280          # noqa: E501
281
282        :return: The image_base64 of this Stamp.  # noqa: E501
283        :rtype: str
284        """
285        return self._image_base64
286
287    @image_base64.setter
288    def image_base64(self, image_base64):
289        """Sets the image_base64 of this Stamp.
290
291          # noqa: E501
292
293        :param image_base64: The image_base64 of this Stamp.  # noqa: E501
294        :type: str
295        """
296
297        self._image_base64 = image_base64
298
299    @property
300    def image_type(self):
301        """Gets the image_type of this Stamp.  # noqa: E501
302
303          # noqa: E501
304
305        :return: The image_type of this Stamp.  # noqa: E501
306        :rtype: str
307        """
308        return self._image_type
309
310    @image_type.setter
311    def image_type(self, image_type):
312        """Sets the image_type of this Stamp.
313
314          # noqa: E501
315
316        :param image_type: The image_type of this Stamp.  # noqa: E501
317        :type: str
318        """
319
320        self._image_type = image_type
321
322    @property
323    def last_modified_date_time(self):
324        """Gets the last_modified_date_time of this Stamp.  # noqa: E501
325
326        The date and time the item was last modified.  # noqa: E501
327
328        :return: The last_modified_date_time of this Stamp.  # noqa: E501
329        :rtype: str
330        """
331        return self._last_modified_date_time
332
333    @last_modified_date_time.setter
334    def last_modified_date_time(self, last_modified_date_time):
335        """Sets the last_modified_date_time of this Stamp.
336
337        The date and time the item was last modified.  # noqa: E501
338
339        :param last_modified_date_time: The last_modified_date_time of this Stamp.  # noqa: E501
340        :type: str
341        """
342
343        self._last_modified_date_time = last_modified_date_time
344
345    @property
346    def phonetic_name(self):
347        """Gets the phonetic_name of this Stamp.  # noqa: E501
348
349          # noqa: E501
350
351        :return: The phonetic_name of this Stamp.  # noqa: E501
352        :rtype: str
353        """
354        return self._phonetic_name
355
356    @phonetic_name.setter
357    def phonetic_name(self, phonetic_name):
358        """Sets the phonetic_name of this Stamp.
359
360          # noqa: E501
361
362        :param phonetic_name: The phonetic_name of this Stamp.  # noqa: E501
363        :type: str
364        """
365
366        self._phonetic_name = phonetic_name
367
368    @property
369    def signature_name(self):
370        """Gets the signature_name of this Stamp.  # noqa: E501
371
372        Specifies the user signature name.  # noqa: E501
373
374        :return: The signature_name of this Stamp.  # noqa: E501
375        :rtype: str
376        """
377        return self._signature_name
378
379    @signature_name.setter
380    def signature_name(self, signature_name):
381        """Sets the signature_name of this Stamp.
382
383        Specifies the user signature name.  # noqa: E501
384
385        :param signature_name: The signature_name of this Stamp.  # noqa: E501
386        :type: str
387        """
388
389        self._signature_name = signature_name
390
391    @property
392    def stamp_format(self):
393        """Gets the stamp_format of this Stamp.  # noqa: E501
394
395          # noqa: E501
396
397        :return: The stamp_format of this Stamp.  # noqa: E501
398        :rtype: str
399        """
400        return self._stamp_format
401
402    @stamp_format.setter
403    def stamp_format(self, stamp_format):
404        """Sets the stamp_format of this Stamp.
405
406          # noqa: E501
407
408        :param stamp_format: The stamp_format of this Stamp.  # noqa: E501
409        :type: str
410        """
411
412        self._stamp_format = stamp_format
413
414    @property
415    def stamp_image_uri(self):
416        """Gets the stamp_image_uri of this Stamp.  # noqa: E501
417
418          # noqa: E501
419
420        :return: The stamp_image_uri of this Stamp.  # noqa: E501
421        :rtype: str
422        """
423        return self._stamp_image_uri
424
425    @stamp_image_uri.setter
426    def stamp_image_uri(self, stamp_image_uri):
427        """Sets the stamp_image_uri of this Stamp.
428
429          # noqa: E501
430
431        :param stamp_image_uri: The stamp_image_uri of this Stamp.  # noqa: E501
432        :type: str
433        """
434
435        self._stamp_image_uri = stamp_image_uri
436
437    @property
438    def stamp_size_mm(self):
439        """Gets the stamp_size_mm of this Stamp.  # noqa: E501
440
441          # noqa: E501
442
443        :return: The stamp_size_mm of this Stamp.  # noqa: E501
444        :rtype: str
445        """
446        return self._stamp_size_mm
447
448    @stamp_size_mm.setter
449    def stamp_size_mm(self, stamp_size_mm):
450        """Sets the stamp_size_mm of this Stamp.
451
452          # noqa: E501
453
454        :param stamp_size_mm: The stamp_size_mm of this Stamp.  # noqa: E501
455        :type: str
456        """
457
458        self._stamp_size_mm = stamp_size_mm
459
460    @property
461    def status(self):
462        """Gets the status of this Stamp.  # noqa: E501
463
464        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
465
466        :return: The status of this Stamp.  # noqa: E501
467        :rtype: str
468        """
469        return self._status
470
471    @status.setter
472    def status(self, status):
473        """Sets the status of this Stamp.
474
475        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
476
477        :param status: The status of this Stamp.  # noqa: E501
478        :type: str
479        """
480
481        self._status = status
482
483    def to_dict(self):
484        """Returns the model properties as a dict"""
485        result = {}
486
487        for attr, _ in six.iteritems(self.swagger_types):
488            value = getattr(self, attr)
489            if isinstance(value, list):
490                result[attr] = list(map(
491                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
492                    value
493                ))
494            elif hasattr(value, "to_dict"):
495                result[attr] = value.to_dict()
496            elif isinstance(value, dict):
497                result[attr] = dict(map(
498                    lambda item: (item[0], item[1].to_dict())
499                    if hasattr(item[1], "to_dict") else item,
500                    value.items()
501                ))
502            else:
503                result[attr] = value
504        if issubclass(Stamp, dict):
505            for key, value in self.items():
506                result[key] = value
507
508        return result
509
510    def to_str(self):
511        """Returns the string representation of the model"""
512        return pprint.pformat(self.to_dict())
513
514    def __repr__(self):
515        """For `print` and `pprint`"""
516        return self.to_str()
517
518    def __eq__(self, other):
519        """Returns true if both objects are equal"""
520        if not isinstance(other, Stamp):
521            return False
522
523        return self.to_dict() == other.to_dict()
524
525    def __ne__(self, other):
526        """Returns true if both objects are not equal"""
527        if not isinstance(other, Stamp):
528            return True
529
530        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.

Stamp(_configuration=None, **kwargs)
 74    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 75        """Stamp - a model defined in Swagger"""  # noqa: E501
 76        if _configuration is None:
 77            _configuration = Configuration()
 78        self._configuration = _configuration
 79
 80        self._adopted_date_time = None
 81        self._created_date_time = None
 82        self._custom_field = None
 83        self._date_stamp_properties = None
 84        self._disallow_user_resize_stamp = None
 85        self._error_details = None
 86        self._external_id = None
 87        self._image_base64 = None
 88        self._image_type = None
 89        self._last_modified_date_time = None
 90        self._phonetic_name = None
 91        self._signature_name = None
 92        self._stamp_format = None
 93        self._stamp_image_uri = None
 94        self._stamp_size_mm = None
 95        self._status = None
 96        self.discriminator = None
 97
 98        setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None))
 99        setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None))
100        setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None))
101        setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None))
102        setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None))
103        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
104        setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None))
105        setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None))
106        setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None))
107        setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None))
108        setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None))
109        setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None))
110        setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None))
111        setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None))
112        setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None))
113        setattr(self, "_{}".format('status'), kwargs.get('status', None))

Stamp - a model defined in Swagger

swagger_types = {'adopted_date_time': 'str', 'created_date_time': 'str', 'custom_field': 'str', 'date_stamp_properties': 'DateStampProperties', 'disallow_user_resize_stamp': 'str', 'error_details': 'ErrorDetails', 'external_id': 'str', 'image_base64': 'str', 'image_type': 'str', 'last_modified_date_time': 'str', 'phonetic_name': 'str', 'signature_name': 'str', 'stamp_format': 'str', 'stamp_image_uri': 'str', 'stamp_size_mm': 'str', 'status': 'str'}
attribute_map = {'adopted_date_time': 'adoptedDateTime', 'created_date_time': 'createdDateTime', 'custom_field': 'customField', 'date_stamp_properties': 'dateStampProperties', 'disallow_user_resize_stamp': 'disallowUserResizeStamp', 'error_details': 'errorDetails', 'external_id': 'externalID', 'image_base64': 'imageBase64', 'image_type': 'imageType', 'last_modified_date_time': 'lastModifiedDateTime', 'phonetic_name': 'phoneticName', 'signature_name': 'signatureName', 'stamp_format': 'stampFormat', 'stamp_image_uri': 'stampImageUri', 'stamp_size_mm': 'stampSizeMM', 'status': 'status'}
adopted_date_time

Gets the adopted_date_time of this Stamp. # noqa: E501

# noqa: E501

Returns

The adopted_date_time of this Stamp. # noqa: E501

created_date_time

Gets the created_date_time of this Stamp. # noqa: E501

Indicates the date and time the item was created. # noqa: E501

Returns

The created_date_time of this Stamp. # noqa: E501

custom_field

Gets the custom_field of this Stamp. # noqa: E501

# noqa: E501

Returns

The custom_field of this Stamp. # noqa: E501

date_stamp_properties

Gets the date_stamp_properties of this Stamp. # noqa: E501

Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - DateAreaX: The X axis position of the top-left corner. - DateAreaY: The Y axis position of the top-left corner. - DateAreaWidth: The width of the rectangle. - DateAreaHeight: The height of the rectangle. # noqa: E501

Returns

The date_stamp_properties of this Stamp. # noqa: E501

disallow_user_resize_stamp

Gets the disallow_user_resize_stamp of this Stamp. # noqa: E501

# noqa: E501

Returns

The disallow_user_resize_stamp of this Stamp. # noqa: E501

error_details

Gets the error_details of this Stamp. # noqa: E501

Array or errors. # noqa: E501

Returns

The error_details of this Stamp. # noqa: E501

external_id

Gets the external_id of this Stamp. # noqa: E501

# noqa: E501

Returns

The external_id of this Stamp. # noqa: E501

image_base64

Gets the image_base64 of this Stamp. # noqa: E501

# noqa: E501

Returns

The image_base64 of this Stamp. # noqa: E501

image_type

Gets the image_type of this Stamp. # noqa: E501

# noqa: E501

Returns

The image_type of this Stamp. # noqa: E501

last_modified_date_time

Gets the last_modified_date_time of this Stamp. # noqa: E501

The date and time the item was last modified. # noqa: E501

Returns

The last_modified_date_time of this Stamp. # noqa: E501

phonetic_name

Gets the phonetic_name of this Stamp. # noqa: E501

# noqa: E501

Returns

The phonetic_name of this Stamp. # noqa: E501

signature_name

Gets the signature_name of this Stamp. # noqa: E501

Specifies the user signature name. # noqa: E501

Returns

The signature_name of this Stamp. # noqa: E501

stamp_format

Gets the stamp_format of this Stamp. # noqa: E501

# noqa: E501

Returns

The stamp_format of this Stamp. # noqa: E501

stamp_image_uri

Gets the stamp_image_uri of this Stamp. # noqa: E501

# noqa: E501

Returns

The stamp_image_uri of this Stamp. # noqa: E501

stamp_size_mm

Gets the stamp_size_mm of this Stamp. # noqa: E501

# noqa: E501

Returns

The stamp_size_mm of this Stamp. # noqa: E501

status

Gets the status of this Stamp. # noqa: E501

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

Returns

The status of this Stamp. # noqa: E501

def to_dict(self)
483    def to_dict(self):
484        """Returns the model properties as a dict"""
485        result = {}
486
487        for attr, _ in six.iteritems(self.swagger_types):
488            value = getattr(self, attr)
489            if isinstance(value, list):
490                result[attr] = list(map(
491                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
492                    value
493                ))
494            elif hasattr(value, "to_dict"):
495                result[attr] = value.to_dict()
496            elif isinstance(value, dict):
497                result[attr] = dict(map(
498                    lambda item: (item[0], item[1].to_dict())
499                    if hasattr(item[1], "to_dict") else item,
500                    value.items()
501                ))
502            else:
503                result[attr] = value
504        if issubclass(Stamp, dict):
505            for key, value in self.items():
506                result[key] = value
507
508        return result

Returns the model properties as a dict

def to_str(self)
510    def to_str(self):
511        """Returns the string representation of the model"""
512        return pprint.pformat(self.to_dict())

Returns the string representation of the model