Current section
Files
Jump to
Current section
Files
lib/docusign/model/envelope_definition.ex
# NOTE: This file is auto generated by OpenAPI Generator
# https://openapi-generator.tech
# Do not edit this file manually.
defmodule DocuSign.Model.EnvelopeDefinition do
@moduledoc """
Envelope object definition.
"""
alias DocuSign.Deserializer
alias DocuSign.Model.AccountCustomFields
alias DocuSign.Model.Attachment
alias DocuSign.Model.CompositeTemplate
alias DocuSign.Model.Document
alias DocuSign.Model.EmailSettings
alias DocuSign.Model.EnvelopeCustomMetadata
alias DocuSign.Model.EnvelopeDocument
alias DocuSign.Model.EnvelopeLocks
alias DocuSign.Model.EnvelopeMetadata
alias DocuSign.Model.EnvelopeRecipients
alias DocuSign.Model.EventNotification
alias DocuSign.Model.Folder
alias DocuSign.Model.Notification
alias DocuSign.Model.PowerForm
alias DocuSign.Model.RecipientViewRequest
alias DocuSign.Model.TemplateRole
alias DocuSign.Model.UserInfo
alias DocuSign.Model.Workflow
defstruct [
:accessControlListBase64,
:accessibility,
:allowComments,
:allowMarkup,
:allowReassign,
:allowRecipientRecursion,
:allowViewHistory,
:anySigner,
:asynchronous,
:attachments,
:attachmentsUri,
:authoritativeCopy,
:authoritativeCopyDefault,
:autoNavigation,
:brandId,
:brandLock,
:burnDefaultTabData,
:certificateUri,
:completedDateTime,
:compositeTemplates,
:copyRecipientData,
:createdDateTime,
:customFields,
:customFieldsUri,
:declinedDateTime,
:deletedDateTime,
:deliveredDateTime,
:disableResponsiveDocument,
:documentBase64,
:documents,
:documentsCombinedUri,
:documentsUri,
:emailBlurb,
:emailSettings,
:emailSubject,
:enableWetSign,
:enforceSignerVisibility,
:envelopeAttachments,
:envelopeCustomMetadata,
:envelopeDocuments,
:envelopeId,
:envelopeIdStamping,
:envelopeLocation,
:envelopeMetadata,
:envelopeUri,
:eventNotification,
:expireAfter,
:expireDateTime,
:expireEnabled,
:externalEnvelopeId,
:folders,
:hasComments,
:hasFormDataChanged,
:hasWavFile,
:holder,
:initialSentDateTime,
:is21CFRPart11,
:isDynamicEnvelope,
:isSignatureProviderEnvelope,
:lastModifiedDateTime,
:location,
:lockInformation,
:messageLock,
:notification,
:notificationUri,
:password,
:powerForm,
:purgeCompletedDate,
:purgeRequestDate,
:purgeState,
:recipientViewRequest,
:recipients,
:recipientsLock,
:recipientsUri,
:sender,
:sentDateTime,
:signerCanSignOnMobile,
:signingLocation,
:status,
:statusChangedDateTime,
:statusDateTime,
:templateId,
:templateRoles,
:templatesUri,
:transactionId,
:uSigState,
:useDisclosure,
:voidedDateTime,
:voidedReason,
:workflow
]
@doc false
defimpl Jason.Encoder, for: __MODULE__ do
def encode(struct, opts) do
struct
|> Map.from_struct()
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
|> Map.new()
|> Jason.Encode.map(opts)
end
end
@type t :: %__MODULE__{
:accessControlListBase64 => String.t() | nil,
:accessibility => String.t() | nil,
:allowComments => String.t() | nil,
:allowMarkup => String.t() | nil,
:allowReassign => String.t() | nil,
:allowRecipientRecursion => String.t() | nil,
:allowViewHistory => String.t() | nil,
:anySigner => String.t() | nil,
:asynchronous => String.t() | nil,
:attachments => [Attachment.t()] | nil,
:attachmentsUri => String.t() | nil,
:authoritativeCopy => String.t() | nil,
:authoritativeCopyDefault => String.t() | nil,
:autoNavigation => String.t() | nil,
:brandId => String.t() | nil,
:brandLock => String.t() | nil,
:burnDefaultTabData => String.t() | nil,
:certificateUri => String.t() | nil,
:completedDateTime => String.t() | nil,
:compositeTemplates => [CompositeTemplate.t()] | nil,
:copyRecipientData => String.t() | nil,
:createdDateTime => String.t() | nil,
:customFields => AccountCustomFields.t() | nil,
:customFieldsUri => String.t() | nil,
:declinedDateTime => String.t() | nil,
:deletedDateTime => String.t() | nil,
:deliveredDateTime => String.t() | nil,
:disableResponsiveDocument => String.t() | nil,
:documentBase64 => String.t() | nil,
:documents => [Document.t()] | nil,
:documentsCombinedUri => String.t() | nil,
:documentsUri => String.t() | nil,
:emailBlurb => String.t() | nil,
:emailSettings => EmailSettings.t() | nil,
:emailSubject => String.t() | nil,
:enableWetSign => String.t() | nil,
:enforceSignerVisibility => String.t() | nil,
:envelopeAttachments => [Attachment.t()] | nil,
:envelopeCustomMetadata => EnvelopeCustomMetadata.t() | nil,
:envelopeDocuments => [EnvelopeDocument.t()] | nil,
:envelopeId => String.t() | nil,
:envelopeIdStamping => String.t() | nil,
:envelopeLocation => String.t() | nil,
:envelopeMetadata => EnvelopeMetadata.t() | nil,
:envelopeUri => String.t() | nil,
:eventNotification => EventNotification.t() | nil,
:expireAfter => String.t() | nil,
:expireDateTime => String.t() | nil,
:expireEnabled => String.t() | nil,
:externalEnvelopeId => String.t() | nil,
:folders => [Folder.t()] | nil,
:hasComments => String.t() | nil,
:hasFormDataChanged => String.t() | nil,
:hasWavFile => String.t() | nil,
:holder => String.t() | nil,
:initialSentDateTime => String.t() | nil,
:is21CFRPart11 => String.t() | nil,
:isDynamicEnvelope => String.t() | nil,
:isSignatureProviderEnvelope => String.t() | nil,
:lastModifiedDateTime => String.t() | nil,
:location => String.t() | nil,
:lockInformation => EnvelopeLocks.t() | nil,
:messageLock => String.t() | nil,
:notification => Notification.t() | nil,
:notificationUri => String.t() | nil,
:password => String.t() | nil,
:powerForm => PowerForm.t() | nil,
:purgeCompletedDate => String.t() | nil,
:purgeRequestDate => String.t() | nil,
:purgeState => String.t() | nil,
:recipientViewRequest => RecipientViewRequest.t() | nil,
:recipients => EnvelopeRecipients.t() | nil,
:recipientsLock => String.t() | nil,
:recipientsUri => String.t() | nil,
:sender => UserInfo.t() | nil,
:sentDateTime => String.t() | nil,
:signerCanSignOnMobile => String.t() | nil,
:signingLocation => String.t() | nil,
:status => String.t() | nil,
:statusChangedDateTime => String.t() | nil,
:statusDateTime => String.t() | nil,
:templateId => String.t() | nil,
:templateRoles => [TemplateRole.t()] | nil,
:templatesUri => String.t() | nil,
:transactionId => String.t() | nil,
:uSigState => String.t() | nil,
:useDisclosure => String.t() | nil,
:voidedDateTime => String.t() | nil,
:voidedReason => String.t() | nil,
:workflow => Workflow.t() | nil
}
def decode(value) do
value
|> Deserializer.deserialize(
:attachments,
:list,
Attachment
)
|> Deserializer.deserialize(
:compositeTemplates,
:list,
CompositeTemplate
)
|> Deserializer.deserialize(
:customFields,
:struct,
AccountCustomFields
)
|> Deserializer.deserialize(
:documents,
:list,
Document
)
|> Deserializer.deserialize(
:emailSettings,
:struct,
EmailSettings
)
|> Deserializer.deserialize(
:envelopeAttachments,
:list,
Attachment
)
|> Deserializer.deserialize(
:envelopeCustomMetadata,
:struct,
EnvelopeCustomMetadata
)
|> Deserializer.deserialize(
:envelopeDocuments,
:list,
EnvelopeDocument
)
|> Deserializer.deserialize(
:envelopeMetadata,
:struct,
EnvelopeMetadata
)
|> Deserializer.deserialize(
:eventNotification,
:struct,
EventNotification
)
|> Deserializer.deserialize(
:folders,
:list,
Folder
)
|> Deserializer.deserialize(
:lockInformation,
:struct,
EnvelopeLocks
)
|> Deserializer.deserialize(
:notification,
:struct,
Notification
)
|> Deserializer.deserialize(
:powerForm,
:struct,
PowerForm
)
|> Deserializer.deserialize(
:recipients,
:struct,
EnvelopeRecipients
)
|> Deserializer.deserialize(
:recipientViewRequest,
:struct,
RecipientViewRequest
)
|> Deserializer.deserialize(
:sender,
:struct,
UserInfo
)
|> Deserializer.deserialize(
:templateRoles,
:list,
TemplateRole
)
|> Deserializer.deserialize(
:workflow,
:struct,
Workflow
)
|> then(&struct(__MODULE__, &1))
end
end