docusign_esign.models.event_notification
DocuSign REST API
The DocuSign 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 REST API 5 6 The DocuSign 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 EventNotification(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 'delivery_mode': 'str', 37 'envelope_events': 'list[EnvelopeEvent]', 38 'event_data': 'ConnectEventData', 39 'events': 'list[str]', 40 'include_certificate_of_completion': 'str', 41 'include_certificate_with_soap': 'str', 42 'include_document_fields': 'str', 43 'include_documents': 'str', 44 'include_envelope_void_reason': 'str', 45 'include_hmac': 'str', 46 'include_o_auth': 'str', 47 'include_sender_account_as_custom_field': 'str', 48 'include_time_zone': 'str', 49 'integrator_managed': 'str', 50 'logging_enabled': 'str', 51 'recipient_events': 'list[RecipientEvent]', 52 'require_acknowledgment': 'str', 53 'sign_message_with_x509_cert': 'str', 54 'soap_name_space': 'str', 55 'url': 'str', 56 'use_soap_interface': 'str' 57 } 58 59 attribute_map = { 60 'delivery_mode': 'deliveryMode', 61 'envelope_events': 'envelopeEvents', 62 'event_data': 'eventData', 63 'events': 'events', 64 'include_certificate_of_completion': 'includeCertificateOfCompletion', 65 'include_certificate_with_soap': 'includeCertificateWithSoap', 66 'include_document_fields': 'includeDocumentFields', 67 'include_documents': 'includeDocuments', 68 'include_envelope_void_reason': 'includeEnvelopeVoidReason', 69 'include_hmac': 'includeHMAC', 70 'include_o_auth': 'includeOAuth', 71 'include_sender_account_as_custom_field': 'includeSenderAccountAsCustomField', 72 'include_time_zone': 'includeTimeZone', 73 'integrator_managed': 'integratorManaged', 74 'logging_enabled': 'loggingEnabled', 75 'recipient_events': 'recipientEvents', 76 'require_acknowledgment': 'requireAcknowledgment', 77 'sign_message_with_x509_cert': 'signMessageWithX509Cert', 78 'soap_name_space': 'soapNameSpace', 79 'url': 'url', 80 'use_soap_interface': 'useSoapInterface' 81 } 82 83 def __init__(self, _configuration=None, **kwargs): # noqa: E501 84 """EventNotification - a model defined in Swagger""" # noqa: E501 85 if _configuration is None: 86 _configuration = Configuration() 87 self._configuration = _configuration 88 89 self._delivery_mode = None 90 self._envelope_events = None 91 self._event_data = None 92 self._events = None 93 self._include_certificate_of_completion = None 94 self._include_certificate_with_soap = None 95 self._include_document_fields = None 96 self._include_documents = None 97 self._include_envelope_void_reason = None 98 self._include_hmac = None 99 self._include_o_auth = None 100 self._include_sender_account_as_custom_field = None 101 self._include_time_zone = None 102 self._integrator_managed = None 103 self._logging_enabled = None 104 self._recipient_events = None 105 self._require_acknowledgment = None 106 self._sign_message_with_x509_cert = None 107 self._soap_name_space = None 108 self._url = None 109 self._use_soap_interface = None 110 self.discriminator = None 111 112 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 113 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 114 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 115 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 116 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 117 setattr(self, "_{}".format('include_certificate_with_soap'), kwargs.get('include_certificate_with_soap', None)) 118 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 119 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 120 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 121 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 122 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 123 setattr(self, "_{}".format('include_sender_account_as_custom_field'), kwargs.get('include_sender_account_as_custom_field', None)) 124 setattr(self, "_{}".format('include_time_zone'), kwargs.get('include_time_zone', None)) 125 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 126 setattr(self, "_{}".format('logging_enabled'), kwargs.get('logging_enabled', None)) 127 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 128 setattr(self, "_{}".format('require_acknowledgment'), kwargs.get('require_acknowledgment', None)) 129 setattr(self, "_{}".format('sign_message_with_x509_cert'), kwargs.get('sign_message_with_x509_cert', None)) 130 setattr(self, "_{}".format('soap_name_space'), kwargs.get('soap_name_space', None)) 131 setattr(self, "_{}".format('url'), kwargs.get('url', None)) 132 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None)) 133 134 @property 135 def delivery_mode(self): 136 """Gets the delivery_mode of this EventNotification. # noqa: E501 137 138 # noqa: E501 139 140 :return: The delivery_mode of this EventNotification. # noqa: E501 141 :rtype: str 142 """ 143 return self._delivery_mode 144 145 @delivery_mode.setter 146 def delivery_mode(self, delivery_mode): 147 """Sets the delivery_mode of this EventNotification. 148 149 # noqa: E501 150 151 :param delivery_mode: The delivery_mode of this EventNotification. # noqa: E501 152 :type: str 153 """ 154 155 self._delivery_mode = delivery_mode 156 157 @property 158 def envelope_events(self): 159 """Gets the envelope_events of this EventNotification. # noqa: E501 160 161 A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 162 163 :return: The envelope_events of this EventNotification. # noqa: E501 164 :rtype: list[EnvelopeEvent] 165 """ 166 return self._envelope_events 167 168 @envelope_events.setter 169 def envelope_events(self, envelope_events): 170 """Sets the envelope_events of this EventNotification. 171 172 A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 173 174 :param envelope_events: The envelope_events of this EventNotification. # noqa: E501 175 :type: list[EnvelopeEvent] 176 """ 177 178 self._envelope_events = envelope_events 179 180 @property 181 def event_data(self): 182 """Gets the event_data of this EventNotification. # noqa: E501 183 184 Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) # noqa: E501 185 186 :return: The event_data of this EventNotification. # noqa: E501 187 :rtype: ConnectEventData 188 """ 189 return self._event_data 190 191 @event_data.setter 192 def event_data(self, event_data): 193 """Sets the event_data of this EventNotification. 194 195 Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) # noqa: E501 196 197 :param event_data: The event_data of this EventNotification. # noqa: E501 198 :type: ConnectEventData 199 """ 200 201 self._event_data = event_data 202 203 @property 204 def events(self): 205 """Gets the events of this EventNotification. # noqa: E501 206 207 # noqa: E501 208 209 :return: The events of this EventNotification. # noqa: E501 210 :rtype: list[str] 211 """ 212 return self._events 213 214 @events.setter 215 def events(self, events): 216 """Sets the events of this EventNotification. 217 218 # noqa: E501 219 220 :param events: The events of this EventNotification. # noqa: E501 221 :type: list[str] 222 """ 223 224 self._events = events 225 226 @property 227 def include_certificate_of_completion(self): 228 """Gets the include_certificate_of_completion of this EventNotification. # noqa: E501 229 230 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 231 232 :return: The include_certificate_of_completion of this EventNotification. # noqa: E501 233 :rtype: str 234 """ 235 return self._include_certificate_of_completion 236 237 @include_certificate_of_completion.setter 238 def include_certificate_of_completion(self, include_certificate_of_completion): 239 """Sets the include_certificate_of_completion of this EventNotification. 240 241 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 242 243 :param include_certificate_of_completion: The include_certificate_of_completion of this EventNotification. # noqa: E501 244 :type: str 245 """ 246 247 self._include_certificate_of_completion = include_certificate_of_completion 248 249 @property 250 def include_certificate_with_soap(self): 251 """Gets the include_certificate_with_soap of this EventNotification. # noqa: E501 252 253 When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. # noqa: E501 254 255 :return: The include_certificate_with_soap of this EventNotification. # noqa: E501 256 :rtype: str 257 """ 258 return self._include_certificate_with_soap 259 260 @include_certificate_with_soap.setter 261 def include_certificate_with_soap(self, include_certificate_with_soap): 262 """Sets the include_certificate_with_soap of this EventNotification. 263 264 When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. # noqa: E501 265 266 :param include_certificate_with_soap: The include_certificate_with_soap of this EventNotification. # noqa: E501 267 :type: str 268 """ 269 270 self._include_certificate_with_soap = include_certificate_with_soap 271 272 @property 273 def include_document_fields(self): 274 """Gets the include_document_fields of this EventNotification. # noqa: E501 275 276 When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. # noqa: E501 277 278 :return: The include_document_fields of this EventNotification. # noqa: E501 279 :rtype: str 280 """ 281 return self._include_document_fields 282 283 @include_document_fields.setter 284 def include_document_fields(self, include_document_fields): 285 """Sets the include_document_fields of this EventNotification. 286 287 When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. # noqa: E501 288 289 :param include_document_fields: The include_document_fields of this EventNotification. # noqa: E501 290 :type: str 291 """ 292 293 self._include_document_fields = include_document_fields 294 295 @property 296 def include_documents(self): 297 """Gets the include_documents of this EventNotification. # noqa: E501 298 299 When set to **true**, the PDF documents are included in the message along with the updated XML. # noqa: E501 300 301 :return: The include_documents of this EventNotification. # noqa: E501 302 :rtype: str 303 """ 304 return self._include_documents 305 306 @include_documents.setter 307 def include_documents(self, include_documents): 308 """Sets the include_documents of this EventNotification. 309 310 When set to **true**, the PDF documents are included in the message along with the updated XML. # noqa: E501 311 312 :param include_documents: The include_documents of this EventNotification. # noqa: E501 313 :type: str 314 """ 315 316 self._include_documents = include_documents 317 318 @property 319 def include_envelope_void_reason(self): 320 """Gets the include_envelope_void_reason of this EventNotification. # noqa: E501 321 322 When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. # noqa: E501 323 324 :return: The include_envelope_void_reason of this EventNotification. # noqa: E501 325 :rtype: str 326 """ 327 return self._include_envelope_void_reason 328 329 @include_envelope_void_reason.setter 330 def include_envelope_void_reason(self, include_envelope_void_reason): 331 """Sets the include_envelope_void_reason of this EventNotification. 332 333 When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. # noqa: E501 334 335 :param include_envelope_void_reason: The include_envelope_void_reason of this EventNotification. # noqa: E501 336 :type: str 337 """ 338 339 self._include_envelope_void_reason = include_envelope_void_reason 340 341 @property 342 def include_hmac(self): 343 """Gets the include_hmac of this EventNotification. # noqa: E501 344 345 # noqa: E501 346 347 :return: The include_hmac of this EventNotification. # noqa: E501 348 :rtype: str 349 """ 350 return self._include_hmac 351 352 @include_hmac.setter 353 def include_hmac(self, include_hmac): 354 """Sets the include_hmac of this EventNotification. 355 356 # noqa: E501 357 358 :param include_hmac: The include_hmac of this EventNotification. # noqa: E501 359 :type: str 360 """ 361 362 self._include_hmac = include_hmac 363 364 @property 365 def include_o_auth(self): 366 """Gets the include_o_auth of this EventNotification. # noqa: E501 367 368 # noqa: E501 369 370 :return: The include_o_auth of this EventNotification. # noqa: E501 371 :rtype: str 372 """ 373 return self._include_o_auth 374 375 @include_o_auth.setter 376 def include_o_auth(self, include_o_auth): 377 """Sets the include_o_auth of this EventNotification. 378 379 # noqa: E501 380 381 :param include_o_auth: The include_o_auth of this EventNotification. # noqa: E501 382 :type: str 383 """ 384 385 self._include_o_auth = include_o_auth 386 387 @property 388 def include_sender_account_as_custom_field(self): 389 """Gets the include_sender_account_as_custom_field of this EventNotification. # noqa: E501 390 391 When set to **true**, the sender account ID is included as a envelope custom field in the data. # noqa: E501 392 393 :return: The include_sender_account_as_custom_field of this EventNotification. # noqa: E501 394 :rtype: str 395 """ 396 return self._include_sender_account_as_custom_field 397 398 @include_sender_account_as_custom_field.setter 399 def include_sender_account_as_custom_field(self, include_sender_account_as_custom_field): 400 """Sets the include_sender_account_as_custom_field of this EventNotification. 401 402 When set to **true**, the sender account ID is included as a envelope custom field in the data. # noqa: E501 403 404 :param include_sender_account_as_custom_field: The include_sender_account_as_custom_field of this EventNotification. # noqa: E501 405 :type: str 406 """ 407 408 self._include_sender_account_as_custom_field = include_sender_account_as_custom_field 409 410 @property 411 def include_time_zone(self): 412 """Gets the include_time_zone of this EventNotification. # noqa: E501 413 414 When set to **true**, the envelope time zone information is included in the message. # noqa: E501 415 416 :return: The include_time_zone of this EventNotification. # noqa: E501 417 :rtype: str 418 """ 419 return self._include_time_zone 420 421 @include_time_zone.setter 422 def include_time_zone(self, include_time_zone): 423 """Sets the include_time_zone of this EventNotification. 424 425 When set to **true**, the envelope time zone information is included in the message. # noqa: E501 426 427 :param include_time_zone: The include_time_zone of this EventNotification. # noqa: E501 428 :type: str 429 """ 430 431 self._include_time_zone = include_time_zone 432 433 @property 434 def integrator_managed(self): 435 """Gets the integrator_managed of this EventNotification. # noqa: E501 436 437 # noqa: E501 438 439 :return: The integrator_managed of this EventNotification. # noqa: E501 440 :rtype: str 441 """ 442 return self._integrator_managed 443 444 @integrator_managed.setter 445 def integrator_managed(self, integrator_managed): 446 """Sets the integrator_managed of this EventNotification. 447 448 # noqa: E501 449 450 :param integrator_managed: The integrator_managed of this EventNotification. # noqa: E501 451 :type: str 452 """ 453 454 self._integrator_managed = integrator_managed 455 456 @property 457 def logging_enabled(self): 458 """Gets the logging_enabled of this EventNotification. # noqa: E501 459 460 When set to **true**, logging is turned on for envelope events on the Web Console Connect page. # noqa: E501 461 462 :return: The logging_enabled of this EventNotification. # noqa: E501 463 :rtype: str 464 """ 465 return self._logging_enabled 466 467 @logging_enabled.setter 468 def logging_enabled(self, logging_enabled): 469 """Sets the logging_enabled of this EventNotification. 470 471 When set to **true**, logging is turned on for envelope events on the Web Console Connect page. # noqa: E501 472 473 :param logging_enabled: The logging_enabled of this EventNotification. # noqa: E501 474 :type: str 475 """ 476 477 self._logging_enabled = logging_enabled 478 479 @property 480 def recipient_events(self): 481 """Gets the recipient_events of this EventNotification. # noqa: E501 482 483 A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 484 485 :return: The recipient_events of this EventNotification. # noqa: E501 486 :rtype: list[RecipientEvent] 487 """ 488 return self._recipient_events 489 490 @recipient_events.setter 491 def recipient_events(self, recipient_events): 492 """Sets the recipient_events of this EventNotification. 493 494 A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 495 496 :param recipient_events: The recipient_events of this EventNotification. # noqa: E501 497 :type: list[RecipientEvent] 498 """ 499 500 self._recipient_events = recipient_events 501 502 @property 503 def require_acknowledgment(self): 504 """Gets the require_acknowledgment of this EventNotification. # noqa: E501 505 506 When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. # noqa: E501 507 508 :return: The require_acknowledgment of this EventNotification. # noqa: E501 509 :rtype: str 510 """ 511 return self._require_acknowledgment 512 513 @require_acknowledgment.setter 514 def require_acknowledgment(self, require_acknowledgment): 515 """Sets the require_acknowledgment of this EventNotification. 516 517 When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. # noqa: E501 518 519 :param require_acknowledgment: The require_acknowledgment of this EventNotification. # noqa: E501 520 :type: str 521 """ 522 523 self._require_acknowledgment = require_acknowledgment 524 525 @property 526 def sign_message_with_x509_cert(self): 527 """Gets the sign_message_with_x509_cert of this EventNotification. # noqa: E501 528 529 When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. # noqa: E501 530 531 :return: The sign_message_with_x509_cert of this EventNotification. # noqa: E501 532 :rtype: str 533 """ 534 return self._sign_message_with_x509_cert 535 536 @sign_message_with_x509_cert.setter 537 def sign_message_with_x509_cert(self, sign_message_with_x509_cert): 538 """Sets the sign_message_with_x509_cert of this EventNotification. 539 540 When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. # noqa: E501 541 542 :param sign_message_with_x509_cert: The sign_message_with_x509_cert of this EventNotification. # noqa: E501 543 :type: str 544 """ 545 546 self._sign_message_with_x509_cert = sign_message_with_x509_cert 547 548 @property 549 def soap_name_space(self): 550 """Gets the soap_name_space of this EventNotification. # noqa: E501 551 552 This lists the namespace in the SOAP listener provided. # noqa: E501 553 554 :return: The soap_name_space of this EventNotification. # noqa: E501 555 :rtype: str 556 """ 557 return self._soap_name_space 558 559 @soap_name_space.setter 560 def soap_name_space(self, soap_name_space): 561 """Sets the soap_name_space of this EventNotification. 562 563 This lists the namespace in the SOAP listener provided. # noqa: E501 564 565 :param soap_name_space: The soap_name_space of this EventNotification. # noqa: E501 566 :type: str 567 """ 568 569 self._soap_name_space = soap_name_space 570 571 @property 572 def url(self): 573 """Gets the url of this EventNotification. # noqa: E501 574 575 Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**. # noqa: E501 576 577 :return: The url of this EventNotification. # noqa: E501 578 :rtype: str 579 """ 580 return self._url 581 582 @url.setter 583 def url(self, url): 584 """Sets the url of this EventNotification. 585 586 Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**. # noqa: E501 587 588 :param url: The url of this EventNotification. # noqa: E501 589 :type: str 590 """ 591 592 self._url = url 593 594 @property 595 def use_soap_interface(self): 596 """Gets the use_soap_interface of this EventNotification. # noqa: E501 597 598 When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. # noqa: E501 599 600 :return: The use_soap_interface of this EventNotification. # noqa: E501 601 :rtype: str 602 """ 603 return self._use_soap_interface 604 605 @use_soap_interface.setter 606 def use_soap_interface(self, use_soap_interface): 607 """Sets the use_soap_interface of this EventNotification. 608 609 When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. # noqa: E501 610 611 :param use_soap_interface: The use_soap_interface of this EventNotification. # noqa: E501 612 :type: str 613 """ 614 615 self._use_soap_interface = use_soap_interface 616 617 def to_dict(self): 618 """Returns the model properties as a dict""" 619 result = {} 620 621 for attr, _ in six.iteritems(self.swagger_types): 622 value = getattr(self, attr) 623 if isinstance(value, list): 624 result[attr] = list(map( 625 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 626 value 627 )) 628 elif hasattr(value, "to_dict"): 629 result[attr] = value.to_dict() 630 elif isinstance(value, dict): 631 result[attr] = dict(map( 632 lambda item: (item[0], item[1].to_dict()) 633 if hasattr(item[1], "to_dict") else item, 634 value.items() 635 )) 636 else: 637 result[attr] = value 638 if issubclass(EventNotification, dict): 639 for key, value in self.items(): 640 result[key] = value 641 642 return result 643 644 def to_str(self): 645 """Returns the string representation of the model""" 646 return pprint.pformat(self.to_dict()) 647 648 def __repr__(self): 649 """For `print` and `pprint`""" 650 return self.to_str() 651 652 def __eq__(self, other): 653 """Returns true if both objects are equal""" 654 if not isinstance(other, EventNotification): 655 return False 656 657 return self.to_dict() == other.to_dict() 658 659 def __ne__(self, other): 660 """Returns true if both objects are not equal""" 661 if not isinstance(other, EventNotification): 662 return True 663 664 return self.to_dict() != other.to_dict()
class
EventNotification:
23class EventNotification(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 'delivery_mode': 'str', 38 'envelope_events': 'list[EnvelopeEvent]', 39 'event_data': 'ConnectEventData', 40 'events': 'list[str]', 41 'include_certificate_of_completion': 'str', 42 'include_certificate_with_soap': 'str', 43 'include_document_fields': 'str', 44 'include_documents': 'str', 45 'include_envelope_void_reason': 'str', 46 'include_hmac': 'str', 47 'include_o_auth': 'str', 48 'include_sender_account_as_custom_field': 'str', 49 'include_time_zone': 'str', 50 'integrator_managed': 'str', 51 'logging_enabled': 'str', 52 'recipient_events': 'list[RecipientEvent]', 53 'require_acknowledgment': 'str', 54 'sign_message_with_x509_cert': 'str', 55 'soap_name_space': 'str', 56 'url': 'str', 57 'use_soap_interface': 'str' 58 } 59 60 attribute_map = { 61 'delivery_mode': 'deliveryMode', 62 'envelope_events': 'envelopeEvents', 63 'event_data': 'eventData', 64 'events': 'events', 65 'include_certificate_of_completion': 'includeCertificateOfCompletion', 66 'include_certificate_with_soap': 'includeCertificateWithSoap', 67 'include_document_fields': 'includeDocumentFields', 68 'include_documents': 'includeDocuments', 69 'include_envelope_void_reason': 'includeEnvelopeVoidReason', 70 'include_hmac': 'includeHMAC', 71 'include_o_auth': 'includeOAuth', 72 'include_sender_account_as_custom_field': 'includeSenderAccountAsCustomField', 73 'include_time_zone': 'includeTimeZone', 74 'integrator_managed': 'integratorManaged', 75 'logging_enabled': 'loggingEnabled', 76 'recipient_events': 'recipientEvents', 77 'require_acknowledgment': 'requireAcknowledgment', 78 'sign_message_with_x509_cert': 'signMessageWithX509Cert', 79 'soap_name_space': 'soapNameSpace', 80 'url': 'url', 81 'use_soap_interface': 'useSoapInterface' 82 } 83 84 def __init__(self, _configuration=None, **kwargs): # noqa: E501 85 """EventNotification - a model defined in Swagger""" # noqa: E501 86 if _configuration is None: 87 _configuration = Configuration() 88 self._configuration = _configuration 89 90 self._delivery_mode = None 91 self._envelope_events = None 92 self._event_data = None 93 self._events = None 94 self._include_certificate_of_completion = None 95 self._include_certificate_with_soap = None 96 self._include_document_fields = None 97 self._include_documents = None 98 self._include_envelope_void_reason = None 99 self._include_hmac = None 100 self._include_o_auth = None 101 self._include_sender_account_as_custom_field = None 102 self._include_time_zone = None 103 self._integrator_managed = None 104 self._logging_enabled = None 105 self._recipient_events = None 106 self._require_acknowledgment = None 107 self._sign_message_with_x509_cert = None 108 self._soap_name_space = None 109 self._url = None 110 self._use_soap_interface = None 111 self.discriminator = None 112 113 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 114 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 115 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 116 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 117 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 118 setattr(self, "_{}".format('include_certificate_with_soap'), kwargs.get('include_certificate_with_soap', None)) 119 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 120 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 121 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 122 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 123 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 124 setattr(self, "_{}".format('include_sender_account_as_custom_field'), kwargs.get('include_sender_account_as_custom_field', None)) 125 setattr(self, "_{}".format('include_time_zone'), kwargs.get('include_time_zone', None)) 126 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 127 setattr(self, "_{}".format('logging_enabled'), kwargs.get('logging_enabled', None)) 128 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 129 setattr(self, "_{}".format('require_acknowledgment'), kwargs.get('require_acknowledgment', None)) 130 setattr(self, "_{}".format('sign_message_with_x509_cert'), kwargs.get('sign_message_with_x509_cert', None)) 131 setattr(self, "_{}".format('soap_name_space'), kwargs.get('soap_name_space', None)) 132 setattr(self, "_{}".format('url'), kwargs.get('url', None)) 133 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None)) 134 135 @property 136 def delivery_mode(self): 137 """Gets the delivery_mode of this EventNotification. # noqa: E501 138 139 # noqa: E501 140 141 :return: The delivery_mode of this EventNotification. # noqa: E501 142 :rtype: str 143 """ 144 return self._delivery_mode 145 146 @delivery_mode.setter 147 def delivery_mode(self, delivery_mode): 148 """Sets the delivery_mode of this EventNotification. 149 150 # noqa: E501 151 152 :param delivery_mode: The delivery_mode of this EventNotification. # noqa: E501 153 :type: str 154 """ 155 156 self._delivery_mode = delivery_mode 157 158 @property 159 def envelope_events(self): 160 """Gets the envelope_events of this EventNotification. # noqa: E501 161 162 A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 163 164 :return: The envelope_events of this EventNotification. # noqa: E501 165 :rtype: list[EnvelopeEvent] 166 """ 167 return self._envelope_events 168 169 @envelope_events.setter 170 def envelope_events(self, envelope_events): 171 """Sets the envelope_events of this EventNotification. 172 173 A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 174 175 :param envelope_events: The envelope_events of this EventNotification. # noqa: E501 176 :type: list[EnvelopeEvent] 177 """ 178 179 self._envelope_events = envelope_events 180 181 @property 182 def event_data(self): 183 """Gets the event_data of this EventNotification. # noqa: E501 184 185 Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) # noqa: E501 186 187 :return: The event_data of this EventNotification. # noqa: E501 188 :rtype: ConnectEventData 189 """ 190 return self._event_data 191 192 @event_data.setter 193 def event_data(self, event_data): 194 """Sets the event_data of this EventNotification. 195 196 Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications) # noqa: E501 197 198 :param event_data: The event_data of this EventNotification. # noqa: E501 199 :type: ConnectEventData 200 """ 201 202 self._event_data = event_data 203 204 @property 205 def events(self): 206 """Gets the events of this EventNotification. # noqa: E501 207 208 # noqa: E501 209 210 :return: The events of this EventNotification. # noqa: E501 211 :rtype: list[str] 212 """ 213 return self._events 214 215 @events.setter 216 def events(self, events): 217 """Sets the events of this EventNotification. 218 219 # noqa: E501 220 221 :param events: The events of this EventNotification. # noqa: E501 222 :type: list[str] 223 """ 224 225 self._events = events 226 227 @property 228 def include_certificate_of_completion(self): 229 """Gets the include_certificate_of_completion of this EventNotification. # noqa: E501 230 231 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 232 233 :return: The include_certificate_of_completion of this EventNotification. # noqa: E501 234 :rtype: str 235 """ 236 return self._include_certificate_of_completion 237 238 @include_certificate_of_completion.setter 239 def include_certificate_of_completion(self, include_certificate_of_completion): 240 """Sets the include_certificate_of_completion of this EventNotification. 241 242 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 243 244 :param include_certificate_of_completion: The include_certificate_of_completion of this EventNotification. # noqa: E501 245 :type: str 246 """ 247 248 self._include_certificate_of_completion = include_certificate_of_completion 249 250 @property 251 def include_certificate_with_soap(self): 252 """Gets the include_certificate_with_soap of this EventNotification. # noqa: E501 253 254 When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. # noqa: E501 255 256 :return: The include_certificate_with_soap of this EventNotification. # noqa: E501 257 :rtype: str 258 """ 259 return self._include_certificate_with_soap 260 261 @include_certificate_with_soap.setter 262 def include_certificate_with_soap(self, include_certificate_with_soap): 263 """Sets the include_certificate_with_soap of this EventNotification. 264 265 When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. # noqa: E501 266 267 :param include_certificate_with_soap: The include_certificate_with_soap of this EventNotification. # noqa: E501 268 :type: str 269 """ 270 271 self._include_certificate_with_soap = include_certificate_with_soap 272 273 @property 274 def include_document_fields(self): 275 """Gets the include_document_fields of this EventNotification. # noqa: E501 276 277 When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. # noqa: E501 278 279 :return: The include_document_fields of this EventNotification. # noqa: E501 280 :rtype: str 281 """ 282 return self._include_document_fields 283 284 @include_document_fields.setter 285 def include_document_fields(self, include_document_fields): 286 """Sets the include_document_fields of this EventNotification. 287 288 When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. # noqa: E501 289 290 :param include_document_fields: The include_document_fields of this EventNotification. # noqa: E501 291 :type: str 292 """ 293 294 self._include_document_fields = include_document_fields 295 296 @property 297 def include_documents(self): 298 """Gets the include_documents of this EventNotification. # noqa: E501 299 300 When set to **true**, the PDF documents are included in the message along with the updated XML. # noqa: E501 301 302 :return: The include_documents of this EventNotification. # noqa: E501 303 :rtype: str 304 """ 305 return self._include_documents 306 307 @include_documents.setter 308 def include_documents(self, include_documents): 309 """Sets the include_documents of this EventNotification. 310 311 When set to **true**, the PDF documents are included in the message along with the updated XML. # noqa: E501 312 313 :param include_documents: The include_documents of this EventNotification. # noqa: E501 314 :type: str 315 """ 316 317 self._include_documents = include_documents 318 319 @property 320 def include_envelope_void_reason(self): 321 """Gets the include_envelope_void_reason of this EventNotification. # noqa: E501 322 323 When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. # noqa: E501 324 325 :return: The include_envelope_void_reason of this EventNotification. # noqa: E501 326 :rtype: str 327 """ 328 return self._include_envelope_void_reason 329 330 @include_envelope_void_reason.setter 331 def include_envelope_void_reason(self, include_envelope_void_reason): 332 """Sets the include_envelope_void_reason of this EventNotification. 333 334 When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. # noqa: E501 335 336 :param include_envelope_void_reason: The include_envelope_void_reason of this EventNotification. # noqa: E501 337 :type: str 338 """ 339 340 self._include_envelope_void_reason = include_envelope_void_reason 341 342 @property 343 def include_hmac(self): 344 """Gets the include_hmac of this EventNotification. # noqa: E501 345 346 # noqa: E501 347 348 :return: The include_hmac of this EventNotification. # noqa: E501 349 :rtype: str 350 """ 351 return self._include_hmac 352 353 @include_hmac.setter 354 def include_hmac(self, include_hmac): 355 """Sets the include_hmac of this EventNotification. 356 357 # noqa: E501 358 359 :param include_hmac: The include_hmac of this EventNotification. # noqa: E501 360 :type: str 361 """ 362 363 self._include_hmac = include_hmac 364 365 @property 366 def include_o_auth(self): 367 """Gets the include_o_auth of this EventNotification. # noqa: E501 368 369 # noqa: E501 370 371 :return: The include_o_auth of this EventNotification. # noqa: E501 372 :rtype: str 373 """ 374 return self._include_o_auth 375 376 @include_o_auth.setter 377 def include_o_auth(self, include_o_auth): 378 """Sets the include_o_auth of this EventNotification. 379 380 # noqa: E501 381 382 :param include_o_auth: The include_o_auth of this EventNotification. # noqa: E501 383 :type: str 384 """ 385 386 self._include_o_auth = include_o_auth 387 388 @property 389 def include_sender_account_as_custom_field(self): 390 """Gets the include_sender_account_as_custom_field of this EventNotification. # noqa: E501 391 392 When set to **true**, the sender account ID is included as a envelope custom field in the data. # noqa: E501 393 394 :return: The include_sender_account_as_custom_field of this EventNotification. # noqa: E501 395 :rtype: str 396 """ 397 return self._include_sender_account_as_custom_field 398 399 @include_sender_account_as_custom_field.setter 400 def include_sender_account_as_custom_field(self, include_sender_account_as_custom_field): 401 """Sets the include_sender_account_as_custom_field of this EventNotification. 402 403 When set to **true**, the sender account ID is included as a envelope custom field in the data. # noqa: E501 404 405 :param include_sender_account_as_custom_field: The include_sender_account_as_custom_field of this EventNotification. # noqa: E501 406 :type: str 407 """ 408 409 self._include_sender_account_as_custom_field = include_sender_account_as_custom_field 410 411 @property 412 def include_time_zone(self): 413 """Gets the include_time_zone of this EventNotification. # noqa: E501 414 415 When set to **true**, the envelope time zone information is included in the message. # noqa: E501 416 417 :return: The include_time_zone of this EventNotification. # noqa: E501 418 :rtype: str 419 """ 420 return self._include_time_zone 421 422 @include_time_zone.setter 423 def include_time_zone(self, include_time_zone): 424 """Sets the include_time_zone of this EventNotification. 425 426 When set to **true**, the envelope time zone information is included in the message. # noqa: E501 427 428 :param include_time_zone: The include_time_zone of this EventNotification. # noqa: E501 429 :type: str 430 """ 431 432 self._include_time_zone = include_time_zone 433 434 @property 435 def integrator_managed(self): 436 """Gets the integrator_managed of this EventNotification. # noqa: E501 437 438 # noqa: E501 439 440 :return: The integrator_managed of this EventNotification. # noqa: E501 441 :rtype: str 442 """ 443 return self._integrator_managed 444 445 @integrator_managed.setter 446 def integrator_managed(self, integrator_managed): 447 """Sets the integrator_managed of this EventNotification. 448 449 # noqa: E501 450 451 :param integrator_managed: The integrator_managed of this EventNotification. # noqa: E501 452 :type: str 453 """ 454 455 self._integrator_managed = integrator_managed 456 457 @property 458 def logging_enabled(self): 459 """Gets the logging_enabled of this EventNotification. # noqa: E501 460 461 When set to **true**, logging is turned on for envelope events on the Web Console Connect page. # noqa: E501 462 463 :return: The logging_enabled of this EventNotification. # noqa: E501 464 :rtype: str 465 """ 466 return self._logging_enabled 467 468 @logging_enabled.setter 469 def logging_enabled(self, logging_enabled): 470 """Sets the logging_enabled of this EventNotification. 471 472 When set to **true**, logging is turned on for envelope events on the Web Console Connect page. # noqa: E501 473 474 :param logging_enabled: The logging_enabled of this EventNotification. # noqa: E501 475 :type: str 476 """ 477 478 self._logging_enabled = logging_enabled 479 480 @property 481 def recipient_events(self): 482 """Gets the recipient_events of this EventNotification. # noqa: E501 483 484 A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 485 486 :return: The recipient_events of this EventNotification. # noqa: E501 487 :rtype: list[RecipientEvent] 488 """ 489 return self._recipient_events 490 491 @recipient_events.setter 492 def recipient_events(self, recipient_events): 493 """Sets the recipient_events of this EventNotification. 494 495 A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both. # noqa: E501 496 497 :param recipient_events: The recipient_events of this EventNotification. # noqa: E501 498 :type: list[RecipientEvent] 499 """ 500 501 self._recipient_events = recipient_events 502 503 @property 504 def require_acknowledgment(self): 505 """Gets the require_acknowledgment of this EventNotification. # noqa: E501 506 507 When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. # noqa: E501 508 509 :return: The require_acknowledgment of this EventNotification. # noqa: E501 510 :rtype: str 511 """ 512 return self._require_acknowledgment 513 514 @require_acknowledgment.setter 515 def require_acknowledgment(self, require_acknowledgment): 516 """Sets the require_acknowledgment of this EventNotification. 517 518 When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. # noqa: E501 519 520 :param require_acknowledgment: The require_acknowledgment of this EventNotification. # noqa: E501 521 :type: str 522 """ 523 524 self._require_acknowledgment = require_acknowledgment 525 526 @property 527 def sign_message_with_x509_cert(self): 528 """Gets the sign_message_with_x509_cert of this EventNotification. # noqa: E501 529 530 When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. # noqa: E501 531 532 :return: The sign_message_with_x509_cert of this EventNotification. # noqa: E501 533 :rtype: str 534 """ 535 return self._sign_message_with_x509_cert 536 537 @sign_message_with_x509_cert.setter 538 def sign_message_with_x509_cert(self, sign_message_with_x509_cert): 539 """Sets the sign_message_with_x509_cert of this EventNotification. 540 541 When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. # noqa: E501 542 543 :param sign_message_with_x509_cert: The sign_message_with_x509_cert of this EventNotification. # noqa: E501 544 :type: str 545 """ 546 547 self._sign_message_with_x509_cert = sign_message_with_x509_cert 548 549 @property 550 def soap_name_space(self): 551 """Gets the soap_name_space of this EventNotification. # noqa: E501 552 553 This lists the namespace in the SOAP listener provided. # noqa: E501 554 555 :return: The soap_name_space of this EventNotification. # noqa: E501 556 :rtype: str 557 """ 558 return self._soap_name_space 559 560 @soap_name_space.setter 561 def soap_name_space(self, soap_name_space): 562 """Sets the soap_name_space of this EventNotification. 563 564 This lists the namespace in the SOAP listener provided. # noqa: E501 565 566 :param soap_name_space: The soap_name_space of this EventNotification. # noqa: E501 567 :type: str 568 """ 569 570 self._soap_name_space = soap_name_space 571 572 @property 573 def url(self): 574 """Gets the url of this EventNotification. # noqa: E501 575 576 Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**. # noqa: E501 577 578 :return: The url of this EventNotification. # noqa: E501 579 :rtype: str 580 """ 581 return self._url 582 583 @url.setter 584 def url(self, url): 585 """Sets the url of this EventNotification. 586 587 Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**. # noqa: E501 588 589 :param url: The url of this EventNotification. # noqa: E501 590 :type: str 591 """ 592 593 self._url = url 594 595 @property 596 def use_soap_interface(self): 597 """Gets the use_soap_interface of this EventNotification. # noqa: E501 598 599 When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. # noqa: E501 600 601 :return: The use_soap_interface of this EventNotification. # noqa: E501 602 :rtype: str 603 """ 604 return self._use_soap_interface 605 606 @use_soap_interface.setter 607 def use_soap_interface(self, use_soap_interface): 608 """Sets the use_soap_interface of this EventNotification. 609 610 When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface. # noqa: E501 611 612 :param use_soap_interface: The use_soap_interface of this EventNotification. # noqa: E501 613 :type: str 614 """ 615 616 self._use_soap_interface = use_soap_interface 617 618 def to_dict(self): 619 """Returns the model properties as a dict""" 620 result = {} 621 622 for attr, _ in six.iteritems(self.swagger_types): 623 value = getattr(self, attr) 624 if isinstance(value, list): 625 result[attr] = list(map( 626 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 627 value 628 )) 629 elif hasattr(value, "to_dict"): 630 result[attr] = value.to_dict() 631 elif isinstance(value, dict): 632 result[attr] = dict(map( 633 lambda item: (item[0], item[1].to_dict()) 634 if hasattr(item[1], "to_dict") else item, 635 value.items() 636 )) 637 else: 638 result[attr] = value 639 if issubclass(EventNotification, dict): 640 for key, value in self.items(): 641 result[key] = value 642 643 return result 644 645 def to_str(self): 646 """Returns the string representation of the model""" 647 return pprint.pformat(self.to_dict()) 648 649 def __repr__(self): 650 """For `print` and `pprint`""" 651 return self.to_str() 652 653 def __eq__(self, other): 654 """Returns true if both objects are equal""" 655 if not isinstance(other, EventNotification): 656 return False 657 658 return self.to_dict() == other.to_dict() 659 660 def __ne__(self, other): 661 """Returns true if both objects are not equal""" 662 if not isinstance(other, EventNotification): 663 return True 664 665 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.
EventNotification(_configuration=None, **kwargs)
84 def __init__(self, _configuration=None, **kwargs): # noqa: E501 85 """EventNotification - a model defined in Swagger""" # noqa: E501 86 if _configuration is None: 87 _configuration = Configuration() 88 self._configuration = _configuration 89 90 self._delivery_mode = None 91 self._envelope_events = None 92 self._event_data = None 93 self._events = None 94 self._include_certificate_of_completion = None 95 self._include_certificate_with_soap = None 96 self._include_document_fields = None 97 self._include_documents = None 98 self._include_envelope_void_reason = None 99 self._include_hmac = None 100 self._include_o_auth = None 101 self._include_sender_account_as_custom_field = None 102 self._include_time_zone = None 103 self._integrator_managed = None 104 self._logging_enabled = None 105 self._recipient_events = None 106 self._require_acknowledgment = None 107 self._sign_message_with_x509_cert = None 108 self._soap_name_space = None 109 self._url = None 110 self._use_soap_interface = None 111 self.discriminator = None 112 113 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 114 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 115 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 116 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 117 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 118 setattr(self, "_{}".format('include_certificate_with_soap'), kwargs.get('include_certificate_with_soap', None)) 119 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 120 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 121 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 122 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 123 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 124 setattr(self, "_{}".format('include_sender_account_as_custom_field'), kwargs.get('include_sender_account_as_custom_field', None)) 125 setattr(self, "_{}".format('include_time_zone'), kwargs.get('include_time_zone', None)) 126 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 127 setattr(self, "_{}".format('logging_enabled'), kwargs.get('logging_enabled', None)) 128 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 129 setattr(self, "_{}".format('require_acknowledgment'), kwargs.get('require_acknowledgment', None)) 130 setattr(self, "_{}".format('sign_message_with_x509_cert'), kwargs.get('sign_message_with_x509_cert', None)) 131 setattr(self, "_{}".format('soap_name_space'), kwargs.get('soap_name_space', None)) 132 setattr(self, "_{}".format('url'), kwargs.get('url', None)) 133 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None))
EventNotification - a model defined in Swagger
swagger_types = {'delivery_mode': 'str', 'envelope_events': 'list[EnvelopeEvent]', 'event_data': 'ConnectEventData', 'events': 'list[str]', 'include_certificate_of_completion': 'str', 'include_certificate_with_soap': 'str', 'include_document_fields': 'str', 'include_documents': 'str', 'include_envelope_void_reason': 'str', 'include_hmac': 'str', 'include_o_auth': 'str', 'include_sender_account_as_custom_field': 'str', 'include_time_zone': 'str', 'integrator_managed': 'str', 'logging_enabled': 'str', 'recipient_events': 'list[RecipientEvent]', 'require_acknowledgment': 'str', 'sign_message_with_x509_cert': 'str', 'soap_name_space': 'str', 'url': 'str', 'use_soap_interface': 'str'}
attribute_map = {'delivery_mode': 'deliveryMode', 'envelope_events': 'envelopeEvents', 'event_data': 'eventData', 'events': 'events', 'include_certificate_of_completion': 'includeCertificateOfCompletion', 'include_certificate_with_soap': 'includeCertificateWithSoap', 'include_document_fields': 'includeDocumentFields', 'include_documents': 'includeDocuments', 'include_envelope_void_reason': 'includeEnvelopeVoidReason', 'include_hmac': 'includeHMAC', 'include_o_auth': 'includeOAuth', 'include_sender_account_as_custom_field': 'includeSenderAccountAsCustomField', 'include_time_zone': 'includeTimeZone', 'integrator_managed': 'integratorManaged', 'logging_enabled': 'loggingEnabled', 'recipient_events': 'recipientEvents', 'require_acknowledgment': 'requireAcknowledgment', 'sign_message_with_x509_cert': 'signMessageWithX509Cert', 'soap_name_space': 'soapNameSpace', 'url': 'url', 'use_soap_interface': 'useSoapInterface'}
delivery_mode
Gets the delivery_mode of this EventNotification. # noqa: E501
# noqa: E501
Returns
The delivery_mode of this EventNotification. # noqa: E501
envelope_events
Gets the envelope_events of this EventNotification. # noqa: E501
A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both. # noqa: E501
Returns
The envelope_events of this EventNotification. # noqa: E501
event_data
Gets the event_data of this EventNotification. # noqa: E501
Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications # noqa: E501
Returns
The event_data of this EventNotification. # noqa: E501
events
Gets the events of this EventNotification. # noqa: E501
# noqa: E501
Returns
The events of this EventNotification. # noqa: E501
include_certificate_of_completion
Gets the include_certificate_of_completion of this EventNotification. # noqa: E501
When set to true, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501
Returns
The include_certificate_of_completion of this EventNotification. # noqa: E501
include_certificate_with_soap
Gets the include_certificate_with_soap of this EventNotification. # noqa: E501
When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. # noqa: E501
Returns
The include_certificate_with_soap of this EventNotification. # noqa: E501
include_document_fields
Gets the include_document_fields of this EventNotification. # noqa: E501
When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. # noqa: E501
Returns
The include_document_fields of this EventNotification. # noqa: E501
include_documents
Gets the include_documents of this EventNotification. # noqa: E501
When set to true, the PDF documents are included in the message along with the updated XML. # noqa: E501
Returns
The include_documents of this EventNotification. # noqa: E501
include_envelope_void_reason
Gets the include_envelope_void_reason of this EventNotification. # noqa: E501
When set to true, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. # noqa: E501
Returns
The include_envelope_void_reason of this EventNotification. # noqa: E501
include_hmac
Gets the include_hmac of this EventNotification. # noqa: E501
# noqa: E501
Returns
The include_hmac of this EventNotification. # noqa: E501
include_o_auth
Gets the include_o_auth of this EventNotification. # noqa: E501
# noqa: E501
Returns
The include_o_auth of this EventNotification. # noqa: E501
include_sender_account_as_custom_field
Gets the include_sender_account_as_custom_field of this EventNotification. # noqa: E501
When set to true, the sender account ID is included as a envelope custom field in the data. # noqa: E501
Returns
The include_sender_account_as_custom_field of this EventNotification. # noqa: E501
include_time_zone
Gets the include_time_zone of this EventNotification. # noqa: E501
When set to true, the envelope time zone information is included in the message. # noqa: E501
Returns
The include_time_zone of this EventNotification. # noqa: E501
integrator_managed
Gets the integrator_managed of this EventNotification. # noqa: E501
# noqa: E501
Returns
The integrator_managed of this EventNotification. # noqa: E501
logging_enabled
Gets the logging_enabled of this EventNotification. # noqa: E501
When set to true, logging is turned on for envelope events on the Web Console Connect page. # noqa: E501
Returns
The logging_enabled of this EventNotification. # noqa: E501
recipient_events
Gets the recipient_events of this EventNotification. # noqa: E501
A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both. # noqa: E501
Returns
The recipient_events of this EventNotification. # noqa: E501
require_acknowledgment
Gets the require_acknowledgment of this EventNotification. # noqa: E501
When set to true, the DocuSign Connect service checks that the message was received and retries on failures. # noqa: E501
Returns
The require_acknowledgment of this EventNotification. # noqa: E501
sign_message_with_x509_cert
Gets the sign_message_with_x509_cert of this EventNotification. # noqa: E501
When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. # noqa: E501
Returns
The sign_message_with_x509_cert of this EventNotification. # noqa: E501
soap_name_space
Gets the soap_name_space of this EventNotification. # noqa: E501
This lists the namespace in the SOAP listener provided. # noqa: E501
Returns
The soap_name_space of this EventNotification. # noqa: E501
url
Gets the url of this EventNotification. # noqa: E501
Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless useSoapInterface property is set to true. # noqa: E501
Returns
The url of this EventNotification. # noqa: E501
use_soap_interface
Gets the use_soap_interface of this EventNotification. # noqa: E501
When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface. # noqa: E501
Returns
The use_soap_interface of this EventNotification. # noqa: E501
def
to_dict(self)
618 def to_dict(self): 619 """Returns the model properties as a dict""" 620 result = {} 621 622 for attr, _ in six.iteritems(self.swagger_types): 623 value = getattr(self, attr) 624 if isinstance(value, list): 625 result[attr] = list(map( 626 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 627 value 628 )) 629 elif hasattr(value, "to_dict"): 630 result[attr] = value.to_dict() 631 elif isinstance(value, dict): 632 result[attr] = dict(map( 633 lambda item: (item[0], item[1].to_dict()) 634 if hasattr(item[1], "to_dict") else item, 635 value.items() 636 )) 637 else: 638 result[attr] = value 639 if issubclass(EventNotification, dict): 640 for key, value in self.items(): 641 result[key] = value 642 643 return result
Returns the model properties as a dict