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