docusign_esign.models.signer_email_notifications
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 DocuSign REST API 5 6 The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class SignerEmailNotifications(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 'agent_notification': 'str', 37 'carbon_copy_notification': 'str', 38 'certified_delivery_notification': 'str', 39 'comments_only_private_and_mention': 'str', 40 'comments_receive_all': 'str', 41 'document_markup_activation': 'str', 42 'envelope_activation': 'str', 43 'envelope_complete': 'str', 44 'envelope_corrected': 'str', 45 'envelope_declined': 'str', 46 'envelope_voided': 'str', 47 'fax_received': 'str', 48 'offline_signing_failed': 'str', 49 'purge_documents': 'str', 50 'reassigned_signer': 'str', 51 'when_signing_group_member': 'str' 52 } 53 54 attribute_map = { 55 'agent_notification': 'agentNotification', 56 'carbon_copy_notification': 'carbonCopyNotification', 57 'certified_delivery_notification': 'certifiedDeliveryNotification', 58 'comments_only_private_and_mention': 'commentsOnlyPrivateAndMention', 59 'comments_receive_all': 'commentsReceiveAll', 60 'document_markup_activation': 'documentMarkupActivation', 61 'envelope_activation': 'envelopeActivation', 62 'envelope_complete': 'envelopeComplete', 63 'envelope_corrected': 'envelopeCorrected', 64 'envelope_declined': 'envelopeDeclined', 65 'envelope_voided': 'envelopeVoided', 66 'fax_received': 'faxReceived', 67 'offline_signing_failed': 'offlineSigningFailed', 68 'purge_documents': 'purgeDocuments', 69 'reassigned_signer': 'reassignedSigner', 70 'when_signing_group_member': 'whenSigningGroupMember' 71 } 72 73 def __init__(self, _configuration=None, **kwargs): # noqa: E501 74 """SignerEmailNotifications - a model defined in Swagger""" # noqa: E501 75 if _configuration is None: 76 _configuration = Configuration() 77 self._configuration = _configuration 78 79 self._agent_notification = None 80 self._carbon_copy_notification = None 81 self._certified_delivery_notification = None 82 self._comments_only_private_and_mention = None 83 self._comments_receive_all = None 84 self._document_markup_activation = None 85 self._envelope_activation = None 86 self._envelope_complete = None 87 self._envelope_corrected = None 88 self._envelope_declined = None 89 self._envelope_voided = None 90 self._fax_received = None 91 self._offline_signing_failed = None 92 self._purge_documents = None 93 self._reassigned_signer = None 94 self._when_signing_group_member = None 95 self.discriminator = None 96 97 setattr(self, "_{}".format('agent_notification'), kwargs.get('agent_notification', None)) 98 setattr(self, "_{}".format('carbon_copy_notification'), kwargs.get('carbon_copy_notification', None)) 99 setattr(self, "_{}".format('certified_delivery_notification'), kwargs.get('certified_delivery_notification', None)) 100 setattr(self, "_{}".format('comments_only_private_and_mention'), kwargs.get('comments_only_private_and_mention', None)) 101 setattr(self, "_{}".format('comments_receive_all'), kwargs.get('comments_receive_all', None)) 102 setattr(self, "_{}".format('document_markup_activation'), kwargs.get('document_markup_activation', None)) 103 setattr(self, "_{}".format('envelope_activation'), kwargs.get('envelope_activation', None)) 104 setattr(self, "_{}".format('envelope_complete'), kwargs.get('envelope_complete', None)) 105 setattr(self, "_{}".format('envelope_corrected'), kwargs.get('envelope_corrected', None)) 106 setattr(self, "_{}".format('envelope_declined'), kwargs.get('envelope_declined', None)) 107 setattr(self, "_{}".format('envelope_voided'), kwargs.get('envelope_voided', None)) 108 setattr(self, "_{}".format('fax_received'), kwargs.get('fax_received', None)) 109 setattr(self, "_{}".format('offline_signing_failed'), kwargs.get('offline_signing_failed', None)) 110 setattr(self, "_{}".format('purge_documents'), kwargs.get('purge_documents', None)) 111 setattr(self, "_{}".format('reassigned_signer'), kwargs.get('reassigned_signer', None)) 112 setattr(self, "_{}".format('when_signing_group_member'), kwargs.get('when_signing_group_member', None)) 113 114 @property 115 def agent_notification(self): 116 """Gets the agent_notification of this SignerEmailNotifications. # noqa: E501 117 118 When set to **true**, the user receives agent notification emails. # noqa: E501 119 120 :return: The agent_notification of this SignerEmailNotifications. # noqa: E501 121 :rtype: str 122 """ 123 return self._agent_notification 124 125 @agent_notification.setter 126 def agent_notification(self, agent_notification): 127 """Sets the agent_notification of this SignerEmailNotifications. 128 129 When set to **true**, the user receives agent notification emails. # noqa: E501 130 131 :param agent_notification: The agent_notification of this SignerEmailNotifications. # noqa: E501 132 :type: str 133 """ 134 135 self._agent_notification = agent_notification 136 137 @property 138 def carbon_copy_notification(self): 139 """Gets the carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 140 141 When set to **true**, the user receives notifications of carbon copy deliveries. # noqa: E501 142 143 :return: The carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 144 :rtype: str 145 """ 146 return self._carbon_copy_notification 147 148 @carbon_copy_notification.setter 149 def carbon_copy_notification(self, carbon_copy_notification): 150 """Sets the carbon_copy_notification of this SignerEmailNotifications. 151 152 When set to **true**, the user receives notifications of carbon copy deliveries. # noqa: E501 153 154 :param carbon_copy_notification: The carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 155 :type: str 156 """ 157 158 self._carbon_copy_notification = carbon_copy_notification 159 160 @property 161 def certified_delivery_notification(self): 162 """Gets the certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 163 164 When set to **true**, the user receives notifications of certified deliveries. # noqa: E501 165 166 :return: The certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 167 :rtype: str 168 """ 169 return self._certified_delivery_notification 170 171 @certified_delivery_notification.setter 172 def certified_delivery_notification(self, certified_delivery_notification): 173 """Sets the certified_delivery_notification of this SignerEmailNotifications. 174 175 When set to **true**, the user receives notifications of certified deliveries. # noqa: E501 176 177 :param certified_delivery_notification: The certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 178 :type: str 179 """ 180 181 self._certified_delivery_notification = certified_delivery_notification 182 183 @property 184 def comments_only_private_and_mention(self): 185 """Gets the comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 186 187 # noqa: E501 188 189 :return: The comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 190 :rtype: str 191 """ 192 return self._comments_only_private_and_mention 193 194 @comments_only_private_and_mention.setter 195 def comments_only_private_and_mention(self, comments_only_private_and_mention): 196 """Sets the comments_only_private_and_mention of this SignerEmailNotifications. 197 198 # noqa: E501 199 200 :param comments_only_private_and_mention: The comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 201 :type: str 202 """ 203 204 self._comments_only_private_and_mention = comments_only_private_and_mention 205 206 @property 207 def comments_receive_all(self): 208 """Gets the comments_receive_all of this SignerEmailNotifications. # noqa: E501 209 210 # noqa: E501 211 212 :return: The comments_receive_all of this SignerEmailNotifications. # noqa: E501 213 :rtype: str 214 """ 215 return self._comments_receive_all 216 217 @comments_receive_all.setter 218 def comments_receive_all(self, comments_receive_all): 219 """Sets the comments_receive_all of this SignerEmailNotifications. 220 221 # noqa: E501 222 223 :param comments_receive_all: The comments_receive_all of this SignerEmailNotifications. # noqa: E501 224 :type: str 225 """ 226 227 self._comments_receive_all = comments_receive_all 228 229 @property 230 def document_markup_activation(self): 231 """Gets the document_markup_activation of this SignerEmailNotifications. # noqa: E501 232 233 When set to **true**, the user receives notification that document markup has been activated. # noqa: E501 234 235 :return: The document_markup_activation of this SignerEmailNotifications. # noqa: E501 236 :rtype: str 237 """ 238 return self._document_markup_activation 239 240 @document_markup_activation.setter 241 def document_markup_activation(self, document_markup_activation): 242 """Sets the document_markup_activation of this SignerEmailNotifications. 243 244 When set to **true**, the user receives notification that document markup has been activated. # noqa: E501 245 246 :param document_markup_activation: The document_markup_activation of this SignerEmailNotifications. # noqa: E501 247 :type: str 248 """ 249 250 self._document_markup_activation = document_markup_activation 251 252 @property 253 def envelope_activation(self): 254 """Gets the envelope_activation of this SignerEmailNotifications. # noqa: E501 255 256 When set to **true**, the user receives notification that the envelope has been activated. # noqa: E501 257 258 :return: The envelope_activation of this SignerEmailNotifications. # noqa: E501 259 :rtype: str 260 """ 261 return self._envelope_activation 262 263 @envelope_activation.setter 264 def envelope_activation(self, envelope_activation): 265 """Sets the envelope_activation of this SignerEmailNotifications. 266 267 When set to **true**, the user receives notification that the envelope has been activated. # noqa: E501 268 269 :param envelope_activation: The envelope_activation of this SignerEmailNotifications. # noqa: E501 270 :type: str 271 """ 272 273 self._envelope_activation = envelope_activation 274 275 @property 276 def envelope_complete(self): 277 """Gets the envelope_complete of this SignerEmailNotifications. # noqa: E501 278 279 When set to **true**, the user receives notification that the envelope has been completed. # noqa: E501 280 281 :return: The envelope_complete of this SignerEmailNotifications. # noqa: E501 282 :rtype: str 283 """ 284 return self._envelope_complete 285 286 @envelope_complete.setter 287 def envelope_complete(self, envelope_complete): 288 """Sets the envelope_complete of this SignerEmailNotifications. 289 290 When set to **true**, the user receives notification that the envelope has been completed. # noqa: E501 291 292 :param envelope_complete: The envelope_complete of this SignerEmailNotifications. # noqa: E501 293 :type: str 294 """ 295 296 self._envelope_complete = envelope_complete 297 298 @property 299 def envelope_corrected(self): 300 """Gets the envelope_corrected of this SignerEmailNotifications. # noqa: E501 301 302 When set to **true**, the user receives notification that the envelope has been corrected. # noqa: E501 303 304 :return: The envelope_corrected of this SignerEmailNotifications. # noqa: E501 305 :rtype: str 306 """ 307 return self._envelope_corrected 308 309 @envelope_corrected.setter 310 def envelope_corrected(self, envelope_corrected): 311 """Sets the envelope_corrected of this SignerEmailNotifications. 312 313 When set to **true**, the user receives notification that the envelope has been corrected. # noqa: E501 314 315 :param envelope_corrected: The envelope_corrected of this SignerEmailNotifications. # noqa: E501 316 :type: str 317 """ 318 319 self._envelope_corrected = envelope_corrected 320 321 @property 322 def envelope_declined(self): 323 """Gets the envelope_declined of this SignerEmailNotifications. # noqa: E501 324 325 When set to **true**, the user receives notification that the envelope has been declined. # noqa: E501 326 327 :return: The envelope_declined of this SignerEmailNotifications. # noqa: E501 328 :rtype: str 329 """ 330 return self._envelope_declined 331 332 @envelope_declined.setter 333 def envelope_declined(self, envelope_declined): 334 """Sets the envelope_declined of this SignerEmailNotifications. 335 336 When set to **true**, the user receives notification that the envelope has been declined. # noqa: E501 337 338 :param envelope_declined: The envelope_declined of this SignerEmailNotifications. # noqa: E501 339 :type: str 340 """ 341 342 self._envelope_declined = envelope_declined 343 344 @property 345 def envelope_voided(self): 346 """Gets the envelope_voided of this SignerEmailNotifications. # noqa: E501 347 348 When set to **true**, the user receives notification that the envelope has been voided. # noqa: E501 349 350 :return: The envelope_voided of this SignerEmailNotifications. # noqa: E501 351 :rtype: str 352 """ 353 return self._envelope_voided 354 355 @envelope_voided.setter 356 def envelope_voided(self, envelope_voided): 357 """Sets the envelope_voided of this SignerEmailNotifications. 358 359 When set to **true**, the user receives notification that the envelope has been voided. # noqa: E501 360 361 :param envelope_voided: The envelope_voided of this SignerEmailNotifications. # noqa: E501 362 :type: str 363 """ 364 365 self._envelope_voided = envelope_voided 366 367 @property 368 def fax_received(self): 369 """Gets the fax_received of this SignerEmailNotifications. # noqa: E501 370 371 Reserved: # noqa: E501 372 373 :return: The fax_received of this SignerEmailNotifications. # noqa: E501 374 :rtype: str 375 """ 376 return self._fax_received 377 378 @fax_received.setter 379 def fax_received(self, fax_received): 380 """Sets the fax_received of this SignerEmailNotifications. 381 382 Reserved: # noqa: E501 383 384 :param fax_received: The fax_received of this SignerEmailNotifications. # noqa: E501 385 :type: str 386 """ 387 388 self._fax_received = fax_received 389 390 @property 391 def offline_signing_failed(self): 392 """Gets the offline_signing_failed of this SignerEmailNotifications. # noqa: E501 393 394 When set to **true**, the user receives notification if the offline signing failed. # noqa: E501 395 396 :return: The offline_signing_failed of this SignerEmailNotifications. # noqa: E501 397 :rtype: str 398 """ 399 return self._offline_signing_failed 400 401 @offline_signing_failed.setter 402 def offline_signing_failed(self, offline_signing_failed): 403 """Sets the offline_signing_failed of this SignerEmailNotifications. 404 405 When set to **true**, the user receives notification if the offline signing failed. # noqa: E501 406 407 :param offline_signing_failed: The offline_signing_failed of this SignerEmailNotifications. # noqa: E501 408 :type: str 409 """ 410 411 self._offline_signing_failed = offline_signing_failed 412 413 @property 414 def purge_documents(self): 415 """Gets the purge_documents of this SignerEmailNotifications. # noqa: E501 416 417 When set to **true**, the user receives notification of document purges. # noqa: E501 418 419 :return: The purge_documents of this SignerEmailNotifications. # noqa: E501 420 :rtype: str 421 """ 422 return self._purge_documents 423 424 @purge_documents.setter 425 def purge_documents(self, purge_documents): 426 """Sets the purge_documents of this SignerEmailNotifications. 427 428 When set to **true**, the user receives notification of document purges. # noqa: E501 429 430 :param purge_documents: The purge_documents of this SignerEmailNotifications. # noqa: E501 431 :type: str 432 """ 433 434 self._purge_documents = purge_documents 435 436 @property 437 def reassigned_signer(self): 438 """Gets the reassigned_signer of this SignerEmailNotifications. # noqa: E501 439 440 When set to **true**, the user receives notification that the envelope has been reassigned. # noqa: E501 441 442 :return: The reassigned_signer of this SignerEmailNotifications. # noqa: E501 443 :rtype: str 444 """ 445 return self._reassigned_signer 446 447 @reassigned_signer.setter 448 def reassigned_signer(self, reassigned_signer): 449 """Sets the reassigned_signer of this SignerEmailNotifications. 450 451 When set to **true**, the user receives notification that the envelope has been reassigned. # noqa: E501 452 453 :param reassigned_signer: The reassigned_signer of this SignerEmailNotifications. # noqa: E501 454 :type: str 455 """ 456 457 self._reassigned_signer = reassigned_signer 458 459 @property 460 def when_signing_group_member(self): 461 """Gets the when_signing_group_member of this SignerEmailNotifications. # noqa: E501 462 463 # noqa: E501 464 465 :return: The when_signing_group_member of this SignerEmailNotifications. # noqa: E501 466 :rtype: str 467 """ 468 return self._when_signing_group_member 469 470 @when_signing_group_member.setter 471 def when_signing_group_member(self, when_signing_group_member): 472 """Sets the when_signing_group_member of this SignerEmailNotifications. 473 474 # noqa: E501 475 476 :param when_signing_group_member: The when_signing_group_member of this SignerEmailNotifications. # noqa: E501 477 :type: str 478 """ 479 480 self._when_signing_group_member = when_signing_group_member 481 482 def to_dict(self): 483 """Returns the model properties as a dict""" 484 result = {} 485 486 for attr, _ in six.iteritems(self.swagger_types): 487 value = getattr(self, attr) 488 if isinstance(value, list): 489 result[attr] = list(map( 490 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 491 value 492 )) 493 elif hasattr(value, "to_dict"): 494 result[attr] = value.to_dict() 495 elif isinstance(value, dict): 496 result[attr] = dict(map( 497 lambda item: (item[0], item[1].to_dict()) 498 if hasattr(item[1], "to_dict") else item, 499 value.items() 500 )) 501 else: 502 result[attr] = value 503 if issubclass(SignerEmailNotifications, dict): 504 for key, value in self.items(): 505 result[key] = value 506 507 return result 508 509 def to_str(self): 510 """Returns the string representation of the model""" 511 return pprint.pformat(self.to_dict()) 512 513 def __repr__(self): 514 """For `print` and `pprint`""" 515 return self.to_str() 516 517 def __eq__(self, other): 518 """Returns true if both objects are equal""" 519 if not isinstance(other, SignerEmailNotifications): 520 return False 521 522 return self.to_dict() == other.to_dict() 523 524 def __ne__(self, other): 525 """Returns true if both objects are not equal""" 526 if not isinstance(other, SignerEmailNotifications): 527 return True 528 529 return self.to_dict() != other.to_dict()
class
SignerEmailNotifications:
23class SignerEmailNotifications(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 'agent_notification': 'str', 38 'carbon_copy_notification': 'str', 39 'certified_delivery_notification': 'str', 40 'comments_only_private_and_mention': 'str', 41 'comments_receive_all': 'str', 42 'document_markup_activation': 'str', 43 'envelope_activation': 'str', 44 'envelope_complete': 'str', 45 'envelope_corrected': 'str', 46 'envelope_declined': 'str', 47 'envelope_voided': 'str', 48 'fax_received': 'str', 49 'offline_signing_failed': 'str', 50 'purge_documents': 'str', 51 'reassigned_signer': 'str', 52 'when_signing_group_member': 'str' 53 } 54 55 attribute_map = { 56 'agent_notification': 'agentNotification', 57 'carbon_copy_notification': 'carbonCopyNotification', 58 'certified_delivery_notification': 'certifiedDeliveryNotification', 59 'comments_only_private_and_mention': 'commentsOnlyPrivateAndMention', 60 'comments_receive_all': 'commentsReceiveAll', 61 'document_markup_activation': 'documentMarkupActivation', 62 'envelope_activation': 'envelopeActivation', 63 'envelope_complete': 'envelopeComplete', 64 'envelope_corrected': 'envelopeCorrected', 65 'envelope_declined': 'envelopeDeclined', 66 'envelope_voided': 'envelopeVoided', 67 'fax_received': 'faxReceived', 68 'offline_signing_failed': 'offlineSigningFailed', 69 'purge_documents': 'purgeDocuments', 70 'reassigned_signer': 'reassignedSigner', 71 'when_signing_group_member': 'whenSigningGroupMember' 72 } 73 74 def __init__(self, _configuration=None, **kwargs): # noqa: E501 75 """SignerEmailNotifications - a model defined in Swagger""" # noqa: E501 76 if _configuration is None: 77 _configuration = Configuration() 78 self._configuration = _configuration 79 80 self._agent_notification = None 81 self._carbon_copy_notification = None 82 self._certified_delivery_notification = None 83 self._comments_only_private_and_mention = None 84 self._comments_receive_all = None 85 self._document_markup_activation = None 86 self._envelope_activation = None 87 self._envelope_complete = None 88 self._envelope_corrected = None 89 self._envelope_declined = None 90 self._envelope_voided = None 91 self._fax_received = None 92 self._offline_signing_failed = None 93 self._purge_documents = None 94 self._reassigned_signer = None 95 self._when_signing_group_member = None 96 self.discriminator = None 97 98 setattr(self, "_{}".format('agent_notification'), kwargs.get('agent_notification', None)) 99 setattr(self, "_{}".format('carbon_copy_notification'), kwargs.get('carbon_copy_notification', None)) 100 setattr(self, "_{}".format('certified_delivery_notification'), kwargs.get('certified_delivery_notification', None)) 101 setattr(self, "_{}".format('comments_only_private_and_mention'), kwargs.get('comments_only_private_and_mention', None)) 102 setattr(self, "_{}".format('comments_receive_all'), kwargs.get('comments_receive_all', None)) 103 setattr(self, "_{}".format('document_markup_activation'), kwargs.get('document_markup_activation', None)) 104 setattr(self, "_{}".format('envelope_activation'), kwargs.get('envelope_activation', None)) 105 setattr(self, "_{}".format('envelope_complete'), kwargs.get('envelope_complete', None)) 106 setattr(self, "_{}".format('envelope_corrected'), kwargs.get('envelope_corrected', None)) 107 setattr(self, "_{}".format('envelope_declined'), kwargs.get('envelope_declined', None)) 108 setattr(self, "_{}".format('envelope_voided'), kwargs.get('envelope_voided', None)) 109 setattr(self, "_{}".format('fax_received'), kwargs.get('fax_received', None)) 110 setattr(self, "_{}".format('offline_signing_failed'), kwargs.get('offline_signing_failed', None)) 111 setattr(self, "_{}".format('purge_documents'), kwargs.get('purge_documents', None)) 112 setattr(self, "_{}".format('reassigned_signer'), kwargs.get('reassigned_signer', None)) 113 setattr(self, "_{}".format('when_signing_group_member'), kwargs.get('when_signing_group_member', None)) 114 115 @property 116 def agent_notification(self): 117 """Gets the agent_notification of this SignerEmailNotifications. # noqa: E501 118 119 When set to **true**, the user receives agent notification emails. # noqa: E501 120 121 :return: The agent_notification of this SignerEmailNotifications. # noqa: E501 122 :rtype: str 123 """ 124 return self._agent_notification 125 126 @agent_notification.setter 127 def agent_notification(self, agent_notification): 128 """Sets the agent_notification of this SignerEmailNotifications. 129 130 When set to **true**, the user receives agent notification emails. # noqa: E501 131 132 :param agent_notification: The agent_notification of this SignerEmailNotifications. # noqa: E501 133 :type: str 134 """ 135 136 self._agent_notification = agent_notification 137 138 @property 139 def carbon_copy_notification(self): 140 """Gets the carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 141 142 When set to **true**, the user receives notifications of carbon copy deliveries. # noqa: E501 143 144 :return: The carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 145 :rtype: str 146 """ 147 return self._carbon_copy_notification 148 149 @carbon_copy_notification.setter 150 def carbon_copy_notification(self, carbon_copy_notification): 151 """Sets the carbon_copy_notification of this SignerEmailNotifications. 152 153 When set to **true**, the user receives notifications of carbon copy deliveries. # noqa: E501 154 155 :param carbon_copy_notification: The carbon_copy_notification of this SignerEmailNotifications. # noqa: E501 156 :type: str 157 """ 158 159 self._carbon_copy_notification = carbon_copy_notification 160 161 @property 162 def certified_delivery_notification(self): 163 """Gets the certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 164 165 When set to **true**, the user receives notifications of certified deliveries. # noqa: E501 166 167 :return: The certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 168 :rtype: str 169 """ 170 return self._certified_delivery_notification 171 172 @certified_delivery_notification.setter 173 def certified_delivery_notification(self, certified_delivery_notification): 174 """Sets the certified_delivery_notification of this SignerEmailNotifications. 175 176 When set to **true**, the user receives notifications of certified deliveries. # noqa: E501 177 178 :param certified_delivery_notification: The certified_delivery_notification of this SignerEmailNotifications. # noqa: E501 179 :type: str 180 """ 181 182 self._certified_delivery_notification = certified_delivery_notification 183 184 @property 185 def comments_only_private_and_mention(self): 186 """Gets the comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 187 188 # noqa: E501 189 190 :return: The comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 191 :rtype: str 192 """ 193 return self._comments_only_private_and_mention 194 195 @comments_only_private_and_mention.setter 196 def comments_only_private_and_mention(self, comments_only_private_and_mention): 197 """Sets the comments_only_private_and_mention of this SignerEmailNotifications. 198 199 # noqa: E501 200 201 :param comments_only_private_and_mention: The comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501 202 :type: str 203 """ 204 205 self._comments_only_private_and_mention = comments_only_private_and_mention 206 207 @property 208 def comments_receive_all(self): 209 """Gets the comments_receive_all of this SignerEmailNotifications. # noqa: E501 210 211 # noqa: E501 212 213 :return: The comments_receive_all of this SignerEmailNotifications. # noqa: E501 214 :rtype: str 215 """ 216 return self._comments_receive_all 217 218 @comments_receive_all.setter 219 def comments_receive_all(self, comments_receive_all): 220 """Sets the comments_receive_all of this SignerEmailNotifications. 221 222 # noqa: E501 223 224 :param comments_receive_all: The comments_receive_all of this SignerEmailNotifications. # noqa: E501 225 :type: str 226 """ 227 228 self._comments_receive_all = comments_receive_all 229 230 @property 231 def document_markup_activation(self): 232 """Gets the document_markup_activation of this SignerEmailNotifications. # noqa: E501 233 234 When set to **true**, the user receives notification that document markup has been activated. # noqa: E501 235 236 :return: The document_markup_activation of this SignerEmailNotifications. # noqa: E501 237 :rtype: str 238 """ 239 return self._document_markup_activation 240 241 @document_markup_activation.setter 242 def document_markup_activation(self, document_markup_activation): 243 """Sets the document_markup_activation of this SignerEmailNotifications. 244 245 When set to **true**, the user receives notification that document markup has been activated. # noqa: E501 246 247 :param document_markup_activation: The document_markup_activation of this SignerEmailNotifications. # noqa: E501 248 :type: str 249 """ 250 251 self._document_markup_activation = document_markup_activation 252 253 @property 254 def envelope_activation(self): 255 """Gets the envelope_activation of this SignerEmailNotifications. # noqa: E501 256 257 When set to **true**, the user receives notification that the envelope has been activated. # noqa: E501 258 259 :return: The envelope_activation of this SignerEmailNotifications. # noqa: E501 260 :rtype: str 261 """ 262 return self._envelope_activation 263 264 @envelope_activation.setter 265 def envelope_activation(self, envelope_activation): 266 """Sets the envelope_activation of this SignerEmailNotifications. 267 268 When set to **true**, the user receives notification that the envelope has been activated. # noqa: E501 269 270 :param envelope_activation: The envelope_activation of this SignerEmailNotifications. # noqa: E501 271 :type: str 272 """ 273 274 self._envelope_activation = envelope_activation 275 276 @property 277 def envelope_complete(self): 278 """Gets the envelope_complete of this SignerEmailNotifications. # noqa: E501 279 280 When set to **true**, the user receives notification that the envelope has been completed. # noqa: E501 281 282 :return: The envelope_complete of this SignerEmailNotifications. # noqa: E501 283 :rtype: str 284 """ 285 return self._envelope_complete 286 287 @envelope_complete.setter 288 def envelope_complete(self, envelope_complete): 289 """Sets the envelope_complete of this SignerEmailNotifications. 290 291 When set to **true**, the user receives notification that the envelope has been completed. # noqa: E501 292 293 :param envelope_complete: The envelope_complete of this SignerEmailNotifications. # noqa: E501 294 :type: str 295 """ 296 297 self._envelope_complete = envelope_complete 298 299 @property 300 def envelope_corrected(self): 301 """Gets the envelope_corrected of this SignerEmailNotifications. # noqa: E501 302 303 When set to **true**, the user receives notification that the envelope has been corrected. # noqa: E501 304 305 :return: The envelope_corrected of this SignerEmailNotifications. # noqa: E501 306 :rtype: str 307 """ 308 return self._envelope_corrected 309 310 @envelope_corrected.setter 311 def envelope_corrected(self, envelope_corrected): 312 """Sets the envelope_corrected of this SignerEmailNotifications. 313 314 When set to **true**, the user receives notification that the envelope has been corrected. # noqa: E501 315 316 :param envelope_corrected: The envelope_corrected of this SignerEmailNotifications. # noqa: E501 317 :type: str 318 """ 319 320 self._envelope_corrected = envelope_corrected 321 322 @property 323 def envelope_declined(self): 324 """Gets the envelope_declined of this SignerEmailNotifications. # noqa: E501 325 326 When set to **true**, the user receives notification that the envelope has been declined. # noqa: E501 327 328 :return: The envelope_declined of this SignerEmailNotifications. # noqa: E501 329 :rtype: str 330 """ 331 return self._envelope_declined 332 333 @envelope_declined.setter 334 def envelope_declined(self, envelope_declined): 335 """Sets the envelope_declined of this SignerEmailNotifications. 336 337 When set to **true**, the user receives notification that the envelope has been declined. # noqa: E501 338 339 :param envelope_declined: The envelope_declined of this SignerEmailNotifications. # noqa: E501 340 :type: str 341 """ 342 343 self._envelope_declined = envelope_declined 344 345 @property 346 def envelope_voided(self): 347 """Gets the envelope_voided of this SignerEmailNotifications. # noqa: E501 348 349 When set to **true**, the user receives notification that the envelope has been voided. # noqa: E501 350 351 :return: The envelope_voided of this SignerEmailNotifications. # noqa: E501 352 :rtype: str 353 """ 354 return self._envelope_voided 355 356 @envelope_voided.setter 357 def envelope_voided(self, envelope_voided): 358 """Sets the envelope_voided of this SignerEmailNotifications. 359 360 When set to **true**, the user receives notification that the envelope has been voided. # noqa: E501 361 362 :param envelope_voided: The envelope_voided of this SignerEmailNotifications. # noqa: E501 363 :type: str 364 """ 365 366 self._envelope_voided = envelope_voided 367 368 @property 369 def fax_received(self): 370 """Gets the fax_received of this SignerEmailNotifications. # noqa: E501 371 372 Reserved: # noqa: E501 373 374 :return: The fax_received of this SignerEmailNotifications. # noqa: E501 375 :rtype: str 376 """ 377 return self._fax_received 378 379 @fax_received.setter 380 def fax_received(self, fax_received): 381 """Sets the fax_received of this SignerEmailNotifications. 382 383 Reserved: # noqa: E501 384 385 :param fax_received: The fax_received of this SignerEmailNotifications. # noqa: E501 386 :type: str 387 """ 388 389 self._fax_received = fax_received 390 391 @property 392 def offline_signing_failed(self): 393 """Gets the offline_signing_failed of this SignerEmailNotifications. # noqa: E501 394 395 When set to **true**, the user receives notification if the offline signing failed. # noqa: E501 396 397 :return: The offline_signing_failed of this SignerEmailNotifications. # noqa: E501 398 :rtype: str 399 """ 400 return self._offline_signing_failed 401 402 @offline_signing_failed.setter 403 def offline_signing_failed(self, offline_signing_failed): 404 """Sets the offline_signing_failed of this SignerEmailNotifications. 405 406 When set to **true**, the user receives notification if the offline signing failed. # noqa: E501 407 408 :param offline_signing_failed: The offline_signing_failed of this SignerEmailNotifications. # noqa: E501 409 :type: str 410 """ 411 412 self._offline_signing_failed = offline_signing_failed 413 414 @property 415 def purge_documents(self): 416 """Gets the purge_documents of this SignerEmailNotifications. # noqa: E501 417 418 When set to **true**, the user receives notification of document purges. # noqa: E501 419 420 :return: The purge_documents of this SignerEmailNotifications. # noqa: E501 421 :rtype: str 422 """ 423 return self._purge_documents 424 425 @purge_documents.setter 426 def purge_documents(self, purge_documents): 427 """Sets the purge_documents of this SignerEmailNotifications. 428 429 When set to **true**, the user receives notification of document purges. # noqa: E501 430 431 :param purge_documents: The purge_documents of this SignerEmailNotifications. # noqa: E501 432 :type: str 433 """ 434 435 self._purge_documents = purge_documents 436 437 @property 438 def reassigned_signer(self): 439 """Gets the reassigned_signer of this SignerEmailNotifications. # noqa: E501 440 441 When set to **true**, the user receives notification that the envelope has been reassigned. # noqa: E501 442 443 :return: The reassigned_signer of this SignerEmailNotifications. # noqa: E501 444 :rtype: str 445 """ 446 return self._reassigned_signer 447 448 @reassigned_signer.setter 449 def reassigned_signer(self, reassigned_signer): 450 """Sets the reassigned_signer of this SignerEmailNotifications. 451 452 When set to **true**, the user receives notification that the envelope has been reassigned. # noqa: E501 453 454 :param reassigned_signer: The reassigned_signer of this SignerEmailNotifications. # noqa: E501 455 :type: str 456 """ 457 458 self._reassigned_signer = reassigned_signer 459 460 @property 461 def when_signing_group_member(self): 462 """Gets the when_signing_group_member of this SignerEmailNotifications. # noqa: E501 463 464 # noqa: E501 465 466 :return: The when_signing_group_member of this SignerEmailNotifications. # noqa: E501 467 :rtype: str 468 """ 469 return self._when_signing_group_member 470 471 @when_signing_group_member.setter 472 def when_signing_group_member(self, when_signing_group_member): 473 """Sets the when_signing_group_member of this SignerEmailNotifications. 474 475 # noqa: E501 476 477 :param when_signing_group_member: The when_signing_group_member of this SignerEmailNotifications. # noqa: E501 478 :type: str 479 """ 480 481 self._when_signing_group_member = when_signing_group_member 482 483 def to_dict(self): 484 """Returns the model properties as a dict""" 485 result = {} 486 487 for attr, _ in six.iteritems(self.swagger_types): 488 value = getattr(self, attr) 489 if isinstance(value, list): 490 result[attr] = list(map( 491 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 492 value 493 )) 494 elif hasattr(value, "to_dict"): 495 result[attr] = value.to_dict() 496 elif isinstance(value, dict): 497 result[attr] = dict(map( 498 lambda item: (item[0], item[1].to_dict()) 499 if hasattr(item[1], "to_dict") else item, 500 value.items() 501 )) 502 else: 503 result[attr] = value 504 if issubclass(SignerEmailNotifications, dict): 505 for key, value in self.items(): 506 result[key] = value 507 508 return result 509 510 def to_str(self): 511 """Returns the string representation of the model""" 512 return pprint.pformat(self.to_dict()) 513 514 def __repr__(self): 515 """For `print` and `pprint`""" 516 return self.to_str() 517 518 def __eq__(self, other): 519 """Returns true if both objects are equal""" 520 if not isinstance(other, SignerEmailNotifications): 521 return False 522 523 return self.to_dict() == other.to_dict() 524 525 def __ne__(self, other): 526 """Returns true if both objects are not equal""" 527 if not isinstance(other, SignerEmailNotifications): 528 return True 529 530 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.
SignerEmailNotifications(_configuration=None, **kwargs)
74 def __init__(self, _configuration=None, **kwargs): # noqa: E501 75 """SignerEmailNotifications - a model defined in Swagger""" # noqa: E501 76 if _configuration is None: 77 _configuration = Configuration() 78 self._configuration = _configuration 79 80 self._agent_notification = None 81 self._carbon_copy_notification = None 82 self._certified_delivery_notification = None 83 self._comments_only_private_and_mention = None 84 self._comments_receive_all = None 85 self._document_markup_activation = None 86 self._envelope_activation = None 87 self._envelope_complete = None 88 self._envelope_corrected = None 89 self._envelope_declined = None 90 self._envelope_voided = None 91 self._fax_received = None 92 self._offline_signing_failed = None 93 self._purge_documents = None 94 self._reassigned_signer = None 95 self._when_signing_group_member = None 96 self.discriminator = None 97 98 setattr(self, "_{}".format('agent_notification'), kwargs.get('agent_notification', None)) 99 setattr(self, "_{}".format('carbon_copy_notification'), kwargs.get('carbon_copy_notification', None)) 100 setattr(self, "_{}".format('certified_delivery_notification'), kwargs.get('certified_delivery_notification', None)) 101 setattr(self, "_{}".format('comments_only_private_and_mention'), kwargs.get('comments_only_private_and_mention', None)) 102 setattr(self, "_{}".format('comments_receive_all'), kwargs.get('comments_receive_all', None)) 103 setattr(self, "_{}".format('document_markup_activation'), kwargs.get('document_markup_activation', None)) 104 setattr(self, "_{}".format('envelope_activation'), kwargs.get('envelope_activation', None)) 105 setattr(self, "_{}".format('envelope_complete'), kwargs.get('envelope_complete', None)) 106 setattr(self, "_{}".format('envelope_corrected'), kwargs.get('envelope_corrected', None)) 107 setattr(self, "_{}".format('envelope_declined'), kwargs.get('envelope_declined', None)) 108 setattr(self, "_{}".format('envelope_voided'), kwargs.get('envelope_voided', None)) 109 setattr(self, "_{}".format('fax_received'), kwargs.get('fax_received', None)) 110 setattr(self, "_{}".format('offline_signing_failed'), kwargs.get('offline_signing_failed', None)) 111 setattr(self, "_{}".format('purge_documents'), kwargs.get('purge_documents', None)) 112 setattr(self, "_{}".format('reassigned_signer'), kwargs.get('reassigned_signer', None)) 113 setattr(self, "_{}".format('when_signing_group_member'), kwargs.get('when_signing_group_member', None))
SignerEmailNotifications - a model defined in Swagger
swagger_types = {'agent_notification': 'str', 'carbon_copy_notification': 'str', 'certified_delivery_notification': 'str', 'comments_only_private_and_mention': 'str', 'comments_receive_all': 'str', 'document_markup_activation': 'str', 'envelope_activation': 'str', 'envelope_complete': 'str', 'envelope_corrected': 'str', 'envelope_declined': 'str', 'envelope_voided': 'str', 'fax_received': 'str', 'offline_signing_failed': 'str', 'purge_documents': 'str', 'reassigned_signer': 'str', 'when_signing_group_member': 'str'}
attribute_map = {'agent_notification': 'agentNotification', 'carbon_copy_notification': 'carbonCopyNotification', 'certified_delivery_notification': 'certifiedDeliveryNotification', 'comments_only_private_and_mention': 'commentsOnlyPrivateAndMention', 'comments_receive_all': 'commentsReceiveAll', 'document_markup_activation': 'documentMarkupActivation', 'envelope_activation': 'envelopeActivation', 'envelope_complete': 'envelopeComplete', 'envelope_corrected': 'envelopeCorrected', 'envelope_declined': 'envelopeDeclined', 'envelope_voided': 'envelopeVoided', 'fax_received': 'faxReceived', 'offline_signing_failed': 'offlineSigningFailed', 'purge_documents': 'purgeDocuments', 'reassigned_signer': 'reassignedSigner', 'when_signing_group_member': 'whenSigningGroupMember'}
agent_notification
Gets the agent_notification of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives agent notification emails. # noqa: E501
Returns
The agent_notification of this SignerEmailNotifications. # noqa: E501
carbon_copy_notification
Gets the carbon_copy_notification of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notifications of carbon copy deliveries. # noqa: E501
Returns
The carbon_copy_notification of this SignerEmailNotifications. # noqa: E501
certified_delivery_notification
Gets the certified_delivery_notification of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notifications of certified deliveries. # noqa: E501
Returns
The certified_delivery_notification of this SignerEmailNotifications. # noqa: E501
comments_only_private_and_mention
Gets the comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501
# noqa: E501
Returns
The comments_only_private_and_mention of this SignerEmailNotifications. # noqa: E501
comments_receive_all
Gets the comments_receive_all of this SignerEmailNotifications. # noqa: E501
# noqa: E501
Returns
The comments_receive_all of this SignerEmailNotifications. # noqa: E501
document_markup_activation
Gets the document_markup_activation of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that document markup has been activated. # noqa: E501
Returns
The document_markup_activation of this SignerEmailNotifications. # noqa: E501
envelope_activation
Gets the envelope_activation of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been activated. # noqa: E501
Returns
The envelope_activation of this SignerEmailNotifications. # noqa: E501
envelope_complete
Gets the envelope_complete of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been completed. # noqa: E501
Returns
The envelope_complete of this SignerEmailNotifications. # noqa: E501
envelope_corrected
Gets the envelope_corrected of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been corrected. # noqa: E501
Returns
The envelope_corrected of this SignerEmailNotifications. # noqa: E501
envelope_declined
Gets the envelope_declined of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been declined. # noqa: E501
Returns
The envelope_declined of this SignerEmailNotifications. # noqa: E501
envelope_voided
Gets the envelope_voided of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been voided. # noqa: E501
Returns
The envelope_voided of this SignerEmailNotifications. # noqa: E501
fax_received
Gets the fax_received of this SignerEmailNotifications. # noqa: E501
Reserved: # noqa: E501
Returns
The fax_received of this SignerEmailNotifications. # noqa: E501
offline_signing_failed
Gets the offline_signing_failed of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification if the offline signing failed. # noqa: E501
Returns
The offline_signing_failed of this SignerEmailNotifications. # noqa: E501
purge_documents
Gets the purge_documents of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification of document purges. # noqa: E501
Returns
The purge_documents of this SignerEmailNotifications. # noqa: E501
reassigned_signer
Gets the reassigned_signer of this SignerEmailNotifications. # noqa: E501
When set to true, the user receives notification that the envelope has been reassigned. # noqa: E501
Returns
The reassigned_signer of this SignerEmailNotifications. # noqa: E501
when_signing_group_member
Gets the when_signing_group_member of this SignerEmailNotifications. # noqa: E501
# noqa: E501
Returns
The when_signing_group_member of this SignerEmailNotifications. # noqa: E501
def
to_dict(self)
483 def to_dict(self): 484 """Returns the model properties as a dict""" 485 result = {} 486 487 for attr, _ in six.iteritems(self.swagger_types): 488 value = getattr(self, attr) 489 if isinstance(value, list): 490 result[attr] = list(map( 491 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 492 value 493 )) 494 elif hasattr(value, "to_dict"): 495 result[attr] = value.to_dict() 496 elif isinstance(value, dict): 497 result[attr] = dict(map( 498 lambda item: (item[0], item[1].to_dict()) 499 if hasattr(item[1], "to_dict") else item, 500 value.items() 501 )) 502 else: 503 result[attr] = value 504 if issubclass(SignerEmailNotifications, dict): 505 for key, value in self.items(): 506 result[key] = value 507 508 return result
Returns the model properties as a dict