docusign_esign.models.user_signature
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 UserSignature(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 'initials150_image_id': 'str', 46 'initials_image_uri': 'str', 47 'is_default': 'str', 48 'last_modified_date_time': 'str', 49 'nrds_id': 'str', 50 'nrds_last_name': 'str', 51 'nrds_status': 'str', 52 'phonetic_name': 'str', 53 'signature150_image_id': 'str', 54 'signature_font': 'str', 55 'signature_id': 'str', 56 'signature_image_uri': 'str', 57 'signature_initials': 'str', 58 'signature_name': 'str', 59 'signature_rights': 'str', 60 'signature_type': 'str', 61 'stamp_format': 'str', 62 'stamp_image_uri': 'str', 63 'stamp_size_mm': 'str', 64 'stamp_type': 'str', 65 'status': 'str' 66 } 67 68 attribute_map = { 69 'adopted_date_time': 'adoptedDateTime', 70 'created_date_time': 'createdDateTime', 71 'custom_field': 'customField', 72 'date_stamp_properties': 'dateStampProperties', 73 'disallow_user_resize_stamp': 'disallowUserResizeStamp', 74 'error_details': 'errorDetails', 75 'external_id': 'externalID', 76 'image_base64': 'imageBase64', 77 'image_type': 'imageType', 78 'initials150_image_id': 'initials150ImageId', 79 'initials_image_uri': 'initialsImageUri', 80 'is_default': 'isDefault', 81 'last_modified_date_time': 'lastModifiedDateTime', 82 'nrds_id': 'nrdsId', 83 'nrds_last_name': 'nrdsLastName', 84 'nrds_status': 'nrdsStatus', 85 'phonetic_name': 'phoneticName', 86 'signature150_image_id': 'signature150ImageId', 87 'signature_font': 'signatureFont', 88 'signature_id': 'signatureId', 89 'signature_image_uri': 'signatureImageUri', 90 'signature_initials': 'signatureInitials', 91 'signature_name': 'signatureName', 92 'signature_rights': 'signatureRights', 93 'signature_type': 'signatureType', 94 'stamp_format': 'stampFormat', 95 'stamp_image_uri': 'stampImageUri', 96 'stamp_size_mm': 'stampSizeMM', 97 'stamp_type': 'stampType', 98 'status': 'status' 99 } 100 101 def __init__(self, _configuration=None, **kwargs): # noqa: E501 102 """UserSignature - a model defined in Swagger""" # noqa: E501 103 if _configuration is None: 104 _configuration = Configuration() 105 self._configuration = _configuration 106 107 self._adopted_date_time = None 108 self._created_date_time = None 109 self._custom_field = None 110 self._date_stamp_properties = None 111 self._disallow_user_resize_stamp = None 112 self._error_details = None 113 self._external_id = None 114 self._image_base64 = None 115 self._image_type = None 116 self._initials150_image_id = None 117 self._initials_image_uri = None 118 self._is_default = None 119 self._last_modified_date_time = None 120 self._nrds_id = None 121 self._nrds_last_name = None 122 self._nrds_status = None 123 self._phonetic_name = None 124 self._signature150_image_id = None 125 self._signature_font = None 126 self._signature_id = None 127 self._signature_image_uri = None 128 self._signature_initials = None 129 self._signature_name = None 130 self._signature_rights = None 131 self._signature_type = None 132 self._stamp_format = None 133 self._stamp_image_uri = None 134 self._stamp_size_mm = None 135 self._stamp_type = None 136 self._status = None 137 self.discriminator = None 138 139 setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None)) 140 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 141 setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None)) 142 setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None)) 143 setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None)) 144 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 145 setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None)) 146 setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None)) 147 setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None)) 148 setattr(self, "_{}".format('initials150_image_id'), kwargs.get('initials150_image_id', None)) 149 setattr(self, "_{}".format('initials_image_uri'), kwargs.get('initials_image_uri', None)) 150 setattr(self, "_{}".format('is_default'), kwargs.get('is_default', None)) 151 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 152 setattr(self, "_{}".format('nrds_id'), kwargs.get('nrds_id', None)) 153 setattr(self, "_{}".format('nrds_last_name'), kwargs.get('nrds_last_name', None)) 154 setattr(self, "_{}".format('nrds_status'), kwargs.get('nrds_status', None)) 155 setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None)) 156 setattr(self, "_{}".format('signature150_image_id'), kwargs.get('signature150_image_id', None)) 157 setattr(self, "_{}".format('signature_font'), kwargs.get('signature_font', None)) 158 setattr(self, "_{}".format('signature_id'), kwargs.get('signature_id', None)) 159 setattr(self, "_{}".format('signature_image_uri'), kwargs.get('signature_image_uri', None)) 160 setattr(self, "_{}".format('signature_initials'), kwargs.get('signature_initials', None)) 161 setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None)) 162 setattr(self, "_{}".format('signature_rights'), kwargs.get('signature_rights', None)) 163 setattr(self, "_{}".format('signature_type'), kwargs.get('signature_type', None)) 164 setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None)) 165 setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None)) 166 setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None)) 167 setattr(self, "_{}".format('stamp_type'), kwargs.get('stamp_type', None)) 168 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 169 170 @property 171 def adopted_date_time(self): 172 """Gets the adopted_date_time of this UserSignature. # noqa: E501 173 174 The date and time the user adopted their signature. # noqa: E501 175 176 :return: The adopted_date_time of this UserSignature. # noqa: E501 177 :rtype: str 178 """ 179 return self._adopted_date_time 180 181 @adopted_date_time.setter 182 def adopted_date_time(self, adopted_date_time): 183 """Sets the adopted_date_time of this UserSignature. 184 185 The date and time the user adopted their signature. # noqa: E501 186 187 :param adopted_date_time: The adopted_date_time of this UserSignature. # noqa: E501 188 :type: str 189 """ 190 191 self._adopted_date_time = adopted_date_time 192 193 @property 194 def created_date_time(self): 195 """Gets the created_date_time of this UserSignature. # noqa: E501 196 197 Indicates the date and time the item was created. # noqa: E501 198 199 :return: The created_date_time of this UserSignature. # noqa: E501 200 :rtype: str 201 """ 202 return self._created_date_time 203 204 @created_date_time.setter 205 def created_date_time(self, created_date_time): 206 """Sets the created_date_time of this UserSignature. 207 208 Indicates the date and time the item was created. # noqa: E501 209 210 :param created_date_time: The created_date_time of this UserSignature. # noqa: E501 211 :type: str 212 """ 213 214 self._created_date_time = created_date_time 215 216 @property 217 def custom_field(self): 218 """Gets the custom_field of this UserSignature. # noqa: E501 219 220 # noqa: E501 221 222 :return: The custom_field of this UserSignature. # noqa: E501 223 :rtype: str 224 """ 225 return self._custom_field 226 227 @custom_field.setter 228 def custom_field(self, custom_field): 229 """Sets the custom_field of this UserSignature. 230 231 # noqa: E501 232 233 :param custom_field: The custom_field of this UserSignature. # noqa: E501 234 :type: str 235 """ 236 237 self._custom_field = custom_field 238 239 @property 240 def date_stamp_properties(self): 241 """Gets the date_stamp_properties of this UserSignature. # noqa: E501 242 243 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 244 245 :return: The date_stamp_properties of this UserSignature. # noqa: E501 246 :rtype: DateStampProperties 247 """ 248 return self._date_stamp_properties 249 250 @date_stamp_properties.setter 251 def date_stamp_properties(self, date_stamp_properties): 252 """Sets the date_stamp_properties of this UserSignature. 253 254 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 255 256 :param date_stamp_properties: The date_stamp_properties of this UserSignature. # noqa: E501 257 :type: DateStampProperties 258 """ 259 260 self._date_stamp_properties = date_stamp_properties 261 262 @property 263 def disallow_user_resize_stamp(self): 264 """Gets the disallow_user_resize_stamp of this UserSignature. # noqa: E501 265 266 # noqa: E501 267 268 :return: The disallow_user_resize_stamp of this UserSignature. # noqa: E501 269 :rtype: str 270 """ 271 return self._disallow_user_resize_stamp 272 273 @disallow_user_resize_stamp.setter 274 def disallow_user_resize_stamp(self, disallow_user_resize_stamp): 275 """Sets the disallow_user_resize_stamp of this UserSignature. 276 277 # noqa: E501 278 279 :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this UserSignature. # noqa: E501 280 :type: str 281 """ 282 283 self._disallow_user_resize_stamp = disallow_user_resize_stamp 284 285 @property 286 def error_details(self): 287 """Gets the error_details of this UserSignature. # noqa: E501 288 289 Array or errors. # noqa: E501 290 291 :return: The error_details of this UserSignature. # noqa: E501 292 :rtype: ErrorDetails 293 """ 294 return self._error_details 295 296 @error_details.setter 297 def error_details(self, error_details): 298 """Sets the error_details of this UserSignature. 299 300 Array or errors. # noqa: E501 301 302 :param error_details: The error_details of this UserSignature. # noqa: E501 303 :type: ErrorDetails 304 """ 305 306 self._error_details = error_details 307 308 @property 309 def external_id(self): 310 """Gets the external_id of this UserSignature. # noqa: E501 311 312 # noqa: E501 313 314 :return: The external_id of this UserSignature. # noqa: E501 315 :rtype: str 316 """ 317 return self._external_id 318 319 @external_id.setter 320 def external_id(self, external_id): 321 """Sets the external_id of this UserSignature. 322 323 # noqa: E501 324 325 :param external_id: The external_id of this UserSignature. # noqa: E501 326 :type: str 327 """ 328 329 self._external_id = external_id 330 331 @property 332 def image_base64(self): 333 """Gets the image_base64 of this UserSignature. # noqa: E501 334 335 # noqa: E501 336 337 :return: The image_base64 of this UserSignature. # noqa: E501 338 :rtype: str 339 """ 340 return self._image_base64 341 342 @image_base64.setter 343 def image_base64(self, image_base64): 344 """Sets the image_base64 of this UserSignature. 345 346 # noqa: E501 347 348 :param image_base64: The image_base64 of this UserSignature. # noqa: E501 349 :type: str 350 """ 351 352 self._image_base64 = image_base64 353 354 @property 355 def image_type(self): 356 """Gets the image_type of this UserSignature. # noqa: E501 357 358 # noqa: E501 359 360 :return: The image_type of this UserSignature. # noqa: E501 361 :rtype: str 362 """ 363 return self._image_type 364 365 @image_type.setter 366 def image_type(self, image_type): 367 """Sets the image_type of this UserSignature. 368 369 # noqa: E501 370 371 :param image_type: The image_type of this UserSignature. # noqa: E501 372 :type: str 373 """ 374 375 self._image_type = image_type 376 377 @property 378 def initials150_image_id(self): 379 """Gets the initials150_image_id of this UserSignature. # noqa: E501 380 381 # noqa: E501 382 383 :return: The initials150_image_id of this UserSignature. # noqa: E501 384 :rtype: str 385 """ 386 return self._initials150_image_id 387 388 @initials150_image_id.setter 389 def initials150_image_id(self, initials150_image_id): 390 """Sets the initials150_image_id of this UserSignature. 391 392 # noqa: E501 393 394 :param initials150_image_id: The initials150_image_id of this UserSignature. # noqa: E501 395 :type: str 396 """ 397 398 self._initials150_image_id = initials150_image_id 399 400 @property 401 def initials_image_uri(self): 402 """Gets the initials_image_uri of this UserSignature. # noqa: E501 403 404 Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 405 406 :return: The initials_image_uri of this UserSignature. # noqa: E501 407 :rtype: str 408 """ 409 return self._initials_image_uri 410 411 @initials_image_uri.setter 412 def initials_image_uri(self, initials_image_uri): 413 """Sets the initials_image_uri of this UserSignature. 414 415 Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 416 417 :param initials_image_uri: The initials_image_uri of this UserSignature. # noqa: E501 418 :type: str 419 """ 420 421 self._initials_image_uri = initials_image_uri 422 423 @property 424 def is_default(self): 425 """Gets the is_default of this UserSignature. # noqa: E501 426 427 # noqa: E501 428 429 :return: The is_default of this UserSignature. # noqa: E501 430 :rtype: str 431 """ 432 return self._is_default 433 434 @is_default.setter 435 def is_default(self, is_default): 436 """Sets the is_default of this UserSignature. 437 438 # noqa: E501 439 440 :param is_default: The is_default of this UserSignature. # noqa: E501 441 :type: str 442 """ 443 444 self._is_default = is_default 445 446 @property 447 def last_modified_date_time(self): 448 """Gets the last_modified_date_time of this UserSignature. # noqa: E501 449 450 The date and time the item was last modified. # noqa: E501 451 452 :return: The last_modified_date_time of this UserSignature. # noqa: E501 453 :rtype: str 454 """ 455 return self._last_modified_date_time 456 457 @last_modified_date_time.setter 458 def last_modified_date_time(self, last_modified_date_time): 459 """Sets the last_modified_date_time of this UserSignature. 460 461 The date and time the item was last modified. # noqa: E501 462 463 :param last_modified_date_time: The last_modified_date_time of this UserSignature. # noqa: E501 464 :type: str 465 """ 466 467 self._last_modified_date_time = last_modified_date_time 468 469 @property 470 def nrds_id(self): 471 """Gets the nrds_id of this UserSignature. # noqa: E501 472 473 # noqa: E501 474 475 :return: The nrds_id of this UserSignature. # noqa: E501 476 :rtype: str 477 """ 478 return self._nrds_id 479 480 @nrds_id.setter 481 def nrds_id(self, nrds_id): 482 """Sets the nrds_id of this UserSignature. 483 484 # noqa: E501 485 486 :param nrds_id: The nrds_id of this UserSignature. # noqa: E501 487 :type: str 488 """ 489 490 self._nrds_id = nrds_id 491 492 @property 493 def nrds_last_name(self): 494 """Gets the nrds_last_name of this UserSignature. # noqa: E501 495 496 # noqa: E501 497 498 :return: The nrds_last_name of this UserSignature. # noqa: E501 499 :rtype: str 500 """ 501 return self._nrds_last_name 502 503 @nrds_last_name.setter 504 def nrds_last_name(self, nrds_last_name): 505 """Sets the nrds_last_name of this UserSignature. 506 507 # noqa: E501 508 509 :param nrds_last_name: The nrds_last_name of this UserSignature. # noqa: E501 510 :type: str 511 """ 512 513 self._nrds_last_name = nrds_last_name 514 515 @property 516 def nrds_status(self): 517 """Gets the nrds_status of this UserSignature. # noqa: E501 518 519 # noqa: E501 520 521 :return: The nrds_status of this UserSignature. # noqa: E501 522 :rtype: str 523 """ 524 return self._nrds_status 525 526 @nrds_status.setter 527 def nrds_status(self, nrds_status): 528 """Sets the nrds_status of this UserSignature. 529 530 # noqa: E501 531 532 :param nrds_status: The nrds_status of this UserSignature. # noqa: E501 533 :type: str 534 """ 535 536 self._nrds_status = nrds_status 537 538 @property 539 def phonetic_name(self): 540 """Gets the phonetic_name of this UserSignature. # noqa: E501 541 542 # noqa: E501 543 544 :return: The phonetic_name of this UserSignature. # noqa: E501 545 :rtype: str 546 """ 547 return self._phonetic_name 548 549 @phonetic_name.setter 550 def phonetic_name(self, phonetic_name): 551 """Sets the phonetic_name of this UserSignature. 552 553 # noqa: E501 554 555 :param phonetic_name: The phonetic_name of this UserSignature. # noqa: E501 556 :type: str 557 """ 558 559 self._phonetic_name = phonetic_name 560 561 @property 562 def signature150_image_id(self): 563 """Gets the signature150_image_id of this UserSignature. # noqa: E501 564 565 # noqa: E501 566 567 :return: The signature150_image_id of this UserSignature. # noqa: E501 568 :rtype: str 569 """ 570 return self._signature150_image_id 571 572 @signature150_image_id.setter 573 def signature150_image_id(self, signature150_image_id): 574 """Sets the signature150_image_id of this UserSignature. 575 576 # noqa: E501 577 578 :param signature150_image_id: The signature150_image_id of this UserSignature. # noqa: E501 579 :type: str 580 """ 581 582 self._signature150_image_id = signature150_image_id 583 584 @property 585 def signature_font(self): 586 """Gets the signature_font of this UserSignature. # noqa: E501 587 588 The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" # noqa: E501 589 590 :return: The signature_font of this UserSignature. # noqa: E501 591 :rtype: str 592 """ 593 return self._signature_font 594 595 @signature_font.setter 596 def signature_font(self, signature_font): 597 """Sets the signature_font of this UserSignature. 598 599 The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" # noqa: E501 600 601 :param signature_font: The signature_font of this UserSignature. # noqa: E501 602 :type: str 603 """ 604 605 self._signature_font = signature_font 606 607 @property 608 def signature_id(self): 609 """Gets the signature_id of this UserSignature. # noqa: E501 610 611 Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 612 613 :return: The signature_id of this UserSignature. # noqa: E501 614 :rtype: str 615 """ 616 return self._signature_id 617 618 @signature_id.setter 619 def signature_id(self, signature_id): 620 """Sets the signature_id of this UserSignature. 621 622 Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 623 624 :param signature_id: The signature_id of this UserSignature. # noqa: E501 625 :type: str 626 """ 627 628 self._signature_id = signature_id 629 630 @property 631 def signature_image_uri(self): 632 """Gets the signature_image_uri of this UserSignature. # noqa: E501 633 634 Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 635 636 :return: The signature_image_uri of this UserSignature. # noqa: E501 637 :rtype: str 638 """ 639 return self._signature_image_uri 640 641 @signature_image_uri.setter 642 def signature_image_uri(self, signature_image_uri): 643 """Sets the signature_image_uri of this UserSignature. 644 645 Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 646 647 :param signature_image_uri: The signature_image_uri of this UserSignature. # noqa: E501 648 :type: str 649 """ 650 651 self._signature_image_uri = signature_image_uri 652 653 @property 654 def signature_initials(self): 655 """Gets the signature_initials of this UserSignature. # noqa: E501 656 657 The initials associated with the signature. # noqa: E501 658 659 :return: The signature_initials of this UserSignature. # noqa: E501 660 :rtype: str 661 """ 662 return self._signature_initials 663 664 @signature_initials.setter 665 def signature_initials(self, signature_initials): 666 """Sets the signature_initials of this UserSignature. 667 668 The initials associated with the signature. # noqa: E501 669 670 :param signature_initials: The signature_initials of this UserSignature. # noqa: E501 671 :type: str 672 """ 673 674 self._signature_initials = signature_initials 675 676 @property 677 def signature_name(self): 678 """Gets the signature_name of this UserSignature. # noqa: E501 679 680 Specifies the user signature name. # noqa: E501 681 682 :return: The signature_name of this UserSignature. # noqa: E501 683 :rtype: str 684 """ 685 return self._signature_name 686 687 @signature_name.setter 688 def signature_name(self, signature_name): 689 """Sets the signature_name of this UserSignature. 690 691 Specifies the user signature name. # noqa: E501 692 693 :param signature_name: The signature_name of this UserSignature. # noqa: E501 694 :type: str 695 """ 696 697 self._signature_name = signature_name 698 699 @property 700 def signature_rights(self): 701 """Gets the signature_rights of this UserSignature. # noqa: E501 702 703 # noqa: E501 704 705 :return: The signature_rights of this UserSignature. # noqa: E501 706 :rtype: str 707 """ 708 return self._signature_rights 709 710 @signature_rights.setter 711 def signature_rights(self, signature_rights): 712 """Sets the signature_rights of this UserSignature. 713 714 # noqa: E501 715 716 :param signature_rights: The signature_rights of this UserSignature. # noqa: E501 717 :type: str 718 """ 719 720 self._signature_rights = signature_rights 721 722 @property 723 def signature_type(self): 724 """Gets the signature_type of this UserSignature. # noqa: E501 725 726 # noqa: E501 727 728 :return: The signature_type of this UserSignature. # noqa: E501 729 :rtype: str 730 """ 731 return self._signature_type 732 733 @signature_type.setter 734 def signature_type(self, signature_type): 735 """Sets the signature_type of this UserSignature. 736 737 # noqa: E501 738 739 :param signature_type: The signature_type of this UserSignature. # noqa: E501 740 :type: str 741 """ 742 743 self._signature_type = signature_type 744 745 @property 746 def stamp_format(self): 747 """Gets the stamp_format of this UserSignature. # noqa: E501 748 749 # noqa: E501 750 751 :return: The stamp_format of this UserSignature. # noqa: E501 752 :rtype: str 753 """ 754 return self._stamp_format 755 756 @stamp_format.setter 757 def stamp_format(self, stamp_format): 758 """Sets the stamp_format of this UserSignature. 759 760 # noqa: E501 761 762 :param stamp_format: The stamp_format of this UserSignature. # noqa: E501 763 :type: str 764 """ 765 766 self._stamp_format = stamp_format 767 768 @property 769 def stamp_image_uri(self): 770 """Gets the stamp_image_uri of this UserSignature. # noqa: E501 771 772 # noqa: E501 773 774 :return: The stamp_image_uri of this UserSignature. # noqa: E501 775 :rtype: str 776 """ 777 return self._stamp_image_uri 778 779 @stamp_image_uri.setter 780 def stamp_image_uri(self, stamp_image_uri): 781 """Sets the stamp_image_uri of this UserSignature. 782 783 # noqa: E501 784 785 :param stamp_image_uri: The stamp_image_uri of this UserSignature. # noqa: E501 786 :type: str 787 """ 788 789 self._stamp_image_uri = stamp_image_uri 790 791 @property 792 def stamp_size_mm(self): 793 """Gets the stamp_size_mm of this UserSignature. # noqa: E501 794 795 # noqa: E501 796 797 :return: The stamp_size_mm of this UserSignature. # noqa: E501 798 :rtype: str 799 """ 800 return self._stamp_size_mm 801 802 @stamp_size_mm.setter 803 def stamp_size_mm(self, stamp_size_mm): 804 """Sets the stamp_size_mm of this UserSignature. 805 806 # noqa: E501 807 808 :param stamp_size_mm: The stamp_size_mm of this UserSignature. # noqa: E501 809 :type: str 810 """ 811 812 self._stamp_size_mm = stamp_size_mm 813 814 @property 815 def stamp_type(self): 816 """Gets the stamp_type of this UserSignature. # noqa: E501 817 818 # noqa: E501 819 820 :return: The stamp_type of this UserSignature. # noqa: E501 821 :rtype: str 822 """ 823 return self._stamp_type 824 825 @stamp_type.setter 826 def stamp_type(self, stamp_type): 827 """Sets the stamp_type of this UserSignature. 828 829 # noqa: E501 830 831 :param stamp_type: The stamp_type of this UserSignature. # noqa: E501 832 :type: str 833 """ 834 835 self._stamp_type = stamp_type 836 837 @property 838 def status(self): 839 """Gets the status of this UserSignature. # noqa: E501 840 841 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 842 843 :return: The status of this UserSignature. # noqa: E501 844 :rtype: str 845 """ 846 return self._status 847 848 @status.setter 849 def status(self, status): 850 """Sets the status of this UserSignature. 851 852 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 853 854 :param status: The status of this UserSignature. # noqa: E501 855 :type: str 856 """ 857 858 self._status = status 859 860 def to_dict(self): 861 """Returns the model properties as a dict""" 862 result = {} 863 864 for attr, _ in six.iteritems(self.swagger_types): 865 value = getattr(self, attr) 866 if isinstance(value, list): 867 result[attr] = list(map( 868 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 869 value 870 )) 871 elif hasattr(value, "to_dict"): 872 result[attr] = value.to_dict() 873 elif isinstance(value, dict): 874 result[attr] = dict(map( 875 lambda item: (item[0], item[1].to_dict()) 876 if hasattr(item[1], "to_dict") else item, 877 value.items() 878 )) 879 else: 880 result[attr] = value 881 if issubclass(UserSignature, dict): 882 for key, value in self.items(): 883 result[key] = value 884 885 return result 886 887 def to_str(self): 888 """Returns the string representation of the model""" 889 return pprint.pformat(self.to_dict()) 890 891 def __repr__(self): 892 """For `print` and `pprint`""" 893 return self.to_str() 894 895 def __eq__(self, other): 896 """Returns true if both objects are equal""" 897 if not isinstance(other, UserSignature): 898 return False 899 900 return self.to_dict() == other.to_dict() 901 902 def __ne__(self, other): 903 """Returns true if both objects are not equal""" 904 if not isinstance(other, UserSignature): 905 return True 906 907 return self.to_dict() != other.to_dict()
class
UserSignature:
23class UserSignature(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 'initials150_image_id': 'str', 47 'initials_image_uri': 'str', 48 'is_default': 'str', 49 'last_modified_date_time': 'str', 50 'nrds_id': 'str', 51 'nrds_last_name': 'str', 52 'nrds_status': 'str', 53 'phonetic_name': 'str', 54 'signature150_image_id': 'str', 55 'signature_font': 'str', 56 'signature_id': 'str', 57 'signature_image_uri': 'str', 58 'signature_initials': 'str', 59 'signature_name': 'str', 60 'signature_rights': 'str', 61 'signature_type': 'str', 62 'stamp_format': 'str', 63 'stamp_image_uri': 'str', 64 'stamp_size_mm': 'str', 65 'stamp_type': 'str', 66 'status': 'str' 67 } 68 69 attribute_map = { 70 'adopted_date_time': 'adoptedDateTime', 71 'created_date_time': 'createdDateTime', 72 'custom_field': 'customField', 73 'date_stamp_properties': 'dateStampProperties', 74 'disallow_user_resize_stamp': 'disallowUserResizeStamp', 75 'error_details': 'errorDetails', 76 'external_id': 'externalID', 77 'image_base64': 'imageBase64', 78 'image_type': 'imageType', 79 'initials150_image_id': 'initials150ImageId', 80 'initials_image_uri': 'initialsImageUri', 81 'is_default': 'isDefault', 82 'last_modified_date_time': 'lastModifiedDateTime', 83 'nrds_id': 'nrdsId', 84 'nrds_last_name': 'nrdsLastName', 85 'nrds_status': 'nrdsStatus', 86 'phonetic_name': 'phoneticName', 87 'signature150_image_id': 'signature150ImageId', 88 'signature_font': 'signatureFont', 89 'signature_id': 'signatureId', 90 'signature_image_uri': 'signatureImageUri', 91 'signature_initials': 'signatureInitials', 92 'signature_name': 'signatureName', 93 'signature_rights': 'signatureRights', 94 'signature_type': 'signatureType', 95 'stamp_format': 'stampFormat', 96 'stamp_image_uri': 'stampImageUri', 97 'stamp_size_mm': 'stampSizeMM', 98 'stamp_type': 'stampType', 99 'status': 'status' 100 } 101 102 def __init__(self, _configuration=None, **kwargs): # noqa: E501 103 """UserSignature - a model defined in Swagger""" # noqa: E501 104 if _configuration is None: 105 _configuration = Configuration() 106 self._configuration = _configuration 107 108 self._adopted_date_time = None 109 self._created_date_time = None 110 self._custom_field = None 111 self._date_stamp_properties = None 112 self._disallow_user_resize_stamp = None 113 self._error_details = None 114 self._external_id = None 115 self._image_base64 = None 116 self._image_type = None 117 self._initials150_image_id = None 118 self._initials_image_uri = None 119 self._is_default = None 120 self._last_modified_date_time = None 121 self._nrds_id = None 122 self._nrds_last_name = None 123 self._nrds_status = None 124 self._phonetic_name = None 125 self._signature150_image_id = None 126 self._signature_font = None 127 self._signature_id = None 128 self._signature_image_uri = None 129 self._signature_initials = None 130 self._signature_name = None 131 self._signature_rights = None 132 self._signature_type = None 133 self._stamp_format = None 134 self._stamp_image_uri = None 135 self._stamp_size_mm = None 136 self._stamp_type = None 137 self._status = None 138 self.discriminator = None 139 140 setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None)) 141 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 142 setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None)) 143 setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None)) 144 setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None)) 145 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 146 setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None)) 147 setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None)) 148 setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None)) 149 setattr(self, "_{}".format('initials150_image_id'), kwargs.get('initials150_image_id', None)) 150 setattr(self, "_{}".format('initials_image_uri'), kwargs.get('initials_image_uri', None)) 151 setattr(self, "_{}".format('is_default'), kwargs.get('is_default', None)) 152 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 153 setattr(self, "_{}".format('nrds_id'), kwargs.get('nrds_id', None)) 154 setattr(self, "_{}".format('nrds_last_name'), kwargs.get('nrds_last_name', None)) 155 setattr(self, "_{}".format('nrds_status'), kwargs.get('nrds_status', None)) 156 setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None)) 157 setattr(self, "_{}".format('signature150_image_id'), kwargs.get('signature150_image_id', None)) 158 setattr(self, "_{}".format('signature_font'), kwargs.get('signature_font', None)) 159 setattr(self, "_{}".format('signature_id'), kwargs.get('signature_id', None)) 160 setattr(self, "_{}".format('signature_image_uri'), kwargs.get('signature_image_uri', None)) 161 setattr(self, "_{}".format('signature_initials'), kwargs.get('signature_initials', None)) 162 setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None)) 163 setattr(self, "_{}".format('signature_rights'), kwargs.get('signature_rights', None)) 164 setattr(self, "_{}".format('signature_type'), kwargs.get('signature_type', None)) 165 setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None)) 166 setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None)) 167 setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None)) 168 setattr(self, "_{}".format('stamp_type'), kwargs.get('stamp_type', None)) 169 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 170 171 @property 172 def adopted_date_time(self): 173 """Gets the adopted_date_time of this UserSignature. # noqa: E501 174 175 The date and time the user adopted their signature. # noqa: E501 176 177 :return: The adopted_date_time of this UserSignature. # noqa: E501 178 :rtype: str 179 """ 180 return self._adopted_date_time 181 182 @adopted_date_time.setter 183 def adopted_date_time(self, adopted_date_time): 184 """Sets the adopted_date_time of this UserSignature. 185 186 The date and time the user adopted their signature. # noqa: E501 187 188 :param adopted_date_time: The adopted_date_time of this UserSignature. # noqa: E501 189 :type: str 190 """ 191 192 self._adopted_date_time = adopted_date_time 193 194 @property 195 def created_date_time(self): 196 """Gets the created_date_time of this UserSignature. # noqa: E501 197 198 Indicates the date and time the item was created. # noqa: E501 199 200 :return: The created_date_time of this UserSignature. # noqa: E501 201 :rtype: str 202 """ 203 return self._created_date_time 204 205 @created_date_time.setter 206 def created_date_time(self, created_date_time): 207 """Sets the created_date_time of this UserSignature. 208 209 Indicates the date and time the item was created. # noqa: E501 210 211 :param created_date_time: The created_date_time of this UserSignature. # noqa: E501 212 :type: str 213 """ 214 215 self._created_date_time = created_date_time 216 217 @property 218 def custom_field(self): 219 """Gets the custom_field of this UserSignature. # noqa: E501 220 221 # noqa: E501 222 223 :return: The custom_field of this UserSignature. # noqa: E501 224 :rtype: str 225 """ 226 return self._custom_field 227 228 @custom_field.setter 229 def custom_field(self, custom_field): 230 """Sets the custom_field of this UserSignature. 231 232 # noqa: E501 233 234 :param custom_field: The custom_field of this UserSignature. # noqa: E501 235 :type: str 236 """ 237 238 self._custom_field = custom_field 239 240 @property 241 def date_stamp_properties(self): 242 """Gets the date_stamp_properties of this UserSignature. # noqa: E501 243 244 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 245 246 :return: The date_stamp_properties of this UserSignature. # noqa: E501 247 :rtype: DateStampProperties 248 """ 249 return self._date_stamp_properties 250 251 @date_stamp_properties.setter 252 def date_stamp_properties(self, date_stamp_properties): 253 """Sets the date_stamp_properties of this UserSignature. 254 255 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 256 257 :param date_stamp_properties: The date_stamp_properties of this UserSignature. # noqa: E501 258 :type: DateStampProperties 259 """ 260 261 self._date_stamp_properties = date_stamp_properties 262 263 @property 264 def disallow_user_resize_stamp(self): 265 """Gets the disallow_user_resize_stamp of this UserSignature. # noqa: E501 266 267 # noqa: E501 268 269 :return: The disallow_user_resize_stamp of this UserSignature. # noqa: E501 270 :rtype: str 271 """ 272 return self._disallow_user_resize_stamp 273 274 @disallow_user_resize_stamp.setter 275 def disallow_user_resize_stamp(self, disallow_user_resize_stamp): 276 """Sets the disallow_user_resize_stamp of this UserSignature. 277 278 # noqa: E501 279 280 :param disallow_user_resize_stamp: The disallow_user_resize_stamp of this UserSignature. # noqa: E501 281 :type: str 282 """ 283 284 self._disallow_user_resize_stamp = disallow_user_resize_stamp 285 286 @property 287 def error_details(self): 288 """Gets the error_details of this UserSignature. # noqa: E501 289 290 Array or errors. # noqa: E501 291 292 :return: The error_details of this UserSignature. # noqa: E501 293 :rtype: ErrorDetails 294 """ 295 return self._error_details 296 297 @error_details.setter 298 def error_details(self, error_details): 299 """Sets the error_details of this UserSignature. 300 301 Array or errors. # noqa: E501 302 303 :param error_details: The error_details of this UserSignature. # noqa: E501 304 :type: ErrorDetails 305 """ 306 307 self._error_details = error_details 308 309 @property 310 def external_id(self): 311 """Gets the external_id of this UserSignature. # noqa: E501 312 313 # noqa: E501 314 315 :return: The external_id of this UserSignature. # noqa: E501 316 :rtype: str 317 """ 318 return self._external_id 319 320 @external_id.setter 321 def external_id(self, external_id): 322 """Sets the external_id of this UserSignature. 323 324 # noqa: E501 325 326 :param external_id: The external_id of this UserSignature. # noqa: E501 327 :type: str 328 """ 329 330 self._external_id = external_id 331 332 @property 333 def image_base64(self): 334 """Gets the image_base64 of this UserSignature. # noqa: E501 335 336 # noqa: E501 337 338 :return: The image_base64 of this UserSignature. # noqa: E501 339 :rtype: str 340 """ 341 return self._image_base64 342 343 @image_base64.setter 344 def image_base64(self, image_base64): 345 """Sets the image_base64 of this UserSignature. 346 347 # noqa: E501 348 349 :param image_base64: The image_base64 of this UserSignature. # noqa: E501 350 :type: str 351 """ 352 353 self._image_base64 = image_base64 354 355 @property 356 def image_type(self): 357 """Gets the image_type of this UserSignature. # noqa: E501 358 359 # noqa: E501 360 361 :return: The image_type of this UserSignature. # noqa: E501 362 :rtype: str 363 """ 364 return self._image_type 365 366 @image_type.setter 367 def image_type(self, image_type): 368 """Sets the image_type of this UserSignature. 369 370 # noqa: E501 371 372 :param image_type: The image_type of this UserSignature. # noqa: E501 373 :type: str 374 """ 375 376 self._image_type = image_type 377 378 @property 379 def initials150_image_id(self): 380 """Gets the initials150_image_id of this UserSignature. # noqa: E501 381 382 # noqa: E501 383 384 :return: The initials150_image_id of this UserSignature. # noqa: E501 385 :rtype: str 386 """ 387 return self._initials150_image_id 388 389 @initials150_image_id.setter 390 def initials150_image_id(self, initials150_image_id): 391 """Sets the initials150_image_id of this UserSignature. 392 393 # noqa: E501 394 395 :param initials150_image_id: The initials150_image_id of this UserSignature. # noqa: E501 396 :type: str 397 """ 398 399 self._initials150_image_id = initials150_image_id 400 401 @property 402 def initials_image_uri(self): 403 """Gets the initials_image_uri of this UserSignature. # noqa: E501 404 405 Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 406 407 :return: The initials_image_uri of this UserSignature. # noqa: E501 408 :rtype: str 409 """ 410 return self._initials_image_uri 411 412 @initials_image_uri.setter 413 def initials_image_uri(self, initials_image_uri): 414 """Sets the initials_image_uri of this UserSignature. 415 416 Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501 417 418 :param initials_image_uri: The initials_image_uri of this UserSignature. # noqa: E501 419 :type: str 420 """ 421 422 self._initials_image_uri = initials_image_uri 423 424 @property 425 def is_default(self): 426 """Gets the is_default of this UserSignature. # noqa: E501 427 428 # noqa: E501 429 430 :return: The is_default of this UserSignature. # noqa: E501 431 :rtype: str 432 """ 433 return self._is_default 434 435 @is_default.setter 436 def is_default(self, is_default): 437 """Sets the is_default of this UserSignature. 438 439 # noqa: E501 440 441 :param is_default: The is_default of this UserSignature. # noqa: E501 442 :type: str 443 """ 444 445 self._is_default = is_default 446 447 @property 448 def last_modified_date_time(self): 449 """Gets the last_modified_date_time of this UserSignature. # noqa: E501 450 451 The date and time the item was last modified. # noqa: E501 452 453 :return: The last_modified_date_time of this UserSignature. # noqa: E501 454 :rtype: str 455 """ 456 return self._last_modified_date_time 457 458 @last_modified_date_time.setter 459 def last_modified_date_time(self, last_modified_date_time): 460 """Sets the last_modified_date_time of this UserSignature. 461 462 The date and time the item was last modified. # noqa: E501 463 464 :param last_modified_date_time: The last_modified_date_time of this UserSignature. # noqa: E501 465 :type: str 466 """ 467 468 self._last_modified_date_time = last_modified_date_time 469 470 @property 471 def nrds_id(self): 472 """Gets the nrds_id of this UserSignature. # noqa: E501 473 474 # noqa: E501 475 476 :return: The nrds_id of this UserSignature. # noqa: E501 477 :rtype: str 478 """ 479 return self._nrds_id 480 481 @nrds_id.setter 482 def nrds_id(self, nrds_id): 483 """Sets the nrds_id of this UserSignature. 484 485 # noqa: E501 486 487 :param nrds_id: The nrds_id of this UserSignature. # noqa: E501 488 :type: str 489 """ 490 491 self._nrds_id = nrds_id 492 493 @property 494 def nrds_last_name(self): 495 """Gets the nrds_last_name of this UserSignature. # noqa: E501 496 497 # noqa: E501 498 499 :return: The nrds_last_name of this UserSignature. # noqa: E501 500 :rtype: str 501 """ 502 return self._nrds_last_name 503 504 @nrds_last_name.setter 505 def nrds_last_name(self, nrds_last_name): 506 """Sets the nrds_last_name of this UserSignature. 507 508 # noqa: E501 509 510 :param nrds_last_name: The nrds_last_name of this UserSignature. # noqa: E501 511 :type: str 512 """ 513 514 self._nrds_last_name = nrds_last_name 515 516 @property 517 def nrds_status(self): 518 """Gets the nrds_status of this UserSignature. # noqa: E501 519 520 # noqa: E501 521 522 :return: The nrds_status of this UserSignature. # noqa: E501 523 :rtype: str 524 """ 525 return self._nrds_status 526 527 @nrds_status.setter 528 def nrds_status(self, nrds_status): 529 """Sets the nrds_status of this UserSignature. 530 531 # noqa: E501 532 533 :param nrds_status: The nrds_status of this UserSignature. # noqa: E501 534 :type: str 535 """ 536 537 self._nrds_status = nrds_status 538 539 @property 540 def phonetic_name(self): 541 """Gets the phonetic_name of this UserSignature. # noqa: E501 542 543 # noqa: E501 544 545 :return: The phonetic_name of this UserSignature. # noqa: E501 546 :rtype: str 547 """ 548 return self._phonetic_name 549 550 @phonetic_name.setter 551 def phonetic_name(self, phonetic_name): 552 """Sets the phonetic_name of this UserSignature. 553 554 # noqa: E501 555 556 :param phonetic_name: The phonetic_name of this UserSignature. # noqa: E501 557 :type: str 558 """ 559 560 self._phonetic_name = phonetic_name 561 562 @property 563 def signature150_image_id(self): 564 """Gets the signature150_image_id of this UserSignature. # noqa: E501 565 566 # noqa: E501 567 568 :return: The signature150_image_id of this UserSignature. # noqa: E501 569 :rtype: str 570 """ 571 return self._signature150_image_id 572 573 @signature150_image_id.setter 574 def signature150_image_id(self, signature150_image_id): 575 """Sets the signature150_image_id of this UserSignature. 576 577 # noqa: E501 578 579 :param signature150_image_id: The signature150_image_id of this UserSignature. # noqa: E501 580 :type: str 581 """ 582 583 self._signature150_image_id = signature150_image_id 584 585 @property 586 def signature_font(self): 587 """Gets the signature_font of this UserSignature. # noqa: E501 588 589 The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" # noqa: E501 590 591 :return: The signature_font of this UserSignature. # noqa: E501 592 :rtype: str 593 """ 594 return self._signature_font 595 596 @signature_font.setter 597 def signature_font(self, signature_font): 598 """Sets the signature_font of this UserSignature. 599 600 The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" # noqa: E501 601 602 :param signature_font: The signature_font of this UserSignature. # noqa: E501 603 :type: str 604 """ 605 606 self._signature_font = signature_font 607 608 @property 609 def signature_id(self): 610 """Gets the signature_id of this UserSignature. # noqa: E501 611 612 Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 613 614 :return: The signature_id of this UserSignature. # noqa: E501 615 :rtype: str 616 """ 617 return self._signature_id 618 619 @signature_id.setter 620 def signature_id(self, signature_id): 621 """Sets the signature_id of this UserSignature. 622 623 Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501 624 625 :param signature_id: The signature_id of this UserSignature. # noqa: E501 626 :type: str 627 """ 628 629 self._signature_id = signature_id 630 631 @property 632 def signature_image_uri(self): 633 """Gets the signature_image_uri of this UserSignature. # noqa: E501 634 635 Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 636 637 :return: The signature_image_uri of this UserSignature. # noqa: E501 638 :rtype: str 639 """ 640 return self._signature_image_uri 641 642 @signature_image_uri.setter 643 def signature_image_uri(self, signature_image_uri): 644 """Sets the signature_image_uri of this UserSignature. 645 646 Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501 647 648 :param signature_image_uri: The signature_image_uri of this UserSignature. # noqa: E501 649 :type: str 650 """ 651 652 self._signature_image_uri = signature_image_uri 653 654 @property 655 def signature_initials(self): 656 """Gets the signature_initials of this UserSignature. # noqa: E501 657 658 The initials associated with the signature. # noqa: E501 659 660 :return: The signature_initials of this UserSignature. # noqa: E501 661 :rtype: str 662 """ 663 return self._signature_initials 664 665 @signature_initials.setter 666 def signature_initials(self, signature_initials): 667 """Sets the signature_initials of this UserSignature. 668 669 The initials associated with the signature. # noqa: E501 670 671 :param signature_initials: The signature_initials of this UserSignature. # noqa: E501 672 :type: str 673 """ 674 675 self._signature_initials = signature_initials 676 677 @property 678 def signature_name(self): 679 """Gets the signature_name of this UserSignature. # noqa: E501 680 681 Specifies the user signature name. # noqa: E501 682 683 :return: The signature_name of this UserSignature. # noqa: E501 684 :rtype: str 685 """ 686 return self._signature_name 687 688 @signature_name.setter 689 def signature_name(self, signature_name): 690 """Sets the signature_name of this UserSignature. 691 692 Specifies the user signature name. # noqa: E501 693 694 :param signature_name: The signature_name of this UserSignature. # noqa: E501 695 :type: str 696 """ 697 698 self._signature_name = signature_name 699 700 @property 701 def signature_rights(self): 702 """Gets the signature_rights of this UserSignature. # noqa: E501 703 704 # noqa: E501 705 706 :return: The signature_rights of this UserSignature. # noqa: E501 707 :rtype: str 708 """ 709 return self._signature_rights 710 711 @signature_rights.setter 712 def signature_rights(self, signature_rights): 713 """Sets the signature_rights of this UserSignature. 714 715 # noqa: E501 716 717 :param signature_rights: The signature_rights of this UserSignature. # noqa: E501 718 :type: str 719 """ 720 721 self._signature_rights = signature_rights 722 723 @property 724 def signature_type(self): 725 """Gets the signature_type of this UserSignature. # noqa: E501 726 727 # noqa: E501 728 729 :return: The signature_type of this UserSignature. # noqa: E501 730 :rtype: str 731 """ 732 return self._signature_type 733 734 @signature_type.setter 735 def signature_type(self, signature_type): 736 """Sets the signature_type of this UserSignature. 737 738 # noqa: E501 739 740 :param signature_type: The signature_type of this UserSignature. # noqa: E501 741 :type: str 742 """ 743 744 self._signature_type = signature_type 745 746 @property 747 def stamp_format(self): 748 """Gets the stamp_format of this UserSignature. # noqa: E501 749 750 # noqa: E501 751 752 :return: The stamp_format of this UserSignature. # noqa: E501 753 :rtype: str 754 """ 755 return self._stamp_format 756 757 @stamp_format.setter 758 def stamp_format(self, stamp_format): 759 """Sets the stamp_format of this UserSignature. 760 761 # noqa: E501 762 763 :param stamp_format: The stamp_format of this UserSignature. # noqa: E501 764 :type: str 765 """ 766 767 self._stamp_format = stamp_format 768 769 @property 770 def stamp_image_uri(self): 771 """Gets the stamp_image_uri of this UserSignature. # noqa: E501 772 773 # noqa: E501 774 775 :return: The stamp_image_uri of this UserSignature. # noqa: E501 776 :rtype: str 777 """ 778 return self._stamp_image_uri 779 780 @stamp_image_uri.setter 781 def stamp_image_uri(self, stamp_image_uri): 782 """Sets the stamp_image_uri of this UserSignature. 783 784 # noqa: E501 785 786 :param stamp_image_uri: The stamp_image_uri of this UserSignature. # noqa: E501 787 :type: str 788 """ 789 790 self._stamp_image_uri = stamp_image_uri 791 792 @property 793 def stamp_size_mm(self): 794 """Gets the stamp_size_mm of this UserSignature. # noqa: E501 795 796 # noqa: E501 797 798 :return: The stamp_size_mm of this UserSignature. # noqa: E501 799 :rtype: str 800 """ 801 return self._stamp_size_mm 802 803 @stamp_size_mm.setter 804 def stamp_size_mm(self, stamp_size_mm): 805 """Sets the stamp_size_mm of this UserSignature. 806 807 # noqa: E501 808 809 :param stamp_size_mm: The stamp_size_mm of this UserSignature. # noqa: E501 810 :type: str 811 """ 812 813 self._stamp_size_mm = stamp_size_mm 814 815 @property 816 def stamp_type(self): 817 """Gets the stamp_type of this UserSignature. # noqa: E501 818 819 # noqa: E501 820 821 :return: The stamp_type of this UserSignature. # noqa: E501 822 :rtype: str 823 """ 824 return self._stamp_type 825 826 @stamp_type.setter 827 def stamp_type(self, stamp_type): 828 """Sets the stamp_type of this UserSignature. 829 830 # noqa: E501 831 832 :param stamp_type: The stamp_type of this UserSignature. # noqa: E501 833 :type: str 834 """ 835 836 self._stamp_type = stamp_type 837 838 @property 839 def status(self): 840 """Gets the status of this UserSignature. # noqa: E501 841 842 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 843 844 :return: The status of this UserSignature. # noqa: E501 845 :rtype: str 846 """ 847 return self._status 848 849 @status.setter 850 def status(self, status): 851 """Sets the status of this UserSignature. 852 853 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 854 855 :param status: The status of this UserSignature. # noqa: E501 856 :type: str 857 """ 858 859 self._status = status 860 861 def to_dict(self): 862 """Returns the model properties as a dict""" 863 result = {} 864 865 for attr, _ in six.iteritems(self.swagger_types): 866 value = getattr(self, attr) 867 if isinstance(value, list): 868 result[attr] = list(map( 869 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 870 value 871 )) 872 elif hasattr(value, "to_dict"): 873 result[attr] = value.to_dict() 874 elif isinstance(value, dict): 875 result[attr] = dict(map( 876 lambda item: (item[0], item[1].to_dict()) 877 if hasattr(item[1], "to_dict") else item, 878 value.items() 879 )) 880 else: 881 result[attr] = value 882 if issubclass(UserSignature, dict): 883 for key, value in self.items(): 884 result[key] = value 885 886 return result 887 888 def to_str(self): 889 """Returns the string representation of the model""" 890 return pprint.pformat(self.to_dict()) 891 892 def __repr__(self): 893 """For `print` and `pprint`""" 894 return self.to_str() 895 896 def __eq__(self, other): 897 """Returns true if both objects are equal""" 898 if not isinstance(other, UserSignature): 899 return False 900 901 return self.to_dict() == other.to_dict() 902 903 def __ne__(self, other): 904 """Returns true if both objects are not equal""" 905 if not isinstance(other, UserSignature): 906 return True 907 908 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.
UserSignature(_configuration=None, **kwargs)
102 def __init__(self, _configuration=None, **kwargs): # noqa: E501 103 """UserSignature - a model defined in Swagger""" # noqa: E501 104 if _configuration is None: 105 _configuration = Configuration() 106 self._configuration = _configuration 107 108 self._adopted_date_time = None 109 self._created_date_time = None 110 self._custom_field = None 111 self._date_stamp_properties = None 112 self._disallow_user_resize_stamp = None 113 self._error_details = None 114 self._external_id = None 115 self._image_base64 = None 116 self._image_type = None 117 self._initials150_image_id = None 118 self._initials_image_uri = None 119 self._is_default = None 120 self._last_modified_date_time = None 121 self._nrds_id = None 122 self._nrds_last_name = None 123 self._nrds_status = None 124 self._phonetic_name = None 125 self._signature150_image_id = None 126 self._signature_font = None 127 self._signature_id = None 128 self._signature_image_uri = None 129 self._signature_initials = None 130 self._signature_name = None 131 self._signature_rights = None 132 self._signature_type = None 133 self._stamp_format = None 134 self._stamp_image_uri = None 135 self._stamp_size_mm = None 136 self._stamp_type = None 137 self._status = None 138 self.discriminator = None 139 140 setattr(self, "_{}".format('adopted_date_time'), kwargs.get('adopted_date_time', None)) 141 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 142 setattr(self, "_{}".format('custom_field'), kwargs.get('custom_field', None)) 143 setattr(self, "_{}".format('date_stamp_properties'), kwargs.get('date_stamp_properties', None)) 144 setattr(self, "_{}".format('disallow_user_resize_stamp'), kwargs.get('disallow_user_resize_stamp', None)) 145 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 146 setattr(self, "_{}".format('external_id'), kwargs.get('external_id', None)) 147 setattr(self, "_{}".format('image_base64'), kwargs.get('image_base64', None)) 148 setattr(self, "_{}".format('image_type'), kwargs.get('image_type', None)) 149 setattr(self, "_{}".format('initials150_image_id'), kwargs.get('initials150_image_id', None)) 150 setattr(self, "_{}".format('initials_image_uri'), kwargs.get('initials_image_uri', None)) 151 setattr(self, "_{}".format('is_default'), kwargs.get('is_default', None)) 152 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 153 setattr(self, "_{}".format('nrds_id'), kwargs.get('nrds_id', None)) 154 setattr(self, "_{}".format('nrds_last_name'), kwargs.get('nrds_last_name', None)) 155 setattr(self, "_{}".format('nrds_status'), kwargs.get('nrds_status', None)) 156 setattr(self, "_{}".format('phonetic_name'), kwargs.get('phonetic_name', None)) 157 setattr(self, "_{}".format('signature150_image_id'), kwargs.get('signature150_image_id', None)) 158 setattr(self, "_{}".format('signature_font'), kwargs.get('signature_font', None)) 159 setattr(self, "_{}".format('signature_id'), kwargs.get('signature_id', None)) 160 setattr(self, "_{}".format('signature_image_uri'), kwargs.get('signature_image_uri', None)) 161 setattr(self, "_{}".format('signature_initials'), kwargs.get('signature_initials', None)) 162 setattr(self, "_{}".format('signature_name'), kwargs.get('signature_name', None)) 163 setattr(self, "_{}".format('signature_rights'), kwargs.get('signature_rights', None)) 164 setattr(self, "_{}".format('signature_type'), kwargs.get('signature_type', None)) 165 setattr(self, "_{}".format('stamp_format'), kwargs.get('stamp_format', None)) 166 setattr(self, "_{}".format('stamp_image_uri'), kwargs.get('stamp_image_uri', None)) 167 setattr(self, "_{}".format('stamp_size_mm'), kwargs.get('stamp_size_mm', None)) 168 setattr(self, "_{}".format('stamp_type'), kwargs.get('stamp_type', None)) 169 setattr(self, "_{}".format('status'), kwargs.get('status', None))
UserSignature - 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', 'initials150_image_id': 'str', 'initials_image_uri': 'str', 'is_default': 'str', 'last_modified_date_time': 'str', 'nrds_id': 'str', 'nrds_last_name': 'str', 'nrds_status': 'str', 'phonetic_name': 'str', 'signature150_image_id': 'str', 'signature_font': 'str', 'signature_id': 'str', 'signature_image_uri': 'str', 'signature_initials': 'str', 'signature_name': 'str', 'signature_rights': 'str', 'signature_type': 'str', 'stamp_format': 'str', 'stamp_image_uri': 'str', 'stamp_size_mm': 'str', 'stamp_type': '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', 'initials150_image_id': 'initials150ImageId', 'initials_image_uri': 'initialsImageUri', 'is_default': 'isDefault', 'last_modified_date_time': 'lastModifiedDateTime', 'nrds_id': 'nrdsId', 'nrds_last_name': 'nrdsLastName', 'nrds_status': 'nrdsStatus', 'phonetic_name': 'phoneticName', 'signature150_image_id': 'signature150ImageId', 'signature_font': 'signatureFont', 'signature_id': 'signatureId', 'signature_image_uri': 'signatureImageUri', 'signature_initials': 'signatureInitials', 'signature_name': 'signatureName', 'signature_rights': 'signatureRights', 'signature_type': 'signatureType', 'stamp_format': 'stampFormat', 'stamp_image_uri': 'stampImageUri', 'stamp_size_mm': 'stampSizeMM', 'stamp_type': 'stampType', 'status': 'status'}
adopted_date_time
Gets the adopted_date_time of this UserSignature. # noqa: E501
The date and time the user adopted their signature. # noqa: E501
Returns
The adopted_date_time of this UserSignature. # noqa: E501
created_date_time
Gets the created_date_time of this UserSignature. # noqa: E501
Indicates the date and time the item was created. # noqa: E501
Returns
The created_date_time of this UserSignature. # noqa: E501
custom_field
Gets the custom_field of this UserSignature. # noqa: E501
# noqa: E501
Returns
The custom_field of this UserSignature. # noqa: E501
date_stamp_properties
Gets the date_stamp_properties of this UserSignature. # 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 UserSignature. # noqa: E501
disallow_user_resize_stamp
Gets the disallow_user_resize_stamp of this UserSignature. # noqa: E501
# noqa: E501
Returns
The disallow_user_resize_stamp of this UserSignature. # noqa: E501
error_details
Gets the error_details of this UserSignature. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this UserSignature. # noqa: E501
external_id
Gets the external_id of this UserSignature. # noqa: E501
# noqa: E501
Returns
The external_id of this UserSignature. # noqa: E501
image_base64
Gets the image_base64 of this UserSignature. # noqa: E501
# noqa: E501
Returns
The image_base64 of this UserSignature. # noqa: E501
image_type
Gets the image_type of this UserSignature. # noqa: E501
# noqa: E501
Returns
The image_type of this UserSignature. # noqa: E501
initials150_image_id
Gets the initials150_image_id of this UserSignature. # noqa: E501
# noqa: E501
Returns
The initials150_image_id of this UserSignature. # noqa: E501
initials_image_uri
Gets the initials_image_uri of this UserSignature. # noqa: E501
Contains the URI for an endpoint that you can use to retrieve the initials image. # noqa: E501
Returns
The initials_image_uri of this UserSignature. # noqa: E501
is_default
Gets the is_default of this UserSignature. # noqa: E501
# noqa: E501
Returns
The is_default of this UserSignature. # noqa: E501
last_modified_date_time
Gets the last_modified_date_time of this UserSignature. # noqa: E501
The date and time the item was last modified. # noqa: E501
Returns
The last_modified_date_time of this UserSignature. # noqa: E501
nrds_id
Gets the nrds_id of this UserSignature. # noqa: E501
# noqa: E501
Returns
The nrds_id of this UserSignature. # noqa: E501
nrds_last_name
Gets the nrds_last_name of this UserSignature. # noqa: E501
# noqa: E501
Returns
The nrds_last_name of this UserSignature. # noqa: E501
nrds_status
Gets the nrds_status of this UserSignature. # noqa: E501
# noqa: E501
Returns
The nrds_status of this UserSignature. # noqa: E501
phonetic_name
Gets the phonetic_name of this UserSignature. # noqa: E501
# noqa: E501
Returns
The phonetic_name of this UserSignature. # noqa: E501
signature150_image_id
Gets the signature150_image_id of this UserSignature. # noqa: E501
# noqa: E501
Returns
The signature150_image_id of this UserSignature. # noqa: E501
signature_font
Gets the signature_font of this UserSignature. # noqa: E501
The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic" # noqa: E501
Returns
The signature_font of this UserSignature. # noqa: E501
signature_id
Gets the signature_id of this UserSignature. # noqa: E501
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. # noqa: E501
Returns
The signature_id of this UserSignature. # noqa: E501
signature_image_uri
Gets the signature_image_uri of this UserSignature. # noqa: E501
Contains the URI for an endpoint that you can use to retrieve the signature image. # noqa: E501
Returns
The signature_image_uri of this UserSignature. # noqa: E501
signature_initials
Gets the signature_initials of this UserSignature. # noqa: E501
The initials associated with the signature. # noqa: E501
Returns
The signature_initials of this UserSignature. # noqa: E501
signature_name
Gets the signature_name of this UserSignature. # noqa: E501
Specifies the user signature name. # noqa: E501
Returns
The signature_name of this UserSignature. # noqa: E501
signature_rights
Gets the signature_rights of this UserSignature. # noqa: E501
# noqa: E501
Returns
The signature_rights of this UserSignature. # noqa: E501
signature_type
Gets the signature_type of this UserSignature. # noqa: E501
# noqa: E501
Returns
The signature_type of this UserSignature. # noqa: E501
stamp_format
Gets the stamp_format of this UserSignature. # noqa: E501
# noqa: E501
Returns
The stamp_format of this UserSignature. # noqa: E501
stamp_image_uri
Gets the stamp_image_uri of this UserSignature. # noqa: E501
# noqa: E501
Returns
The stamp_image_uri of this UserSignature. # noqa: E501
stamp_size_mm
Gets the stamp_size_mm of this UserSignature. # noqa: E501
# noqa: E501
Returns
The stamp_size_mm of this UserSignature. # noqa: E501
stamp_type
Gets the stamp_type of this UserSignature. # noqa: E501
# noqa: E501
Returns
The stamp_type of this UserSignature. # noqa: E501
status
Gets the status of this UserSignature. # 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 UserSignature. # noqa: E501
def
to_dict(self)
861 def to_dict(self): 862 """Returns the model properties as a dict""" 863 result = {} 864 865 for attr, _ in six.iteritems(self.swagger_types): 866 value = getattr(self, attr) 867 if isinstance(value, list): 868 result[attr] = list(map( 869 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 870 value 871 )) 872 elif hasattr(value, "to_dict"): 873 result[attr] = value.to_dict() 874 elif isinstance(value, dict): 875 result[attr] = dict(map( 876 lambda item: (item[0], item[1].to_dict()) 877 if hasattr(item[1], "to_dict") else item, 878 value.items() 879 )) 880 else: 881 result[attr] = value 882 if issubclass(UserSignature, dict): 883 for key, value in self.items(): 884 result[key] = value 885 886 return result
Returns the model properties as a dict