Categorygithub.com/alohihq/signplus-go
repository
0.0.0-20250115133515-0a8c34fa4a47
Repository: https://github.com/alohihq/signplus-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

Signplus Go SDK 1.1.0

Welcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.

This SDK was generated by liblab

Versions

  • API version: 2.1.0
  • SDK version: 1.1.0

About the API

Integrate legally-binding electronic signature to your workflow

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Go >= 1.19.0

Authentication

Access Token Authentication

The signplus API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

import (
    "github.com/alohihq/signplus-go/pkg/signplus"
    "github.com/alohihq/signplus-go/pkg/signplusconfig"
  )

config := signplusconfig.NewConfig()
config.SetAccessToken("YOUR-TOKEN")

sdk := signplus.NewSignplus(config)

If you need to set or update the access token after initializing the SDK, you can use:

import (
    "github.com/alohihq/signplus-go/pkg/signplus"
    "github.com/alohihq/signplus-go/pkg/signplusconfig"
  )

config := signplusconfig.NewConfig()

sdk := signplus.NewSignplus(config)
sdk.SetAccessToken("YOUR-TOKEN")

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:
Name
SignplusService

Response Wrappers

All services use response wrappers to provide a consistent interface to return the responses from the API.

The response wrapper itself is a generic struct that contains the response data and metadata.

Below are the response wrappers used in the SDK:

SignplusResponse[T]

This response wrapper is used to return the response data from the API. It contains the following fields:

NameTypeDescription
DataTThe body of the API response
MetadataSignplusResponseMetadataStatus code and headers returned by the API

SignplusError

This response wrapper is used to return an error. It contains the following fields:

NameTypeDescription
ErrerrorThe error that occurred
BodyTThe body of the API response
MetadataSignplusResponseMetadataStatus code and headers returned by the API

SignplusResponseMetadata

This struct is shared by both response wrappers and contains the following fields:

NameTypeDescription
Headersmap[string]stringA map containing the headers returned by the API
StatusCodeintThe status code returned by the API

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
NameDescription
CreateEnvelopeRequest
Envelope
CreateEnvelopeFromTemplateRequest
ListEnvelopesRequest
ListEnvelopesResponse
Document
ListEnvelopeDocumentsResponse
AddEnvelopeDocumentRequest
SetEnvelopeDynamicFieldsRequest
AddEnvelopeSigningStepsRequest
RenameEnvelopeRequest
SetEnvelopeCommentRequest
EnvelopeNotification
SetEnvelopeExpirationRequest
SetEnvelopeLegalityLevelRequest
Annotation
ListEnvelopeDocumentAnnotationsResponse
AddAnnotationRequest
CreateTemplateRequest
Template
ListTemplatesRequest
ListTemplatesResponse
AddTemplateDocumentRequest
ListTemplateDocumentsResponse
AddTemplateSigningStepsRequest
RenameTemplateRequest
SetTemplateCommentRequest
ListTemplateAnnotationsResponse
ListTemplateDocumentAnnotationsResponse
CreateWebhookRequest
Webhook
ListWebhooksRequest
ListWebhooksResponse
EnvelopeLegalityLevelLegal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
EnvelopeFlowTypeFlow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
EnvelopeStatusStatus of the envelope
SigningStep
Recipient
RecipientRoleRole 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)
RecipientVerification
RecipientVerificationTypeType of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Page
EnvelopeOrderFieldField to order envelopes by
DynamicField
AnnotationTypeType of the annotation
AnnotationSignatureSignature annotation (null if annotation is not a signature)
AnnotationInitialsInitials annotation (null if annotation is not initials)
AnnotationTextText annotation (null if annotation is not a text)
AnnotationDateTimeDate annotation (null if annotation is not a date)
AnnotationCheckboxCheckbox annotation (null if annotation is not a checkbox)
AnnotationFont
AnnotationFontFamilyFont family of the text
AnnotationDateTimeFormatFormat 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)
AnnotationCheckboxStyleStyle of the checkbox
TemplateSigningStep
TemplateRecipient
TemplateRecipientRoleRole 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)
TemplateOrderFieldField to order templates by
WebhookEventEvent of the webhook

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.