boldsign

Documentation

Index

• Constants
• type Client
  • func (m *Client) BoolToIntString(value bool) string
  • func (m *Client) CreateEmbeddedRequestUrl(req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)
  • func (m *Client) CreateEmbeddedRequestUrlFromTemplate(templateId string, req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)
  • func (m *Client) CreateEmbeddedTemplateRequestUrl(req model.EmbeddedDocumentRequest) (*model.EmbeddedTemplateCreated, error)
  • func (m *Client) CreateFormFileWithContentType(w *multipart.Writer, fieldname, filename, path string) (io.Writer, error)
  • func (m *Client) CreateSenderIdentity(senderRequest model.SenderCreateRequest) (*model.SenderCreated, error)
  • func (m *Client) DeleteSenderIdentity(email string) error
  • func (m *Client) DeleteTemplate(templateId string) error
  • func (m *Client) DownloadDocument(documentId string, onBehalfOf string) ([]byte, error)
  • func (m *Client) DownloadTemplate(documentId string, onBehalfOf string) ([]byte, error)
  • func (m *Client) EscapeQuotes(s string) string
  • func (m *Client) GetEmbeddedSignLink(documentId string, signerEmail string, redirectUrl string) (*model.EmbeddedSigningLink, error)
  • func (m *Client) GetEmbeddedTemplateEditUrl(templateId string, req model.EmbeddedDocumentRequest) (*model.EmbeddedTemplateCreated, error)
  • func (m *Client) GetProperties(documentId string) (*model.DocumentProperties, error)
  • func (m *Client) GetTemplate(templateId string) (*model.DocumentProperties, error)
  • func (m *Client) GetToken() (string, error)
  • func (m *Client) MarshalMultipartEmbeddedSignatureRequest(embRequest model.EmbeddedDocumentRequest) (*bytes.Buffer, *multipart.Writer, error)
  • func (m *Client) MergeAndSend(req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)
  • func (m *Client) UpdateSenderIdentity(email string, senderRequest model.SenderUpdateRequest) error
  • func (m *Client) UpdateTemplate(templateId string, req model.EmbeddedDocumentRequest) error
  • func (m *Client) VerifySenderIdentity(email string) (model.SenderIdentityDetail, bool, error)

Constants

const (
	FormFieldKey        string = "form_field"
	FileKey             string = "Files"
	SignersKey          string = "Signers"
	RolesKey            string = "Roles"
	ReminderSettingsKey string = "ReminderSettings"
	ExpiryDaysKey       string = "ExpiryDays"
)

const (
	PreparePage int64 = 0
	FillingPage int64 = 1
)

Types

type Client

type Client struct {
	Secret     string
	ClientID   string
	BaseURL    string
	BaseDomain string
	HTTPClient *http.Client
}

Client contains APIKey and optional http.client

func (*Client) BoolToIntString

func (m *Client) BoolToIntString(value bool) string

func (*Client) CreateEmbeddedRequestUrl

func (m *Client) CreateEmbeddedRequestUrl(req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)

CreateEmbeddedRequestUrl creates a new embedded signature

func (*Client) CreateEmbeddedRequestUrlFromTemplate

func (m *Client) CreateEmbeddedRequestUrlFromTemplate(templateId string, req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)

createEmbeddedRequestUrl creates a new embedded signature with template id

func (*Client) CreateEmbeddedTemplateRequestUrl

func (m *Client) CreateEmbeddedTemplateRequestUrl(req model.EmbeddedDocumentRequest) (*model.EmbeddedTemplateCreated, error)

CreateEmbeddedTemplateRequestUrl creates a new embedded signature with template id

func (*Client) CreateFormFileWithContentType

func (m *Client) CreateFormFileWithContentType(w *multipart.Writer, fieldname, filename, path string) (io.Writer, error)

func (*Client) CreateSenderIdentity

func (m *Client) CreateSenderIdentity(senderRequest model.SenderCreateRequest) (*model.SenderCreated, error)

CreateSenderIdentity creates sender identity

func (*Client) DeleteSenderIdentity

func (m *Client) DeleteSenderIdentity(email string) error

DeleteSenderIdentity

func (*Client) DeleteTemplate

func (m *Client) DeleteTemplate(templateId string) error

DeleteTemplate

func (*Client) DownloadDocument

func (m *Client) DownloadDocument(documentId string, onBehalfOf string) ([]byte, error)

func (*Client) DownloadTemplate

func (m *Client) DownloadTemplate(documentId string, onBehalfOf string) ([]byte, error)

func (*Client) EscapeQuotes

func (m *Client) EscapeQuotes(s string) string

func (*Client) GetEmbeddedSignLink

func (m *Client) GetEmbeddedSignLink(documentId string, signerEmail string, redirectUrl string) (*model.EmbeddedSigningLink, error)

func (*Client) GetEmbeddedTemplateEditUrl

func (m *Client) GetEmbeddedTemplateEditUrl(templateId string, req model.EmbeddedDocumentRequest) (*model.EmbeddedTemplateCreated, error)

GetEmbeddedTemplateEditUrl creates a new embedded signature with template id

func (*Client) GetProperties

func (m *Client) GetProperties(documentId string) (*model.DocumentProperties, error)

func (*Client) GetTemplate

func (m *Client) GetTemplate(templateId string) (*model.DocumentProperties, error)

GetTemplate

func (*Client) GetToken

func (m *Client) GetToken() (string, error)

func (*Client) MarshalMultipartEmbeddedSignatureRequest

func (m *Client) MarshalMultipartEmbeddedSignatureRequest(embRequest model.EmbeddedDocumentRequest) (*bytes.Buffer, *multipart.Writer, error)

func (*Client) MergeAndSend

func (m *Client) MergeAndSend(req model.EmbeddedDocumentRequest) (*model.EmbeddedSendCreated, error)

Send document using multiple templates

func (*Client) UpdateSenderIdentity

func (m *Client) UpdateSenderIdentity(email string, senderRequest model.SenderUpdateRequest) error

UpdateSenderIdentity

func (*Client) UpdateTemplate

func (m *Client) UpdateTemplate(templateId string, req model.EmbeddedDocumentRequest) error

UpdateTemplate

func (*Client) VerifySenderIdentity

func (m *Client) VerifySenderIdentity(email string) (model.SenderIdentityDetail, bool, error)

DeleteSenderIdentity