docusign_esign.models.display_appliance_envelope
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
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 REST API 5 6 The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. 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 14from pprint import pformat 15from six import iteritems 16import re 17 18 19class DisplayApplianceEnvelope(object): 20 """ 21 NOTE: This class is auto generated by the swagger code generator program. 22 Do not edit the class manually. 23 """ 24 def __init__(self, account_id=None, add_demo_stamp=None, allow_multiple_attachments=None, burn_default_tab_data=None, company_name=None, convert_pdf_fields=None, custom_field_version=None, envelope_id=None, envelope_type=None, include_sigs_before_complete=None, is_concat_mode=None, is_envelope_id_stamping_enabled=None, pdf_form_conversion_font_scale100=None, should_flatten=None, show_envelope_changes=None, signing_location=None, sign_online=None, status=None, user_id=None): 25 """ 26 DisplayApplianceEnvelope - a model defined in Swagger 27 28 :param dict swaggerTypes: The key is attribute name 29 and the value is attribute type. 30 :param dict attributeMap: The key is attribute name 31 and the value is json key in definition. 32 """ 33 self.swagger_types = { 34 'account_id': 'str', 35 'add_demo_stamp': 'bool', 36 'allow_multiple_attachments': 'bool', 37 'burn_default_tab_data': 'bool', 38 'company_name': 'str', 39 'convert_pdf_fields': 'bool', 40 'custom_field_version': 'str', 41 'envelope_id': 'str', 42 'envelope_type': 'str', 43 'include_sigs_before_complete': 'bool', 44 'is_concat_mode': 'bool', 45 'is_envelope_id_stamping_enabled': 'bool', 46 'pdf_form_conversion_font_scale100': 'bool', 47 'should_flatten': 'bool', 48 'show_envelope_changes': 'bool', 49 'signing_location': 'str', 50 'sign_online': 'bool', 51 'status': 'str', 52 'user_id': 'str' 53 } 54 55 self.attribute_map = { 56 'account_id': 'accountId', 57 'add_demo_stamp': 'addDemoStamp', 58 'allow_multiple_attachments': 'allowMultipleAttachments', 59 'burn_default_tab_data': 'burnDefaultTabData', 60 'company_name': 'companyName', 61 'convert_pdf_fields': 'convertPdfFields', 62 'custom_field_version': 'customFieldVersion', 63 'envelope_id': 'envelopeId', 64 'envelope_type': 'envelopeType', 65 'include_sigs_before_complete': 'includeSigsBeforeComplete', 66 'is_concat_mode': 'isConcatMode', 67 'is_envelope_id_stamping_enabled': 'isEnvelopeIDStampingEnabled', 68 'pdf_form_conversion_font_scale100': 'pdfFormConversionFontScale100', 69 'should_flatten': 'shouldFlatten', 70 'show_envelope_changes': 'showEnvelopeChanges', 71 'signing_location': 'signingLocation', 72 'sign_online': 'signOnline', 73 'status': 'status', 74 'user_id': 'userId' 75 } 76 77 self._account_id = account_id 78 self._add_demo_stamp = add_demo_stamp 79 self._allow_multiple_attachments = allow_multiple_attachments 80 self._burn_default_tab_data = burn_default_tab_data 81 self._company_name = company_name 82 self._convert_pdf_fields = convert_pdf_fields 83 self._custom_field_version = custom_field_version 84 self._envelope_id = envelope_id 85 self._envelope_type = envelope_type 86 self._include_sigs_before_complete = include_sigs_before_complete 87 self._is_concat_mode = is_concat_mode 88 self._is_envelope_id_stamping_enabled = is_envelope_id_stamping_enabled 89 self._pdf_form_conversion_font_scale100 = pdf_form_conversion_font_scale100 90 self._should_flatten = should_flatten 91 self._show_envelope_changes = show_envelope_changes 92 self._signing_location = signing_location 93 self._sign_online = sign_online 94 self._status = status 95 self._user_id = user_id 96 97 @property 98 def account_id(self): 99 """ 100 Gets the account_id of this DisplayApplianceEnvelope. 101 The account ID associated with the envelope. 102 103 :return: The account_id of this DisplayApplianceEnvelope. 104 :rtype: str 105 """ 106 return self._account_id 107 108 @account_id.setter 109 def account_id(self, account_id): 110 """ 111 Sets the account_id of this DisplayApplianceEnvelope. 112 The account ID associated with the envelope. 113 114 :param account_id: The account_id of this DisplayApplianceEnvelope. 115 :type: str 116 """ 117 118 self._account_id = account_id 119 120 @property 121 def add_demo_stamp(self): 122 """ 123 Gets the add_demo_stamp of this DisplayApplianceEnvelope. 124 125 126 :return: The add_demo_stamp of this DisplayApplianceEnvelope. 127 :rtype: bool 128 """ 129 return self._add_demo_stamp 130 131 @add_demo_stamp.setter 132 def add_demo_stamp(self, add_demo_stamp): 133 """ 134 Sets the add_demo_stamp of this DisplayApplianceEnvelope. 135 136 137 :param add_demo_stamp: The add_demo_stamp of this DisplayApplianceEnvelope. 138 :type: bool 139 """ 140 141 self._add_demo_stamp = add_demo_stamp 142 143 @property 144 def allow_multiple_attachments(self): 145 """ 146 Gets the allow_multiple_attachments of this DisplayApplianceEnvelope. 147 148 149 :return: The allow_multiple_attachments of this DisplayApplianceEnvelope. 150 :rtype: bool 151 """ 152 return self._allow_multiple_attachments 153 154 @allow_multiple_attachments.setter 155 def allow_multiple_attachments(self, allow_multiple_attachments): 156 """ 157 Sets the allow_multiple_attachments of this DisplayApplianceEnvelope. 158 159 160 :param allow_multiple_attachments: The allow_multiple_attachments of this DisplayApplianceEnvelope. 161 :type: bool 162 """ 163 164 self._allow_multiple_attachments = allow_multiple_attachments 165 166 @property 167 def burn_default_tab_data(self): 168 """ 169 Gets the burn_default_tab_data of this DisplayApplianceEnvelope. 170 171 172 :return: The burn_default_tab_data of this DisplayApplianceEnvelope. 173 :rtype: bool 174 """ 175 return self._burn_default_tab_data 176 177 @burn_default_tab_data.setter 178 def burn_default_tab_data(self, burn_default_tab_data): 179 """ 180 Sets the burn_default_tab_data of this DisplayApplianceEnvelope. 181 182 183 :param burn_default_tab_data: The burn_default_tab_data of this DisplayApplianceEnvelope. 184 :type: bool 185 """ 186 187 self._burn_default_tab_data = burn_default_tab_data 188 189 @property 190 def company_name(self): 191 """ 192 Gets the company_name of this DisplayApplianceEnvelope. 193 194 195 :return: The company_name of this DisplayApplianceEnvelope. 196 :rtype: str 197 """ 198 return self._company_name 199 200 @company_name.setter 201 def company_name(self, company_name): 202 """ 203 Sets the company_name of this DisplayApplianceEnvelope. 204 205 206 :param company_name: The company_name of this DisplayApplianceEnvelope. 207 :type: str 208 """ 209 210 self._company_name = company_name 211 212 @property 213 def convert_pdf_fields(self): 214 """ 215 Gets the convert_pdf_fields of this DisplayApplianceEnvelope. 216 217 218 :return: The convert_pdf_fields of this DisplayApplianceEnvelope. 219 :rtype: bool 220 """ 221 return self._convert_pdf_fields 222 223 @convert_pdf_fields.setter 224 def convert_pdf_fields(self, convert_pdf_fields): 225 """ 226 Sets the convert_pdf_fields of this DisplayApplianceEnvelope. 227 228 229 :param convert_pdf_fields: The convert_pdf_fields of this DisplayApplianceEnvelope. 230 :type: bool 231 """ 232 233 self._convert_pdf_fields = convert_pdf_fields 234 235 @property 236 def custom_field_version(self): 237 """ 238 Gets the custom_field_version of this DisplayApplianceEnvelope. 239 240 241 :return: The custom_field_version of this DisplayApplianceEnvelope. 242 :rtype: str 243 """ 244 return self._custom_field_version 245 246 @custom_field_version.setter 247 def custom_field_version(self, custom_field_version): 248 """ 249 Sets the custom_field_version of this DisplayApplianceEnvelope. 250 251 252 :param custom_field_version: The custom_field_version of this DisplayApplianceEnvelope. 253 :type: str 254 """ 255 256 self._custom_field_version = custom_field_version 257 258 @property 259 def envelope_id(self): 260 """ 261 Gets the envelope_id of this DisplayApplianceEnvelope. 262 The envelope ID of the envelope status that failed to post. 263 264 :return: The envelope_id of this DisplayApplianceEnvelope. 265 :rtype: str 266 """ 267 return self._envelope_id 268 269 @envelope_id.setter 270 def envelope_id(self, envelope_id): 271 """ 272 Sets the envelope_id of this DisplayApplianceEnvelope. 273 The envelope ID of the envelope status that failed to post. 274 275 :param envelope_id: The envelope_id of this DisplayApplianceEnvelope. 276 :type: str 277 """ 278 279 self._envelope_id = envelope_id 280 281 @property 282 def envelope_type(self): 283 """ 284 Gets the envelope_type of this DisplayApplianceEnvelope. 285 286 287 :return: The envelope_type of this DisplayApplianceEnvelope. 288 :rtype: str 289 """ 290 return self._envelope_type 291 292 @envelope_type.setter 293 def envelope_type(self, envelope_type): 294 """ 295 Sets the envelope_type of this DisplayApplianceEnvelope. 296 297 298 :param envelope_type: The envelope_type of this DisplayApplianceEnvelope. 299 :type: str 300 """ 301 302 self._envelope_type = envelope_type 303 304 @property 305 def include_sigs_before_complete(self): 306 """ 307 Gets the include_sigs_before_complete of this DisplayApplianceEnvelope. 308 309 310 :return: The include_sigs_before_complete of this DisplayApplianceEnvelope. 311 :rtype: bool 312 """ 313 return self._include_sigs_before_complete 314 315 @include_sigs_before_complete.setter 316 def include_sigs_before_complete(self, include_sigs_before_complete): 317 """ 318 Sets the include_sigs_before_complete of this DisplayApplianceEnvelope. 319 320 321 :param include_sigs_before_complete: The include_sigs_before_complete of this DisplayApplianceEnvelope. 322 :type: bool 323 """ 324 325 self._include_sigs_before_complete = include_sigs_before_complete 326 327 @property 328 def is_concat_mode(self): 329 """ 330 Gets the is_concat_mode of this DisplayApplianceEnvelope. 331 332 333 :return: The is_concat_mode of this DisplayApplianceEnvelope. 334 :rtype: bool 335 """ 336 return self._is_concat_mode 337 338 @is_concat_mode.setter 339 def is_concat_mode(self, is_concat_mode): 340 """ 341 Sets the is_concat_mode of this DisplayApplianceEnvelope. 342 343 344 :param is_concat_mode: The is_concat_mode of this DisplayApplianceEnvelope. 345 :type: bool 346 """ 347 348 self._is_concat_mode = is_concat_mode 349 350 @property 351 def is_envelope_id_stamping_enabled(self): 352 """ 353 Gets the is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 354 355 356 :return: The is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 357 :rtype: bool 358 """ 359 return self._is_envelope_id_stamping_enabled 360 361 @is_envelope_id_stamping_enabled.setter 362 def is_envelope_id_stamping_enabled(self, is_envelope_id_stamping_enabled): 363 """ 364 Sets the is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 365 366 367 :param is_envelope_id_stamping_enabled: The is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 368 :type: bool 369 """ 370 371 self._is_envelope_id_stamping_enabled = is_envelope_id_stamping_enabled 372 373 @property 374 def pdf_form_conversion_font_scale100(self): 375 """ 376 Gets the pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 377 378 379 :return: The pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 380 :rtype: bool 381 """ 382 return self._pdf_form_conversion_font_scale100 383 384 @pdf_form_conversion_font_scale100.setter 385 def pdf_form_conversion_font_scale100(self, pdf_form_conversion_font_scale100): 386 """ 387 Sets the pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 388 389 390 :param pdf_form_conversion_font_scale100: The pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 391 :type: bool 392 """ 393 394 self._pdf_form_conversion_font_scale100 = pdf_form_conversion_font_scale100 395 396 @property 397 def should_flatten(self): 398 """ 399 Gets the should_flatten of this DisplayApplianceEnvelope. 400 401 402 :return: The should_flatten of this DisplayApplianceEnvelope. 403 :rtype: bool 404 """ 405 return self._should_flatten 406 407 @should_flatten.setter 408 def should_flatten(self, should_flatten): 409 """ 410 Sets the should_flatten of this DisplayApplianceEnvelope. 411 412 413 :param should_flatten: The should_flatten of this DisplayApplianceEnvelope. 414 :type: bool 415 """ 416 417 self._should_flatten = should_flatten 418 419 @property 420 def show_envelope_changes(self): 421 """ 422 Gets the show_envelope_changes of this DisplayApplianceEnvelope. 423 424 425 :return: The show_envelope_changes of this DisplayApplianceEnvelope. 426 :rtype: bool 427 """ 428 return self._show_envelope_changes 429 430 @show_envelope_changes.setter 431 def show_envelope_changes(self, show_envelope_changes): 432 """ 433 Sets the show_envelope_changes of this DisplayApplianceEnvelope. 434 435 436 :param show_envelope_changes: The show_envelope_changes of this DisplayApplianceEnvelope. 437 :type: bool 438 """ 439 440 self._show_envelope_changes = show_envelope_changes 441 442 @property 443 def signing_location(self): 444 """ 445 Gets the signing_location of this DisplayApplianceEnvelope. 446 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. 447 448 :return: The signing_location of this DisplayApplianceEnvelope. 449 :rtype: str 450 """ 451 return self._signing_location 452 453 @signing_location.setter 454 def signing_location(self, signing_location): 455 """ 456 Sets the signing_location of this DisplayApplianceEnvelope. 457 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. 458 459 :param signing_location: The signing_location of this DisplayApplianceEnvelope. 460 :type: str 461 """ 462 463 self._signing_location = signing_location 464 465 @property 466 def sign_online(self): 467 """ 468 Gets the sign_online of this DisplayApplianceEnvelope. 469 470 471 :return: The sign_online of this DisplayApplianceEnvelope. 472 :rtype: bool 473 """ 474 return self._sign_online 475 476 @sign_online.setter 477 def sign_online(self, sign_online): 478 """ 479 Sets the sign_online of this DisplayApplianceEnvelope. 480 481 482 :param sign_online: The sign_online of this DisplayApplianceEnvelope. 483 :type: bool 484 """ 485 486 self._sign_online = sign_online 487 488 @property 489 def status(self): 490 """ 491 Gets the status of this DisplayApplianceEnvelope. 492 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. 493 494 :return: The status of this DisplayApplianceEnvelope. 495 :rtype: str 496 """ 497 return self._status 498 499 @status.setter 500 def status(self, status): 501 """ 502 Sets the status of this DisplayApplianceEnvelope. 503 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. 504 505 :param status: The status of this DisplayApplianceEnvelope. 506 :type: str 507 """ 508 509 self._status = status 510 511 @property 512 def user_id(self): 513 """ 514 Gets the user_id of this DisplayApplianceEnvelope. 515 516 517 :return: The user_id of this DisplayApplianceEnvelope. 518 :rtype: str 519 """ 520 return self._user_id 521 522 @user_id.setter 523 def user_id(self, user_id): 524 """ 525 Sets the user_id of this DisplayApplianceEnvelope. 526 527 528 :param user_id: The user_id of this DisplayApplianceEnvelope. 529 :type: str 530 """ 531 532 self._user_id = user_id 533 534 def to_dict(self): 535 """ 536 Returns the model properties as a dict 537 """ 538 result = {} 539 540 for attr, _ in iteritems(self.swagger_types): 541 value = getattr(self, attr) 542 if isinstance(value, list): 543 result[attr] = list(map( 544 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 545 value 546 )) 547 elif hasattr(value, "to_dict"): 548 result[attr] = value.to_dict() 549 elif isinstance(value, dict): 550 result[attr] = dict(map( 551 lambda item: (item[0], item[1].to_dict()) 552 if hasattr(item[1], "to_dict") else item, 553 value.items() 554 )) 555 else: 556 result[attr] = value 557 558 return result 559 560 def to_str(self): 561 """ 562 Returns the string representation of the model 563 """ 564 return pformat(self.to_dict()) 565 566 def __repr__(self): 567 """ 568 For `print` and `pprint` 569 """ 570 return self.to_str() 571 572 def __eq__(self, other): 573 """ 574 Returns true if both objects are equal 575 """ 576 return self.__dict__ == other.__dict__ 577 578 def __ne__(self, other): 579 """ 580 Returns true if both objects are not equal 581 """ 582 return not self == other
class
DisplayApplianceEnvelope:
20class DisplayApplianceEnvelope(object): 21 """ 22 NOTE: This class is auto generated by the swagger code generator program. 23 Do not edit the class manually. 24 """ 25 def __init__(self, account_id=None, add_demo_stamp=None, allow_multiple_attachments=None, burn_default_tab_data=None, company_name=None, convert_pdf_fields=None, custom_field_version=None, envelope_id=None, envelope_type=None, include_sigs_before_complete=None, is_concat_mode=None, is_envelope_id_stamping_enabled=None, pdf_form_conversion_font_scale100=None, should_flatten=None, show_envelope_changes=None, signing_location=None, sign_online=None, status=None, user_id=None): 26 """ 27 DisplayApplianceEnvelope - a model defined in Swagger 28 29 :param dict swaggerTypes: The key is attribute name 30 and the value is attribute type. 31 :param dict attributeMap: The key is attribute name 32 and the value is json key in definition. 33 """ 34 self.swagger_types = { 35 'account_id': 'str', 36 'add_demo_stamp': 'bool', 37 'allow_multiple_attachments': 'bool', 38 'burn_default_tab_data': 'bool', 39 'company_name': 'str', 40 'convert_pdf_fields': 'bool', 41 'custom_field_version': 'str', 42 'envelope_id': 'str', 43 'envelope_type': 'str', 44 'include_sigs_before_complete': 'bool', 45 'is_concat_mode': 'bool', 46 'is_envelope_id_stamping_enabled': 'bool', 47 'pdf_form_conversion_font_scale100': 'bool', 48 'should_flatten': 'bool', 49 'show_envelope_changes': 'bool', 50 'signing_location': 'str', 51 'sign_online': 'bool', 52 'status': 'str', 53 'user_id': 'str' 54 } 55 56 self.attribute_map = { 57 'account_id': 'accountId', 58 'add_demo_stamp': 'addDemoStamp', 59 'allow_multiple_attachments': 'allowMultipleAttachments', 60 'burn_default_tab_data': 'burnDefaultTabData', 61 'company_name': 'companyName', 62 'convert_pdf_fields': 'convertPdfFields', 63 'custom_field_version': 'customFieldVersion', 64 'envelope_id': 'envelopeId', 65 'envelope_type': 'envelopeType', 66 'include_sigs_before_complete': 'includeSigsBeforeComplete', 67 'is_concat_mode': 'isConcatMode', 68 'is_envelope_id_stamping_enabled': 'isEnvelopeIDStampingEnabled', 69 'pdf_form_conversion_font_scale100': 'pdfFormConversionFontScale100', 70 'should_flatten': 'shouldFlatten', 71 'show_envelope_changes': 'showEnvelopeChanges', 72 'signing_location': 'signingLocation', 73 'sign_online': 'signOnline', 74 'status': 'status', 75 'user_id': 'userId' 76 } 77 78 self._account_id = account_id 79 self._add_demo_stamp = add_demo_stamp 80 self._allow_multiple_attachments = allow_multiple_attachments 81 self._burn_default_tab_data = burn_default_tab_data 82 self._company_name = company_name 83 self._convert_pdf_fields = convert_pdf_fields 84 self._custom_field_version = custom_field_version 85 self._envelope_id = envelope_id 86 self._envelope_type = envelope_type 87 self._include_sigs_before_complete = include_sigs_before_complete 88 self._is_concat_mode = is_concat_mode 89 self._is_envelope_id_stamping_enabled = is_envelope_id_stamping_enabled 90 self._pdf_form_conversion_font_scale100 = pdf_form_conversion_font_scale100 91 self._should_flatten = should_flatten 92 self._show_envelope_changes = show_envelope_changes 93 self._signing_location = signing_location 94 self._sign_online = sign_online 95 self._status = status 96 self._user_id = user_id 97 98 @property 99 def account_id(self): 100 """ 101 Gets the account_id of this DisplayApplianceEnvelope. 102 The account ID associated with the envelope. 103 104 :return: The account_id of this DisplayApplianceEnvelope. 105 :rtype: str 106 """ 107 return self._account_id 108 109 @account_id.setter 110 def account_id(self, account_id): 111 """ 112 Sets the account_id of this DisplayApplianceEnvelope. 113 The account ID associated with the envelope. 114 115 :param account_id: The account_id of this DisplayApplianceEnvelope. 116 :type: str 117 """ 118 119 self._account_id = account_id 120 121 @property 122 def add_demo_stamp(self): 123 """ 124 Gets the add_demo_stamp of this DisplayApplianceEnvelope. 125 126 127 :return: The add_demo_stamp of this DisplayApplianceEnvelope. 128 :rtype: bool 129 """ 130 return self._add_demo_stamp 131 132 @add_demo_stamp.setter 133 def add_demo_stamp(self, add_demo_stamp): 134 """ 135 Sets the add_demo_stamp of this DisplayApplianceEnvelope. 136 137 138 :param add_demo_stamp: The add_demo_stamp of this DisplayApplianceEnvelope. 139 :type: bool 140 """ 141 142 self._add_demo_stamp = add_demo_stamp 143 144 @property 145 def allow_multiple_attachments(self): 146 """ 147 Gets the allow_multiple_attachments of this DisplayApplianceEnvelope. 148 149 150 :return: The allow_multiple_attachments of this DisplayApplianceEnvelope. 151 :rtype: bool 152 """ 153 return self._allow_multiple_attachments 154 155 @allow_multiple_attachments.setter 156 def allow_multiple_attachments(self, allow_multiple_attachments): 157 """ 158 Sets the allow_multiple_attachments of this DisplayApplianceEnvelope. 159 160 161 :param allow_multiple_attachments: The allow_multiple_attachments of this DisplayApplianceEnvelope. 162 :type: bool 163 """ 164 165 self._allow_multiple_attachments = allow_multiple_attachments 166 167 @property 168 def burn_default_tab_data(self): 169 """ 170 Gets the burn_default_tab_data of this DisplayApplianceEnvelope. 171 172 173 :return: The burn_default_tab_data of this DisplayApplianceEnvelope. 174 :rtype: bool 175 """ 176 return self._burn_default_tab_data 177 178 @burn_default_tab_data.setter 179 def burn_default_tab_data(self, burn_default_tab_data): 180 """ 181 Sets the burn_default_tab_data of this DisplayApplianceEnvelope. 182 183 184 :param burn_default_tab_data: The burn_default_tab_data of this DisplayApplianceEnvelope. 185 :type: bool 186 """ 187 188 self._burn_default_tab_data = burn_default_tab_data 189 190 @property 191 def company_name(self): 192 """ 193 Gets the company_name of this DisplayApplianceEnvelope. 194 195 196 :return: The company_name of this DisplayApplianceEnvelope. 197 :rtype: str 198 """ 199 return self._company_name 200 201 @company_name.setter 202 def company_name(self, company_name): 203 """ 204 Sets the company_name of this DisplayApplianceEnvelope. 205 206 207 :param company_name: The company_name of this DisplayApplianceEnvelope. 208 :type: str 209 """ 210 211 self._company_name = company_name 212 213 @property 214 def convert_pdf_fields(self): 215 """ 216 Gets the convert_pdf_fields of this DisplayApplianceEnvelope. 217 218 219 :return: The convert_pdf_fields of this DisplayApplianceEnvelope. 220 :rtype: bool 221 """ 222 return self._convert_pdf_fields 223 224 @convert_pdf_fields.setter 225 def convert_pdf_fields(self, convert_pdf_fields): 226 """ 227 Sets the convert_pdf_fields of this DisplayApplianceEnvelope. 228 229 230 :param convert_pdf_fields: The convert_pdf_fields of this DisplayApplianceEnvelope. 231 :type: bool 232 """ 233 234 self._convert_pdf_fields = convert_pdf_fields 235 236 @property 237 def custom_field_version(self): 238 """ 239 Gets the custom_field_version of this DisplayApplianceEnvelope. 240 241 242 :return: The custom_field_version of this DisplayApplianceEnvelope. 243 :rtype: str 244 """ 245 return self._custom_field_version 246 247 @custom_field_version.setter 248 def custom_field_version(self, custom_field_version): 249 """ 250 Sets the custom_field_version of this DisplayApplianceEnvelope. 251 252 253 :param custom_field_version: The custom_field_version of this DisplayApplianceEnvelope. 254 :type: str 255 """ 256 257 self._custom_field_version = custom_field_version 258 259 @property 260 def envelope_id(self): 261 """ 262 Gets the envelope_id of this DisplayApplianceEnvelope. 263 The envelope ID of the envelope status that failed to post. 264 265 :return: The envelope_id of this DisplayApplianceEnvelope. 266 :rtype: str 267 """ 268 return self._envelope_id 269 270 @envelope_id.setter 271 def envelope_id(self, envelope_id): 272 """ 273 Sets the envelope_id of this DisplayApplianceEnvelope. 274 The envelope ID of the envelope status that failed to post. 275 276 :param envelope_id: The envelope_id of this DisplayApplianceEnvelope. 277 :type: str 278 """ 279 280 self._envelope_id = envelope_id 281 282 @property 283 def envelope_type(self): 284 """ 285 Gets the envelope_type of this DisplayApplianceEnvelope. 286 287 288 :return: The envelope_type of this DisplayApplianceEnvelope. 289 :rtype: str 290 """ 291 return self._envelope_type 292 293 @envelope_type.setter 294 def envelope_type(self, envelope_type): 295 """ 296 Sets the envelope_type of this DisplayApplianceEnvelope. 297 298 299 :param envelope_type: The envelope_type of this DisplayApplianceEnvelope. 300 :type: str 301 """ 302 303 self._envelope_type = envelope_type 304 305 @property 306 def include_sigs_before_complete(self): 307 """ 308 Gets the include_sigs_before_complete of this DisplayApplianceEnvelope. 309 310 311 :return: The include_sigs_before_complete of this DisplayApplianceEnvelope. 312 :rtype: bool 313 """ 314 return self._include_sigs_before_complete 315 316 @include_sigs_before_complete.setter 317 def include_sigs_before_complete(self, include_sigs_before_complete): 318 """ 319 Sets the include_sigs_before_complete of this DisplayApplianceEnvelope. 320 321 322 :param include_sigs_before_complete: The include_sigs_before_complete of this DisplayApplianceEnvelope. 323 :type: bool 324 """ 325 326 self._include_sigs_before_complete = include_sigs_before_complete 327 328 @property 329 def is_concat_mode(self): 330 """ 331 Gets the is_concat_mode of this DisplayApplianceEnvelope. 332 333 334 :return: The is_concat_mode of this DisplayApplianceEnvelope. 335 :rtype: bool 336 """ 337 return self._is_concat_mode 338 339 @is_concat_mode.setter 340 def is_concat_mode(self, is_concat_mode): 341 """ 342 Sets the is_concat_mode of this DisplayApplianceEnvelope. 343 344 345 :param is_concat_mode: The is_concat_mode of this DisplayApplianceEnvelope. 346 :type: bool 347 """ 348 349 self._is_concat_mode = is_concat_mode 350 351 @property 352 def is_envelope_id_stamping_enabled(self): 353 """ 354 Gets the is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 355 356 357 :return: The is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 358 :rtype: bool 359 """ 360 return self._is_envelope_id_stamping_enabled 361 362 @is_envelope_id_stamping_enabled.setter 363 def is_envelope_id_stamping_enabled(self, is_envelope_id_stamping_enabled): 364 """ 365 Sets the is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 366 367 368 :param is_envelope_id_stamping_enabled: The is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope. 369 :type: bool 370 """ 371 372 self._is_envelope_id_stamping_enabled = is_envelope_id_stamping_enabled 373 374 @property 375 def pdf_form_conversion_font_scale100(self): 376 """ 377 Gets the pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 378 379 380 :return: The pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 381 :rtype: bool 382 """ 383 return self._pdf_form_conversion_font_scale100 384 385 @pdf_form_conversion_font_scale100.setter 386 def pdf_form_conversion_font_scale100(self, pdf_form_conversion_font_scale100): 387 """ 388 Sets the pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 389 390 391 :param pdf_form_conversion_font_scale100: The pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope. 392 :type: bool 393 """ 394 395 self._pdf_form_conversion_font_scale100 = pdf_form_conversion_font_scale100 396 397 @property 398 def should_flatten(self): 399 """ 400 Gets the should_flatten of this DisplayApplianceEnvelope. 401 402 403 :return: The should_flatten of this DisplayApplianceEnvelope. 404 :rtype: bool 405 """ 406 return self._should_flatten 407 408 @should_flatten.setter 409 def should_flatten(self, should_flatten): 410 """ 411 Sets the should_flatten of this DisplayApplianceEnvelope. 412 413 414 :param should_flatten: The should_flatten of this DisplayApplianceEnvelope. 415 :type: bool 416 """ 417 418 self._should_flatten = should_flatten 419 420 @property 421 def show_envelope_changes(self): 422 """ 423 Gets the show_envelope_changes of this DisplayApplianceEnvelope. 424 425 426 :return: The show_envelope_changes of this DisplayApplianceEnvelope. 427 :rtype: bool 428 """ 429 return self._show_envelope_changes 430 431 @show_envelope_changes.setter 432 def show_envelope_changes(self, show_envelope_changes): 433 """ 434 Sets the show_envelope_changes of this DisplayApplianceEnvelope. 435 436 437 :param show_envelope_changes: The show_envelope_changes of this DisplayApplianceEnvelope. 438 :type: bool 439 """ 440 441 self._show_envelope_changes = show_envelope_changes 442 443 @property 444 def signing_location(self): 445 """ 446 Gets the signing_location of this DisplayApplianceEnvelope. 447 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. 448 449 :return: The signing_location of this DisplayApplianceEnvelope. 450 :rtype: str 451 """ 452 return self._signing_location 453 454 @signing_location.setter 455 def signing_location(self, signing_location): 456 """ 457 Sets the signing_location of this DisplayApplianceEnvelope. 458 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. 459 460 :param signing_location: The signing_location of this DisplayApplianceEnvelope. 461 :type: str 462 """ 463 464 self._signing_location = signing_location 465 466 @property 467 def sign_online(self): 468 """ 469 Gets the sign_online of this DisplayApplianceEnvelope. 470 471 472 :return: The sign_online of this DisplayApplianceEnvelope. 473 :rtype: bool 474 """ 475 return self._sign_online 476 477 @sign_online.setter 478 def sign_online(self, sign_online): 479 """ 480 Sets the sign_online of this DisplayApplianceEnvelope. 481 482 483 :param sign_online: The sign_online of this DisplayApplianceEnvelope. 484 :type: bool 485 """ 486 487 self._sign_online = sign_online 488 489 @property 490 def status(self): 491 """ 492 Gets the status of this DisplayApplianceEnvelope. 493 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. 494 495 :return: The status of this DisplayApplianceEnvelope. 496 :rtype: str 497 """ 498 return self._status 499 500 @status.setter 501 def status(self, status): 502 """ 503 Sets the status of this DisplayApplianceEnvelope. 504 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. 505 506 :param status: The status of this DisplayApplianceEnvelope. 507 :type: str 508 """ 509 510 self._status = status 511 512 @property 513 def user_id(self): 514 """ 515 Gets the user_id of this DisplayApplianceEnvelope. 516 517 518 :return: The user_id of this DisplayApplianceEnvelope. 519 :rtype: str 520 """ 521 return self._user_id 522 523 @user_id.setter 524 def user_id(self, user_id): 525 """ 526 Sets the user_id of this DisplayApplianceEnvelope. 527 528 529 :param user_id: The user_id of this DisplayApplianceEnvelope. 530 :type: str 531 """ 532 533 self._user_id = user_id 534 535 def to_dict(self): 536 """ 537 Returns the model properties as a dict 538 """ 539 result = {} 540 541 for attr, _ in iteritems(self.swagger_types): 542 value = getattr(self, attr) 543 if isinstance(value, list): 544 result[attr] = list(map( 545 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 546 value 547 )) 548 elif hasattr(value, "to_dict"): 549 result[attr] = value.to_dict() 550 elif isinstance(value, dict): 551 result[attr] = dict(map( 552 lambda item: (item[0], item[1].to_dict()) 553 if hasattr(item[1], "to_dict") else item, 554 value.items() 555 )) 556 else: 557 result[attr] = value 558 559 return result 560 561 def to_str(self): 562 """ 563 Returns the string representation of the model 564 """ 565 return pformat(self.to_dict()) 566 567 def __repr__(self): 568 """ 569 For `print` and `pprint` 570 """ 571 return self.to_str() 572 573 def __eq__(self, other): 574 """ 575 Returns true if both objects are equal 576 """ 577 return self.__dict__ == other.__dict__ 578 579 def __ne__(self, other): 580 """ 581 Returns true if both objects are not equal 582 """ 583 return not self == other
NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.
DisplayApplianceEnvelope( account_id=None, add_demo_stamp=None, allow_multiple_attachments=None, burn_default_tab_data=None, company_name=None, convert_pdf_fields=None, custom_field_version=None, envelope_id=None, envelope_type=None, include_sigs_before_complete=None, is_concat_mode=None, is_envelope_id_stamping_enabled=None, pdf_form_conversion_font_scale100=None, should_flatten=None, show_envelope_changes=None, signing_location=None, sign_online=None, status=None, user_id=None)
25 def __init__(self, account_id=None, add_demo_stamp=None, allow_multiple_attachments=None, burn_default_tab_data=None, company_name=None, convert_pdf_fields=None, custom_field_version=None, envelope_id=None, envelope_type=None, include_sigs_before_complete=None, is_concat_mode=None, is_envelope_id_stamping_enabled=None, pdf_form_conversion_font_scale100=None, should_flatten=None, show_envelope_changes=None, signing_location=None, sign_online=None, status=None, user_id=None): 26 """ 27 DisplayApplianceEnvelope - a model defined in Swagger 28 29 :param dict swaggerTypes: The key is attribute name 30 and the value is attribute type. 31 :param dict attributeMap: The key is attribute name 32 and the value is json key in definition. 33 """ 34 self.swagger_types = { 35 'account_id': 'str', 36 'add_demo_stamp': 'bool', 37 'allow_multiple_attachments': 'bool', 38 'burn_default_tab_data': 'bool', 39 'company_name': 'str', 40 'convert_pdf_fields': 'bool', 41 'custom_field_version': 'str', 42 'envelope_id': 'str', 43 'envelope_type': 'str', 44 'include_sigs_before_complete': 'bool', 45 'is_concat_mode': 'bool', 46 'is_envelope_id_stamping_enabled': 'bool', 47 'pdf_form_conversion_font_scale100': 'bool', 48 'should_flatten': 'bool', 49 'show_envelope_changes': 'bool', 50 'signing_location': 'str', 51 'sign_online': 'bool', 52 'status': 'str', 53 'user_id': 'str' 54 } 55 56 self.attribute_map = { 57 'account_id': 'accountId', 58 'add_demo_stamp': 'addDemoStamp', 59 'allow_multiple_attachments': 'allowMultipleAttachments', 60 'burn_default_tab_data': 'burnDefaultTabData', 61 'company_name': 'companyName', 62 'convert_pdf_fields': 'convertPdfFields', 63 'custom_field_version': 'customFieldVersion', 64 'envelope_id': 'envelopeId', 65 'envelope_type': 'envelopeType', 66 'include_sigs_before_complete': 'includeSigsBeforeComplete', 67 'is_concat_mode': 'isConcatMode', 68 'is_envelope_id_stamping_enabled': 'isEnvelopeIDStampingEnabled', 69 'pdf_form_conversion_font_scale100': 'pdfFormConversionFontScale100', 70 'should_flatten': 'shouldFlatten', 71 'show_envelope_changes': 'showEnvelopeChanges', 72 'signing_location': 'signingLocation', 73 'sign_online': 'signOnline', 74 'status': 'status', 75 'user_id': 'userId' 76 } 77 78 self._account_id = account_id 79 self._add_demo_stamp = add_demo_stamp 80 self._allow_multiple_attachments = allow_multiple_attachments 81 self._burn_default_tab_data = burn_default_tab_data 82 self._company_name = company_name 83 self._convert_pdf_fields = convert_pdf_fields 84 self._custom_field_version = custom_field_version 85 self._envelope_id = envelope_id 86 self._envelope_type = envelope_type 87 self._include_sigs_before_complete = include_sigs_before_complete 88 self._is_concat_mode = is_concat_mode 89 self._is_envelope_id_stamping_enabled = is_envelope_id_stamping_enabled 90 self._pdf_form_conversion_font_scale100 = pdf_form_conversion_font_scale100 91 self._should_flatten = should_flatten 92 self._show_envelope_changes = show_envelope_changes 93 self._signing_location = signing_location 94 self._sign_online = sign_online 95 self._status = status 96 self._user_id = user_id
DisplayApplianceEnvelope - a model defined in Swagger
Parameters
- dict swaggerTypes: The key is attribute name and the value is attribute type.
- dict attributeMap: The key is attribute name and the value is json key in definition.
account_id
Gets the account_id of this DisplayApplianceEnvelope. The account ID associated with the envelope.
Returns
The account_id of this DisplayApplianceEnvelope.
add_demo_stamp
Gets the add_demo_stamp of this DisplayApplianceEnvelope.
Returns
The add_demo_stamp of this DisplayApplianceEnvelope.
allow_multiple_attachments
Gets the allow_multiple_attachments of this DisplayApplianceEnvelope.
Returns
The allow_multiple_attachments of this DisplayApplianceEnvelope.
burn_default_tab_data
Gets the burn_default_tab_data of this DisplayApplianceEnvelope.
Returns
The burn_default_tab_data of this DisplayApplianceEnvelope.
company_name
Gets the company_name of this DisplayApplianceEnvelope.
Returns
The company_name of this DisplayApplianceEnvelope.
convert_pdf_fields
Gets the convert_pdf_fields of this DisplayApplianceEnvelope.
Returns
The convert_pdf_fields of this DisplayApplianceEnvelope.
custom_field_version
Gets the custom_field_version of this DisplayApplianceEnvelope.
Returns
The custom_field_version of this DisplayApplianceEnvelope.
envelope_id
Gets the envelope_id of this DisplayApplianceEnvelope. The envelope ID of the envelope status that failed to post.
Returns
The envelope_id of this DisplayApplianceEnvelope.
envelope_type
Gets the envelope_type of this DisplayApplianceEnvelope.
Returns
The envelope_type of this DisplayApplianceEnvelope.
include_sigs_before_complete
Gets the include_sigs_before_complete of this DisplayApplianceEnvelope.
Returns
The include_sigs_before_complete of this DisplayApplianceEnvelope.
is_concat_mode
Gets the is_concat_mode of this DisplayApplianceEnvelope.
Returns
The is_concat_mode of this DisplayApplianceEnvelope.
is_envelope_id_stamping_enabled
Gets the is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope.
Returns
The is_envelope_id_stamping_enabled of this DisplayApplianceEnvelope.
pdf_form_conversion_font_scale100
Gets the pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope.
Returns
The pdf_form_conversion_font_scale100 of this DisplayApplianceEnvelope.
should_flatten
Gets the should_flatten of this DisplayApplianceEnvelope.
Returns
The should_flatten of this DisplayApplianceEnvelope.
show_envelope_changes
Gets the show_envelope_changes of this DisplayApplianceEnvelope.
Returns
The show_envelope_changes of this DisplayApplianceEnvelope.
signing_location
Gets the signing_location of this DisplayApplianceEnvelope. Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
Returns
The signing_location of this DisplayApplianceEnvelope.
sign_online
Gets the sign_online of this DisplayApplianceEnvelope.
Returns
The sign_online of this DisplayApplianceEnvelope.
status
Gets the status of this DisplayApplianceEnvelope. 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.
Returns
The status of this DisplayApplianceEnvelope.
user_id
Gets the user_id of this DisplayApplianceEnvelope.
Returns
The user_id of this DisplayApplianceEnvelope.
def
to_dict(self)
535 def to_dict(self): 536 """ 537 Returns the model properties as a dict 538 """ 539 result = {} 540 541 for attr, _ in iteritems(self.swagger_types): 542 value = getattr(self, attr) 543 if isinstance(value, list): 544 result[attr] = list(map( 545 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 546 value 547 )) 548 elif hasattr(value, "to_dict"): 549 result[attr] = value.to_dict() 550 elif isinstance(value, dict): 551 result[attr] = dict(map( 552 lambda item: (item[0], item[1].to_dict()) 553 if hasattr(item[1], "to_dict") else item, 554 value.items() 555 )) 556 else: 557 result[attr] = value 558 559 return result
Returns the model properties as a dict