docusign_esign.models.template_recipients
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 TemplateRecipients(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 'agents': 'list[Agent]', 37 'carbon_copies': 'list[CarbonCopy]', 38 'certified_deliveries': 'list[CertifiedDelivery]', 39 'current_routing_order': 'str', 40 'editors': 'list[Editor]', 41 'error_details': 'ErrorDetails', 42 'in_person_signers': 'list[InPersonSigner]', 43 'intermediaries': 'list[Intermediary]', 44 'notaries': 'list[NotaryRecipient]', 45 'notary_witnesses': 'list[NotaryWitness]', 46 'participants': 'list[Participant]', 47 'recipient_count': 'str', 48 'seals': 'list[SealSign]', 49 'signers': 'list[Signer]', 50 'witnesses': 'list[Witness]' 51 } 52 53 attribute_map = { 54 'agents': 'agents', 55 'carbon_copies': 'carbonCopies', 56 'certified_deliveries': 'certifiedDeliveries', 57 'current_routing_order': 'currentRoutingOrder', 58 'editors': 'editors', 59 'error_details': 'errorDetails', 60 'in_person_signers': 'inPersonSigners', 61 'intermediaries': 'intermediaries', 62 'notaries': 'notaries', 63 'notary_witnesses': 'notaryWitnesses', 64 'participants': 'participants', 65 'recipient_count': 'recipientCount', 66 'seals': 'seals', 67 'signers': 'signers', 68 'witnesses': 'witnesses' 69 } 70 71 def __init__(self, _configuration=None, **kwargs): # noqa: E501 72 """TemplateRecipients - a model defined in Swagger""" # noqa: E501 73 if _configuration is None: 74 _configuration = Configuration() 75 self._configuration = _configuration 76 77 self._agents = None 78 self._carbon_copies = None 79 self._certified_deliveries = None 80 self._current_routing_order = None 81 self._editors = None 82 self._error_details = None 83 self._in_person_signers = None 84 self._intermediaries = None 85 self._notaries = None 86 self._notary_witnesses = None 87 self._participants = None 88 self._recipient_count = None 89 self._seals = None 90 self._signers = None 91 self._witnesses = None 92 self.discriminator = None 93 94 setattr(self, "_{}".format('agents'), kwargs.get('agents', None)) 95 setattr(self, "_{}".format('carbon_copies'), kwargs.get('carbon_copies', None)) 96 setattr(self, "_{}".format('certified_deliveries'), kwargs.get('certified_deliveries', None)) 97 setattr(self, "_{}".format('current_routing_order'), kwargs.get('current_routing_order', None)) 98 setattr(self, "_{}".format('editors'), kwargs.get('editors', None)) 99 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 100 setattr(self, "_{}".format('in_person_signers'), kwargs.get('in_person_signers', None)) 101 setattr(self, "_{}".format('intermediaries'), kwargs.get('intermediaries', None)) 102 setattr(self, "_{}".format('notaries'), kwargs.get('notaries', None)) 103 setattr(self, "_{}".format('notary_witnesses'), kwargs.get('notary_witnesses', None)) 104 setattr(self, "_{}".format('participants'), kwargs.get('participants', None)) 105 setattr(self, "_{}".format('recipient_count'), kwargs.get('recipient_count', None)) 106 setattr(self, "_{}".format('seals'), kwargs.get('seals', None)) 107 setattr(self, "_{}".format('signers'), kwargs.get('signers', None)) 108 setattr(self, "_{}".format('witnesses'), kwargs.get('witnesses', None)) 109 110 @property 111 def agents(self): 112 """Gets the agents of this TemplateRecipients. # noqa: E501 113 114 A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. # noqa: E501 115 116 :return: The agents of this TemplateRecipients. # noqa: E501 117 :rtype: list[Agent] 118 """ 119 return self._agents 120 121 @agents.setter 122 def agents(self, agents): 123 """Sets the agents of this TemplateRecipients. 124 125 A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. # noqa: E501 126 127 :param agents: The agents of this TemplateRecipients. # noqa: E501 128 :type: list[Agent] 129 """ 130 131 self._agents = agents 132 133 @property 134 def carbon_copies(self): 135 """Gets the carbon_copies of this TemplateRecipients. # noqa: E501 136 137 A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. # noqa: E501 138 139 :return: The carbon_copies of this TemplateRecipients. # noqa: E501 140 :rtype: list[CarbonCopy] 141 """ 142 return self._carbon_copies 143 144 @carbon_copies.setter 145 def carbon_copies(self, carbon_copies): 146 """Sets the carbon_copies of this TemplateRecipients. 147 148 A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. # noqa: E501 149 150 :param carbon_copies: The carbon_copies of this TemplateRecipients. # noqa: E501 151 :type: list[CarbonCopy] 152 """ 153 154 self._carbon_copies = carbon_copies 155 156 @property 157 def certified_deliveries(self): 158 """Gets the certified_deliveries of this TemplateRecipients. # noqa: E501 159 160 A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. # noqa: E501 161 162 :return: The certified_deliveries of this TemplateRecipients. # noqa: E501 163 :rtype: list[CertifiedDelivery] 164 """ 165 return self._certified_deliveries 166 167 @certified_deliveries.setter 168 def certified_deliveries(self, certified_deliveries): 169 """Sets the certified_deliveries of this TemplateRecipients. 170 171 A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. # noqa: E501 172 173 :param certified_deliveries: The certified_deliveries of this TemplateRecipients. # noqa: E501 174 :type: list[CertifiedDelivery] 175 """ 176 177 self._certified_deliveries = certified_deliveries 178 179 @property 180 def current_routing_order(self): 181 """Gets the current_routing_order of this TemplateRecipients. # noqa: E501 182 183 # noqa: E501 184 185 :return: The current_routing_order of this TemplateRecipients. # noqa: E501 186 :rtype: str 187 """ 188 return self._current_routing_order 189 190 @current_routing_order.setter 191 def current_routing_order(self, current_routing_order): 192 """Sets the current_routing_order of this TemplateRecipients. 193 194 # noqa: E501 195 196 :param current_routing_order: The current_routing_order of this TemplateRecipients. # noqa: E501 197 :type: str 198 """ 199 200 self._current_routing_order = current_routing_order 201 202 @property 203 def editors(self): 204 """Gets the editors of this TemplateRecipients. # noqa: E501 205 206 # noqa: E501 207 208 :return: The editors of this TemplateRecipients. # noqa: E501 209 :rtype: list[Editor] 210 """ 211 return self._editors 212 213 @editors.setter 214 def editors(self, editors): 215 """Sets the editors of this TemplateRecipients. 216 217 # noqa: E501 218 219 :param editors: The editors of this TemplateRecipients. # noqa: E501 220 :type: list[Editor] 221 """ 222 223 self._editors = editors 224 225 @property 226 def error_details(self): 227 """Gets the error_details of this TemplateRecipients. # noqa: E501 228 229 Array or errors. # noqa: E501 230 231 :return: The error_details of this TemplateRecipients. # noqa: E501 232 :rtype: ErrorDetails 233 """ 234 return self._error_details 235 236 @error_details.setter 237 def error_details(self, error_details): 238 """Sets the error_details of this TemplateRecipients. 239 240 Array or errors. # noqa: E501 241 242 :param error_details: The error_details of this TemplateRecipients. # noqa: E501 243 :type: ErrorDetails 244 """ 245 246 self._error_details = error_details 247 248 @property 249 def in_person_signers(self): 250 """Gets the in_person_signers of this TemplateRecipients. # noqa: E501 251 252 Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. # noqa: E501 253 254 :return: The in_person_signers of this TemplateRecipients. # noqa: E501 255 :rtype: list[InPersonSigner] 256 """ 257 return self._in_person_signers 258 259 @in_person_signers.setter 260 def in_person_signers(self, in_person_signers): 261 """Sets the in_person_signers of this TemplateRecipients. 262 263 Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. # noqa: E501 264 265 :param in_person_signers: The in_person_signers of this TemplateRecipients. # noqa: E501 266 :type: list[InPersonSigner] 267 """ 268 269 self._in_person_signers = in_person_signers 270 271 @property 272 def intermediaries(self): 273 """Gets the intermediaries of this TemplateRecipients. # noqa: E501 274 275 Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). # noqa: E501 276 277 :return: The intermediaries of this TemplateRecipients. # noqa: E501 278 :rtype: list[Intermediary] 279 """ 280 return self._intermediaries 281 282 @intermediaries.setter 283 def intermediaries(self, intermediaries): 284 """Sets the intermediaries of this TemplateRecipients. 285 286 Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). # noqa: E501 287 288 :param intermediaries: The intermediaries of this TemplateRecipients. # noqa: E501 289 :type: list[Intermediary] 290 """ 291 292 self._intermediaries = intermediaries 293 294 @property 295 def notaries(self): 296 """Gets the notaries of this TemplateRecipients. # noqa: E501 297 298 # noqa: E501 299 300 :return: The notaries of this TemplateRecipients. # noqa: E501 301 :rtype: list[NotaryRecipient] 302 """ 303 return self._notaries 304 305 @notaries.setter 306 def notaries(self, notaries): 307 """Sets the notaries of this TemplateRecipients. 308 309 # noqa: E501 310 311 :param notaries: The notaries of this TemplateRecipients. # noqa: E501 312 :type: list[NotaryRecipient] 313 """ 314 315 self._notaries = notaries 316 317 @property 318 def notary_witnesses(self): 319 """Gets the notary_witnesses of this TemplateRecipients. # noqa: E501 320 321 # noqa: E501 322 323 :return: The notary_witnesses of this TemplateRecipients. # noqa: E501 324 :rtype: list[NotaryWitness] 325 """ 326 return self._notary_witnesses 327 328 @notary_witnesses.setter 329 def notary_witnesses(self, notary_witnesses): 330 """Sets the notary_witnesses of this TemplateRecipients. 331 332 # noqa: E501 333 334 :param notary_witnesses: The notary_witnesses of this TemplateRecipients. # noqa: E501 335 :type: list[NotaryWitness] 336 """ 337 338 self._notary_witnesses = notary_witnesses 339 340 @property 341 def participants(self): 342 """Gets the participants of this TemplateRecipients. # noqa: E501 343 344 # noqa: E501 345 346 :return: The participants of this TemplateRecipients. # noqa: E501 347 :rtype: list[Participant] 348 """ 349 return self._participants 350 351 @participants.setter 352 def participants(self, participants): 353 """Sets the participants of this TemplateRecipients. 354 355 # noqa: E501 356 357 :param participants: The participants of this TemplateRecipients. # noqa: E501 358 :type: list[Participant] 359 """ 360 361 self._participants = participants 362 363 @property 364 def recipient_count(self): 365 """Gets the recipient_count of this TemplateRecipients. # noqa: E501 366 367 The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. # noqa: E501 368 369 :return: The recipient_count of this TemplateRecipients. # noqa: E501 370 :rtype: str 371 """ 372 return self._recipient_count 373 374 @recipient_count.setter 375 def recipient_count(self, recipient_count): 376 """Sets the recipient_count of this TemplateRecipients. 377 378 The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. # noqa: E501 379 380 :param recipient_count: The recipient_count of this TemplateRecipients. # noqa: E501 381 :type: str 382 """ 383 384 self._recipient_count = recipient_count 385 386 @property 387 def seals(self): 388 """Gets the seals of this TemplateRecipients. # noqa: E501 389 390 # noqa: E501 391 392 :return: The seals of this TemplateRecipients. # noqa: E501 393 :rtype: list[SealSign] 394 """ 395 return self._seals 396 397 @seals.setter 398 def seals(self, seals): 399 """Sets the seals of this TemplateRecipients. 400 401 # noqa: E501 402 403 :param seals: The seals of this TemplateRecipients. # noqa: E501 404 :type: list[SealSign] 405 """ 406 407 self._seals = seals 408 409 @property 410 def signers(self): 411 """Gets the signers of this TemplateRecipients. # noqa: E501 412 413 A complex type containing information about the Signer recipient. # noqa: E501 414 415 :return: The signers of this TemplateRecipients. # noqa: E501 416 :rtype: list[Signer] 417 """ 418 return self._signers 419 420 @signers.setter 421 def signers(self, signers): 422 """Sets the signers of this TemplateRecipients. 423 424 A complex type containing information about the Signer recipient. # noqa: E501 425 426 :param signers: The signers of this TemplateRecipients. # noqa: E501 427 :type: list[Signer] 428 """ 429 430 self._signers = signers 431 432 @property 433 def witnesses(self): 434 """Gets the witnesses of this TemplateRecipients. # noqa: E501 435 436 # noqa: E501 437 438 :return: The witnesses of this TemplateRecipients. # noqa: E501 439 :rtype: list[Witness] 440 """ 441 return self._witnesses 442 443 @witnesses.setter 444 def witnesses(self, witnesses): 445 """Sets the witnesses of this TemplateRecipients. 446 447 # noqa: E501 448 449 :param witnesses: The witnesses of this TemplateRecipients. # noqa: E501 450 :type: list[Witness] 451 """ 452 453 self._witnesses = witnesses 454 455 def to_dict(self): 456 """Returns the model properties as a dict""" 457 result = {} 458 459 for attr, _ in six.iteritems(self.swagger_types): 460 value = getattr(self, attr) 461 if isinstance(value, list): 462 result[attr] = list(map( 463 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 464 value 465 )) 466 elif hasattr(value, "to_dict"): 467 result[attr] = value.to_dict() 468 elif isinstance(value, dict): 469 result[attr] = dict(map( 470 lambda item: (item[0], item[1].to_dict()) 471 if hasattr(item[1], "to_dict") else item, 472 value.items() 473 )) 474 else: 475 result[attr] = value 476 if issubclass(TemplateRecipients, dict): 477 for key, value in self.items(): 478 result[key] = value 479 480 return result 481 482 def to_str(self): 483 """Returns the string representation of the model""" 484 return pprint.pformat(self.to_dict()) 485 486 def __repr__(self): 487 """For `print` and `pprint`""" 488 return self.to_str() 489 490 def __eq__(self, other): 491 """Returns true if both objects are equal""" 492 if not isinstance(other, TemplateRecipients): 493 return False 494 495 return self.to_dict() == other.to_dict() 496 497 def __ne__(self, other): 498 """Returns true if both objects are not equal""" 499 if not isinstance(other, TemplateRecipients): 500 return True 501 502 return self.to_dict() != other.to_dict()
class
TemplateRecipients:
23class TemplateRecipients(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 'agents': 'list[Agent]', 38 'carbon_copies': 'list[CarbonCopy]', 39 'certified_deliveries': 'list[CertifiedDelivery]', 40 'current_routing_order': 'str', 41 'editors': 'list[Editor]', 42 'error_details': 'ErrorDetails', 43 'in_person_signers': 'list[InPersonSigner]', 44 'intermediaries': 'list[Intermediary]', 45 'notaries': 'list[NotaryRecipient]', 46 'notary_witnesses': 'list[NotaryWitness]', 47 'participants': 'list[Participant]', 48 'recipient_count': 'str', 49 'seals': 'list[SealSign]', 50 'signers': 'list[Signer]', 51 'witnesses': 'list[Witness]' 52 } 53 54 attribute_map = { 55 'agents': 'agents', 56 'carbon_copies': 'carbonCopies', 57 'certified_deliveries': 'certifiedDeliveries', 58 'current_routing_order': 'currentRoutingOrder', 59 'editors': 'editors', 60 'error_details': 'errorDetails', 61 'in_person_signers': 'inPersonSigners', 62 'intermediaries': 'intermediaries', 63 'notaries': 'notaries', 64 'notary_witnesses': 'notaryWitnesses', 65 'participants': 'participants', 66 'recipient_count': 'recipientCount', 67 'seals': 'seals', 68 'signers': 'signers', 69 'witnesses': 'witnesses' 70 } 71 72 def __init__(self, _configuration=None, **kwargs): # noqa: E501 73 """TemplateRecipients - a model defined in Swagger""" # noqa: E501 74 if _configuration is None: 75 _configuration = Configuration() 76 self._configuration = _configuration 77 78 self._agents = None 79 self._carbon_copies = None 80 self._certified_deliveries = None 81 self._current_routing_order = None 82 self._editors = None 83 self._error_details = None 84 self._in_person_signers = None 85 self._intermediaries = None 86 self._notaries = None 87 self._notary_witnesses = None 88 self._participants = None 89 self._recipient_count = None 90 self._seals = None 91 self._signers = None 92 self._witnesses = None 93 self.discriminator = None 94 95 setattr(self, "_{}".format('agents'), kwargs.get('agents', None)) 96 setattr(self, "_{}".format('carbon_copies'), kwargs.get('carbon_copies', None)) 97 setattr(self, "_{}".format('certified_deliveries'), kwargs.get('certified_deliveries', None)) 98 setattr(self, "_{}".format('current_routing_order'), kwargs.get('current_routing_order', None)) 99 setattr(self, "_{}".format('editors'), kwargs.get('editors', None)) 100 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 101 setattr(self, "_{}".format('in_person_signers'), kwargs.get('in_person_signers', None)) 102 setattr(self, "_{}".format('intermediaries'), kwargs.get('intermediaries', None)) 103 setattr(self, "_{}".format('notaries'), kwargs.get('notaries', None)) 104 setattr(self, "_{}".format('notary_witnesses'), kwargs.get('notary_witnesses', None)) 105 setattr(self, "_{}".format('participants'), kwargs.get('participants', None)) 106 setattr(self, "_{}".format('recipient_count'), kwargs.get('recipient_count', None)) 107 setattr(self, "_{}".format('seals'), kwargs.get('seals', None)) 108 setattr(self, "_{}".format('signers'), kwargs.get('signers', None)) 109 setattr(self, "_{}".format('witnesses'), kwargs.get('witnesses', None)) 110 111 @property 112 def agents(self): 113 """Gets the agents of this TemplateRecipients. # noqa: E501 114 115 A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. # noqa: E501 116 117 :return: The agents of this TemplateRecipients. # noqa: E501 118 :rtype: list[Agent] 119 """ 120 return self._agents 121 122 @agents.setter 123 def agents(self, agents): 124 """Sets the agents of this TemplateRecipients. 125 126 A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. # noqa: E501 127 128 :param agents: The agents of this TemplateRecipients. # noqa: E501 129 :type: list[Agent] 130 """ 131 132 self._agents = agents 133 134 @property 135 def carbon_copies(self): 136 """Gets the carbon_copies of this TemplateRecipients. # noqa: E501 137 138 A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. # noqa: E501 139 140 :return: The carbon_copies of this TemplateRecipients. # noqa: E501 141 :rtype: list[CarbonCopy] 142 """ 143 return self._carbon_copies 144 145 @carbon_copies.setter 146 def carbon_copies(self, carbon_copies): 147 """Sets the carbon_copies of this TemplateRecipients. 148 149 A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. # noqa: E501 150 151 :param carbon_copies: The carbon_copies of this TemplateRecipients. # noqa: E501 152 :type: list[CarbonCopy] 153 """ 154 155 self._carbon_copies = carbon_copies 156 157 @property 158 def certified_deliveries(self): 159 """Gets the certified_deliveries of this TemplateRecipients. # noqa: E501 160 161 A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. # noqa: E501 162 163 :return: The certified_deliveries of this TemplateRecipients. # noqa: E501 164 :rtype: list[CertifiedDelivery] 165 """ 166 return self._certified_deliveries 167 168 @certified_deliveries.setter 169 def certified_deliveries(self, certified_deliveries): 170 """Sets the certified_deliveries of this TemplateRecipients. 171 172 A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. # noqa: E501 173 174 :param certified_deliveries: The certified_deliveries of this TemplateRecipients. # noqa: E501 175 :type: list[CertifiedDelivery] 176 """ 177 178 self._certified_deliveries = certified_deliveries 179 180 @property 181 def current_routing_order(self): 182 """Gets the current_routing_order of this TemplateRecipients. # noqa: E501 183 184 # noqa: E501 185 186 :return: The current_routing_order of this TemplateRecipients. # noqa: E501 187 :rtype: str 188 """ 189 return self._current_routing_order 190 191 @current_routing_order.setter 192 def current_routing_order(self, current_routing_order): 193 """Sets the current_routing_order of this TemplateRecipients. 194 195 # noqa: E501 196 197 :param current_routing_order: The current_routing_order of this TemplateRecipients. # noqa: E501 198 :type: str 199 """ 200 201 self._current_routing_order = current_routing_order 202 203 @property 204 def editors(self): 205 """Gets the editors of this TemplateRecipients. # noqa: E501 206 207 # noqa: E501 208 209 :return: The editors of this TemplateRecipients. # noqa: E501 210 :rtype: list[Editor] 211 """ 212 return self._editors 213 214 @editors.setter 215 def editors(self, editors): 216 """Sets the editors of this TemplateRecipients. 217 218 # noqa: E501 219 220 :param editors: The editors of this TemplateRecipients. # noqa: E501 221 :type: list[Editor] 222 """ 223 224 self._editors = editors 225 226 @property 227 def error_details(self): 228 """Gets the error_details of this TemplateRecipients. # noqa: E501 229 230 Array or errors. # noqa: E501 231 232 :return: The error_details of this TemplateRecipients. # noqa: E501 233 :rtype: ErrorDetails 234 """ 235 return self._error_details 236 237 @error_details.setter 238 def error_details(self, error_details): 239 """Sets the error_details of this TemplateRecipients. 240 241 Array or errors. # noqa: E501 242 243 :param error_details: The error_details of this TemplateRecipients. # noqa: E501 244 :type: ErrorDetails 245 """ 246 247 self._error_details = error_details 248 249 @property 250 def in_person_signers(self): 251 """Gets the in_person_signers of this TemplateRecipients. # noqa: E501 252 253 Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. # noqa: E501 254 255 :return: The in_person_signers of this TemplateRecipients. # noqa: E501 256 :rtype: list[InPersonSigner] 257 """ 258 return self._in_person_signers 259 260 @in_person_signers.setter 261 def in_person_signers(self, in_person_signers): 262 """Sets the in_person_signers of this TemplateRecipients. 263 264 Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. # noqa: E501 265 266 :param in_person_signers: The in_person_signers of this TemplateRecipients. # noqa: E501 267 :type: list[InPersonSigner] 268 """ 269 270 self._in_person_signers = in_person_signers 271 272 @property 273 def intermediaries(self): 274 """Gets the intermediaries of this TemplateRecipients. # noqa: E501 275 276 Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). # noqa: E501 277 278 :return: The intermediaries of this TemplateRecipients. # noqa: E501 279 :rtype: list[Intermediary] 280 """ 281 return self._intermediaries 282 283 @intermediaries.setter 284 def intermediaries(self, intermediaries): 285 """Sets the intermediaries of this TemplateRecipients. 286 287 Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). # noqa: E501 288 289 :param intermediaries: The intermediaries of this TemplateRecipients. # noqa: E501 290 :type: list[Intermediary] 291 """ 292 293 self._intermediaries = intermediaries 294 295 @property 296 def notaries(self): 297 """Gets the notaries of this TemplateRecipients. # noqa: E501 298 299 # noqa: E501 300 301 :return: The notaries of this TemplateRecipients. # noqa: E501 302 :rtype: list[NotaryRecipient] 303 """ 304 return self._notaries 305 306 @notaries.setter 307 def notaries(self, notaries): 308 """Sets the notaries of this TemplateRecipients. 309 310 # noqa: E501 311 312 :param notaries: The notaries of this TemplateRecipients. # noqa: E501 313 :type: list[NotaryRecipient] 314 """ 315 316 self._notaries = notaries 317 318 @property 319 def notary_witnesses(self): 320 """Gets the notary_witnesses of this TemplateRecipients. # noqa: E501 321 322 # noqa: E501 323 324 :return: The notary_witnesses of this TemplateRecipients. # noqa: E501 325 :rtype: list[NotaryWitness] 326 """ 327 return self._notary_witnesses 328 329 @notary_witnesses.setter 330 def notary_witnesses(self, notary_witnesses): 331 """Sets the notary_witnesses of this TemplateRecipients. 332 333 # noqa: E501 334 335 :param notary_witnesses: The notary_witnesses of this TemplateRecipients. # noqa: E501 336 :type: list[NotaryWitness] 337 """ 338 339 self._notary_witnesses = notary_witnesses 340 341 @property 342 def participants(self): 343 """Gets the participants of this TemplateRecipients. # noqa: E501 344 345 # noqa: E501 346 347 :return: The participants of this TemplateRecipients. # noqa: E501 348 :rtype: list[Participant] 349 """ 350 return self._participants 351 352 @participants.setter 353 def participants(self, participants): 354 """Sets the participants of this TemplateRecipients. 355 356 # noqa: E501 357 358 :param participants: The participants of this TemplateRecipients. # noqa: E501 359 :type: list[Participant] 360 """ 361 362 self._participants = participants 363 364 @property 365 def recipient_count(self): 366 """Gets the recipient_count of this TemplateRecipients. # noqa: E501 367 368 The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. # noqa: E501 369 370 :return: The recipient_count of this TemplateRecipients. # noqa: E501 371 :rtype: str 372 """ 373 return self._recipient_count 374 375 @recipient_count.setter 376 def recipient_count(self, recipient_count): 377 """Sets the recipient_count of this TemplateRecipients. 378 379 The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. # noqa: E501 380 381 :param recipient_count: The recipient_count of this TemplateRecipients. # noqa: E501 382 :type: str 383 """ 384 385 self._recipient_count = recipient_count 386 387 @property 388 def seals(self): 389 """Gets the seals of this TemplateRecipients. # noqa: E501 390 391 # noqa: E501 392 393 :return: The seals of this TemplateRecipients. # noqa: E501 394 :rtype: list[SealSign] 395 """ 396 return self._seals 397 398 @seals.setter 399 def seals(self, seals): 400 """Sets the seals of this TemplateRecipients. 401 402 # noqa: E501 403 404 :param seals: The seals of this TemplateRecipients. # noqa: E501 405 :type: list[SealSign] 406 """ 407 408 self._seals = seals 409 410 @property 411 def signers(self): 412 """Gets the signers of this TemplateRecipients. # noqa: E501 413 414 A complex type containing information about the Signer recipient. # noqa: E501 415 416 :return: The signers of this TemplateRecipients. # noqa: E501 417 :rtype: list[Signer] 418 """ 419 return self._signers 420 421 @signers.setter 422 def signers(self, signers): 423 """Sets the signers of this TemplateRecipients. 424 425 A complex type containing information about the Signer recipient. # noqa: E501 426 427 :param signers: The signers of this TemplateRecipients. # noqa: E501 428 :type: list[Signer] 429 """ 430 431 self._signers = signers 432 433 @property 434 def witnesses(self): 435 """Gets the witnesses of this TemplateRecipients. # noqa: E501 436 437 # noqa: E501 438 439 :return: The witnesses of this TemplateRecipients. # noqa: E501 440 :rtype: list[Witness] 441 """ 442 return self._witnesses 443 444 @witnesses.setter 445 def witnesses(self, witnesses): 446 """Sets the witnesses of this TemplateRecipients. 447 448 # noqa: E501 449 450 :param witnesses: The witnesses of this TemplateRecipients. # noqa: E501 451 :type: list[Witness] 452 """ 453 454 self._witnesses = witnesses 455 456 def to_dict(self): 457 """Returns the model properties as a dict""" 458 result = {} 459 460 for attr, _ in six.iteritems(self.swagger_types): 461 value = getattr(self, attr) 462 if isinstance(value, list): 463 result[attr] = list(map( 464 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 465 value 466 )) 467 elif hasattr(value, "to_dict"): 468 result[attr] = value.to_dict() 469 elif isinstance(value, dict): 470 result[attr] = dict(map( 471 lambda item: (item[0], item[1].to_dict()) 472 if hasattr(item[1], "to_dict") else item, 473 value.items() 474 )) 475 else: 476 result[attr] = value 477 if issubclass(TemplateRecipients, dict): 478 for key, value in self.items(): 479 result[key] = value 480 481 return result 482 483 def to_str(self): 484 """Returns the string representation of the model""" 485 return pprint.pformat(self.to_dict()) 486 487 def __repr__(self): 488 """For `print` and `pprint`""" 489 return self.to_str() 490 491 def __eq__(self, other): 492 """Returns true if both objects are equal""" 493 if not isinstance(other, TemplateRecipients): 494 return False 495 496 return self.to_dict() == other.to_dict() 497 498 def __ne__(self, other): 499 """Returns true if both objects are not equal""" 500 if not isinstance(other, TemplateRecipients): 501 return True 502 503 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.
TemplateRecipients(_configuration=None, **kwargs)
72 def __init__(self, _configuration=None, **kwargs): # noqa: E501 73 """TemplateRecipients - a model defined in Swagger""" # noqa: E501 74 if _configuration is None: 75 _configuration = Configuration() 76 self._configuration = _configuration 77 78 self._agents = None 79 self._carbon_copies = None 80 self._certified_deliveries = None 81 self._current_routing_order = None 82 self._editors = None 83 self._error_details = None 84 self._in_person_signers = None 85 self._intermediaries = None 86 self._notaries = None 87 self._notary_witnesses = None 88 self._participants = None 89 self._recipient_count = None 90 self._seals = None 91 self._signers = None 92 self._witnesses = None 93 self.discriminator = None 94 95 setattr(self, "_{}".format('agents'), kwargs.get('agents', None)) 96 setattr(self, "_{}".format('carbon_copies'), kwargs.get('carbon_copies', None)) 97 setattr(self, "_{}".format('certified_deliveries'), kwargs.get('certified_deliveries', None)) 98 setattr(self, "_{}".format('current_routing_order'), kwargs.get('current_routing_order', None)) 99 setattr(self, "_{}".format('editors'), kwargs.get('editors', None)) 100 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 101 setattr(self, "_{}".format('in_person_signers'), kwargs.get('in_person_signers', None)) 102 setattr(self, "_{}".format('intermediaries'), kwargs.get('intermediaries', None)) 103 setattr(self, "_{}".format('notaries'), kwargs.get('notaries', None)) 104 setattr(self, "_{}".format('notary_witnesses'), kwargs.get('notary_witnesses', None)) 105 setattr(self, "_{}".format('participants'), kwargs.get('participants', None)) 106 setattr(self, "_{}".format('recipient_count'), kwargs.get('recipient_count', None)) 107 setattr(self, "_{}".format('seals'), kwargs.get('seals', None)) 108 setattr(self, "_{}".format('signers'), kwargs.get('signers', None)) 109 setattr(self, "_{}".format('witnesses'), kwargs.get('witnesses', None))
TemplateRecipients - a model defined in Swagger
swagger_types = {'agents': 'list[Agent]', 'carbon_copies': 'list[CarbonCopy]', 'certified_deliveries': 'list[CertifiedDelivery]', 'current_routing_order': 'str', 'editors': 'list[Editor]', 'error_details': 'ErrorDetails', 'in_person_signers': 'list[InPersonSigner]', 'intermediaries': 'list[Intermediary]', 'notaries': 'list[NotaryRecipient]', 'notary_witnesses': 'list[NotaryWitness]', 'participants': 'list[Participant]', 'recipient_count': 'str', 'seals': 'list[SealSign]', 'signers': 'list[Signer]', 'witnesses': 'list[Witness]'}
attribute_map = {'agents': 'agents', 'carbon_copies': 'carbonCopies', 'certified_deliveries': 'certifiedDeliveries', 'current_routing_order': 'currentRoutingOrder', 'editors': 'editors', 'error_details': 'errorDetails', 'in_person_signers': 'inPersonSigners', 'intermediaries': 'intermediaries', 'notaries': 'notaries', 'notary_witnesses': 'notaryWitnesses', 'participants': 'participants', 'recipient_count': 'recipientCount', 'seals': 'seals', 'signers': 'signers', 'witnesses': 'witnesses'}
agents
Gets the agents of this TemplateRecipients. # noqa: E501
A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. # noqa: E501
Returns
The agents of this TemplateRecipients. # noqa: E501
carbon_copies
Gets the carbon_copies of this TemplateRecipients. # noqa: E501
A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. # noqa: E501
Returns
The carbon_copies of this TemplateRecipients. # noqa: E501
certified_deliveries
Gets the certified_deliveries of this TemplateRecipients. # noqa: E501
A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. # noqa: E501
Returns
The certified_deliveries of this TemplateRecipients. # noqa: E501
current_routing_order
Gets the current_routing_order of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The current_routing_order of this TemplateRecipients. # noqa: E501
editors
Gets the editors of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The editors of this TemplateRecipients. # noqa: E501
error_details
Gets the error_details of this TemplateRecipients. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this TemplateRecipients. # noqa: E501
in_person_signers
Gets the in_person_signers of this TemplateRecipients. # noqa: E501
Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. # noqa: E501
Returns
The in_person_signers of this TemplateRecipients. # noqa: E501
intermediaries
Gets the intermediaries of this TemplateRecipients. # noqa: E501
Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). # noqa: E501
Returns
The intermediaries of this TemplateRecipients. # noqa: E501
notaries
Gets the notaries of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The notaries of this TemplateRecipients. # noqa: E501
notary_witnesses
Gets the notary_witnesses of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The notary_witnesses of this TemplateRecipients. # noqa: E501
participants
Gets the participants of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The participants of this TemplateRecipients. # noqa: E501
recipient_count
Gets the recipient_count of this TemplateRecipients. # noqa: E501
The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to true, the envelope time zone information is included in the message. # noqa: E501
Returns
The recipient_count of this TemplateRecipients. # noqa: E501
seals
Gets the seals of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The seals of this TemplateRecipients. # noqa: E501
signers
Gets the signers of this TemplateRecipients. # noqa: E501
A complex type containing information about the Signer recipient. # noqa: E501
Returns
The signers of this TemplateRecipients. # noqa: E501
witnesses
Gets the witnesses of this TemplateRecipients. # noqa: E501
# noqa: E501
Returns
The witnesses of this TemplateRecipients. # noqa: E501
def
to_dict(self)
456 def to_dict(self): 457 """Returns the model properties as a dict""" 458 result = {} 459 460 for attr, _ in six.iteritems(self.swagger_types): 461 value = getattr(self, attr) 462 if isinstance(value, list): 463 result[attr] = list(map( 464 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 465 value 466 )) 467 elif hasattr(value, "to_dict"): 468 result[attr] = value.to_dict() 469 elif isinstance(value, dict): 470 result[attr] = dict(map( 471 lambda item: (item[0], item[1].to_dict()) 472 if hasattr(item[1], "to_dict") else item, 473 value.items() 474 )) 475 else: 476 result[attr] = value 477 if issubclass(TemplateRecipients, dict): 478 for key, value in self.items(): 479 result[key] = value 480 481 return result
Returns the model properties as a dict