click

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: May 12, 2023 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Overview

Package click implements the DocuSign SDK category Click.

Service Api documentation may be found at: https://developers.docusign.com/docs/click-api/reference/accounts Usage example: 

import (
    "github.com/jfcote87/esign"
)
...
clickService := click.New(esignCredential)

Code generated by gen-esign; DO NOT EDIT.

Index

Constants

View Source 
const (
	// OAuthScopeManage enables all clickwrap operations, including creating, sending, and updating clickwraps;
	// getting a list of clickwraps, creating user agreements, getting a list of users, and retrieving responses.
	OAuthScopeManage = "click.manage"
	// OAuthScopeSend required to send a new clickwrap or check for a previously sent one.
	OAuthScopeSend = "click.send"
)

For more infomation on how to use scopes, see https://developers.docusign.com/docs/click-api/click101/auth/

Variables

This section is empty.

Functions

This section is empty.

Types

type ClickwrapAgreementsResponse added in v0.10.0 

type ClickwrapAgreementsResponse struct {
	// User agreements from this datetime.
	BeginCreatedOn interface{} `json:"beginCreatedOn,omitempty"`
	// Number of pages remaining in the response.
	MinimumPagesRemaining int32 `json:"minimumPagesRemaining,omitempty"`
	// The number of the current page.
	Page int32 `json:"page,omitempty"`
	// The number of items per page.
	PageSize int32 `json:"pageSize,omitempty"`
	// An array of user agreements.
	UserAgreements []UserAgreementResponse `json:"userAgreements,omitempty"`
}

ClickwrapAgreementsResponse not described in definition file

type ClickwrapDeleteResponse added in v0.10.0 

type ClickwrapDeleteResponse struct {
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// A message describing the result of deletion request. One of:
	//
	// - `alreadyDeleted`: Clickwrap is already deleted.
	// - `deletionSuccess`: Successfully deleted the clickwrap.
	// - `deletionFailure`: Failed to delete the clickwrap.
	// - `cannotDelete`: Active clickwrap version cannot be deleted.
	DeletionMessage string `json:"deletionMessage,omitempty"`
	// **True** if the clickwrap was deleted successfully. **False** otherwise.
	DeletionSuccess bool `json:"deletionSuccess,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status string `json:"status,omitempty"`
}

ClickwrapDeleteResponse not described in definition file

type ClickwrapRequest added in v0.10.0 

type ClickwrapRequest struct {
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// Display settings for this clickwrap.
	DisplaySettings *DisplaySettings `json:"displaySettings,omitempty"`
	// An array of documents.
	Documents []Document `json:"documents,omitempty"`
	// Specifies whether `scheduledReacceptance` and `scheduledDate` should be cleared. May be one of:
	//
	// - `"scheduledReacceptance"`
	// - `"scheduledDate"`
	// - `"scheduledReacceptance,scheduledDate"`
	//
	FieldsToNull string `json:"fieldsToNull,omitempty"`
	// When **true**, the next version created is a major version. When **false** the next version created is minor.
	IsMajorVersion bool `json:"isMajorVersion,omitempty"`
	//
	IsShared bool `json:"isShared,omitempty"`
	// Name of the clickwrap.
	Name string `json:"name,omitempty"`
	// When **true**, requires signers who have previously agreed to this
	// clickwrap to sign again. The version number is incremented.
	RequireReacceptance bool `json:"requireReacceptance,omitempty"`
	// The time and date when this clickwrap is activated.
	ScheduledDate interface{} `json:"scheduledDate,omitempty"`
	// Specifies the interval between reacceptances in days, weeks, months, or years.
	ScheduledReacceptance *ClickwrapScheduledReacceptance `json:"scheduledReacceptance,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status interface{} `json:"status,omitempty"`
	// The user ID of current owner of the clickwrap.
	TransferFromUserID string `json:"transferFromUserId,omitempty"`
	// The user ID of the new owner of the clickwrap.
	TransferToUserID string `json:"transferToUserId,omitempty"`
}

ClickwrapRequest request body for working with clickwrap.

type ClickwrapScheduledReacceptance added in v0.10.0 

type ClickwrapScheduledReacceptance struct {
	// The time between recurrences specified in `recurrenceIntervalType` units.
	//
	// The minimum and maximum values depend on `recurrenceIntervalType`:
	//
	// - `days`: 1 - 365
	// - `weeks`: 1 - 52
	// - `months`: 1 - 12
	// - `years`: 1
	RecurrenceInterval int32 `json:"recurrenceInterval,omitempty"`
	// The units of the `recurrenceInterval`. Must be one of:
	//
	// - `days`
	// - `weeks`
	// - `month`
	// - `years`
	//
	RecurrenceIntervalType string `json:"recurrenceIntervalType,omitempty"`
	// The date when the recurrence interval starts.
	StartDateTime interface{} `json:"startDateTime,omitempty"`
}

ClickwrapScheduledReacceptance not described in definition file

type ClickwrapTransferRequest added in v0.10.0 

type ClickwrapTransferRequest struct {
	// ID of the user to transfer from.
	TransferFromUserID string `json:"transferFromUserId,omitempty"`
	// ID of the user to transfer to.
	TransferToUserID string `json:"transferToUserId,omitempty"`
}

ClickwrapTransferRequest not described in definition file

type ClickwrapVersion added in v0.10.0 

type ClickwrapVersion struct {
	// The unique version ID, a GUID, of this clickwrap version.
	ClickwrapVersionID string `json:"clickwrapVersionId,omitempty"`
	// The time that the clickwrap was created.
	CreatedTime interface{} `json:"createdTime,omitempty"`
	// The time that the clickwrap was last modified.
	LastModified interface{} `json:"lastModified,omitempty"`
	// The user ID of the last user who modified this clickwrap.
	LastModifiedBy string `json:"lastModifiedBy,omitempty"`
	// The user ID of the owner of this clickwrap.
	OwnerUserID string `json:"ownerUserId,omitempty"`
	// When **true**, requires signers who have previously agreed to this
	// clickwrap to sign again. The version number is incremented.
	RequireReacceptance bool `json:"requireReacceptance,omitempty"`
	// The time and date when this clickwrap is activated.
	ScheduledDate interface{} `json:"scheduledDate,omitempty"`
	// Specifies the interval between reacceptances in days, weeks, months, or years.
	ScheduledReacceptance *ClickwrapScheduledReacceptance `json:"scheduledReacceptance,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status string `json:"status,omitempty"`
	// The ID of the version.
	VersionID string `json:"versionId,omitempty"`
	// Version of the clickwrap.
	VersionNumber string `json:"versionNumber,omitempty"`
}

ClickwrapVersion not described in definition file

type ClickwrapVersionDeleteResponse added in v0.10.0 

type ClickwrapVersionDeleteResponse struct {
	// The unique version ID, a GUID, of this clickwrap version.
	ClickwrapVersionID string `json:"clickwrapVersionId,omitempty"`
	// The time that the clickwrap was created.
	CreatedTime interface{} `json:"createdTime,omitempty"`
	// A message describing the result of deletion request. One of:
	//
	// - `alreadyDeleted`: Clickwrap is already deleted.
	// - `deletionSuccess`: Successfully deleted the clickwrap.
	// - `deletionFailure`: Failed to delete the clickwrap.
	// - `cannotDelete`: Active clickwrap version cannot be deleted.
	DeletionMessage string `json:"deletionMessage,omitempty"`
	// **True** if the clickwrap was deleted successfully. **False** otherwise.
	DeletionSuccess bool `json:"deletionSuccess,omitempty"`
	// The time that the clickwrap was last modified.
	LastModified interface{} `json:"lastModified,omitempty"`
	// The user ID of the last user who modified this clickwrap.
	LastModifiedBy string `json:"lastModifiedBy,omitempty"`
	// The user ID of the owner of this clickwrap.
	OwnerUserID string `json:"ownerUserId,omitempty"`
	// When **true**, requires signers who have previously agreed to this
	// clickwrap to sign again. The version number is incremented.
	RequireReacceptance bool `json:"requireReacceptance,omitempty"`
	// The time and date when this clickwrap is activated.
	ScheduledDate interface{} `json:"scheduledDate,omitempty"`
	// Specifies the interval between reacceptances in days, weeks, months, or years.
	ScheduledReacceptance *ClickwrapScheduledReacceptance `json:"scheduledReacceptance,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status string `json:"status,omitempty"`
	// The ID of the version.
	VersionID string `json:"versionId,omitempty"`
	// Version of the clickwrap.
	VersionNumber string `json:"versionNumber,omitempty"`
}

ClickwrapVersionDeleteResponse not described in definition file

type ClickwrapVersionResponse added in v0.10.0 

type ClickwrapVersionResponse struct {
	// A GUID that identifies your account.
	// This value is automatically generated by
	// DocuSign for any account you create. Copy the
	// value from the **API Account ID** field in
	// the **API and Keys** page in
	// eSignature Settings.
	//
	AccountID string `json:"accountId,omitempty"`
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// The unique version ID, a GUID, of this clickwrap version.
	ClickwrapVersionID string `json:"clickwrapVersionId,omitempty"`
	// The time that the clickwrap was created.
	CreatedTime interface{} `json:"createdTime,omitempty"`
	// Display settings for a clickwrap.
	DisplaySettings *DisplaySettings `json:"displaySettings,omitempty"`
	// An array of documents.
	Documents []Document `json:"documents,omitempty"`
	// The time that the clickwrap was last modified.
	LastModified interface{} `json:"lastModified,omitempty"`
	// The user ID of the last user who modified this clickwrap.
	LastModifiedBy string `json:"lastModifiedBy,omitempty"`
	// The user ID of the owner of this clickwrap.
	OwnerUserID string `json:"ownerUserId,omitempty"`
	// When **true**, requires signers who have previously agreed to this
	// clickwrap to sign again. The version number is incremented.
	RequireReacceptance bool `json:"requireReacceptance,omitempty"`
	// The time and date when this clickwrap is activated.
	ScheduledDate interface{} `json:"scheduledDate,omitempty"`
	// Specifies the interval between reacceptances in days, weeks, months, or years.
	ScheduledReacceptance *ClickwrapScheduledReacceptance `json:"scheduledReacceptance,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status string `json:"status,omitempty"`
	// The ID of the version.
	VersionID string `json:"versionId,omitempty"`
	// Version of the clickwrap.
	VersionNumber string `json:"versionNumber,omitempty"`
}

ClickwrapVersionResponse not described in definition file

type ClickwrapVersionSummaryResponse added in v0.10.0 

type ClickwrapVersionSummaryResponse struct {
	// A GUID that identifies your account.
	// This value is automatically generated by
	// DocuSign for any account you create. Copy the
	// value from the **API Account ID** field in
	// the **API and Keys** page in
	// eSignature Settings.
	//
	AccountID string `json:"accountId,omitempty"`
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// The unique version ID, a GUID, of this clickwrap version.
	ClickwrapVersionID string `json:"clickwrapVersionId,omitempty"`
	// The time that the clickwrap was created.
	CreatedTime interface{} `json:"createdTime,omitempty"`
	// The time that the clickwrap was last modified.
	LastModified interface{} `json:"lastModified,omitempty"`
	// The user ID of the last user who modified this clickwrap.
	LastModifiedBy string `json:"lastModifiedBy,omitempty"`
	// The user ID of the owner of this clickwrap.
	OwnerUserID string `json:"ownerUserId,omitempty"`
	// When **true**, requires signers who have previously agreed to this
	// clickwrap to sign again. The version number is incremented.
	RequireReacceptance bool `json:"requireReacceptance,omitempty"`
	// The time and date when this clickwrap is activated.
	ScheduledDate interface{} `json:"scheduledDate,omitempty"`
	// Specifies the interval between reacceptances in days, weeks, months, or years.
	ScheduledReacceptance *ClickwrapScheduledReacceptance `json:"scheduledReacceptance,omitempty"`
	// Clickwrap status. Possible values:
	//
	// - `active`
	// - `inactive`
	// - `deleted`
	Status string `json:"status,omitempty"`
	// The ID of the version.
	VersionID string `json:"versionId,omitempty"`
	// Version of the clickwrap.
	VersionNumber string `json:"versionNumber,omitempty"`
}

ClickwrapVersionSummaryResponse not described in definition file

type ClickwrapVersionsDeleteResponse added in v0.10.0 

type ClickwrapVersionsDeleteResponse struct {
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// An array delete responses.
	Versions []ClickwrapVersionDeleteResponse `json:"versions,omitempty"`
}

ClickwrapVersionsDeleteResponse not described in definition file

type ClickwrapVersionsPagedResponse added in v0.10.0 

type ClickwrapVersionsPagedResponse struct {
	// A GUID that identifies your account.
	// This value is automatically generated by
	// DocuSign for any account you create. Copy the
	// value from the **API Account ID** field in
	// the **API and Keys** page in
	// eSignature Settings.
	//
	AccountID string `json:"accountId,omitempty"`
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The name of the clickwrap.
	ClickwrapName string `json:"clickwrapName,omitempty"`
	// Number of pages remaining in the response.
	MinimumPagesRemaining int32 `json:"minimumPagesRemaining,omitempty"`
	// The number of the current page.
	Page int32 `json:"page,omitempty"`
	// The number of items per page.
	PageSize int32 `json:"pageSize,omitempty"`
	// An array of clickwrap versions.
	Versions []ClickwrapVersion `json:"versions,omitempty"`
}

ClickwrapVersionsPagedResponse not described in definition file

type ClickwrapVersionsResponse added in v0.10.0 

type ClickwrapVersionsResponse struct {
	// An array of `clickwrapVersionSummaryResponse` objects.
	Clickwraps []ClickwrapVersionSummaryResponse `json:"clickwraps,omitempty"`
	// Number of pages remaining in the response.
	MinimumPagesRemaining int32 `json:"minimumPagesRemaining,omitempty"`
	// The number of the current page.
	Page int32 `json:"page,omitempty"`
	// The number of items per page.
	PageSize int32 `json:"pageSize,omitempty"`
}

ClickwrapVersionsResponse not described in definition file

type ClickwrapsDeleteResponse added in v0.10.0 

type ClickwrapsDeleteResponse struct {
	//
	Clickwraps []ClickwrapDeleteResponse `json:"clickwraps,omitempty"`
}

ClickwrapsDeleteResponse not described in definition file

type CreateClickwrapOp added in v0.10.0 

type CreateClickwrapOp esign.Op

CreateClickwrapOp implements DocuSign API SDK Click::createClickwrap

func (*CreateClickwrapOp) Do added in v0.10.0 

func (op *CreateClickwrapOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type CreateClickwrapVersionOp added in v0.10.0 

type CreateClickwrapVersionOp esign.Op

CreateClickwrapVersionOp implements DocuSign API SDK Click::createClickwrapVersion

func (*CreateClickwrapVersionOp) Do added in v0.10.0 

func (op *CreateClickwrapVersionOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type CreateHasAgreedOp added in v0.10.0 

type CreateHasAgreedOp esign.Op

CreateHasAgreedOp implements DocuSign API SDK Click::createHasAgreed

func (*CreateHasAgreedOp) Do added in v0.10.0 

func (op *CreateHasAgreedOp) Do(ctx context.Context) (UserAgreementResponse, error)

Do executes the op. A nil context will return error.

type DeleteClickwrapOp added in v0.10.0 

type DeleteClickwrapOp esign.Op

DeleteClickwrapOp implements DocuSign API SDK Click::deleteClickwrap

func (*DeleteClickwrapOp) Do added in v0.10.0 

func (op *DeleteClickwrapOp) Do(ctx context.Context) (ClickwrapVersionsDeleteResponse, error)

Do executes the op. A nil context will return error.

func (*DeleteClickwrapOp) Versions added in v0.10.0 

func (op *DeleteClickwrapOp) Versions(val string) *DeleteClickwrapOp

Versions is a comma-separated list of versions to delete.

type DeleteClickwrapVersionByNumberOp added in v0.10.0 

type DeleteClickwrapVersionByNumberOp esign.Op

DeleteClickwrapVersionByNumberOp implements DocuSign API SDK Click::deleteClickwrapVersionByNumber

func (*DeleteClickwrapVersionByNumberOp) Do added in v0.10.0 

func (op *DeleteClickwrapVersionByNumberOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type DeleteClickwrapVersionOp added in v0.10.0 

type DeleteClickwrapVersionOp esign.Op

DeleteClickwrapVersionOp implements DocuSign API SDK Click::deleteClickwrapVersion

func (*DeleteClickwrapVersionOp) Do added in v0.10.0 

func (op *DeleteClickwrapVersionOp) Do(ctx context.Context) (ClickwrapVersionDeleteResponse, error)

Do executes the op. A nil context will return error.

type DeleteClickwrapVersionsOp added in v0.10.0 

type DeleteClickwrapVersionsOp esign.Op

DeleteClickwrapVersionsOp implements DocuSign API SDK Click::deleteClickwrapVersions

func (*DeleteClickwrapVersionsOp) ClickwrapVersionIds added in v0.10.0 

func (op *DeleteClickwrapVersionsOp) ClickwrapVersionIds(val string) *DeleteClickwrapVersionsOp

ClickwrapVersionIds is a comma-separated list of clickwrap version IDs to delete.

func (*DeleteClickwrapVersionsOp) Do added in v0.10.0 

func (op *DeleteClickwrapVersionsOp) Do(ctx context.Context) (ClickwrapVersionsDeleteResponse, error)

Do executes the op. A nil context will return error.

type DeleteClickwrapsOp added in v0.10.0 

type DeleteClickwrapsOp esign.Op

DeleteClickwrapsOp implements DocuSign API SDK Click::deleteClickwraps

func (*DeleteClickwrapsOp) ClickwrapIds added in v0.10.0 

func (op *DeleteClickwrapsOp) ClickwrapIds(val string) *DeleteClickwrapsOp

ClickwrapIds is a comma-separated list of clickwrap IDs to delete.

func (*DeleteClickwrapsOp) Do added in v0.10.0 

func (op *DeleteClickwrapsOp) Do(ctx context.Context) (ClickwrapsDeleteResponse, error)

Do executes the op. A nil context will return error.

type DisplaySettings 

type DisplaySettings struct {
	// Position of the Accept button in the agreement. One of
	//
	// - `right`
	// - `left`
	//
	ActionButtonAlignment string `json:"actionButtonAlignment,omitempty"`
	// When **true**, this agreement can be be used in client-only integrations
	AllowClientOnly bool `json:"allowClientOnly,omitempty"`
	// Hosts that can host the clickwrap.
	//
	// It is an error if the clickwrap didn't come from one of these hosts.
	//
	AllowedHosts []string `json:"allowedHosts,omitempty"`
	// The signing brand ID.
	BrandID string `json:"brandId,omitempty"`
	// Text on the agree button.
	ConsentButtonText string `json:"consentButtonText,omitempty"`
	// The text on agree button.
	ConsentText string `json:"consentText,omitempty"`
	// The text on the decline button.
	DeclineButtonText string `json:"declineButtonText,omitempty"`
	// The display name of the user agreement.
	DisplayName string `json:"displayName,omitempty"`
	// Display type: link or document
	DocumentDisplay string `json:"documentDisplay,omitempty"`
	// **True** if the agreement is downloadable.
	Downloadable bool `json:"downloadable,omitempty"`
	// Display format: inline or modal.
	Format string `json:"format,omitempty"`
	// **True** if the agreement has a decline checkbox.
	HasDeclineButton bool `json:"hasDeclineButton,omitempty"`
	// The host origin.
	//
	HostOrigin string `json:"hostOrigin,omitempty"`
	// **True** if the user needs to scroll to the end of the document.
	//
	MustRead bool `json:"mustRead,omitempty"`
	// **True** if the user must view the document.
	//
	MustView bool `json:"mustView,omitempty"`
	// When **true**, this agreement records decline actions.
	RecordDeclineResponses bool `json:"recordDeclineResponses,omitempty"`
	// **True** if accept is required.
	//
	RequireAccept bool `json:"requireAccept,omitempty"`
	// **True** if send to email is applicable.
	//
	SendToEmail bool `json:"sendToEmail,omitempty"`
}

DisplaySettings information about how an agreement is displayed.

type Document 

type Document struct {
	// The base64-encoded contents of the document.
	DocumentBase64 string `json:"documentBase64,omitempty"`
	// The HTML representation of the document.
	DocumentHTML string `json:"documentHtml,omitempty"`
	// The name of the document.
	DocumentName string `json:"documentName,omitempty"`
	// The file extension of the document.
	FileExtension string `json:"fileExtension,omitempty"`
	// The order of document layout.
	Order int32 `json:"order,omitempty"`
}

Document information about a document.

type ErrorDetails added in v0.10.0 

type ErrorDetails struct {
	// The error code.
	ErrorCode string `json:"errorCode,omitempty"`
	// The error message.
	Message string `json:"message,omitempty"`
}

ErrorDetails error details.

type GetAgreementOp added in v0.10.0 

type GetAgreementOp esign.Op

GetAgreementOp implements DocuSign API SDK Click::getAgreement

func (*GetAgreementOp) Do added in v0.10.0 

func (op *GetAgreementOp) Do(ctx context.Context) (UserAgreementResponse, error)

Do executes the op. A nil context will return error.

type GetAgreementPdfOp added in v0.10.0 

type GetAgreementPdfOp esign.Op

GetAgreementPdfOp implements DocuSign API SDK Click::getAgreementPdf

func (*GetAgreementPdfOp) Do added in v0.10.0 

func (op *GetAgreementPdfOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type GetClickwrapAgreementsOp added in v0.10.0 

type GetClickwrapAgreementsOp esign.Op

GetClickwrapAgreementsOp implements DocuSign API SDK Click::getClickwrapAgreements

func (*GetClickwrapAgreementsOp) ClientUserID added in v0.10.0 

func (op *GetClickwrapAgreementsOp) ClientUserID(val string) *GetClickwrapAgreementsOp

ClientUserID is the client ID.

func (*GetClickwrapAgreementsOp) Do added in v0.10.0 

func (op *GetClickwrapAgreementsOp) Do(ctx context.Context) (ClickwrapAgreementsResponse, error)

Do executes the op. A nil context will return error.

func (*GetClickwrapAgreementsOp) FromDate added in v0.10.0 

func (op *GetClickwrapAgreementsOp) FromDate(val string) *GetClickwrapAgreementsOp

FromDate optional. The earliest date to return agreements from.

func (*GetClickwrapAgreementsOp) PageNumber added in v0.10.0 

func (op *GetClickwrapAgreementsOp) PageNumber(val string) *GetClickwrapAgreementsOp

PageNumber optional. The page number to return.

func (*GetClickwrapAgreementsOp) Status added in v0.10.0 

func (op *GetClickwrapAgreementsOp) Status(val string) *GetClickwrapAgreementsOp

Status optional. The status of the clickwraps to return.

func (*GetClickwrapAgreementsOp) ToDate added in v0.10.0 

func (op *GetClickwrapAgreementsOp) ToDate(val string) *GetClickwrapAgreementsOp

ToDate optional. The latest date to return agreements from.

type GetClickwrapOp added in v0.10.0 

type GetClickwrapOp esign.Op

GetClickwrapOp implements DocuSign API SDK Click::getClickwrap

func (*GetClickwrapOp) Do added in v0.10.0 

func (op *GetClickwrapOp) Do(ctx context.Context) (ClickwrapVersionResponse, error)

Do executes the op. A nil context will return error.

type GetClickwrapVersionAgreementsByNumberOp added in v0.10.0 

type GetClickwrapVersionAgreementsByNumberOp esign.Op

GetClickwrapVersionAgreementsByNumberOp implements DocuSign API SDK Click::getClickwrapVersionAgreementsByNumber

func (*GetClickwrapVersionAgreementsByNumberOp) ClientUserID added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) ClientUserID(val string) *GetClickwrapVersionAgreementsByNumberOp

ClientUserID is the client user ID.

func (*GetClickwrapVersionAgreementsByNumberOp) Do added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) Do(ctx context.Context) (ClickwrapAgreementsResponse, error)

Do executes the op. A nil context will return error.

func (*GetClickwrapVersionAgreementsByNumberOp) FromDate added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) FromDate(val string) *GetClickwrapVersionAgreementsByNumberOp

FromDate optional. The earliest date to return agreements from.

func (*GetClickwrapVersionAgreementsByNumberOp) PageNumber added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) PageNumber(val string) *GetClickwrapVersionAgreementsByNumberOp

PageNumber optional. The page number to return.

func (*GetClickwrapVersionAgreementsByNumberOp) Status added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) Status(val string) *GetClickwrapVersionAgreementsByNumberOp

Status clickwrap status. Possible values:

- `active` - `inactive` - `deleted`

func (*GetClickwrapVersionAgreementsByNumberOp) ToDate added in v0.10.0 

func (op *GetClickwrapVersionAgreementsByNumberOp) ToDate(val string) *GetClickwrapVersionAgreementsByNumberOp

ToDate optional. The latest date to return agreements from.

type GetClickwrapVersionAgreementsOp added in v0.10.0 

type GetClickwrapVersionAgreementsOp esign.Op

GetClickwrapVersionAgreementsOp implements DocuSign API SDK Click::getClickwrapVersionAgreements

func (*GetClickwrapVersionAgreementsOp) ClientUserID added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) ClientUserID(val string) *GetClickwrapVersionAgreementsOp

ClientUserID set the call query parameter client_user_id

func (*GetClickwrapVersionAgreementsOp) Do added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) Do(ctx context.Context) (ClickwrapAgreementsResponse, error)

Do executes the op. A nil context will return error.

func (*GetClickwrapVersionAgreementsOp) FromDate added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) FromDate(val string) *GetClickwrapVersionAgreementsOp

FromDate optional. The earliest date to return agreements from.

func (*GetClickwrapVersionAgreementsOp) PageNumber added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) PageNumber(val string) *GetClickwrapVersionAgreementsOp

PageNumber optional. The page number to return.

func (*GetClickwrapVersionAgreementsOp) Status added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) Status(val string) *GetClickwrapVersionAgreementsOp

Status clickwrap status. Possible values:

- `active` - `inactive` - `deleted`

func (*GetClickwrapVersionAgreementsOp) ToDate added in v0.10.0 

func (op *GetClickwrapVersionAgreementsOp) ToDate(val string) *GetClickwrapVersionAgreementsOp

ToDate optional. The latest date to return agreements from.

type GetClickwrapVersionByNumberOp added in v0.10.0 

type GetClickwrapVersionByNumberOp esign.Op

GetClickwrapVersionByNumberOp implements DocuSign API SDK Click::getClickwrapVersionByNumber

func (*GetClickwrapVersionByNumberOp) Do added in v0.10.0 

func (op *GetClickwrapVersionByNumberOp) Do(ctx context.Context) (ClickwrapVersionResponse, error)

Do executes the op. A nil context will return error.

type GetClickwrapVersionOp added in v0.10.0 

type GetClickwrapVersionOp esign.Op

GetClickwrapVersionOp implements DocuSign API SDK Click::getClickwrapVersion

func (*GetClickwrapVersionOp) Do added in v0.10.0 

func (op *GetClickwrapVersionOp) Do(ctx context.Context) (ClickwrapVersionResponse, error)

Do executes the op. A nil context will return error.

type GetClickwrapsOp added in v0.10.0 

type GetClickwrapsOp esign.Op

GetClickwrapsOp implements DocuSign API SDK Click::getClickwraps

func (*GetClickwrapsOp) Do added in v0.10.0 

func (op *GetClickwrapsOp) Do(ctx context.Context) (ClickwrapVersionsResponse, error)

Do executes the op. A nil context will return error.

func (*GetClickwrapsOp) FromDate added in v0.10.0 

func (op *GetClickwrapsOp) FromDate(val string) *GetClickwrapsOp

FromDate optional. The earliest date to return agreements from.

func (*GetClickwrapsOp) OwnerUserID added in v0.10.0 

func (op *GetClickwrapsOp) OwnerUserID(val string) *GetClickwrapsOp

OwnerUserID optional. The user ID of the owner.

func (*GetClickwrapsOp) PageNumber added in v0.10.0 

func (op *GetClickwrapsOp) PageNumber(val string) *GetClickwrapsOp

PageNumber optional. The page number to return.

func (*GetClickwrapsOp) Shared added in v0.10.0 

func (op *GetClickwrapsOp) Shared(val string) *GetClickwrapsOp

Shared set the call query parameter shared

func (*GetClickwrapsOp) Status added in v0.10.0 

func (op *GetClickwrapsOp) Status(val string) *GetClickwrapsOp

Status optional. The status of the clickwraps to filter by. One of:

- `active` - `inactive`

func (*GetClickwrapsOp) ToDate added in v0.10.0 

func (op *GetClickwrapsOp) ToDate(val string) *GetClickwrapsOp

ToDate optional. The latest date to return agreements from.

type GetServiceInformationOp added in v0.10.0 

type GetServiceInformationOp esign.Op

GetServiceInformationOp implements DocuSign API SDK Click::getServiceInformation

func (*GetServiceInformationOp) Do added in v0.10.0 

func (op *GetServiceInformationOp) Do(ctx context.Context) (ServiceInformation, error)

Do executes the op. A nil context will return error.

type Service 

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

Service implements DocuSign Click API operations

func New 

func New(cred esign.Credential) *Service

New initializes a click service using cred to authorize ops.

func (*Service) CreateClickwrap added in v0.10.0 

func (s *Service) CreateClickwrap(clickwrapRequest ClickwrapRequest) *CreateClickwrapOp

CreateClickwrap creates a clickwrap for an account.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/createclickwrap

SDK Method Click::createClickwrap

func (*Service) CreateClickwrapVersion added in v0.10.0 

func (s *Service) CreateClickwrapVersion(clickwrapID string, clickwrapRequest ClickwrapRequest) *CreateClickwrapVersionOp

CreateClickwrapVersion creates a new clickwrap version.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/createclickwrapversion

SDK Method Click::createClickwrapVersion

func (*Service) CreateHasAgreed added in v0.10.0 

func (s *Service) CreateHasAgreed(clickwrapID string, userAgreementRequest UserAgreementRequest) *CreateHasAgreedOp

CreateHasAgreed checks if a user has agreed to a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/createhasagreed

SDK Method Click::createHasAgreed

func (*Service) DeleteClickwrap added in v0.10.0 

func (s *Service) DeleteClickwrap(clickwrapID string) *DeleteClickwrapOp

DeleteClickwrap deletes a clickwrap and all of its versions.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/deleteclickwrap

SDK Method Click::deleteClickwrap

func (*Service) DeleteClickwrapVersion added in v0.10.0 

func (s *Service) DeleteClickwrapVersion(clickwrapID string, versionID string) *DeleteClickwrapVersionOp

DeleteClickwrapVersion deletes a specific version of a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/deleteclickwrapversion

SDK Method Click::deleteClickwrapVersion

func (*Service) DeleteClickwrapVersionByNumber added in v0.10.0 

func (s *Service) DeleteClickwrapVersionByNumber(clickwrapID string, versionNumber string) *DeleteClickwrapVersionByNumberOp

DeleteClickwrapVersionByNumber deletes a clickwrap version from a clickwrap by specifying its version number.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/deleteclickwrapversionbynumber

SDK Method Click::deleteClickwrapVersionByNumber

func (*Service) DeleteClickwrapVersions added in v0.10.0 

func (s *Service) DeleteClickwrapVersions(clickwrapID string) *DeleteClickwrapVersionsOp

DeleteClickwrapVersions deletes the versions of a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/deleteclickwrapversions

SDK Method Click::deleteClickwrapVersions

func (*Service) DeleteClickwraps added in v0.10.0 

func (s *Service) DeleteClickwraps() *DeleteClickwrapsOp

DeleteClickwraps deletes clickwraps for an account.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/deleteclickwraps

SDK Method Click::deleteClickwraps

func (*Service) GetAgreement added in v0.10.0 

func (s *Service) GetAgreement(agreementID string, clickwrapID string) *GetAgreementOp

GetAgreement gets a specific agreement for a specified clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getagreement

SDK Method Click::getAgreement

func (*Service) GetAgreementPdf added in v0.10.0 

func (s *Service) GetAgreementPdf(agreementID string, clickwrapID string) *GetAgreementPdfOp

GetAgreementPdf gets the completed user agreement PDF.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getagreementpdf

SDK Method Click::getAgreementPdf

func (*Service) GetClickwrap added in v0.10.0 

func (s *Service) GetClickwrap(clickwrapID string) *GetClickwrapOp

GetClickwrap gets a single clickwrap object.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrap

SDK Method Click::getClickwrap

func (*Service) GetClickwrapAgreements added in v0.10.0 

func (s *Service) GetClickwrapAgreements(clickwrapID string) *GetClickwrapAgreementsOp

GetClickwrapAgreements get user agreements

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrapagreements

SDK Method Click::getClickwrapAgreements

func (*Service) GetClickwrapVersion added in v0.10.0 

func (s *Service) GetClickwrapVersion(clickwrapID string, versionID string) *GetClickwrapVersionOp

GetClickwrapVersion gets a specific version from a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrapversion

SDK Method Click::getClickwrapVersion

func (*Service) GetClickwrapVersionAgreements added in v0.10.0 

func (s *Service) GetClickwrapVersionAgreements(clickwrapID string, versionID string) *GetClickwrapVersionAgreementsOp

GetClickwrapVersionAgreements gets the agreement responses for a clickwrap version.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrapversionagreements

SDK Method Click::getClickwrapVersionAgreements

func (*Service) GetClickwrapVersionAgreementsByNumber added in v0.10.0 

func (s *Service) GetClickwrapVersionAgreementsByNumber(clickwrapID string, versionNumber string) *GetClickwrapVersionAgreementsByNumberOp

GetClickwrapVersionAgreementsByNumber gets the agreement responses for a clickwrap version

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrapversionagreementsbynumber

SDK Method Click::getClickwrapVersionAgreementsByNumber

func (*Service) GetClickwrapVersionByNumber added in v0.10.0 

func (s *Service) GetClickwrapVersionByNumber(clickwrapID string, versionNumber string) *GetClickwrapVersionByNumberOp

GetClickwrapVersionByNumber gets a clickwrap version by specifying its version number.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwrapversionbynumber

SDK Method Click::getClickwrapVersionByNumber

func (*Service) GetClickwraps added in v0.10.0 

func (s *Service) GetClickwraps() *GetClickwrapsOp

GetClickwraps gets all the clickwraps for an account.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getclickwraps

SDK Method Click::getClickwraps

func (*Service) GetServiceInformation added in v0.10.0 

func (s *Service) GetServiceInformation() *GetServiceInformationOp

GetServiceInformation gets the current version and other information about the Click API.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/getserviceinformation

SDK Method Click::getServiceInformation

func (*Service) UpdateClickwrap added in v0.10.0 

func (s *Service) UpdateClickwrap(clickwrapID string, clickwrapTransferRequest ClickwrapTransferRequest) *UpdateClickwrapOp

UpdateClickwrap updates the user ID of a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/updateclickwrap

SDK Method Click::updateClickwrap

func (*Service) UpdateClickwrapVersion added in v0.10.0 

func (s *Service) UpdateClickwrapVersion(clickwrapID string, versionID string, clickwrapRequest ClickwrapRequest) *UpdateClickwrapVersionOp

UpdateClickwrapVersion updates a specific version of a clickwrap.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/updateclickwrapversion

SDK Method Click::updateClickwrapVersion

func (*Service) UpdateClickwrapVersionByNumber added in v0.10.0 

func (s *Service) UpdateClickwrapVersionByNumber(clickwrapID string, versionNumber string, clickwrapRequest ClickwrapRequest) *UpdateClickwrapVersionByNumberOp

UpdateClickwrapVersionByNumber updates a clickwrap version by specifying its version number.

https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/updateclickwrapversionbynumber

SDK Method Click::updateClickwrapVersionByNumber

type ServiceInformation added in v0.10.0 

type ServiceInformation struct {
	//
	BuildBranch string `json:"buildBranch,omitempty"`
	//
	BuildBranchDeployedDateTime string `json:"buildBranchDeployedDateTime,omitempty"`
	//
	BuildSHA string `json:"buildSHA,omitempty"`
	// The internal build version information.
	BuildVersion string `json:"buildVersion,omitempty"`
	// An array of URLs (strings) of related sites.
	LinkedSites []string `json:"linkedSites,omitempty"`
	// An array of `serviceVersion` objects.
	ServiceVersions []ServiceVersion `json:"serviceVersions,omitempty"`
}

ServiceInformation not described in definition file

type ServiceVersion added in v0.10.0 

type ServiceVersion struct {
	// The human-readable semver version string.
	Version string `json:"version,omitempty"`
	// The URL where this version of the API can be found.
	VersionURL string `json:"versionUrl,omitempty"`
}

ServiceVersion not described in definition file

type UpdateClickwrapOp added in v0.10.0 

type UpdateClickwrapOp esign.Op

UpdateClickwrapOp implements DocuSign API SDK Click::updateClickwrap

func (*UpdateClickwrapOp) Do added in v0.10.0 

func (op *UpdateClickwrapOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type UpdateClickwrapVersionByNumberOp added in v0.10.0 

type UpdateClickwrapVersionByNumberOp esign.Op

UpdateClickwrapVersionByNumberOp implements DocuSign API SDK Click::updateClickwrapVersionByNumber

func (*UpdateClickwrapVersionByNumberOp) Do added in v0.10.0 

func (op *UpdateClickwrapVersionByNumberOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type UpdateClickwrapVersionOp added in v0.10.0 

type UpdateClickwrapVersionOp esign.Op

UpdateClickwrapVersionOp implements DocuSign API SDK Click::updateClickwrapVersion

func (*UpdateClickwrapVersionOp) Do added in v0.10.0 

func (op *UpdateClickwrapVersionOp) Do(ctx context.Context) (ClickwrapVersionSummaryResponse, error)

Do executes the op. A nil context will return error.

type UserAgreementRequest added in v0.10.0 

type UserAgreementRequest struct {
	// The user ID of the client.
	ClientUserID string `json:"clientUserId,omitempty"`
	// The host origin.
	//
	HostOrigin string `json:"hostOrigin,omitempty"`
	// A customer-defined string you can use in requests. This string will appear in the corresponding response.
	Metadata string `json:"metadata,omitempty"`
}

UserAgreementRequest not described in definition file

type UserAgreementResponse added in v0.10.0 

type UserAgreementResponse struct {
	// A GUID that identifies your account.
	// This value is automatically generated by
	// DocuSign for any account you create. Copy the
	// value from the **API Account ID** field in
	// the **API and Keys** page in
	// eSignature Settings.
	//
	AccountID string `json:"accountId,omitempty"`
	// Date that the client last completed the agreement.
	//
	// This property is null if `agreementUrl` is not null and `status` is not  `agreed`.
	AgreedOn interface{} `json:"agreedOn,omitempty"`
	// The agreement ID.
	AgreementID string `json:"agreementId,omitempty"`
	// When not null, an agreement is required for user specified by  `clientUserId`.
	//
	// When missing the user specified by `clientUserId`
	// has already agreed and does not require a new acceptance.
	//
	// Use this URL to render the agreement in a web page.
	//
	// <!--
	// or redirected to when providing redirect_url as a query paramter.
	// -->
	//
	AgreementURL string `json:"agreementUrl,omitempty"`
	// The ID of the clickwrap.
	ClickwrapID string `json:"clickwrapId,omitempty"`
	// The user ID of the client.
	ClientUserID string `json:"clientUserId,omitempty"`
	// The customer-branded HTML with the Electronic Record and Signature Disclosure information
	ConsumerDisclosureHTML string `json:"consumerDisclosureHtml,omitempty"`
	// The date when the clickwrap was created. May be null.
	CreatedOn interface{} `json:"createdOn,omitempty"`
	// The date when the user declined the most recent required agreement.
	//
	// This property is valid only when `status` is `declined`. Otherwise it is null.
	DeclinedOn interface{} `json:"declinedOn,omitempty"`
	// An array of documents.
	Documents []Document `json:"documents,omitempty"`
	// A customer-defined string you can use in requests. This string will appear in the corresponding response.
	Metadata string `json:"metadata,omitempty"`
	// The display settings for this agreement.
	Settings *DisplaySettings `json:"settings,omitempty"`
	// User agreement status. One of:
	//
	// - `created`
	// - `agreed`
	// - `declined`
	Status string `json:"status,omitempty"`
	// The human-readable semver version string.
	Version string `json:"version,omitempty"`
	// The ID of the version.
	VersionID string `json:"versionId,omitempty"`
	// Version of the clickwrap.
	VersionNumber int32 `json:"versionNumber,omitempty"`
}

UserAgreementResponse not described in definition file

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.