docusign_esign.models.power_form_recipient
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 PowerFormRecipient(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 'access_code': 'str', 37 'access_code_locked': 'str', 38 'access_code_required': 'str', 39 'email': 'str', 40 'email_locked': 'str', 41 'id_check_configuration_name': 'str', 42 'id_check_required': 'str', 43 'name': 'str', 44 'recipient_type': 'str', 45 'role_name': 'str', 46 'routing_order': 'str', 47 'template_requires_id_lookup': 'str', 48 'user_name_locked': 'str' 49 } 50 51 attribute_map = { 52 'access_code': 'accessCode', 53 'access_code_locked': 'accessCodeLocked', 54 'access_code_required': 'accessCodeRequired', 55 'email': 'email', 56 'email_locked': 'emailLocked', 57 'id_check_configuration_name': 'idCheckConfigurationName', 58 'id_check_required': 'idCheckRequired', 59 'name': 'name', 60 'recipient_type': 'recipientType', 61 'role_name': 'roleName', 62 'routing_order': 'routingOrder', 63 'template_requires_id_lookup': 'templateRequiresIdLookup', 64 'user_name_locked': 'userNameLocked' 65 } 66 67 def __init__(self, _configuration=None, **kwargs): # noqa: E501 68 """PowerFormRecipient - a model defined in Swagger""" # noqa: E501 69 if _configuration is None: 70 _configuration = Configuration() 71 self._configuration = _configuration 72 73 self._access_code = None 74 self._access_code_locked = None 75 self._access_code_required = None 76 self._email = None 77 self._email_locked = None 78 self._id_check_configuration_name = None 79 self._id_check_required = None 80 self._name = None 81 self._recipient_type = None 82 self._role_name = None 83 self._routing_order = None 84 self._template_requires_id_lookup = None 85 self._user_name_locked = None 86 self.discriminator = None 87 88 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 89 setattr(self, "_{}".format('access_code_locked'), kwargs.get('access_code_locked', None)) 90 setattr(self, "_{}".format('access_code_required'), kwargs.get('access_code_required', None)) 91 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 92 setattr(self, "_{}".format('email_locked'), kwargs.get('email_locked', None)) 93 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 94 setattr(self, "_{}".format('id_check_required'), kwargs.get('id_check_required', None)) 95 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 96 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 97 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 98 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 99 setattr(self, "_{}".format('template_requires_id_lookup'), kwargs.get('template_requires_id_lookup', None)) 100 setattr(self, "_{}".format('user_name_locked'), kwargs.get('user_name_locked', None)) 101 102 @property 103 def access_code(self): 104 """Gets the access_code of this PowerFormRecipient. # noqa: E501 105 106 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 107 108 :return: The access_code of this PowerFormRecipient. # noqa: E501 109 :rtype: str 110 """ 111 return self._access_code 112 113 @access_code.setter 114 def access_code(self, access_code): 115 """Sets the access_code of this PowerFormRecipient. 116 117 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 118 119 :param access_code: The access_code of this PowerFormRecipient. # noqa: E501 120 :type: str 121 """ 122 123 self._access_code = access_code 124 125 @property 126 def access_code_locked(self): 127 """Gets the access_code_locked of this PowerFormRecipient. # noqa: E501 128 129 # noqa: E501 130 131 :return: The access_code_locked of this PowerFormRecipient. # noqa: E501 132 :rtype: str 133 """ 134 return self._access_code_locked 135 136 @access_code_locked.setter 137 def access_code_locked(self, access_code_locked): 138 """Sets the access_code_locked of this PowerFormRecipient. 139 140 # noqa: E501 141 142 :param access_code_locked: The access_code_locked of this PowerFormRecipient. # noqa: E501 143 :type: str 144 """ 145 146 self._access_code_locked = access_code_locked 147 148 @property 149 def access_code_required(self): 150 """Gets the access_code_required of this PowerFormRecipient. # noqa: E501 151 152 # noqa: E501 153 154 :return: The access_code_required of this PowerFormRecipient. # noqa: E501 155 :rtype: str 156 """ 157 return self._access_code_required 158 159 @access_code_required.setter 160 def access_code_required(self, access_code_required): 161 """Sets the access_code_required of this PowerFormRecipient. 162 163 # noqa: E501 164 165 :param access_code_required: The access_code_required of this PowerFormRecipient. # noqa: E501 166 :type: str 167 """ 168 169 self._access_code_required = access_code_required 170 171 @property 172 def email(self): 173 """Gets the email of this PowerFormRecipient. # noqa: E501 174 175 # noqa: E501 176 177 :return: The email of this PowerFormRecipient. # noqa: E501 178 :rtype: str 179 """ 180 return self._email 181 182 @email.setter 183 def email(self, email): 184 """Sets the email of this PowerFormRecipient. 185 186 # noqa: E501 187 188 :param email: The email of this PowerFormRecipient. # noqa: E501 189 :type: str 190 """ 191 192 self._email = email 193 194 @property 195 def email_locked(self): 196 """Gets the email_locked of this PowerFormRecipient. # noqa: E501 197 198 # noqa: E501 199 200 :return: The email_locked of this PowerFormRecipient. # noqa: E501 201 :rtype: str 202 """ 203 return self._email_locked 204 205 @email_locked.setter 206 def email_locked(self, email_locked): 207 """Sets the email_locked of this PowerFormRecipient. 208 209 # noqa: E501 210 211 :param email_locked: The email_locked of this PowerFormRecipient. # noqa: E501 212 :type: str 213 """ 214 215 self._email_locked = email_locked 216 217 @property 218 def id_check_configuration_name(self): 219 """Gets the id_check_configuration_name of this PowerFormRecipient. # noqa: E501 220 221 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 222 223 :return: The id_check_configuration_name of this PowerFormRecipient. # noqa: E501 224 :rtype: str 225 """ 226 return self._id_check_configuration_name 227 228 @id_check_configuration_name.setter 229 def id_check_configuration_name(self, id_check_configuration_name): 230 """Sets the id_check_configuration_name of this PowerFormRecipient. 231 232 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 233 234 :param id_check_configuration_name: The id_check_configuration_name of this PowerFormRecipient. # noqa: E501 235 :type: str 236 """ 237 238 self._id_check_configuration_name = id_check_configuration_name 239 240 @property 241 def id_check_required(self): 242 """Gets the id_check_required of this PowerFormRecipient. # noqa: E501 243 244 # noqa: E501 245 246 :return: The id_check_required of this PowerFormRecipient. # noqa: E501 247 :rtype: str 248 """ 249 return self._id_check_required 250 251 @id_check_required.setter 252 def id_check_required(self, id_check_required): 253 """Sets the id_check_required of this PowerFormRecipient. 254 255 # noqa: E501 256 257 :param id_check_required: The id_check_required of this PowerFormRecipient. # noqa: E501 258 :type: str 259 """ 260 261 self._id_check_required = id_check_required 262 263 @property 264 def name(self): 265 """Gets the name of this PowerFormRecipient. # noqa: E501 266 267 # noqa: E501 268 269 :return: The name of this PowerFormRecipient. # noqa: E501 270 :rtype: str 271 """ 272 return self._name 273 274 @name.setter 275 def name(self, name): 276 """Sets the name of this PowerFormRecipient. 277 278 # noqa: E501 279 280 :param name: The name of this PowerFormRecipient. # noqa: E501 281 :type: str 282 """ 283 284 self._name = name 285 286 @property 287 def recipient_type(self): 288 """Gets the recipient_type of this PowerFormRecipient. # noqa: E501 289 290 # noqa: E501 291 292 :return: The recipient_type of this PowerFormRecipient. # noqa: E501 293 :rtype: str 294 """ 295 return self._recipient_type 296 297 @recipient_type.setter 298 def recipient_type(self, recipient_type): 299 """Sets the recipient_type of this PowerFormRecipient. 300 301 # noqa: E501 302 303 :param recipient_type: The recipient_type of this PowerFormRecipient. # noqa: E501 304 :type: str 305 """ 306 307 self._recipient_type = recipient_type 308 309 @property 310 def role_name(self): 311 """Gets the role_name of this PowerFormRecipient. # noqa: E501 312 313 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 314 315 :return: The role_name of this PowerFormRecipient. # noqa: E501 316 :rtype: str 317 """ 318 return self._role_name 319 320 @role_name.setter 321 def role_name(self, role_name): 322 """Sets the role_name of this PowerFormRecipient. 323 324 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 325 326 :param role_name: The role_name of this PowerFormRecipient. # noqa: E501 327 :type: str 328 """ 329 330 self._role_name = role_name 331 332 @property 333 def routing_order(self): 334 """Gets the routing_order of this PowerFormRecipient. # noqa: E501 335 336 Specifies the routing order of the recipient in the envelope. # noqa: E501 337 338 :return: The routing_order of this PowerFormRecipient. # noqa: E501 339 :rtype: str 340 """ 341 return self._routing_order 342 343 @routing_order.setter 344 def routing_order(self, routing_order): 345 """Sets the routing_order of this PowerFormRecipient. 346 347 Specifies the routing order of the recipient in the envelope. # noqa: E501 348 349 :param routing_order: The routing_order of this PowerFormRecipient. # noqa: E501 350 :type: str 351 """ 352 353 self._routing_order = routing_order 354 355 @property 356 def template_requires_id_lookup(self): 357 """Gets the template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 358 359 # noqa: E501 360 361 :return: The template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 362 :rtype: str 363 """ 364 return self._template_requires_id_lookup 365 366 @template_requires_id_lookup.setter 367 def template_requires_id_lookup(self, template_requires_id_lookup): 368 """Sets the template_requires_id_lookup of this PowerFormRecipient. 369 370 # noqa: E501 371 372 :param template_requires_id_lookup: The template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 373 :type: str 374 """ 375 376 self._template_requires_id_lookup = template_requires_id_lookup 377 378 @property 379 def user_name_locked(self): 380 """Gets the user_name_locked of this PowerFormRecipient. # noqa: E501 381 382 # noqa: E501 383 384 :return: The user_name_locked of this PowerFormRecipient. # noqa: E501 385 :rtype: str 386 """ 387 return self._user_name_locked 388 389 @user_name_locked.setter 390 def user_name_locked(self, user_name_locked): 391 """Sets the user_name_locked of this PowerFormRecipient. 392 393 # noqa: E501 394 395 :param user_name_locked: The user_name_locked of this PowerFormRecipient. # noqa: E501 396 :type: str 397 """ 398 399 self._user_name_locked = user_name_locked 400 401 def to_dict(self): 402 """Returns the model properties as a dict""" 403 result = {} 404 405 for attr, _ in six.iteritems(self.swagger_types): 406 value = getattr(self, attr) 407 if isinstance(value, list): 408 result[attr] = list(map( 409 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 410 value 411 )) 412 elif hasattr(value, "to_dict"): 413 result[attr] = value.to_dict() 414 elif isinstance(value, dict): 415 result[attr] = dict(map( 416 lambda item: (item[0], item[1].to_dict()) 417 if hasattr(item[1], "to_dict") else item, 418 value.items() 419 )) 420 else: 421 result[attr] = value 422 if issubclass(PowerFormRecipient, dict): 423 for key, value in self.items(): 424 result[key] = value 425 426 return result 427 428 def to_str(self): 429 """Returns the string representation of the model""" 430 return pprint.pformat(self.to_dict()) 431 432 def __repr__(self): 433 """For `print` and `pprint`""" 434 return self.to_str() 435 436 def __eq__(self, other): 437 """Returns true if both objects are equal""" 438 if not isinstance(other, PowerFormRecipient): 439 return False 440 441 return self.to_dict() == other.to_dict() 442 443 def __ne__(self, other): 444 """Returns true if both objects are not equal""" 445 if not isinstance(other, PowerFormRecipient): 446 return True 447 448 return self.to_dict() != other.to_dict()
class
PowerFormRecipient:
23class PowerFormRecipient(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 'access_code': 'str', 38 'access_code_locked': 'str', 39 'access_code_required': 'str', 40 'email': 'str', 41 'email_locked': 'str', 42 'id_check_configuration_name': 'str', 43 'id_check_required': 'str', 44 'name': 'str', 45 'recipient_type': 'str', 46 'role_name': 'str', 47 'routing_order': 'str', 48 'template_requires_id_lookup': 'str', 49 'user_name_locked': 'str' 50 } 51 52 attribute_map = { 53 'access_code': 'accessCode', 54 'access_code_locked': 'accessCodeLocked', 55 'access_code_required': 'accessCodeRequired', 56 'email': 'email', 57 'email_locked': 'emailLocked', 58 'id_check_configuration_name': 'idCheckConfigurationName', 59 'id_check_required': 'idCheckRequired', 60 'name': 'name', 61 'recipient_type': 'recipientType', 62 'role_name': 'roleName', 63 'routing_order': 'routingOrder', 64 'template_requires_id_lookup': 'templateRequiresIdLookup', 65 'user_name_locked': 'userNameLocked' 66 } 67 68 def __init__(self, _configuration=None, **kwargs): # noqa: E501 69 """PowerFormRecipient - a model defined in Swagger""" # noqa: E501 70 if _configuration is None: 71 _configuration = Configuration() 72 self._configuration = _configuration 73 74 self._access_code = None 75 self._access_code_locked = None 76 self._access_code_required = None 77 self._email = None 78 self._email_locked = None 79 self._id_check_configuration_name = None 80 self._id_check_required = None 81 self._name = None 82 self._recipient_type = None 83 self._role_name = None 84 self._routing_order = None 85 self._template_requires_id_lookup = None 86 self._user_name_locked = None 87 self.discriminator = None 88 89 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 90 setattr(self, "_{}".format('access_code_locked'), kwargs.get('access_code_locked', None)) 91 setattr(self, "_{}".format('access_code_required'), kwargs.get('access_code_required', None)) 92 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 93 setattr(self, "_{}".format('email_locked'), kwargs.get('email_locked', None)) 94 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 95 setattr(self, "_{}".format('id_check_required'), kwargs.get('id_check_required', None)) 96 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 97 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 98 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 99 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 100 setattr(self, "_{}".format('template_requires_id_lookup'), kwargs.get('template_requires_id_lookup', None)) 101 setattr(self, "_{}".format('user_name_locked'), kwargs.get('user_name_locked', None)) 102 103 @property 104 def access_code(self): 105 """Gets the access_code of this PowerFormRecipient. # noqa: E501 106 107 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 108 109 :return: The access_code of this PowerFormRecipient. # noqa: E501 110 :rtype: str 111 """ 112 return self._access_code 113 114 @access_code.setter 115 def access_code(self, access_code): 116 """Sets the access_code of this PowerFormRecipient. 117 118 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 119 120 :param access_code: The access_code of this PowerFormRecipient. # noqa: E501 121 :type: str 122 """ 123 124 self._access_code = access_code 125 126 @property 127 def access_code_locked(self): 128 """Gets the access_code_locked of this PowerFormRecipient. # noqa: E501 129 130 # noqa: E501 131 132 :return: The access_code_locked of this PowerFormRecipient. # noqa: E501 133 :rtype: str 134 """ 135 return self._access_code_locked 136 137 @access_code_locked.setter 138 def access_code_locked(self, access_code_locked): 139 """Sets the access_code_locked of this PowerFormRecipient. 140 141 # noqa: E501 142 143 :param access_code_locked: The access_code_locked of this PowerFormRecipient. # noqa: E501 144 :type: str 145 """ 146 147 self._access_code_locked = access_code_locked 148 149 @property 150 def access_code_required(self): 151 """Gets the access_code_required of this PowerFormRecipient. # noqa: E501 152 153 # noqa: E501 154 155 :return: The access_code_required of this PowerFormRecipient. # noqa: E501 156 :rtype: str 157 """ 158 return self._access_code_required 159 160 @access_code_required.setter 161 def access_code_required(self, access_code_required): 162 """Sets the access_code_required of this PowerFormRecipient. 163 164 # noqa: E501 165 166 :param access_code_required: The access_code_required of this PowerFormRecipient. # noqa: E501 167 :type: str 168 """ 169 170 self._access_code_required = access_code_required 171 172 @property 173 def email(self): 174 """Gets the email of this PowerFormRecipient. # noqa: E501 175 176 # noqa: E501 177 178 :return: The email of this PowerFormRecipient. # noqa: E501 179 :rtype: str 180 """ 181 return self._email 182 183 @email.setter 184 def email(self, email): 185 """Sets the email of this PowerFormRecipient. 186 187 # noqa: E501 188 189 :param email: The email of this PowerFormRecipient. # noqa: E501 190 :type: str 191 """ 192 193 self._email = email 194 195 @property 196 def email_locked(self): 197 """Gets the email_locked of this PowerFormRecipient. # noqa: E501 198 199 # noqa: E501 200 201 :return: The email_locked of this PowerFormRecipient. # noqa: E501 202 :rtype: str 203 """ 204 return self._email_locked 205 206 @email_locked.setter 207 def email_locked(self, email_locked): 208 """Sets the email_locked of this PowerFormRecipient. 209 210 # noqa: E501 211 212 :param email_locked: The email_locked of this PowerFormRecipient. # noqa: E501 213 :type: str 214 """ 215 216 self._email_locked = email_locked 217 218 @property 219 def id_check_configuration_name(self): 220 """Gets the id_check_configuration_name of this PowerFormRecipient. # noqa: E501 221 222 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 223 224 :return: The id_check_configuration_name of this PowerFormRecipient. # noqa: E501 225 :rtype: str 226 """ 227 return self._id_check_configuration_name 228 229 @id_check_configuration_name.setter 230 def id_check_configuration_name(self, id_check_configuration_name): 231 """Sets the id_check_configuration_name of this PowerFormRecipient. 232 233 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 234 235 :param id_check_configuration_name: The id_check_configuration_name of this PowerFormRecipient. # noqa: E501 236 :type: str 237 """ 238 239 self._id_check_configuration_name = id_check_configuration_name 240 241 @property 242 def id_check_required(self): 243 """Gets the id_check_required of this PowerFormRecipient. # noqa: E501 244 245 # noqa: E501 246 247 :return: The id_check_required of this PowerFormRecipient. # noqa: E501 248 :rtype: str 249 """ 250 return self._id_check_required 251 252 @id_check_required.setter 253 def id_check_required(self, id_check_required): 254 """Sets the id_check_required of this PowerFormRecipient. 255 256 # noqa: E501 257 258 :param id_check_required: The id_check_required of this PowerFormRecipient. # noqa: E501 259 :type: str 260 """ 261 262 self._id_check_required = id_check_required 263 264 @property 265 def name(self): 266 """Gets the name of this PowerFormRecipient. # noqa: E501 267 268 # noqa: E501 269 270 :return: The name of this PowerFormRecipient. # noqa: E501 271 :rtype: str 272 """ 273 return self._name 274 275 @name.setter 276 def name(self, name): 277 """Sets the name of this PowerFormRecipient. 278 279 # noqa: E501 280 281 :param name: The name of this PowerFormRecipient. # noqa: E501 282 :type: str 283 """ 284 285 self._name = name 286 287 @property 288 def recipient_type(self): 289 """Gets the recipient_type of this PowerFormRecipient. # noqa: E501 290 291 # noqa: E501 292 293 :return: The recipient_type of this PowerFormRecipient. # noqa: E501 294 :rtype: str 295 """ 296 return self._recipient_type 297 298 @recipient_type.setter 299 def recipient_type(self, recipient_type): 300 """Sets the recipient_type of this PowerFormRecipient. 301 302 # noqa: E501 303 304 :param recipient_type: The recipient_type of this PowerFormRecipient. # noqa: E501 305 :type: str 306 """ 307 308 self._recipient_type = recipient_type 309 310 @property 311 def role_name(self): 312 """Gets the role_name of this PowerFormRecipient. # noqa: E501 313 314 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 315 316 :return: The role_name of this PowerFormRecipient. # noqa: E501 317 :rtype: str 318 """ 319 return self._role_name 320 321 @role_name.setter 322 def role_name(self, role_name): 323 """Sets the role_name of this PowerFormRecipient. 324 325 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 326 327 :param role_name: The role_name of this PowerFormRecipient. # noqa: E501 328 :type: str 329 """ 330 331 self._role_name = role_name 332 333 @property 334 def routing_order(self): 335 """Gets the routing_order of this PowerFormRecipient. # noqa: E501 336 337 Specifies the routing order of the recipient in the envelope. # noqa: E501 338 339 :return: The routing_order of this PowerFormRecipient. # noqa: E501 340 :rtype: str 341 """ 342 return self._routing_order 343 344 @routing_order.setter 345 def routing_order(self, routing_order): 346 """Sets the routing_order of this PowerFormRecipient. 347 348 Specifies the routing order of the recipient in the envelope. # noqa: E501 349 350 :param routing_order: The routing_order of this PowerFormRecipient. # noqa: E501 351 :type: str 352 """ 353 354 self._routing_order = routing_order 355 356 @property 357 def template_requires_id_lookup(self): 358 """Gets the template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 359 360 # noqa: E501 361 362 :return: The template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 363 :rtype: str 364 """ 365 return self._template_requires_id_lookup 366 367 @template_requires_id_lookup.setter 368 def template_requires_id_lookup(self, template_requires_id_lookup): 369 """Sets the template_requires_id_lookup of this PowerFormRecipient. 370 371 # noqa: E501 372 373 :param template_requires_id_lookup: The template_requires_id_lookup of this PowerFormRecipient. # noqa: E501 374 :type: str 375 """ 376 377 self._template_requires_id_lookup = template_requires_id_lookup 378 379 @property 380 def user_name_locked(self): 381 """Gets the user_name_locked of this PowerFormRecipient. # noqa: E501 382 383 # noqa: E501 384 385 :return: The user_name_locked of this PowerFormRecipient. # noqa: E501 386 :rtype: str 387 """ 388 return self._user_name_locked 389 390 @user_name_locked.setter 391 def user_name_locked(self, user_name_locked): 392 """Sets the user_name_locked of this PowerFormRecipient. 393 394 # noqa: E501 395 396 :param user_name_locked: The user_name_locked of this PowerFormRecipient. # noqa: E501 397 :type: str 398 """ 399 400 self._user_name_locked = user_name_locked 401 402 def to_dict(self): 403 """Returns the model properties as a dict""" 404 result = {} 405 406 for attr, _ in six.iteritems(self.swagger_types): 407 value = getattr(self, attr) 408 if isinstance(value, list): 409 result[attr] = list(map( 410 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 411 value 412 )) 413 elif hasattr(value, "to_dict"): 414 result[attr] = value.to_dict() 415 elif isinstance(value, dict): 416 result[attr] = dict(map( 417 lambda item: (item[0], item[1].to_dict()) 418 if hasattr(item[1], "to_dict") else item, 419 value.items() 420 )) 421 else: 422 result[attr] = value 423 if issubclass(PowerFormRecipient, dict): 424 for key, value in self.items(): 425 result[key] = value 426 427 return result 428 429 def to_str(self): 430 """Returns the string representation of the model""" 431 return pprint.pformat(self.to_dict()) 432 433 def __repr__(self): 434 """For `print` and `pprint`""" 435 return self.to_str() 436 437 def __eq__(self, other): 438 """Returns true if both objects are equal""" 439 if not isinstance(other, PowerFormRecipient): 440 return False 441 442 return self.to_dict() == other.to_dict() 443 444 def __ne__(self, other): 445 """Returns true if both objects are not equal""" 446 if not isinstance(other, PowerFormRecipient): 447 return True 448 449 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.
PowerFormRecipient(_configuration=None, **kwargs)
68 def __init__(self, _configuration=None, **kwargs): # noqa: E501 69 """PowerFormRecipient - a model defined in Swagger""" # noqa: E501 70 if _configuration is None: 71 _configuration = Configuration() 72 self._configuration = _configuration 73 74 self._access_code = None 75 self._access_code_locked = None 76 self._access_code_required = None 77 self._email = None 78 self._email_locked = None 79 self._id_check_configuration_name = None 80 self._id_check_required = None 81 self._name = None 82 self._recipient_type = None 83 self._role_name = None 84 self._routing_order = None 85 self._template_requires_id_lookup = None 86 self._user_name_locked = None 87 self.discriminator = None 88 89 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 90 setattr(self, "_{}".format('access_code_locked'), kwargs.get('access_code_locked', None)) 91 setattr(self, "_{}".format('access_code_required'), kwargs.get('access_code_required', None)) 92 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 93 setattr(self, "_{}".format('email_locked'), kwargs.get('email_locked', None)) 94 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 95 setattr(self, "_{}".format('id_check_required'), kwargs.get('id_check_required', None)) 96 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 97 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 98 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 99 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 100 setattr(self, "_{}".format('template_requires_id_lookup'), kwargs.get('template_requires_id_lookup', None)) 101 setattr(self, "_{}".format('user_name_locked'), kwargs.get('user_name_locked', None))
PowerFormRecipient - a model defined in Swagger
swagger_types = {'access_code': 'str', 'access_code_locked': 'str', 'access_code_required': 'str', 'email': 'str', 'email_locked': 'str', 'id_check_configuration_name': 'str', 'id_check_required': 'str', 'name': 'str', 'recipient_type': 'str', 'role_name': 'str', 'routing_order': 'str', 'template_requires_id_lookup': 'str', 'user_name_locked': 'str'}
attribute_map = {'access_code': 'accessCode', 'access_code_locked': 'accessCodeLocked', 'access_code_required': 'accessCodeRequired', 'email': 'email', 'email_locked': 'emailLocked', 'id_check_configuration_name': 'idCheckConfigurationName', 'id_check_required': 'idCheckRequired', 'name': 'name', 'recipient_type': 'recipientType', 'role_name': 'roleName', 'routing_order': 'routingOrder', 'template_requires_id_lookup': 'templateRequiresIdLookup', 'user_name_locked': 'userNameLocked'}
access_code
Gets the access_code of this PowerFormRecipient. # noqa: E501
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required. # noqa: E501
Returns
The access_code of this PowerFormRecipient. # noqa: E501
access_code_locked
Gets the access_code_locked of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The access_code_locked of this PowerFormRecipient. # noqa: E501
access_code_required
Gets the access_code_required of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The access_code_required of this PowerFormRecipient. # noqa: E501
email
Gets the email of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The email of this PowerFormRecipient. # noqa: E501
email_locked
Gets the email_locked of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The email_locked of this PowerFormRecipient. # noqa: E501
id_check_configuration_name
Gets the id_check_configuration_name of this PowerFormRecipient. # noqa: E501
Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node. # noqa: E501
Returns
The id_check_configuration_name of this PowerFormRecipient. # noqa: E501
id_check_required
Gets the id_check_required of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The id_check_required of this PowerFormRecipient. # noqa: E501
name
Gets the name of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The name of this PowerFormRecipient. # noqa: E501
recipient_type
Gets the recipient_type of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The recipient_type of this PowerFormRecipient. # noqa: E501
role_name
Gets the role_name of this PowerFormRecipient. # noqa: E501
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients. # noqa: E501
Returns
The role_name of this PowerFormRecipient. # noqa: E501
routing_order
Gets the routing_order of this PowerFormRecipient. # noqa: E501
Specifies the routing order of the recipient in the envelope. # noqa: E501
Returns
The routing_order of this PowerFormRecipient. # noqa: E501
template_requires_id_lookup
Gets the template_requires_id_lookup of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The template_requires_id_lookup of this PowerFormRecipient. # noqa: E501
user_name_locked
Gets the user_name_locked of this PowerFormRecipient. # noqa: E501
# noqa: E501
Returns
The user_name_locked of this PowerFormRecipient. # noqa: E501
def
to_dict(self)
402 def to_dict(self): 403 """Returns the model properties as a dict""" 404 result = {} 405 406 for attr, _ in six.iteritems(self.swagger_types): 407 value = getattr(self, attr) 408 if isinstance(value, list): 409 result[attr] = list(map( 410 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 411 value 412 )) 413 elif hasattr(value, "to_dict"): 414 result[attr] = value.to_dict() 415 elif isinstance(value, dict): 416 result[attr] = dict(map( 417 lambda item: (item[0], item[1].to_dict()) 418 if hasattr(item[1], "to_dict") else item, 419 value.items() 420 )) 421 else: 422 result[attr] = value 423 if issubclass(PowerFormRecipient, dict): 424 for key, value in self.items(): 425 result[key] = value 426 427 return result
Returns the model properties as a dict