All notable changes will be documented in this file.
Updates should follow the Keep a CHANGELOG principles.
- Add
AccountBilling.automaticTagsPlacement
- Extend
EnvelopeRecipient
andEnvelopeTemplateRecipient
resource - Add
EnvelopeDocument.createTagsByAutoplacement
endpoint - Add
Webhook oAuth properties
- Add
ForbiddenException
- Add
AccountBilling.productType
- Add
EnvelopeTemplate.title
- Add
EnvelopesEndpoint.cancel
body - Fix
AccountUsersEndpoint.invite
endpoint - Add
MyIdentifications.info
endpoint - Add
EnvelopeRecipient.certificateInfo
endpoint - Add
EnvelopeProperties.channelForSender
in to resource - Edit
CertificateInfo
resource - Extend
Contact
resource - Extend
AccountBilling
resource with identify limits - Add
AccountBilling.userContactLimit
- Add
IdentifyScenarioVersion.restrictedCountries
- Add
EnvelopeTemplateDocumentAssignments
endpoint - Add
Envelope.createdBy
andEnvelope.sentBy
- Add
BatchSendings
andBatchSendingsItems
endpoints
- Add
EnvelopeTemplateRecipientDefaults.signDocumentsAtOnce
- Add
AccountSecurity.signDocumentsAtOnce
- Add
EnvelopeRecipient.signDocumentsAtOnce
- Add
EnvelopeTemplateRecipient.signDocumentsAtOnce
- Add
EnvelopeDocumentsEndpoint.invalidate
- Add
EnvelopeDocumentsEndpoint.restore
- Add
CompletedIdentificationReport.name
- Add
ReportEndpoint.completedIdentifications
endpoint andCompletedIdentificationReport
resource - Add
IdentificationResult
claims - Add
IdentificationsEndpoint.updateResult
- Add
SignatureScenarioVariant.signDocumentsAtOnce
- Add
EnvelopeTagsEndpoint.updateValues
endpoint - Add
EnvelopeDocument.assignments
to resource - Add
EnvelopeRecipient
signed document columns - Add
EnvelopeTagsByPlaceholder
endpoint
- Add
SentEnvelopeReport.bankIdSignCount
- Add
SentEnvelopeReport.bankIdIdentifyAmlCount
- Add
IdentificationEndpoint.delete
- Add
IdentifyScenarioVersion.expireAfterHours
- Add
IdentifyScenarioVersion.discardCompletedAfterDays
- Add AccountSecurity.discardedIdentificationRetention
- Add multiple Identifications endpoints
- Add
IdentificationInspection.claims
- Add
Identificaiton.cancelledAt
- Add
Identificaiton.discardedAt
- Add
Identification.result
and its sub-entities - Add
IdentificationsEndpoint.cancel
- Add
IdentificationsEndpoint.discard
- Add
IdentificationsEndpoint.restore
- Add
Identification.forReviewAt
- Add
EnvelopeRecipient.channelForNotifications
- Add
EnvelopeTemplateRecipient.channelForNotifications
- Add
DeactivateAccount
endpoint - Add
MyAccount.idpAlias
- Add
IdentifyScenarioInfo.approvalMode
- Add
Envelope.name
- Deprecate
Envelope.emailSubject
- Add
SentEnvelopeReport.sender
- Add
IdentifyScenarioVersion.selfieEnabled
- Add
AccountBilling.identifyAi
- Add
MyAccount.createdAt
- Add
MyContactsEndpoint
CRUD endpoints - Add
IdentifyScenarioVersion.ownConditions
- Add
MyAccount.shortName
- Add
MyEndpoint.info
endpoint andMyInfo
resource - Add
MyAccountEndpoint.switch
endpoint - Add
AccountSmsSendersEndpoint
andAccountSmsSender
resource - Add
envelopeAnonymizeRetention
andenvelopeAnonymizeGroups
toAccountSecurity
- Add
anonymizeAt
andanonymizedAt
toEnvelope
- Add anonymize action to
Envelope
- Add
AccountEmailSendersEndpoint
andAccountEmailSender
resource - Add
approvedAt
,deniedAt
anddenailMessage
toIdentification
- Add
Identification.approve
endpoint andIdentification.deny
endpoint - Add
notificationForSenderEmail
toAccountSettings
- Add
EnvelopeTag.format
,EnvelopeTag.dateOfSignature
,EnvelopeTemplateTag.format
- Add
ScenarioVersionInfo
toIdentification
- Add
EnvelopeTemplate.visibleFields
,EnvelopeTemplate.validatedFields
,EnvelopeTemplate.delegation
- Add
EnvelopeTemplate.signerDefaults
,EnvelopeTemplate.approverDefaults
,EnvelopeTemplate.ccDefaults
- Add
EnvelopeTemplateRecipientDefaults
- Change
EnvelopeDocument.file
to nullable - Change
EnvelopeRecipientAttachment.file
to nullable
- Add
AccountSecurity.auditLogDownloadDefaultUnchecked
- Add
AccountSettings.documentsMerging
- Add
MyEnvelope.subjectName
- Add
MyEnvelope.validTo
- Add
AccountIdentifyScenariosEndpoint
andIdentifyScenario
resource - Add
AccountIdentifyScenarioVersionsEndpoint
andIdentifyScenarioVersion
resource - Add
AccountSettings.identify
- Add multiple fields for
IdentifyScenarioVersion
- Add
IdentifyScenariosEndpoint.info
endpoint - Add
SignatureScenariosEndpoint.info
endpoint - Add scenario fields on
EnvelopeRecipient
andEnvelopeTemplateRecipient
andEnvelopeTemplate
- Modify and add various
SignatureScenarioVariant
fields - Add
IdentificationScenarioVersion.approvalMode
- Add
IdentificationInfo
resource andEnvelopeRecipient.identification
- Add
EnvelopeProperties.auditLogAvailableToAccountUsers
- Add
IdentificationInfo.approvalMode
- Add
EnvelopeRecipient.approvalMode
- Add
EnvelopeRecipient.approveDocumentsAtOnce
- Add
EnvelopeTemplateRecipient.approvalMode
- Add
EnvelopeTemplateRecipient.approveDocumentsAtOnce
- Change
Identification.envelope
from string to EnvelopeInfo
- Fix
MyEnelopeRecipient.intermediaryName
andMyEnvelopeRecipient.intermediaryEmail
type as nullable
- Add
EnvelopeRecipientIdentification.authorizedAt
- Add resource
Blame
- Add
Envelope.sender
- Add
Branding.signerReturnUrl
- Add
AccountEndpoint.manageBilling
- Add multiple fields for
AccountBilling
- Add identify field for
AccountBilling
- Add
IdentificationsEndpoint
andIdentification
resource - Add
AccountSignatureScenariosEndpoint
andSignatureScenario
resource - Add
AccountSignatureScenarioVersionsEndpoint
,SignatureScenarioVersion
andSignatureScenarioVariant
resource - Add
AccountSettings.signatureScenarios
- Add
AccountBilling.signatureScenarios
- Add
Account.sentWithSignatureScenarios
- Add
EnvelopeRecipientsEndpoint.scenario
endpoint
- Fix nullable type on
MyAccount.idpDomain
- Fix nullable type on
Branding.ownConditions
- Fix nullable type on
EnvelopeTemplateRecipient.intermediaryName
- Fix incorrect type on
EnvelopeTemplateTag.document
andEnvelopeTemlateTag.recipient
- Fix incorrect type on
AccountRequest.createdBy
- Fix incorrect type on
Certificate.expiresAt
- Added native types to all properties
- Replaced usage of dynamic properties with magic methods
- Removed support for older PHP versions (<8.0)
- Add new fields for IdentityProvider
- Add new field $userId for User
- Add new field $signatureValidity for EnvelopeDocument
- Add new field $height for EnvelopeTag and EnvelopeTemplateTag
- Add
EnvelopeTag.recipientClaim
,EnvelopeTemplateTag.recipientClaim
- Add new fields $identificationNumber, $address for
EnvelopeRecipient
andEnvelopeTemplateRecipient
- Add signatureImageContent endpoint to AccountMe
- Add new field $hasSignatureImage to User
- Add method BaseResource::links() that returns links
- Remove invalid fields on ListResource + fix tests
- Add new oidc fields for
AccountSecurity
resource - Add
Certificate.vaultName
,Certificate.certificateName
- Add
EnvelopeProperties.sendDocumentsAsEmailAttachment
- Add
EnvelopeProperties.generateSignatureSheet
- Add
EnvelopeProperties.auditLogAvailableToAllRecipients
- Add
EnvelopeRecipient.authFailedReason
- Update
EnvelopesEndpoint.discard
with body like discardAt param - Add new
EnvelopeDocumentSignatureSheets
resource and endpoint - Add my envelope info endpoint
- Add
AccountSettings.useEnvelopeDescription
,Envelope.description
andEnvelopeTemplate.description
- Add
User.autoscrollTags
- Add
AccountSecurity.discardedEnvelopeRetention
- Add
EnvelopeProperties.timestampDocuments
,EnvelopeProperties.timestampAuditlog
,EnvelopeProperties.timestampingAuthorities
,EnvelopeProperties.sendCompleted
- Add
AccountSecurity.continuousSigning
- Add
EnvelopeDocumentAssignmentsEndpoint
- Add
AccountBrandings
CRUD endpoint - Add
Envelope.branding
andEnvelopeTemplate.branding
- Add multiple fields for
Branding
- Add new
AccountMessaging
endpoint and resource - Add
Branding.ownConditions
- Add multiple fields for
AccountSettings
- Add new endpoint
EnvelopeRecipientEndpoint.listIdentifications
- Update VerifiedClaims resource
- Add
AccountRequest.requestTime|responseTime|duration
- Add
EnvelopeTag.renderInteractive
andEnvelopeTemplateTag.renderInteractive
- Add new fields for
AccountStatistics
andAccountSmsLog
- Add
EnvelopeEndpoint.startCorrection
andEnvelopeEndpoint.finishCorrection
- Add
EnvelopeRecipientTemplate.bankIdScopes
- Add emailBodyCompleted to four resources
- Add
ReportEndpoint.sentEnvelopes
- Add
EnvelopeDocumentsEndpoint.replaceFile
- Add
EnvelopeTemplateDocumentsEndpoint.replaceFile
- Add
EnvelopeProperties.labelPositioning
- Add
Envelope.sealedAt
- Fix hydration of nullable properties
- Change EnvelopeTemplateDocument.labelPositioning as not nullable
- Add
AccountCertificateEndpoint
andCertificate
resource - Add
Label
resource andLabelsEndpoint
- Add
EnvelopeLabelsEndpoint
- Add
EnvelopeRecipient.bankIdScopes
- Add
AccountCertificatesEndpoint.enable
andAccountCertificatesEndpoint.disable
- Add
EnvelopeTemplateLabelsEndpoint
- Add
EnvelopeEndpoint.discard
andEnvelopeEndpoint.restore
- Add
EnvelopeProperties.signatureTagParts
- Add
EnvelopesEndpoint.validate
- Replace fields
authenticationMethod
,authenticationPlace
andauthenticateOnDownload
withauthenticationOnOpen
,authenticationOnSignature
andauthenticationOnDownload
- Remove
AccountEnvelopeTemplate
, leave onlyEnvelopeTemplate
- Add
MyAccountsEndpoint.get
andMyAccount.idpDomain
- Add
IdentityProvider
resource andAccount.identityProvider
- Add
EnvelopesEndpoint.clone
- Add
EnvelopeProperties.declineAllowed
andEnvelopeProperties.declineReasonRequired
- Add
EnvelopeRecipient.declineReason
- Add
EnvelopeRecipientAttachment
resource - Add
EnvelopeRecipientEndpoint.attachments
- Add
EnvelopeRecipientAttachmentsEndpoint
- Add
EnvelopeDocumentsEndpoint.merge
- Add
EnvelopeTemplatesEndpoint.clone
- Add
AccountMeEndpoint.update
- Add
EnvelopeProperties
resource andEnvelope.properties
- Add
EnvelopeTemplateTag.assignment
+EnvelopeTemplateTag.EnvelopeRecipient
can be null - Add
EnvelopeTag.assignment
+EnvelopeTag.EnvelopeRecipient
can be null - Add
EnvelopeTemplate.useDefaultTemplateSettings
- Add
EnvelopeDocument.labelPositioning
,EnvelopeDocument.labelPositionX
,EnvelopeDocument.labelPositionY
, - Add
EnvelopeTemplateDocument.labelPositioning
,EnvelopeTemplateDocument.labelPositionX
,EnvelopeTemplateDocument.labelPositionY
, - Add
AccountSettings.bankIdSign
- Add
EnvelopeRecipient.intermediaryName
andEnvelopeRecipient.intermediaryEmail
- Add
EnvelopeTemplateRecipient.intermediaryName
andEnvelopeTemplateRecipient.intermediaryEmail
- Add
MyEnvelopeRecipient.intermediaryName
andMyEnvelopeRecipient.intermediaryEmail
- Add
AccountSecurity
endpoint and resource - Add new method
DigiSign::validateSignature
for validation of webhook signatures
- Add
EnvelopeTemplateDocument.positions
endpoint - Add Suggest Contact EP
GET /api/my/contacts/suggest
- Add
MyEnvelopeRecipient
authenticationMethod properties - Add
EnvelopeDocument.fromTemplate
- Add
EnvelopeRecipient.fromTemplate
- Add
EnvelopeTag.fromTemplate
- Add
MyEnvelope.senderEmail
- Add
MyEnvelopeRecipient.signatureType
- Add
EnvelopesEndpoint.template
- Add
EnvelopesEndpoint.embedSigning
- Add
EnvelopeTag.choice
andEnvelopeTag.group
- Add
EnvelopeTemplateTag.choice
andEnvelopeTemplateTag.group
- Allow setting auth_bearer via options
- Add body param for
EnvelopesEndpoint.embedEdit
- Add
use
forEnvelopeTemplateEndpoint
- Add
AccountSettings.bankIdProduct
- Add
EnvelopeTemplate.bankIdScopes
- Add new
EnumsEndpoint
- Add
EnvelopeTemplateDocumentsEndpoint::download
- Add
EnvelopeTag.scale
andEnvelopeTemplateTag.scale
- Add multiple fields to
EnvelopeTemplateRecipient
- Add
Envelope.template
- Add new endpoints
MyEndpoint
,MyDashboardEndpoint
,MyEnvelopesEndpoint
- Add new resources
MyDashboard
,MyEnvelope
,MyEnvelopeDocument
andMyEnvelopeRecipient
- Add new
MyAccount
endpoint and resource - Add
MyAccountsEndpoint.accept
endpoint - Add
MyAccountsEndpoint.decline
endpoint - Add
MyAccount.status
property - Add
AccountUsersEndpoint.reinvite
endpoint
- Add
final
to all resources
- Add PHP 7.2 compatibility
- Add
EnvelopeTag.width
- Add
EnvelopeTag.bankIdClaim
- Add
Envelope.sendCompleted
- Add
Envelope.timestampDocuments
- Add
EnvelopeTemplate.sendCompleted
- Add
EnvelopeTemplate.timestampDocuments
- Add
resend
forEnvelopesEndpoint
- Add new
EnvelopeTemplate
endpoints and resources
- Add new
WebhookAttemptsEndpoint
andWebhookAttempt
resource
- Add
Webhook.status
- Add
Webhook.secret
- Fix caching resolved mapping without subclass
- Fix nullable types on EnvelopeTag
Complete rewrite of library
see UPGRADING-1.0
- Add support of API EnvelopeNotification
- Add more tests for increase code coverage
- Fix RuntimeException Message Body
- Fixed UriResolver URI to https://api.digisign.org
- Add support of API Envelope, EnvelopeDocument, EnvelopeRecipient, EnvelopeTag
- Add support of API Delivery, DeliveryDocument, DeliveryRecipient
- Add support of API File, Account
- Add AuthProvider with AuthTokenProviderInterface
- Add new IriTemplate and Iri classes to improve work with IRIs
- Add more implementations of Iri, Add abstract ResourceIri to simplify Iri classes
- Add more tests for increase code coverage