docusign_esign.models.recipient_view_request
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 DocuSign REST API 5 6 The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class RecipientViewRequest(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 'assertion_id': 'str', 37 'authentication_instant': 'str', 38 'authentication_method': 'str', 39 'client_ur_ls': 'RecipientTokenClientURLs', 40 'client_user_id': 'str', 41 'email': 'str', 42 'frame_ancestors': 'list[str]', 43 'message_origins': 'list[str]', 44 'ping_frequency': 'str', 45 'ping_url': 'str', 46 'recipient_id': 'str', 47 'return_url': 'str', 48 'security_domain': 'str', 49 'user_id': 'str', 50 'user_name': 'str', 51 'x_frame_options': 'str', 52 'x_frame_options_allow_from_url': 'str' 53 } 54 55 attribute_map = { 56 'assertion_id': 'assertionId', 57 'authentication_instant': 'authenticationInstant', 58 'authentication_method': 'authenticationMethod', 59 'client_ur_ls': 'clientURLs', 60 'client_user_id': 'clientUserId', 61 'email': 'email', 62 'frame_ancestors': 'frameAncestors', 63 'message_origins': 'messageOrigins', 64 'ping_frequency': 'pingFrequency', 65 'ping_url': 'pingUrl', 66 'recipient_id': 'recipientId', 67 'return_url': 'returnUrl', 68 'security_domain': 'securityDomain', 69 'user_id': 'userId', 70 'user_name': 'userName', 71 'x_frame_options': 'xFrameOptions', 72 'x_frame_options_allow_from_url': 'xFrameOptionsAllowFromUrl' 73 } 74 75 def __init__(self, _configuration=None, **kwargs): # noqa: E501 76 """RecipientViewRequest - a model defined in Swagger""" # noqa: E501 77 if _configuration is None: 78 _configuration = Configuration() 79 self._configuration = _configuration 80 81 self._assertion_id = None 82 self._authentication_instant = None 83 self._authentication_method = None 84 self._client_ur_ls = None 85 self._client_user_id = None 86 self._email = None 87 self._frame_ancestors = None 88 self._message_origins = None 89 self._ping_frequency = None 90 self._ping_url = None 91 self._recipient_id = None 92 self._return_url = None 93 self._security_domain = None 94 self._user_id = None 95 self._user_name = None 96 self._x_frame_options = None 97 self._x_frame_options_allow_from_url = None 98 self.discriminator = None 99 100 setattr(self, "_{}".format('assertion_id'), kwargs.get('assertion_id', None)) 101 setattr(self, "_{}".format('authentication_instant'), kwargs.get('authentication_instant', None)) 102 setattr(self, "_{}".format('authentication_method'), kwargs.get('authentication_method', None)) 103 setattr(self, "_{}".format('client_ur_ls'), kwargs.get('client_ur_ls', None)) 104 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 105 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 106 setattr(self, "_{}".format('frame_ancestors'), kwargs.get('frame_ancestors', None)) 107 setattr(self, "_{}".format('message_origins'), kwargs.get('message_origins', None)) 108 setattr(self, "_{}".format('ping_frequency'), kwargs.get('ping_frequency', None)) 109 setattr(self, "_{}".format('ping_url'), kwargs.get('ping_url', None)) 110 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 111 setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None)) 112 setattr(self, "_{}".format('security_domain'), kwargs.get('security_domain', None)) 113 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 114 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 115 setattr(self, "_{}".format('x_frame_options'), kwargs.get('x_frame_options', None)) 116 setattr(self, "_{}".format('x_frame_options_allow_from_url'), kwargs.get('x_frame_options_allow_from_url', None)) 117 118 @property 119 def assertion_id(self): 120 """Gets the assertion_id of this RecipientViewRequest. # noqa: E501 121 122 A unique identifier of the authentication event executed by the client application. # noqa: E501 123 124 :return: The assertion_id of this RecipientViewRequest. # noqa: E501 125 :rtype: str 126 """ 127 return self._assertion_id 128 129 @assertion_id.setter 130 def assertion_id(self, assertion_id): 131 """Sets the assertion_id of this RecipientViewRequest. 132 133 A unique identifier of the authentication event executed by the client application. # noqa: E501 134 135 :param assertion_id: The assertion_id of this RecipientViewRequest. # noqa: E501 136 :type: str 137 """ 138 139 self._assertion_id = assertion_id 140 141 @property 142 def authentication_instant(self): 143 """Gets the authentication_instant of this RecipientViewRequest. # noqa: E501 144 145 A sender generated value that indicates the date/time that the signer was authenticated. # noqa: E501 146 147 :return: The authentication_instant of this RecipientViewRequest. # noqa: E501 148 :rtype: str 149 """ 150 return self._authentication_instant 151 152 @authentication_instant.setter 153 def authentication_instant(self, authentication_instant): 154 """Sets the authentication_instant of this RecipientViewRequest. 155 156 A sender generated value that indicates the date/time that the signer was authenticated. # noqa: E501 157 158 :param authentication_instant: The authentication_instant of this RecipientViewRequest. # noqa: E501 159 :type: str 160 """ 161 162 self._authentication_instant = authentication_instant 163 164 @property 165 def authentication_method(self): 166 """Gets the authentication_method of this RecipientViewRequest. # noqa: E501 167 168 A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. # noqa: E501 169 170 :return: The authentication_method of this RecipientViewRequest. # noqa: E501 171 :rtype: str 172 """ 173 return self._authentication_method 174 175 @authentication_method.setter 176 def authentication_method(self, authentication_method): 177 """Sets the authentication_method of this RecipientViewRequest. 178 179 A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. # noqa: E501 180 181 :param authentication_method: The authentication_method of this RecipientViewRequest. # noqa: E501 182 :type: str 183 """ 184 185 self._authentication_method = authentication_method 186 187 @property 188 def client_ur_ls(self): 189 """Gets the client_ur_ls of this RecipientViewRequest. # noqa: E501 190 191 # noqa: E501 192 193 :return: The client_ur_ls of this RecipientViewRequest. # noqa: E501 194 :rtype: RecipientTokenClientURLs 195 """ 196 return self._client_ur_ls 197 198 @client_ur_ls.setter 199 def client_ur_ls(self, client_ur_ls): 200 """Sets the client_ur_ls of this RecipientViewRequest. 201 202 # noqa: E501 203 204 :param client_ur_ls: The client_ur_ls of this RecipientViewRequest. # noqa: E501 205 :type: RecipientTokenClientURLs 206 """ 207 208 self._client_ur_ls = client_ur_ls 209 210 @property 211 def client_user_id(self): 212 """Gets the client_user_id of this RecipientViewRequest. # noqa: E501 213 214 A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. # noqa: E501 215 216 :return: The client_user_id of this RecipientViewRequest. # noqa: E501 217 :rtype: str 218 """ 219 return self._client_user_id 220 221 @client_user_id.setter 222 def client_user_id(self, client_user_id): 223 """Sets the client_user_id of this RecipientViewRequest. 224 225 A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. # noqa: E501 226 227 :param client_user_id: The client_user_id of this RecipientViewRequest. # noqa: E501 228 :type: str 229 """ 230 231 self._client_user_id = client_user_id 232 233 @property 234 def email(self): 235 """Gets the email of this RecipientViewRequest. # noqa: E501 236 237 Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 238 239 :return: The email of this RecipientViewRequest. # noqa: E501 240 :rtype: str 241 """ 242 return self._email 243 244 @email.setter 245 def email(self, email): 246 """Sets the email of this RecipientViewRequest. 247 248 Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 249 250 :param email: The email of this RecipientViewRequest. # noqa: E501 251 :type: str 252 """ 253 254 self._email = email 255 256 @property 257 def frame_ancestors(self): 258 """Gets the frame_ancestors of this RecipientViewRequest. # noqa: E501 259 260 # noqa: E501 261 262 :return: The frame_ancestors of this RecipientViewRequest. # noqa: E501 263 :rtype: list[str] 264 """ 265 return self._frame_ancestors 266 267 @frame_ancestors.setter 268 def frame_ancestors(self, frame_ancestors): 269 """Sets the frame_ancestors of this RecipientViewRequest. 270 271 # noqa: E501 272 273 :param frame_ancestors: The frame_ancestors of this RecipientViewRequest. # noqa: E501 274 :type: list[str] 275 """ 276 277 self._frame_ancestors = frame_ancestors 278 279 @property 280 def message_origins(self): 281 """Gets the message_origins of this RecipientViewRequest. # noqa: E501 282 283 # noqa: E501 284 285 :return: The message_origins of this RecipientViewRequest. # noqa: E501 286 :rtype: list[str] 287 """ 288 return self._message_origins 289 290 @message_origins.setter 291 def message_origins(self, message_origins): 292 """Sets the message_origins of this RecipientViewRequest. 293 294 # noqa: E501 295 296 :param message_origins: The message_origins of this RecipientViewRequest. # noqa: E501 297 :type: list[str] 298 """ 299 300 self._message_origins = message_origins 301 302 @property 303 def ping_frequency(self): 304 """Gets the ping_frequency of this RecipientViewRequest. # noqa: E501 305 306 Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. # noqa: E501 307 308 :return: The ping_frequency of this RecipientViewRequest. # noqa: E501 309 :rtype: str 310 """ 311 return self._ping_frequency 312 313 @ping_frequency.setter 314 def ping_frequency(self, ping_frequency): 315 """Sets the ping_frequency of this RecipientViewRequest. 316 317 Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. # noqa: E501 318 319 :param ping_frequency: The ping_frequency of this RecipientViewRequest. # noqa: E501 320 :type: str 321 """ 322 323 self._ping_frequency = ping_frequency 324 325 @property 326 def ping_url(self): 327 """Gets the ping_url of this RecipientViewRequest. # noqa: E501 328 329 A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. # noqa: E501 330 331 :return: The ping_url of this RecipientViewRequest. # noqa: E501 332 :rtype: str 333 """ 334 return self._ping_url 335 336 @ping_url.setter 337 def ping_url(self, ping_url): 338 """Sets the ping_url of this RecipientViewRequest. 339 340 A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. # noqa: E501 341 342 :param ping_url: The ping_url of this RecipientViewRequest. # noqa: E501 343 :type: str 344 """ 345 346 self._ping_url = ping_url 347 348 @property 349 def recipient_id(self): 350 """Gets the recipient_id of this RecipientViewRequest. # noqa: E501 351 352 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 353 354 :return: The recipient_id of this RecipientViewRequest. # noqa: E501 355 :rtype: str 356 """ 357 return self._recipient_id 358 359 @recipient_id.setter 360 def recipient_id(self, recipient_id): 361 """Sets the recipient_id of this RecipientViewRequest. 362 363 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 364 365 :param recipient_id: The recipient_id of this RecipientViewRequest. # noqa: E501 366 :type: str 367 """ 368 369 self._recipient_id = recipient_id 370 371 @property 372 def return_url(self): 373 """Gets the return_url of this RecipientViewRequest. # noqa: E501 374 375 The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. # noqa: E501 376 377 :return: The return_url of this RecipientViewRequest. # noqa: E501 378 :rtype: str 379 """ 380 return self._return_url 381 382 @return_url.setter 383 def return_url(self, return_url): 384 """Sets the return_url of this RecipientViewRequest. 385 386 The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. # noqa: E501 387 388 :param return_url: The return_url of this RecipientViewRequest. # noqa: E501 389 :type: str 390 """ 391 392 self._return_url = return_url 393 394 @property 395 def security_domain(self): 396 """Gets the security_domain of this RecipientViewRequest. # noqa: E501 397 398 The domain in which the user authenticated. # noqa: E501 399 400 :return: The security_domain of this RecipientViewRequest. # noqa: E501 401 :rtype: str 402 """ 403 return self._security_domain 404 405 @security_domain.setter 406 def security_domain(self, security_domain): 407 """Sets the security_domain of this RecipientViewRequest. 408 409 The domain in which the user authenticated. # noqa: E501 410 411 :param security_domain: The security_domain of this RecipientViewRequest. # noqa: E501 412 :type: str 413 """ 414 415 self._security_domain = security_domain 416 417 @property 418 def user_id(self): 419 """Gets the user_id of this RecipientViewRequest. # noqa: E501 420 421 Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. # noqa: E501 422 423 :return: The user_id of this RecipientViewRequest. # noqa: E501 424 :rtype: str 425 """ 426 return self._user_id 427 428 @user_id.setter 429 def user_id(self, user_id): 430 """Sets the user_id of this RecipientViewRequest. 431 432 Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. # noqa: E501 433 434 :param user_id: The user_id of this RecipientViewRequest. # noqa: E501 435 :type: str 436 """ 437 438 self._user_id = user_id 439 440 @property 441 def user_name(self): 442 """Gets the user_name of this RecipientViewRequest. # noqa: E501 443 444 Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 445 446 :return: The user_name of this RecipientViewRequest. # noqa: E501 447 :rtype: str 448 """ 449 return self._user_name 450 451 @user_name.setter 452 def user_name(self, user_name): 453 """Sets the user_name of this RecipientViewRequest. 454 455 Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 456 457 :param user_name: The user_name of this RecipientViewRequest. # noqa: E501 458 :type: str 459 """ 460 461 self._user_name = user_name 462 463 @property 464 def x_frame_options(self): 465 """Gets the x_frame_options of this RecipientViewRequest. # noqa: E501 466 467 # noqa: E501 468 469 :return: The x_frame_options of this RecipientViewRequest. # noqa: E501 470 :rtype: str 471 """ 472 return self._x_frame_options 473 474 @x_frame_options.setter 475 def x_frame_options(self, x_frame_options): 476 """Sets the x_frame_options of this RecipientViewRequest. 477 478 # noqa: E501 479 480 :param x_frame_options: The x_frame_options of this RecipientViewRequest. # noqa: E501 481 :type: str 482 """ 483 484 self._x_frame_options = x_frame_options 485 486 @property 487 def x_frame_options_allow_from_url(self): 488 """Gets the x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 489 490 # noqa: E501 491 492 :return: The x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 493 :rtype: str 494 """ 495 return self._x_frame_options_allow_from_url 496 497 @x_frame_options_allow_from_url.setter 498 def x_frame_options_allow_from_url(self, x_frame_options_allow_from_url): 499 """Sets the x_frame_options_allow_from_url of this RecipientViewRequest. 500 501 # noqa: E501 502 503 :param x_frame_options_allow_from_url: The x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 504 :type: str 505 """ 506 507 self._x_frame_options_allow_from_url = x_frame_options_allow_from_url 508 509 def to_dict(self): 510 """Returns the model properties as a dict""" 511 result = {} 512 513 for attr, _ in six.iteritems(self.swagger_types): 514 value = getattr(self, attr) 515 if isinstance(value, list): 516 result[attr] = list(map( 517 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 518 value 519 )) 520 elif hasattr(value, "to_dict"): 521 result[attr] = value.to_dict() 522 elif isinstance(value, dict): 523 result[attr] = dict(map( 524 lambda item: (item[0], item[1].to_dict()) 525 if hasattr(item[1], "to_dict") else item, 526 value.items() 527 )) 528 else: 529 result[attr] = value 530 if issubclass(RecipientViewRequest, dict): 531 for key, value in self.items(): 532 result[key] = value 533 534 return result 535 536 def to_str(self): 537 """Returns the string representation of the model""" 538 return pprint.pformat(self.to_dict()) 539 540 def __repr__(self): 541 """For `print` and `pprint`""" 542 return self.to_str() 543 544 def __eq__(self, other): 545 """Returns true if both objects are equal""" 546 if not isinstance(other, RecipientViewRequest): 547 return False 548 549 return self.to_dict() == other.to_dict() 550 551 def __ne__(self, other): 552 """Returns true if both objects are not equal""" 553 if not isinstance(other, RecipientViewRequest): 554 return True 555 556 return self.to_dict() != other.to_dict()
23class RecipientViewRequest(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 'assertion_id': 'str', 38 'authentication_instant': 'str', 39 'authentication_method': 'str', 40 'client_ur_ls': 'RecipientTokenClientURLs', 41 'client_user_id': 'str', 42 'email': 'str', 43 'frame_ancestors': 'list[str]', 44 'message_origins': 'list[str]', 45 'ping_frequency': 'str', 46 'ping_url': 'str', 47 'recipient_id': 'str', 48 'return_url': 'str', 49 'security_domain': 'str', 50 'user_id': 'str', 51 'user_name': 'str', 52 'x_frame_options': 'str', 53 'x_frame_options_allow_from_url': 'str' 54 } 55 56 attribute_map = { 57 'assertion_id': 'assertionId', 58 'authentication_instant': 'authenticationInstant', 59 'authentication_method': 'authenticationMethod', 60 'client_ur_ls': 'clientURLs', 61 'client_user_id': 'clientUserId', 62 'email': 'email', 63 'frame_ancestors': 'frameAncestors', 64 'message_origins': 'messageOrigins', 65 'ping_frequency': 'pingFrequency', 66 'ping_url': 'pingUrl', 67 'recipient_id': 'recipientId', 68 'return_url': 'returnUrl', 69 'security_domain': 'securityDomain', 70 'user_id': 'userId', 71 'user_name': 'userName', 72 'x_frame_options': 'xFrameOptions', 73 'x_frame_options_allow_from_url': 'xFrameOptionsAllowFromUrl' 74 } 75 76 def __init__(self, _configuration=None, **kwargs): # noqa: E501 77 """RecipientViewRequest - a model defined in Swagger""" # noqa: E501 78 if _configuration is None: 79 _configuration = Configuration() 80 self._configuration = _configuration 81 82 self._assertion_id = None 83 self._authentication_instant = None 84 self._authentication_method = None 85 self._client_ur_ls = None 86 self._client_user_id = None 87 self._email = None 88 self._frame_ancestors = None 89 self._message_origins = None 90 self._ping_frequency = None 91 self._ping_url = None 92 self._recipient_id = None 93 self._return_url = None 94 self._security_domain = None 95 self._user_id = None 96 self._user_name = None 97 self._x_frame_options = None 98 self._x_frame_options_allow_from_url = None 99 self.discriminator = None 100 101 setattr(self, "_{}".format('assertion_id'), kwargs.get('assertion_id', None)) 102 setattr(self, "_{}".format('authentication_instant'), kwargs.get('authentication_instant', None)) 103 setattr(self, "_{}".format('authentication_method'), kwargs.get('authentication_method', None)) 104 setattr(self, "_{}".format('client_ur_ls'), kwargs.get('client_ur_ls', None)) 105 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 106 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 107 setattr(self, "_{}".format('frame_ancestors'), kwargs.get('frame_ancestors', None)) 108 setattr(self, "_{}".format('message_origins'), kwargs.get('message_origins', None)) 109 setattr(self, "_{}".format('ping_frequency'), kwargs.get('ping_frequency', None)) 110 setattr(self, "_{}".format('ping_url'), kwargs.get('ping_url', None)) 111 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 112 setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None)) 113 setattr(self, "_{}".format('security_domain'), kwargs.get('security_domain', None)) 114 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 115 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 116 setattr(self, "_{}".format('x_frame_options'), kwargs.get('x_frame_options', None)) 117 setattr(self, "_{}".format('x_frame_options_allow_from_url'), kwargs.get('x_frame_options_allow_from_url', None)) 118 119 @property 120 def assertion_id(self): 121 """Gets the assertion_id of this RecipientViewRequest. # noqa: E501 122 123 A unique identifier of the authentication event executed by the client application. # noqa: E501 124 125 :return: The assertion_id of this RecipientViewRequest. # noqa: E501 126 :rtype: str 127 """ 128 return self._assertion_id 129 130 @assertion_id.setter 131 def assertion_id(self, assertion_id): 132 """Sets the assertion_id of this RecipientViewRequest. 133 134 A unique identifier of the authentication event executed by the client application. # noqa: E501 135 136 :param assertion_id: The assertion_id of this RecipientViewRequest. # noqa: E501 137 :type: str 138 """ 139 140 self._assertion_id = assertion_id 141 142 @property 143 def authentication_instant(self): 144 """Gets the authentication_instant of this RecipientViewRequest. # noqa: E501 145 146 A sender generated value that indicates the date/time that the signer was authenticated. # noqa: E501 147 148 :return: The authentication_instant of this RecipientViewRequest. # noqa: E501 149 :rtype: str 150 """ 151 return self._authentication_instant 152 153 @authentication_instant.setter 154 def authentication_instant(self, authentication_instant): 155 """Sets the authentication_instant of this RecipientViewRequest. 156 157 A sender generated value that indicates the date/time that the signer was authenticated. # noqa: E501 158 159 :param authentication_instant: The authentication_instant of this RecipientViewRequest. # noqa: E501 160 :type: str 161 """ 162 163 self._authentication_instant = authentication_instant 164 165 @property 166 def authentication_method(self): 167 """Gets the authentication_method of this RecipientViewRequest. # noqa: E501 168 169 A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. # noqa: E501 170 171 :return: The authentication_method of this RecipientViewRequest. # noqa: E501 172 :rtype: str 173 """ 174 return self._authentication_method 175 176 @authentication_method.setter 177 def authentication_method(self, authentication_method): 178 """Sets the authentication_method of this RecipientViewRequest. 179 180 A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. # noqa: E501 181 182 :param authentication_method: The authentication_method of this RecipientViewRequest. # noqa: E501 183 :type: str 184 """ 185 186 self._authentication_method = authentication_method 187 188 @property 189 def client_ur_ls(self): 190 """Gets the client_ur_ls of this RecipientViewRequest. # noqa: E501 191 192 # noqa: E501 193 194 :return: The client_ur_ls of this RecipientViewRequest. # noqa: E501 195 :rtype: RecipientTokenClientURLs 196 """ 197 return self._client_ur_ls 198 199 @client_ur_ls.setter 200 def client_ur_ls(self, client_ur_ls): 201 """Sets the client_ur_ls of this RecipientViewRequest. 202 203 # noqa: E501 204 205 :param client_ur_ls: The client_ur_ls of this RecipientViewRequest. # noqa: E501 206 :type: RecipientTokenClientURLs 207 """ 208 209 self._client_ur_ls = client_ur_ls 210 211 @property 212 def client_user_id(self): 213 """Gets the client_user_id of this RecipientViewRequest. # noqa: E501 214 215 A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. # noqa: E501 216 217 :return: The client_user_id of this RecipientViewRequest. # noqa: E501 218 :rtype: str 219 """ 220 return self._client_user_id 221 222 @client_user_id.setter 223 def client_user_id(self, client_user_id): 224 """Sets the client_user_id of this RecipientViewRequest. 225 226 A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. # noqa: E501 227 228 :param client_user_id: The client_user_id of this RecipientViewRequest. # noqa: E501 229 :type: str 230 """ 231 232 self._client_user_id = client_user_id 233 234 @property 235 def email(self): 236 """Gets the email of this RecipientViewRequest. # noqa: E501 237 238 Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 239 240 :return: The email of this RecipientViewRequest. # noqa: E501 241 :rtype: str 242 """ 243 return self._email 244 245 @email.setter 246 def email(self, email): 247 """Sets the email of this RecipientViewRequest. 248 249 Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 250 251 :param email: The email of this RecipientViewRequest. # noqa: E501 252 :type: str 253 """ 254 255 self._email = email 256 257 @property 258 def frame_ancestors(self): 259 """Gets the frame_ancestors of this RecipientViewRequest. # noqa: E501 260 261 # noqa: E501 262 263 :return: The frame_ancestors of this RecipientViewRequest. # noqa: E501 264 :rtype: list[str] 265 """ 266 return self._frame_ancestors 267 268 @frame_ancestors.setter 269 def frame_ancestors(self, frame_ancestors): 270 """Sets the frame_ancestors of this RecipientViewRequest. 271 272 # noqa: E501 273 274 :param frame_ancestors: The frame_ancestors of this RecipientViewRequest. # noqa: E501 275 :type: list[str] 276 """ 277 278 self._frame_ancestors = frame_ancestors 279 280 @property 281 def message_origins(self): 282 """Gets the message_origins of this RecipientViewRequest. # noqa: E501 283 284 # noqa: E501 285 286 :return: The message_origins of this RecipientViewRequest. # noqa: E501 287 :rtype: list[str] 288 """ 289 return self._message_origins 290 291 @message_origins.setter 292 def message_origins(self, message_origins): 293 """Sets the message_origins of this RecipientViewRequest. 294 295 # noqa: E501 296 297 :param message_origins: The message_origins of this RecipientViewRequest. # noqa: E501 298 :type: list[str] 299 """ 300 301 self._message_origins = message_origins 302 303 @property 304 def ping_frequency(self): 305 """Gets the ping_frequency of this RecipientViewRequest. # noqa: E501 306 307 Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. # noqa: E501 308 309 :return: The ping_frequency of this RecipientViewRequest. # noqa: E501 310 :rtype: str 311 """ 312 return self._ping_frequency 313 314 @ping_frequency.setter 315 def ping_frequency(self, ping_frequency): 316 """Sets the ping_frequency of this RecipientViewRequest. 317 318 Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. # noqa: E501 319 320 :param ping_frequency: The ping_frequency of this RecipientViewRequest. # noqa: E501 321 :type: str 322 """ 323 324 self._ping_frequency = ping_frequency 325 326 @property 327 def ping_url(self): 328 """Gets the ping_url of this RecipientViewRequest. # noqa: E501 329 330 A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. # noqa: E501 331 332 :return: The ping_url of this RecipientViewRequest. # noqa: E501 333 :rtype: str 334 """ 335 return self._ping_url 336 337 @ping_url.setter 338 def ping_url(self, ping_url): 339 """Sets the ping_url of this RecipientViewRequest. 340 341 A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. # noqa: E501 342 343 :param ping_url: The ping_url of this RecipientViewRequest. # noqa: E501 344 :type: str 345 """ 346 347 self._ping_url = ping_url 348 349 @property 350 def recipient_id(self): 351 """Gets the recipient_id of this RecipientViewRequest. # noqa: E501 352 353 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 354 355 :return: The recipient_id of this RecipientViewRequest. # noqa: E501 356 :rtype: str 357 """ 358 return self._recipient_id 359 360 @recipient_id.setter 361 def recipient_id(self, recipient_id): 362 """Sets the recipient_id of this RecipientViewRequest. 363 364 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 365 366 :param recipient_id: The recipient_id of this RecipientViewRequest. # noqa: E501 367 :type: str 368 """ 369 370 self._recipient_id = recipient_id 371 372 @property 373 def return_url(self): 374 """Gets the return_url of this RecipientViewRequest. # noqa: E501 375 376 The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. # noqa: E501 377 378 :return: The return_url of this RecipientViewRequest. # noqa: E501 379 :rtype: str 380 """ 381 return self._return_url 382 383 @return_url.setter 384 def return_url(self, return_url): 385 """Sets the return_url of this RecipientViewRequest. 386 387 The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. # noqa: E501 388 389 :param return_url: The return_url of this RecipientViewRequest. # noqa: E501 390 :type: str 391 """ 392 393 self._return_url = return_url 394 395 @property 396 def security_domain(self): 397 """Gets the security_domain of this RecipientViewRequest. # noqa: E501 398 399 The domain in which the user authenticated. # noqa: E501 400 401 :return: The security_domain of this RecipientViewRequest. # noqa: E501 402 :rtype: str 403 """ 404 return self._security_domain 405 406 @security_domain.setter 407 def security_domain(self, security_domain): 408 """Sets the security_domain of this RecipientViewRequest. 409 410 The domain in which the user authenticated. # noqa: E501 411 412 :param security_domain: The security_domain of this RecipientViewRequest. # noqa: E501 413 :type: str 414 """ 415 416 self._security_domain = security_domain 417 418 @property 419 def user_id(self): 420 """Gets the user_id of this RecipientViewRequest. # noqa: E501 421 422 Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. # noqa: E501 423 424 :return: The user_id of this RecipientViewRequest. # noqa: E501 425 :rtype: str 426 """ 427 return self._user_id 428 429 @user_id.setter 430 def user_id(self, user_id): 431 """Sets the user_id of this RecipientViewRequest. 432 433 Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. # noqa: E501 434 435 :param user_id: The user_id of this RecipientViewRequest. # noqa: E501 436 :type: str 437 """ 438 439 self._user_id = user_id 440 441 @property 442 def user_name(self): 443 """Gets the user_name of this RecipientViewRequest. # noqa: E501 444 445 Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 446 447 :return: The user_name of this RecipientViewRequest. # noqa: E501 448 :rtype: str 449 """ 450 return self._user_name 451 452 @user_name.setter 453 def user_name(self, user_name): 454 """Sets the user_name of this RecipientViewRequest. 455 456 Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501 457 458 :param user_name: The user_name of this RecipientViewRequest. # noqa: E501 459 :type: str 460 """ 461 462 self._user_name = user_name 463 464 @property 465 def x_frame_options(self): 466 """Gets the x_frame_options of this RecipientViewRequest. # noqa: E501 467 468 # noqa: E501 469 470 :return: The x_frame_options of this RecipientViewRequest. # noqa: E501 471 :rtype: str 472 """ 473 return self._x_frame_options 474 475 @x_frame_options.setter 476 def x_frame_options(self, x_frame_options): 477 """Sets the x_frame_options of this RecipientViewRequest. 478 479 # noqa: E501 480 481 :param x_frame_options: The x_frame_options of this RecipientViewRequest. # noqa: E501 482 :type: str 483 """ 484 485 self._x_frame_options = x_frame_options 486 487 @property 488 def x_frame_options_allow_from_url(self): 489 """Gets the x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 490 491 # noqa: E501 492 493 :return: The x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 494 :rtype: str 495 """ 496 return self._x_frame_options_allow_from_url 497 498 @x_frame_options_allow_from_url.setter 499 def x_frame_options_allow_from_url(self, x_frame_options_allow_from_url): 500 """Sets the x_frame_options_allow_from_url of this RecipientViewRequest. 501 502 # noqa: E501 503 504 :param x_frame_options_allow_from_url: The x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501 505 :type: str 506 """ 507 508 self._x_frame_options_allow_from_url = x_frame_options_allow_from_url 509 510 def to_dict(self): 511 """Returns the model properties as a dict""" 512 result = {} 513 514 for attr, _ in six.iteritems(self.swagger_types): 515 value = getattr(self, attr) 516 if isinstance(value, list): 517 result[attr] = list(map( 518 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 519 value 520 )) 521 elif hasattr(value, "to_dict"): 522 result[attr] = value.to_dict() 523 elif isinstance(value, dict): 524 result[attr] = dict(map( 525 lambda item: (item[0], item[1].to_dict()) 526 if hasattr(item[1], "to_dict") else item, 527 value.items() 528 )) 529 else: 530 result[attr] = value 531 if issubclass(RecipientViewRequest, dict): 532 for key, value in self.items(): 533 result[key] = value 534 535 return result 536 537 def to_str(self): 538 """Returns the string representation of the model""" 539 return pprint.pformat(self.to_dict()) 540 541 def __repr__(self): 542 """For `print` and `pprint`""" 543 return self.to_str() 544 545 def __eq__(self, other): 546 """Returns true if both objects are equal""" 547 if not isinstance(other, RecipientViewRequest): 548 return False 549 550 return self.to_dict() == other.to_dict() 551 552 def __ne__(self, other): 553 """Returns true if both objects are not equal""" 554 if not isinstance(other, RecipientViewRequest): 555 return True 556 557 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.
76 def __init__(self, _configuration=None, **kwargs): # noqa: E501 77 """RecipientViewRequest - a model defined in Swagger""" # noqa: E501 78 if _configuration is None: 79 _configuration = Configuration() 80 self._configuration = _configuration 81 82 self._assertion_id = None 83 self._authentication_instant = None 84 self._authentication_method = None 85 self._client_ur_ls = None 86 self._client_user_id = None 87 self._email = None 88 self._frame_ancestors = None 89 self._message_origins = None 90 self._ping_frequency = None 91 self._ping_url = None 92 self._recipient_id = None 93 self._return_url = None 94 self._security_domain = None 95 self._user_id = None 96 self._user_name = None 97 self._x_frame_options = None 98 self._x_frame_options_allow_from_url = None 99 self.discriminator = None 100 101 setattr(self, "_{}".format('assertion_id'), kwargs.get('assertion_id', None)) 102 setattr(self, "_{}".format('authentication_instant'), kwargs.get('authentication_instant', None)) 103 setattr(self, "_{}".format('authentication_method'), kwargs.get('authentication_method', None)) 104 setattr(self, "_{}".format('client_ur_ls'), kwargs.get('client_ur_ls', None)) 105 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 106 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 107 setattr(self, "_{}".format('frame_ancestors'), kwargs.get('frame_ancestors', None)) 108 setattr(self, "_{}".format('message_origins'), kwargs.get('message_origins', None)) 109 setattr(self, "_{}".format('ping_frequency'), kwargs.get('ping_frequency', None)) 110 setattr(self, "_{}".format('ping_url'), kwargs.get('ping_url', None)) 111 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 112 setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None)) 113 setattr(self, "_{}".format('security_domain'), kwargs.get('security_domain', None)) 114 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 115 setattr(self, "_{}".format('user_name'), kwargs.get('user_name', None)) 116 setattr(self, "_{}".format('x_frame_options'), kwargs.get('x_frame_options', None)) 117 setattr(self, "_{}".format('x_frame_options_allow_from_url'), kwargs.get('x_frame_options_allow_from_url', None))
RecipientViewRequest - a model defined in Swagger
Gets the assertion_id of this RecipientViewRequest. # noqa: E501
A unique identifier of the authentication event executed by the client application. # noqa: E501
Returns
The assertion_id of this RecipientViewRequest. # noqa: E501
Gets the authentication_instant of this RecipientViewRequest. # noqa: E501
A sender generated value that indicates the date/time that the signer was authenticated. # noqa: E501
Returns
The authentication_instant of this RecipientViewRequest. # noqa: E501
Gets the authentication_method of this RecipientViewRequest. # noqa: E501
A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion. # noqa: E501
Returns
The authentication_method of this RecipientViewRequest. # noqa: E501
Gets the client_ur_ls of this RecipientViewRequest. # noqa: E501
# noqa: E501
Returns
The client_ur_ls of this RecipientViewRequest. # noqa: E501
Gets the client_user_id of this RecipientViewRequest. # noqa: E501
A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters. # noqa: E501
Returns
The client_user_id of this RecipientViewRequest. # noqa: E501
Gets the email of this RecipientViewRequest. # noqa: E501
Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501
Returns
The email of this RecipientViewRequest. # noqa: E501
Gets the frame_ancestors of this RecipientViewRequest. # noqa: E501
# noqa: E501
Returns
The frame_ancestors of this RecipientViewRequest. # noqa: E501
Gets the message_origins of this RecipientViewRequest. # noqa: E501
# noqa: E501
Returns
The message_origins of this RecipientViewRequest. # noqa: E501
Gets the ping_frequency of this RecipientViewRequest. # noqa: E501
Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. # noqa: E501
Returns
The ping_frequency of this RecipientViewRequest. # noqa: E501
Gets the ping_url of this RecipientViewRequest. # noqa: E501
A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received. # noqa: E501
Returns
The ping_url of this RecipientViewRequest. # noqa: E501
Gets the recipient_id of this RecipientViewRequest. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this RecipientViewRequest. # noqa: E501
Gets the return_url of this RecipientViewRequest. # noqa: E501
The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. # noqa: E501
Returns
The return_url of this RecipientViewRequest. # noqa: E501
Gets the security_domain of this RecipientViewRequest. # noqa: E501
The domain in which the user authenticated. # noqa: E501
Returns
The security_domain of this RecipientViewRequest. # noqa: E501
Gets the user_id of this RecipientViewRequest. # noqa: E501
Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the userId
property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user. # noqa: E501
Returns
The user_id of this RecipientViewRequest. # noqa: E501
Gets the user_name of this RecipientViewRequest. # noqa: E501
Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient. # noqa: E501
Returns
The user_name of this RecipientViewRequest. # noqa: E501
Gets the x_frame_options of this RecipientViewRequest. # noqa: E501
# noqa: E501
Returns
The x_frame_options of this RecipientViewRequest. # noqa: E501
Gets the x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501
# noqa: E501
Returns
The x_frame_options_allow_from_url of this RecipientViewRequest. # noqa: E501
510 def to_dict(self): 511 """Returns the model properties as a dict""" 512 result = {} 513 514 for attr, _ in six.iteritems(self.swagger_types): 515 value = getattr(self, attr) 516 if isinstance(value, list): 517 result[attr] = list(map( 518 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 519 value 520 )) 521 elif hasattr(value, "to_dict"): 522 result[attr] = value.to_dict() 523 elif isinstance(value, dict): 524 result[attr] = dict(map( 525 lambda item: (item[0], item[1].to_dict()) 526 if hasattr(item[1], "to_dict") else item, 527 value.items() 528 )) 529 else: 530 result[attr] = value 531 if issubclass(RecipientViewRequest, dict): 532 for key, value in self.items(): 533 result[key] = value 534 535 return result
Returns the model properties as a dict