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