templates

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jun 13, 2021 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Overview

Package templates implements the DocuSign SDK category Templates.

Use the Templates category to manage your account's templates.

You can:

* Create, list, get, update, and delete templates. * Manage templates' notification and group sharing settings. * Fetch and rotate pages from a document used by a template.

Templates can be created programmatically or can be created via the DocuSign web interface and then used by your application.

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

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2.1/templates"
    "github.com/ICGGroup/esign/v2.1/model"
)
...
templatesService := templates.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BulkRecipientsDeleteOp 

type BulkRecipientsDeleteOp esign.Op

BulkRecipientsDeleteOp implements DocuSign API SDK Templates::deleteBulkRecipients

func (*BulkRecipientsDeleteOp) Do 

func (op *BulkRecipientsDeleteOp) Do(ctx context.Context) (*model.BulkRecipientsUpdateResponse, error)

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

type BulkRecipientsListOp 

type BulkRecipientsListOp esign.Op

BulkRecipientsListOp implements DocuSign API SDK Templates::listBulkRecipients

func (*BulkRecipientsListOp) Do 

func (op *BulkRecipientsListOp) Do(ctx context.Context) (*model.BulkRecipientsResponse, error)

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

func (*BulkRecipientsListOp) IncludeTabs 

func (op *BulkRecipientsListOp) IncludeTabs() *BulkRecipientsListOp

IncludeTabs when set to **true**, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**).

func (*BulkRecipientsListOp) StartPosition 

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

StartPosition is the starting position of the results set.

type BulkRecipientsUpdateOp 

type BulkRecipientsUpdateOp esign.Op

BulkRecipientsUpdateOp implements DocuSign API SDK Templates::updateBulkRecipients

func (*BulkRecipientsUpdateOp) Do 

func (op *BulkRecipientsUpdateOp) Do(ctx context.Context) (*model.BulkRecipientsSummaryResponse, error)

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

type CreateOp 

type CreateOp esign.Op

CreateOp implements DocuSign API SDK Templates::createTemplate

func (*CreateOp) Do 

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

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

type CustomFieldsCreateOp 

type CustomFieldsCreateOp esign.Op

CustomFieldsCreateOp implements DocuSign API SDK Templates::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 Templates::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 Templates::listCustomFields

func (*CustomFieldsListOp) Do 

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

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

type CustomFieldsUpdateOp 

type CustomFieldsUpdateOp esign.Op

CustomFieldsUpdateOp implements DocuSign API SDK Templates::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 Templates::deleteDocumentPage

func (*DeleteDocumentPageOp) Do 

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

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

type DeleteGroupShareOp 

type DeleteGroupShareOp esign.Op

DeleteGroupShareOp implements DocuSign API SDK Templates::deleteGroupShare

func (*DeleteGroupShareOp) Do 

func (op *DeleteGroupShareOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

type DocumentFieldsCreateOp 

type DocumentFieldsCreateOp esign.Op

DocumentFieldsCreateOp implements DocuSign API SDK Templates::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 Templates::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 Templates::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 Templates::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 Templates::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 Templates::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 filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.

Example: `page_numbers=2,6`

type DocumentsDeleteOp 

type DocumentsDeleteOp esign.Op

DocumentsDeleteOp implements DocuSign API SDK Templates::deleteDocuments

func (*DocumentsDeleteOp) Do 

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

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

type DocumentsGetOp 

type DocumentsGetOp esign.Op

DocumentsGetOp implements DocuSign API SDK Templates::getDocument

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) Encrypt 

func (op *DocumentsGetOp) Encrypt() *DocumentsGetOp

Encrypt set the call query parameter encrypt

func (*DocumentsGetOp) ShowChanges 

func (op *DocumentsGetOp) ShowChanges() *DocumentsGetOp

ShowChanges set the call query parameter show_changes

type DocumentsListOp 

type DocumentsListOp esign.Op

DocumentsListOp implements DocuSign API SDK Templates::listDocuments

func (*DocumentsListOp) Do 

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

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

func (*DocumentsListOp) IncludeTabs 

func (op *DocumentsListOp) IncludeTabs(val string) *DocumentsListOp

IncludeTabs reserved for DocuSign.

type DocumentsUpdateListOp 

type DocumentsUpdateListOp esign.Op

DocumentsUpdateListOp implements DocuSign API SDK Templates::updateDocuments

func (*DocumentsUpdateListOp) Do 

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

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

type DocumentsUpdateOp 

type DocumentsUpdateOp esign.Op

DocumentsUpdateOp implements DocuSign API SDK Templates::updateDocument

func (*DocumentsUpdateOp) Do 

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

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

func (*DocumentsUpdateOp) IsEnvelopeDefinition 

func (op *DocumentsUpdateOp) IsEnvelopeDefinition() *DocumentsUpdateOp

IsEnvelopeDefinition set the call query parameter is_envelope_definition

type GetDocumentPageImageOp 

type GetDocumentPageImageOp esign.Op

GetDocumentPageImageOp implements DocuSign API SDK Templates::getDocumentPageImage

func (*GetDocumentPageImageOp) Do 

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

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

func (*GetDocumentPageImageOp) Dpi 

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

Dpi is the number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

func (*GetDocumentPageImageOp) MaxHeight 

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

MaxHeight sets the maximum height of the returned images in pixels.

func (*GetDocumentPageImageOp) MaxWidth 

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

MaxWidth sets the maximum width of the returned images in pixels.

func (*GetDocumentPageImageOp) ShowChanges 

func (op *GetDocumentPageImageOp) ShowChanges() *GetDocumentPageImageOp

ShowChanges set the call query parameter show_changes

type GetNotificationSettingsOp 

type GetNotificationSettingsOp esign.Op

GetNotificationSettingsOp implements DocuSign API SDK Templates::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 Templates::get

func (*GetOp) Do 

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

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

func (*GetOp) Include 

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

Include is a comma-separated list of additional template attributes to include in the response. Valid values are:

- `recipients` - `folders` - `documents` - `custom_fields` - `notifications` - `powerforms`

type GetPageImagesOp 

type GetPageImagesOp esign.Op

GetPageImagesOp implements DocuSign API SDK Templates::getDocumentPageImages

func (*GetPageImagesOp) Count 

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

Count is the maximum number of results to return.

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 is the number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

func (*GetPageImagesOp) MaxHeight 

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

MaxHeight sets the maximum height of the returned images in pixels.

func (*GetPageImagesOp) MaxWidth 

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

MaxWidth sets the maximum width of the returned images in pixels.

func (*GetPageImagesOp) Nocache 

func (op *GetPageImagesOp) Nocache() *GetPageImagesOp

Nocache if **true**, using cache is disabled and image information is retrieved from a database. **True** is the default value.

func (*GetPageImagesOp) ShowChanges 

func (op *GetPageImagesOp) ShowChanges() *GetPageImagesOp

ShowChanges if **true**, changes display in the user interface.

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 ListOp 

type ListOp esign.Op

ListOp implements DocuSign API SDK Templates::ListTemplates

func (*ListOp) Count 

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

Count number of records to return in the cache.

func (*ListOp) CreatedFromDate 

func (op *ListOp) CreatedFromDate(val string) *ListOp

CreatedFromDate list templates created on or after this date.

func (*ListOp) CreatedToDate 

func (op *ListOp) CreatedToDate(val string) *ListOp

CreatedToDate list templates modified before this date.

func (*ListOp) Do 

func (op *ListOp) Do(ctx context.Context) (*model.EnvelopeTemplateResults, error)

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

func (*ListOp) FolderIds 

func (op *ListOp) FolderIds(val ...string) *ListOp

FolderIds is a comma separated list of folder ID GUIDs.

func (*ListOp) FolderTypes 

func (op *ListOp) FolderTypes(val string) *ListOp

FolderTypes is the type of folder to return templates for. Possible values are:

  • `templates`: Templates in the **My Templates** folder. Templates in the **Shared Templates** and **All Template** folders (if the request id from and Admin) are excluded.
  • `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.
  • `recylebin`: Templates that have been deleted.

func (*ListOp) FromDate 

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

FromDate start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.

func (*ListOp) Include 

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

Include is a comma-separated list of additional template attributes to include in the response. Valid values are:

- `advanced_templates` - `custom_fields` - `documents` - `folders` - `notifications` - `pathExtended` - `powerforms` - `recipients` - `shared_template_folders`

`pathExtended`: Includes SalesForce configuration data for merge fields that can be used to optimize upload template by eliminating the need to connect to SalesForce.

func (*ListOp) IsDownload 

func (op *ListOp) IsDownload(val string) *ListOp

IsDownload when **true**, download the templates listed in `template_ids` as a ZIP file.

The `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.

Default is **false**.

func (*ListOp) ModifiedFromDate 

func (op *ListOp) ModifiedFromDate(val time.Time) *ListOp

ModifiedFromDate list templates modified on or after this date.

func (*ListOp) ModifiedToDate 

func (op *ListOp) ModifiedToDate(val time.Time) *ListOp

ModifiedToDate list templates modified before this date.

func (*ListOp) Order 

func (op *ListOp) Order(val string) *ListOp

Order specifies the sort order of the search results. Valid values are:

- `asc`: Ascending (A to Z) - `desc`: Descending (Z to A)

func (*ListOp) OrderBy 

func (op *ListOp) OrderBy(val string) *ListOp

OrderBy specifies how the search results are listed. Valid values are:

- `name`: template name - `modified`: date/time template was last modified - `used`: date/time the template was last used.

func (*ListOp) SearchFields 

func (op *ListOp) SearchFields(val string) *ListOp

SearchFields is a comma-separated list of additional template properties to search.

- `sender`: Include sender name and email in the search. - `recipients`: Include recipient names and emails in the search. - `envelope`: Not used in template searches.

func (*ListOp) SearchText 

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

SearchText is the search text used to search the names of templates.

func (*ListOp) SharedByMe 

func (op *ListOp) SharedByMe(val string) *ListOp

SharedByMe if true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.

func (*ListOp) StartPosition 

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

StartPosition is the starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).

func (*ListOp) TemplateIds 

func (op *ListOp) TemplateIds(val string) *ListOp

TemplateIds is a comma-separated list of template IDs to download. This value is valid only when `is_download` is **true**.

func (*ListOp) ToDate 

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

ToDate end of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

func (*ListOp) UsedFromDate 

func (op *ListOp) UsedFromDate(val time.Time) *ListOp

UsedFromDate start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.

func (*ListOp) UsedToDate 

func (op *ListOp) UsedToDate(val time.Time) *ListOp

UsedToDate end of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.

func (*ListOp) UserFilter 

func (op *ListOp) UserFilter(val string) *ListOp

UserFilter filters the templates in the response. Valid values are:

- `owned_by_me`: Results include only templates owned by the user. - `shared_with_me`: Results include only templates owned by the user. - `all`: Results include all templates owned or shared with the user.

func (*ListOp) UserID 

func (op *ListOp) UserID(val string) *ListOp

UserID is the user ID.

type LocksCreateOp 

type LocksCreateOp esign.Op

LocksCreateOp implements DocuSign API SDK Templates::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 Templates::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 Templates::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 Templates::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 RecipientTabsCreateOp 

type RecipientTabsCreateOp esign.Op

RecipientTabsCreateOp implements DocuSign API SDK Templates::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 Templates::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 Templates::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. If you do not specify this parameter, the effect is the default behavior (**false**).

func (*RecipientTabsListOp) IncludeMetadata 

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

IncludeMetadata when set to **true**, the response includes metadata indicating which properties are editable.

type RecipientTabsUpdateOp 

type RecipientTabsUpdateOp esign.Op

RecipientTabsUpdateOp implements DocuSign API SDK Templates::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 Templates::createRecipients

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 Templates::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 Templates::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 Templates::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` 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. If you do not specify this parameter, the effect is the default behavior (**false**).

type RecipientsUpdateOp 

type RecipientsUpdateOp esign.Op

RecipientsUpdateOp implements DocuSign API SDK Templates::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) 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 Templates::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 Templates Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a templates service using cred to authorize ops.

func (*Service) BulkRecipientsDelete 

func (s *Service) BulkRecipientsDelete(recipientID string, templateID string) *BulkRecipientsDeleteOp

BulkRecipientsDelete deletes the bulk recipient list on a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatebulkrecipients/delete

SDK Method Templates::deleteBulkRecipients

func (*Service) BulkRecipientsList 

func (s *Service) BulkRecipientsList(recipientID string, templateID string) *BulkRecipientsListOp

BulkRecipientsList gets the bulk recipient file from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatebulkrecipients/list

SDK Method Templates::listBulkRecipients

func (*Service) BulkRecipientsUpdate 

func (s *Service) BulkRecipientsUpdate(recipientID string, templateID string, bulkRecipientsRequest *model.BulkRecipientsRequest) *BulkRecipientsUpdateOp

BulkRecipientsUpdate adds or replaces the bulk recipients list in a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatebulkrecipients/update

SDK Method Templates::updateBulkRecipients

func (*Service) Create 

func (s *Service) Create(templates *model.EnvelopeTemplate, uploads ...*esign.UploadFile) *CreateOp

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

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

SDK Method Templates::createTemplate

func (*Service) CustomFieldsCreate 

func (s *Service) CustomFieldsCreate(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsCreateOp

CustomFieldsCreate creates custom document fields in an existing template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatecustomfields/create

SDK Method Templates::createCustomFields

func (*Service) CustomFieldsDelete 

func (s *Service) CustomFieldsDelete(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsDeleteOp

CustomFieldsDelete deletes envelope custom fields in a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatecustomfields/delete

SDK Method Templates::deleteCustomFields

func (*Service) CustomFieldsList 

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

CustomFieldsList gets the custom document fields from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatecustomfields/list

SDK Method Templates::listCustomFields

func (*Service) CustomFieldsUpdate 

func (s *Service) CustomFieldsUpdate(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsUpdateOp

CustomFieldsUpdate updates envelope custom fields in a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatecustomfields/update

SDK Method Templates::updateCustomFields

func (*Service) DeleteDocumentPage 

func (s *Service) DeleteDocumentPage(documentID string, pageNumber string, templateID string, pageRequest *model.PageRequest) *DeleteDocumentPageOp

DeleteDocumentPage deletes a page from a document in an template.

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

SDK Method Templates::deleteDocumentPage

func (*Service) DeleteGroupShare 

func (s *Service) DeleteGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *DeleteGroupShareOp

DeleteGroupShare removes a member group's sharing permissions for a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templates/deletegroupshare

SDK Method Templates::deleteGroupShare

func (*Service) DocumentFieldsCreate 

func (s *Service) DocumentFieldsCreate(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsCreateOp

DocumentFieldsCreate creates custom document fields in an existing template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/create

SDK Method Templates::createDocumentFields

func (*Service) DocumentFieldsDelete 

func (s *Service) DocumentFieldsDelete(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsDeleteOp

DocumentFieldsDelete deletes custom document fields from an existing template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/delete

SDK Method Templates::deleteDocumentFields

func (*Service) DocumentFieldsList 

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

DocumentFieldsList gets the custom document fields for a an existing template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/list

SDK Method Templates::listDocumentFields

func (*Service) DocumentFieldsUpdate 

func (s *Service) DocumentFieldsUpdate(documentID string, templateID string, templateDocumentFields *model.DocumentFieldsInformation) *DocumentFieldsUpdateOp

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

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumentfields/update

SDK Method Templates::updateDocumentFields

func (*Service) DocumentTabsGet 

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

DocumentTabsGet returns tabs on the document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumenttabs/get

SDK Method Templates::getDocumentTabs

func (*Service) DocumentTabsGetByPage 

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

DocumentTabsGetByPage returns tabs on the specified page.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocumenttabs/getbypage

SDK Method Templates::getPageTabs

func (*Service) DocumentsDelete 

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

DocumentsDelete deletes documents from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/delete

SDK Method Templates::deleteDocuments

func (*Service) DocumentsGet 

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

DocumentsGet gets PDF documents from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/get

SDK Method Templates::getDocument

func (*Service) DocumentsList 

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

DocumentsList gets a list of documents associated with a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/list

SDK Method Templates::listDocuments

func (*Service) DocumentsUpdate 

func (s *Service) DocumentsUpdate(documentID string, templateID string, envelopeDefinition *model.EnvelopeDefinition) *DocumentsUpdateOp

DocumentsUpdate adds a document to a template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/update

SDK Method Templates::updateDocument

func (*Service) DocumentsUpdateList 

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

DocumentsUpdateList adds documents to a template document.

https://developers.docusign.com/esign-rest-api/reference/templates/templatedocuments/updatelist

SDK Method Templates::updateDocuments

func (*Service) Get 

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

Get gets a specific template associated with a specified account.

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

SDK Method Templates::get

func (*Service) GetDocumentPageImage 

func (s *Service) GetDocumentPageImage(documentID string, pageNumber string, templateID string) *GetDocumentPageImageOp

GetDocumentPageImage gets a page image from a template for display.

https://developers.docusign.com/esign-rest-api/reference/templates/templates/getdocumentpageimage

SDK Method Templates::getDocumentPageImage

func (*Service) GetNotificationSettings 

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

GetNotificationSettings gets template notification information.

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

SDK Method Templates::getNotificationSettings

func (*Service) GetPageImages 

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

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

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

SDK Method Templates::getDocumentPageImages

func (*Service) List 

func (s *Service) List() *ListOp

List gets the definition of a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templates/list

SDK Method Templates::ListTemplates

func (*Service) LocksCreate 

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

LocksCreate lock a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templatelocks/create

SDK Method Templates::createLock

func (*Service) LocksDelete 

func (s *Service) LocksDelete(templateID string, lockRequest *model.LockRequest) *LocksDeleteOp

LocksDelete deletes a template lock.

https://developers.docusign.com/esign-rest-api/reference/templates/templatelocks/delete

SDK Method Templates::deleteLock

func (*Service) LocksGet 

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

LocksGet gets template lock information.

https://developers.docusign.com/esign-rest-api/reference/templates/templatelocks/get

SDK Method Templates::getLock

func (*Service) LocksUpdate 

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

LocksUpdate updates a template lock.

https://developers.docusign.com/esign-rest-api/reference/templates/templatelocks/update

SDK Method Templates::updateLock

func (*Service) RecipientTabsCreate 

func (s *Service) RecipientTabsCreate(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsCreateOp

RecipientTabsCreate adds tabs for a recipient.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipienttabs/create

SDK Method Templates::createTabs

func (*Service) RecipientTabsDelete 

func (s *Service) RecipientTabsDelete(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsDeleteOp

RecipientTabsDelete deletes the tabs associated with a recipient in a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipienttabs/delete

SDK Method Templates::deleteTabs

func (*Service) RecipientTabsList 

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

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

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipienttabs/list

SDK Method Templates::listTabs

func (*Service) RecipientTabsUpdate 

func (s *Service) RecipientTabsUpdate(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsUpdateOp

RecipientTabsUpdate updates the tabs for a recipient.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipienttabs/update

SDK Method Templates::updateTabs

func (*Service) RecipientsCreate 

func (s *Service) RecipientsCreate(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsCreateOp

RecipientsCreate adds tabs for a recipient.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipients/create

SDK Method Templates::createRecipients

func (*Service) RecipientsDelete 

func (s *Service) RecipientsDelete(recipientID string, templateID string, templateRecipients *model.TemplateRecipients) *RecipientsDeleteOp

RecipientsDelete deletes the specified recipient file from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipients/delete

SDK Method Templates::deleteRecipient

func (*Service) RecipientsDeleteList 

func (s *Service) RecipientsDeleteList(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsDeleteListOp

RecipientsDeleteList deletes recipients from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipients/deletelist

SDK Method Templates::deleteRecipients

func (*Service) RecipientsList 

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

RecipientsList gets recipient information from a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipients/list

SDK Method Templates::listRecipients

func (*Service) RecipientsUpdate 

func (s *Service) RecipientsUpdate(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsUpdateOp

RecipientsUpdate updates recipients in a template.

https://developers.docusign.com/esign-rest-api/reference/templates/templaterecipients/update

SDK Method Templates::updateRecipients

func (*Service) RotateDocumentPage 

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

RotateDocumentPage rotates page image from a template for display.

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

SDK Method Templates::rotateDocumentPage

func (*Service) Update 

func (s *Service) Update(templateID string, templates *model.EnvelopeTemplate) *UpdateOp

Update updates an existing template.

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

SDK Method Templates::update

func (*Service) UpdateGroupShare 

func (s *Service) UpdateGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *UpdateGroupShareOp

UpdateGroupShare shares a template with a group

https://developers.docusign.com/esign-rest-api/reference/templates/templates/updategroupshare

SDK Method Templates::updateGroupShare

func (*Service) UpdateNotificationSettings 

func (s *Service) UpdateNotificationSettings(templateID string, templateNotificationRequest *model.TemplateNotificationRequest) *UpdateNotificationSettingsOp

UpdateNotificationSettings updates the notification structure for an existing template.

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

SDK Method Templates::updateNotificationSettings

func (*Service) ViewsCreateEdit 

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

ViewsCreateEdit provides a URL to start an edit view of the Template UI

https://developers.docusign.com/esign-rest-api/reference/templates/templateviews/createedit

SDK Method Templates::createEditView

type UpdateGroupShareOp 

type UpdateGroupShareOp esign.Op

UpdateGroupShareOp implements DocuSign API SDK Templates::updateGroupShare

func (*UpdateGroupShareOp) Do 

func (op *UpdateGroupShareOp) Do(ctx context.Context) (*model.GroupInformation, error)

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

type UpdateNotificationSettingsOp 

type UpdateNotificationSettingsOp esign.Op

UpdateNotificationSettingsOp implements DocuSign API SDK Templates::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 Templates::update

func (*UpdateOp) Do 

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

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

type ViewsCreateEditOp 

type ViewsCreateEditOp esign.Op

ViewsCreateEditOp implements DocuSign API SDK Templates::createEditView

func (*ViewsCreateEditOp) Do 

func (op *ViewsCreateEditOp) 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.