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