Go
SDK Reference
Go
SDK Reference
A list of all methods in the SignplusService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| CreateEnvelope | Create new envelope |
| CreateEnvelopeFromTemplate | Create new envelope from template |
| ListEnvelopes | List envelopes |
| GetEnvelope | Get envelope |
| DeleteEnvelope | Delete envelope |
| GetEnvelopeDocument | Get envelope document |
| GetEnvelopeDocuments | Get envelope documents |
| AddEnvelopeDocument | Add envelope document |
| SetEnvelopeDynamicFields | Set envelope dynamic fields |
| AddEnvelopeSigningSteps | Add envelope signing steps |
| SendEnvelope | Send envelope for signature |
| DuplicateEnvelope | Duplicate envelope |
| VoidEnvelope | Void envelope |
| RenameEnvelope | Rename envelope |
| SetEnvelopeComment | Set envelope comment |
| SetEnvelopeNotification | Set envelope notification |
| SetEnvelopeExpirationDate | Set envelope expiration date |
| SetEnvelopeLegalityLevel | Set envelope legality level |
| GetEnvelopeAnnotations | Get envelope annotations |
| GetEnvelopeDocumentAnnotations | Get envelope document annotations |
| AddEnvelopeAnnotation | Add envelope annotation |
| DeleteEnvelopeAnnotation | Delete envelope annotation |
| CreateTemplate | Create new template |
| ListTemplates | List templates |
| GetTemplate | Get template |
| DeleteTemplate | Delete template |
| DuplicateTemplate | Duplicate template |
| AddTemplateDocument | Add template document |
| GetTemplateDocument | Get template document |
| GetTemplateDocuments | Get template documents |
| AddTemplateSigningSteps | Add template signing steps |
| RenameTemplate | Rename template |
| SetTemplateComment | Set template comment |
| SetTemplateNotification | Set template notification |
| GetTemplateAnnotations | Get template annotations |
| GetDocumentTemplateAnnotations | Get document template annotations |
| AddTemplateAnnotation | Add template annotation |
| DeleteTemplateAnnotation | Delete template annotation |
| CreateWebhook | Create webhook |
| ListWebhooks | List webhooks |
| DeleteWebhook | Delete webhook |
CreateEnvelope
Create new envelope
- HTTP Method:
POST - Endpoint:
/envelope
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| createEnvelopeRequest | CreateEnvelopeRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
envelopeFlowType := signplus.ENVELOPE_FLOW_TYPE_REQUEST_SIGNATURE
envelopeLegalityLevel := signplus.ENVELOPE_LEGALITY_LEVEL_SES
request := signplus.CreateEnvelopeRequest{}
request.SetName("Name")
request.SetFlowType(envelopeFlowType)
request.SetLegalityLevel(envelopeLegalityLevel)
response, err := client.Signplus.CreateEnvelope(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
CreateEnvelopeFromTemplate
Create new envelope from template
- HTTP Method:
POST - Endpoint:
/envelope/from_template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| createEnvelopeFromTemplateRequest | CreateEnvelopeFromTemplateRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.CreateEnvelopeFromTemplateRequest{}
request.SetName("Name")
response, err := client.Signplus.CreateEnvelopeFromTemplate(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
ListEnvelopes
List envelopes
- HTTP Method:
POST - Endpoint:
/envelopes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| listEnvelopesRequest | ListEnvelopesRequest |
Return Type
ListEnvelopesResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.ListEnvelopesRequest{}
response, err := client.Signplus.ListEnvelopes(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
GetEnvelope
Get envelope
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetEnvelope(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
DeleteEnvelope
Delete envelope
- HTTP Method:
DELETE - Endpoint:
/envelope/{envelope_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
any
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DeleteEnvelope(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
GetEnvelopeDocument
Get envelope document
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/document/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| documentId | string |
Return Type
Document
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetEnvelopeDocument(context.Background(), "envelopeId", "documentId")
if err != nil {
panic(err)
}
fmt.Print(response)
GetEnvelopeDocuments
Get envelope documents
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/documents
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
ListEnvelopeDocumentsResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetEnvelopeDocuments(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
AddEnvelopeDocument
Add envelope document
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/document
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| addEnvelopeDocumentRequest | AddEnvelopeDocumentRequest |
Return Type
Document
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.AddEnvelopeDocumentRequest{}
response, err := client.Signplus.AddEnvelopeDocument(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetEnvelopeDynamicFields
Set envelope dynamic fields
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/dynamic_fields
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| setEnvelopeDynamicFieldsRequest | SetEnvelopeDynamicFieldsRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
dynamicField := signplus.DynamicField{}
request := signplus.SetEnvelopeDynamicFieldsRequest{}
request.SetDynamicFields([]signplus.DynamicField{dynamicField})
response, err := client.Signplus.SetEnvelopeDynamicFields(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
AddEnvelopeSigningSteps
Add envelope signing steps
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/signing_steps
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| addEnvelopeSigningStepsRequest | AddEnvelopeSigningStepsRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.AddEnvelopeSigningStepsRequest{}
response, err := client.Signplus.AddEnvelopeSigningSteps(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SendEnvelope
Send envelope for signature
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/send
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.SendEnvelope(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
DuplicateEnvelope
Duplicate envelope
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/duplicate
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DuplicateEnvelope(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
VoidEnvelope
Void envelope
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/void
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.VoidEnvelope(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
RenameEnvelope
Rename envelope
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/rename
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| renameEnvelopeRequest | RenameEnvelopeRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.RenameEnvelopeRequest{}
response, err := client.Signplus.RenameEnvelope(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetEnvelopeComment
Set envelope comment
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_comment
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| setEnvelopeCommentRequest | SetEnvelopeCommentRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.SetEnvelopeCommentRequest{}
request.SetComment("Comment")
response, err := client.Signplus.SetEnvelopeComment(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetEnvelopeNotification
Set envelope notification
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_notification
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| envelopeNotification | EnvelopeNotification |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.EnvelopeNotification{}
response, err := client.Signplus.SetEnvelopeNotification(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetEnvelopeExpirationDate
Set envelope expiration date
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_expiration_date
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| setEnvelopeExpirationRequest | SetEnvelopeExpirationRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.SetEnvelopeExpirationRequest{}
request.SetExpiresAt(int64(123))
response, err := client.Signplus.SetEnvelopeExpirationDate(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetEnvelopeLegalityLevel
Set envelope legality level
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_legality_level
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ||
| setEnvelopeLegalityLevelRequest | SetEnvelopeLegalityLevelRequest |
Return Type
Envelope
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.SetEnvelopeLegalityLevelRequest{}
response, err := client.Signplus.SetEnvelopeLegalityLevel(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
GetEnvelopeAnnotations
Get envelope annotations
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/annotations
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ID of the envelope |
Return Type
[]Annotation
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetEnvelopeAnnotations(context.Background(), "envelopeId")
if err != nil {
panic(err)
}
fmt.Print(response)
GetEnvelopeDocumentAnnotations
Get envelope document annotations
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/annotations/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ID of the envelope | |
| documentId | string | ID of document |
Return Type
ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetEnvelopeDocumentAnnotations(context.Background(), "envelopeId", "documentId")
if err != nil {
panic(err)
}
fmt.Print(response)
AddEnvelopeAnnotation
Add envelope annotation
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/annotation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ID of the envelope | |
| addAnnotationRequest | AddAnnotationRequest |
Return Type
Annotation
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
annotationType := signplus.ANNOTATION_TYPE_TEXT
request := signplus.AddAnnotationRequest{}
request.SetDocumentId("DocumentId")
request.SetPage(int64(123))
request.SetX(float64(123))
request.SetY(float64(123))
request.SetWidth(float64(123))
request.SetHeight(float64(123))
request.SetType_(annotationType)
response, err := client.Signplus.AddEnvelopeAnnotation(context.Background(), "envelopeId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
DeleteEnvelopeAnnotation
Delete envelope annotation
- HTTP Method:
DELETE - Endpoint:
/envelope/{envelope_id}/annotation/{annotation_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| envelopeId | string | ID of the envelope | |
| annotationId | string | ID of the annotation to delete |
Return Type
any
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DeleteEnvelopeAnnotation(context.Background(), "envelopeId", "annotationId")
if err != nil {
panic(err)
}
fmt.Print(response)
CreateTemplate
Create new template
- HTTP Method:
POST - Endpoint:
/template
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| createTemplateRequest | CreateTemplateRequest |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.CreateTemplateRequest{}
request.SetName("Name")
response, err := client.Signplus.CreateTemplate(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
ListTemplates
List templates
- HTTP Method:
POST - Endpoint:
/templates
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| listTemplatesRequest | ListTemplatesRequest |
Return Type
ListTemplatesResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.ListTemplatesRequest{}
response, err := client.Signplus.ListTemplates(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
GetTemplate
Get template
- HTTP Method:
GET - Endpoint:
/template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetTemplate(context.Background(), "templateId")
if err != nil {
panic(err)
}
fmt.Print(response)
DeleteTemplate
Delete template
- HTTP Method:
DELETE - Endpoint:
/template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string |
Return Type
any
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DeleteTemplate(context.Background(), "templateId")
if err != nil {
panic(err)
}
fmt.Print(response)
DuplicateTemplate
Duplicate template
- HTTP Method:
POST - Endpoint:
/template/{template_id}/duplicate
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DuplicateTemplate(context.Background(), "templateId")
if err != nil {
panic(err)
}
fmt.Print(response)
AddTemplateDocument
Add template document
- HTTP Method:
POST - Endpoint:
/template/{template_id}/document
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| addTemplateDocumentRequest | AddTemplateDocumentRequest |
Return Type
Document
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.AddTemplateDocumentRequest{}
request.SetFile(any)
response, err := client.Signplus.AddTemplateDocument(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
GetTemplateDocument
Get template document
- HTTP Method:
GET - Endpoint:
/template/{template_id}/document/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| documentId | string |
Return Type
Document
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetTemplateDocument(context.Background(), "templateId", "documentId")
if err != nil {
panic(err)
}
fmt.Print(response)
GetTemplateDocuments
Get template documents
- HTTP Method:
GET - Endpoint:
/template/{template_id}/documents
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string |
Return Type
ListTemplateDocumentsResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetTemplateDocuments(context.Background(), "templateId")
if err != nil {
panic(err)
}
fmt.Print(response)
AddTemplateSigningSteps
Add template signing steps
- HTTP Method:
POST - Endpoint:
/template/{template_id}/signing_steps
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| addTemplateSigningStepsRequest | AddTemplateSigningStepsRequest |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
templateSigningStep := signplus.TemplateSigningStep{}
request := signplus.AddTemplateSigningStepsRequest{}
request.SetSigningSteps([]signplus.TemplateSigningStep{templateSigningStep})
response, err := client.Signplus.AddTemplateSigningSteps(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
RenameTemplate
Rename template
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/rename
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| renameTemplateRequest | RenameTemplateRequest |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.RenameTemplateRequest{}
request.SetName("Name")
response, err := client.Signplus.RenameTemplate(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetTemplateComment
Set template comment
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/set_comment
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| setTemplateCommentRequest | SetTemplateCommentRequest |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.SetTemplateCommentRequest{}
request.SetComment("Comment")
response, err := client.Signplus.SetTemplateComment(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
SetTemplateNotification
Set template notification
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/set_notification
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ||
| envelopeNotification | EnvelopeNotification |
Return Type
Template
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.EnvelopeNotification{}
response, err := client.Signplus.SetTemplateNotification(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
GetTemplateAnnotations
Get template annotations
- HTTP Method:
GET - Endpoint:
/template/{template_id}/annotations
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ID of the template |
Return Type
ListTemplateAnnotationsResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetTemplateAnnotations(context.Background(), "templateId")
if err != nil {
panic(err)
}
fmt.Print(response)
GetDocumentTemplateAnnotations
Get document template annotations
- HTTP Method:
GET - Endpoint:
/template/{template_id}/annotations/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ID of the template | |
| documentId | string | ID of document |
Return Type
ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.GetDocumentTemplateAnnotations(context.Background(), "templateId", "documentId")
if err != nil {
panic(err)
}
fmt.Print(response)
AddTemplateAnnotation
Add template annotation
- HTTP Method:
POST - Endpoint:
/template/{template_id}/annotation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ID of the template | |
| addAnnotationRequest | AddAnnotationRequest |
Return Type
Annotation
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
annotationType := signplus.ANNOTATION_TYPE_TEXT
request := signplus.AddAnnotationRequest{}
request.SetDocumentId("DocumentId")
request.SetPage(int64(123))
request.SetX(float64(123))
request.SetY(float64(123))
request.SetWidth(float64(123))
request.SetHeight(float64(123))
request.SetType_(annotationType)
response, err := client.Signplus.AddTemplateAnnotation(context.Background(), "templateId", request)
if err != nil {
panic(err)
}
fmt.Print(response)
DeleteTemplateAnnotation
Delete template annotation
- HTTP Method:
DELETE - Endpoint:
/template/{template_id}/annotation/{annotation_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| templateId | string | ID of the template | |
| annotationId | string | ID of the annotation to delete |
Return Type
any
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DeleteTemplateAnnotation(context.Background(), "templateId", "annotationId")
if err != nil {
panic(err)
}
fmt.Print(response)
CreateWebhook
Create webhook
- HTTP Method:
POST - Endpoint:
/webhook
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| createWebhookRequest | CreateWebhookRequest |
Return Type
Webhook
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
webhookEvent := signplus.WEBHOOK_EVENT_ENVELOPE_EXPIRED
request := signplus.CreateWebhookRequest{}
request.SetEvent(webhookEvent)
request.SetTarget("Target")
response, err := client.Signplus.CreateWebhook(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
ListWebhooks
List webhooks
- HTTP Method:
POST - Endpoint:
/webhooks
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| listWebhooksRequest | ListWebhooksRequest |
Return Type
ListWebhooksResponse
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
request := signplus.ListWebhooksRequest{}
response, err := client.Signplus.ListWebhooks(context.Background(), request)
if err != nil {
panic(err)
}
fmt.Print(response)
DeleteWebhook
Delete webhook
- HTTP Method:
DELETE - Endpoint:
/webhook/{webhook_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ctx | Context | Default go language context | |
| webhookId | string |
Return Type
any
Example Usage Code Snippet
import (
"fmt"
"encoding/json"
"github.com/alohihq/signplus-go/pkg/signplusconfig"
"github.com/alohihq/signplus-go/pkg/signplus"
)
config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)
response, err := client.Signplus.DeleteWebhook(context.Background(), "webhookId")
if err != nil {
panic(err)
}
fmt.Print(response)
Models
Document
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the document | |
| Name | string | Name of the document | |
| Filename | string | Filename of the document | |
| PageCount | int64 | Number of pages in the document | |
| Pages | []signplus.Page | List of pages in the document |
Models
TemplateSigningStep
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Recipients | []signplus.TemplateRecipient | List of recipients |
Models
ListEnvelopeDocumentAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Annotations | []signplus.Annotation |
Models
Template
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the template | |
| Name | string | Name of the template | |
| Comment | string | Comment for the template | |
| Pages | int64 | Total number of pages in the template | |
| LegalityLevel | signplus.EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| CreatedAt | int64 | Unix timestamp of the creation date | |
| UpdatedAt | int64 | Unix timestamp of the last modification date | |
| ExpirationDelay | int64 | Expiration delay added to the current time when an envelope is created from this template | |
| NumRecipients | int64 | Number of recipients in the envelope | |
| SigningSteps | []signplus.TemplateSigningStep | ||
| Documents | []signplus.Document | ||
| Notification | signplus.EnvelopeNotification | ||
| DynamicFields | []string | List of dynamic fields |
Models
WebhookEvent
Event of the webhook
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| ENVELOPE_EXPIRED | string | “ENVELOPE_EXPIRED” | |
| ENVELOPE_DECLINED | string | “ENVELOPE_DECLINED” | |
| ENVELOPE_VOIDED | string | “ENVELOPE_VOIDED” | |
| ENVELOPE_COMPLETED | string | “ENVELOPE_COMPLETED” |
Models
RenameTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the template |
Models
AnnotationCheckboxStyle
Style of the checkbox
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| CIRCLE_CHECK | string | “CIRCLE_CHECK” | |
| CIRCLE_FULL | string | “CIRCLE_FULL” | |
| SQUARE_CHECK | string | “SQUARE_CHECK” | |
| SQUARE_FULL | string | “SQUARE_FULL” | |
| CHECK_MARK | string | “CHECK_MARK” | |
| TIMES_SQUARE | string | “TIMES_SQUARE” |
Models
AnnotationInitials
Initials annotation (null if annotation is not initials)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the annotation initials |
Models
RenameEnvelopeRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the envelope |
Models
DynamicField
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the dynamic field | |
| Value | string | Value of the dynamic field |
Models
SetEnvelopeDynamicFieldsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DynamicFields | []signplus.DynamicField | List of dynamic fields |
Models
AddEnvelopeSigningStepsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SigningSteps | []signplus.SigningStep | List of signing steps |
Models
EnvelopeFlowType
Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| REQUEST_SIGNATURE | string | “REQUEST_SIGNATURE” | |
| SIGN_MYSELF | string | “SIGN_MYSELF” |
Models
SetEnvelopeCommentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Comment | string | Comment for the envelope |
Models
AnnotationText
Text annotation (null if annotation is not a text)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Size | float64 | Font size of the text in pt | |
| Color | float64 | Text color in 32bit representation | |
| Value | string | Text content of the annotation | |
| Tooltip | string | Tooltip of the annotation | |
| DynamicFieldName | string | Name of the dynamic field | |
| Font | signplus.AnnotationFont |
Models
Envelope
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the envelope | |
| Name | string | Name of the envelope | |
| Comment | string | Comment for the envelope | |
| Pages | int64 | Total number of pages in the envelope | |
| FlowType | signplus.EnvelopeFlowType | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) | |
| LegalityLevel | signplus.EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| Status | signplus.EnvelopeStatus | Status of the envelope | |
| CreatedAt | int64 | Unix timestamp of the creation date | |
| UpdatedAt | int64 | Unix timestamp of the last modification date | |
| ExpiresAt | int64 | Unix timestamp of the expiration date | |
| NumRecipients | int64 | Number of recipients in the envelope | |
| IsDuplicable | bool | Whether the envelope can be duplicated | |
| SigningSteps | []signplus.SigningStep | ||
| Documents | []signplus.Document | ||
| Notification | signplus.EnvelopeNotification |
Models
AddTemplateSigningStepsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SigningSteps | []signplus.TemplateSigningStep | List of signing steps |
Models
CreateEnvelopeRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the envelope | |
| FlowType | signplus.EnvelopeFlowType | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) | |
| LegalityLevel | signplus.EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| ExpiresAt | int64 | Unix timestamp of the expiration date | |
| Comment | string | Comment for the envelope | |
| Sandbox | bool | Whether the envelope is created in sandbox mode |
Models
TemplateRecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SIGNER | string | “SIGNER” | |
| RECEIVES_COPY | string | “RECEIVES_COPY” | |
| IN_PERSON_SIGNER | string | “IN_PERSON_SIGNER” |
Models
ListWebhooksRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| WebhookId | string | ID of the webhook | |
| Event | signplus.WebhookEvent | Event of the webhook |
Models
AnnotationDateTimeFormat
Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DMY_NUMERIC_SLASH | string | “DMY_NUMERIC_SLASH” | |
| MDY_NUMERIC_SLASH | string | “MDY_NUMERIC_SLASH” | |
| YMD_NUMERIC_SLASH | string | “YMD_NUMERIC_SLASH” | |
| DMY_NUMERIC_DASH_SHORT | string | “DMY_NUMERIC_DASH_SHORT” | |
| DMY_NUMERIC_DASH | string | “DMY_NUMERIC_DASH” | |
| YMD_NUMERIC_DASH | string | “YMD_NUMERIC_DASH” | |
| MDY_TEXT_DASH_SHORT | string | “MDY_TEXT_DASH_SHORT” | |
| MDY_TEXT_SPACE_SHORT | string | “MDY_TEXT_SPACE_SHORT” | |
| MDY_TEXT_SPACE | string | “MDY_TEXT_SPACE” |
Models
ListTemplateDocumentAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Annotations | []signplus.Annotation |
Models
AnnotationFontFamily
Font family of the text
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| UNKNOWN | string | “UNKNOWN” | |
| SERIF | string | “SERIF” | |
| SANS | string | “SANS” | |
| MONO | string | “MONO” |
Models
CreateTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string |
Models
AddTemplateDocumentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| File | any | File to upload in binary format |
Models
SetEnvelopeExpirationRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| ExpiresAt | int64 | Unix timestamp of the expiration date |
Models
SetEnvelopeLegalityLevelRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| LegalityLevel | signplus.EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) |
Models
ListTemplatesResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| HasNextPage | bool | Whether there is a next page | |
| HasPreviousPage | bool | Whether there is a previous page | |
| Templates | []signplus.Template |
Models
SetTemplateCommentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Comment | string | Comment for the template |
Models
ListEnvelopesResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| HasNextPage | bool | Whether there is a next page | |
| HasPreviousPage | bool | Whether there is a previous page | |
| Envelopes | []signplus.Envelope |
Models
ListTemplatesRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the template | |
| Tags | []string | List of tag templates | |
| Ids | []string | List of templates IDs | |
| First | int64 | ||
| Last | int64 | ||
| After | string | ||
| Before | string | ||
| OrderField | signplus.TemplateOrderField | Field to order templates by | |
| Ascending | bool | Whether to order templates in ascending order |
Models
AnnotationFont
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Family | signplus.AnnotationFontFamily | Font family of the text | |
| Italic | bool | Whether the text is italic | |
| Bold | bool | Whether the text is bold |
Models
AnnotationType
Type of the annotation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| TEXT | string | “TEXT” | |
| SIGNATURE | string | “SIGNATURE” | |
| INITIALS | string | “INITIALS” | |
| CHECKBOX | string | “CHECKBOX” | |
| DATE | string | “DATE” |
Models
ListWebhooksResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Webhooks | []signplus.Webhook |
Models
Webhook
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the webhook | |
| Event | signplus.WebhookEvent | Event of the webhook | |
| Target | string | Target URL of the webhook |
Models
CreateEnvelopeFromTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the envelope | |
| Comment | string | Comment for the envelope | |
| Sandbox | bool | Whether the envelope is created in sandbox mode |
Models
RecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SIGNER | string | “SIGNER” | |
| RECEIVES_COPY | string | “RECEIVES_COPY” | |
| IN_PERSON_SIGNER | string | “IN_PERSON_SIGNER” |
Models
EnvelopeLegalityLevel
Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SES | string | “SES” | |
| QES_EIDAS | string | “QES_EIDAS” | |
| QES_ZERTES | string | “QES_ZERTES” |
Models
ListTemplateDocumentsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Documents | []signplus.Document |
Models
TemplateRecipient
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the recipient | |
| Uid | string | Unique identifier of the user associated with the recipient | |
| Name | string | Name of the recipient | |
| string | Email of the recipient | ||
| Role | signplus.TemplateRecipientRole | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) |
Models
RecipientVerification
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Type_ | signplus.RecipientVerificationType | Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) | |
| Value | string |
Models
ListTemplateAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Annotations | []signplus.Annotation |
Models
Annotation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the annotation | |
| RecipientId | string | ID of the recipient | |
| DocumentId | string | ID of the document | |
| Page | int64 | Page number where the annotation is placed | |
| X | float64 | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner | |
| Y | float64 | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner | |
| Width | float64 | Width of the annotation (in % of the page width from 0 to 100) | |
| Height | float64 | Height of the annotation (in % of the page height from 0 to 100) | |
| Required | bool | Whether the annotation is required | |
| Type_ | signplus.AnnotationType | Type of the annotation | |
| Signature | signplus.AnnotationSignature | Signature annotation (null if annotation is not a signature) | |
| Initials | signplus.AnnotationInitials | Initials annotation (null if annotation is not initials) | |
| Text | signplus.AnnotationText | Text annotation (null if annotation is not a text) | |
| Datetime | signplus.AnnotationDateTime | Date annotation (null if annotation is not a date) | |
| Checkbox | signplus.AnnotationCheckbox | Checkbox annotation (null if annotation is not a checkbox) |
Models
ListEnvelopeDocumentsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Documents | []signplus.Document |
Models
CreateWebhookRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Event | signplus.WebhookEvent | Event of the webhook | |
| Target | string | URL of the webhook target |
Models
Page
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Width | int64 | Width of the page in pixels | |
| Height | int64 | Height of the page in pixels |
Models
Recipient
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the recipient | |
| string | Email of the recipient | ||
| Role | signplus.RecipientRole | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) | |
| Id | string | Unique identifier of the recipient | |
| Uid | string | Unique identifier of the user associated with the recipient | |
| Verification | signplus.RecipientVerification |
Models
EnvelopeOrderField
Field to order envelopes by
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| CREATION_DATE | string | “CREATION_DATE” | |
| MODIFICATION_DATE | string | “MODIFICATION_DATE” | |
| NAME | string | “NAME” | |
| STATUS | string | “STATUS” | |
| LAST_DOCUMENT_CHANGE | string | “LAST_DOCUMENT_CHANGE” |
Models
SigningStep
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Recipients | []signplus.Recipient | List of recipients |
Models
EnvelopeStatus
Status of the envelope
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DRAFT | string | “DRAFT” | |
| IN_PROGRESS | string | “IN_PROGRESS” | |
| COMPLETED | string | “COMPLETED” | |
| EXPIRED | string | “EXPIRED” | |
| DECLINED | string | “DECLINED” | |
| VOIDED | string | “VOIDED” | |
| PENDING | string | “PENDING” |
Models
ListEnvelopesRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | Name of the envelope | |
| Tags | []string | List of tags | |
| Comment | string | Comment of the envelope | |
| Ids | []string | List of envelope IDs | |
| Statuses | []signplus.EnvelopeStatus | List of envelope statuses | |
| FolderIds | []string | List of folder IDs | |
| OnlyRootFolder | bool | Whether to only list envelopes in the root folder | |
| DateFrom | int64 | Unix timestamp of the start date | |
| DateTo | int64 | Unix timestamp of the end date | |
| Uid | string | Unique identifier of the user | |
| First | int64 | ||
| Last | int64 | ||
| After | string | ||
| Before | string | ||
| OrderField | signplus.EnvelopeOrderField | Field to order envelopes by | |
| Ascending | bool | Whether to order envelopes in ascending order | |
| IncludeTrash | bool | Whether to include envelopes in the trash |
Models
RecipientVerificationType
Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SMS | string | “SMS” | |
| PASSCODE | string | “PASSCODE” |
Models
TemplateOrderField
Field to order templates by
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| TEMPLATE_ID | string | “TEMPLATE_ID” | |
| TEMPLATE_CREATION_DATE | string | “TEMPLATE_CREATION_DATE” | |
| TEMPLATE_MODIFICATION_DATE | string | “TEMPLATE_MODIFICATION_DATE” | |
| TEMPLATE_NAME | string | “TEMPLATE_NAME” |
Models
AnnotationCheckbox
Checkbox annotation (null if annotation is not a checkbox)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Checked | bool | Whether the checkbox is checked | |
| Style | signplus.AnnotationCheckboxStyle | Style of the checkbox |
Models
AnnotationSignature
Signature annotation (null if annotation is not a signature)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Id | string | Unique identifier of the annotation signature |
Models
AddAnnotationRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DocumentId | string | ID of the document | |
| Page | int64 | Page number where the annotation is placed | |
| X | float64 | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner | |
| Y | float64 | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner | |
| Width | float64 | Width of the annotation (in % of the page width from 0 to 100) | |
| Height | float64 | Height of the annotation (in % of the page height from 0 to 100) | |
| Type_ | signplus.AnnotationType | Type of the annotation | |
| RecipientId | string | ID of the recipient | |
| Required | bool | ||
| Signature | signplus.AnnotationSignature | Signature annotation (null if annotation is not a signature) | |
| Initials | signplus.AnnotationInitials | Initials annotation (null if annotation is not initials) | |
| Text | signplus.AnnotationText | Text annotation (null if annotation is not a text) | |
| Datetime | signplus.AnnotationDateTime | Date annotation (null if annotation is not a date) | |
| Checkbox | signplus.AnnotationCheckbox | Checkbox annotation (null if annotation is not a checkbox) |
Models
AnnotationDateTime
Date annotation (null if annotation is not a date)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Size | float64 | Font size of the text in pt | |
| Font | signplus.AnnotationFont | ||
| Color | string | Color of the text in hex format | |
| AutoFill | bool | Whether the date should be automatically filled | |
| Timezone | string | Timezone of the date | |
| Timestamp | int64 | Unix timestamp of the date | |
| Format | signplus.AnnotationDateTimeFormat | Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces) |
Models
AddEnvelopeDocumentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| File | any | File to upload in binary format |
Models
EnvelopeNotification
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Subject | string | Subject of the notification | |
| Message | string | Message of the notification | |
| ReminderInterval | int64 | Interval in days to send reminder |