docusign_esign.models.connect_custom_configuration
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class ConnectCustomConfiguration(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 'allow_envelope_publish': 'str', 37 'allow_salesforce_publish': 'str', 38 'all_users': 'str', 39 'all_users_except': 'str', 40 'configuration_type': 'str', 41 'connect_id': 'str', 42 'delivery_mode': 'str', 43 'disabled_by': 'str', 44 'enable_log': 'str', 45 'envelope_events': 'list[str]', 46 'event_data': 'ConnectEventData', 47 'events': 'list[str]', 48 'external_folder_id': 'str', 49 'external_folder_label': 'str', 50 'group_ids': 'list[str]', 51 'include_certificate_of_completion': 'str', 52 'include_cert_soap_header': 'str', 53 'include_document_fields': 'str', 54 'include_documents': 'str', 55 'include_envelope_void_reason': 'str', 56 'include_hmac': 'str', 57 'include_o_auth': 'str', 58 'include_sender_accountas_custom_field': 'str', 59 'include_time_zone_information': 'str', 60 'integrator_managed': 'str', 61 'name': 'str', 62 'password': 'str', 63 'recipient_events': 'list[str]', 64 'require_mutual_tls': 'str', 65 'requires_acknowledgement': 'str', 66 'salesforce_api_version': 'str', 67 'salesforce_authcode': 'str', 68 'salesforce_call_back_url': 'str', 69 'salesforce_documents_as_content_files': 'str', 70 'sender_override': 'str', 71 'sender_selectable_items': 'list[str]', 72 'sf_objects': 'list[ConnectSalesforceObject]', 73 'sign_message_with_x509_certificate': 'str', 74 'soap_namespace': 'str', 75 'url_to_publish_to': 'str', 76 'user_ids': 'list[str]', 77 'user_name': 'str', 78 'use_soap_interface': 'str' 79 } 80 81 attribute_map = { 82 'allow_envelope_publish': 'allowEnvelopePublish', 83 'allow_salesforce_publish': 'allowSalesforcePublish', 84 'all_users': 'allUsers', 85 'all_users_except': 'allUsersExcept', 86 'configuration_type': 'configurationType', 87 'connect_id': 'connectId', 88 'delivery_mode': 'deliveryMode', 89 'disabled_by': 'disabledBy', 90 'enable_log': 'enableLog', 91 'envelope_events': 'envelopeEvents', 92 'event_data': 'eventData', 93 'events': 'events', 94 'external_folder_id': 'externalFolderId', 95 'external_folder_label': 'externalFolderLabel', 96 'group_ids': 'groupIds', 97 'include_certificate_of_completion': 'includeCertificateOfCompletion', 98 'include_cert_soap_header': 'includeCertSoapHeader', 99 'include_document_fields': 'includeDocumentFields', 100 'include_documents': 'includeDocuments', 101 'include_envelope_void_reason': 'includeEnvelopeVoidReason', 102 'include_hmac': 'includeHMAC', 103 'include_o_auth': 'includeOAuth', 104 'include_sender_accountas_custom_field': 'includeSenderAccountasCustomField', 105 'include_time_zone_information': 'includeTimeZoneInformation', 106 'integrator_managed': 'integratorManaged', 107 'name': 'name', 108 'password': 'password', 109 'recipient_events': 'recipientEvents', 110 'require_mutual_tls': 'requireMutualTls', 111 'requires_acknowledgement': 'requiresAcknowledgement', 112 'salesforce_api_version': 'salesforceApiVersion', 113 'salesforce_authcode': 'salesforceAuthcode', 114 'salesforce_call_back_url': 'salesforceCallBackUrl', 115 'salesforce_documents_as_content_files': 'salesforceDocumentsAsContentFiles', 116 'sender_override': 'senderOverride', 117 'sender_selectable_items': 'senderSelectableItems', 118 'sf_objects': 'sfObjects', 119 'sign_message_with_x509_certificate': 'signMessageWithX509Certificate', 120 'soap_namespace': 'soapNamespace', 121 'url_to_publish_to': 'urlToPublishTo', 122 'user_ids': 'userIds', 123 'user_name': 'userName', 124 'use_soap_interface': 'useSoapInterface' 125 } 126 127 def __init__(self, _configuration=None, **kwargs): # noqa: E501 128 """ConnectCustomConfiguration - a model defined in Swagger""" # noqa: E501 129 if _configuration is None: 130 _configuration = Configuration() 131 self._configuration = _configuration 132 133 self._allow_envelope_publish = None 134 self._allow_salesforce_publish = None 135 self._all_users = None 136 self._all_users_except = None 137 self._configuration_type = None 138 self._connect_id = None 139 self._delivery_mode = None 140 self._disabled_by = None 141 self._enable_log = None 142 self._envelope_events = None 143 self._event_data = None 144 self._events = None 145 self._external_folder_id = None 146 self._external_folder_label = None 147 self._group_ids = None 148 self._include_certificate_of_completion = None 149 self._include_cert_soap_header = None 150 self._include_document_fields = None 151 self._include_documents = None 152 self._include_envelope_void_reason = None 153 self._include_hmac = None 154 self._include_o_auth = None 155 self._include_sender_accountas_custom_field = None 156 self._include_time_zone_information = None 157 self._integrator_managed = None 158 self._name = None 159 self._password = None 160 self._recipient_events = None 161 self._require_mutual_tls = None 162 self._requires_acknowledgement = None 163 self._salesforce_api_version = None 164 self._salesforce_authcode = None 165 self._salesforce_call_back_url = None 166 self._salesforce_documents_as_content_files = None 167 self._sender_override = None 168 self._sender_selectable_items = None 169 self._sf_objects = None 170 self._sign_message_with_x509_certificate = None 171 self._soap_namespace = None 172 self._url_to_publish_to = None 173 self._user_ids = None 174 self._user_name = None 175 self._use_soap_interface = None 176 self.discriminator = None 177 178 setattr(self, "_{}".format('allow_envelope_publish'), kwargs.get('allow_envelope_publish', None)) 179 setattr(self, "_{}".format('allow_salesforce_publish'), kwargs.get('allow_salesforce_publish', None)) 180 setattr(self, "_{}".format('all_users'), kwargs.get('all_users', None)) 181 setattr(self, "_{}".format('all_users_except'), kwargs.get('all_users_except', None)) 182 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 183 setattr(self, "_{}".format('connect_id'), kwargs.get('connect_id', None)) 184 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 185 setattr(self, "_{}".format('disabled_by'), kwargs.get('disabled_by', None)) 186 setattr(self, "_{}".format('enable_log'), kwargs.get('enable_log', None)) 187 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 188 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 189 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 190 setattr(self, "_{}".format('external_folder_id'), kwargs.get('external_folder_id', None)) 191 setattr(self, "_{}".format('external_folder_label'), kwargs.get('external_folder_label', None)) 192 setattr(self, "_{}".format('group_ids'), kwargs.get('group_ids', None)) 193 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 194 setattr(self, "_{}".format('include_cert_soap_header'), kwargs.get('include_cert_soap_header', None)) 195 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 196 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 197 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 198 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 199 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 200 setattr(self, "_{}".format('include_sender_accountas_custom_field'), kwargs.get('include_sender_accountas_custom_field', None)) 201 setattr(self, "_{}".format('include_time_zone_information'), kwargs.get('include_time_zone_information', None)) 202 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 203 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 204 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 205 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 206 setattr(self, "_{}".format('require_mutual_tls'), kwargs.get('require_mutual_tls', None)) 207 setattr(self, "_{}".format('requires_acknowledgement'), kwargs.get('requires_acknowledgement', None)) 208 setattr(self, "_{}".format('salesforce_api_version'), kwargs.get('salesforce_api_version', None)) 209 setattr(self, "_{}".format('salesforce_authcode'), kwargs.get('salesforce_authcode', None)) 210 setattr(self, "_{}".format('salesforce_call_back_url'), kwargs.get('salesforce_call_back_url', None)) 211 setattr(self, "_{}".format('salesforce_documents_as_content_files'), kwargs.get('salesforce_documents_as_content_files', None)) 212 setattr(self, "_{}".format('sender_override'), kwargs.get('sender_override', None)) 213 setattr(self, "_{}".format('sender_selectable_items'), kwargs.get('sender_selectable_items', None)) 214 setattr(self, "_{}".format('sf_objects'), kwargs.get('sf_objects', None)) 215 setattr(self, "_{}".format('sign_message_with_x509_certificate'), kwargs.get('sign_message_with_x509_certificate', None)) 216 setattr(self, "_{}".format('soap_namespace'), kwargs.get('soap_namespace', None)) 217 setattr(self, "_{}".format('url_to_publish_to'), kwargs.get('url_to_publish_to', None)) 218 setattr(self, "_{}".format('user_ids'), kwargs.get('user_ids', None)) 219 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 220 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None)) 221 222 @property 223 def allow_envelope_publish(self): 224 """Gets the allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 225 226 When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. # noqa: E501 227 228 :return: The allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 229 :rtype: str 230 """ 231 return self._allow_envelope_publish 232 233 @allow_envelope_publish.setter 234 def allow_envelope_publish(self, allow_envelope_publish): 235 """Sets the allow_envelope_publish of this ConnectCustomConfiguration. 236 237 When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. # noqa: E501 238 239 :param allow_envelope_publish: The allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 240 :type: str 241 """ 242 243 self._allow_envelope_publish = allow_envelope_publish 244 245 @property 246 def allow_salesforce_publish(self): 247 """Gets the allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 248 249 # noqa: E501 250 251 :return: The allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 252 :rtype: str 253 """ 254 return self._allow_salesforce_publish 255 256 @allow_salesforce_publish.setter 257 def allow_salesforce_publish(self, allow_salesforce_publish): 258 """Sets the allow_salesforce_publish of this ConnectCustomConfiguration. 259 260 # noqa: E501 261 262 :param allow_salesforce_publish: The allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 263 :type: str 264 """ 265 266 self._allow_salesforce_publish = allow_salesforce_publish 267 268 @property 269 def all_users(self): 270 """Gets the all_users of this ConnectCustomConfiguration. # noqa: E501 271 272 When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. # noqa: E501 273 274 :return: The all_users of this ConnectCustomConfiguration. # noqa: E501 275 :rtype: str 276 """ 277 return self._all_users 278 279 @all_users.setter 280 def all_users(self, all_users): 281 """Sets the all_users of this ConnectCustomConfiguration. 282 283 When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. # noqa: E501 284 285 :param all_users: The all_users of this ConnectCustomConfiguration. # noqa: E501 286 :type: str 287 """ 288 289 self._all_users = all_users 290 291 @property 292 def all_users_except(self): 293 """Gets the all_users_except of this ConnectCustomConfiguration. # noqa: E501 294 295 # noqa: E501 296 297 :return: The all_users_except of this ConnectCustomConfiguration. # noqa: E501 298 :rtype: str 299 """ 300 return self._all_users_except 301 302 @all_users_except.setter 303 def all_users_except(self, all_users_except): 304 """Sets the all_users_except of this ConnectCustomConfiguration. 305 306 # noqa: E501 307 308 :param all_users_except: The all_users_except of this ConnectCustomConfiguration. # noqa: E501 309 :type: str 310 """ 311 312 self._all_users_except = all_users_except 313 314 @property 315 def configuration_type(self): 316 """Gets the configuration_type of this ConnectCustomConfiguration. # noqa: E501 317 318 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 319 320 :return: The configuration_type of this ConnectCustomConfiguration. # noqa: E501 321 :rtype: str 322 """ 323 return self._configuration_type 324 325 @configuration_type.setter 326 def configuration_type(self, configuration_type): 327 """Sets the configuration_type of this ConnectCustomConfiguration. 328 329 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 330 331 :param configuration_type: The configuration_type of this ConnectCustomConfiguration. # noqa: E501 332 :type: str 333 """ 334 335 self._configuration_type = configuration_type 336 337 @property 338 def connect_id(self): 339 """Gets the connect_id of this ConnectCustomConfiguration. # noqa: E501 340 341 Specifies the DocuSign generated ID for the Connect configuration. # noqa: E501 342 343 :return: The connect_id of this ConnectCustomConfiguration. # noqa: E501 344 :rtype: str 345 """ 346 return self._connect_id 347 348 @connect_id.setter 349 def connect_id(self, connect_id): 350 """Sets the connect_id of this ConnectCustomConfiguration. 351 352 Specifies the DocuSign generated ID for the Connect configuration. # noqa: E501 353 354 :param connect_id: The connect_id of this ConnectCustomConfiguration. # noqa: E501 355 :type: str 356 """ 357 358 self._connect_id = connect_id 359 360 @property 361 def delivery_mode(self): 362 """Gets the delivery_mode of this ConnectCustomConfiguration. # noqa: E501 363 364 # noqa: E501 365 366 :return: The delivery_mode of this ConnectCustomConfiguration. # noqa: E501 367 :rtype: str 368 """ 369 return self._delivery_mode 370 371 @delivery_mode.setter 372 def delivery_mode(self, delivery_mode): 373 """Sets the delivery_mode of this ConnectCustomConfiguration. 374 375 # noqa: E501 376 377 :param delivery_mode: The delivery_mode of this ConnectCustomConfiguration. # noqa: E501 378 :type: str 379 """ 380 381 self._delivery_mode = delivery_mode 382 383 @property 384 def disabled_by(self): 385 """Gets the disabled_by of this ConnectCustomConfiguration. # noqa: E501 386 387 # noqa: E501 388 389 :return: The disabled_by of this ConnectCustomConfiguration. # noqa: E501 390 :rtype: str 391 """ 392 return self._disabled_by 393 394 @disabled_by.setter 395 def disabled_by(self, disabled_by): 396 """Sets the disabled_by of this ConnectCustomConfiguration. 397 398 # noqa: E501 399 400 :param disabled_by: The disabled_by of this ConnectCustomConfiguration. # noqa: E501 401 :type: str 402 """ 403 404 self._disabled_by = disabled_by 405 406 @property 407 def enable_log(self): 408 """Gets the enable_log of this ConnectCustomConfiguration. # noqa: E501 409 410 This turns Connect logging on or off. When set to **true**, logging is turned on. # noqa: E501 411 412 :return: The enable_log of this ConnectCustomConfiguration. # noqa: E501 413 :rtype: str 414 """ 415 return self._enable_log 416 417 @enable_log.setter 418 def enable_log(self, enable_log): 419 """Sets the enable_log of this ConnectCustomConfiguration. 420 421 This turns Connect logging on or off. When set to **true**, logging is turned on. # noqa: E501 422 423 :param enable_log: The enable_log of this ConnectCustomConfiguration. # noqa: E501 424 :type: str 425 """ 426 427 self._enable_log = enable_log 428 429 @property 430 def envelope_events(self): 431 """Gets the envelope_events of this ConnectCustomConfiguration. # noqa: E501 432 433 A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. # noqa: E501 434 435 :return: The envelope_events of this ConnectCustomConfiguration. # noqa: E501 436 :rtype: list[str] 437 """ 438 return self._envelope_events 439 440 @envelope_events.setter 441 def envelope_events(self, envelope_events): 442 """Sets the envelope_events of this ConnectCustomConfiguration. 443 444 A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. # noqa: E501 445 446 :param envelope_events: The envelope_events of this ConnectCustomConfiguration. # noqa: E501 447 :type: list[str] 448 """ 449 450 self._envelope_events = envelope_events 451 452 @property 453 def event_data(self): 454 """Gets the event_data of this ConnectCustomConfiguration. # noqa: E501 455 456 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 457 458 :return: The event_data of this ConnectCustomConfiguration. # noqa: E501 459 :rtype: ConnectEventData 460 """ 461 return self._event_data 462 463 @event_data.setter 464 def event_data(self, event_data): 465 """Sets the event_data of this ConnectCustomConfiguration. 466 467 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 468 469 :param event_data: The event_data of this ConnectCustomConfiguration. # noqa: E501 470 :type: ConnectEventData 471 """ 472 473 self._event_data = event_data 474 475 @property 476 def events(self): 477 """Gets the events of this ConnectCustomConfiguration. # noqa: E501 478 479 # noqa: E501 480 481 :return: The events of this ConnectCustomConfiguration. # noqa: E501 482 :rtype: list[str] 483 """ 484 return self._events 485 486 @events.setter 487 def events(self, events): 488 """Sets the events of this ConnectCustomConfiguration. 489 490 # noqa: E501 491 492 :param events: The events of this ConnectCustomConfiguration. # noqa: E501 493 :type: list[str] 494 """ 495 496 self._events = events 497 498 @property 499 def external_folder_id(self): 500 """Gets the external_folder_id of this ConnectCustomConfiguration. # noqa: E501 501 502 # noqa: E501 503 504 :return: The external_folder_id of this ConnectCustomConfiguration. # noqa: E501 505 :rtype: str 506 """ 507 return self._external_folder_id 508 509 @external_folder_id.setter 510 def external_folder_id(self, external_folder_id): 511 """Sets the external_folder_id of this ConnectCustomConfiguration. 512 513 # noqa: E501 514 515 :param external_folder_id: The external_folder_id of this ConnectCustomConfiguration. # noqa: E501 516 :type: str 517 """ 518 519 self._external_folder_id = external_folder_id 520 521 @property 522 def external_folder_label(self): 523 """Gets the external_folder_label of this ConnectCustomConfiguration. # noqa: E501 524 525 # noqa: E501 526 527 :return: The external_folder_label of this ConnectCustomConfiguration. # noqa: E501 528 :rtype: str 529 """ 530 return self._external_folder_label 531 532 @external_folder_label.setter 533 def external_folder_label(self, external_folder_label): 534 """Sets the external_folder_label of this ConnectCustomConfiguration. 535 536 # noqa: E501 537 538 :param external_folder_label: The external_folder_label of this ConnectCustomConfiguration. # noqa: E501 539 :type: str 540 """ 541 542 self._external_folder_label = external_folder_label 543 544 @property 545 def group_ids(self): 546 """Gets the group_ids of this ConnectCustomConfiguration. # noqa: E501 547 548 # noqa: E501 549 550 :return: The group_ids of this ConnectCustomConfiguration. # noqa: E501 551 :rtype: list[str] 552 """ 553 return self._group_ids 554 555 @group_ids.setter 556 def group_ids(self, group_ids): 557 """Sets the group_ids of this ConnectCustomConfiguration. 558 559 # noqa: E501 560 561 :param group_ids: The group_ids of this ConnectCustomConfiguration. # noqa: E501 562 :type: list[str] 563 """ 564 565 self._group_ids = group_ids 566 567 @property 568 def include_certificate_of_completion(self): 569 """Gets the include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 570 571 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 572 573 :return: The include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 574 :rtype: str 575 """ 576 return self._include_certificate_of_completion 577 578 @include_certificate_of_completion.setter 579 def include_certificate_of_completion(self, include_certificate_of_completion): 580 """Sets the include_certificate_of_completion of this ConnectCustomConfiguration. 581 582 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 583 584 :param include_certificate_of_completion: The include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 585 :type: str 586 """ 587 588 self._include_certificate_of_completion = include_certificate_of_completion 589 590 @property 591 def include_cert_soap_header(self): 592 """Gets the include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 593 594 # noqa: E501 595 596 :return: The include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 597 :rtype: str 598 """ 599 return self._include_cert_soap_header 600 601 @include_cert_soap_header.setter 602 def include_cert_soap_header(self, include_cert_soap_header): 603 """Sets the include_cert_soap_header of this ConnectCustomConfiguration. 604 605 # noqa: E501 606 607 :param include_cert_soap_header: The include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 608 :type: str 609 """ 610 611 self._include_cert_soap_header = include_cert_soap_header 612 613 @property 614 def include_document_fields(self): 615 """Gets the include_document_fields of this ConnectCustomConfiguration. # noqa: E501 616 617 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 618 619 :return: The include_document_fields of this ConnectCustomConfiguration. # noqa: E501 620 :rtype: str 621 """ 622 return self._include_document_fields 623 624 @include_document_fields.setter 625 def include_document_fields(self, include_document_fields): 626 """Sets the include_document_fields of this ConnectCustomConfiguration. 627 628 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 629 630 :param include_document_fields: The include_document_fields of this ConnectCustomConfiguration. # noqa: E501 631 :type: str 632 """ 633 634 self._include_document_fields = include_document_fields 635 636 @property 637 def include_documents(self): 638 """Gets the include_documents of this ConnectCustomConfiguration. # noqa: E501 639 640 When set to **true**, Connect will send the PDF document along with the update XML. # noqa: E501 641 642 :return: The include_documents of this ConnectCustomConfiguration. # noqa: E501 643 :rtype: str 644 """ 645 return self._include_documents 646 647 @include_documents.setter 648 def include_documents(self, include_documents): 649 """Sets the include_documents of this ConnectCustomConfiguration. 650 651 When set to **true**, Connect will send the PDF document along with the update XML. # noqa: E501 652 653 :param include_documents: The include_documents of this ConnectCustomConfiguration. # noqa: E501 654 :type: str 655 """ 656 657 self._include_documents = include_documents 658 659 @property 660 def include_envelope_void_reason(self): 661 """Gets the include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 662 663 When set to **true**, Connect will include the voidedReason for voided envelopes. # noqa: E501 664 665 :return: The include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 666 :rtype: str 667 """ 668 return self._include_envelope_void_reason 669 670 @include_envelope_void_reason.setter 671 def include_envelope_void_reason(self, include_envelope_void_reason): 672 """Sets the include_envelope_void_reason of this ConnectCustomConfiguration. 673 674 When set to **true**, Connect will include the voidedReason for voided envelopes. # noqa: E501 675 676 :param include_envelope_void_reason: The include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 677 :type: str 678 """ 679 680 self._include_envelope_void_reason = include_envelope_void_reason 681 682 @property 683 def include_hmac(self): 684 """Gets the include_hmac of this ConnectCustomConfiguration. # noqa: E501 685 686 # noqa: E501 687 688 :return: The include_hmac of this ConnectCustomConfiguration. # noqa: E501 689 :rtype: str 690 """ 691 return self._include_hmac 692 693 @include_hmac.setter 694 def include_hmac(self, include_hmac): 695 """Sets the include_hmac of this ConnectCustomConfiguration. 696 697 # noqa: E501 698 699 :param include_hmac: The include_hmac of this ConnectCustomConfiguration. # noqa: E501 700 :type: str 701 """ 702 703 self._include_hmac = include_hmac 704 705 @property 706 def include_o_auth(self): 707 """Gets the include_o_auth of this ConnectCustomConfiguration. # noqa: E501 708 709 # noqa: E501 710 711 :return: The include_o_auth of this ConnectCustomConfiguration. # noqa: E501 712 :rtype: str 713 """ 714 return self._include_o_auth 715 716 @include_o_auth.setter 717 def include_o_auth(self, include_o_auth): 718 """Sets the include_o_auth of this ConnectCustomConfiguration. 719 720 # noqa: E501 721 722 :param include_o_auth: The include_o_auth of this ConnectCustomConfiguration. # noqa: E501 723 :type: str 724 """ 725 726 self._include_o_auth = include_o_auth 727 728 @property 729 def include_sender_accountas_custom_field(self): 730 """Gets the include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 731 732 When set to **true**, Connect will include the sender account as Custom Field in the data. # noqa: E501 733 734 :return: The include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 735 :rtype: str 736 """ 737 return self._include_sender_accountas_custom_field 738 739 @include_sender_accountas_custom_field.setter 740 def include_sender_accountas_custom_field(self, include_sender_accountas_custom_field): 741 """Sets the include_sender_accountas_custom_field of this ConnectCustomConfiguration. 742 743 When set to **true**, Connect will include the sender account as Custom Field in the data. # noqa: E501 744 745 :param include_sender_accountas_custom_field: The include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 746 :type: str 747 """ 748 749 self._include_sender_accountas_custom_field = include_sender_accountas_custom_field 750 751 @property 752 def include_time_zone_information(self): 753 """Gets the include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 754 755 When set to **true**, Connect will include the envelope time zone information. # noqa: E501 756 757 :return: The include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 758 :rtype: str 759 """ 760 return self._include_time_zone_information 761 762 @include_time_zone_information.setter 763 def include_time_zone_information(self, include_time_zone_information): 764 """Sets the include_time_zone_information of this ConnectCustomConfiguration. 765 766 When set to **true**, Connect will include the envelope time zone information. # noqa: E501 767 768 :param include_time_zone_information: The include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 769 :type: str 770 """ 771 772 self._include_time_zone_information = include_time_zone_information 773 774 @property 775 def integrator_managed(self): 776 """Gets the integrator_managed of this ConnectCustomConfiguration. # noqa: E501 777 778 # noqa: E501 779 780 :return: The integrator_managed of this ConnectCustomConfiguration. # noqa: E501 781 :rtype: str 782 """ 783 return self._integrator_managed 784 785 @integrator_managed.setter 786 def integrator_managed(self, integrator_managed): 787 """Sets the integrator_managed of this ConnectCustomConfiguration. 788 789 # noqa: E501 790 791 :param integrator_managed: The integrator_managed of this ConnectCustomConfiguration. # noqa: E501 792 :type: str 793 """ 794 795 self._integrator_managed = integrator_managed 796 797 @property 798 def name(self): 799 """Gets the name of this ConnectCustomConfiguration. # noqa: E501 800 801 The name of the Connect configuration. The name helps identify the configuration in the list. # noqa: E501 802 803 :return: The name of this ConnectCustomConfiguration. # noqa: E501 804 :rtype: str 805 """ 806 return self._name 807 808 @name.setter 809 def name(self, name): 810 """Sets the name of this ConnectCustomConfiguration. 811 812 The name of the Connect configuration. The name helps identify the configuration in the list. # noqa: E501 813 814 :param name: The name of this ConnectCustomConfiguration. # noqa: E501 815 :type: str 816 """ 817 818 self._name = name 819 820 @property 821 def password(self): 822 """Gets the password of this ConnectCustomConfiguration. # noqa: E501 823 824 # noqa: E501 825 826 :return: The password of this ConnectCustomConfiguration. # noqa: E501 827 :rtype: str 828 """ 829 return self._password 830 831 @password.setter 832 def password(self, password): 833 """Sets the password of this ConnectCustomConfiguration. 834 835 # noqa: E501 836 837 :param password: The password of this ConnectCustomConfiguration. # noqa: E501 838 :type: str 839 """ 840 841 self._password = password 842 843 @property 844 def recipient_events(self): 845 """Gets the recipient_events of this ConnectCustomConfiguration. # noqa: E501 846 847 A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. # noqa: E501 848 849 :return: The recipient_events of this ConnectCustomConfiguration. # noqa: E501 850 :rtype: list[str] 851 """ 852 return self._recipient_events 853 854 @recipient_events.setter 855 def recipient_events(self, recipient_events): 856 """Sets the recipient_events of this ConnectCustomConfiguration. 857 858 A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. # noqa: E501 859 860 :param recipient_events: The recipient_events of this ConnectCustomConfiguration. # noqa: E501 861 :type: list[str] 862 """ 863 864 self._recipient_events = recipient_events 865 866 @property 867 def require_mutual_tls(self): 868 """Gets the require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 869 870 # noqa: E501 871 872 :return: The require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 873 :rtype: str 874 """ 875 return self._require_mutual_tls 876 877 @require_mutual_tls.setter 878 def require_mutual_tls(self, require_mutual_tls): 879 """Sets the require_mutual_tls of this ConnectCustomConfiguration. 880 881 # noqa: E501 882 883 :param require_mutual_tls: The require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 884 :type: str 885 """ 886 887 self._require_mutual_tls = require_mutual_tls 888 889 @property 890 def requires_acknowledgement(self): 891 """Gets the requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 892 893 When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. # noqa: E501 894 895 :return: The requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 896 :rtype: str 897 """ 898 return self._requires_acknowledgement 899 900 @requires_acknowledgement.setter 901 def requires_acknowledgement(self, requires_acknowledgement): 902 """Sets the requires_acknowledgement of this ConnectCustomConfiguration. 903 904 When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. # noqa: E501 905 906 :param requires_acknowledgement: The requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 907 :type: str 908 """ 909 910 self._requires_acknowledgement = requires_acknowledgement 911 912 @property 913 def salesforce_api_version(self): 914 """Gets the salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 915 916 # noqa: E501 917 918 :return: The salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 919 :rtype: str 920 """ 921 return self._salesforce_api_version 922 923 @salesforce_api_version.setter 924 def salesforce_api_version(self, salesforce_api_version): 925 """Sets the salesforce_api_version of this ConnectCustomConfiguration. 926 927 # noqa: E501 928 929 :param salesforce_api_version: The salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 930 :type: str 931 """ 932 933 self._salesforce_api_version = salesforce_api_version 934 935 @property 936 def salesforce_authcode(self): 937 """Gets the salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 938 939 # noqa: E501 940 941 :return: The salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 942 :rtype: str 943 """ 944 return self._salesforce_authcode 945 946 @salesforce_authcode.setter 947 def salesforce_authcode(self, salesforce_authcode): 948 """Sets the salesforce_authcode of this ConnectCustomConfiguration. 949 950 # noqa: E501 951 952 :param salesforce_authcode: The salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 953 :type: str 954 """ 955 956 self._salesforce_authcode = salesforce_authcode 957 958 @property 959 def salesforce_call_back_url(self): 960 """Gets the salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 961 962 # noqa: E501 963 964 :return: The salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 965 :rtype: str 966 """ 967 return self._salesforce_call_back_url 968 969 @salesforce_call_back_url.setter 970 def salesforce_call_back_url(self, salesforce_call_back_url): 971 """Sets the salesforce_call_back_url of this ConnectCustomConfiguration. 972 973 # noqa: E501 974 975 :param salesforce_call_back_url: The salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 976 :type: str 977 """ 978 979 self._salesforce_call_back_url = salesforce_call_back_url 980 981 @property 982 def salesforce_documents_as_content_files(self): 983 """Gets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 984 985 # noqa: E501 986 987 :return: The salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 988 :rtype: str 989 """ 990 return self._salesforce_documents_as_content_files 991 992 @salesforce_documents_as_content_files.setter 993 def salesforce_documents_as_content_files(self, salesforce_documents_as_content_files): 994 """Sets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. 995 996 # noqa: E501 997 998 :param salesforce_documents_as_content_files: The salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 999 :type: str 1000 """ 1001 1002 self._salesforce_documents_as_content_files = salesforce_documents_as_content_files 1003 1004 @property 1005 def sender_override(self): 1006 """Gets the sender_override of this ConnectCustomConfiguration. # noqa: E501 1007 1008 # noqa: E501 1009 1010 :return: The sender_override of this ConnectCustomConfiguration. # noqa: E501 1011 :rtype: str 1012 """ 1013 return self._sender_override 1014 1015 @sender_override.setter 1016 def sender_override(self, sender_override): 1017 """Sets the sender_override of this ConnectCustomConfiguration. 1018 1019 # noqa: E501 1020 1021 :param sender_override: The sender_override of this ConnectCustomConfiguration. # noqa: E501 1022 :type: str 1023 """ 1024 1025 self._sender_override = sender_override 1026 1027 @property 1028 def sender_selectable_items(self): 1029 """Gets the sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1030 1031 # noqa: E501 1032 1033 :return: The sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1034 :rtype: list[str] 1035 """ 1036 return self._sender_selectable_items 1037 1038 @sender_selectable_items.setter 1039 def sender_selectable_items(self, sender_selectable_items): 1040 """Sets the sender_selectable_items of this ConnectCustomConfiguration. 1041 1042 # noqa: E501 1043 1044 :param sender_selectable_items: The sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1045 :type: list[str] 1046 """ 1047 1048 self._sender_selectable_items = sender_selectable_items 1049 1050 @property 1051 def sf_objects(self): 1052 """Gets the sf_objects of this ConnectCustomConfiguration. # noqa: E501 1053 1054 # noqa: E501 1055 1056 :return: The sf_objects of this ConnectCustomConfiguration. # noqa: E501 1057 :rtype: list[ConnectSalesforceObject] 1058 """ 1059 return self._sf_objects 1060 1061 @sf_objects.setter 1062 def sf_objects(self, sf_objects): 1063 """Sets the sf_objects of this ConnectCustomConfiguration. 1064 1065 # noqa: E501 1066 1067 :param sf_objects: The sf_objects of this ConnectCustomConfiguration. # noqa: E501 1068 :type: list[ConnectSalesforceObject] 1069 """ 1070 1071 self._sf_objects = sf_objects 1072 1073 @property 1074 def sign_message_with_x509_certificate(self): 1075 """Gets the sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1076 1077 When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. # noqa: E501 1078 1079 :return: The sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1080 :rtype: str 1081 """ 1082 return self._sign_message_with_x509_certificate 1083 1084 @sign_message_with_x509_certificate.setter 1085 def sign_message_with_x509_certificate(self, sign_message_with_x509_certificate): 1086 """Sets the sign_message_with_x509_certificate of this ConnectCustomConfiguration. 1087 1088 When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. # noqa: E501 1089 1090 :param sign_message_with_x509_certificate: The sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1091 :type: str 1092 """ 1093 1094 self._sign_message_with_x509_certificate = sign_message_with_x509_certificate 1095 1096 @property 1097 def soap_namespace(self): 1098 """Gets the soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1099 1100 The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. # noqa: E501 1101 1102 :return: The soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1103 :rtype: str 1104 """ 1105 return self._soap_namespace 1106 1107 @soap_namespace.setter 1108 def soap_namespace(self, soap_namespace): 1109 """Sets the soap_namespace of this ConnectCustomConfiguration. 1110 1111 The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. # noqa: E501 1112 1113 :param soap_namespace: The soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1114 :type: str 1115 """ 1116 1117 self._soap_namespace = soap_namespace 1118 1119 @property 1120 def url_to_publish_to(self): 1121 """Gets the url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1122 1123 This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. # noqa: E501 1124 1125 :return: The url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1126 :rtype: str 1127 """ 1128 return self._url_to_publish_to 1129 1130 @url_to_publish_to.setter 1131 def url_to_publish_to(self, url_to_publish_to): 1132 """Sets the url_to_publish_to of this ConnectCustomConfiguration. 1133 1134 This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. # noqa: E501 1135 1136 :param url_to_publish_to: The url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1137 :type: str 1138 """ 1139 1140 self._url_to_publish_to = url_to_publish_to 1141 1142 @property 1143 def user_ids(self): 1144 """Gets the user_ids of this ConnectCustomConfiguration. # noqa: E501 1145 1146 A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. # noqa: E501 1147 1148 :return: The user_ids of this ConnectCustomConfiguration. # noqa: E501 1149 :rtype: list[str] 1150 """ 1151 return self._user_ids 1152 1153 @user_ids.setter 1154 def user_ids(self, user_ids): 1155 """Sets the user_ids of this ConnectCustomConfiguration. 1156 1157 A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. # noqa: E501 1158 1159 :param user_ids: The user_ids of this ConnectCustomConfiguration. # noqa: E501 1160 :type: list[str] 1161 """ 1162 1163 self._user_ids = user_ids 1164 1165 @property 1166 def user_name(self): 1167 """Gets the user_name of this ConnectCustomConfiguration. # noqa: E501 1168 1169 # noqa: E501 1170 1171 :return: The user_name of this ConnectCustomConfiguration. # noqa: E501 1172 :rtype: str 1173 """ 1174 return self._user_name 1175 1176 @user_name.setter 1177 def user_name(self, user_name): 1178 """Sets the user_name of this ConnectCustomConfiguration. 1179 1180 # noqa: E501 1181 1182 :param user_name: The user_name of this ConnectCustomConfiguration. # noqa: E501 1183 :type: str 1184 """ 1185 1186 self._user_name = user_name 1187 1188 @property 1189 def use_soap_interface(self): 1190 """Gets the use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1191 1192 When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. # noqa: E501 1193 1194 :return: The use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1195 :rtype: str 1196 """ 1197 return self._use_soap_interface 1198 1199 @use_soap_interface.setter 1200 def use_soap_interface(self, use_soap_interface): 1201 """Sets the use_soap_interface of this ConnectCustomConfiguration. 1202 1203 When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. # noqa: E501 1204 1205 :param use_soap_interface: The use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1206 :type: str 1207 """ 1208 1209 self._use_soap_interface = use_soap_interface 1210 1211 def to_dict(self): 1212 """Returns the model properties as a dict""" 1213 result = {} 1214 1215 for attr, _ in six.iteritems(self.swagger_types): 1216 value = getattr(self, attr) 1217 if isinstance(value, list): 1218 result[attr] = list(map( 1219 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1220 value 1221 )) 1222 elif hasattr(value, "to_dict"): 1223 result[attr] = value.to_dict() 1224 elif isinstance(value, dict): 1225 result[attr] = dict(map( 1226 lambda item: (item[0], item[1].to_dict()) 1227 if hasattr(item[1], "to_dict") else item, 1228 value.items() 1229 )) 1230 else: 1231 result[attr] = value 1232 if issubclass(ConnectCustomConfiguration, dict): 1233 for key, value in self.items(): 1234 result[key] = value 1235 1236 return result 1237 1238 def to_str(self): 1239 """Returns the string representation of the model""" 1240 return pprint.pformat(self.to_dict()) 1241 1242 def __repr__(self): 1243 """For `print` and `pprint`""" 1244 return self.to_str() 1245 1246 def __eq__(self, other): 1247 """Returns true if both objects are equal""" 1248 if not isinstance(other, ConnectCustomConfiguration): 1249 return False 1250 1251 return self.to_dict() == other.to_dict() 1252 1253 def __ne__(self, other): 1254 """Returns true if both objects are not equal""" 1255 if not isinstance(other, ConnectCustomConfiguration): 1256 return True 1257 1258 return self.to_dict() != other.to_dict()
23class ConnectCustomConfiguration(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 'allow_envelope_publish': 'str', 38 'allow_salesforce_publish': 'str', 39 'all_users': 'str', 40 'all_users_except': 'str', 41 'configuration_type': 'str', 42 'connect_id': 'str', 43 'delivery_mode': 'str', 44 'disabled_by': 'str', 45 'enable_log': 'str', 46 'envelope_events': 'list[str]', 47 'event_data': 'ConnectEventData', 48 'events': 'list[str]', 49 'external_folder_id': 'str', 50 'external_folder_label': 'str', 51 'group_ids': 'list[str]', 52 'include_certificate_of_completion': 'str', 53 'include_cert_soap_header': 'str', 54 'include_document_fields': 'str', 55 'include_documents': 'str', 56 'include_envelope_void_reason': 'str', 57 'include_hmac': 'str', 58 'include_o_auth': 'str', 59 'include_sender_accountas_custom_field': 'str', 60 'include_time_zone_information': 'str', 61 'integrator_managed': 'str', 62 'name': 'str', 63 'password': 'str', 64 'recipient_events': 'list[str]', 65 'require_mutual_tls': 'str', 66 'requires_acknowledgement': 'str', 67 'salesforce_api_version': 'str', 68 'salesforce_authcode': 'str', 69 'salesforce_call_back_url': 'str', 70 'salesforce_documents_as_content_files': 'str', 71 'sender_override': 'str', 72 'sender_selectable_items': 'list[str]', 73 'sf_objects': 'list[ConnectSalesforceObject]', 74 'sign_message_with_x509_certificate': 'str', 75 'soap_namespace': 'str', 76 'url_to_publish_to': 'str', 77 'user_ids': 'list[str]', 78 'user_name': 'str', 79 'use_soap_interface': 'str' 80 } 81 82 attribute_map = { 83 'allow_envelope_publish': 'allowEnvelopePublish', 84 'allow_salesforce_publish': 'allowSalesforcePublish', 85 'all_users': 'allUsers', 86 'all_users_except': 'allUsersExcept', 87 'configuration_type': 'configurationType', 88 'connect_id': 'connectId', 89 'delivery_mode': 'deliveryMode', 90 'disabled_by': 'disabledBy', 91 'enable_log': 'enableLog', 92 'envelope_events': 'envelopeEvents', 93 'event_data': 'eventData', 94 'events': 'events', 95 'external_folder_id': 'externalFolderId', 96 'external_folder_label': 'externalFolderLabel', 97 'group_ids': 'groupIds', 98 'include_certificate_of_completion': 'includeCertificateOfCompletion', 99 'include_cert_soap_header': 'includeCertSoapHeader', 100 'include_document_fields': 'includeDocumentFields', 101 'include_documents': 'includeDocuments', 102 'include_envelope_void_reason': 'includeEnvelopeVoidReason', 103 'include_hmac': 'includeHMAC', 104 'include_o_auth': 'includeOAuth', 105 'include_sender_accountas_custom_field': 'includeSenderAccountasCustomField', 106 'include_time_zone_information': 'includeTimeZoneInformation', 107 'integrator_managed': 'integratorManaged', 108 'name': 'name', 109 'password': 'password', 110 'recipient_events': 'recipientEvents', 111 'require_mutual_tls': 'requireMutualTls', 112 'requires_acknowledgement': 'requiresAcknowledgement', 113 'salesforce_api_version': 'salesforceApiVersion', 114 'salesforce_authcode': 'salesforceAuthcode', 115 'salesforce_call_back_url': 'salesforceCallBackUrl', 116 'salesforce_documents_as_content_files': 'salesforceDocumentsAsContentFiles', 117 'sender_override': 'senderOverride', 118 'sender_selectable_items': 'senderSelectableItems', 119 'sf_objects': 'sfObjects', 120 'sign_message_with_x509_certificate': 'signMessageWithX509Certificate', 121 'soap_namespace': 'soapNamespace', 122 'url_to_publish_to': 'urlToPublishTo', 123 'user_ids': 'userIds', 124 'user_name': 'userName', 125 'use_soap_interface': 'useSoapInterface' 126 } 127 128 def __init__(self, _configuration=None, **kwargs): # noqa: E501 129 """ConnectCustomConfiguration - a model defined in Swagger""" # noqa: E501 130 if _configuration is None: 131 _configuration = Configuration() 132 self._configuration = _configuration 133 134 self._allow_envelope_publish = None 135 self._allow_salesforce_publish = None 136 self._all_users = None 137 self._all_users_except = None 138 self._configuration_type = None 139 self._connect_id = None 140 self._delivery_mode = None 141 self._disabled_by = None 142 self._enable_log = None 143 self._envelope_events = None 144 self._event_data = None 145 self._events = None 146 self._external_folder_id = None 147 self._external_folder_label = None 148 self._group_ids = None 149 self._include_certificate_of_completion = None 150 self._include_cert_soap_header = None 151 self._include_document_fields = None 152 self._include_documents = None 153 self._include_envelope_void_reason = None 154 self._include_hmac = None 155 self._include_o_auth = None 156 self._include_sender_accountas_custom_field = None 157 self._include_time_zone_information = None 158 self._integrator_managed = None 159 self._name = None 160 self._password = None 161 self._recipient_events = None 162 self._require_mutual_tls = None 163 self._requires_acknowledgement = None 164 self._salesforce_api_version = None 165 self._salesforce_authcode = None 166 self._salesforce_call_back_url = None 167 self._salesforce_documents_as_content_files = None 168 self._sender_override = None 169 self._sender_selectable_items = None 170 self._sf_objects = None 171 self._sign_message_with_x509_certificate = None 172 self._soap_namespace = None 173 self._url_to_publish_to = None 174 self._user_ids = None 175 self._user_name = None 176 self._use_soap_interface = None 177 self.discriminator = None 178 179 setattr(self, "_{}".format('allow_envelope_publish'), kwargs.get('allow_envelope_publish', None)) 180 setattr(self, "_{}".format('allow_salesforce_publish'), kwargs.get('allow_salesforce_publish', None)) 181 setattr(self, "_{}".format('all_users'), kwargs.get('all_users', None)) 182 setattr(self, "_{}".format('all_users_except'), kwargs.get('all_users_except', None)) 183 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 184 setattr(self, "_{}".format('connect_id'), kwargs.get('connect_id', None)) 185 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 186 setattr(self, "_{}".format('disabled_by'), kwargs.get('disabled_by', None)) 187 setattr(self, "_{}".format('enable_log'), kwargs.get('enable_log', None)) 188 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 189 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 190 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 191 setattr(self, "_{}".format('external_folder_id'), kwargs.get('external_folder_id', None)) 192 setattr(self, "_{}".format('external_folder_label'), kwargs.get('external_folder_label', None)) 193 setattr(self, "_{}".format('group_ids'), kwargs.get('group_ids', None)) 194 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 195 setattr(self, "_{}".format('include_cert_soap_header'), kwargs.get('include_cert_soap_header', None)) 196 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 197 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 198 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 199 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 200 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 201 setattr(self, "_{}".format('include_sender_accountas_custom_field'), kwargs.get('include_sender_accountas_custom_field', None)) 202 setattr(self, "_{}".format('include_time_zone_information'), kwargs.get('include_time_zone_information', None)) 203 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 204 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 205 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 206 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 207 setattr(self, "_{}".format('require_mutual_tls'), kwargs.get('require_mutual_tls', None)) 208 setattr(self, "_{}".format('requires_acknowledgement'), kwargs.get('requires_acknowledgement', None)) 209 setattr(self, "_{}".format('salesforce_api_version'), kwargs.get('salesforce_api_version', None)) 210 setattr(self, "_{}".format('salesforce_authcode'), kwargs.get('salesforce_authcode', None)) 211 setattr(self, "_{}".format('salesforce_call_back_url'), kwargs.get('salesforce_call_back_url', None)) 212 setattr(self, "_{}".format('salesforce_documents_as_content_files'), kwargs.get('salesforce_documents_as_content_files', None)) 213 setattr(self, "_{}".format('sender_override'), kwargs.get('sender_override', None)) 214 setattr(self, "_{}".format('sender_selectable_items'), kwargs.get('sender_selectable_items', None)) 215 setattr(self, "_{}".format('sf_objects'), kwargs.get('sf_objects', None)) 216 setattr(self, "_{}".format('sign_message_with_x509_certificate'), kwargs.get('sign_message_with_x509_certificate', None)) 217 setattr(self, "_{}".format('soap_namespace'), kwargs.get('soap_namespace', None)) 218 setattr(self, "_{}".format('url_to_publish_to'), kwargs.get('url_to_publish_to', None)) 219 setattr(self, "_{}".format('user_ids'), kwargs.get('user_ids', None)) 220 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 221 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None)) 222 223 @property 224 def allow_envelope_publish(self): 225 """Gets the allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 226 227 When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. # noqa: E501 228 229 :return: The allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 230 :rtype: str 231 """ 232 return self._allow_envelope_publish 233 234 @allow_envelope_publish.setter 235 def allow_envelope_publish(self, allow_envelope_publish): 236 """Sets the allow_envelope_publish of this ConnectCustomConfiguration. 237 238 When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. # noqa: E501 239 240 :param allow_envelope_publish: The allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501 241 :type: str 242 """ 243 244 self._allow_envelope_publish = allow_envelope_publish 245 246 @property 247 def allow_salesforce_publish(self): 248 """Gets the allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 249 250 # noqa: E501 251 252 :return: The allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 253 :rtype: str 254 """ 255 return self._allow_salesforce_publish 256 257 @allow_salesforce_publish.setter 258 def allow_salesforce_publish(self, allow_salesforce_publish): 259 """Sets the allow_salesforce_publish of this ConnectCustomConfiguration. 260 261 # noqa: E501 262 263 :param allow_salesforce_publish: The allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501 264 :type: str 265 """ 266 267 self._allow_salesforce_publish = allow_salesforce_publish 268 269 @property 270 def all_users(self): 271 """Gets the all_users of this ConnectCustomConfiguration. # noqa: E501 272 273 When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. # noqa: E501 274 275 :return: The all_users of this ConnectCustomConfiguration. # noqa: E501 276 :rtype: str 277 """ 278 return self._all_users 279 280 @all_users.setter 281 def all_users(self, all_users): 282 """Sets the all_users of this ConnectCustomConfiguration. 283 284 When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. # noqa: E501 285 286 :param all_users: The all_users of this ConnectCustomConfiguration. # noqa: E501 287 :type: str 288 """ 289 290 self._all_users = all_users 291 292 @property 293 def all_users_except(self): 294 """Gets the all_users_except of this ConnectCustomConfiguration. # noqa: E501 295 296 # noqa: E501 297 298 :return: The all_users_except of this ConnectCustomConfiguration. # noqa: E501 299 :rtype: str 300 """ 301 return self._all_users_except 302 303 @all_users_except.setter 304 def all_users_except(self, all_users_except): 305 """Sets the all_users_except of this ConnectCustomConfiguration. 306 307 # noqa: E501 308 309 :param all_users_except: The all_users_except of this ConnectCustomConfiguration. # noqa: E501 310 :type: str 311 """ 312 313 self._all_users_except = all_users_except 314 315 @property 316 def configuration_type(self): 317 """Gets the configuration_type of this ConnectCustomConfiguration. # noqa: E501 318 319 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 320 321 :return: The configuration_type of this ConnectCustomConfiguration. # noqa: E501 322 :rtype: str 323 """ 324 return self._configuration_type 325 326 @configuration_type.setter 327 def configuration_type(self, configuration_type): 328 """Sets the configuration_type of this ConnectCustomConfiguration. 329 330 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 331 332 :param configuration_type: The configuration_type of this ConnectCustomConfiguration. # noqa: E501 333 :type: str 334 """ 335 336 self._configuration_type = configuration_type 337 338 @property 339 def connect_id(self): 340 """Gets the connect_id of this ConnectCustomConfiguration. # noqa: E501 341 342 Specifies the DocuSign generated ID for the Connect configuration. # noqa: E501 343 344 :return: The connect_id of this ConnectCustomConfiguration. # noqa: E501 345 :rtype: str 346 """ 347 return self._connect_id 348 349 @connect_id.setter 350 def connect_id(self, connect_id): 351 """Sets the connect_id of this ConnectCustomConfiguration. 352 353 Specifies the DocuSign generated ID for the Connect configuration. # noqa: E501 354 355 :param connect_id: The connect_id of this ConnectCustomConfiguration. # noqa: E501 356 :type: str 357 """ 358 359 self._connect_id = connect_id 360 361 @property 362 def delivery_mode(self): 363 """Gets the delivery_mode of this ConnectCustomConfiguration. # noqa: E501 364 365 # noqa: E501 366 367 :return: The delivery_mode of this ConnectCustomConfiguration. # noqa: E501 368 :rtype: str 369 """ 370 return self._delivery_mode 371 372 @delivery_mode.setter 373 def delivery_mode(self, delivery_mode): 374 """Sets the delivery_mode of this ConnectCustomConfiguration. 375 376 # noqa: E501 377 378 :param delivery_mode: The delivery_mode of this ConnectCustomConfiguration. # noqa: E501 379 :type: str 380 """ 381 382 self._delivery_mode = delivery_mode 383 384 @property 385 def disabled_by(self): 386 """Gets the disabled_by of this ConnectCustomConfiguration. # noqa: E501 387 388 # noqa: E501 389 390 :return: The disabled_by of this ConnectCustomConfiguration. # noqa: E501 391 :rtype: str 392 """ 393 return self._disabled_by 394 395 @disabled_by.setter 396 def disabled_by(self, disabled_by): 397 """Sets the disabled_by of this ConnectCustomConfiguration. 398 399 # noqa: E501 400 401 :param disabled_by: The disabled_by of this ConnectCustomConfiguration. # noqa: E501 402 :type: str 403 """ 404 405 self._disabled_by = disabled_by 406 407 @property 408 def enable_log(self): 409 """Gets the enable_log of this ConnectCustomConfiguration. # noqa: E501 410 411 This turns Connect logging on or off. When set to **true**, logging is turned on. # noqa: E501 412 413 :return: The enable_log of this ConnectCustomConfiguration. # noqa: E501 414 :rtype: str 415 """ 416 return self._enable_log 417 418 @enable_log.setter 419 def enable_log(self, enable_log): 420 """Sets the enable_log of this ConnectCustomConfiguration. 421 422 This turns Connect logging on or off. When set to **true**, logging is turned on. # noqa: E501 423 424 :param enable_log: The enable_log of this ConnectCustomConfiguration. # noqa: E501 425 :type: str 426 """ 427 428 self._enable_log = enable_log 429 430 @property 431 def envelope_events(self): 432 """Gets the envelope_events of this ConnectCustomConfiguration. # noqa: E501 433 434 A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. # noqa: E501 435 436 :return: The envelope_events of this ConnectCustomConfiguration. # noqa: E501 437 :rtype: list[str] 438 """ 439 return self._envelope_events 440 441 @envelope_events.setter 442 def envelope_events(self, envelope_events): 443 """Sets the envelope_events of this ConnectCustomConfiguration. 444 445 A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. # noqa: E501 446 447 :param envelope_events: The envelope_events of this ConnectCustomConfiguration. # noqa: E501 448 :type: list[str] 449 """ 450 451 self._envelope_events = envelope_events 452 453 @property 454 def event_data(self): 455 """Gets the event_data of this ConnectCustomConfiguration. # noqa: E501 456 457 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 458 459 :return: The event_data of this ConnectCustomConfiguration. # noqa: E501 460 :rtype: ConnectEventData 461 """ 462 return self._event_data 463 464 @event_data.setter 465 def event_data(self, event_data): 466 """Sets the event_data of this ConnectCustomConfiguration. 467 468 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 469 470 :param event_data: The event_data of this ConnectCustomConfiguration. # noqa: E501 471 :type: ConnectEventData 472 """ 473 474 self._event_data = event_data 475 476 @property 477 def events(self): 478 """Gets the events of this ConnectCustomConfiguration. # noqa: E501 479 480 # noqa: E501 481 482 :return: The events of this ConnectCustomConfiguration. # noqa: E501 483 :rtype: list[str] 484 """ 485 return self._events 486 487 @events.setter 488 def events(self, events): 489 """Sets the events of this ConnectCustomConfiguration. 490 491 # noqa: E501 492 493 :param events: The events of this ConnectCustomConfiguration. # noqa: E501 494 :type: list[str] 495 """ 496 497 self._events = events 498 499 @property 500 def external_folder_id(self): 501 """Gets the external_folder_id of this ConnectCustomConfiguration. # noqa: E501 502 503 # noqa: E501 504 505 :return: The external_folder_id of this ConnectCustomConfiguration. # noqa: E501 506 :rtype: str 507 """ 508 return self._external_folder_id 509 510 @external_folder_id.setter 511 def external_folder_id(self, external_folder_id): 512 """Sets the external_folder_id of this ConnectCustomConfiguration. 513 514 # noqa: E501 515 516 :param external_folder_id: The external_folder_id of this ConnectCustomConfiguration. # noqa: E501 517 :type: str 518 """ 519 520 self._external_folder_id = external_folder_id 521 522 @property 523 def external_folder_label(self): 524 """Gets the external_folder_label of this ConnectCustomConfiguration. # noqa: E501 525 526 # noqa: E501 527 528 :return: The external_folder_label of this ConnectCustomConfiguration. # noqa: E501 529 :rtype: str 530 """ 531 return self._external_folder_label 532 533 @external_folder_label.setter 534 def external_folder_label(self, external_folder_label): 535 """Sets the external_folder_label of this ConnectCustomConfiguration. 536 537 # noqa: E501 538 539 :param external_folder_label: The external_folder_label of this ConnectCustomConfiguration. # noqa: E501 540 :type: str 541 """ 542 543 self._external_folder_label = external_folder_label 544 545 @property 546 def group_ids(self): 547 """Gets the group_ids of this ConnectCustomConfiguration. # noqa: E501 548 549 # noqa: E501 550 551 :return: The group_ids of this ConnectCustomConfiguration. # noqa: E501 552 :rtype: list[str] 553 """ 554 return self._group_ids 555 556 @group_ids.setter 557 def group_ids(self, group_ids): 558 """Sets the group_ids of this ConnectCustomConfiguration. 559 560 # noqa: E501 561 562 :param group_ids: The group_ids of this ConnectCustomConfiguration. # noqa: E501 563 :type: list[str] 564 """ 565 566 self._group_ids = group_ids 567 568 @property 569 def include_certificate_of_completion(self): 570 """Gets the include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 571 572 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 573 574 :return: The include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 575 :rtype: str 576 """ 577 return self._include_certificate_of_completion 578 579 @include_certificate_of_completion.setter 580 def include_certificate_of_completion(self, include_certificate_of_completion): 581 """Sets the include_certificate_of_completion of this ConnectCustomConfiguration. 582 583 When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. # noqa: E501 584 585 :param include_certificate_of_completion: The include_certificate_of_completion of this ConnectCustomConfiguration. # noqa: E501 586 :type: str 587 """ 588 589 self._include_certificate_of_completion = include_certificate_of_completion 590 591 @property 592 def include_cert_soap_header(self): 593 """Gets the include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 594 595 # noqa: E501 596 597 :return: The include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 598 :rtype: str 599 """ 600 return self._include_cert_soap_header 601 602 @include_cert_soap_header.setter 603 def include_cert_soap_header(self, include_cert_soap_header): 604 """Sets the include_cert_soap_header of this ConnectCustomConfiguration. 605 606 # noqa: E501 607 608 :param include_cert_soap_header: The include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501 609 :type: str 610 """ 611 612 self._include_cert_soap_header = include_cert_soap_header 613 614 @property 615 def include_document_fields(self): 616 """Gets the include_document_fields of this ConnectCustomConfiguration. # noqa: E501 617 618 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 619 620 :return: The include_document_fields of this ConnectCustomConfiguration. # noqa: E501 621 :rtype: str 622 """ 623 return self._include_document_fields 624 625 @include_document_fields.setter 626 def include_document_fields(self, include_document_fields): 627 """Sets the include_document_fields of this ConnectCustomConfiguration. 628 629 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 630 631 :param include_document_fields: The include_document_fields of this ConnectCustomConfiguration. # noqa: E501 632 :type: str 633 """ 634 635 self._include_document_fields = include_document_fields 636 637 @property 638 def include_documents(self): 639 """Gets the include_documents of this ConnectCustomConfiguration. # noqa: E501 640 641 When set to **true**, Connect will send the PDF document along with the update XML. # noqa: E501 642 643 :return: The include_documents of this ConnectCustomConfiguration. # noqa: E501 644 :rtype: str 645 """ 646 return self._include_documents 647 648 @include_documents.setter 649 def include_documents(self, include_documents): 650 """Sets the include_documents of this ConnectCustomConfiguration. 651 652 When set to **true**, Connect will send the PDF document along with the update XML. # noqa: E501 653 654 :param include_documents: The include_documents of this ConnectCustomConfiguration. # noqa: E501 655 :type: str 656 """ 657 658 self._include_documents = include_documents 659 660 @property 661 def include_envelope_void_reason(self): 662 """Gets the include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 663 664 When set to **true**, Connect will include the voidedReason for voided envelopes. # noqa: E501 665 666 :return: The include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 667 :rtype: str 668 """ 669 return self._include_envelope_void_reason 670 671 @include_envelope_void_reason.setter 672 def include_envelope_void_reason(self, include_envelope_void_reason): 673 """Sets the include_envelope_void_reason of this ConnectCustomConfiguration. 674 675 When set to **true**, Connect will include the voidedReason for voided envelopes. # noqa: E501 676 677 :param include_envelope_void_reason: The include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501 678 :type: str 679 """ 680 681 self._include_envelope_void_reason = include_envelope_void_reason 682 683 @property 684 def include_hmac(self): 685 """Gets the include_hmac of this ConnectCustomConfiguration. # noqa: E501 686 687 # noqa: E501 688 689 :return: The include_hmac of this ConnectCustomConfiguration. # noqa: E501 690 :rtype: str 691 """ 692 return self._include_hmac 693 694 @include_hmac.setter 695 def include_hmac(self, include_hmac): 696 """Sets the include_hmac of this ConnectCustomConfiguration. 697 698 # noqa: E501 699 700 :param include_hmac: The include_hmac of this ConnectCustomConfiguration. # noqa: E501 701 :type: str 702 """ 703 704 self._include_hmac = include_hmac 705 706 @property 707 def include_o_auth(self): 708 """Gets the include_o_auth of this ConnectCustomConfiguration. # noqa: E501 709 710 # noqa: E501 711 712 :return: The include_o_auth of this ConnectCustomConfiguration. # noqa: E501 713 :rtype: str 714 """ 715 return self._include_o_auth 716 717 @include_o_auth.setter 718 def include_o_auth(self, include_o_auth): 719 """Sets the include_o_auth of this ConnectCustomConfiguration. 720 721 # noqa: E501 722 723 :param include_o_auth: The include_o_auth of this ConnectCustomConfiguration. # noqa: E501 724 :type: str 725 """ 726 727 self._include_o_auth = include_o_auth 728 729 @property 730 def include_sender_accountas_custom_field(self): 731 """Gets the include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 732 733 When set to **true**, Connect will include the sender account as Custom Field in the data. # noqa: E501 734 735 :return: The include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 736 :rtype: str 737 """ 738 return self._include_sender_accountas_custom_field 739 740 @include_sender_accountas_custom_field.setter 741 def include_sender_accountas_custom_field(self, include_sender_accountas_custom_field): 742 """Sets the include_sender_accountas_custom_field of this ConnectCustomConfiguration. 743 744 When set to **true**, Connect will include the sender account as Custom Field in the data. # noqa: E501 745 746 :param include_sender_accountas_custom_field: The include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501 747 :type: str 748 """ 749 750 self._include_sender_accountas_custom_field = include_sender_accountas_custom_field 751 752 @property 753 def include_time_zone_information(self): 754 """Gets the include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 755 756 When set to **true**, Connect will include the envelope time zone information. # noqa: E501 757 758 :return: The include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 759 :rtype: str 760 """ 761 return self._include_time_zone_information 762 763 @include_time_zone_information.setter 764 def include_time_zone_information(self, include_time_zone_information): 765 """Sets the include_time_zone_information of this ConnectCustomConfiguration. 766 767 When set to **true**, Connect will include the envelope time zone information. # noqa: E501 768 769 :param include_time_zone_information: The include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501 770 :type: str 771 """ 772 773 self._include_time_zone_information = include_time_zone_information 774 775 @property 776 def integrator_managed(self): 777 """Gets the integrator_managed of this ConnectCustomConfiguration. # noqa: E501 778 779 # noqa: E501 780 781 :return: The integrator_managed of this ConnectCustomConfiguration. # noqa: E501 782 :rtype: str 783 """ 784 return self._integrator_managed 785 786 @integrator_managed.setter 787 def integrator_managed(self, integrator_managed): 788 """Sets the integrator_managed of this ConnectCustomConfiguration. 789 790 # noqa: E501 791 792 :param integrator_managed: The integrator_managed of this ConnectCustomConfiguration. # noqa: E501 793 :type: str 794 """ 795 796 self._integrator_managed = integrator_managed 797 798 @property 799 def name(self): 800 """Gets the name of this ConnectCustomConfiguration. # noqa: E501 801 802 The name of the Connect configuration. The name helps identify the configuration in the list. # noqa: E501 803 804 :return: The name of this ConnectCustomConfiguration. # noqa: E501 805 :rtype: str 806 """ 807 return self._name 808 809 @name.setter 810 def name(self, name): 811 """Sets the name of this ConnectCustomConfiguration. 812 813 The name of the Connect configuration. The name helps identify the configuration in the list. # noqa: E501 814 815 :param name: The name of this ConnectCustomConfiguration. # noqa: E501 816 :type: str 817 """ 818 819 self._name = name 820 821 @property 822 def password(self): 823 """Gets the password of this ConnectCustomConfiguration. # noqa: E501 824 825 # noqa: E501 826 827 :return: The password of this ConnectCustomConfiguration. # noqa: E501 828 :rtype: str 829 """ 830 return self._password 831 832 @password.setter 833 def password(self, password): 834 """Sets the password of this ConnectCustomConfiguration. 835 836 # noqa: E501 837 838 :param password: The password of this ConnectCustomConfiguration. # noqa: E501 839 :type: str 840 """ 841 842 self._password = password 843 844 @property 845 def recipient_events(self): 846 """Gets the recipient_events of this ConnectCustomConfiguration. # noqa: E501 847 848 A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. # noqa: E501 849 850 :return: The recipient_events of this ConnectCustomConfiguration. # noqa: E501 851 :rtype: list[str] 852 """ 853 return self._recipient_events 854 855 @recipient_events.setter 856 def recipient_events(self, recipient_events): 857 """Sets the recipient_events of this ConnectCustomConfiguration. 858 859 A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. # noqa: E501 860 861 :param recipient_events: The recipient_events of this ConnectCustomConfiguration. # noqa: E501 862 :type: list[str] 863 """ 864 865 self._recipient_events = recipient_events 866 867 @property 868 def require_mutual_tls(self): 869 """Gets the require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 870 871 # noqa: E501 872 873 :return: The require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 874 :rtype: str 875 """ 876 return self._require_mutual_tls 877 878 @require_mutual_tls.setter 879 def require_mutual_tls(self, require_mutual_tls): 880 """Sets the require_mutual_tls of this ConnectCustomConfiguration. 881 882 # noqa: E501 883 884 :param require_mutual_tls: The require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501 885 :type: str 886 """ 887 888 self._require_mutual_tls = require_mutual_tls 889 890 @property 891 def requires_acknowledgement(self): 892 """Gets the requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 893 894 When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. # noqa: E501 895 896 :return: The requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 897 :rtype: str 898 """ 899 return self._requires_acknowledgement 900 901 @requires_acknowledgement.setter 902 def requires_acknowledgement(self, requires_acknowledgement): 903 """Sets the requires_acknowledgement of this ConnectCustomConfiguration. 904 905 When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. # noqa: E501 906 907 :param requires_acknowledgement: The requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501 908 :type: str 909 """ 910 911 self._requires_acknowledgement = requires_acknowledgement 912 913 @property 914 def salesforce_api_version(self): 915 """Gets the salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 916 917 # noqa: E501 918 919 :return: The salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 920 :rtype: str 921 """ 922 return self._salesforce_api_version 923 924 @salesforce_api_version.setter 925 def salesforce_api_version(self, salesforce_api_version): 926 """Sets the salesforce_api_version of this ConnectCustomConfiguration. 927 928 # noqa: E501 929 930 :param salesforce_api_version: The salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501 931 :type: str 932 """ 933 934 self._salesforce_api_version = salesforce_api_version 935 936 @property 937 def salesforce_authcode(self): 938 """Gets the salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 939 940 # noqa: E501 941 942 :return: The salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 943 :rtype: str 944 """ 945 return self._salesforce_authcode 946 947 @salesforce_authcode.setter 948 def salesforce_authcode(self, salesforce_authcode): 949 """Sets the salesforce_authcode of this ConnectCustomConfiguration. 950 951 # noqa: E501 952 953 :param salesforce_authcode: The salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501 954 :type: str 955 """ 956 957 self._salesforce_authcode = salesforce_authcode 958 959 @property 960 def salesforce_call_back_url(self): 961 """Gets the salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 962 963 # noqa: E501 964 965 :return: The salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 966 :rtype: str 967 """ 968 return self._salesforce_call_back_url 969 970 @salesforce_call_back_url.setter 971 def salesforce_call_back_url(self, salesforce_call_back_url): 972 """Sets the salesforce_call_back_url of this ConnectCustomConfiguration. 973 974 # noqa: E501 975 976 :param salesforce_call_back_url: The salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501 977 :type: str 978 """ 979 980 self._salesforce_call_back_url = salesforce_call_back_url 981 982 @property 983 def salesforce_documents_as_content_files(self): 984 """Gets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 985 986 # noqa: E501 987 988 :return: The salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 989 :rtype: str 990 """ 991 return self._salesforce_documents_as_content_files 992 993 @salesforce_documents_as_content_files.setter 994 def salesforce_documents_as_content_files(self, salesforce_documents_as_content_files): 995 """Sets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. 996 997 # noqa: E501 998 999 :param salesforce_documents_as_content_files: The salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501 1000 :type: str 1001 """ 1002 1003 self._salesforce_documents_as_content_files = salesforce_documents_as_content_files 1004 1005 @property 1006 def sender_override(self): 1007 """Gets the sender_override of this ConnectCustomConfiguration. # noqa: E501 1008 1009 # noqa: E501 1010 1011 :return: The sender_override of this ConnectCustomConfiguration. # noqa: E501 1012 :rtype: str 1013 """ 1014 return self._sender_override 1015 1016 @sender_override.setter 1017 def sender_override(self, sender_override): 1018 """Sets the sender_override of this ConnectCustomConfiguration. 1019 1020 # noqa: E501 1021 1022 :param sender_override: The sender_override of this ConnectCustomConfiguration. # noqa: E501 1023 :type: str 1024 """ 1025 1026 self._sender_override = sender_override 1027 1028 @property 1029 def sender_selectable_items(self): 1030 """Gets the sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1031 1032 # noqa: E501 1033 1034 :return: The sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1035 :rtype: list[str] 1036 """ 1037 return self._sender_selectable_items 1038 1039 @sender_selectable_items.setter 1040 def sender_selectable_items(self, sender_selectable_items): 1041 """Sets the sender_selectable_items of this ConnectCustomConfiguration. 1042 1043 # noqa: E501 1044 1045 :param sender_selectable_items: The sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501 1046 :type: list[str] 1047 """ 1048 1049 self._sender_selectable_items = sender_selectable_items 1050 1051 @property 1052 def sf_objects(self): 1053 """Gets the sf_objects of this ConnectCustomConfiguration. # noqa: E501 1054 1055 # noqa: E501 1056 1057 :return: The sf_objects of this ConnectCustomConfiguration. # noqa: E501 1058 :rtype: list[ConnectSalesforceObject] 1059 """ 1060 return self._sf_objects 1061 1062 @sf_objects.setter 1063 def sf_objects(self, sf_objects): 1064 """Sets the sf_objects of this ConnectCustomConfiguration. 1065 1066 # noqa: E501 1067 1068 :param sf_objects: The sf_objects of this ConnectCustomConfiguration. # noqa: E501 1069 :type: list[ConnectSalesforceObject] 1070 """ 1071 1072 self._sf_objects = sf_objects 1073 1074 @property 1075 def sign_message_with_x509_certificate(self): 1076 """Gets the sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1077 1078 When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. # noqa: E501 1079 1080 :return: The sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1081 :rtype: str 1082 """ 1083 return self._sign_message_with_x509_certificate 1084 1085 @sign_message_with_x509_certificate.setter 1086 def sign_message_with_x509_certificate(self, sign_message_with_x509_certificate): 1087 """Sets the sign_message_with_x509_certificate of this ConnectCustomConfiguration. 1088 1089 When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. # noqa: E501 1090 1091 :param sign_message_with_x509_certificate: The sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501 1092 :type: str 1093 """ 1094 1095 self._sign_message_with_x509_certificate = sign_message_with_x509_certificate 1096 1097 @property 1098 def soap_namespace(self): 1099 """Gets the soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1100 1101 The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. # noqa: E501 1102 1103 :return: The soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1104 :rtype: str 1105 """ 1106 return self._soap_namespace 1107 1108 @soap_namespace.setter 1109 def soap_namespace(self, soap_namespace): 1110 """Sets the soap_namespace of this ConnectCustomConfiguration. 1111 1112 The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. # noqa: E501 1113 1114 :param soap_namespace: The soap_namespace of this ConnectCustomConfiguration. # noqa: E501 1115 :type: str 1116 """ 1117 1118 self._soap_namespace = soap_namespace 1119 1120 @property 1121 def url_to_publish_to(self): 1122 """Gets the url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1123 1124 This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. # noqa: E501 1125 1126 :return: The url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1127 :rtype: str 1128 """ 1129 return self._url_to_publish_to 1130 1131 @url_to_publish_to.setter 1132 def url_to_publish_to(self, url_to_publish_to): 1133 """Sets the url_to_publish_to of this ConnectCustomConfiguration. 1134 1135 This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. # noqa: E501 1136 1137 :param url_to_publish_to: The url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501 1138 :type: str 1139 """ 1140 1141 self._url_to_publish_to = url_to_publish_to 1142 1143 @property 1144 def user_ids(self): 1145 """Gets the user_ids of this ConnectCustomConfiguration. # noqa: E501 1146 1147 A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. # noqa: E501 1148 1149 :return: The user_ids of this ConnectCustomConfiguration. # noqa: E501 1150 :rtype: list[str] 1151 """ 1152 return self._user_ids 1153 1154 @user_ids.setter 1155 def user_ids(self, user_ids): 1156 """Sets the user_ids of this ConnectCustomConfiguration. 1157 1158 A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. # noqa: E501 1159 1160 :param user_ids: The user_ids of this ConnectCustomConfiguration. # noqa: E501 1161 :type: list[str] 1162 """ 1163 1164 self._user_ids = user_ids 1165 1166 @property 1167 def user_name(self): 1168 """Gets the user_name of this ConnectCustomConfiguration. # noqa: E501 1169 1170 # noqa: E501 1171 1172 :return: The user_name of this ConnectCustomConfiguration. # noqa: E501 1173 :rtype: str 1174 """ 1175 return self._user_name 1176 1177 @user_name.setter 1178 def user_name(self, user_name): 1179 """Sets the user_name of this ConnectCustomConfiguration. 1180 1181 # noqa: E501 1182 1183 :param user_name: The user_name of this ConnectCustomConfiguration. # noqa: E501 1184 :type: str 1185 """ 1186 1187 self._user_name = user_name 1188 1189 @property 1190 def use_soap_interface(self): 1191 """Gets the use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1192 1193 When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. # noqa: E501 1194 1195 :return: The use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1196 :rtype: str 1197 """ 1198 return self._use_soap_interface 1199 1200 @use_soap_interface.setter 1201 def use_soap_interface(self, use_soap_interface): 1202 """Sets the use_soap_interface of this ConnectCustomConfiguration. 1203 1204 When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint. # noqa: E501 1205 1206 :param use_soap_interface: The use_soap_interface of this ConnectCustomConfiguration. # noqa: E501 1207 :type: str 1208 """ 1209 1210 self._use_soap_interface = use_soap_interface 1211 1212 def to_dict(self): 1213 """Returns the model properties as a dict""" 1214 result = {} 1215 1216 for attr, _ in six.iteritems(self.swagger_types): 1217 value = getattr(self, attr) 1218 if isinstance(value, list): 1219 result[attr] = list(map( 1220 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1221 value 1222 )) 1223 elif hasattr(value, "to_dict"): 1224 result[attr] = value.to_dict() 1225 elif isinstance(value, dict): 1226 result[attr] = dict(map( 1227 lambda item: (item[0], item[1].to_dict()) 1228 if hasattr(item[1], "to_dict") else item, 1229 value.items() 1230 )) 1231 else: 1232 result[attr] = value 1233 if issubclass(ConnectCustomConfiguration, dict): 1234 for key, value in self.items(): 1235 result[key] = value 1236 1237 return result 1238 1239 def to_str(self): 1240 """Returns the string representation of the model""" 1241 return pprint.pformat(self.to_dict()) 1242 1243 def __repr__(self): 1244 """For `print` and `pprint`""" 1245 return self.to_str() 1246 1247 def __eq__(self, other): 1248 """Returns true if both objects are equal""" 1249 if not isinstance(other, ConnectCustomConfiguration): 1250 return False 1251 1252 return self.to_dict() == other.to_dict() 1253 1254 def __ne__(self, other): 1255 """Returns true if both objects are not equal""" 1256 if not isinstance(other, ConnectCustomConfiguration): 1257 return True 1258 1259 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.
128 def __init__(self, _configuration=None, **kwargs): # noqa: E501 129 """ConnectCustomConfiguration - a model defined in Swagger""" # noqa: E501 130 if _configuration is None: 131 _configuration = Configuration() 132 self._configuration = _configuration 133 134 self._allow_envelope_publish = None 135 self._allow_salesforce_publish = None 136 self._all_users = None 137 self._all_users_except = None 138 self._configuration_type = None 139 self._connect_id = None 140 self._delivery_mode = None 141 self._disabled_by = None 142 self._enable_log = None 143 self._envelope_events = None 144 self._event_data = None 145 self._events = None 146 self._external_folder_id = None 147 self._external_folder_label = None 148 self._group_ids = None 149 self._include_certificate_of_completion = None 150 self._include_cert_soap_header = None 151 self._include_document_fields = None 152 self._include_documents = None 153 self._include_envelope_void_reason = None 154 self._include_hmac = None 155 self._include_o_auth = None 156 self._include_sender_accountas_custom_field = None 157 self._include_time_zone_information = None 158 self._integrator_managed = None 159 self._name = None 160 self._password = None 161 self._recipient_events = None 162 self._require_mutual_tls = None 163 self._requires_acknowledgement = None 164 self._salesforce_api_version = None 165 self._salesforce_authcode = None 166 self._salesforce_call_back_url = None 167 self._salesforce_documents_as_content_files = None 168 self._sender_override = None 169 self._sender_selectable_items = None 170 self._sf_objects = None 171 self._sign_message_with_x509_certificate = None 172 self._soap_namespace = None 173 self._url_to_publish_to = None 174 self._user_ids = None 175 self._user_name = None 176 self._use_soap_interface = None 177 self.discriminator = None 178 179 setattr(self, "_{}".format('allow_envelope_publish'), kwargs.get('allow_envelope_publish', None)) 180 setattr(self, "_{}".format('allow_salesforce_publish'), kwargs.get('allow_salesforce_publish', None)) 181 setattr(self, "_{}".format('all_users'), kwargs.get('all_users', None)) 182 setattr(self, "_{}".format('all_users_except'), kwargs.get('all_users_except', None)) 183 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 184 setattr(self, "_{}".format('connect_id'), kwargs.get('connect_id', None)) 185 setattr(self, "_{}".format('delivery_mode'), kwargs.get('delivery_mode', None)) 186 setattr(self, "_{}".format('disabled_by'), kwargs.get('disabled_by', None)) 187 setattr(self, "_{}".format('enable_log'), kwargs.get('enable_log', None)) 188 setattr(self, "_{}".format('envelope_events'), kwargs.get('envelope_events', None)) 189 setattr(self, "_{}".format('event_data'), kwargs.get('event_data', None)) 190 setattr(self, "_{}".format('events'), kwargs.get('events', None)) 191 setattr(self, "_{}".format('external_folder_id'), kwargs.get('external_folder_id', None)) 192 setattr(self, "_{}".format('external_folder_label'), kwargs.get('external_folder_label', None)) 193 setattr(self, "_{}".format('group_ids'), kwargs.get('group_ids', None)) 194 setattr(self, "_{}".format('include_certificate_of_completion'), kwargs.get('include_certificate_of_completion', None)) 195 setattr(self, "_{}".format('include_cert_soap_header'), kwargs.get('include_cert_soap_header', None)) 196 setattr(self, "_{}".format('include_document_fields'), kwargs.get('include_document_fields', None)) 197 setattr(self, "_{}".format('include_documents'), kwargs.get('include_documents', None)) 198 setattr(self, "_{}".format('include_envelope_void_reason'), kwargs.get('include_envelope_void_reason', None)) 199 setattr(self, "_{}".format('include_hmac'), kwargs.get('include_hmac', None)) 200 setattr(self, "_{}".format('include_o_auth'), kwargs.get('include_o_auth', None)) 201 setattr(self, "_{}".format('include_sender_accountas_custom_field'), kwargs.get('include_sender_accountas_custom_field', None)) 202 setattr(self, "_{}".format('include_time_zone_information'), kwargs.get('include_time_zone_information', None)) 203 setattr(self, "_{}".format('integrator_managed'), kwargs.get('integrator_managed', None)) 204 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 205 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 206 setattr(self, "_{}".format('recipient_events'), kwargs.get('recipient_events', None)) 207 setattr(self, "_{}".format('require_mutual_tls'), kwargs.get('require_mutual_tls', None)) 208 setattr(self, "_{}".format('requires_acknowledgement'), kwargs.get('requires_acknowledgement', None)) 209 setattr(self, "_{}".format('salesforce_api_version'), kwargs.get('salesforce_api_version', None)) 210 setattr(self, "_{}".format('salesforce_authcode'), kwargs.get('salesforce_authcode', None)) 211 setattr(self, "_{}".format('salesforce_call_back_url'), kwargs.get('salesforce_call_back_url', None)) 212 setattr(self, "_{}".format('salesforce_documents_as_content_files'), kwargs.get('salesforce_documents_as_content_files', None)) 213 setattr(self, "_{}".format('sender_override'), kwargs.get('sender_override', None)) 214 setattr(self, "_{}".format('sender_selectable_items'), kwargs.get('sender_selectable_items', None)) 215 setattr(self, "_{}".format('sf_objects'), kwargs.get('sf_objects', None)) 216 setattr(self, "_{}".format('sign_message_with_x509_certificate'), kwargs.get('sign_message_with_x509_certificate', None)) 217 setattr(self, "_{}".format('soap_namespace'), kwargs.get('soap_namespace', None)) 218 setattr(self, "_{}".format('url_to_publish_to'), kwargs.get('url_to_publish_to', None)) 219 setattr(self, "_{}".format('user_ids'), kwargs.get('user_ids', None)) 220 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 221 setattr(self, "_{}".format('use_soap_interface'), kwargs.get('use_soap_interface', None))
ConnectCustomConfiguration - a model defined in Swagger
Gets the allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501
When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. # noqa: E501
Returns
The allow_envelope_publish of this ConnectCustomConfiguration. # noqa: E501
Gets the allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The allow_salesforce_publish of this ConnectCustomConfiguration. # noqa: E501
Gets the all_users of this ConnectCustomConfiguration. # noqa: E501
When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. # noqa: E501
Returns
The all_users of this ConnectCustomConfiguration. # noqa: E501
Gets the all_users_except of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The all_users_except of this ConnectCustomConfiguration. # noqa: E501
Gets the configuration_type of this ConnectCustomConfiguration. # noqa: E501
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce. # noqa: E501
Returns
The configuration_type of this ConnectCustomConfiguration. # noqa: E501
Gets the connect_id of this ConnectCustomConfiguration. # noqa: E501
Specifies the DocuSign generated ID for the Connect configuration. # noqa: E501
Returns
The connect_id of this ConnectCustomConfiguration. # noqa: E501
Gets the delivery_mode of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The delivery_mode of this ConnectCustomConfiguration. # noqa: E501
Gets the disabled_by of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The disabled_by of this ConnectCustomConfiguration. # noqa: E501
Gets the enable_log of this ConnectCustomConfiguration. # noqa: E501
This turns Connect logging on or off. When set to true, logging is turned on. # noqa: E501
Returns
The enable_log of this ConnectCustomConfiguration. # noqa: E501
Gets the envelope_events of this ConnectCustomConfiguration. # noqa: E501
A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. # noqa: E501
Returns
The envelope_events of this ConnectCustomConfiguration. # noqa: E501
Gets the event_data of this ConnectCustomConfiguration. # 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 ConnectCustomConfiguration. # noqa: E501
Gets the events of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The events of this ConnectCustomConfiguration. # noqa: E501
Gets the external_folder_id of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The external_folder_id of this ConnectCustomConfiguration. # noqa: E501
Gets the external_folder_label of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The external_folder_label of this ConnectCustomConfiguration. # noqa: E501
Gets the group_ids of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The group_ids of this ConnectCustomConfiguration. # noqa: E501
Gets the include_certificate_of_completion of this ConnectCustomConfiguration. # 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 ConnectCustomConfiguration. # noqa: E501
Gets the include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The include_cert_soap_header of this ConnectCustomConfiguration. # noqa: E501
Gets the include_document_fields of this ConnectCustomConfiguration. # 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 ConnectCustomConfiguration. # noqa: E501
Gets the include_documents of this ConnectCustomConfiguration. # noqa: E501
When set to true, Connect will send the PDF document along with the update XML. # noqa: E501
Returns
The include_documents of this ConnectCustomConfiguration. # noqa: E501
Gets the include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501
When set to true, Connect will include the voidedReason for voided envelopes. # noqa: E501
Returns
The include_envelope_void_reason of this ConnectCustomConfiguration. # noqa: E501
Gets the include_hmac of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The include_hmac of this ConnectCustomConfiguration. # noqa: E501
Gets the include_o_auth of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The include_o_auth of this ConnectCustomConfiguration. # noqa: E501
Gets the include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501
When set to true, Connect will include the sender account as Custom Field in the data. # noqa: E501
Returns
The include_sender_accountas_custom_field of this ConnectCustomConfiguration. # noqa: E501
Gets the include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501
When set to true, Connect will include the envelope time zone information. # noqa: E501
Returns
The include_time_zone_information of this ConnectCustomConfiguration. # noqa: E501
Gets the integrator_managed of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The integrator_managed of this ConnectCustomConfiguration. # noqa: E501
Gets the name of this ConnectCustomConfiguration. # noqa: E501
The name of the Connect configuration. The name helps identify the configuration in the list. # noqa: E501
Returns
The name of this ConnectCustomConfiguration. # noqa: E501
Gets the password of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The password of this ConnectCustomConfiguration. # noqa: E501
Gets the recipient_events of this ConnectCustomConfiguration. # noqa: E501
A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. # noqa: E501
Returns
The recipient_events of this ConnectCustomConfiguration. # noqa: E501
Gets the require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The require_mutual_tls of this ConnectCustomConfiguration. # noqa: E501
Gets the requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501
When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. # noqa: E501
Returns
The requires_acknowledgement of this ConnectCustomConfiguration. # noqa: E501
Gets the salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The salesforce_api_version of this ConnectCustomConfiguration. # noqa: E501
Gets the salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The salesforce_authcode of this ConnectCustomConfiguration. # noqa: E501
Gets the salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The salesforce_call_back_url of this ConnectCustomConfiguration. # noqa: E501
Gets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501
Gets the sender_override of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The sender_override of this ConnectCustomConfiguration. # noqa: E501
Gets the sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The sender_selectable_items of this ConnectCustomConfiguration. # noqa: E501
Gets the sf_objects of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The sf_objects of this ConnectCustomConfiguration. # noqa: E501
Gets the sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501
When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. # noqa: E501
Returns
The sign_message_with_x509_certificate of this ConnectCustomConfiguration. # noqa: E501
Gets the soap_namespace of this ConnectCustomConfiguration. # noqa: E501
The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. # noqa: E501
Returns
The soap_namespace of this ConnectCustomConfiguration. # noqa: E501
Gets the url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501
This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. # noqa: E501
Returns
The url_to_publish_to of this ConnectCustomConfiguration. # noqa: E501
Gets the user_ids of this ConnectCustomConfiguration. # noqa: E501
A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. # noqa: E501
Returns
The user_ids of this ConnectCustomConfiguration. # noqa: E501
Gets the user_name of this ConnectCustomConfiguration. # noqa: E501
# noqa: E501
Returns
The user_name of this ConnectCustomConfiguration. # noqa: E501
Gets the use_soap_interface of this ConnectCustomConfiguration. # noqa: E501
When set to true, indicates that the urlToPublishTo
property contains a SOAP endpoint. # noqa: E501
Returns
The use_soap_interface of this ConnectCustomConfiguration. # noqa: E501
1212 def to_dict(self): 1213 """Returns the model properties as a dict""" 1214 result = {} 1215 1216 for attr, _ in six.iteritems(self.swagger_types): 1217 value = getattr(self, attr) 1218 if isinstance(value, list): 1219 result[attr] = list(map( 1220 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1221 value 1222 )) 1223 elif hasattr(value, "to_dict"): 1224 result[attr] = value.to_dict() 1225 elif isinstance(value, dict): 1226 result[attr] = dict(map( 1227 lambda item: (item[0], item[1].to_dict()) 1228 if hasattr(item[1], "to_dict") else item, 1229 value.items() 1230 )) 1231 else: 1232 result[attr] = value 1233 if issubclass(ConnectCustomConfiguration, dict): 1234 for key, value in self.items(): 1235 result[key] = value 1236 1237 return result
Returns the model properties as a dict