model

package
v1.1.19 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 26, 2024 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuditTrail added in v1.0.1 

type AuditTrail struct {
	Id        string `json:"id"`
	Name      string `json:"name"`
	Email     string `json:"email"`
	ToName    string `json:"toName"`
	ToEmail   string `json:"toEmail"`
	Ipaddress string `json:"ipaddress"`
	Action    string `json:"action"`
	Timestamp int    `json:"timestamp"`
}

type DocumentCC added in v1.0.1 

type DocumentCC struct {
	EmailAddress string `json:"emailAddress"`
}

func (*DocumentCC) GetEmailAddress added in v1.0.1 

func (s *DocumentCC) GetEmailAddress() string

type DocumentCcDetails added in v1.0.1 

type DocumentCcDetails struct {
	EmailAddress string `json:"emailAddress"`
	UserId       string `json:"userId"`
	IsViewed     bool   `json:"isViewed"`
}

func (*DocumentCcDetails) GetEmailAddress added in v1.0.1 

func (s *DocumentCcDetails) GetEmailAddress() string

type DocumentProperties added in v1.0.1 

type DocumentProperties struct {
	DocumentId          string                  `json:"documentId"`
	TemplateId          string                  `json:"templateId,omitempty"`
	BrandId             string                  `json:"brandId,omitempty"`
	MessageTitle        string                  `json:"messageTitle,omitempty"`
	DocumentDescription string                  `json:"documentDescription,omitempty"`
	Status              string                  `json:"status,omitempty"`
	Files               []File                  `json:"files,omitempty"`
	SenderDetail        SenderDetail            `json:"senderDetail,omitempty"`
	SignerDetails       []DocumentSignerDetails `json:"signerDetails,omitempty"`
	CcDetails           []DocumentCcDetails     `json:"ccDetails,omitempty"`
	ReminderSettings    ReminderSettings        `json:"reminderSettings,omitempty"`
	Reassign            []DocumentReassign      `json:"reassign,omitempty"`
	DocumentHistory     []AuditTrail            `json:"documentHistory,omitempty"`
	ActivityBy          string                  `json:"activityBy,omitempty"`
	ActivityDate        int                     `json:"activityDate,omitempty"`
	ActivityAction      string                  `json:"activityAction,omitempty"`
	CreatedDate         int                     `json:"createdDate,omitempty"`
	ExpiryDays          int                     `json:"expiryDays,omitempty"`
	ExpiryDate          int                     `json:"expiryDate,omitempty"`
	EnableSigningOrder  bool                    `json:"enableSigningOrder,omitempty"`
	IsDeleted           bool                    `json:"isDeleted,omitempty"`
	RevokeMessage       string                  `json:"revokeMessage,omitempty"`
	DeclineMessage      string                  `json:"declineMessage,omitempty"`
	ApplicationId       string                  `json:"applicationId,omitempty"`
	Labels              []string                `json:"labels,omitempty"`
	DisableEmails       bool                    `json:"disableEmails,omitempty"`
	EnablePrintAndSign  bool                    `json:"enablePrintAndSign,omitempty"`
	EnableReassign      bool                    `json:"enableReassign,omitempty"`
	DisableExpiryAlert  bool                    `json:"disableExpiryAlert,omitempty"`
	HideDocumentId      bool                    `json:"hideDocumentId,omitempty"`
	Roles               []TemplateRole          `json:"roles,omitempty,omitempty"`
	Description         string                  `json:"description,omitempty"`
	DocumentTitle       string                  `json:"documentTitle,omitempty"`
	DocumentMessage     string                  `json:"documentMessage,omitempty"`
	Title               string                  `json:"title,omitempty"`
}

type DocumentReassign added in v1.0.1 

type DocumentReassign struct {
	SignerEmail string `json:"signerEmail"`
	Order       int    `json:"order"`
	Message     string `json:"message"`
}

type DocumentSigner 

type DocumentSigner struct {
	Name         string `json:"name"`
	EmailAddress string `json:"emailAddress"`
	// PrivateMessage     string                   `field:"PrivateMessage"`
	// AuthenticationCode string                   `field:"AuthenticationCode"`
	SignerOrder int `json:"signerOrder"`
}

func (*DocumentSigner) GetEmailAddress 

func (s *DocumentSigner) GetEmailAddress() string

func (*DocumentSigner) GetName 

func (s *DocumentSigner) GetName() string

func (*DocumentSigner) GetSignerOrder added in v1.0.1 

func (s *DocumentSigner) GetSignerOrder() int

type DocumentSignerDetails added in v1.0.1 

type DocumentSignerDetails struct {
	SignerName             string                   `json:"signerName"`
	SignerRole             string                   `json:"signerRole"`
	SignerEmail            string                   `json:"signerEmail"`
	Status                 string                   `json:"status"`
	IsAuthenticationFailed bool                     `json:"isAuthenticationFailed"`
	EnableEmailOTP         bool                     `json:"enableEmailOTP"`
	IsDeliveryFailed       bool                     `json:"isDeliveryFailed"`
	IsViewed               bool                     `json:"isViewed"`
	Order                  int                      `json:"order"`
	SignerType             string                   `json:"signerType"`
	IsReassigned           bool                     `json:"isReassigned"`
	PrivateMessage         string                   `json:"privateMessage"`
	FormFields             []map[string]interface{} `json:"formFields"`
	HostEmail              string                   `json:"hostEmail"`
	HostName               string                   `json:"hostName"`
}

type EmbeddedDocumentRequest 

type EmbeddedDocumentRequest struct {
	Title                 string           `form_field:"Title"`
	Message               string           `form_field:"Message"`
	RedirectUrl           string           `form_field:"RedirectUrl"`
	Signers               []DocumentSigner `form_field:"Signers"`
	Files                 []string         `form_field:"Files"`
	EnableSigningOrder    bool             `form_field:"EnableSigningOrder"`
	SendViewOption        string           `form_field:"SendViewOption"`
	BrandId               string           `form_field:"BrandId"`
	OnBehalfOf            string           `form_field:"OnBehalfOf"`
	SendLinkValidTill     string           `form_field:"SendLinkValidTill"`
	ShowToolbar           bool             `form_field:"ShowToolbar"`
	ShowNavigationButtons bool             `form_field:"ShowNavigationButtons"`
	ShowSaveButton        bool             `form_field:"ShowSaveButton"`
	ShowPreviewButton     bool             `form_field:"ShowPreviewButton"`
	ShowSendButton        bool             `form_field:"ShowSendButton"`
	EnableReassign        bool             `form_field:"EnableReassign"`
	EnablePrintAndSign    bool             `form_field:"EnablePrintAndSign"`
	UseTextTags           bool             `form_field:"UseTextTags"`
	DisableExpiryAlert    bool             `form_field:"DisableExpiryAlert"`
	EnableEmbeddedSigning bool             `form_field:"EnableEmbeddedSigning"`
	HideDocumentId        bool             `form_field:"HideDocumentId"`
	DisableEmails         bool             `form_field:"DisableEmails"`
	ExpiryDays            int              `form_field:"ExpiryDays"`
	ReminderSettings      ReminderSettings `form_field:"ReminderSettings"`

	Description         string         `form_field:"Description"`
	DocumentTitle       string         `form_field:"DocumentTitle"`
	DocumentMessage     string         `form_field:"DocumentMessage"`
	ViewOption          string         `form_field:"ViewOption"`
	AllowNewFiles       bool           `form_field:"AllowNewFiles"`
	AllowModifyFiles    bool           `form_field:"AllowModifyFiles"`
	LinkValidTill       string         `form_field:"LinkValidTill"`
	ShowTooltip         bool           `form_field:"ShowTooltip"`
	AutoDetectFields    bool           `form_field:"autoDetectFields"`
	AllowMessageEditing bool           `form_field:"AllowMessageEditing"`
	Roles               []TemplateRole `form_field:"Roles" json:"roles,omitempty"`
	TemplateIds         []string       `form_field:"templateIds"`
}

func (*EmbeddedDocumentRequest) GetFiles 

func (e *EmbeddedDocumentRequest) GetFiles() []string

GetFile returns File

func (*EmbeddedDocumentRequest) GetMessage 

func (e *EmbeddedDocumentRequest) GetMessage() string

func (*EmbeddedDocumentRequest) GetRedirectUrl 

func (e *EmbeddedDocumentRequest) GetRedirectUrl() string

func (*EmbeddedDocumentRequest) GetRoles added in v1.1.13 

func (e *EmbeddedDocumentRequest) GetRoles() []TemplateRole

func (*EmbeddedDocumentRequest) GetSigners 

func (e *EmbeddedDocumentRequest) GetSigners() []DocumentSigner

GetSignerRoles returns Signers

func (*EmbeddedDocumentRequest) GetTemplateIds added in v1.1.18 

func (e *EmbeddedDocumentRequest) GetTemplateIds() []string

func (*EmbeddedDocumentRequest) GetTitle 

func (e *EmbeddedDocumentRequest) GetTitle() string

type EmbeddedSendCreated 

type EmbeddedSendCreated struct {
	DocumentId string `json:"documentId,omitempty"`
	SendUrl    string `json:"sendUrl,omitempty"`
}

func (*EmbeddedSendCreated) GetDocumentId 

func (e *EmbeddedSendCreated) GetDocumentId() string

GetDocumentId returns DocumentId

func (*EmbeddedSendCreated) GetSendUrl 

func (e *EmbeddedSendCreated) GetSendUrl() string

GetSendUrl returns SendUrl 

type EmbeddedSigningLink struct {
	SignLink string `json:"signLink"`
}
func (s *EmbeddedSigningLink) GetSignLink() string

type EmbeddedTemplateCreated added in v1.1.13 

type EmbeddedTemplateCreated struct {
	TemplateId string `json:"templateId,omitempty"`
	CreateUrl  string `json:"createUrl,omitempty"`
	EditUrl    string `json:"editUrl,omitempty"`
}

func (*EmbeddedTemplateCreated) GetCreateUrl added in v1.1.13 

func (e *EmbeddedTemplateCreated) GetCreateUrl() string

GetCreateUrl returns CreateUrl

func (*EmbeddedTemplateCreated) GetTemplateId added in v1.1.13 

func (e *EmbeddedTemplateCreated) GetTemplateId() string

GetTemplateId returns TemplateId

type ErrorResponse 

type ErrorResponse struct {
	Errors string `json:"errors"`
	Type   string `json:"type"`
	Title  string `json:"title"`
}

type Event added in v1.0.4 

type Event struct {
	Event *EventData          `json:"event"`
	Data  *DocumentProperties `json:"data"`
}

type EventData added in v1.0.4 

type EventData struct {
	Id        string `json:"id"`
	EventType string `json:"eventType"`
}

type File added in v1.0.1 

type File struct {
	DocumentName string `json:"documentName"`
	Order        int    `json:"order"`
	PageCount    int    `json:"pageCount"`
}

type ReminderSettings added in v1.0.1 

type ReminderSettings struct {
	EnableAutoReminder bool `json:"enableAutoReminder"`
	ReminderDays       int  `json:"reminderDays"`
	ReminderCount      int  `json:"reminderCount"`
}

type SenderCreateRequest added in v1.1.5 

type SenderCreateRequest struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

type SenderCreated added in v1.1.5 

type SenderCreated struct {
	ID string `json:"senderIdentityId"`
}

type SenderDetail added in v1.0.1 

type SenderDetail struct {
	Name           string `json:"name"`
	PrivateMessage string `json:"privateMessage"`
	EmailAddress   string `json:"emailAddress"`
	IsViewed       bool   `json:"isViewed"`
}

type SenderIdentities added in v1.1.6 

type SenderIdentities []SenderIdentityDetail

type SenderIdentitiesResponse added in v1.1.6 

type SenderIdentitiesResponse struct {
	Result      SenderIdentities       `json:"result"`
	PageDetails map[string]interface{} `json:"pageDetails"`
}

type SenderIdentityDetail added in v1.1.6 

type SenderIdentityDetail struct {
	Status       string `json:"status"`
	Name         string `json:"name"`
	Email        string `json:"email"`
	CreatedBy    string `json:"createdBy"`
	ApprovedDate string `json:"approvedDate"`
}

func (*SenderIdentityDetail) IsVerified added in v1.1.6 

func (s *SenderIdentityDetail) IsVerified() bool

type SenderUpdateRequest added in v1.1.5 

type SenderUpdateRequest struct {
	Name string `json:"name"`
}

type TemplateRole added in v1.1.13 

type TemplateRole struct {
	Name               string `json:"name,omitempty"`
	Index              int    `json:"index,omitempty"`
	DefaultSignerName  string `json:"defaultSignerName,omitempty"`
	DefaultSignerEmail string `json:"defaultSignerEmail,omitempty"`
	SignerOrder        int    `json:"signerOrder,omitempty"`
	SignerType         string `json:"signerType,omitempty"`
	RoleIndex          int    `json:"roleIndex,omitempty"`
	SignerName         string `json:"SignerName,omitempty"`
	SignerEmail        string `json:"SignerEmail,omitempty"`
	PrivateMessage     string `json:"privateMessage,omitempty"`
	AuthenticationCode string `json:"authenticationCode,omitempty"`
	EnableEmailOTP     bool   `json:"enableEmailOTP,omitempty"`
	SignerRole         string `json:"signerRole,omitempty"`
}

func (*TemplateRole) GetDefaultSignerEmail added in v1.1.14 

func (s *TemplateRole) GetDefaultSignerEmail() string

func (*TemplateRole) GetDefaultSignerName added in v1.1.14 

func (s *TemplateRole) GetDefaultSignerName() string

func (*TemplateRole) GetIndex added in v1.1.13 

func (s *TemplateRole) GetIndex() int

func (*TemplateRole) GetName added in v1.1.13 

func (s *TemplateRole) GetName() string

func (*TemplateRole) GetSignerOrder added in v1.1.14 

func (s *TemplateRole) GetSignerOrder() int

func (*TemplateRole) GetSignerType added in v1.1.14 

func (s *TemplateRole) GetSignerType() string

func (*TemplateRole) Scan added in v1.1.16 

func (tr *TemplateRole) Scan(value interface{}) error

Implement a custom scanner for TemplateRole slice

func (TemplateRole) Value added in v1.1.16 

func (tr TemplateRole) Value() (driver.Value, error)

Implement a custom valuer for TemplateRole slice

type Warning 

type Warning struct {
	Message string `json:"warning_msg"`
	Name    string `json:"warning_name"`
}

func (*Warning) GetMessage 

func (w *Warning) GetMessage() string

GetMessage returns Message

func (*Warning) GetName 

func (w *Warning) GetName() string

GetName returns Name

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.