docusign_esign.models.folder_item
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 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 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 FolderItem(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, completed_date_time=None, created_date_time=None, custom_fields=None, description=None, envelope_id=None, envelope_uri=None, is21_cfr_part11=None, is_signature_provider_envelope=None, last_modified=None, name=None, owner_name=None, page_count=None, password=None, sender_email=None, sender_name=None, sent_date_time=None, shared=None, status=None, subject=None, template_id=None, uri=None): 25 """ 26 FolderItem - 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 'completed_date_time': 'str', 35 'created_date_time': 'str', 36 'custom_fields': 'list[CustomFieldV2]', 37 'description': 'str', 38 'envelope_id': 'str', 39 'envelope_uri': 'str', 40 'is21_cfr_part11': 'str', 41 'is_signature_provider_envelope': 'str', 42 'last_modified': 'str', 43 'name': 'str', 44 'owner_name': 'str', 45 'page_count': 'int', 46 'password': 'str', 47 'sender_email': 'str', 48 'sender_name': 'str', 49 'sent_date_time': 'str', 50 'shared': 'str', 51 'status': 'str', 52 'subject': 'str', 53 'template_id': 'str', 54 'uri': 'str' 55 } 56 57 self.attribute_map = { 58 'completed_date_time': 'completedDateTime', 59 'created_date_time': 'createdDateTime', 60 'custom_fields': 'customFields', 61 'description': 'description', 62 'envelope_id': 'envelopeId', 63 'envelope_uri': 'envelopeUri', 64 'is21_cfr_part11': 'is21CFRPart11', 65 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 66 'last_modified': 'lastModified', 67 'name': 'name', 68 'owner_name': 'ownerName', 69 'page_count': 'pageCount', 70 'password': 'password', 71 'sender_email': 'senderEmail', 72 'sender_name': 'senderName', 73 'sent_date_time': 'sentDateTime', 74 'shared': 'shared', 75 'status': 'status', 76 'subject': 'subject', 77 'template_id': 'templateId', 78 'uri': 'uri' 79 } 80 81 self._completed_date_time = completed_date_time 82 self._created_date_time = created_date_time 83 self._custom_fields = custom_fields 84 self._description = description 85 self._envelope_id = envelope_id 86 self._envelope_uri = envelope_uri 87 self._is21_cfr_part11 = is21_cfr_part11 88 self._is_signature_provider_envelope = is_signature_provider_envelope 89 self._last_modified = last_modified 90 self._name = name 91 self._owner_name = owner_name 92 self._page_count = page_count 93 self._password = password 94 self._sender_email = sender_email 95 self._sender_name = sender_name 96 self._sent_date_time = sent_date_time 97 self._shared = shared 98 self._status = status 99 self._subject = subject 100 self._template_id = template_id 101 self._uri = uri 102 103 @property 104 def completed_date_time(self): 105 """ 106 Gets the completed_date_time of this FolderItem. 107 Specifies the date and time this item was completed. 108 109 :return: The completed_date_time of this FolderItem. 110 :rtype: str 111 """ 112 return self._completed_date_time 113 114 @completed_date_time.setter 115 def completed_date_time(self, completed_date_time): 116 """ 117 Sets the completed_date_time of this FolderItem. 118 Specifies the date and time this item was completed. 119 120 :param completed_date_time: The completed_date_time of this FolderItem. 121 :type: str 122 """ 123 124 self._completed_date_time = completed_date_time 125 126 @property 127 def created_date_time(self): 128 """ 129 Gets the created_date_time of this FolderItem. 130 Indicates the date and time the item was created. 131 132 :return: The created_date_time of this FolderItem. 133 :rtype: str 134 """ 135 return self._created_date_time 136 137 @created_date_time.setter 138 def created_date_time(self, created_date_time): 139 """ 140 Sets the created_date_time of this FolderItem. 141 Indicates the date and time the item was created. 142 143 :param created_date_time: The created_date_time of this FolderItem. 144 :type: str 145 """ 146 147 self._created_date_time = created_date_time 148 149 @property 150 def custom_fields(self): 151 """ 152 Gets the custom_fields of this FolderItem. 153 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. 154 155 :return: The custom_fields of this FolderItem. 156 :rtype: list[CustomFieldV2] 157 """ 158 return self._custom_fields 159 160 @custom_fields.setter 161 def custom_fields(self, custom_fields): 162 """ 163 Sets the custom_fields of this FolderItem. 164 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. 165 166 :param custom_fields: The custom_fields of this FolderItem. 167 :type: list[CustomFieldV2] 168 """ 169 170 self._custom_fields = custom_fields 171 172 @property 173 def description(self): 174 """ 175 Gets the description of this FolderItem. 176 177 178 :return: The description of this FolderItem. 179 :rtype: str 180 """ 181 return self._description 182 183 @description.setter 184 def description(self, description): 185 """ 186 Sets the description of this FolderItem. 187 188 189 :param description: The description of this FolderItem. 190 :type: str 191 """ 192 193 self._description = description 194 195 @property 196 def envelope_id(self): 197 """ 198 Gets the envelope_id of this FolderItem. 199 The envelope ID of the envelope status that failed to post. 200 201 :return: The envelope_id of this FolderItem. 202 :rtype: str 203 """ 204 return self._envelope_id 205 206 @envelope_id.setter 207 def envelope_id(self, envelope_id): 208 """ 209 Sets the envelope_id of this FolderItem. 210 The envelope ID of the envelope status that failed to post. 211 212 :param envelope_id: The envelope_id of this FolderItem. 213 :type: str 214 """ 215 216 self._envelope_id = envelope_id 217 218 @property 219 def envelope_uri(self): 220 """ 221 Gets the envelope_uri of this FolderItem. 222 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. 223 224 :return: The envelope_uri of this FolderItem. 225 :rtype: str 226 """ 227 return self._envelope_uri 228 229 @envelope_uri.setter 230 def envelope_uri(self, envelope_uri): 231 """ 232 Sets the envelope_uri of this FolderItem. 233 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. 234 235 :param envelope_uri: The envelope_uri of this FolderItem. 236 :type: str 237 """ 238 239 self._envelope_uri = envelope_uri 240 241 @property 242 def is21_cfr_part11(self): 243 """ 244 Gets the is21_cfr_part11 of this FolderItem. 245 When set to **true**, indicates that this module is enabled on the account. 246 247 :return: The is21_cfr_part11 of this FolderItem. 248 :rtype: str 249 """ 250 return self._is21_cfr_part11 251 252 @is21_cfr_part11.setter 253 def is21_cfr_part11(self, is21_cfr_part11): 254 """ 255 Sets the is21_cfr_part11 of this FolderItem. 256 When set to **true**, indicates that this module is enabled on the account. 257 258 :param is21_cfr_part11: The is21_cfr_part11 of this FolderItem. 259 :type: str 260 """ 261 262 self._is21_cfr_part11 = is21_cfr_part11 263 264 @property 265 def is_signature_provider_envelope(self): 266 """ 267 Gets the is_signature_provider_envelope of this FolderItem. 268 269 270 :return: The is_signature_provider_envelope of this FolderItem. 271 :rtype: str 272 """ 273 return self._is_signature_provider_envelope 274 275 @is_signature_provider_envelope.setter 276 def is_signature_provider_envelope(self, is_signature_provider_envelope): 277 """ 278 Sets the is_signature_provider_envelope of this FolderItem. 279 280 281 :param is_signature_provider_envelope: The is_signature_provider_envelope of this FolderItem. 282 :type: str 283 """ 284 285 self._is_signature_provider_envelope = is_signature_provider_envelope 286 287 @property 288 def last_modified(self): 289 """ 290 Gets the last_modified of this FolderItem. 291 292 293 :return: The last_modified of this FolderItem. 294 :rtype: str 295 """ 296 return self._last_modified 297 298 @last_modified.setter 299 def last_modified(self, last_modified): 300 """ 301 Sets the last_modified of this FolderItem. 302 303 304 :param last_modified: The last_modified of this FolderItem. 305 :type: str 306 """ 307 308 self._last_modified = last_modified 309 310 @property 311 def name(self): 312 """ 313 Gets the name of this FolderItem. 314 315 316 :return: The name of this FolderItem. 317 :rtype: str 318 """ 319 return self._name 320 321 @name.setter 322 def name(self, name): 323 """ 324 Sets the name of this FolderItem. 325 326 327 :param name: The name of this FolderItem. 328 :type: str 329 """ 330 331 self._name = name 332 333 @property 334 def owner_name(self): 335 """ 336 Gets the owner_name of this FolderItem. 337 Name of the envelope owner. 338 339 :return: The owner_name of this FolderItem. 340 :rtype: str 341 """ 342 return self._owner_name 343 344 @owner_name.setter 345 def owner_name(self, owner_name): 346 """ 347 Sets the owner_name of this FolderItem. 348 Name of the envelope owner. 349 350 :param owner_name: The owner_name of this FolderItem. 351 :type: str 352 """ 353 354 self._owner_name = owner_name 355 356 @property 357 def page_count(self): 358 """ 359 Gets the page_count of this FolderItem. 360 361 362 :return: The page_count of this FolderItem. 363 :rtype: int 364 """ 365 return self._page_count 366 367 @page_count.setter 368 def page_count(self, page_count): 369 """ 370 Sets the page_count of this FolderItem. 371 372 373 :param page_count: The page_count of this FolderItem. 374 :type: int 375 """ 376 377 self._page_count = page_count 378 379 @property 380 def password(self): 381 """ 382 Gets the password of this FolderItem. 383 384 385 :return: The password of this FolderItem. 386 :rtype: str 387 """ 388 return self._password 389 390 @password.setter 391 def password(self, password): 392 """ 393 Sets the password of this FolderItem. 394 395 396 :param password: The password of this FolderItem. 397 :type: str 398 """ 399 400 self._password = password 401 402 @property 403 def sender_email(self): 404 """ 405 Gets the sender_email of this FolderItem. 406 407 408 :return: The sender_email of this FolderItem. 409 :rtype: str 410 """ 411 return self._sender_email 412 413 @sender_email.setter 414 def sender_email(self, sender_email): 415 """ 416 Sets the sender_email of this FolderItem. 417 418 419 :param sender_email: The sender_email of this FolderItem. 420 :type: str 421 """ 422 423 self._sender_email = sender_email 424 425 @property 426 def sender_name(self): 427 """ 428 Gets the sender_name of this FolderItem. 429 Name of the envelope sender. 430 431 :return: The sender_name of this FolderItem. 432 :rtype: str 433 """ 434 return self._sender_name 435 436 @sender_name.setter 437 def sender_name(self, sender_name): 438 """ 439 Sets the sender_name of this FolderItem. 440 Name of the envelope sender. 441 442 :param sender_name: The sender_name of this FolderItem. 443 :type: str 444 """ 445 446 self._sender_name = sender_name 447 448 @property 449 def sent_date_time(self): 450 """ 451 Gets the sent_date_time of this FolderItem. 452 The date and time the envelope was sent. 453 454 :return: The sent_date_time of this FolderItem. 455 :rtype: str 456 """ 457 return self._sent_date_time 458 459 @sent_date_time.setter 460 def sent_date_time(self, sent_date_time): 461 """ 462 Sets the sent_date_time of this FolderItem. 463 The date and time the envelope was sent. 464 465 :param sent_date_time: The sent_date_time of this FolderItem. 466 :type: str 467 """ 468 469 self._sent_date_time = sent_date_time 470 471 @property 472 def shared(self): 473 """ 474 Gets the shared of this FolderItem. 475 When set to **true**, this custom tab is shared. 476 477 :return: The shared of this FolderItem. 478 :rtype: str 479 """ 480 return self._shared 481 482 @shared.setter 483 def shared(self, shared): 484 """ 485 Sets the shared of this FolderItem. 486 When set to **true**, this custom tab is shared. 487 488 :param shared: The shared of this FolderItem. 489 :type: str 490 """ 491 492 self._shared = shared 493 494 @property 495 def status(self): 496 """ 497 Gets the status of this FolderItem. 498 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. 499 500 :return: The status of this FolderItem. 501 :rtype: str 502 """ 503 return self._status 504 505 @status.setter 506 def status(self, status): 507 """ 508 Sets the status of this FolderItem. 509 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. 510 511 :param status: The status of this FolderItem. 512 :type: str 513 """ 514 515 self._status = status 516 517 @property 518 def subject(self): 519 """ 520 Gets the subject of this FolderItem. 521 522 523 :return: The subject of this FolderItem. 524 :rtype: str 525 """ 526 return self._subject 527 528 @subject.setter 529 def subject(self, subject): 530 """ 531 Sets the subject of this FolderItem. 532 533 534 :param subject: The subject of this FolderItem. 535 :type: str 536 """ 537 538 self._subject = subject 539 540 @property 541 def template_id(self): 542 """ 543 Gets the template_id of this FolderItem. 544 The unique identifier of the template. If this is not provided, DocuSign will generate a value. 545 546 :return: The template_id of this FolderItem. 547 :rtype: str 548 """ 549 return self._template_id 550 551 @template_id.setter 552 def template_id(self, template_id): 553 """ 554 Sets the template_id of this FolderItem. 555 The unique identifier of the template. If this is not provided, DocuSign will generate a value. 556 557 :param template_id: The template_id of this FolderItem. 558 :type: str 559 """ 560 561 self._template_id = template_id 562 563 @property 564 def uri(self): 565 """ 566 Gets the uri of this FolderItem. 567 568 569 :return: The uri of this FolderItem. 570 :rtype: str 571 """ 572 return self._uri 573 574 @uri.setter 575 def uri(self, uri): 576 """ 577 Sets the uri of this FolderItem. 578 579 580 :param uri: The uri of this FolderItem. 581 :type: str 582 """ 583 584 self._uri = uri 585 586 def to_dict(self): 587 """ 588 Returns the model properties as a dict 589 """ 590 result = {} 591 592 for attr, _ in iteritems(self.swagger_types): 593 value = getattr(self, attr) 594 if isinstance(value, list): 595 result[attr] = list(map( 596 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 597 value 598 )) 599 elif hasattr(value, "to_dict"): 600 result[attr] = value.to_dict() 601 elif isinstance(value, dict): 602 result[attr] = dict(map( 603 lambda item: (item[0], item[1].to_dict()) 604 if hasattr(item[1], "to_dict") else item, 605 value.items() 606 )) 607 else: 608 result[attr] = value 609 610 return result 611 612 def to_str(self): 613 """ 614 Returns the string representation of the model 615 """ 616 return pformat(self.to_dict()) 617 618 def __repr__(self): 619 """ 620 For `print` and `pprint` 621 """ 622 return self.to_str() 623 624 def __eq__(self, other): 625 """ 626 Returns true if both objects are equal 627 """ 628 return self.__dict__ == other.__dict__ 629 630 def __ne__(self, other): 631 """ 632 Returns true if both objects are not equal 633 """ 634 return not self == other
class
FolderItem:
20class FolderItem(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, completed_date_time=None, created_date_time=None, custom_fields=None, description=None, envelope_id=None, envelope_uri=None, is21_cfr_part11=None, is_signature_provider_envelope=None, last_modified=None, name=None, owner_name=None, page_count=None, password=None, sender_email=None, sender_name=None, sent_date_time=None, shared=None, status=None, subject=None, template_id=None, uri=None): 26 """ 27 FolderItem - 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 'completed_date_time': 'str', 36 'created_date_time': 'str', 37 'custom_fields': 'list[CustomFieldV2]', 38 'description': 'str', 39 'envelope_id': 'str', 40 'envelope_uri': 'str', 41 'is21_cfr_part11': 'str', 42 'is_signature_provider_envelope': 'str', 43 'last_modified': 'str', 44 'name': 'str', 45 'owner_name': 'str', 46 'page_count': 'int', 47 'password': 'str', 48 'sender_email': 'str', 49 'sender_name': 'str', 50 'sent_date_time': 'str', 51 'shared': 'str', 52 'status': 'str', 53 'subject': 'str', 54 'template_id': 'str', 55 'uri': 'str' 56 } 57 58 self.attribute_map = { 59 'completed_date_time': 'completedDateTime', 60 'created_date_time': 'createdDateTime', 61 'custom_fields': 'customFields', 62 'description': 'description', 63 'envelope_id': 'envelopeId', 64 'envelope_uri': 'envelopeUri', 65 'is21_cfr_part11': 'is21CFRPart11', 66 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 67 'last_modified': 'lastModified', 68 'name': 'name', 69 'owner_name': 'ownerName', 70 'page_count': 'pageCount', 71 'password': 'password', 72 'sender_email': 'senderEmail', 73 'sender_name': 'senderName', 74 'sent_date_time': 'sentDateTime', 75 'shared': 'shared', 76 'status': 'status', 77 'subject': 'subject', 78 'template_id': 'templateId', 79 'uri': 'uri' 80 } 81 82 self._completed_date_time = completed_date_time 83 self._created_date_time = created_date_time 84 self._custom_fields = custom_fields 85 self._description = description 86 self._envelope_id = envelope_id 87 self._envelope_uri = envelope_uri 88 self._is21_cfr_part11 = is21_cfr_part11 89 self._is_signature_provider_envelope = is_signature_provider_envelope 90 self._last_modified = last_modified 91 self._name = name 92 self._owner_name = owner_name 93 self._page_count = page_count 94 self._password = password 95 self._sender_email = sender_email 96 self._sender_name = sender_name 97 self._sent_date_time = sent_date_time 98 self._shared = shared 99 self._status = status 100 self._subject = subject 101 self._template_id = template_id 102 self._uri = uri 103 104 @property 105 def completed_date_time(self): 106 """ 107 Gets the completed_date_time of this FolderItem. 108 Specifies the date and time this item was completed. 109 110 :return: The completed_date_time of this FolderItem. 111 :rtype: str 112 """ 113 return self._completed_date_time 114 115 @completed_date_time.setter 116 def completed_date_time(self, completed_date_time): 117 """ 118 Sets the completed_date_time of this FolderItem. 119 Specifies the date and time this item was completed. 120 121 :param completed_date_time: The completed_date_time of this FolderItem. 122 :type: str 123 """ 124 125 self._completed_date_time = completed_date_time 126 127 @property 128 def created_date_time(self): 129 """ 130 Gets the created_date_time of this FolderItem. 131 Indicates the date and time the item was created. 132 133 :return: The created_date_time of this FolderItem. 134 :rtype: str 135 """ 136 return self._created_date_time 137 138 @created_date_time.setter 139 def created_date_time(self, created_date_time): 140 """ 141 Sets the created_date_time of this FolderItem. 142 Indicates the date and time the item was created. 143 144 :param created_date_time: The created_date_time of this FolderItem. 145 :type: str 146 """ 147 148 self._created_date_time = created_date_time 149 150 @property 151 def custom_fields(self): 152 """ 153 Gets the custom_fields of this FolderItem. 154 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. 155 156 :return: The custom_fields of this FolderItem. 157 :rtype: list[CustomFieldV2] 158 """ 159 return self._custom_fields 160 161 @custom_fields.setter 162 def custom_fields(self, custom_fields): 163 """ 164 Sets the custom_fields of this FolderItem. 165 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. 166 167 :param custom_fields: The custom_fields of this FolderItem. 168 :type: list[CustomFieldV2] 169 """ 170 171 self._custom_fields = custom_fields 172 173 @property 174 def description(self): 175 """ 176 Gets the description of this FolderItem. 177 178 179 :return: The description of this FolderItem. 180 :rtype: str 181 """ 182 return self._description 183 184 @description.setter 185 def description(self, description): 186 """ 187 Sets the description of this FolderItem. 188 189 190 :param description: The description of this FolderItem. 191 :type: str 192 """ 193 194 self._description = description 195 196 @property 197 def envelope_id(self): 198 """ 199 Gets the envelope_id of this FolderItem. 200 The envelope ID of the envelope status that failed to post. 201 202 :return: The envelope_id of this FolderItem. 203 :rtype: str 204 """ 205 return self._envelope_id 206 207 @envelope_id.setter 208 def envelope_id(self, envelope_id): 209 """ 210 Sets the envelope_id of this FolderItem. 211 The envelope ID of the envelope status that failed to post. 212 213 :param envelope_id: The envelope_id of this FolderItem. 214 :type: str 215 """ 216 217 self._envelope_id = envelope_id 218 219 @property 220 def envelope_uri(self): 221 """ 222 Gets the envelope_uri of this FolderItem. 223 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. 224 225 :return: The envelope_uri of this FolderItem. 226 :rtype: str 227 """ 228 return self._envelope_uri 229 230 @envelope_uri.setter 231 def envelope_uri(self, envelope_uri): 232 """ 233 Sets the envelope_uri of this FolderItem. 234 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. 235 236 :param envelope_uri: The envelope_uri of this FolderItem. 237 :type: str 238 """ 239 240 self._envelope_uri = envelope_uri 241 242 @property 243 def is21_cfr_part11(self): 244 """ 245 Gets the is21_cfr_part11 of this FolderItem. 246 When set to **true**, indicates that this module is enabled on the account. 247 248 :return: The is21_cfr_part11 of this FolderItem. 249 :rtype: str 250 """ 251 return self._is21_cfr_part11 252 253 @is21_cfr_part11.setter 254 def is21_cfr_part11(self, is21_cfr_part11): 255 """ 256 Sets the is21_cfr_part11 of this FolderItem. 257 When set to **true**, indicates that this module is enabled on the account. 258 259 :param is21_cfr_part11: The is21_cfr_part11 of this FolderItem. 260 :type: str 261 """ 262 263 self._is21_cfr_part11 = is21_cfr_part11 264 265 @property 266 def is_signature_provider_envelope(self): 267 """ 268 Gets the is_signature_provider_envelope of this FolderItem. 269 270 271 :return: The is_signature_provider_envelope of this FolderItem. 272 :rtype: str 273 """ 274 return self._is_signature_provider_envelope 275 276 @is_signature_provider_envelope.setter 277 def is_signature_provider_envelope(self, is_signature_provider_envelope): 278 """ 279 Sets the is_signature_provider_envelope of this FolderItem. 280 281 282 :param is_signature_provider_envelope: The is_signature_provider_envelope of this FolderItem. 283 :type: str 284 """ 285 286 self._is_signature_provider_envelope = is_signature_provider_envelope 287 288 @property 289 def last_modified(self): 290 """ 291 Gets the last_modified of this FolderItem. 292 293 294 :return: The last_modified of this FolderItem. 295 :rtype: str 296 """ 297 return self._last_modified 298 299 @last_modified.setter 300 def last_modified(self, last_modified): 301 """ 302 Sets the last_modified of this FolderItem. 303 304 305 :param last_modified: The last_modified of this FolderItem. 306 :type: str 307 """ 308 309 self._last_modified = last_modified 310 311 @property 312 def name(self): 313 """ 314 Gets the name of this FolderItem. 315 316 317 :return: The name of this FolderItem. 318 :rtype: str 319 """ 320 return self._name 321 322 @name.setter 323 def name(self, name): 324 """ 325 Sets the name of this FolderItem. 326 327 328 :param name: The name of this FolderItem. 329 :type: str 330 """ 331 332 self._name = name 333 334 @property 335 def owner_name(self): 336 """ 337 Gets the owner_name of this FolderItem. 338 Name of the envelope owner. 339 340 :return: The owner_name of this FolderItem. 341 :rtype: str 342 """ 343 return self._owner_name 344 345 @owner_name.setter 346 def owner_name(self, owner_name): 347 """ 348 Sets the owner_name of this FolderItem. 349 Name of the envelope owner. 350 351 :param owner_name: The owner_name of this FolderItem. 352 :type: str 353 """ 354 355 self._owner_name = owner_name 356 357 @property 358 def page_count(self): 359 """ 360 Gets the page_count of this FolderItem. 361 362 363 :return: The page_count of this FolderItem. 364 :rtype: int 365 """ 366 return self._page_count 367 368 @page_count.setter 369 def page_count(self, page_count): 370 """ 371 Sets the page_count of this FolderItem. 372 373 374 :param page_count: The page_count of this FolderItem. 375 :type: int 376 """ 377 378 self._page_count = page_count 379 380 @property 381 def password(self): 382 """ 383 Gets the password of this FolderItem. 384 385 386 :return: The password of this FolderItem. 387 :rtype: str 388 """ 389 return self._password 390 391 @password.setter 392 def password(self, password): 393 """ 394 Sets the password of this FolderItem. 395 396 397 :param password: The password of this FolderItem. 398 :type: str 399 """ 400 401 self._password = password 402 403 @property 404 def sender_email(self): 405 """ 406 Gets the sender_email of this FolderItem. 407 408 409 :return: The sender_email of this FolderItem. 410 :rtype: str 411 """ 412 return self._sender_email 413 414 @sender_email.setter 415 def sender_email(self, sender_email): 416 """ 417 Sets the sender_email of this FolderItem. 418 419 420 :param sender_email: The sender_email of this FolderItem. 421 :type: str 422 """ 423 424 self._sender_email = sender_email 425 426 @property 427 def sender_name(self): 428 """ 429 Gets the sender_name of this FolderItem. 430 Name of the envelope sender. 431 432 :return: The sender_name of this FolderItem. 433 :rtype: str 434 """ 435 return self._sender_name 436 437 @sender_name.setter 438 def sender_name(self, sender_name): 439 """ 440 Sets the sender_name of this FolderItem. 441 Name of the envelope sender. 442 443 :param sender_name: The sender_name of this FolderItem. 444 :type: str 445 """ 446 447 self._sender_name = sender_name 448 449 @property 450 def sent_date_time(self): 451 """ 452 Gets the sent_date_time of this FolderItem. 453 The date and time the envelope was sent. 454 455 :return: The sent_date_time of this FolderItem. 456 :rtype: str 457 """ 458 return self._sent_date_time 459 460 @sent_date_time.setter 461 def sent_date_time(self, sent_date_time): 462 """ 463 Sets the sent_date_time of this FolderItem. 464 The date and time the envelope was sent. 465 466 :param sent_date_time: The sent_date_time of this FolderItem. 467 :type: str 468 """ 469 470 self._sent_date_time = sent_date_time 471 472 @property 473 def shared(self): 474 """ 475 Gets the shared of this FolderItem. 476 When set to **true**, this custom tab is shared. 477 478 :return: The shared of this FolderItem. 479 :rtype: str 480 """ 481 return self._shared 482 483 @shared.setter 484 def shared(self, shared): 485 """ 486 Sets the shared of this FolderItem. 487 When set to **true**, this custom tab is shared. 488 489 :param shared: The shared of this FolderItem. 490 :type: str 491 """ 492 493 self._shared = shared 494 495 @property 496 def status(self): 497 """ 498 Gets the status of this FolderItem. 499 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. 500 501 :return: The status of this FolderItem. 502 :rtype: str 503 """ 504 return self._status 505 506 @status.setter 507 def status(self, status): 508 """ 509 Sets the status of this FolderItem. 510 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. 511 512 :param status: The status of this FolderItem. 513 :type: str 514 """ 515 516 self._status = status 517 518 @property 519 def subject(self): 520 """ 521 Gets the subject of this FolderItem. 522 523 524 :return: The subject of this FolderItem. 525 :rtype: str 526 """ 527 return self._subject 528 529 @subject.setter 530 def subject(self, subject): 531 """ 532 Sets the subject of this FolderItem. 533 534 535 :param subject: The subject of this FolderItem. 536 :type: str 537 """ 538 539 self._subject = subject 540 541 @property 542 def template_id(self): 543 """ 544 Gets the template_id of this FolderItem. 545 The unique identifier of the template. If this is not provided, DocuSign will generate a value. 546 547 :return: The template_id of this FolderItem. 548 :rtype: str 549 """ 550 return self._template_id 551 552 @template_id.setter 553 def template_id(self, template_id): 554 """ 555 Sets the template_id of this FolderItem. 556 The unique identifier of the template. If this is not provided, DocuSign will generate a value. 557 558 :param template_id: The template_id of this FolderItem. 559 :type: str 560 """ 561 562 self._template_id = template_id 563 564 @property 565 def uri(self): 566 """ 567 Gets the uri of this FolderItem. 568 569 570 :return: The uri of this FolderItem. 571 :rtype: str 572 """ 573 return self._uri 574 575 @uri.setter 576 def uri(self, uri): 577 """ 578 Sets the uri of this FolderItem. 579 580 581 :param uri: The uri of this FolderItem. 582 :type: str 583 """ 584 585 self._uri = uri 586 587 def to_dict(self): 588 """ 589 Returns the model properties as a dict 590 """ 591 result = {} 592 593 for attr, _ in iteritems(self.swagger_types): 594 value = getattr(self, attr) 595 if isinstance(value, list): 596 result[attr] = list(map( 597 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 598 value 599 )) 600 elif hasattr(value, "to_dict"): 601 result[attr] = value.to_dict() 602 elif isinstance(value, dict): 603 result[attr] = dict(map( 604 lambda item: (item[0], item[1].to_dict()) 605 if hasattr(item[1], "to_dict") else item, 606 value.items() 607 )) 608 else: 609 result[attr] = value 610 611 return result 612 613 def to_str(self): 614 """ 615 Returns the string representation of the model 616 """ 617 return pformat(self.to_dict()) 618 619 def __repr__(self): 620 """ 621 For `print` and `pprint` 622 """ 623 return self.to_str() 624 625 def __eq__(self, other): 626 """ 627 Returns true if both objects are equal 628 """ 629 return self.__dict__ == other.__dict__ 630 631 def __ne__(self, other): 632 """ 633 Returns true if both objects are not equal 634 """ 635 return not self == other
NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.
FolderItem( completed_date_time=None, created_date_time=None, custom_fields=None, description=None, envelope_id=None, envelope_uri=None, is21_cfr_part11=None, is_signature_provider_envelope=None, last_modified=None, name=None, owner_name=None, page_count=None, password=None, sender_email=None, sender_name=None, sent_date_time=None, shared=None, status=None, subject=None, template_id=None, uri=None)
25 def __init__(self, completed_date_time=None, created_date_time=None, custom_fields=None, description=None, envelope_id=None, envelope_uri=None, is21_cfr_part11=None, is_signature_provider_envelope=None, last_modified=None, name=None, owner_name=None, page_count=None, password=None, sender_email=None, sender_name=None, sent_date_time=None, shared=None, status=None, subject=None, template_id=None, uri=None): 26 """ 27 FolderItem - 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 'completed_date_time': 'str', 36 'created_date_time': 'str', 37 'custom_fields': 'list[CustomFieldV2]', 38 'description': 'str', 39 'envelope_id': 'str', 40 'envelope_uri': 'str', 41 'is21_cfr_part11': 'str', 42 'is_signature_provider_envelope': 'str', 43 'last_modified': 'str', 44 'name': 'str', 45 'owner_name': 'str', 46 'page_count': 'int', 47 'password': 'str', 48 'sender_email': 'str', 49 'sender_name': 'str', 50 'sent_date_time': 'str', 51 'shared': 'str', 52 'status': 'str', 53 'subject': 'str', 54 'template_id': 'str', 55 'uri': 'str' 56 } 57 58 self.attribute_map = { 59 'completed_date_time': 'completedDateTime', 60 'created_date_time': 'createdDateTime', 61 'custom_fields': 'customFields', 62 'description': 'description', 63 'envelope_id': 'envelopeId', 64 'envelope_uri': 'envelopeUri', 65 'is21_cfr_part11': 'is21CFRPart11', 66 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 67 'last_modified': 'lastModified', 68 'name': 'name', 69 'owner_name': 'ownerName', 70 'page_count': 'pageCount', 71 'password': 'password', 72 'sender_email': 'senderEmail', 73 'sender_name': 'senderName', 74 'sent_date_time': 'sentDateTime', 75 'shared': 'shared', 76 'status': 'status', 77 'subject': 'subject', 78 'template_id': 'templateId', 79 'uri': 'uri' 80 } 81 82 self._completed_date_time = completed_date_time 83 self._created_date_time = created_date_time 84 self._custom_fields = custom_fields 85 self._description = description 86 self._envelope_id = envelope_id 87 self._envelope_uri = envelope_uri 88 self._is21_cfr_part11 = is21_cfr_part11 89 self._is_signature_provider_envelope = is_signature_provider_envelope 90 self._last_modified = last_modified 91 self._name = name 92 self._owner_name = owner_name 93 self._page_count = page_count 94 self._password = password 95 self._sender_email = sender_email 96 self._sender_name = sender_name 97 self._sent_date_time = sent_date_time 98 self._shared = shared 99 self._status = status 100 self._subject = subject 101 self._template_id = template_id 102 self._uri = uri
FolderItem - 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.
completed_date_time
Gets the completed_date_time of this FolderItem. Specifies the date and time this item was completed.
Returns
The completed_date_time of this FolderItem.
created_date_time
Gets the created_date_time of this FolderItem. Indicates the date and time the item was created.
Returns
The created_date_time of this FolderItem.
custom_fields
Gets the custom_fields of this FolderItem. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
Returns
The custom_fields of this FolderItem.
envelope_id
Gets the envelope_id of this FolderItem. The envelope ID of the envelope status that failed to post.
Returns
The envelope_id of this FolderItem.
envelope_uri
Gets the envelope_uri of this FolderItem. Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Returns
The envelope_uri of this FolderItem.
is21_cfr_part11
Gets the is21_cfr_part11 of this FolderItem. When set to true, indicates that this module is enabled on the account.
Returns
The is21_cfr_part11 of this FolderItem.
is_signature_provider_envelope
Gets the is_signature_provider_envelope of this FolderItem.
Returns
The is_signature_provider_envelope of this FolderItem.
last_modified
Gets the last_modified of this FolderItem.
Returns
The last_modified of this FolderItem.
owner_name
Gets the owner_name of this FolderItem. Name of the envelope owner.
Returns
The owner_name of this FolderItem.
sender_name
Gets the sender_name of this FolderItem. Name of the envelope sender.
Returns
The sender_name of this FolderItem.
sent_date_time
Gets the sent_date_time of this FolderItem. The date and time the envelope was sent.
Returns
The sent_date_time of this FolderItem.
status
Gets the status of this FolderItem. 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 FolderItem.
template_id
Gets the template_id of this FolderItem. The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Returns
The template_id of this FolderItem.
def
to_dict(self)
587 def to_dict(self): 588 """ 589 Returns the model properties as a dict 590 """ 591 result = {} 592 593 for attr, _ in iteritems(self.swagger_types): 594 value = getattr(self, attr) 595 if isinstance(value, list): 596 result[attr] = list(map( 597 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 598 value 599 )) 600 elif hasattr(value, "to_dict"): 601 result[attr] = value.to_dict() 602 elif isinstance(value, dict): 603 result[attr] = dict(map( 604 lambda item: (item[0], item[1].to_dict()) 605 if hasattr(item[1], "to_dict") else item, 606 value.items() 607 )) 608 else: 609 result[attr] = value 610 611 return result
Returns the model properties as a dict