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/v2/reference/Templates Usage example:
import ( "github.com/jfcote87/esign" "github.com/jfcote87/esign/v2/templates" "github.com/jfcote87/esign/v2/model" ) ... templatesService := templates.New(esignCredential)
Index ¶
- type BulkRecipientsDeleteOp
- type BulkRecipientsListOp
- type BulkRecipientsUpdateOp
- type CreateOp
- type CustomFieldsCreateOp
- type CustomFieldsDeleteOp
- type CustomFieldsListOp
- type CustomFieldsUpdateOp
- type DeleteDocumentPageOp
- type DeleteGroupShareOp
- type DocumentFieldsCreateOp
- type DocumentFieldsDeleteOp
- type DocumentFieldsListOp
- type DocumentFieldsUpdateOp
- type DocumentTabsGetByPageOp
- type DocumentTabsGetOp
- type DocumentsDeleteOp
- type DocumentsGetOp
- type DocumentsListOp
- type DocumentsUpdateListOp
- type DocumentsUpdateOp
- type GetDocumentPageImageOp
- func (op *GetDocumentPageImageOp) Do(ctx context.Context) (*esign.Download, error)
- func (op *GetDocumentPageImageOp) Dpi(val int) *GetDocumentPageImageOp
- func (op *GetDocumentPageImageOp) MaxHeight(val int) *GetDocumentPageImageOp
- func (op *GetDocumentPageImageOp) MaxWidth(val int) *GetDocumentPageImageOp
- func (op *GetDocumentPageImageOp) ShowChanges() *GetDocumentPageImageOp
- type GetNotificationSettingsOp
- type GetOp
- type GetPageImagesOp
- func (op *GetPageImagesOp) Count(val int) *GetPageImagesOp
- func (op *GetPageImagesOp) Do(ctx context.Context) (*model.PageImages, error)
- func (op *GetPageImagesOp) Dpi(val int) *GetPageImagesOp
- func (op *GetPageImagesOp) MaxHeight(val int) *GetPageImagesOp
- func (op *GetPageImagesOp) MaxWidth(val int) *GetPageImagesOp
- func (op *GetPageImagesOp) Nocache() *GetPageImagesOp
- func (op *GetPageImagesOp) ShowChanges() *GetPageImagesOp
- func (op *GetPageImagesOp) StartPosition(val int) *GetPageImagesOp
- type ListOp
- func (op *ListOp) Count(val int) *ListOp
- func (op *ListOp) Do(ctx context.Context) (*model.EnvelopeTemplateResults, error)
- func (op *ListOp) Folder(val string) *ListOp
- func (op *ListOp) FolderIds(val ...string) *ListOp
- func (op *ListOp) FromDate(val time.Time) *ListOp
- func (op *ListOp) Include(val ...string) *ListOp
- func (op *ListOp) ModifiedFromDate(val time.Time) *ListOp
- func (op *ListOp) ModifiedToDate(val time.Time) *ListOp
- func (op *ListOp) Order(val string) *ListOp
- func (op *ListOp) OrderBy(val string) *ListOp
- func (op *ListOp) SearchText(val string) *ListOp
- func (op *ListOp) SharedByMe(val string) *ListOp
- func (op *ListOp) StartPosition(val int) *ListOp
- func (op *ListOp) ToDate(val time.Time) *ListOp
- func (op *ListOp) UsedFromDate(val time.Time) *ListOp
- func (op *ListOp) UsedToDate(val time.Time) *ListOp
- func (op *ListOp) UserFilter(val string) *ListOp
- func (op *ListOp) UserID(val string) *ListOp
- type LocksCreateOp
- type LocksDeleteOp
- type LocksGetOp
- type LocksUpdateOp
- type RecipientTabsCreateOp
- type RecipientTabsDeleteOp
- type RecipientTabsListOp
- type RecipientTabsUpdateOp
- type RecipientsCreateOp
- type RecipientsDeleteListOp
- type RecipientsDeleteOp
- type RecipientsListOp
- type RecipientsUpdateOp
- type RotateDocumentPageOp
- type Service
- func (s *Service) BulkRecipientsDelete(recipientID string, templateID string) *BulkRecipientsDeleteOp
- func (s *Service) BulkRecipientsList(recipientID string, templateID string) *BulkRecipientsListOp
- func (s *Service) BulkRecipientsUpdate(recipientID string, templateID string, ...) *BulkRecipientsUpdateOp
- func (s *Service) Create(templates *model.EnvelopeTemplate, uploads ...*esign.UploadFile) *CreateOp
- func (s *Service) CustomFieldsCreate(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsCreateOp
- func (s *Service) CustomFieldsDelete(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsDeleteOp
- func (s *Service) CustomFieldsList(templateID string) *CustomFieldsListOp
- func (s *Service) CustomFieldsUpdate(templateID string, templateCustomFields *model.TemplateCustomFields) *CustomFieldsUpdateOp
- func (s *Service) DeleteDocumentPage(documentID string, pageNumber string, templateID string, ...) *DeleteDocumentPageOp
- func (s *Service) DeleteGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *DeleteGroupShareOp
- func (s *Service) DocumentFieldsCreate(documentID string, templateID string, ...) *DocumentFieldsCreateOp
- func (s *Service) DocumentFieldsDelete(documentID string, templateID string, ...) *DocumentFieldsDeleteOp
- func (s *Service) DocumentFieldsList(documentID string, templateID string) *DocumentFieldsListOp
- func (s *Service) DocumentFieldsUpdate(documentID string, templateID string, ...) *DocumentFieldsUpdateOp
- func (s *Service) DocumentTabsGet(documentID string, templateID string) *DocumentTabsGetOp
- func (s *Service) DocumentTabsGetByPage(documentID string, pageNumber string, templateID string) *DocumentTabsGetByPageOp
- func (s *Service) DocumentsDelete(templateID string, envelopeDefinition *model.EnvelopeDefinition) *DocumentsDeleteOp
- func (s *Service) DocumentsGet(documentID string, templateID string) *DocumentsGetOp
- func (s *Service) DocumentsList(templateID string) *DocumentsListOp
- func (s *Service) DocumentsUpdate(documentID string, templateID string, ...) *DocumentsUpdateOp
- func (s *Service) DocumentsUpdateList(templateID string, envelopeDefinition *model.EnvelopeDefinition) *DocumentsUpdateListOp
- func (s *Service) Get(templateID string) *GetOp
- func (s *Service) GetDocumentPageImage(documentID string, pageNumber string, templateID string) *GetDocumentPageImageOp
- func (s *Service) GetNotificationSettings(templateID string) *GetNotificationSettingsOp
- func (s *Service) GetPageImages(documentID string, templateID string) *GetPageImagesOp
- func (s *Service) List() *ListOp
- func (s *Service) LocksCreate(templateID string, lockRequest *model.LockRequest) *LocksCreateOp
- func (s *Service) LocksDelete(templateID string, lockRequest *model.LockRequest) *LocksDeleteOp
- func (s *Service) LocksGet(templateID string) *LocksGetOp
- func (s *Service) LocksUpdate(templateID string, lockRequest *model.LockRequest) *LocksUpdateOp
- func (s *Service) RecipientTabsCreate(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsCreateOp
- func (s *Service) RecipientTabsDelete(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsDeleteOp
- func (s *Service) RecipientTabsList(recipientID string, templateID string) *RecipientTabsListOp
- func (s *Service) RecipientTabsUpdate(recipientID string, templateID string, templateTabs *model.TemplateTabs) *RecipientTabsUpdateOp
- func (s *Service) RecipientsCreate(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsCreateOp
- func (s *Service) RecipientsDelete(recipientID string, templateID string, ...) *RecipientsDeleteOp
- func (s *Service) RecipientsDeleteList(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsDeleteListOp
- func (s *Service) RecipientsList(templateID string) *RecipientsListOp
- func (s *Service) RecipientsUpdate(templateID string, templateRecipients *model.TemplateRecipients) *RecipientsUpdateOp
- func (s *Service) RotateDocumentPage(documentID string, pageNumber string, templateID string, ...) *RotateDocumentPageOp
- func (s *Service) Update(templateID string, templates *model.EnvelopeTemplate) *UpdateOp
- func (s *Service) UpdateGroupShare(templateID string, templatePart string, groups *model.GroupInformation) *UpdateGroupShareOp
- func (s *Service) UpdateNotificationSettings(templateID string, ...) *UpdateNotificationSettingsOp
- func (s *Service) ViewsCreateEdit(templateID string, returnURLRequest *model.ReturnURLRequest) *ViewsCreateEditOp
- type UpdateGroupShareOp
- type UpdateNotificationSettingsOp
- type UpdateOp
- type ViewsCreateEditOp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BulkRecipientsDeleteOp ¶
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 ¶
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.
func (*BulkRecipientsListOp) StartPosition ¶
func (op *BulkRecipientsListOp) StartPosition(val int) *BulkRecipientsListOp
StartPosition reserved for DocuSign.
type BulkRecipientsUpdateOp ¶
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 CustomFieldsCreateOp ¶
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 ¶
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 ¶
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 ¶
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 ¶
DeleteDocumentPageOp implements DocuSign API SDK Templates::deleteDocumentPage
type DeleteGroupShareOp ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
DocumentTabsGetByPageOp implements DocuSign API SDK Templates::getPageTabs
type DocumentTabsGetOp ¶
DocumentTabsGetOp implements DocuSign API SDK Templates::getDocumentTabs
func (*DocumentTabsGetOp) PageNumbers ¶
func (op *DocumentTabsGetOp) PageNumbers(val string) *DocumentTabsGetOp
PageNumbers set the call query parameter page_numbers
type DocumentsDeleteOp ¶
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 ¶
DocumentsGetOp implements DocuSign API SDK Templates::getDocument
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 ¶
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.
type DocumentsUpdateListOp ¶
DocumentsUpdateListOp implements DocuSign API SDK Templates::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.TemplateDocumentsResult, 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 ¶
DocumentsUpdateOp implements DocuSign API SDK Templates::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) (*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 ¶
GetDocumentPageImageOp implements DocuSign API SDK Templates::getDocumentPageImage
func (*GetDocumentPageImageOp) Dpi ¶
func (op *GetDocumentPageImageOp) Dpi(val int) *GetDocumentPageImageOp
Dpi number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
func (*GetDocumentPageImageOp) MaxHeight ¶
func (op *GetDocumentPageImageOp) MaxHeight(val int) *GetDocumentPageImageOp
MaxHeight sets the maximum height (in pixels) of the returned image.
func (*GetDocumentPageImageOp) MaxWidth ¶
func (op *GetDocumentPageImageOp) MaxWidth(val int) *GetDocumentPageImageOp
MaxWidth sets the maximum width (in pixels) of the returned image.
func (*GetDocumentPageImageOp) ShowChanges ¶
func (op *GetDocumentPageImageOp) ShowChanges() *GetDocumentPageImageOp
ShowChanges set the call query parameter show_changes
type GetNotificationSettingsOp ¶
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 ¶
GetOp implements DocuSign API SDK Templates::get
type GetPageImagesOp ¶
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 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 ListOp ¶
ListOp implements DocuSign API SDK Templates::ListTemplates
func (*ListOp) Folder ¶
Folder is the query value can be a folder name or folder ID. The response will only return templates in the specified folder.
func (*ListOp) FromDate ¶
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 ¶
Include is a comma-separated list of additional template attributes to include in the response. Valid values are:
* custom_fields * documents * folders * notifications * recipients
func (*ListOp) ModifiedFromDate ¶
ModifiedFromDate set the call query parameter modified_from_date
func (*ListOp) ModifiedToDate ¶
ModifiedToDate set the call query parameter modified_to_date
func (*ListOp) Order ¶
Order sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
func (*ListOp) OrderBy ¶
OrderBy sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
func (*ListOp) SearchText ¶
SearchText is the search text used to search the names of templates.
func (*ListOp) SharedByMe ¶
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 ¶
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) ToDate ¶
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 ¶
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 ¶
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 ¶
UserFilter sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
type LocksCreateOp ¶
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 ¶
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 ¶
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 ¶
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 ¶
RecipientTabsCreateOp implements DocuSign API SDK Templates::createTabs
type RecipientTabsDeleteOp ¶
RecipientTabsDeleteOp implements DocuSign API SDK Templates::deleteTabs
type RecipientTabsListOp ¶
RecipientTabsListOp implements DocuSign API SDK Templates::listTabs
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 ¶
RecipientTabsUpdateOp implements DocuSign API SDK Templates::updateTabs
type RecipientsCreateOp ¶
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 ¶
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 ¶
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 ¶
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.
type RecipientsUpdateOp ¶
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 ¶
RotateDocumentPageOp implements DocuSign API SDK Templates::rotateDocumentPage
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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/reference/templates/templatedocuments/updatelist
SDK Method Templates::updateDocuments
func (*Service) Get ¶
Get gets a list of templates for a specified account.
https://developers.docusign.com/esign-rest-api/v2/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/v2/reference/templates/templates/getdocumentpageimage
SDK Method Templates::getDocumentPageImage
func (*Service) GetNotificationSettings ¶
func (s *Service) GetNotificationSettings(templateID string) *GetNotificationSettingsOp
GetNotificationSettings gets template notification information.
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/v2/reference/templates/templates/getpageimages
SDK Method Templates::getDocumentPageImages
func (*Service) List ¶
List gets the definition of a template.
https://developers.docusign.com/esign-rest-api/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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/v2/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.
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/v2/reference/templates/templateviews/createedit
SDK Method Templates::createEditView
type UpdateGroupShareOp ¶
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 ¶
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.