/// <summary> /// Initializes a new instance of the <see cref="TemplateRole" /> class. /// </summary> /// <param name="AccessCode">If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..</param> /// <param name="ClientUserId">Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .</param> /// <param name="DefaultRecipient">When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient..</param> /// <param name="Email">Specifies the email associated with a role name..</param> /// <param name="EmailNotification">EmailNotification.</param> /// <param name="EmbeddedRecipientStartURL">Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .</param> /// <param name="InPersonSignerName">Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters..</param> /// <param name="Name">Specifies the recipient's name..</param> /// <param name="RecipientSignatureProviders">.</param> /// <param name="RoleName">Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..</param> /// <param name="RoutingOrder">Specifies the routing order of the recipient in the envelope. .</param> /// <param name="SigningGroupId">When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..</param> /// <param name="Tabs">Tabs.</param> public TemplateRole(string AccessCode = default(string), string ClientUserId = default(string), string DefaultRecipient = default(string), string Email = default(string), RecipientEmailNotification EmailNotification = default(RecipientEmailNotification), string EmbeddedRecipientStartURL = default(string), string InPersonSignerName = default(string), string Name = default(string), List <RecipientSignatureProvider> RecipientSignatureProviders = default(List <RecipientSignatureProvider>), string RoleName = default(string), string RoutingOrder = default(string), string SigningGroupId = default(string), Tabs Tabs = default(Tabs)) { this.AccessCode = AccessCode; this.ClientUserId = ClientUserId; this.DefaultRecipient = DefaultRecipient; this.Email = Email; this.EmailNotification = EmailNotification; this.EmbeddedRecipientStartURL = EmbeddedRecipientStartURL; this.InPersonSignerName = InPersonSignerName; this.Name = Name; this.RecipientSignatureProviders = RecipientSignatureProviders; this.RoleName = RoleName; this.RoutingOrder = RoutingOrder; this.SigningGroupId = SigningGroupId; this.Tabs = Tabs; }
/// <summary> /// Initializes a new instance of the <see cref="BulkSendingCopyRecipient" /> class. /// </summary> /// <param name="AccessCode">If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..</param> /// <param name="ClientUserId">Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .</param> /// <param name="CustomFields">An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..</param> /// <param name="DeliveryMethod">Reserved: For DocuSign use only..</param> /// <param name="Email">.</param> /// <param name="EmailNotification">EmailNotification.</param> /// <param name="EmbeddedRecipientStartURL">Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .</param> /// <param name="FaxNumber">Reserved:.</param> /// <param name="IdCheckConfigurationName">Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node..</param> /// <param name="IdCheckInformationInput">IdCheckInformationInput.</param> /// <param name="IdentificationMethod">.</param> /// <param name="Name">.</param> /// <param name="Note">Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters..</param> /// <param name="PhoneAuthentication">PhoneAuthentication.</param> /// <param name="RecipientId">Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..</param> /// <param name="RecipientSignatureProviders">.</param> /// <param name="RoleName">Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..</param> /// <param name="SmsAuthentication">SmsAuthentication.</param> /// <param name="SocialAuthentications"> Lists the social ID type that can be used for recipient authentication..</param> /// <param name="Tabs">.</param> public BulkSendingCopyRecipient(string AccessCode = default(string), string ClientUserId = default(string), List <string> CustomFields = default(List <string>), string DeliveryMethod = default(string), string Email = default(string), RecipientEmailNotification EmailNotification = default(RecipientEmailNotification), string EmbeddedRecipientStartURL = default(string), string FaxNumber = default(string), string IdCheckConfigurationName = default(string), IdCheckInformationInput IdCheckInformationInput = default(IdCheckInformationInput), string IdentificationMethod = default(string), string Name = default(string), string Note = default(string), RecipientPhoneAuthentication PhoneAuthentication = default(RecipientPhoneAuthentication), string RecipientId = default(string), List <RecipientSignatureProvider> RecipientSignatureProviders = default(List <RecipientSignatureProvider>), string RoleName = default(string), RecipientSMSAuthentication SmsAuthentication = default(RecipientSMSAuthentication), List <SocialAuthentication> SocialAuthentications = default(List <SocialAuthentication>), List <BulkSendingCopyTab> Tabs = default(List <BulkSendingCopyTab>)) { this.AccessCode = AccessCode; this.ClientUserId = ClientUserId; this.CustomFields = CustomFields; this.DeliveryMethod = DeliveryMethod; this.Email = Email; this.EmailNotification = EmailNotification; this.EmbeddedRecipientStartURL = EmbeddedRecipientStartURL; this.FaxNumber = FaxNumber; this.IdCheckConfigurationName = IdCheckConfigurationName; this.IdCheckInformationInput = IdCheckInformationInput; this.IdentificationMethod = IdentificationMethod; this.Name = Name; this.Note = Note; this.PhoneAuthentication = PhoneAuthentication; this.RecipientId = RecipientId; this.RecipientSignatureProviders = RecipientSignatureProviders; this.RoleName = RoleName; this.SmsAuthentication = SmsAuthentication; this.SocialAuthentications = SocialAuthentications; this.Tabs = Tabs; }