Current section
Files
Jump to
Current section
Files
lib/docusign/model/in_person_signer.ex
# NOTE: This file is auto generated by OpenAPI Generator 7.12.0 (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule DocuSign.Model.InPersonSigner do
@moduledoc """
Contains information about an in-person recipient. This is a Docusign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [EnvelopeRecipients resource][resource]. [resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient
"""
alias DocuSign.Deserializer
alias DocuSign.Model.AuthenticationStatus
alias DocuSign.Model.DocumentVisibility
alias DocuSign.Model.EnvelopeRecipientTabs
alias DocuSign.Model.ErrorDetails
alias DocuSign.Model.FeatureAvailableMetadata
alias DocuSign.Model.IdCheckInformationInput
alias DocuSign.Model.NotaryHost
alias DocuSign.Model.OfflineAttributes
alias DocuSign.Model.PropertyMetadata
alias DocuSign.Model.RecipientAttachment
alias DocuSign.Model.RecipientEmailNotification
alias DocuSign.Model.RecipientIdentityVerification
alias DocuSign.Model.RecipientPhoneAuthentication
alias DocuSign.Model.RecipientSignatureInformation
alias DocuSign.Model.RecipientSignatureProvider
alias DocuSign.Model.RecipientSmsAuthentication
alias DocuSign.Model.SocialAuthentication
alias DocuSign.Model.UserInfo
@derive Jason.Encoder
defstruct [
:accessCode,
:accessCodeMetadata,
:addAccessCodeToEmail,
:allowSystemOverrideForLockedRecipient,
:autoNavigation,
:autoRespondedReason,
:bulkSendV2Recipient,
:canSignOffline,
:clientUserId,
:completedCount,
:creationReason,
:customFields,
:declinedDateTime,
:declinedReason,
:defaultRecipient,
:deliveredDateTime,
:deliveryMethod,
:deliveryMethodMetadata,
:designatorId,
:designatorIdGuid,
:documentTemplateId,
:documentVisibility,
:email,
:emailMetadata,
:emailNotification,
:embeddedRecipientStartURL,
:errorDetails,
:excludedDocuments,
:faxNumber,
:faxNumberMetadata,
:hostEmail,
:hostEmailMetadata,
:hostName,
:hostNameMetadata,
:idCheckConfigurationName,
:idCheckConfigurationNameMetadata,
:idCheckInformationInput,
:identityVerification,
:inPersonSigningType,
:inPersonSigningTypeMetadata,
:inheritEmailNotificationConfiguration,
:lockedRecipientPhoneAuthEditable,
:lockedRecipientSmsEditable,
:name,
:nameMetadata,
:notaryHost,
:notaryId,
:note,
:noteMetadata,
:offlineAttributes,
:phoneAuthentication,
:recipientAttachments,
:recipientAuthenticationStatus,
:recipientFeatureMetadata,
:recipientId,
:recipientIdGuid,
:recipientSignatureProviders,
:recipientSuppliesTabs,
:recipientType,
:recipientTypeMetadata,
:requireIdLookup,
:requireIdLookupMetadata,
:requireSignOnPaper,
:requireSignerCertificate,
:requireUploadSignature,
:roleName,
:routingOrder,
:routingOrderMetadata,
:sentDateTime,
:signInEachLocation,
:signInEachLocationMetadata,
:signatureInfo,
:signedDateTime,
:signerEmail,
:signerEmailMetadata,
:signerFirstName,
:signerFirstNameMetadata,
:signerLastName,
:signerLastNameMetadata,
:signerName,
:signerNameMetadata,
:signingGroupId,
:signingGroupIdMetadata,
:signingGroupName,
:signingGroupUsers,
:smsAuthentication,
:socialAuthentications,
:status,
:statusCode,
:suppressEmails,
:tabs,
:templateLocked,
:templateRequired,
:totalTabCount,
:userId,
:webFormRecipientViewId
]
@type t :: %__MODULE__{
:accessCode => String.t() | nil,
:accessCodeMetadata => PropertyMetadata.t() | nil,
:addAccessCodeToEmail => String.t() | nil,
:allowSystemOverrideForLockedRecipient => String.t() | nil,
:autoNavigation => String.t() | nil,
:autoRespondedReason => String.t() | nil,
:bulkSendV2Recipient => String.t() | nil,
:canSignOffline => String.t() | nil,
:clientUserId => String.t() | nil,
:completedCount => String.t() | nil,
:creationReason => String.t() | nil,
:customFields => [String.t()] | nil,
:declinedDateTime => String.t() | nil,
:declinedReason => String.t() | nil,
:defaultRecipient => String.t() | nil,
:deliveredDateTime => String.t() | nil,
:deliveryMethod => String.t() | nil,
:deliveryMethodMetadata => PropertyMetadata.t() | nil,
:designatorId => String.t() | nil,
:designatorIdGuid => String.t() | nil,
:documentTemplateId => String.t() | nil,
:documentVisibility => [DocumentVisibility.t()] | nil,
:email => String.t() | nil,
:emailMetadata => PropertyMetadata.t() | nil,
:emailNotification => RecipientEmailNotification.t() | nil,
:embeddedRecipientStartURL => String.t() | nil,
:errorDetails => ErrorDetails.t() | nil,
:excludedDocuments => [String.t()] | nil,
:faxNumber => String.t() | nil,
:faxNumberMetadata => PropertyMetadata.t() | nil,
:hostEmail => String.t() | nil,
:hostEmailMetadata => PropertyMetadata.t() | nil,
:hostName => String.t() | nil,
:hostNameMetadata => PropertyMetadata.t() | nil,
:idCheckConfigurationName => String.t() | nil,
:idCheckConfigurationNameMetadata => PropertyMetadata.t() | nil,
:idCheckInformationInput => IdCheckInformationInput.t() | nil,
:identityVerification => RecipientIdentityVerification.t() | nil,
:inPersonSigningType => String.t() | nil,
:inPersonSigningTypeMetadata => PropertyMetadata.t() | nil,
:inheritEmailNotificationConfiguration => String.t() | nil,
:lockedRecipientPhoneAuthEditable => String.t() | nil,
:lockedRecipientSmsEditable => String.t() | nil,
:name => String.t() | nil,
:nameMetadata => PropertyMetadata.t() | nil,
:notaryHost => NotaryHost.t() | nil,
:notaryId => String.t() | nil,
:note => String.t() | nil,
:noteMetadata => PropertyMetadata.t() | nil,
:offlineAttributes => OfflineAttributes.t() | nil,
:phoneAuthentication => RecipientPhoneAuthentication.t() | nil,
:recipientAttachments => [RecipientAttachment.t()] | nil,
:recipientAuthenticationStatus => AuthenticationStatus.t() | nil,
:recipientFeatureMetadata => [FeatureAvailableMetadata.t()] | nil,
:recipientId => String.t() | nil,
:recipientIdGuid => String.t() | nil,
:recipientSignatureProviders => [RecipientSignatureProvider.t()] | nil,
:recipientSuppliesTabs => String.t() | nil,
:recipientType => String.t() | nil,
:recipientTypeMetadata => PropertyMetadata.t() | nil,
:requireIdLookup => String.t() | nil,
:requireIdLookupMetadata => PropertyMetadata.t() | nil,
:requireSignOnPaper => String.t() | nil,
:requireSignerCertificate => String.t() | nil,
:requireUploadSignature => String.t() | nil,
:roleName => String.t() | nil,
:routingOrder => String.t() | nil,
:routingOrderMetadata => PropertyMetadata.t() | nil,
:sentDateTime => String.t() | nil,
:signInEachLocation => String.t() | nil,
:signInEachLocationMetadata => PropertyMetadata.t() | nil,
:signatureInfo => RecipientSignatureInformation.t() | nil,
:signedDateTime => String.t() | nil,
:signerEmail => String.t() | nil,
:signerEmailMetadata => PropertyMetadata.t() | nil,
:signerFirstName => String.t() | nil,
:signerFirstNameMetadata => PropertyMetadata.t() | nil,
:signerLastName => String.t() | nil,
:signerLastNameMetadata => PropertyMetadata.t() | nil,
:signerName => String.t() | nil,
:signerNameMetadata => PropertyMetadata.t() | nil,
:signingGroupId => String.t() | nil,
:signingGroupIdMetadata => PropertyMetadata.t() | nil,
:signingGroupName => String.t() | nil,
:signingGroupUsers => [UserInfo.t()] | nil,
:smsAuthentication => RecipientSmsAuthentication.t() | nil,
:socialAuthentications => [SocialAuthentication.t()] | nil,
:status => String.t() | nil,
:statusCode => String.t() | nil,
:suppressEmails => String.t() | nil,
:tabs => EnvelopeRecipientTabs.t() | nil,
:templateLocked => String.t() | nil,
:templateRequired => String.t() | nil,
:totalTabCount => String.t() | nil,
:userId => String.t() | nil,
:webFormRecipientViewId => String.t() | nil
}
def decode(value) do
value
|> Deserializer.deserialize(:accessCodeMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:deliveryMethodMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:documentVisibility, :list, DocumentVisibility)
|> Deserializer.deserialize(:emailMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:emailNotification,
:struct,
RecipientEmailNotification
)
|> Deserializer.deserialize(:errorDetails, :struct, ErrorDetails)
|> Deserializer.deserialize(:faxNumberMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:hostEmailMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:hostNameMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:idCheckConfigurationNameMetadata,
:struct,
PropertyMetadata
)
|> Deserializer.deserialize(
:idCheckInformationInput,
:struct,
IdCheckInformationInput
)
|> Deserializer.deserialize(
:identityVerification,
:struct,
RecipientIdentityVerification
)
|> Deserializer.deserialize(
:inPersonSigningTypeMetadata,
:struct,
PropertyMetadata
)
|> Deserializer.deserialize(:nameMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:notaryHost, :struct, NotaryHost)
|> Deserializer.deserialize(:noteMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:offlineAttributes, :struct, OfflineAttributes)
|> Deserializer.deserialize(
:phoneAuthentication,
:struct,
RecipientPhoneAuthentication
)
|> Deserializer.deserialize(:recipientAttachments, :list, RecipientAttachment)
|> Deserializer.deserialize(
:recipientAuthenticationStatus,
:struct,
AuthenticationStatus
)
|> Deserializer.deserialize(
:recipientFeatureMetadata,
:list,
FeatureAvailableMetadata
)
|> Deserializer.deserialize(
:recipientSignatureProviders,
:list,
RecipientSignatureProvider
)
|> Deserializer.deserialize(:recipientTypeMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:requireIdLookupMetadata,
:struct,
PropertyMetadata
)
|> Deserializer.deserialize(:routingOrderMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:signatureInfo,
:struct,
RecipientSignatureInformation
)
|> Deserializer.deserialize(:signerEmailMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:signerFirstNameMetadata,
:struct,
PropertyMetadata
)
|> Deserializer.deserialize(:signerLastNameMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:signerNameMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(
:signInEachLocationMetadata,
:struct,
PropertyMetadata
)
|> Deserializer.deserialize(:signingGroupIdMetadata, :struct, PropertyMetadata)
|> Deserializer.deserialize(:signingGroupUsers, :list, UserInfo)
|> Deserializer.deserialize(
:smsAuthentication,
:struct,
RecipientSmsAuthentication
)
|> Deserializer.deserialize(
:socialAuthentications,
:list,
SocialAuthentication
)
|> Deserializer.deserialize(:tabs, :struct, EnvelopeRecipientTabs)
end
end