envelopes

package
v0.9.4 Latest Latest
Warning

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

 Go to latest Published: May 14, 2021 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Overview

Package envelopes implements the DocuSign SDK category Envelopes.

The DocuSign API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.

Envelopes are the key objects within the DocuSign eSignature system. As a result, they are complex data structures with few required fields. See the [API Recipes](https://www.docusign.com/developer-center/recipes) for use case examples and their solutions.

To create and send envelopes, see the [Envelopes resource](Envelopes).

Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/Envelopes Usage example: 

import (
    "github.com/pwaterz/esign"
    "github.com/pwaterz/esign/v2/envelopes"
    "github.com/pwaterz/esign/v2/model"
)
...
envelopesService := envelopes.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttachmentsCreateOp 

type AttachmentsCreateOp esign.Op

AttachmentsCreateOp implements DocuSign API SDK Envelopes::putAttachments

func (*AttachmentsCreateOp) Do 

func (op *AttachmentsCreateOp) Do(ctx context.Context) (*model.EnvelopeAttachmentsResult, error)

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

type AttachmentsDeleteOp 

type AttachmentsDeleteOp esign.Op

AttachmentsDeleteOp implements DocuSign API SDK Envelopes::deleteAttachments

func (*AttachmentsDeleteOp) Do 

func (op *AttachmentsDeleteOp) Do(ctx context.Context) (*model.EnvelopeAttachmentsResult, error)

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

type AttachmentsGetOp 

type AttachmentsGetOp esign.Op

AttachmentsGetOp implements DocuSign API SDK Envelopes::getAttachment

func (*AttachmentsGetOp) Do 

func (op *AttachmentsGetOp) Do(ctx context.Context) (*esign.Download, error)

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

type AttachmentsListOp 

type AttachmentsListOp esign.Op

AttachmentsListOp implements DocuSign API SDK Envelopes::getAttachments

func (*AttachmentsListOp) Do 

func (op *AttachmentsListOp) Do(ctx context.Context) (*model.EnvelopeAttachmentsResult, error)

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

type AttachmentsUpdateOp 

type AttachmentsUpdateOp esign.Op

AttachmentsUpdateOp implements DocuSign API SDK Envelopes::putAttachment

func (*AttachmentsUpdateOp) Do 

func (op *AttachmentsUpdateOp) Do(ctx context.Context) (*model.EnvelopeAttachmentsResult, error)

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

type ChunkedUploadsCommitOp 

type ChunkedUploadsCommitOp esign.Op

ChunkedUploadsCommitOp implements DocuSign API SDK Envelopes::updateChunkedUpload

func (*ChunkedUploadsCommitOp) Action 

func (op *ChunkedUploadsCommitOp) Action(val string) *ChunkedUploadsCommitOp

Action set the call query parameter action

func (*ChunkedUploadsCommitOp) Do 

func (op *ChunkedUploadsCommitOp) Do(ctx context.Context) (*model.ChunkedUploadResponse, error)

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

type ChunkedUploadsCreateOp 

type ChunkedUploadsCreateOp esign.Op

ChunkedUploadsCreateOp implements DocuSign API SDK Envelopes::createChunkedUpload

func (*ChunkedUploadsCreateOp) Do 

func (op *ChunkedUploadsCreateOp) Do(ctx context.Context) (*model.ChunkedUploadResponse, error)

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

type ChunkedUploadsDeleteOp 

type ChunkedUploadsDeleteOp esign.Op

ChunkedUploadsDeleteOp implements DocuSign API SDK Envelopes::deleteChunkedUpload

func (*ChunkedUploadsDeleteOp) Do 

func (op *ChunkedUploadsDeleteOp) Do(ctx context.Context) (*model.ChunkedUploadResponse, error)

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

type ChunkedUploadsGetOp 

type ChunkedUploadsGetOp esign.Op

ChunkedUploadsGetOp implements DocuSign API SDK Envelopes::getChunkedUpload

func (*ChunkedUploadsGetOp) Do 

func (op *ChunkedUploadsGetOp) Do(ctx context.Context) (*model.ChunkedUploadResponse, error)

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

func (*ChunkedUploadsGetOp) Include 

func (op *ChunkedUploadsGetOp) Include(val ...string) *ChunkedUploadsGetOp

Include is a comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.

type ChunkedUploadsUpdateOp 

type ChunkedUploadsUpdateOp esign.Op

ChunkedUploadsUpdateOp implements DocuSign API SDK Envelopes::updateChunkedUploadPart

func (*ChunkedUploadsUpdateOp) Do 

func (op *ChunkedUploadsUpdateOp) Do(ctx context.Context) (*model.ChunkedUploadResponse, error)

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

type ConsumerDisclosuresGetDefaultOp 

type ConsumerDisclosuresGetDefaultOp esign.Op

ConsumerDisclosuresGetDefaultOp implements DocuSign API SDK Envelopes::getConsumerDisclosureDefault

func (*ConsumerDisclosuresGetDefaultOp) Do 

func (op *ConsumerDisclosuresGetDefaultOp) Do(ctx context.Context) (*model.ConsumerDisclosure, error)

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

func (*ConsumerDisclosuresGetDefaultOp) LangCode 

func (op *ConsumerDisclosuresGetDefaultOp) LangCode(val string) *ConsumerDisclosuresGetDefaultOp

LangCode set the call query parameter langCode

type ConsumerDisclosuresGetOp 

type ConsumerDisclosuresGetOp esign.Op

ConsumerDisclosuresGetOp implements DocuSign API SDK Envelopes::getConsumerDisclosure

func (*ConsumerDisclosuresGetOp) Do 

func (op *ConsumerDisclosuresGetOp) Do(ctx context.Context) (*model.ConsumerDisclosure, error)

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

func (*ConsumerDisclosuresGetOp) LangCode 

func (op *ConsumerDisclosuresGetOp) LangCode(val string) *ConsumerDisclosuresGetOp

LangCode set the call query parameter langCode

type CreateOp 

type CreateOp esign.Op

CreateOp implements DocuSign API SDK Envelopes::createEnvelope

func (*CreateOp) CdseMode 

func (op *CreateOp) CdseMode(val string) *CreateOp

CdseMode reserved for DocuSign.

func (*CreateOp) ChangeRoutingOrder 

func (op *CreateOp) ChangeRoutingOrder() *CreateOp

ChangeRoutingOrder when true, users can define the routing order of recipients while sending documents for signature.

func (*CreateOp) CompletedDocumentsOnly 

func (op *CreateOp) CompletedDocumentsOnly(val string) *CreateOp

CompletedDocumentsOnly reserved for DocuSign.

func (*CreateOp) Do 

func (op *CreateOp) Do(ctx context.Context) (*model.EnvelopeSummary, error)

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

func (*CreateOp) MergeRolesOnDraft 

func (op *CreateOp) MergeRolesOnDraft() *CreateOp

MergeRolesOnDraft when set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)

###### Note: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.

type CustomFieldsCreateOp 

type CustomFieldsCreateOp esign.Op

CustomFieldsCreateOp implements DocuSign API SDK Envelopes::createCustomFields

func (*CustomFieldsCreateOp) Do 

func (op *CustomFieldsCreateOp) Do(ctx context.Context) (*model.CustomFields, error)

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

type CustomFieldsDeleteOp 

type CustomFieldsDeleteOp esign.Op

CustomFieldsDeleteOp implements DocuSign API SDK Envelopes::deleteCustomFields

func (*CustomFieldsDeleteOp) Do 

func (op *CustomFieldsDeleteOp) Do(ctx context.Context) (*model.CustomFields, error)

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

type CustomFieldsListOp 

type CustomFieldsListOp esign.Op

CustomFieldsListOp implements DocuSign API SDK Envelopes::listCustomFields

func (*CustomFieldsListOp) Do 

func (op *CustomFieldsListOp) Do(ctx context.Context) (*model.CustomFieldsEnvelope, error)

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

type CustomFieldsUpdateOp 

type CustomFieldsUpdateOp esign.Op

CustomFieldsUpdateOp implements DocuSign API SDK Envelopes::updateCustomFields

func (*CustomFieldsUpdateOp) Do 

func (op *CustomFieldsUpdateOp) Do(ctx context.Context) (*model.CustomFields, error)

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

type DeleteDocumentPageOp 

type DeleteDocumentPageOp esign.Op

DeleteDocumentPageOp implements DocuSign API SDK Envelopes::deleteDocumentPage

func (*DeleteDocumentPageOp) Do 

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

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

type DocumentFieldsCreateOp 

type DocumentFieldsCreateOp esign.Op

DocumentFieldsCreateOp implements DocuSign API SDK Envelopes::createDocumentFields

func (*DocumentFieldsCreateOp) Do 

func (op *DocumentFieldsCreateOp) Do(ctx context.Context) (*model.DocumentFieldsInformation, error)

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

type DocumentFieldsDeleteOp 

type DocumentFieldsDeleteOp esign.Op

DocumentFieldsDeleteOp implements DocuSign API SDK Envelopes::deleteDocumentFields

func (*DocumentFieldsDeleteOp) Do 

func (op *DocumentFieldsDeleteOp) Do(ctx context.Context) (*model.DocumentFieldsInformation, error)

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

type DocumentFieldsListOp 

type DocumentFieldsListOp esign.Op

DocumentFieldsListOp implements DocuSign API SDK Envelopes::listDocumentFields

func (*DocumentFieldsListOp) Do 

func (op *DocumentFieldsListOp) Do(ctx context.Context) (*model.DocumentFieldsInformation, error)

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

type DocumentFieldsUpdateOp 

type DocumentFieldsUpdateOp esign.Op

DocumentFieldsUpdateOp implements DocuSign API SDK Envelopes::updateDocumentFields

func (*DocumentFieldsUpdateOp) Do 

func (op *DocumentFieldsUpdateOp) Do(ctx context.Context) (*model.DocumentFieldsInformation, error)

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

type DocumentTabsGetByPageOp 

type DocumentTabsGetByPageOp esign.Op

DocumentTabsGetByPageOp implements DocuSign API SDK Envelopes::getPageTabs

func (*DocumentTabsGetByPageOp) Do 

func (op *DocumentTabsGetByPageOp) Do(ctx context.Context) (*model.Tabs, error)

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

type DocumentTabsGetOp 

type DocumentTabsGetOp esign.Op

DocumentTabsGetOp implements DocuSign API SDK Envelopes::getDocumentTabs

func (*DocumentTabsGetOp) Do 

func (op *DocumentTabsGetOp) Do(ctx context.Context) (*model.Tabs, error)

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

func (*DocumentTabsGetOp) PageNumbers 

func (op *DocumentTabsGetOp) PageNumbers(val string) *DocumentTabsGetOp

PageNumbers set the call query parameter page_numbers

type DocumentVisibilityGetOp 

type DocumentVisibilityGetOp esign.Op

DocumentVisibilityGetOp implements DocuSign API SDK Envelopes::getRecipientDocumentVisibility

func (*DocumentVisibilityGetOp) Do 

func (op *DocumentVisibilityGetOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error)

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

type DocumentVisibilityUpdateListOp 

type DocumentVisibilityUpdateListOp esign.Op

DocumentVisibilityUpdateListOp implements DocuSign API SDK Envelopes::updateRecipientsDocumentVisibility

func (*DocumentVisibilityUpdateListOp) Do 

func (op *DocumentVisibilityUpdateListOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error)

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

type DocumentVisibilityUpdateOp 

type DocumentVisibilityUpdateOp esign.Op

DocumentVisibilityUpdateOp implements DocuSign API SDK Envelopes::updateRecipientDocumentVisibility

func (*DocumentVisibilityUpdateOp) Do 

func (op *DocumentVisibilityUpdateOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error)

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

type DocumentsDeleteOp 

type DocumentsDeleteOp esign.Op

DocumentsDeleteOp implements DocuSign API SDK Envelopes::deleteDocuments

func (*DocumentsDeleteOp) Do 

func (op *DocumentsDeleteOp) Do(ctx context.Context) (*model.EnvelopeDocumentsResult, error)

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

type DocumentsGetOp 

type DocumentsGetOp esign.Op

DocumentsGetOp implements DocuSign API SDK Envelopes::getDocument

func (*DocumentsGetOp) Certificate 

func (op *DocumentsGetOp) Certificate() *DocumentsGetOp

Certificate when set to **false**, the envelope signing certificate is removed from the download.

func (*DocumentsGetOp) Do 

func (op *DocumentsGetOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*DocumentsGetOp) Encoding 

func (op *DocumentsGetOp) Encoding(val string) *DocumentsGetOp

Encoding set the call query parameter encoding

func (*DocumentsGetOp) Encrypt 

func (op *DocumentsGetOp) Encrypt() *DocumentsGetOp

Encrypt when set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.

func (*DocumentsGetOp) Language 

func (op *DocumentsGetOp) Language(val string) *DocumentsGetOp

Language specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).

func (*DocumentsGetOp) RecipientID 

func (op *DocumentsGetOp) RecipientID(val string) *DocumentsGetOp

RecipientID set the call query parameter recipient_id

func (*DocumentsGetOp) ShowChanges 

func (op *DocumentsGetOp) ShowChanges() *DocumentsGetOp

ShowChanges when set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.

func (*DocumentsGetOp) Watermark 

func (op *DocumentsGetOp) Watermark() *DocumentsGetOp

Watermark when set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

type DocumentsListOp 

type DocumentsListOp esign.Op

DocumentsListOp implements DocuSign API SDK Envelopes::listDocuments

func (*DocumentsListOp) Do 

func (op *DocumentsListOp) Do(ctx context.Context) (*model.EnvelopeDocumentsResult, error)

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

type DocumentsUpdateListOp 

type DocumentsUpdateListOp esign.Op

DocumentsUpdateListOp implements DocuSign API SDK Envelopes::updateDocuments

func (*DocumentsUpdateListOp) ApplyDocumentFields 

func (op *DocumentsUpdateListOp) ApplyDocumentFields() *DocumentsUpdateListOp

ApplyDocumentFields when **true**, document fields can be added or modified while adding or modifying envelope documents.

func (*DocumentsUpdateListOp) Do 

func (op *DocumentsUpdateListOp) Do(ctx context.Context) (*model.EnvelopeDocumentsResult, error)

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

func (*DocumentsUpdateListOp) PersistTabs 

func (op *DocumentsUpdateListOp) PersistTabs() *DocumentsUpdateListOp

PersistTabs set the call query parameter persist_tabs

type DocumentsUpdateOp 

type DocumentsUpdateOp esign.Op

DocumentsUpdateOp implements DocuSign API SDK Envelopes::updateDocument

func (*DocumentsUpdateOp) ApplyDocumentFields 

func (op *DocumentsUpdateOp) ApplyDocumentFields() *DocumentsUpdateOp

ApplyDocumentFields when **true**, document fields can be added or modified while adding or modifying envelope documents.

func (*DocumentsUpdateOp) Do 

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

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

type EmailSettingsCreateOp 

type EmailSettingsCreateOp esign.Op

EmailSettingsCreateOp implements DocuSign API SDK Envelopes::createEmailSettings

func (*EmailSettingsCreateOp) Do 

func (op *EmailSettingsCreateOp) Do(ctx context.Context) (*model.EmailSettings, error)

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

type EmailSettingsDeleteOp 

type EmailSettingsDeleteOp esign.Op

EmailSettingsDeleteOp implements DocuSign API SDK Envelopes::deleteEmailSettings

func (*EmailSettingsDeleteOp) Do 

func (op *EmailSettingsDeleteOp) Do(ctx context.Context) (*model.EmailSettings, error)

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

type EmailSettingsGetOp 

type EmailSettingsGetOp esign.Op

EmailSettingsGetOp implements DocuSign API SDK Envelopes::getEmailSettings

func (*EmailSettingsGetOp) Do 

func (op *EmailSettingsGetOp) Do(ctx context.Context) (*model.EmailSettings, error)

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

type EmailSettingsUpdateOp 

type EmailSettingsUpdateOp esign.Op

EmailSettingsUpdateOp implements DocuSign API SDK Envelopes::updateEmailSettings

func (*EmailSettingsUpdateOp) Do 

func (op *EmailSettingsUpdateOp) Do(ctx context.Context) (*model.EmailSettings, error)

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

type FormDataGetOp 

type FormDataGetOp esign.Op

FormDataGetOp implements DocuSign API SDK Envelopes::getFormData

func (*FormDataGetOp) Do 

func (op *FormDataGetOp) Do(ctx context.Context) (*model.EnvelopeFormData, error)

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

type GetNotificationSettingsOp 

type GetNotificationSettingsOp esign.Op

GetNotificationSettingsOp implements DocuSign API SDK Envelopes::getNotificationSettings

func (*GetNotificationSettingsOp) Do 

func (op *GetNotificationSettingsOp) Do(ctx context.Context) (*model.Notification, error)

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

type GetOp 

type GetOp esign.Op

GetOp implements DocuSign API SDK Envelopes::getEnvelope

func (*GetOp) AdvancedUpdate 

func (op *GetOp) AdvancedUpdate() *GetOp

AdvancedUpdate when true, envelope information can be added or modified.

func (*GetOp) Do 

func (op *GetOp) Do(ctx context.Context) (*model.Envelope, error)

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

func (*GetOp) Include 

func (op *GetOp) Include(val string) *GetOp

Include reserved for DocuSign.

type GetPageImageOp 

type GetPageImageOp esign.Op

GetPageImageOp implements DocuSign API SDK Envelopes::getDocumentPageImage

func (*GetPageImageOp) Do 

func (op *GetPageImageOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*GetPageImageOp) Dpi 

func (op *GetPageImageOp) Dpi(val int) *GetPageImageOp

Dpi sets the dpi for the image.

func (*GetPageImageOp) MaxHeight 

func (op *GetPageImageOp) MaxHeight(val int) *GetPageImageOp

MaxHeight sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting.

func (*GetPageImageOp) MaxWidth 

func (op *GetPageImageOp) MaxWidth(val int) *GetPageImageOp

MaxWidth sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting.

func (*GetPageImageOp) ShowChanges 

func (op *GetPageImageOp) ShowChanges() *GetPageImageOp

ShowChanges set the call query parameter show_changes

type GetPageImagesOp 

type GetPageImagesOp esign.Op

GetPageImagesOp implements DocuSign API SDK Envelopes::getDocumentPageImages

func (*GetPageImagesOp) Count 

func (op *GetPageImagesOp) Count(val int) *GetPageImagesOp

Count is the maximum number of results to be returned by this request.

func (*GetPageImagesOp) Do 

func (op *GetPageImagesOp) Do(ctx context.Context) (*model.PageImages, error)

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

func (*GetPageImagesOp) Dpi 

func (op *GetPageImagesOp) Dpi(val int) *GetPageImagesOp

Dpi number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.

func (*GetPageImagesOp) MaxHeight 

func (op *GetPageImagesOp) MaxHeight(val int) *GetPageImagesOp

MaxHeight sets the maximum height (in pixels) of the returned image.

func (*GetPageImagesOp) MaxWidth 

func (op *GetPageImagesOp) MaxWidth(val int) *GetPageImagesOp

MaxWidth sets the maximum width (in pixels) of the returned image.

func (*GetPageImagesOp) Nocache 

func (op *GetPageImagesOp) Nocache() *GetPageImagesOp

Nocache set the call query parameter nocache

func (*GetPageImagesOp) ShowChanges 

func (op *GetPageImagesOp) ShowChanges() *GetPageImagesOp

ShowChanges set the call query parameter show_changes

func (*GetPageImagesOp) StartPosition 

func (op *GetPageImagesOp) StartPosition(val int) *GetPageImagesOp

StartPosition is the position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.

type GetRecipientInitialsImageOp 

type GetRecipientInitialsImageOp esign.Op

GetRecipientInitialsImageOp implements DocuSign API SDK Envelopes::getRecipientInitialsImage

func (*GetRecipientInitialsImageOp) Do 

func (op *GetRecipientInitialsImageOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*GetRecipientInitialsImageOp) IncludeChrome 

func (op *GetRecipientInitialsImageOp) IncludeChrome() *GetRecipientInitialsImageOp

IncludeChrome is the added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

type GetRecipientSignatureImageOp 

type GetRecipientSignatureImageOp esign.Op

GetRecipientSignatureImageOp implements DocuSign API SDK Envelopes::getRecipientSignatureImage

func (*GetRecipientSignatureImageOp) Do 

func (op *GetRecipientSignatureImageOp) Do(ctx context.Context) (*esign.Download, error)

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

func (*GetRecipientSignatureImageOp) IncludeChrome 

func (op *GetRecipientSignatureImageOp) IncludeChrome() *GetRecipientSignatureImageOp

IncludeChrome when set to **true**, indicates the chromed version of the signature image should be retrieved.

type GetRecipientSignatureOp 

type GetRecipientSignatureOp esign.Op

GetRecipientSignatureOp implements DocuSign API SDK Envelopes::getRecipientSignature

func (*GetRecipientSignatureOp) Do 

func (op *GetRecipientSignatureOp) Do(ctx context.Context) (*model.UserSignature, error)

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

type ListAuditEventsOp 

type ListAuditEventsOp esign.Op

ListAuditEventsOp implements DocuSign API SDK Envelopes::listAuditEvents

func (*ListAuditEventsOp) Do 

func (op *ListAuditEventsOp) Do(ctx context.Context) (*model.EnvelopeAuditEventResponse, error)

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

type ListStatusChangesOp 

type ListStatusChangesOp esign.Op

ListStatusChangesOp implements DocuSign API SDK Envelopes::listStatusChanges

func (*ListStatusChangesOp) AcStatus 

func (op *ListStatusChangesOp) AcStatus(val string) *ListStatusChangesOp

AcStatus specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.

func (*ListStatusChangesOp) Block 

func (op *ListStatusChangesOp) Block(val string) *ListStatusChangesOp

Block reserved for DocuSign.

func (*ListStatusChangesOp) Count 

func (op *ListStatusChangesOp) Count(val int) *ListStatusChangesOp

Count optional. Number of items to return. Currently there is no implicit maximum limit of the number of items that can be returned.

func (*ListStatusChangesOp) CustomField 

func (op *ListStatusChangesOp) CustomField(val string) *ListStatusChangesOp

CustomField optional. Specifies a envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`

Example: If you have an envelope custom field named "Region" and you want to search for all envelopes where the value is "West" you would use set this parameter to `Region=West`.

func (*ListStatusChangesOp) Do 

func (op *ListStatusChangesOp) Do(ctx context.Context) (*model.EnvelopesInformation, error)

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

func (*ListStatusChangesOp) Email 

func (op *ListStatusChangesOp) Email(val string) *ListStatusChangesOp

Email limit results to envelopes sent by the account user with this email address.

`user_name` must be given as well, and both `email` and `user_name` must refer to an existing account user.

func (*ListStatusChangesOp) EnvelopeIds 

func (op *ListStatusChangesOp) EnvelopeIds(val ...string) *ListStatusChangesOp

EnvelopeIds comma separated list of `envelopeId` values.

func (*ListStatusChangesOp) FromDate 

func (op *ListStatusChangesOp) FromDate(val time.Time) *ListStatusChangesOp

FromDate specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set.

func (*ListStatusChangesOp) FromToStatus 

func (op *ListStatusChangesOp) FromToStatus(val string) *ListStatusChangesOp

FromToStatus is the status value checked for in the `from_date` to `to_date` time period.

Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

If `Changed` is specified, then envelopes that changed status during the period will be returned.

For example, if `Created` is specified, then envelopes created during the period are found.

The default is `Changed`.

func (*ListStatusChangesOp) StartPosition 

func (op *ListStatusChangesOp) StartPosition(val int) *ListStatusChangesOp

StartPosition this value is supported and currently has no implicit maximum items.

func (*ListStatusChangesOp) Status 

func (op *ListStatusChangesOp) Status(val ...string) *ListStatusChangesOp

Status is a comma-separated list of current envelope statuses to included in the response. Possible values are:

* completed * created * declined * deleted * delivered * processing * sent * signed * timedout * voided

The `any` value is equivalent to any status.

func (*ListStatusChangesOp) ToDate 

func (op *ListStatusChangesOp) ToDate(val time.Time) *ListStatusChangesOp

ToDate specifies the date and time to stop looking for status changes. The default is the current date and time.

func (*ListStatusChangesOp) TransactionIds 

func (op *ListStatusChangesOp) TransactionIds(val ...string) *ListStatusChangesOp

TransactionIds is a comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days.

func (*ListStatusChangesOp) UserName 

func (op *ListStatusChangesOp) UserName(val string) *ListStatusChangesOp

UserName limit results to envelopes sent by the account user with this user name.

`email` must be given as well, and both `email` and `user_name` must refer to an existing account user.

type ListStatusOp 

type ListStatusOp esign.Op

ListStatusOp implements DocuSign API SDK Envelopes::listStatus

func (*ListStatusOp) AcStatus 

func (op *ListStatusOp) AcStatus(val string) *ListStatusOp

AcStatus specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.

func (*ListStatusOp) Block 

func (op *ListStatusOp) Block(val string) *ListStatusOp

Block reserved for DocuSign.

func (*ListStatusOp) Count 

func (op *ListStatusOp) Count(val string) *ListStatusOp

Count is the maximum number of results to be returned by this request.

func (*ListStatusOp) Do 

func (op *ListStatusOp) Do(ctx context.Context) (*model.EnvelopesInformation, error)

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

func (*ListStatusOp) Email 

func (op *ListStatusOp) Email(val string) *ListStatusOp

Email reserved for DocuSign.

func (*ListStatusOp) EnvelopeIds 

func (op *ListStatusOp) EnvelopeIds(val string) *ListStatusOp

EnvelopeIds comma separated list of `envelopeId` values.

func (*ListStatusOp) FromDate 

func (op *ListStatusOp) FromDate(val time.Time) *ListStatusOp

FromDate is the date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are set.

****Note****: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.

func (*ListStatusOp) FromToStatus 

func (op *ListStatusOp) FromToStatus(val string) *ListStatusOp

FromToStatus is the status value checked for in the `from_date` to `to_date` time period.

Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.

If `Changed` is specified, then envelopes that changed status during the period will be returned.

For example, if `Created` is specified, then envelopes created during the period are found.

The default is `Changed`.

func (*ListStatusOp) StartPosition 

func (op *ListStatusOp) StartPosition(val int) *ListStatusOp

StartPosition reserved for DocuSign.

func (*ListStatusOp) Status 

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

Status item status. <!-- TODO -->

func (*ListStatusOp) ToDate 

func (op *ListStatusOp) ToDate(val time.Time) *ListStatusOp

ToDate optional date/time setting that specifies the last date/time or envelope status changes in the result set.

Default: "now", the time that you call the method.

func (*ListStatusOp) TransactionIds 

func (op *ListStatusOp) TransactionIds(val string) *ListStatusOp

TransactionIds is a comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days.

func (*ListStatusOp) UserName 

func (op *ListStatusOp) UserName(val string) *ListStatusOp

UserName limit results to envelopes sent by the account user with this user name.

`email` must be given as well, and both `email` and `user_name` must refer to an existing account user.

type LocksCreateOp 

type LocksCreateOp esign.Op

LocksCreateOp implements DocuSign API SDK Envelopes::createLock

func (*LocksCreateOp) Do 

func (op *LocksCreateOp) Do(ctx context.Context) (*model.LockInformation, error)

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

type LocksDeleteOp 

type LocksDeleteOp esign.Op

LocksDeleteOp implements DocuSign API SDK Envelopes::deleteLock

func (*LocksDeleteOp) Do 

func (op *LocksDeleteOp) Do(ctx context.Context) (*model.LockInformation, error)

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

type LocksGetOp 

type LocksGetOp esign.Op

LocksGetOp implements DocuSign API SDK Envelopes::getLock

func (*LocksGetOp) Do 

func (op *LocksGetOp) Do(ctx context.Context) (*model.LockInformation, error)

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

type LocksUpdateOp 

type LocksUpdateOp esign.Op

LocksUpdateOp implements DocuSign API SDK Envelopes::updateLock

func (*LocksUpdateOp) Do 

func (op *LocksUpdateOp) Do(ctx context.Context) (*model.LockInformation, error)

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

type NotaryJournalsListOp 

type NotaryJournalsListOp esign.Op

NotaryJournalsListOp implements DocuSign API SDK Envelopes::listNotaryJournals

func (*NotaryJournalsListOp) Count 

func (op *NotaryJournalsListOp) Count(val string) *NotaryJournalsListOp

Count is the maximum number of results to be returned by this request.

func (*NotaryJournalsListOp) Do 

func (op *NotaryJournalsListOp) Do(ctx context.Context) (*model.NotaryJournalList, error)

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

func (*NotaryJournalsListOp) SearchText 

func (op *NotaryJournalsListOp) SearchText(val string) *NotaryJournalsListOp

SearchText set the call query parameter search_text

func (*NotaryJournalsListOp) StartPosition 

func (op *NotaryJournalsListOp) StartPosition(val string) *NotaryJournalsListOp

StartPosition is the position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.

type RecipientTabsCreateOp 

type RecipientTabsCreateOp esign.Op

RecipientTabsCreateOp implements DocuSign API SDK Envelopes::createTabs

func (*RecipientTabsCreateOp) Do 

func (op *RecipientTabsCreateOp) Do(ctx context.Context) (*model.Tabs, error)

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

type RecipientTabsDeleteOp 

type RecipientTabsDeleteOp esign.Op

RecipientTabsDeleteOp implements DocuSign API SDK Envelopes::deleteTabs

func (*RecipientTabsDeleteOp) Do 

func (op *RecipientTabsDeleteOp) Do(ctx context.Context) (*model.Tabs, error)

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

type RecipientTabsListOp 

type RecipientTabsListOp esign.Op

RecipientTabsListOp implements DocuSign API SDK Envelopes::listTabs

func (*RecipientTabsListOp) Do 

func (op *RecipientTabsListOp) Do(ctx context.Context) (*model.Tabs, error)

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

func (*RecipientTabsListOp) IncludeAnchorTabLocations 

func (op *RecipientTabsListOp) IncludeAnchorTabLocations() *RecipientTabsListOp

IncludeAnchorTabLocations when set to **true**, all tabs with anchor tab properties are included in the response.

func (*RecipientTabsListOp) IncludeMetadata 

func (op *RecipientTabsListOp) IncludeMetadata(val string) *RecipientTabsListOp

IncludeMetadata reserved for DocuSign.

type RecipientTabsUpdateOp 

type RecipientTabsUpdateOp esign.Op

RecipientTabsUpdateOp implements DocuSign API SDK Envelopes::updateTabs

func (*RecipientTabsUpdateOp) Do 

func (op *RecipientTabsUpdateOp) Do(ctx context.Context) (*model.Tabs, error)

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

type RecipientsCreateOp 

type RecipientsCreateOp esign.Op

RecipientsCreateOp implements DocuSign API SDK Envelopes::createRecipient

func (*RecipientsCreateOp) Do 

func (op *RecipientsCreateOp) Do(ctx context.Context) (*model.Recipients, error)

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

func (*RecipientsCreateOp) ResendEnvelope 

func (op *RecipientsCreateOp) ResendEnvelope() *RecipientsCreateOp

ResendEnvelope when set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.

type RecipientsDeleteListOp 

type RecipientsDeleteListOp esign.Op

RecipientsDeleteListOp implements DocuSign API SDK Envelopes::deleteRecipients

func (*RecipientsDeleteListOp) Do 

func (op *RecipientsDeleteListOp) Do(ctx context.Context) (*model.Recipients, error)

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

type RecipientsDeleteOp 

type RecipientsDeleteOp esign.Op

RecipientsDeleteOp implements DocuSign API SDK Envelopes::deleteRecipient

func (*RecipientsDeleteOp) Do 

func (op *RecipientsDeleteOp) Do(ctx context.Context) (*model.Recipients, error)

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

type RecipientsListOp 

type RecipientsListOp esign.Op

RecipientsListOp implements DocuSign API SDK Envelopes::listRecipients

func (*RecipientsListOp) Do 

func (op *RecipientsListOp) Do(ctx context.Context) (*model.Recipients, error)

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

func (*RecipientsListOp) IncludeAnchorTabLocations 

func (op *RecipientsListOp) IncludeAnchorTabLocations() *RecipientsListOp

IncludeAnchorTabLocations when set to **true** and `include_tabs` value is set to **true**, all tabs with anchor tab properties are included in the response.

func (*RecipientsListOp) IncludeExtended 

func (op *RecipientsListOp) IncludeExtended() *RecipientsListOp

IncludeExtended when set to **true**, the extended properties are included in the response.

func (*RecipientsListOp) IncludeTabs 

func (op *RecipientsListOp) IncludeTabs() *RecipientsListOp

IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response.

type RecipientsUpdateOp 

type RecipientsUpdateOp esign.Op

RecipientsUpdateOp implements DocuSign API SDK Envelopes::updateRecipients

func (*RecipientsUpdateOp) Do 

func (op *RecipientsUpdateOp) Do(ctx context.Context) (*model.RecipientsUpdateSummary, error)

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

func (*RecipientsUpdateOp) OfflineSigning 

func (op *RecipientsUpdateOp) OfflineSigning(val string) *RecipientsUpdateOp

OfflineSigning set the call query parameter offline_signing

func (*RecipientsUpdateOp) ResendEnvelope 

func (op *RecipientsUpdateOp) ResendEnvelope() *RecipientsUpdateOp

ResendEnvelope when set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.

type RotateDocumentPageOp 

type RotateDocumentPageOp esign.Op

RotateDocumentPageOp implements DocuSign API SDK Envelopes::rotateDocumentPage

func (*RotateDocumentPageOp) Do 

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

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

type Service 

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

Service implements DocuSign Envelopes Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a envelopes service using cred to authorize ops.

func (*Service) AttachmentsCreate 

func (s *Service) AttachmentsCreate(envelopeID string, envelopeAttachmentsRequest *model.EnvelopeAttachmentsRequest) *AttachmentsCreateOp

AttachmentsCreate add one or more attachments to a DRAFT or IN-PROCESS envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeattachments/create

SDK Method Envelopes::putAttachments

func (*Service) AttachmentsDelete 

func (s *Service) AttachmentsDelete(envelopeID string, envelopeAttachmentsRequest *model.EnvelopeAttachmentsRequest) *AttachmentsDeleteOp

AttachmentsDelete delete one or more attachments from a DRAFT envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeattachments/delete

SDK Method Envelopes::deleteAttachments

func (*Service) AttachmentsGet 

func (s *Service) AttachmentsGet(attachmentID string, envelopeID string) *AttachmentsGetOp

AttachmentsGet retrieves an attachment from the envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeattachments/get

SDK Method Envelopes::getAttachment

func (*Service) AttachmentsList 

func (s *Service) AttachmentsList(envelopeID string) *AttachmentsListOp

AttachmentsList returns a list of attachments associated with the specified envelope

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeattachments/list

SDK Method Envelopes::getAttachments

func (*Service) AttachmentsUpdate 

func (s *Service) AttachmentsUpdate(attachmentID string, envelopeID string, attachment *model.Attachment) *AttachmentsUpdateOp

AttachmentsUpdate add an attachment to a DRAFT or IN-PROCESS envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeattachments/update

SDK Method Envelopes::putAttachment

func (*Service) ChunkedUploadsCommit 

func (s *Service) ChunkedUploadsCommit(chunkedUploadID string, media io.Reader, mimeType string) *ChunkedUploadsCommitOp

ChunkedUploadsCommit integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/chunkeduploads/commit

SDK Method Envelopes::updateChunkedUpload

func (*Service) ChunkedUploadsCreate 

func (s *Service) ChunkedUploadsCreate(chunkedUploadRequest *model.ChunkedUploadRequest) *ChunkedUploadsCreateOp

ChunkedUploadsCreate initiate a new ChunkedUpload.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/chunkeduploads/create

SDK Method Envelopes::createChunkedUpload

func (*Service) ChunkedUploadsDelete 

func (s *Service) ChunkedUploadsDelete(chunkedUploadID string) *ChunkedUploadsDeleteOp

ChunkedUploadsDelete delete an existing ChunkedUpload.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/chunkeduploads/delete

SDK Method Envelopes::deleteChunkedUpload

func (*Service) ChunkedUploadsGet 

func (s *Service) ChunkedUploadsGet(chunkedUploadID string) *ChunkedUploadsGetOp

ChunkedUploadsGet retrieves the current metadata of a ChunkedUpload.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/chunkeduploads/get

SDK Method Envelopes::getChunkedUpload

func (*Service) ChunkedUploadsUpdate 

func (s *Service) ChunkedUploadsUpdate(chunkedUploadID string, chunkedUploadPartSeq string, chunkedUploadRequest *model.ChunkedUploadRequest) *ChunkedUploadsUpdateOp

ChunkedUploadsUpdate add a chunk, a chunk 'part', to an existing ChunkedUpload.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/chunkeduploads/update

SDK Method Envelopes::updateChunkedUploadPart

func (*Service) ConsumerDisclosuresGet 

func (s *Service) ConsumerDisclosuresGet(envelopeID string, langCode string, recipientID string) *ConsumerDisclosuresGetOp

ConsumerDisclosuresGet reserved: Gets the Electronic Record and Signature Disclosure associated with the account.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeconsumerdisclosures/get

SDK Method Envelopes::getConsumerDisclosure

func (*Service) ConsumerDisclosuresGetDefault 

func (s *Service) ConsumerDisclosuresGetDefault(envelopeID string, recipientID string) *ConsumerDisclosuresGetDefaultOp

ConsumerDisclosuresGetDefault gets the Electronic Record and Signature Disclosure associated with the account.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeconsumerdisclosures/getdefault

SDK Method Envelopes::getConsumerDisclosureDefault

func (*Service) Create 

func (s *Service) Create(envelopeDefinition *model.EnvelopeDefinition, uploads ...*esign.UploadFile) *CreateOp

Create creates an envelope. If any uploads[x].Reader is an io.ReadCloser(s), Do() will always close Reader.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/create

SDK Method Envelopes::createEnvelope

func (*Service) CustomFieldsCreate 

func (s *Service) CustomFieldsCreate(envelopeID string, envelopeCustomFields *model.CustomFields) *CustomFieldsCreateOp

CustomFieldsCreate updates envelope custom fields for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopecustomfields/create

SDK Method Envelopes::createCustomFields

func (*Service) CustomFieldsDelete 

func (s *Service) CustomFieldsDelete(envelopeID string, envelopeCustomFields *model.CustomFields) *CustomFieldsDeleteOp

CustomFieldsDelete deletes envelope custom fields for draft and in-process envelopes.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopecustomfields/delete

SDK Method Envelopes::deleteCustomFields

func (*Service) CustomFieldsList 

func (s *Service) CustomFieldsList(envelopeID string) *CustomFieldsListOp

CustomFieldsList gets the custom field information for the specified envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopecustomfields/list

SDK Method Envelopes::listCustomFields

func (*Service) CustomFieldsUpdate 

func (s *Service) CustomFieldsUpdate(envelopeID string, envelopeCustomFields *model.CustomFields) *CustomFieldsUpdateOp

CustomFieldsUpdate updates envelope custom fields in an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopecustomfields/update

SDK Method Envelopes::updateCustomFields

func (*Service) DeleteDocumentPage 

func (s *Service) DeleteDocumentPage(documentID string, envelopeID string, pageNumber string) *DeleteDocumentPageOp

DeleteDocumentPage deletes a page from a document in an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/deletedocumentpage

SDK Method Envelopes::deleteDocumentPage

func (*Service) DocumentFieldsCreate 

func (s *Service) DocumentFieldsCreate(documentID string, envelopeID string, envelopeDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsCreateOp

DocumentFieldsCreate creates custom document fields in an existing envelope document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentfields/create

SDK Method Envelopes::createDocumentFields

func (*Service) DocumentFieldsDelete 

func (s *Service) DocumentFieldsDelete(documentID string, envelopeID string, envelopeDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsDeleteOp

DocumentFieldsDelete deletes custom document fields from an existing envelope document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentfields/delete

SDK Method Envelopes::deleteDocumentFields

func (*Service) DocumentFieldsList 

func (s *Service) DocumentFieldsList(documentID string, envelopeID string) *DocumentFieldsListOp

DocumentFieldsList gets the custom document fields from an existing envelope document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentfields/list

SDK Method Envelopes::listDocumentFields

func (*Service) DocumentFieldsUpdate 

func (s *Service) DocumentFieldsUpdate(documentID string, envelopeID string, envelopeDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsUpdateOp

DocumentFieldsUpdate updates existing custom document fields in an existing envelope document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentfields/update

SDK Method Envelopes::updateDocumentFields

func (*Service) DocumentTabsGet 

func (s *Service) DocumentTabsGet(documentID string, envelopeID string) *DocumentTabsGetOp

DocumentTabsGet returns tabs on the document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumenttabs/get

SDK Method Envelopes::getDocumentTabs

func (*Service) DocumentTabsGetByPage 

func (s *Service) DocumentTabsGetByPage(documentID string, envelopeID string, pageNumber string) *DocumentTabsGetByPageOp

DocumentTabsGetByPage returns tabs on the specified page.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumenttabs/getbypage

SDK Method Envelopes::getPageTabs

func (*Service) DocumentVisibilityGet 

func (s *Service) DocumentVisibilityGet(envelopeID string, recipientID string) *DocumentVisibilityGetOp

DocumentVisibilityGet returns document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentvisibility/get

SDK Method Envelopes::getRecipientDocumentVisibility

func (*Service) DocumentVisibilityUpdate 

func (s *Service) DocumentVisibilityUpdate(envelopeID string, recipientID string, envelopeDocumentVisibility *model.DocumentVisibilityList) *DocumentVisibilityUpdateOp

DocumentVisibilityUpdate updates document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentvisibility/update

SDK Method Envelopes::updateRecipientDocumentVisibility

func (*Service) DocumentVisibilityUpdateList 

func (s *Service) DocumentVisibilityUpdateList(envelopeID string, envelopeDocumentVisibility *model.DocumentVisibilityList) *DocumentVisibilityUpdateListOp

DocumentVisibilityUpdateList updates document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocumentvisibility/updatelist

SDK Method Envelopes::updateRecipientsDocumentVisibility

func (*Service) DocumentsDelete 

func (s *Service) DocumentsDelete(envelopeID string, envelopeDefinition *model.EnvelopeDefinition) *DocumentsDeleteOp

DocumentsDelete deletes documents from a draft envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocuments/delete

SDK Method Envelopes::deleteDocuments

func (*Service) DocumentsGet 

func (s *Service) DocumentsGet(documentID string, envelopeID string) *DocumentsGetOp

DocumentsGet gets a document from an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocuments/get

SDK Method Envelopes::getDocument

func (*Service) DocumentsList 

func (s *Service) DocumentsList(envelopeID string) *DocumentsListOp

DocumentsList gets a list of envelope documents.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocuments/list

SDK Method Envelopes::listDocuments

func (*Service) DocumentsUpdate 

func (s *Service) DocumentsUpdate(documentID string, envelopeID string, media io.Reader, mimeType string) *DocumentsUpdateOp

DocumentsUpdate adds a document to an existing draft envelope. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocuments/update

SDK Method Envelopes::updateDocument

func (*Service) DocumentsUpdateList 

func (s *Service) DocumentsUpdateList(envelopeID string, envelopeDefinition *model.EnvelopeDefinition) *DocumentsUpdateListOp

DocumentsUpdateList adds one or more documents to an existing envelope document.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopedocuments/updatelist

SDK Method Envelopes::updateDocuments

func (*Service) EmailSettingsCreate 

func (s *Service) EmailSettingsCreate(envelopeID string, envelopeEmailSettings *model.EmailSettings) *EmailSettingsCreateOp

EmailSettingsCreate adds email setting overrides to an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeemailsettings/create

SDK Method Envelopes::createEmailSettings

func (*Service) EmailSettingsDelete 

func (s *Service) EmailSettingsDelete(envelopeID string) *EmailSettingsDeleteOp

EmailSettingsDelete deletes the email setting overrides for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeemailsettings/delete

SDK Method Envelopes::deleteEmailSettings

func (*Service) EmailSettingsGet 

func (s *Service) EmailSettingsGet(envelopeID string) *EmailSettingsGetOp

EmailSettingsGet gets the email setting overrides for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeemailsettings/get

SDK Method Envelopes::getEmailSettings

func (*Service) EmailSettingsUpdate 

func (s *Service) EmailSettingsUpdate(envelopeID string, envelopeEmailSettings *model.EmailSettings) *EmailSettingsUpdateOp

EmailSettingsUpdate updates the email setting overrides for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeemailsettings/update

SDK Method Envelopes::updateEmailSettings

func (*Service) FormDataGet 

func (s *Service) FormDataGet(envelopeID string) *FormDataGetOp

FormDataGet returns envelope form data for an existing envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeformdata/get

SDK Method Envelopes::getFormData

func (*Service) Get 

func (s *Service) Get(envelopeID string) *GetOp

Get gets the status of a single envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/get

SDK Method Envelopes::getEnvelope

func (*Service) GetNotificationSettings 

func (s *Service) GetNotificationSettings(envelopeID string) *GetNotificationSettingsOp

GetNotificationSettings gets envelope notification information.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getnotificationsettings

SDK Method Envelopes::getNotificationSettings

func (*Service) GetPageImage 

func (s *Service) GetPageImage(documentID string, envelopeID string, pageNumber string) *GetPageImageOp

GetPageImage gets a page image from an envelope for display.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getpageimage

SDK Method Envelopes::getDocumentPageImage

func (*Service) GetPageImages 

func (s *Service) GetPageImages(documentID string, envelopeID string) *GetPageImagesOp

GetPageImages returns document page image(s) based on input.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getpageimages

SDK Method Envelopes::getDocumentPageImages

func (*Service) GetRecipientInitialsImage 

func (s *Service) GetRecipientInitialsImage(envelopeID string, recipientID string) *GetRecipientInitialsImageOp

GetRecipientInitialsImage gets the initials image for a user.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getrecipientinitialsimage

SDK Method Envelopes::getRecipientInitialsImage

func (*Service) GetRecipientSignature 

func (s *Service) GetRecipientSignature(envelopeID string, recipientID string) *GetRecipientSignatureOp

GetRecipientSignature gets signature information for a signer or sign-in-person recipient.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getrecipientsignature

SDK Method Envelopes::getRecipientSignature

func (*Service) GetRecipientSignatureImage 

func (s *Service) GetRecipientSignatureImage(envelopeID string, recipientID string) *GetRecipientSignatureImageOp

GetRecipientSignatureImage retrieve signature image information for a signer/sign-in-person recipient.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/getrecipientsignatureimage

SDK Method Envelopes::getRecipientSignatureImage

func (*Service) ListAuditEvents 

func (s *Service) ListAuditEvents(envelopeID string) *ListAuditEventsOp

ListAuditEvents gets the envelope audit events for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/listauditevents

SDK Method Envelopes::listAuditEvents

func (*Service) ListStatus 

func (s *Service) ListStatus(envelopeIdsRequest *model.EnvelopeIdsRequest) *ListStatusOp

ListStatus gets the envelope status for the specified envelopes.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/liststatus

SDK Method Envelopes::listStatus

func (*Service) ListStatusChanges 

func (s *Service) ListStatusChanges() *ListStatusChangesOp

ListStatusChanges gets status changes for one or more envelopes.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/liststatuschanges

SDK Method Envelopes::listStatusChanges

func (*Service) LocksCreate 

func (s *Service) LocksCreate(envelopeID string, lockRequest *model.LockRequest) *LocksCreateOp

LocksCreate lock an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopelocks/create

SDK Method Envelopes::createLock

func (*Service) LocksDelete 

func (s *Service) LocksDelete(envelopeID string) *LocksDeleteOp

LocksDelete deletes an envelope lock.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopelocks/delete

SDK Method Envelopes::deleteLock

func (*Service) LocksGet 

func (s *Service) LocksGet(envelopeID string) *LocksGetOp

LocksGet gets envelope lock information.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopelocks/get

SDK Method Envelopes::getLock

func (*Service) LocksUpdate 

func (s *Service) LocksUpdate(envelopeID string, lockRequest *model.LockRequest) *LocksUpdateOp

LocksUpdate updates an envelope lock.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopelocks/update

SDK Method Envelopes::updateLock

func (*Service) NotaryJournalsList 

func (s *Service) NotaryJournalsList() *NotaryJournalsListOp

NotaryJournalsList is SDK Method Envelopes::listNotaryJournals

https://developers.docusign.com/esign/restapi/Envelopes/NotaryJournals/list

func (*Service) RecipientTabsCreate 

func (s *Service) RecipientTabsCreate(envelopeID string, recipientID string, envelopeRecipientTabs *model.Tabs) *RecipientTabsCreateOp

RecipientTabsCreate adds tabs for a recipient.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipienttabs/create

SDK Method Envelopes::createTabs

func (*Service) RecipientTabsDelete 

func (s *Service) RecipientTabsDelete(envelopeID string, recipientID string, envelopeRecipientTabs *model.Tabs) *RecipientTabsDeleteOp

RecipientTabsDelete deletes the tabs associated with a recipient.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipienttabs/delete

SDK Method Envelopes::deleteTabs

func (*Service) RecipientTabsList 

func (s *Service) RecipientTabsList(envelopeID string, recipientID string) *RecipientTabsListOp

RecipientTabsList gets the tabs information for a signer or sign-in-person recipient in an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipienttabs/list

SDK Method Envelopes::listTabs

func (*Service) RecipientTabsUpdate 

func (s *Service) RecipientTabsUpdate(envelopeID string, recipientID string, envelopeRecipientTabs *model.Tabs) *RecipientTabsUpdateOp

RecipientTabsUpdate updates the tabs for a recipient.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipienttabs/update

SDK Method Envelopes::updateTabs

func (*Service) RecipientsCreate 

func (s *Service) RecipientsCreate(envelopeID string, envelopeRecipients *model.Recipients) *RecipientsCreateOp

RecipientsCreate adds one or more recipients to an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipients/create

SDK Method Envelopes::createRecipient

func (*Service) RecipientsDelete 

func (s *Service) RecipientsDelete(envelopeID string, recipientID string) *RecipientsDeleteOp

RecipientsDelete deletes a recipient from an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipients/delete

SDK Method Envelopes::deleteRecipient

func (*Service) RecipientsDeleteList 

func (s *Service) RecipientsDeleteList(envelopeID string, envelopeRecipients *model.Recipients) *RecipientsDeleteListOp

RecipientsDeleteList deletes recipients from an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipients/deletelist

SDK Method Envelopes::deleteRecipients

func (*Service) RecipientsList 

func (s *Service) RecipientsList(envelopeID string) *RecipientsListOp

RecipientsList gets the status of recipients for an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipients/list

SDK Method Envelopes::listRecipients

func (*Service) RecipientsUpdate 

func (s *Service) RecipientsUpdate(envelopeID string, envelopeRecipients *model.Recipients) *RecipientsUpdateOp

RecipientsUpdate updates recipients in a draft envelope or corrects recipient information for an in process envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/enveloperecipients/update

SDK Method Envelopes::updateRecipients

func (*Service) RotateDocumentPage 

func (s *Service) RotateDocumentPage(documentID string, envelopeID string, pageNumber string, pageRequest *model.PageRequest) *RotateDocumentPageOp

RotateDocumentPage rotates page image from an envelope for display.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/rotatedocumentpage

SDK Method Envelopes::rotateDocumentPage

func (*Service) TemplateDocumentVisibilityGet 

func (s *Service) TemplateDocumentVisibilityGet(recipientID string, templateID string) *TemplateDocumentVisibilityGetOp

TemplateDocumentVisibilityGet returns document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/templatedocumentvisibility/get

SDK Method Envelopes::getTemplateRecipientDocumentVisibility

func (*Service) TemplateDocumentVisibilityUpdate 

func (s *Service) TemplateDocumentVisibilityUpdate(recipientID string, templateID string, templateDocumentVisibility *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateOp

TemplateDocumentVisibilityUpdate updates document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/templatedocumentvisibility/update

SDK Method Envelopes::updateTemplateRecipientDocumentVisibility

func (*Service) TemplateDocumentVisibilityUpdateList 

func (s *Service) TemplateDocumentVisibilityUpdateList(templateID string, templateDocumentVisibility *model.TemplateDocumentVisibilityList) *TemplateDocumentVisibilityUpdateListOp

TemplateDocumentVisibilityUpdateList updates document visibility for the recipients

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/templatedocumentvisibility/updatelist

SDK Method Envelopes::updateTemplateRecipientsDocumentVisibility

func (*Service) TemplatesApply 

func (s *Service) TemplatesApply(envelopeID string, documentTemplateList *model.DocumentTemplateList) *TemplatesApplyOp

TemplatesApply adds templates to an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopetemplates/apply

SDK Method Envelopes::applyTemplate

func (*Service) TemplatesApplyToDocument 

func (s *Service) TemplatesApplyToDocument(documentID string, envelopeID string, documentTemplateList *model.DocumentTemplateList) *TemplatesApplyToDocumentOp

TemplatesApplyToDocument adds templates to a document in an envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopetemplates/applytodocument

SDK Method Envelopes::applyTemplateToDocument

func (*Service) TemplatesDelete 

func (s *Service) TemplatesDelete(documentID string, envelopeID string, templateID string) *TemplatesDeleteOp

TemplatesDelete deletes a template from a document in an existing envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopetemplates/delete

SDK Method Envelopes::deleteTemplatesFromDocument

func (*Service) TemplatesList 

func (s *Service) TemplatesList(envelopeID string) *TemplatesListOp

TemplatesList get List of Templates used in an Envelope

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopetemplates/list

SDK Method Envelopes::listTemplates

func (*Service) TemplatesListByDocument 

func (s *Service) TemplatesListByDocument(documentID string, envelopeID string) *TemplatesListByDocumentOp

TemplatesListByDocument gets the templates associated with a document in an existing envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopetemplates/listbydocument

SDK Method Envelopes::listTemplatesForDocument

func (*Service) Update 

func (s *Service) Update(envelopeID string, envelopes *model.Envelope) *UpdateOp

Update send, void, or modify a draft envelope. Purge documents from a completed envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/update

SDK Method Envelopes::update

func (*Service) UpdateNotificationSettings 

func (s *Service) UpdateNotificationSettings(envelopeID string, envelopeNotificationRequest *model.EnvelopeNotificationRequest) *UpdateNotificationSettingsOp

UpdateNotificationSettings sets envelope notification (Reminders/Expirations) structure for an existing envelope.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/updatenotificationsettings

SDK Method Envelopes::updateNotificationSettings

func (*Service) UpdateRecipientInitialsImage 

func (s *Service) UpdateRecipientInitialsImage(envelopeID string, recipientID string, media io.Reader, mimeType string) *UpdateRecipientInitialsImageOp

UpdateRecipientInitialsImage sets the initials image for an accountless signer. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/updaterecipientinitialsimage

SDK Method Envelopes::updateRecipientInitialsImage

func (*Service) UpdateRecipientSignatureImage 

func (s *Service) UpdateRecipientSignatureImage(envelopeID string, recipientID string, media io.Reader, mimeType string) *UpdateRecipientSignatureImageOp

UpdateRecipientSignatureImage sets the signature image for an accountless signer. If media is an io.ReadCloser, Do() will close media.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopes/updaterecipientsignatureimage

SDK Method Envelopes::updateRecipientSignatureImage

func (*Service) ViewsCreateConsole 

func (s *Service) ViewsCreateConsole(consoleViewRequest *model.ConsoleViewRequest) *ViewsCreateConsoleOp

ViewsCreateConsole returns a URL to the authentication view UI.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeviews/createconsole

SDK Method Envelopes::createConsoleView

func (*Service) ViewsCreateCorrect 

func (s *Service) ViewsCreateCorrect(envelopeID string, correctViewRequest *model.CorrectViewRequest) *ViewsCreateCorrectOp

ViewsCreateCorrect returns a URL to the envelope correction UI.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeviews/createcorrect

SDK Method Envelopes::createCorrectView

func (*Service) ViewsCreateEdit 

func (s *Service) ViewsCreateEdit(envelopeID string, returnURLRequest *model.ReturnURLRequest) *ViewsCreateEditOp

ViewsCreateEdit returns a URL to the edit view UI.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeviews/createedit

SDK Method Envelopes::createEditView

func (*Service) ViewsCreateRecipient 

func (s *Service) ViewsCreateRecipient(envelopeID string, recipientViewRequest *model.RecipientViewRequest) *ViewsCreateRecipientOp

ViewsCreateRecipient returns a URL to the recipient view UI.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeviews/createrecipient

SDK Method Envelopes::createRecipientView

func (*Service) ViewsCreateSender 

func (s *Service) ViewsCreateSender(envelopeID string, returnURLRequest *model.ReturnURLRequest) *ViewsCreateSenderOp

ViewsCreateSender returns a URL to the sender view UI.

https://developers.docusign.com/esign-rest-api/v2/reference/envelopes/envelopeviews/createsender

SDK Method Envelopes::createSenderView

func (*Service) ViewsCreateSharedRecipient 

func (s *Service) ViewsCreateSharedRecipient(envelopeID string, recipientViewRequest *model.RecipientViewRequest) *ViewsCreateSharedRecipientOp

ViewsCreateSharedRecipient is SDK Method Envelopes::createEnvelopeRecipientSharedView

https://developers.docusign.com/esign/restapi/Envelopes/EnvelopeViews/createSharedRecipient

type TemplateDocumentVisibilityGetOp 

type TemplateDocumentVisibilityGetOp esign.Op

TemplateDocumentVisibilityGetOp implements DocuSign API SDK Envelopes::getTemplateRecipientDocumentVisibility

func (*TemplateDocumentVisibilityGetOp) Do 

func (op *TemplateDocumentVisibilityGetOp) Do(ctx context.Context) (*model.DocumentVisibilityList, error)

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

type TemplateDocumentVisibilityUpdateListOp 

type TemplateDocumentVisibilityUpdateListOp esign.Op

TemplateDocumentVisibilityUpdateListOp implements DocuSign API SDK Envelopes::updateTemplateRecipientsDocumentVisibility

func (*TemplateDocumentVisibilityUpdateListOp) Do 

func (op *TemplateDocumentVisibilityUpdateListOp) Do(ctx context.Context) (*model.TemplateDocumentVisibilityList, error)

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

type TemplateDocumentVisibilityUpdateOp 

type TemplateDocumentVisibilityUpdateOp esign.Op

TemplateDocumentVisibilityUpdateOp implements DocuSign API SDK Envelopes::updateTemplateRecipientDocumentVisibility

func (*TemplateDocumentVisibilityUpdateOp) Do 

func (op *TemplateDocumentVisibilityUpdateOp) Do(ctx context.Context) (*model.TemplateDocumentVisibilityList, error)

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

type TemplatesApplyOp 

type TemplatesApplyOp esign.Op

TemplatesApplyOp implements DocuSign API SDK Envelopes::applyTemplate

func (*TemplatesApplyOp) Do 

func (op *TemplatesApplyOp) Do(ctx context.Context) (*model.DocumentTemplateList, error)

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

type TemplatesApplyToDocumentOp 

type TemplatesApplyToDocumentOp esign.Op

TemplatesApplyToDocumentOp implements DocuSign API SDK Envelopes::applyTemplateToDocument

func (*TemplatesApplyToDocumentOp) Do 

func (op *TemplatesApplyToDocumentOp) Do(ctx context.Context) (*model.DocumentTemplateList, error)

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

type TemplatesDeleteOp 

type TemplatesDeleteOp esign.Op

TemplatesDeleteOp implements DocuSign API SDK Envelopes::deleteTemplatesFromDocument

func (*TemplatesDeleteOp) Do 

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

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

type TemplatesListByDocumentOp 

type TemplatesListByDocumentOp esign.Op

TemplatesListByDocumentOp implements DocuSign API SDK Envelopes::listTemplatesForDocument

func (*TemplatesListByDocumentOp) Do 

func (op *TemplatesListByDocumentOp) Do(ctx context.Context) (*model.TemplateInformation, error)

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

func (*TemplatesListByDocumentOp) Include 

func (op *TemplatesListByDocumentOp) Include(val ...string) *TemplatesListByDocumentOp

Include is a comma-separated list that limits the results. Valid values:

* applied * matched

type TemplatesListOp 

type TemplatesListOp esign.Op

TemplatesListOp implements DocuSign API SDK Envelopes::listTemplates

func (*TemplatesListOp) Do 

func (op *TemplatesListOp) Do(ctx context.Context) (*model.TemplateInformation, error)

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

func (*TemplatesListOp) Include 

func (op *TemplatesListOp) Include(val string) *TemplatesListOp

Include is the possible values are: matching_applied - This returns template matching information for the template.

type UpdateNotificationSettingsOp 

type UpdateNotificationSettingsOp esign.Op

UpdateNotificationSettingsOp implements DocuSign API SDK Envelopes::updateNotificationSettings

func (*UpdateNotificationSettingsOp) Do 

func (op *UpdateNotificationSettingsOp) Do(ctx context.Context) (*model.Notification, error)

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

type UpdateOp 

type UpdateOp esign.Op

UpdateOp implements DocuSign API SDK Envelopes::update

func (*UpdateOp) AdvancedUpdate 

func (op *UpdateOp) AdvancedUpdate() *UpdateOp

AdvancedUpdate when set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.

func (*UpdateOp) Do 

func (op *UpdateOp) Do(ctx context.Context) (*model.EnvelopeUpdateSummary, error)

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

func (*UpdateOp) ResendEnvelope 

func (op *UpdateOp) ResendEnvelope() *UpdateOp

ResendEnvelope when set to **true**, sends the specified envelope again.

type UpdateRecipientInitialsImageOp 

type UpdateRecipientInitialsImageOp esign.Op

UpdateRecipientInitialsImageOp implements DocuSign API SDK Envelopes::updateRecipientInitialsImage

func (*UpdateRecipientInitialsImageOp) Do 

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

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

type UpdateRecipientSignatureImageOp 

type UpdateRecipientSignatureImageOp esign.Op

UpdateRecipientSignatureImageOp implements DocuSign API SDK Envelopes::updateRecipientSignatureImage

func (*UpdateRecipientSignatureImageOp) Do 

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

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

type ViewsCreateConsoleOp 

type ViewsCreateConsoleOp esign.Op

ViewsCreateConsoleOp implements DocuSign API SDK Envelopes::createConsoleView

func (*ViewsCreateConsoleOp) Do 

func (op *ViewsCreateConsoleOp) Do(ctx context.Context) (*model.ViewURL, error)

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

type ViewsCreateCorrectOp 

type ViewsCreateCorrectOp esign.Op

ViewsCreateCorrectOp implements DocuSign API SDK Envelopes::createCorrectView

func (*ViewsCreateCorrectOp) Do 

func (op *ViewsCreateCorrectOp) Do(ctx context.Context) (*model.ViewURL, error)

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

type ViewsCreateEditOp 

type ViewsCreateEditOp esign.Op

ViewsCreateEditOp implements DocuSign API SDK Envelopes::createEditView

func (*ViewsCreateEditOp) Do 

func (op *ViewsCreateEditOp) Do(ctx context.Context) (*model.ViewURL, error)

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

type ViewsCreateRecipientOp 

type ViewsCreateRecipientOp esign.Op

ViewsCreateRecipientOp implements DocuSign API SDK Envelopes::createRecipientView

func (*ViewsCreateRecipientOp) Do 

func (op *ViewsCreateRecipientOp) Do(ctx context.Context) (*model.ViewURL, error)

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

type ViewsCreateSenderOp 

type ViewsCreateSenderOp esign.Op

ViewsCreateSenderOp implements DocuSign API SDK Envelopes::createSenderView

func (*ViewsCreateSenderOp) Do 

func (op *ViewsCreateSenderOp) Do(ctx context.Context) (*model.ViewURL, error)

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

type ViewsCreateSharedRecipientOp 

type ViewsCreateSharedRecipientOp esign.Op

ViewsCreateSharedRecipientOp implements DocuSign API SDK Envelopes::createEnvelopeRecipientSharedView

func (*ViewsCreateSharedRecipientOp) Do 

func (op *ViewsCreateSharedRecipientOp) Do(ctx context.Context) (*model.ViewURL, error)

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

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.