Skip to content

Commit ef654ba

Browse files
authored
Merge pull request #62 from dvargas92495/signer_types
Adding types for signer related fields
2 parents d59a1b6 + a2c6577 commit ef654ba

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

typings/index.d.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -782,9 +782,12 @@ declare module 'eversign/lib/Signer' {
782782
class Signer {
783783
constructor(signerObject?: Partial<Signer.IObject>)
784784
getDeclined(): boolean
785+
getDeliverEmail(): boolean
785786
getEmail(): string
786787
getEmbeddedSigningUrl(): string
787788
getId(): number
789+
getLanguage(): string
790+
getMessage(): string
788791
getName(): string
789792
getOrder(): number
790793
getPin(): number
@@ -793,12 +796,18 @@ declare module 'eversign/lib/Signer' {
793796
getSent(): boolean
794797
getSigned(): boolean
795798
getSignedTimestamp(): number
799+
getSignerAuthenticationSmsEnabled(): boolean
800+
getSignerAuthenticationPhoneNumber(): string
796801
getSigningUrl(): string
797802
getStatus(): Signer.STATUS
798803
getViewed(): boolean
799804
setDeclined(newDeclined: boolean): void
805+
setDeliverEmail(newDeliverEmail: string): void
800806
setEmail(newEmail: string): void
807+
setEmbeddedSigningUrl(newEmbeddedSigningUrl: string): void
801808
setId(newId: number): void
809+
setLanguage(newLanguage: string): void
810+
setMessage(newMessage: string): void
802811
setName(newName: string): void
803812
setOrder(newOrder: number): void
804813
setPin(newPin: number): void
@@ -807,6 +816,8 @@ declare module 'eversign/lib/Signer' {
807816
setSent(newSent: boolean): void
808817
setSigned(newSigned: boolean): void
809818
setSignedTimestamp(newSignedTimstamp: number): void
819+
setSignerAuthenticationPhoneNumber(newSignerAuthenticationPhoneNumber: string): void
820+
setSignerAuthenticationSmsEnabled(newSignerAuthenticationSmsEnabled: string): void
810821
setSigningUrl(newSigningUrl: string): void
811822
setStatus(newStatus: Signer.STATUS): void
812823
setViewed(newViewed: boolean): void
@@ -895,6 +906,27 @@ declare module 'eversign/lib/Signer' {
895906
* the embedded/iframe signing url
896907
*/
897908
embeddedSigningUrl: string,
909+
/**
910+
* This parameter is only applicable if embedded_signing_enabled is set to 1.
911+
* When this parameter is set, embedded document signers will be notified by email.
912+
*/
913+
deliverEmail: boolean,
914+
/**
915+
* This parameter is used to specify if signer authentication by SMS is enabled.
916+
*/
917+
signerAuthenticationSmsEnabled: boolean,
918+
/**
919+
* If signer authentication by SMS is enabled, this parameter is used to specify the phone number to which SMS validation will be delivered. ITU call prefix can start both with 00 or + sign.
920+
*/
921+
signerAuthenticationPhoneNumber: string,
922+
/**
923+
* This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overriden by this parameter.
924+
*/
925+
message: string,
926+
/**
927+
* This parameter is used to specify the language in which signing notifications (emails), the document status page and the signature process will appear for this signer.
928+
*/
929+
language: undefined,
898930
}
899931
}
900932

0 commit comments

Comments
 (0)