sign

package
v0.0.0-...-5643740 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: MIT Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	//Github is a constant for github
	Github = "github"

	// Unknown is a constant for unknown
	Unknown = "Unknown"

	// Gitlab is a constant for gitlab
	Gitlab = "gitlab"
)
View Source 
const (
	DontLoadRepoDetails = false
	DocSignFalse        = "false"
	DocusignCompleted   = "Completed"
)

constants

Variables

View Source 
var (
	ErrCCLANotEnabled        = errors.New("corporate license agreement is not enabled with this project")
	ErrTemplateNotConfigured = errors.New("cla template not configured for this project")
	ErrNotInOrg              error
)

errors

Functions

func CCLADocusignMiddleware 

func CCLADocusignMiddleware(next http.Handler) http.Handler

CCLADocusignMiddleware used to set CCLA middleware

func Configure 

func Configure(api *operations.EasyclaAPI, service Service, userService users.Service)

Configure API call

func DocusignMiddleware 

func DocusignMiddleware(next http.Handler) http.Handler

DocusignMiddleware is used to get access to xml request body

Types

type Attachment 

type Attachment struct {
	Data  string `xml:"Data"`
	Label string `xml:"Label"`
}

Attachment represents the <Attachment> element

type ClaSignatoryEmailParams 

type ClaSignatoryEmailParams struct {
	ClaGroupName    string
	SignatoryName   string
	ClaManagerName  string
	ClaManagerEmail string
	CompanyName     string
	ProjectVersion  string
	ProjectNames    []string
}

type DocuSignDocument 

type DocuSignDocument struct {
	DocumentId        string `json:"documentId,omitempty"`     // Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.
	DocumentBase64    string `json:"documentBase64,omitempty"` // The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.0:w
	FileExtension     string `json:"fileExtension,omitempty"`  // The file extension type of the document. Non-PDF documents are converted to PDF. If the document is not a PDF, fileExtension is required. If you try to upload a non-PDF document without a fileExtension, you will receive an "unable to load document" error message. The file extension type of the document. If the document is not a PDF it is converted to a PDF.
	FileFormatHint    string `json:"fileFormatHint,omitempty"`
	IncludeInDownload string `json:"includeInDownload,omitempty"` // When set to true, the document is included in the combined document download.
	Name              string `json:"name,omitempty"`              // The name of the document. This is the name that appears in the list of documents when managing an envelope.
	Order             string `json:"order,omitempty"`             // The order in which to sort the results. Valid values are: asc, desc
}

DocuSignDocument is the data model for a document from DocuSign

type DocuSignEnvelopeInformation 

type DocuSignEnvelopeInformation struct {
	XMLName        xml.Name       `xml:"DocuSignEnvelopeInformation"`
	EnvelopeStatus EnvelopeStatus `xml:"EnvelopeStatus"`
	// Additional fields can be added here if needed
	FormData string `xml:"FormData"`
}

DocuSignEnvelopeInformation is the root element

type DocuSignEnvelopeRequest 

type DocuSignEnvelopeRequest struct {
	EnvelopeId           string                    `json:"envelopeId,omitempty"`           // The envelope ID of the envelope
	EnvelopeIdStamping   string                    `json:"envelopeIdStamping,omitempty"`   // When true, Envelope ID Stamping is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed.
	TemplateId           string                    `json:"templateId,omitempty"`           // The ID of the template. If a value is not provided, DocuSign generates a value.
	Documents            []DocuSignDocument        `json:"documents,omitempty"`            // A data model containing details about the documents associated with the envelope
	DocumentBase64       string                    `json:"documentBase64,omitempty"`       // The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
	DocumentsCombinedUri string                    `json:"documentsCombinedUri,omitempty"` // The URI for retrieving all of the documents associated with the envelope as a single PDF file.
	DocumentsUri         string                    `json:"documentsUri,omitempty"`         // The URI for retrieving all of the documents associated with the envelope as separate files.
	EmailSubject         string                    `json:"emailSubject,omitempty"`         // EmailSubject - The subject line of the email message that is sent to all recipients.
	EmailBlurb           string                    `json:"emailBlurb,omitempty"`           // EmailBlurb - This is the same as the email body. If specified it is included in email body for all envelope recipients.
	Recipients           DocuSignRecipientType     `json:"recipients,omitempty"`
	TemplateRoles        []DocuSignTemplateRole    `json:"templateRoles,omitempty"`
	EventNotification    DocuSignEventNotification `json:"eventNotification,omitempty"`

	/* Status
	Indicates the envelope status. Valid values when creating an envelope are:

	    created: The envelope is created as a draft. It can be modified and sent later.
	    sent: The envelope will be sent to the recipients after the envelope is created.

	You can query these additional statuses once the recipients have interacted with the envelope.

	    completed: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
	    declined: The envelope has been declined by the recipients.
	    delivered: The envelope has been delivered to the recipients.
	    signed: The envelope has been signed by the recipients.
	    voided: The envelope is no longer valid and recipients cannot access or sign the envelope.

	*/
	Status string `json:"status,omitempty"`
}

DocuSignEnvelopeRequest is the request body for an envelope from DocuSign, see: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/

type DocuSignEnvelopeResponse 

type DocuSignEnvelopeResponse struct {
	EnvelopeId   string              `json:"envelopeId,omitempty"`
	Recipients   []DocuSignRecipient `json:"recipients,omitempty"`
	ErrorDetails struct {
		ErrorCode string `json:"errorCode,omitempty"`
		Message   string `json:"message,omitempty"`
	} `json:"errorDetails,omitempty"`
}

DocuSignEnvelopeResponse is the response body for an envelope from DocuSign, see: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/

type DocuSignEnvelopeResponseModel 

type DocuSignEnvelopeResponseModel struct {
	/*
		// Response from: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/
			{
			  "allowMarkup": "false",
			  "autoNavigation": "true",
			  "brandId": "56502fe1-xxxx-xxxx-xxxx-97cb5c43176a",
			  "certificateUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate",
			  "createdDateTime": "2016-10-05T01:04:58.1830000Z",
			  "customFieldsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields",
			  "documentsCombinedUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined",
			  "documentsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents",
			  "emailSubject": "Please sign the NDA",
			  "enableWetSign": "true",
			  "envelopeId": "4b728be4-xxxx-xxxx-xxxx-d63e23f822b6",
			  "envelopeIdStamping": "true",
			  "envelopeUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6",
			  "initialSentDateTime": "2016-10-05T01:04:58.7770000Z",
			  "is21CFRPart11": "false",
			  "isSignatureProviderEnvelope": "false",
			  "lastModifiedDateTime": "2016-10-05T01:04:58.1830000Z",
			  "notificationUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification",
			  "purgeState": "unpurged",
			  "recipientsUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients",
			  "sentDateTime": "2016-10-05T01:04:58.7770000Z",
			  "status": "sent",
			  "statusChangedDateTime": "2016-10-05T01:04:58.7770000Z",
			  "templatesUri": "/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates"
			}
	*/
	AllowMarkup                 string `json:"allowMarkup,omitempty"`
	AutoNavigation              string `json:"autoNavigation,omitempty"`
	BrandId                     string `json:"brandId,omitempty"`
	CertificateUri              string `json:"certificateUri,omitempty"`
	CreatedDateTime             string `json:"createdDateTime,omitempty"`
	CustomFieldsUri             string `json:"customFieldsUri,omitempty"`
	DocumentsCombinedUri        string `json:"documentsCombinedUri,omitempty"`
	DocumentsUri                string `json:"documentsUri,omitempty"`
	EmailSubject                string `json:"emailSubject,omitempty"`
	EnableWetSign               string `json:"enableWetSign,omitempty"`
	EnvelopeId                  string `json:"envelopeId,omitempty"`
	EnvelopeIdStamping          string `json:"envelopeIdStamping,omitempty"`
	EnvelopeUri                 string `json:"envelopeUri,omitempty"`
	InitialSentDateTime         string `json:"initialSentDateTime,omitempty"`
	Is21CFRPart11               string `json:"is21CFRPart11,omitempty"`
	IsSignatureProviderEnvelope string `json:"isSignatureProviderEnvelope,omitempty"`
	LastModifiedDateTime        string `json:"lastModifiedDateTime,omitempty"`
	NotificationUri             string `json:"notificationUri,omitempty"`
	PurgeState                  string `json:"purgeState,omitempty"`
	RecipientsUri               string `json:"recipientsUri,omitempty"`
	SentDateTime                string `json:"sentDateTime,omitempty"`
	Status                      string `json:"status,omitempty"`
	StatusChangedDateTime       string `json:"statusChangedDateTime,omitempty"`
	TemplatesUri                string `json:"templatesUri,omitempty"`
}

DocuSignEnvelopeResponseModel is the envelope response model

type DocuSignEnvelopeSummary 

type DocuSignEnvelopeSummary struct {
	AllowComments               string           `json:"allowComments"`        // "true"
	AllowMarkup                 string           `json:"allowMarkup"`          // "false"
	AllowReassign               string           `json:"allowReassign"`        // "true"
	AllowViewHistory            string           `json:"allowViewHistory"`     // "true"
	AnySigner                   interface{}      `json:"anySigner"`            // <nil>
	AttachmentsURI              string           `json:"attachmentsUri"`       // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/attachments
	AutoNavigation              string           `json:"autoNavigation"`       // "true"
	BurnDefaultTabData          string           `json:"burnDefaultTabData"`   // "false"
	CertificateURI              string           `json:"certificateUri"`       // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/documents/summary
	CreatedDateTime             string           `json:"createdDateTime"`      // 2023-05-26T18:55:47.18Z
	CustomFieldsURI             string           `json:"customFieldsUri"`      // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/custom_fields
	DocumentsCombinedURI        string           `json:"documentsCombinedUri"` // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/documents/combined
	DocumentsURI                string           `json:"documentsUri"`         // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/documents
	EmailSubject                string           `json:"emailSubject"`         // Please DocuSign this document: Test DocuSign
	EnableWetSign               string           `json:"enableWetSign"`        // "false"
	EnvelopeID                  string           `json:"envelopeId"`           // 016d4678-bf5c-41f3-b7c9-5c58606cdb4a
	EnvelopeIDStamping          string           `json:"envelopeIdStamping"`   // "true"
	EnvelopeLocation            string           `json:"envelopeLocation"`     // current_site
	EnvelopeMetadata            EnvelopeMetadata `json:"envelopeMetadata"`
	EnvelopeURI                 string           `json:"envelopeUri"`                 // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a
	ExpiresAfter                string           `json:"expiresAfter"`                // 120
	ExpireDateTime              string           `json:"expireDateTime"`              // 2023-05-26T18:55:48.257Z
	ExpireEnabled               string           `json:"expireEnabled"`               // "true"
	HasComments                 string           `json:"hasComments"`                 // "false"
	HasFormDataChanged          string           `json:"hasFormDataChanged"`          // "false"
	InitialSendDateTime         string           `json:"initialSendDateTime"`         // 2023-05-26T18:55:48.257Z
	Is21CFRPart11               string           `json:"is21CFRPart11"`               // "false"
	IsDynamicEnvelope           string           `json:"isDynamicEnvelope"`           // "false"
	IsSignatureProviderEnvelope string           `json:"isSignatureProviderEnvelope"` // "false"
	LastModifiedDateTime        string           `json:"lastModifiedDateTime"`        // 2023-05-26T18:55:48.257Z
	NotificationURI             string           `json:"notificationUri"`             // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/notification
	PurgeState                  string           `json:"purgeState"`                  // unpurged
	Recipients                  Recipients       `json:"recipients"`
	RecipientsURI               string           `json:"recipientsUri"` // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/recipients
	Sender                      Sender           `json:"sender"`
	SentDateTime                string           `json:"sentDateTime"`          // 2023-05-26T18:55:48.257Z
	SignerCanSignOnMobile       string           `json:"signerCanSignOnMobile"` // "true"
	SignerLocation              string           `json:"signerLocation"`        // online
	Status                      string           `json:"status"`                // sent
	StatusChangedDateTime       string           `json:"statusChangedDateTime"` // 2023-05-26T18:55:48.257Z
	TemplatesURI                string           `json:"templatesUri"`          // /envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a/templates0:w
}

type DocuSignEventNotification 

type DocuSignEventNotification struct {
	URL            string                   `json:"url"`
	LoggingEnabled bool                     `json:"loggingEnabled"`
	EnvelopeEvents []DocuSignRecipientEvent `json:"envelopeEvents"`
}

type DocuSignGetTokenRequest 

type DocuSignGetTokenRequest struct {
	GrantType string `json:"grant_type"`
	Assertion string `json:"assertion"`
}

DocuSignGetTokenRequest is the request body for getting a token from DocuSign

type DocuSignGetTokenResponse 

type DocuSignGetTokenResponse struct {
	AccessToken string `json:"access_token"`
	TokenType   string `json:"token_type"`
	ExpiresIn   int    `json:"expires_in"`
	Scope       string `json:"scope"`
}

DocuSignGetTokenResponse is the response body for getting a token from DocuSign

type DocuSignRecipient 

type DocuSignRecipient struct {
	RecipientId string `json:"recipientId,omitempty"` // Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.

	ClientUserId string `json:"clientUserId,omitempty"` // Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

	/* The recipient type, as specified by the following values:
	agent:             Agent recipients can add name and email information for recipients that appear after the agent in routing order.
	carbonCopy:        Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.
	certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
	editor:            Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
	inPersonSigner:    In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
	intermediaries:    Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
	seal:              Electronic seal recipients represent legal entities.
	signer:            Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
	witness:           Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.
	*/
	RecipientType string `json:"recipientType,omitempty"`

	RoleName string `json:"roleName,omitempty"` // Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients.

	RoutingOrder string `json:"routingOrder,omitempty"` // Specifies the routing order of the recipient in the envelope.

	Name      string `json:"name,omitempty"`      // The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if firstName and lastName are set.
	FirstName string `json:"firstName,omitempty"` // recipient's first name (50 characters maximum)
	LastName  string `json:"lastName,omitempty"`  // recipient's last name
	Email     string `json:"email,omitempty"`     // recipient's email address
	Note      string `json:"note,omitempty"`      // A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.

	Tabs DocuSignTab `json:"tabs"` // The tabs associated with the recipient. The tabs property enables you to programmatically position tabs on the document. For example, you can specify that the SIGN_HERE tab is placed at a given (x,y) location on the document. You can also specify the font, font color, font size, and other properties of the text in the tab. You can also specify the location and size of the tab. For example, you can specify that the tab is 50 pixels wide and 20 pixels high. You can also specify the page number on which the tab is located and whether the tab is located in a document, a template, or an inline template. For more information about tabs, see the Tabs section of the REST API documentation.
}

DocuSignRecipient is the data model for an editor or signer from DocuSign

type DocuSignRecipientEvent 

type DocuSignRecipientEvent struct {
	EnvelopeEventStatusCode string `json:"envelopeEventStatusCode"`
}

type DocuSignRecipientType 

type DocuSignRecipientType struct {
	Agents              []DocuSignRecipient `json:"agent,omitempty"`
	CarbonCopies        []DocuSignRecipient `json:"carbonCopy,omitempty"`
	CertifiedDeliveries []DocuSignRecipient `json:"certifiedDelivery,omitempty"`
	Editors             []DocuSignRecipient `json:"editor,omitempty"`
	InPersonSigners     []DocuSignRecipient `json:"inPersonSigner,omitempty"`
	Intermediaries      []DocuSignRecipient `json:"intermediary,omitempty"`
	Notaries            []DocuSignRecipient `json:"notaryRecipient,omitempty"`
	Participants        []DocuSignRecipient `json:"participant,omitempty"`
	Seals               []DocuSignRecipient `json:"seals,omitempty"`          // A list of electronic seals to apply to documents.
	Signers             []DocuSignRecipient `json:"signers,omitempty"`        // A list of signers on the envelope.
	Witnesses           []DocuSignRecipient `json:"witness,omitempty"`        // A list of signers who act as witnesses for an envelope.
	RecipientCount      string              `json:"recipientCount,omitempty"` // The number of recipients in the envelope.
}

DocuSignRecipientType is the data model for a recipient from DocuSign

type DocuSignTab 

type DocuSignTab struct {
	ApproveTabs              []DocuSignTabDetails `json:"approveTabs,omitempty"`
	CheckBoxTabs             []DocuSignTabDetails `json:"checkboxTabs,omitempty"`
	CommentThreadTabs        []DocuSignTabDetails `json:"commentThreadTabs,omitempty"`
	CommissionCountyTabs     []DocuSignTabDetails `json:"commissionCountyTabs,omitempty"`
	CommissionExpirationTabs []DocuSignTabDetails `json:"commissionExpirationTabs,omitempty"`
	CommissionNumberTabs     []DocuSignTabDetails `json:"commissionNumberTabs,omitempty"`
	CommissionStateTabs      []DocuSignTabDetails `json:"commissionStateTabs,omitempty"`
	CompanyTabs              []DocuSignTabDetails `json:"companyTabs,omitempty"`
	DateSignedTabs           []DocuSignTabDetails `json:"dateSignedTabs,omitempty"`
	DateTabs                 []DocuSignTabDetails `json:"dateTabs,omitempty"`
	DeclinedTabs             []DocuSignTabDetails `json:"declineTabs,omitempty"`
	DrawTabs                 []DocuSignTabDetails `json:"drawTabs,omitempty"`
	EmailAddressTabs         []DocuSignTabDetails `json:"emailAddressTabs,omitempty"`
	EmailTabs                []DocuSignTabDetails `json:"emailTabs,omitempty"`
	EnvelopeIdTabs           []DocuSignTabDetails `json:"envelopeIdTabs,omitempty"`
	FirstNameTabs            []DocuSignTabDetails `json:"firstNameTabs,omitempty"`
	FormulaTabs              []DocuSignTabDetails `json:"formulaTab,omitempty"`
	FullNameTabs             []DocuSignTabDetails `json:"fullNameTabs,omitempty"`
	InitialHereTabs          []DocuSignTabDetails `json:"initialHereTabs,omitempty"`
	LastNameTabs             []DocuSignTabDetails `json:"lastNameTabs,omitempty"`
	ListTabs                 []DocuSignTabDetails `json:"listTabs,omitempty"`
	NotarizeTabs             []DocuSignTabDetails `json:"notarizeTabs,omitempty"`
	NotarySealTabs           []DocuSignTabDetails `json:"notarySealTabs,omitempty"`
	NoteTabs                 []DocuSignTabDetails `json:"noteTabs,omitempty"`
	NumberTabs               []DocuSignTabDetails `json:"numberTabs,omitempty"`
	NumericalTabs            []DocuSignTabDetails `json:"numericalTabs,omitempty"`
	PhoneNumberTabs          []DocuSignTabDetails `json:"phoneNumberTabs,omitempty"`
	PolyLineOverlayTabs      []DocuSignTabDetails `json:"polyLineOverlayTabs,omitempty"`
	PrefillTabs              []DocuSignTabDetails `json:"prefillTabs,omitempty"`
	RadioGroupTabs           []DocuSignTabDetails `json:"radioGroupTabs,omitempty"`
	SignerAttachmentTabs     []DocuSignTabDetails `json:"signerAttachmentTabs,omitempty"`
	SignHereTabs             []DocuSignTabDetails `json:"signHereTabs,omitempty"`
	SmartSectionTabs         []DocuSignTabDetails `json:"smartSectionTabs,omitempty"`
	SSNTabs                  []DocuSignTabDetails `json:"ssnTabs,omitempty"`
	TabGroups                []DocuSignTabDetails `json:"tabGroupTabs,omitempty"`
	TextTabs                 []DocuSignTabDetails `json:"textTabs,omitempty"`
	TitleTabs                []DocuSignTabDetails `json:"titleTabs,omitempty"`
	ViewTabs                 []DocuSignTabDetails `json:"viewTabs,omitempty"`
	ZipTabs                  []DocuSignTabDetails `json:"zipTabs,omitempty"`
	TextOptionalTabs         []DocuSignTabDetails `json:"textOptionalTabs,omitempty"`
	SignHereOptionalTabs     []DocuSignTabDetails `json:"signHereOptionalTabs,omitempty"`
}

DocuSignTab is the data model for a tab from DocuSign

type DocuSignTabDetails 

type DocuSignTabDetails struct {
	AnchorCaseSensitive       string `json:"anchorCaseSensitive,omitempty"`       // anchor case sensitive flag, "true" or "false"
	AnchorIgnoreIfNotPresent  string `json:"anchorIgnoreIfNotPresent,omitempty"`  // When true, this tab is ignored if the anchorString is not found in the document.
	AnchorHorizontalAlignment string `json:"anchorHorizontalAlignment,omitempty"` // This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are : left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. right: Aligns the tab’s left side with the last character of the matching anchor word.
	AnchorMatchWholeWord      string `json:"anchorMatchWholeWord,omitempty"`      // When true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false. For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When false, if the input is man then man, manpower, fireman, and penmanship will all match.
	AnchorString              string `json:"anchorString,omitempty"`              // Specifies the string to find in the document and use as the basis for tab placement
	AnchorUnits               string `json:"anchorUnits,omitempty"`               // anchor units, pixels, cms, mms
	AnchorXOffset             string `json:"anchorXOffset,omitempty"`             // anchor x offset
	AnchorYOffset             string `json:"anchorYOffset,omitempty"`             // anchor y offset
	Bold                      string `json:"bold,omitempty"`                      // bold flag, "true" or "false"
	DocumentId                string `json:"documentId,omitempty"`                // Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
	Font                      string `json:"font,omitempty"`                      // font
	FontSize                  string `json:"fontSize,omitempty"`                  // font size
	Height                    string `json:"height,omitempty"`                    // The height of the tab in pixels. Must be an integer.
	Locked                    string `json:"locked,omitempty"`                    // locked flag, "true" or "false"
	MinNumericalValue         string `json:"minNumericalValue,omitempty"`         // minimum numerical value, such as "0", used for validation of numerical tabs
	MaxNumericalValue         string `json:"maxNumericalValue,omitempty"`         // maximum numerical value, such as "100", used for validation of numerical tabs
	Name                      string `json:"name,omitempty"`                      // The name of the tab. For example, Sign Here or Initial Here. If the tooltip attribute is not set, this value will be displayed as the custom tooltip text.
	Optional                  string `json:"optional,omitempty"`                  // When true, the recipient does not need to complete this tab to complete the signing process
	PageNumber                string `json:"pageNumber,omitempty"`                // Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
	Required                  string `json:"required,omitempty"`                  // When true, the signer is required to fill out this tab
	TabId                     string `json:"tabId,omitempty"`                     // tab idj
	TabLabel                  string `json:"tabLabel,omitempty"`                  // label
	TabOrder                  string `json:"tabOrder,omitempty"`                  // A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.
	TabType                   string `json:"tabType,omitempty"`                   // Indicates type of tab (for example: signHere or initialHere)
	ToolTip                   string `json:"toolTip,omitempty"`                   // The text of a tooltip that appears when a user hovers over a form field or tab.
	Width                     string `json:"width,omitempty"`                     // The width of the tab in pixels. Must be an integer. This is not applicable to Sign Here tab.
	XPosition                 string `json:"xPosition,omitempty"`                 // x position
	YPosition                 string `json:"yPosition,omitempty"`                 // x position
	ValidationType            string `json:"validationType,omitempty"`            // validation type, "string", "number", "date", "zipcode", "currency"
	Value                     string `json:"value,omitempty"`
	CustomTabId               string `json:"customTabId,omitempty"`
}

DocuSignTabDetails is the data model for a tab from DocuSign

type DocuSignTemplateRole 

type DocuSignTemplateRole struct {
	Name         string `json:"name,omitempty"`         // the recipient's email address
	Email        string `json:"email,omitempty"`        // the recipient's name
	RoleName     string `json:"roleName,omitempty"`     // the template role name associated with the recipient
	ClientUserID string `json:"clientUserId,omitempty"` // Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. If the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.
	RoutingOrder string `json:"routingOrder,omitempty"` // Specifies the routing order of the recipient in the envelope.
}

DocuSignTemplateRole is the request body for a template role from DocuSign

type DocuSignUpdateDocumentResponse 

type DocuSignUpdateDocumentResponse struct {
	/*
		{"documentId":"1","documentIdGuid":"2c205f31-4c6b-4237-b6bc-d79457b949a5","name":"document.pdf","type":"content","uri":"/envelopes/ebeee6a6-c17f-4d05-8441-38d5c1ad9675/documents/1","order":"1","containsPdfFormFields":"false","templateRequired":"false","authoritativeCopy":"false"}
	*/
	DocumentId            string `json:"documentId,omitempty"`
	DocumentIdGuid        string `json:"documentIdGuid,omitempty"`
	Name                  string `json:"name,omitempty"`
	Type                  string `json:"type,omitempty"`
	Uri                   string `json:"uri,omitempty"`
	Order                 string `json:"order,omitempty"`
	ContainsPdfFormFields string `json:"containsPdfFormFields,omitempty"`
	TemplateRequired      string `json:"templateRequired,omitempty"`
	AuthoritativeCopy     string `json:"authoritativeCopy,omitempty"`
}

DocuSignUpdateDocumentResponse is the response body for adding/updating a document to an envelope from DocuSign

type DocuSignUserInfoResponse 

type DocuSignUserInfoResponse struct {
	Sub        string `json:"sub"` // holds the GUID API username of the user that is being impersonated
	Name       string `json:"name"`
	GivenName  string `json:"given_name"`
	FamilyName string `json:"family_name"`
	Created    string `json:"created"`
	Email      string `json:"email"`
	Accounts   []struct {
		AccountId   string `json:"account_id"`
		IsDefault   bool   `json:"is_default"`
		AccountName string `json:"account_name"`
		BaseUri     string `json:"base_uri"`
	} `json:"accounts"`
}

DocuSignUserInfoResponse is the response body for getting user info from DocuSign

type DocuSignWebhookData 

type DocuSignWebhookData struct {
	AccountID       string                  `json:"accountId"`  // 77c754e9-4016-4ccc-957f-15eaa18f2d22
	EnvelopeID      string                  `json:"envelopeId"` // 016d4678-bf5c-41f3-b7c9-5c58606cdb4a
	EnvelopeSummary DocuSignEnvelopeSummary `json:"envelopeSummary"`
	UserID          string                  `json:"userId"` // 9fd66d5d-7396-4b80-a85e-2a7e536471b1
}

type DocuSignWebhookModel 

type DocuSignWebhookModel struct {
	APIVersion        string              `json:"apiVersion"`      // v2.1
	ConfigurationID   int                 `json:"configurationId"` // 10418598
	Data              DocuSignWebhookData `json:"data"`
	Event             string              `json:"event"`             // envelope-sent, envelope-completed
	GeneratedDateTime string              `json:"generatedDateTime"` // generated_date_time
	URI               string              `json:"uri"`               // /restapi/v2.1/accounts/77c754e9-4016-4ccc-957f-15eaa18f2d22/envelopes/016d4678-bf5c-41f3-b7c9-5c58606cdb4a
}

DocuSignWebhookModel represents the webhook callback data model from DocuSign

type DocuSignXMLData 

type DocuSignXMLData struct {
	XMLName        xml.Name `xml:"EnvelopeStatus"`
	EnvelopeID     string   `xml:"EnvelopeID"`
	Status         string   `xml:"Status"`
	Subject        string   `xml:"Subject"`
	UserName       string   `xml:"UserName"`
	Email          string   `xml:"Email"`
	SignedDateTime string   `xml:"SignedDateTime"`
}

type DocumentStatus 

type DocumentStatus struct {
	ID           string `xml:"ID"`
	Name         string `xml:"Name"`
	TemplateName string `xml:"TemplateName"`
	Sequence     int    `xml:"Sequence"`
}

DocumentStatus represents the <DocumentStatus> element

type DocusignEnvelopeResponse 

type DocusignEnvelopeResponse struct {
	EnvelopeId     string `json:"envelopeId,omitempty"`
	Status         string `json:"status,omitempty"`
	StatusDateTime string `json:"statusDateTime,omitempty"`
	Uri            string `json:"uri,omitempty"`
}

DocusignEnvelopeResponse

type DocusignRecipientResponse 

type DocusignRecipientResponse struct {
	Signers []Signer `json:"signers"`
}

type DocusignRecipientView 

type DocusignRecipientView struct {
	Email               string `json:"email"`
	Username            string `json:"userName"`
	ReturnURL           string `json:"returnUrl"`
	RecipientID         string `json:"recipientId"`
	ClientUserId        string `json:"clientUserId,omitempty"`
	AuthenticaionMethod string `json:"authenticationMethod"`
}

type DocusignRecipientViewResponse 

type DocusignRecipientViewResponse struct {
	URL string `json:"url"`
}

type EnvelopeMetadata 

type EnvelopeMetadata struct {
	AllowAdvancedCorrect string `json:"allowAdvancedCorrect"` // "false"
	AllowCorrect         string `json:"allowCorrect"`         // "true"
	EnableSignWithNotary string `json:"enableSignWithNotary"` // "false"
}

type EnvelopeStatus 

type EnvelopeStatus struct {
	RecipientStatuses  []RecipientStatus `xml:"RecipientStatuses>RecipientStatus"`
	TimeGenerated      string            `xml:"TimeGenerated"`
	EnvelopeID         string            `xml:"EnvelopeID"`
	Subject            string            `xml:"Subject"`
	UserName           string            `xml:"UserName"`
	Email              string            `xml:"Email"`
	Status             string            `xml:"Status"`
	Created            string            `xml:"Created"`
	Sent               string            `xml:"Sent"`
	Delivered          string            `xml:"Delivered"`
	Signed             string            `xml:"Signed"`
	Completed          string            `xml:"Completed"`
	ACStatus           string            `xml:"ACStatus"`
	ACStatusDate       string            `xml:"ACStatusDate"`
	ACHolder           string            `xml:"ACHolder"`
	ACHolderEmail      string            `xml:"ACHolderEmail"`
	ACHolderLocation   string            `xml:"ACHolderLocation"`
	SigningLocation    string            `xml:"SigningLocation"`
	SenderIPAddress    string            `xml:"SenderIPAddress"`
	EnvelopePDFHash    string            `xml:"EnvelopePDFHash"` // Assuming string, adjust as necessary
	CustomFields       string            `xml:"CustomFields"`    // Assuming string, adjust as necessary
	AutoNavigation     bool              `xml:"AutoNavigation"`
	EnvelopeIdStamping bool              `xml:"EnvelopeIdStamping"`
	AuthoritativeCopy  bool              `xml:"AuthoritativeCopy"`
	DocumentStatuses   []DocumentStatus  `xml:"DocumentStatuses>DocumentStatus"`
}

EnvelopeStatus represents the <EnvelopeStatus> element

type EsignAgreement 

type EsignAgreement struct {
	AccountEsignId string `xml:"AccountEsignId"`
}

EsignAgreement represents the <EsignAgreement> element

type EventData 

type EventData struct {
	Version     string   `json:"version,omitempty"`
	Format      string   `json:"format,omitempty"`
	IncludeData []string `json:"includeData,omitempty"`
}

EventData represents the eventData attribute in DocusignEventNotification.

type Field 

type Field struct {
	Name  string `xml:"name,attr"`
	Value string `xml:"value"`
}

Field represents the <field> element within <xfdf>

type FormData 

type FormData struct {
	XFDF XFDF `xml:"xfdf"`
}

FormData represents the <FormData> element

type IndividualMembershipDocuSignDBSummaryModel 

type IndividualMembershipDocuSignDBSummaryModel struct {
	DocuSignEnvelopeID               string         `db:"docusign_envelope_id"`
	DocuSignEnvelopeCreatedAt        string         `db:"docusign_envelope_created_at"`
	DocuSignEnvelopeSigningStatus    string         `db:"docusign_envelope_signing_status"`
	DocuSignEnvelopeSigningUpdatedAt string         `db:"docusign_envelope_signing_updated_at"`
	Memo                             sql.NullString `db:"memo"`
}

IndividualMembershipDocuSignDBSummaryModel is the data model for an individual membership DocuSign database summary models

type ProjectRepo 

type ProjectRepo interface {
	GetCLAGroupByID(ctx context.Context, claGroupID string, loadRepoDetails bool) (*v1Models.ClaGroup, error)
}

ProjectRepo contains project repo methods

type Recipient 

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

type RecipientStatus 

type RecipientStatus struct {
	Type                      string         `xml:"Type"`
	Email                     string         `xml:"Email"`
	UserName                  string         `xml:"UserName"`
	RoutingOrder              int            `xml:"RoutingOrder"`
	Sent                      string         `xml:"Sent"`
	Delivered                 string         `xml:"Delivered"`
	Signed                    string         `xml:"Signed"`
	DeclineReason             string         `xml:"DeclineReason"`
	Status                    string         `xml:"Status"`
	RecipientIPAddress        string         `xml:"RecipientIPAddress"`
	ClientUserId              string         `xml:"ClientUserId"`
	CustomFields              string         `xml:"CustomFields"`
	TabStatuses               []TabStatus    `xml:"TabStatuses>TabStatus"`
	RecipientAttachment       []Attachment   `xml:"RecipientAttachment>Attachment"`
	AccountStatus             string         `xml:"AccountStatus"`
	EsignAgreementInformation EsignAgreement `xml:"EsignAgreementInformation"`
	FormData                  FormData       `xml:"FormData"`
	RecipientId               string         `xml:"RecipientId"`
}

RecipientStatus represents the <RecipientStatus> element

type RecipientViewResponse 

type RecipientViewResponse struct {
	URL string `json:"url"`
}

Define a struct to represent the response from the DocuSign API.

type Recipients 

type Recipients struct {
	Agents              []interface{}   `json:"agents"`              // <nil>
	CarbonCopies        []interface{}   `json:"carbonCopies"`        // <nil>
	CertifiedDeliveries []interface{}   `json:"certifiedDeliveries"` // <nil>
	CurrentRoutingOrder string          `json:"currentRoutingOrder"` // 1
	Editors             []interface{}   `json:"editors"`             // <nil>
	InPersonSigners     []interface{}   `json:"inPersonSigners"`     // <nil>
	Intermediaries      []interface{}   `json:"intermediaries"`      // <nil>
	Notaries            []interface{}   `json:"notaries"`            // <nil>
	RecipientCount      string          `json:"recipientCount"`      // 1
	Seals               []interface{}   `json:"seals"`               // <nil>
	Signers             []WebhookSigner `json:"signers"`
	Witnesses           []interface{}   `json:"witnesses"` // <nil>
}

type Sender 

type Sender struct {
	AccountID string `json:"accountId"` // 9fd66d5d-7396-4b80-a85e-2a7e536471b1
	Email     string `json:"email"`     // test@test
	IPAddress string `json:"ipAddress"` // 35.11.11.111
	UserName  string `json:"userName"`  // Test DocuSign
	UserID    string `json:"userId"`    // 9fd66d5d-7396-4b80-a85e-2a7e536471b1
}

type Service 

type Service interface {
	VoidEnvelope(ctx context.Context, envelopeID, message string) error
	PrepareSignRequest(ctx context.Context, signRequest *DocuSignEnvelopeRequest) (*DocusignEnvelopeResponse, error)
	GetSignURL(email, recipientID, userName, clientUserId, envelopeID, returnURL string) (string, error)

	RequestCorporateSignature(ctx context.Context, lfUsername string, authorizationHeader string, input *models.CorporateSignatureInput) (*models.CorporateSignatureOutput, error)
	RequestIndividualSignature(ctx context.Context, input *models.IndividualSignatureInput, preferredEmail string) (*models.IndividualSignatureOutput, error)
	RequestIndividualSignatureGerrit(ctx context.Context, input *models.IndividualSignatureInput) (*models.IndividualSignatureOutput, error)
	SignedIndividualCallbackGithub(ctx context.Context, payload []byte, installationID, changeRequestID, repositoryID string) error
	SignedIndividualCallbackGitlab(ctx context.Context, payload []byte, userID, organizationID, repositoryID, mergeRequestID string) error
	SignedIndividualCallbackGerrit(ctx context.Context, payload []byte, userID string) error
	SignedCorporateCallback(ctx context.Context, payload []byte, companyID, projectID string) error
	// contains filtered or unexported methods
}

Service interface defines the sign service methods

func NewService 

func NewService(apiURL, v1API string, compRepo company.IRepository, projectRepo ProjectRepo, pcgRepo projects_cla_groups.Repository, compService company.IService, claGroupService cla_groups.Service, docsignPrivateKey string, userService users.Service, signatureService signatures.SignatureService, storeRepository store.Repository,
	repositoryService repositories.Service, githubOrgService github_organizations.Service, gitlabOrgService gitlab_organizations.ServiceInterface, claLandingPage string, claLogoURL string, emailTemplateService emails.EmailTemplateService, eventsService events.Service, gitlabActivityService gitlab_activity.Service, gitlabApp *gitlab_api.App,
	gerritService gerrits.Service) Service

NewService returns an instance of v2 project service

type Signer 

type Signer struct {
	CreationReason  string `json:"creationReason"`
	IsBulkRecipient string `json:"isBulkRecipient"`
	Name            string `json:"name"`
	Email           string `json:"email"`
	RecipientId     string `json:"recipientId"`
	RecipientIdGuid string `json:"recipientIdGuid"`
	RequireIdLookup string `json:"requireIdLookup"`
	UserId          string `json:"userId"`
	ClientUserId    string `json:"clientUserId"`
	RoutingOrder    string `json:"routingOrder"`
	RoleName        string `json:"roleName"`
	Status          string `json:"status"`
}

type TabStatus 

type TabStatus struct {
	TabType       string `xml:"TabType"`
	Status        string `xml:"Status"`
	XPosition     int    `xml:"XPosition"`
	YPosition     int    `xml:"YPosition"`
	TabLabel      string `xml:"TabLabel"`
	TabName       string `xml:"TabName"`
	TabValue      string `xml:"TabValue"`
	DocumentID    string `xml:"DocumentID"`
	PageNumber    int    `xml:"PageNumber"`
	CustomTabType string `xml:"CustomTabType"`
}

TabStatus represents the <TabStatus> element

type TextOptionalTab 

type TextOptionalTab struct {
	Name     string `json:"name"`
	Value    string `json:"value"`
	Height   int    `json:"height"`
	Width    int    `json:"width"`
	Locked   bool   `json:"locked"`
	Required bool   `json:"required"`
}

type UserSignDetails 

type UserSignDetails struct {
	// contains filtered or unexported fields
}

type WebhookSigner 

type WebhookSigner struct {
	CompletedCount         string `json:"completedCount"`         // 0
	CreationReason         string `json:"creationReason"`         // sender
	DeliveryMethod         string `json:"deliveryMethod"`         // email
	Email                  string `json:"email"`                  // test@test
	IsBulkRecipient        string `json:"isBulkRecipient"`        // "false"
	Name                   string `json:"name"`                   // Test DocuSign
	RecipientID            string `json:"recipientId"`            // 1
	RecipientIDGuid        string `json:"recipientIdGuid"`        // 9fd66d5d-7396-4b80-a85e-2a7e536471b1
	ReceipientType         string `json:"recipientType"`          // signer
	RequireIdLookup        string `json:"requireIdLookup"`        // "false"
	RequireUploadSignature string `json:"requireUploadSignature"` // "false"
	RoutingOrder           string `json:"routingOrder"`           // 1
	SentDateTime           string `json:"sentDateTime"`           // 2023-05-26T18:55:48.257Z
	Status                 string `json:"status"`                 // sent
	UserId                 string `json:"userId"`                 // 9fd66d5d-7396-4b80-a85e-2a7e536471b1
}

type XFDF 

type XFDF struct {
	Fields []Field `xml:"fields>field"`
}

XFDF represents the <xfdf> element within <FormData>

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.