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