Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.ITemplatesApi:

Public Member Functions
CustomFields	CreateCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Creates custom document fields in an existing template document. More...

ApiResponse< CustomFields >	CreateCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Creates custom document fields in an existing template document. More...

DocumentFieldsInformation	CreateDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Creates custom document fields in an existing template document. More...

ApiResponse< DocumentFieldsInformation >	CreateDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Creates custom document fields in an existing template document. More...

ViewUrl	CreateEditView (string accountId, string templateId, ReturnUrlRequest returnUrlRequest=null)
	Provides a URL to start an edit view of the Template UI More...

ApiResponse< ViewUrl >	CreateEditViewWithHttpInfo (string accountId, string templateId, ReturnUrlRequest returnUrlRequest=null)
	Provides a URL to start an edit view of the Template UI More...

LockInformation	CreateLock (string accountId, string templateId, LockRequest lockRequest=null)
	Lock a template. More...

ApiResponse< LockInformation >	CreateLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Lock a template. More...

Recipients	CreateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
	Adds tabs for a recipient. More...

ApiResponse< Recipients >	CreateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
	Adds tabs for a recipient. More...

Tabs	CreateTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Adds tabs for a recipient. More...

ApiResponse< Tabs >	CreateTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Adds tabs for a recipient. More...

TemplateSummary	CreateTemplate (string accountId, EnvelopeTemplate envelopeTemplate=null)
	Creates an envelope from a template. More...

ApiResponse< TemplateSummary >	CreateTemplateWithHttpInfo (string accountId, EnvelopeTemplate envelopeTemplate=null)
	Creates an envelope from a template. More...

DocumentHtmlDefinitions	CreateTemplateDocumentResponsiveHtmlPreview (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Post Responsive HTML Preview for a document in a template. More...

ApiResponse< DocumentHtmlDefinitions >	CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Post Responsive HTML Preview for a document in a template. More...

Tabs	CreateTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Adds the tabs to a tempate More...

ApiResponse< Tabs >	CreateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Adds the tabs to a tempate More...

ViewUrl	CreateTemplateRecipientPreview (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
	Provides a URL to start a recipient view of the Envelope UI More...

ApiResponse< ViewUrl >	CreateTemplateRecipientPreviewWithHttpInfo (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
	Provides a URL to start a recipient view of the Envelope UI More...

DocumentHtmlDefinitions	CreateTemplateResponsiveHtmlPreview (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Get Responsive HTML Preview for all documents in a template. More...

ApiResponse< DocumentHtmlDefinitions >	CreateTemplateResponsiveHtmlPreviewWithHttpInfo (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Get Responsive HTML Preview for all documents in a template. More...

CustomFields	DeleteCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Deletes envelope custom fields in a template. More...

ApiResponse< CustomFields >	DeleteCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Deletes envelope custom fields in a template. More...

DocumentFieldsInformation	DeleteDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Deletes custom document fields from an existing template document. More...

ApiResponse< DocumentFieldsInformation >	DeleteDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Deletes custom document fields from an existing template document. More...

void	DeleteDocumentPage (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Deletes a page from a document in an template. More...

ApiResponse< Object >	DeleteDocumentPageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Deletes a page from a document in an template. More...

TemplateDocumentsResult	DeleteDocuments (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Deletes documents from a template. More...

ApiResponse< TemplateDocumentsResult >	DeleteDocumentsWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Deletes documents from a template. More...

GroupInformation	DeleteGroupShare (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Removes a member group's sharing permissions for a template. More...

ApiResponse< GroupInformation >	DeleteGroupShareWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Removes a member group's sharing permissions for a template. More...

LockInformation	DeleteLock (string accountId, string templateId, LockRequest lockRequest=null)
	Deletes a template lock. More...

ApiResponse< LockInformation >	DeleteLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Deletes a template lock. More...

Recipients	DeleteRecipient (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
	Deletes the specified recipient file from a template. More...

ApiResponse< Recipients >	DeleteRecipientWithHttpInfo (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
	Deletes the specified recipient file from a template. More...

Recipients	DeleteRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null)
	Deletes recipients from a template. More...

ApiResponse< Recipients >	DeleteRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null)
	Deletes recipients from a template. More...

Tabs	DeleteTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Deletes the tabs associated with a recipient in a template. More...

ApiResponse< Tabs >	DeleteTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Deletes the tabs associated with a recipient in a template. More...

Tabs	DeleteTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Deletes tabs from an envelope document More...

ApiResponse< Tabs >	DeleteTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Deletes tabs from an envelope document More...

EnvelopeTemplate	Get (string accountId, string templateId, TemplatesApi.GetOptions options=null)
	Gets a list of templates for a specified account. More...

ApiResponse< EnvelopeTemplate >	GetWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
	Gets a list of templates for a specified account. More...

System.IO.Stream	GetDocument (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
	Gets PDF documents from a template. More...

ApiResponse< System.IO.Stream >	GetDocumentWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
	Gets PDF documents from a template. More...

System.IO.Stream	GetDocumentPageImage (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
	Gets a page image from a template for display. More...

ApiResponse< System.IO.Stream >	GetDocumentPageImageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
	Gets a page image from a template for display. More...

Tabs	GetDocumentTabs (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
	Returns tabs on the document. More...

ApiResponse< Tabs >	GetDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
	Returns tabs on the document. More...

LockInformation	GetLock (string accountId, string templateId)
	Gets template lock information. More...

ApiResponse< LockInformation >	GetLockWithHttpInfo (string accountId, string templateId)
	Gets template lock information. More...

Notification	GetNotificationSettings (string accountId, string templateId)
	Gets template notification information. More...

ApiResponse< Notification >	GetNotificationSettingsWithHttpInfo (string accountId, string templateId)
	Gets template notification information. More...

Tabs	GetPageTabs (string accountId, string templateId, string documentId, string pageNumber)
	Returns tabs on the specified page. More...

ApiResponse< Tabs >	GetPageTabsWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber)
	Returns tabs on the specified page. More...

PageImages	GetPages (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
	Returns document page image(s) based on input. More...

ApiResponse< PageImages >	GetPagesWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
	Returns document page image(s) based on input. More...

DocumentHtmlDefinitionOriginals	GetTemplateDocumentHtmlDefinitions (string accountId, string templateId, string documentId)
	Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...

ApiResponse< DocumentHtmlDefinitionOriginals >	GetTemplateDocumentHtmlDefinitionsWithHttpInfo (string accountId, string templateId, string documentId)
	Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...

DocumentHtmlDefinitionOriginals	GetTemplateHtmlDefinitions (string accountId, string templateId)
	Get the Original HTML Definition used to generate the Responsive HTML for the template. More...

ApiResponse< DocumentHtmlDefinitionOriginals >	GetTemplateHtmlDefinitionsWithHttpInfo (string accountId, string templateId)
	Get the Original HTML Definition used to generate the Responsive HTML for the template. More...

CustomFields	ListCustomFields (string accountId, string templateId)
	Gets the custom document fields from a template. More...

ApiResponse< CustomFields >	ListCustomFieldsWithHttpInfo (string accountId, string templateId)
	Gets the custom document fields from a template. More...

DocumentFieldsInformation	ListDocumentFields (string accountId, string templateId, string documentId)
	Gets the custom document fields for a an existing template document. More...

ApiResponse< DocumentFieldsInformation >	ListDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId)
	Gets the custom document fields for a an existing template document. More...

TemplateDocumentsResult	ListDocuments (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
	Gets a list of documents associated with a template. More...

ApiResponse< TemplateDocumentsResult >	ListDocumentsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
	Gets a list of documents associated with a template. More...

Recipients	ListRecipients (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
	Gets recipient information from a template. More...

ApiResponse< Recipients >	ListRecipientsWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
	Gets recipient information from a template. More...

Tabs	ListTabs (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
	Gets the tabs information for a signer or sign-in-person recipient in a template. More...

ApiResponse< Tabs >	ListTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
	Gets the tabs information for a signer or sign-in-person recipient in a template. More...

EnvelopeTemplateResults	ListTemplates (string accountId, TemplatesApi.ListTemplatesOptions options=null)
	Gets the definition of a template. More...

ApiResponse< EnvelopeTemplateResults >	ListTemplatesWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
	Gets the definition of a template. More...

void	RotateDocumentPage (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Rotates page image from a template for display. More...

ApiResponse< Object >	RotateDocumentPageWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Rotates page image from a template for display. More...

TemplateUpdateSummary	Update (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
	Updates an existing template. More...

ApiResponse< TemplateUpdateSummary >	UpdateWithHttpInfo (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
	Updates an existing template. More...

CustomFields	UpdateCustomFields (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Updates envelope custom fields in a template. More...

ApiResponse< CustomFields >	UpdateCustomFieldsWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Updates envelope custom fields in a template. More...

EnvelopeDocument	UpdateDocument (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
	Adds a document to a template document. More...

ApiResponse< EnvelopeDocument >	UpdateDocumentWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
	Adds a document to a template document. More...

DocumentFieldsInformation	UpdateDocumentFields (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Updates existing custom document fields in an existing template document. More...

ApiResponse< DocumentFieldsInformation >	UpdateDocumentFieldsWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Updates existing custom document fields in an existing template document. More...

TemplateDocumentsResult	UpdateDocuments (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Adds documents to a template document. More...

ApiResponse< TemplateDocumentsResult >	UpdateDocumentsWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Adds documents to a template document. More...

GroupInformation	UpdateGroupShare (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Shares a template with a group More...

ApiResponse< GroupInformation >	UpdateGroupShareWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Shares a template with a group More...

LockInformation	UpdateLock (string accountId, string templateId, LockRequest lockRequest=null)
	Updates a template lock. More...

ApiResponse< LockInformation >	UpdateLockWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Updates a template lock. More...

Notification	UpdateNotificationSettings (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
	Updates the notification structure for an existing template. More...

ApiResponse< Notification >	UpdateNotificationSettingsWithHttpInfo (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
	Updates the notification structure for an existing template. More...

RecipientsUpdateSummary	UpdateRecipients (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
	Updates recipients in a template. More...

ApiResponse< RecipientsUpdateSummary >	UpdateRecipientsWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
	Updates recipients in a template. More...

Tabs	UpdateTabs (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Updates the tabs for a recipient. More...

ApiResponse< Tabs >	UpdateTabsWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Updates the tabs for a recipient. More...

Tabs	UpdateTemplateDocumentTabs (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Updates the tabs for a template More...

ApiResponse< Tabs >	UpdateTemplateDocumentTabsWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Updates the tabs for a template More...

System.Threading.Tasks.Task< CustomFields >	CreateCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Creates custom document fields in an existing template document. More...

System.Threading.Tasks.Task< ApiResponse< CustomFields > >	CreateCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Creates custom document fields in an existing template document. More...

System.Threading.Tasks.Task< DocumentFieldsInformation >	CreateDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Creates custom document fields in an existing template document. More...

System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > >	CreateDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Creates custom document fields in an existing template document. More...

System.Threading.Tasks.Task< ViewUrl >	CreateEditViewAsync (string accountId, string templateId, ReturnUrlRequest returnUrlRequest=null)
	Provides a URL to start an edit view of the Template UI More...

System.Threading.Tasks.Task< ApiResponse< ViewUrl > >	CreateEditViewAsyncWithHttpInfo (string accountId, string templateId, ReturnUrlRequest returnUrlRequest=null)
	Provides a URL to start an edit view of the Template UI More...

System.Threading.Tasks.Task< LockInformation >	CreateLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
	Lock a template. More...

System.Threading.Tasks.Task< ApiResponse< LockInformation > >	CreateLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Lock a template. More...

System.Threading.Tasks.Task< Recipients >	CreateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
	Adds tabs for a recipient. More...

System.Threading.Tasks.Task< ApiResponse< Recipients > >	CreateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.CreateRecipientsOptions options=null)
	Adds tabs for a recipient. More...

System.Threading.Tasks.Task< Tabs >	CreateTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Adds tabs for a recipient. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	CreateTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Adds tabs for a recipient. More...

System.Threading.Tasks.Task< TemplateSummary >	CreateTemplateAsync (string accountId, EnvelopeTemplate envelopeTemplate=null)
	Creates an envelope from a template. More...

System.Threading.Tasks.Task< ApiResponse< TemplateSummary > >	CreateTemplateAsyncWithHttpInfo (string accountId, EnvelopeTemplate envelopeTemplate=null)
	Creates an envelope from a template. More...

System.Threading.Tasks.Task< DocumentHtmlDefinitions >	CreateTemplateDocumentResponsiveHtmlPreviewAsync (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Post Responsive HTML Preview for a document in a template. More...

System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > >	CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Post Responsive HTML Preview for a document in a template. More...

System.Threading.Tasks.Task< Tabs >	CreateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Adds the tabs to a tempate More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	CreateTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Adds the tabs to a tempate More...

System.Threading.Tasks.Task< ViewUrl >	CreateTemplateRecipientPreviewAsync (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
	Provides a URL to start a recipient view of the Envelope UI More...

System.Threading.Tasks.Task< ApiResponse< ViewUrl > >	CreateTemplateRecipientPreviewAsyncWithHttpInfo (string accountId, string templateId, RecipientPreviewRequest recipientPreviewRequest=null)
	Provides a URL to start a recipient view of the Envelope UI More...

System.Threading.Tasks.Task< DocumentHtmlDefinitions >	CreateTemplateResponsiveHtmlPreviewAsync (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Get Responsive HTML Preview for all documents in a template. More...

System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > >	CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string templateId, DocumentHtmlDefinition documentHtmlDefinition=null)
	Get Responsive HTML Preview for all documents in a template. More...

System.Threading.Tasks.Task< CustomFields >	DeleteCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Deletes envelope custom fields in a template. More...

System.Threading.Tasks.Task< ApiResponse< CustomFields > >	DeleteCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Deletes envelope custom fields in a template. More...

System.Threading.Tasks.Task< DocumentFieldsInformation >	DeleteDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Deletes custom document fields from an existing template document. More...

System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > >	DeleteDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Deletes custom document fields from an existing template document. More...

System.Threading.Tasks.Task	DeleteDocumentPageAsync (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Deletes a page from a document in an template. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteDocumentPageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Deletes a page from a document in an template. More...

System.Threading.Tasks.Task< TemplateDocumentsResult >	DeleteDocumentsAsync (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Deletes documents from a template. More...

System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > >	DeleteDocumentsAsyncWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Deletes documents from a template. More...

System.Threading.Tasks.Task< GroupInformation >	DeleteGroupShareAsync (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Removes a member group's sharing permissions for a template. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	DeleteGroupShareAsyncWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Removes a member group's sharing permissions for a template. More...

System.Threading.Tasks.Task< LockInformation >	DeleteLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
	Deletes a template lock. More...

System.Threading.Tasks.Task< ApiResponse< LockInformation > >	DeleteLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Deletes a template lock. More...

System.Threading.Tasks.Task< Recipients >	DeleteRecipientAsync (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
	Deletes the specified recipient file from a template. More...

System.Threading.Tasks.Task< ApiResponse< Recipients > >	DeleteRecipientAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateRecipients templateRecipients=null)
	Deletes the specified recipient file from a template. More...

System.Threading.Tasks.Task< Recipients >	DeleteRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null)
	Deletes recipients from a template. More...

System.Threading.Tasks.Task< ApiResponse< Recipients > >	DeleteRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null)
	Deletes recipients from a template. More...

System.Threading.Tasks.Task< Tabs >	DeleteTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Deletes the tabs associated with a recipient in a template. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	DeleteTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Deletes the tabs associated with a recipient in a template. More...

System.Threading.Tasks.Task< Tabs >	DeleteTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Deletes tabs from an envelope document More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	DeleteTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Deletes tabs from an envelope document More...

System.Threading.Tasks.Task< EnvelopeTemplate >	GetAsync (string accountId, string templateId, TemplatesApi.GetOptions options=null)
	Gets a list of templates for a specified account. More...

System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplate > >	GetAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.GetOptions options=null)
	Gets a list of templates for a specified account. More...

System.Threading.Tasks.Task< System.IO.Stream >	GetDocumentAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
	Gets PDF documents from a template. More...

System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > >	GetDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentOptions options=null)
	Gets PDF documents from a template. More...

System.Threading.Tasks.Task< System.IO.Stream >	GetDocumentPageImageAsync (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
	Gets a page image from a template for display. More...

System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > >	GetDocumentPageImageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, TemplatesApi.GetDocumentPageImageOptions options=null)
	Gets a page image from a template for display. More...

System.Threading.Tasks.Task< Tabs >	GetDocumentTabsAsync (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
	Returns tabs on the document. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	GetDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetDocumentTabsOptions options=null)
	Returns tabs on the document. More...

System.Threading.Tasks.Task< LockInformation >	GetLockAsync (string accountId, string templateId)
	Gets template lock information. More...

System.Threading.Tasks.Task< ApiResponse< LockInformation > >	GetLockAsyncWithHttpInfo (string accountId, string templateId)
	Gets template lock information. More...

System.Threading.Tasks.Task< Notification >	GetNotificationSettingsAsync (string accountId, string templateId)
	Gets template notification information. More...

System.Threading.Tasks.Task< ApiResponse< Notification > >	GetNotificationSettingsAsyncWithHttpInfo (string accountId, string templateId)
	Gets template notification information. More...

System.Threading.Tasks.Task< Tabs >	GetPageTabsAsync (string accountId, string templateId, string documentId, string pageNumber)
	Returns tabs on the specified page. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	GetPageTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber)
	Returns tabs on the specified page. More...

System.Threading.Tasks.Task< PageImages >	GetPagesAsync (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
	Returns document page image(s) based on input. More...

System.Threading.Tasks.Task< ApiResponse< PageImages > >	GetPagesAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplatesApi.GetPagesOptions options=null)
	Returns document page image(s) based on input. More...

System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginals >	GetTemplateDocumentHtmlDefinitionsAsync (string accountId, string templateId, string documentId)
	Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...

System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > >	GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo (string accountId, string templateId, string documentId)
	Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. More...

System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginals >	GetTemplateHtmlDefinitionsAsync (string accountId, string templateId)
	Get the Original HTML Definition used to generate the Responsive HTML for the template. More...

System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > >	GetTemplateHtmlDefinitionsAsyncWithHttpInfo (string accountId, string templateId)
	Get the Original HTML Definition used to generate the Responsive HTML for the template. More...

System.Threading.Tasks.Task< CustomFields >	ListCustomFieldsAsync (string accountId, string templateId)
	Gets the custom document fields from a template. More...

System.Threading.Tasks.Task< ApiResponse< CustomFields > >	ListCustomFieldsAsyncWithHttpInfo (string accountId, string templateId)
	Gets the custom document fields from a template. More...

System.Threading.Tasks.Task< DocumentFieldsInformation >	ListDocumentFieldsAsync (string accountId, string templateId, string documentId)
	Gets the custom document fields for a an existing template document. More...

System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > >	ListDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId)
	Gets the custom document fields for a an existing template document. More...

System.Threading.Tasks.Task< TemplateDocumentsResult >	ListDocumentsAsync (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
	Gets a list of documents associated with a template. More...

System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > >	ListDocumentsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListDocumentsOptions options=null)
	Gets a list of documents associated with a template. More...

System.Threading.Tasks.Task< Recipients >	ListRecipientsAsync (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
	Gets recipient information from a template. More...

System.Threading.Tasks.Task< ApiResponse< Recipients > >	ListRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplatesApi.ListRecipientsOptions options=null)
	Gets recipient information from a template. More...

System.Threading.Tasks.Task< Tabs >	ListTabsAsync (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
	Gets the tabs information for a signer or sign-in-person recipient in a template. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	ListTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplatesApi.ListTabsOptions options=null)
	Gets the tabs information for a signer or sign-in-person recipient in a template. More...

System.Threading.Tasks.Task< EnvelopeTemplateResults >	ListTemplatesAsync (string accountId, TemplatesApi.ListTemplatesOptions options=null)
	Gets the definition of a template. More...

System.Threading.Tasks.Task< ApiResponse< EnvelopeTemplateResults > >	ListTemplatesAsyncWithHttpInfo (string accountId, TemplatesApi.ListTemplatesOptions options=null)
	Gets the definition of a template. More...

System.Threading.Tasks.Task	RotateDocumentPageAsync (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Rotates page image from a template for display. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	RotateDocumentPageAsyncWithHttpInfo (string accountId, string templateId, string documentId, string pageNumber, PageRequest pageRequest=null)
	Rotates page image from a template for display. More...

System.Threading.Tasks.Task< TemplateUpdateSummary >	UpdateAsync (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
	Updates an existing template. More...

System.Threading.Tasks.Task< ApiResponse< TemplateUpdateSummary > >	UpdateAsyncWithHttpInfo (string accountId, string templateId, EnvelopeTemplate envelopeTemplate=null)
	Updates an existing template. More...

System.Threading.Tasks.Task< CustomFields >	UpdateCustomFieldsAsync (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Updates envelope custom fields in a template. More...

System.Threading.Tasks.Task< ApiResponse< CustomFields > >	UpdateCustomFieldsAsyncWithHttpInfo (string accountId, string templateId, TemplateCustomFields templateCustomFields=null)
	Updates envelope custom fields in a template. More...

System.Threading.Tasks.Task< EnvelopeDocument >	UpdateDocumentAsync (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
	Adds a document to a template document. More...

System.Threading.Tasks.Task< ApiResponse< EnvelopeDocument > >	UpdateDocumentAsyncWithHttpInfo (string accountId, string templateId, string documentId, EnvelopeDefinition envelopeDefinition=null, TemplatesApi.UpdateDocumentOptions options=null)
	Adds a document to a template document. More...

System.Threading.Tasks.Task< DocumentFieldsInformation >	UpdateDocumentFieldsAsync (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Updates existing custom document fields in an existing template document. More...

System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > >	UpdateDocumentFieldsAsyncWithHttpInfo (string accountId, string templateId, string documentId, DocumentFieldsInformation documentFieldsInformation=null)
	Updates existing custom document fields in an existing template document. More...

System.Threading.Tasks.Task< TemplateDocumentsResult >	UpdateDocumentsAsync (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Adds documents to a template document. More...

System.Threading.Tasks.Task< ApiResponse< TemplateDocumentsResult > >	UpdateDocumentsAsyncWithHttpInfo (string accountId, string templateId, EnvelopeDefinition envelopeDefinition=null)
	Adds documents to a template document. More...

System.Threading.Tasks.Task< GroupInformation >	UpdateGroupShareAsync (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Shares a template with a group More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	UpdateGroupShareAsyncWithHttpInfo (string accountId, string templateId, string templatePart, GroupInformation groupInformation=null)
	Shares a template with a group More...

System.Threading.Tasks.Task< LockInformation >	UpdateLockAsync (string accountId, string templateId, LockRequest lockRequest=null)
	Updates a template lock. More...

System.Threading.Tasks.Task< ApiResponse< LockInformation > >	UpdateLockAsyncWithHttpInfo (string accountId, string templateId, LockRequest lockRequest=null)
	Updates a template lock. More...

System.Threading.Tasks.Task< Notification >	UpdateNotificationSettingsAsync (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
	Updates the notification structure for an existing template. More...

System.Threading.Tasks.Task< ApiResponse< Notification > >	UpdateNotificationSettingsAsyncWithHttpInfo (string accountId, string templateId, TemplateNotificationRequest templateNotificationRequest=null)
	Updates the notification structure for an existing template. More...

System.Threading.Tasks.Task< RecipientsUpdateSummary >	UpdateRecipientsAsync (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
	Updates recipients in a template. More...

System.Threading.Tasks.Task< ApiResponse< RecipientsUpdateSummary > >	UpdateRecipientsAsyncWithHttpInfo (string accountId, string templateId, TemplateRecipients templateRecipients=null, TemplatesApi.UpdateRecipientsOptions options=null)
	Updates recipients in a template. More...

System.Threading.Tasks.Task< Tabs >	UpdateTabsAsync (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Updates the tabs for a recipient. More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	UpdateTabsAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateTabs templateTabs=null)
	Updates the tabs for a recipient. More...

System.Threading.Tasks.Task< Tabs >	UpdateTemplateDocumentTabsAsync (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Updates the tabs for a template More...

System.Threading.Tasks.Task< ApiResponse< Tabs > >	UpdateTemplateDocumentTabsAsyncWithHttpInfo (string accountId, string templateId, string documentId, TemplateTabs templateTabs=null)
	Updates the tabs for a template More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateCustomFields()

CustomFields DocuSign.eSign.Api.ITemplatesApi.CreateCustomFields	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateCustomFieldsAsync()

System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.ITemplatesApi.CreateCustomFieldsAsync	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of CustomFields

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateCustomFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.ITemplatesApi.CreateCustomFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of ApiResponse (CustomFields)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.ITemplatesApi.CreateCustomFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.ITemplatesApi.CreateDocumentFields	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateDocumentFieldsAsync()

System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.CreateDocumentFieldsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of DocumentFieldsInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateDocumentFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.ITemplatesApi.CreateDocumentFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of ApiResponse (DocumentFieldsInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.CreateDocumentFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Creates custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateEditView()

ViewUrl DocuSign.eSign.Api.ITemplatesApi.CreateEditView	(	string	accountId,
		string	templateId,
		ReturnUrlRequest	returnUrlRequest = `null`
	)

Provides a URL to start an edit view of the Template UI

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
returnUrlRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateEditViewAsync()

System.Threading.Tasks.Task<ViewUrl> DocuSign.eSign.Api.ITemplatesApi.CreateEditViewAsync	(	string	accountId,
		string	templateId,
		ReturnUrlRequest	returnUrlRequest = `null`
	)

Provides a URL to start an edit view of the Template UI

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
returnUrlRequest	(optional)

Returns: Task of ViewUrl

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateEditViewAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<ViewUrl> > DocuSign.eSign.Api.ITemplatesApi.CreateEditViewAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		ReturnUrlRequest	returnUrlRequest = `null`
	)

Provides a URL to start an edit view of the Template UI

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
returnUrlRequest	(optional)

Returns: Task of ApiResponse (ViewUrl)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateEditViewWithHttpInfo()

ApiResponse<ViewUrl> DocuSign.eSign.Api.ITemplatesApi.CreateEditViewWithHttpInfo	(	string	accountId,
		string	templateId,
		ReturnUrlRequest	returnUrlRequest = `null`
	)

Provides a URL to start an edit view of the Template UI

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
returnUrlRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateLock()

LockInformation DocuSign.eSign.Api.ITemplatesApi.CreateLock	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Lock a template.

Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateLockAsync()

System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.ITemplatesApi.CreateLockAsync	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Lock a template.

Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of LockInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateLockAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.ITemplatesApi.CreateLockAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Lock a template.

Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of ApiResponse (LockInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.ITemplatesApi.CreateLockWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Lock a template.

Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateRecipients()

Recipients DocuSign.eSign.Api.ITemplatesApi.CreateRecipients	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.CreateRecipientsOptions	options = `null`
	)

Adds tabs for a recipient.

Adds one or more recipients to a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns

◆ CreateRecipientsAsync()

System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.ITemplatesApi.CreateRecipientsAsync	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.CreateRecipientsOptions	options = `null`
	)

Adds tabs for a recipient.

Adds one or more recipients to a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of Recipients

◆ CreateRecipientsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.ITemplatesApi.CreateRecipientsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.CreateRecipientsOptions	options = `null`
	)

Adds tabs for a recipient.

Adds one or more recipients to a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (Recipients)

◆ CreateRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.ITemplatesApi.CreateRecipientsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.CreateRecipientsOptions	options = `null`
	)

Adds tabs for a recipient.

Adds one or more recipients to a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ CreateTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.CreateTabs	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Adds tabs for a recipient.

Adds one or more tabs for a recipient.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.CreateTabsAsync	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Adds tabs for a recipient.

Adds one or more tabs for a recipient.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.CreateTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Adds tabs for a recipient.

Adds one or more tabs for a recipient.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.CreateTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Adds tabs for a recipient.

Adds one or more tabs for a recipient.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplate()

TemplateSummary DocuSign.eSign.Api.ITemplatesApi.CreateTemplate	(	string	accountId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Creates an envelope from a template.

Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
envelopeTemplate	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateAsync()

System.Threading.Tasks.Task<TemplateSummary> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateAsync	(	string	accountId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Creates an envelope from a template.

Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
envelopeTemplate	(optional)

Returns: Task of TemplateSummary

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TemplateSummary> > DocuSign.eSign.Api.ITemplatesApi.CreateTemplateAsyncWithHttpInfo	(	string	accountId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Creates an envelope from a template.

Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
envelopeTemplate	(optional)

Returns: Task of ApiResponse (TemplateSummary)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreview()

DocumentHtmlDefinitions DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentResponsiveHtmlPreview	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Post Responsive HTML Preview for a document in a template.

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentHtmlDefinition	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsync()

System.Threading.Tasks.Task<DocumentHtmlDefinitions> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Post Responsive HTML Preview for a document in a template.

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentHtmlDefinition	(optional)

Returns: Task of DocumentHtmlDefinitions

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitions> > DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Post Responsive HTML Preview for a document in a template.

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentHtmlDefinition	(optional)

Returns: Task of ApiResponse (DocumentHtmlDefinitions)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo()

ApiResponse<DocumentHtmlDefinitions> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Post Responsive HTML Preview for a document in a template.

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentHtmlDefinition	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentTabs	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Adds the tabs to a tempate

Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentTabsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Adds the tabs to a tempate

Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Adds the tabs to a tempate

Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateDocumentTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Adds the tabs to a tempate

Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateRecipientPreview()

ViewUrl DocuSign.eSign.Api.ITemplatesApi.CreateTemplateRecipientPreview	(	string	accountId,
		string	templateId,
		RecipientPreviewRequest	recipientPreviewRequest = `null`
	)

Provides a URL to start a recipient view of the Envelope UI

This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientPreviewRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateRecipientPreviewAsync()

System.Threading.Tasks.Task<ViewUrl> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateRecipientPreviewAsync	(	string	accountId,
		string	templateId,
		RecipientPreviewRequest	recipientPreviewRequest = `null`
	)

Provides a URL to start a recipient view of the Envelope UI

This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientPreviewRequest	(optional)

Returns: Task of ViewUrl

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateRecipientPreviewAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<ViewUrl> > DocuSign.eSign.Api.ITemplatesApi.CreateTemplateRecipientPreviewAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		RecipientPreviewRequest	recipientPreviewRequest = `null`
	)

Provides a URL to start a recipient view of the Envelope UI

This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientPreviewRequest	(optional)

Returns: Task of ApiResponse (ViewUrl)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateRecipientPreviewWithHttpInfo()

ApiResponse<ViewUrl> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateRecipientPreviewWithHttpInfo	(	string	accountId,
		string	templateId,
		RecipientPreviewRequest	recipientPreviewRequest = `null`
	)

Provides a URL to start a recipient view of the Envelope UI

This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientPreviewRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateResponsiveHtmlPreview()

DocumentHtmlDefinitions DocuSign.eSign.Api.ITemplatesApi.CreateTemplateResponsiveHtmlPreview	(	string	accountId,
		string	templateId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Get Responsive HTML Preview for all documents in a template.

Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentHtmlDefinition	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewAsync()

System.Threading.Tasks.Task<DocumentHtmlDefinitions> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateResponsiveHtmlPreviewAsync	(	string	accountId,
		string	templateId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Get Responsive HTML Preview for all documents in a template.

Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentHtmlDefinition	(optional)

Returns: Task of DocumentHtmlDefinitions

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitions> > DocuSign.eSign.Api.ITemplatesApi.CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Get Responsive HTML Preview for all documents in a template.

Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentHtmlDefinition	(optional)

Returns: Task of ApiResponse (DocumentHtmlDefinitions)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateResponsiveHtmlPreviewWithHttpInfo()

ApiResponse<DocumentHtmlDefinitions> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateResponsiveHtmlPreviewWithHttpInfo	(	string	accountId,
		string	templateId,
		DocumentHtmlDefinition	documentHtmlDefinition = `null`
	)

Get Responsive HTML Preview for all documents in a template.

Creates a preview of the responsive, HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentHtmlDefinition	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ CreateTemplateWithHttpInfo()

ApiResponse<TemplateSummary> DocuSign.eSign.Api.ITemplatesApi.CreateTemplateWithHttpInfo	(	string	accountId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Creates an envelope from a template.

Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient's name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` To add a recipient's email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
envelopeTemplate	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteCustomFields()

CustomFields DocuSign.eSign.Api.ITemplatesApi.DeleteCustomFields	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Deletes envelope custom fields in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteCustomFieldsAsync()

System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.ITemplatesApi.DeleteCustomFieldsAsync	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Deletes envelope custom fields in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of CustomFields

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteCustomFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.ITemplatesApi.DeleteCustomFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Deletes envelope custom fields in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of ApiResponse (CustomFields)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.ITemplatesApi.DeleteCustomFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Deletes envelope custom fields in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentFields	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Deletes custom document fields from an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentFieldsAsync()

System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentFieldsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Deletes custom document fields from an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of DocumentFieldsInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Deletes custom document fields from an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of ApiResponse (DocumentFieldsInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Deletes custom document fields from an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentPage()

void DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentPage	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Deletes a page from a document in an template.

Deletes a page from a document in a template based on the page number.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentPageAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentPageAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Deletes a page from a document in an template.

Deletes a page from a document in a template based on the page number.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: Task of void

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentPageAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentPageAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Deletes a page from a document in an template.

Deletes a page from a document in a template based on the page number.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentPageWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentPageWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Deletes a page from a document in an template.

Deletes a page from a document in a template based on the page number.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.ITemplatesApi.DeleteDocuments	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Deletes documents from a template.

Deletes one or more documents from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentsAsync()

System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentsAsync	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Deletes documents from a template.

Deletes one or more documents from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: Task of TemplateDocumentsResult

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Deletes documents from a template.

Deletes one or more documents from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: Task of ApiResponse (TemplateDocumentsResult)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.DeleteDocumentsWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Deletes documents from a template.

Deletes one or more documents from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteGroupShare()

GroupInformation DocuSign.eSign.Api.ITemplatesApi.DeleteGroupShare	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Removes a member group's sharing permissions for a template.

Removes a member group's sharing permissions for a specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteGroupShareAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteGroupShareAsync	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Removes a member group's sharing permissions for a template.

Removes a member group's sharing permissions for a specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: Task of GroupInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteGroupShareAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.ITemplatesApi.DeleteGroupShareAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Removes a member group's sharing permissions for a template.

Removes a member group's sharing permissions for a specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: Task of ApiResponse (GroupInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteGroupShareWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteGroupShareWithHttpInfo	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Removes a member group's sharing permissions for a template.

Removes a member group's sharing permissions for a specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteLock()

LockInformation DocuSign.eSign.Api.ITemplatesApi.DeleteLock	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Deletes a template lock.

Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteLockAsync()

System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteLockAsync	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Deletes a template lock.

Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of LockInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteLockAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.ITemplatesApi.DeleteLockAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Deletes a template lock.

Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of ApiResponse (LockInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.ITemplatesApi.DeleteLockWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Deletes a template lock.

Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipient()

Recipients DocuSign.eSign.Api.ITemplatesApi.DeleteRecipient	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes the specified recipient file from a template.

Deletes the specified recipient file from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateRecipients	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientAsync()

System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientAsync	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes the specified recipient file from a template.

Deletes the specified recipient file from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateRecipients	(optional)

Returns: Task of Recipients

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes the specified recipient file from a template.

Deletes the specified recipient file from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateRecipients	(optional)

Returns: Task of ApiResponse (Recipients)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipients()

Recipients DocuSign.eSign.Api.ITemplatesApi.DeleteRecipients	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes recipients from a template.

Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientsAsync()

System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientsAsync	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes recipients from a template.

Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)

Returns: Task of Recipients

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes recipients from a template.

Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)

Returns: Task of ApiResponse (Recipients)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes recipients from a template.

Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteRecipientWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.ITemplatesApi.DeleteRecipientWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateRecipients	templateRecipients = `null`
	)

Deletes the specified recipient file from a template.

Deletes the specified recipient file from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateRecipients	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.DeleteTabs	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Deletes the tabs associated with a recipient in a template.

Deletes one or more tabs associated with a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.DeleteTabsAsync	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Deletes the tabs associated with a recipient in a template.

Deletes one or more tabs associated with a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.DeleteTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Deletes the tabs associated with a recipient in a template.

Deletes one or more tabs associated with a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.DeleteTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Deletes the tabs associated with a recipient in a template.

Deletes one or more tabs associated with a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.DeleteTemplateDocumentTabs	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Deletes tabs from an envelope document

Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTemplateDocumentTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.DeleteTemplateDocumentTabsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Deletes tabs from an envelope document

Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTemplateDocumentTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.DeleteTemplateDocumentTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Deletes tabs from an envelope document

Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ DeleteTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.DeleteTemplateDocumentTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Deletes tabs from an envelope document

Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ Get()

EnvelopeTemplate DocuSign.eSign.Api.ITemplatesApi.Get	(	string	accountId,
		string	templateId,
		TemplatesApi.GetOptions	options = `null`
	)

Gets a list of templates for a specified account.

Retrieves the definition of the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ GetAsync()

System.Threading.Tasks.Task<EnvelopeTemplate> DocuSign.eSign.Api.ITemplatesApi.GetAsync	(	string	accountId,
		string	templateId,
		TemplatesApi.GetOptions	options = `null`
	)

Gets a list of templates for a specified account.

Retrieves the definition of the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of EnvelopeTemplate

◆ GetAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<EnvelopeTemplate> > DocuSign.eSign.Api.ITemplatesApi.GetAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.GetOptions	options = `null`
	)

Gets a list of templates for a specified account.

Retrieves the definition of the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (EnvelopeTemplate)

◆ GetDocument()

System.IO.Stream DocuSign.eSign.Api.ITemplatesApi.GetDocument	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentOptions	options = `null`
	)

Gets PDF documents from a template.

Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ GetDocumentAsync()

System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.ITemplatesApi.GetDocumentAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentOptions	options = `null`
	)

Gets PDF documents from a template.

Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of System.IO.Stream

◆ GetDocumentAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.ITemplatesApi.GetDocumentAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentOptions	options = `null`
	)

Gets PDF documents from a template.

Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (System.IO.Stream)

◆ GetDocumentPageImage()

System.IO.Stream DocuSign.eSign.Api.ITemplatesApi.GetDocumentPageImage	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		TemplatesApi.GetDocumentPageImageOptions	options = `null`
	)

Gets a page image from a template for display.

Retrieves a page image for display from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ GetDocumentPageImageAsync()

System.Threading.Tasks.Task<System.IO.Stream> DocuSign.eSign.Api.ITemplatesApi.GetDocumentPageImageAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		TemplatesApi.GetDocumentPageImageOptions	options = `null`
	)

Gets a page image from a template for display.

Retrieves a page image for display from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of System.IO.Stream

◆ GetDocumentPageImageAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<System.IO.Stream> > DocuSign.eSign.Api.ITemplatesApi.GetDocumentPageImageAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		TemplatesApi.GetDocumentPageImageOptions	options = `null`
	)

Gets a page image from a template for display.

Retrieves a page image for display from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (System.IO.Stream)

◆ GetDocumentPageImageWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.ITemplatesApi.GetDocumentPageImageWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		TemplatesApi.GetDocumentPageImageOptions	options = `null`
	)

Gets a page image from a template for display.

Retrieves a page image for display from the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetDocumentTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.GetDocumentTabs	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentTabsOptions	options = `null`
	)

Returns tabs on the document.

Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ GetDocumentTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.GetDocumentTabsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentTabsOptions	options = `null`
	)

Returns tabs on the document.

Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of Tabs

◆ GetDocumentTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.GetDocumentTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentTabsOptions	options = `null`
	)

Returns tabs on the document.

Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (Tabs)

◆ GetDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.GetDocumentTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentTabsOptions	options = `null`
	)

Returns tabs on the document.

Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetDocumentWithHttpInfo()

ApiResponse<System.IO.Stream> DocuSign.eSign.Api.ITemplatesApi.GetDocumentWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetDocumentOptions	options = `null`
	)

Gets PDF documents from a template.

Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetLock()

LockInformation DocuSign.eSign.Api.ITemplatesApi.GetLock	(	string	accountId,
		string	templateId
	)

Gets template lock information.

Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetLockAsync()

System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.ITemplatesApi.GetLockAsync	(	string	accountId,
		string	templateId
	)

Gets template lock information.

Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of LockInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetLockAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.ITemplatesApi.GetLockAsyncWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets template lock information.

Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of ApiResponse (LockInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.ITemplatesApi.GetLockWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets template lock information.

Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetNotificationSettings()

Notification DocuSign.eSign.Api.ITemplatesApi.GetNotificationSettings	(	string	accountId,
		string	templateId
	)

Gets template notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetNotificationSettingsAsync()

System.Threading.Tasks.Task<Notification> DocuSign.eSign.Api.ITemplatesApi.GetNotificationSettingsAsync	(	string	accountId,
		string	templateId
	)

Gets template notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of Notification

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetNotificationSettingsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Notification> > DocuSign.eSign.Api.ITemplatesApi.GetNotificationSettingsAsyncWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets template notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of ApiResponse (Notification)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetNotificationSettingsWithHttpInfo()

ApiResponse<Notification> DocuSign.eSign.Api.ITemplatesApi.GetNotificationSettingsWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets template notification information.

Retrieves the envelope notification, reminders and expirations, information for an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetPages()

PageImages DocuSign.eSign.Api.ITemplatesApi.GetPages	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetPagesOptions	options = `null`
	)

Returns document page image(s) based on input.

Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ GetPagesAsync()

System.Threading.Tasks.Task<PageImages> DocuSign.eSign.Api.ITemplatesApi.GetPagesAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetPagesOptions	options = `null`
	)

Returns document page image(s) based on input.

Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of PageImages

◆ GetPagesAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<PageImages> > DocuSign.eSign.Api.ITemplatesApi.GetPagesAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetPagesOptions	options = `null`
	)

Returns document page image(s) based on input.

Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PageImages)

◆ GetPagesWithHttpInfo()

ApiResponse<PageImages> DocuSign.eSign.Api.ITemplatesApi.GetPagesWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplatesApi.GetPagesOptions	options = `null`
	)

Returns document page image(s) based on input.

Returns images of the pages in a template document for display based on the parameters that you specify.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetPageTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.GetPageTabs	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber
	)

Returns tabs on the specified page.

Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetPageTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.GetPageTabsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber
	)

Returns tabs on the specified page.

Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetPageTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.GetPageTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber
	)

Returns tabs on the specified page.

Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetPageTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.GetPageTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber
	)

Returns tabs on the specified page.

Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateDocumentHtmlDefinitions()

DocumentHtmlDefinitionOriginals DocuSign.eSign.Api.ITemplatesApi.GetTemplateDocumentHtmlDefinitions	(	string	accountId,
		string	templateId,
		string	documentId
	)

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsAsync()

System.Threading.Tasks.Task<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.ITemplatesApi.GetTemplateDocumentHtmlDefinitionsAsync	(	string	accountId,
		string	templateId,
		string	documentId
	)

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: Task of DocumentHtmlDefinitionOriginals

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitionOriginals> > DocuSign.eSign.Api.ITemplatesApi.GetTemplateDocumentHtmlDefinitionsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId
	)

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: Task of ApiResponse (DocumentHtmlDefinitionOriginals)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateDocumentHtmlDefinitionsWithHttpInfo()

ApiResponse<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.ITemplatesApi.GetTemplateDocumentHtmlDefinitionsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId
	)

Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateHtmlDefinitions()

DocumentHtmlDefinitionOriginals DocuSign.eSign.Api.ITemplatesApi.GetTemplateHtmlDefinitions	(	string	accountId,
		string	templateId
	)

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateHtmlDefinitionsAsync()

System.Threading.Tasks.Task<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.ITemplatesApi.GetTemplateHtmlDefinitionsAsync	(	string	accountId,
		string	templateId
	)

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of DocumentHtmlDefinitionOriginals

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateHtmlDefinitionsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentHtmlDefinitionOriginals> > DocuSign.eSign.Api.ITemplatesApi.GetTemplateHtmlDefinitionsAsyncWithHttpInfo	(	string	accountId,
		string	templateId
	)

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of ApiResponse (DocumentHtmlDefinitionOriginals)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetTemplateHtmlDefinitionsWithHttpInfo()

ApiResponse<DocumentHtmlDefinitionOriginals> DocuSign.eSign.Api.ITemplatesApi.GetTemplateHtmlDefinitionsWithHttpInfo	(	string	accountId,
		string	templateId
	)

Get the Original HTML Definition used to generate the Responsive HTML for the template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ GetWithHttpInfo()

ApiResponse<EnvelopeTemplate> DocuSign.eSign.Api.ITemplatesApi.GetWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.GetOptions	options = `null`
	)

Gets a list of templates for a specified account.

Retrieves the definition of the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListCustomFields()

CustomFields DocuSign.eSign.Api.ITemplatesApi.ListCustomFields	(	string	accountId,
		string	templateId
	)

Gets the custom document fields from a template.

Retrieves the custom document field information from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListCustomFieldsAsync()

System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.ITemplatesApi.ListCustomFieldsAsync	(	string	accountId,
		string	templateId
	)

Gets the custom document fields from a template.

Retrieves the custom document field information from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of CustomFields

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListCustomFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.ITemplatesApi.ListCustomFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets the custom document fields from a template.

Retrieves the custom document field information from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: Task of ApiResponse (CustomFields)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.ITemplatesApi.ListCustomFieldsWithHttpInfo	(	string	accountId,
		string	templateId
	)

Gets the custom document fields from a template.

Retrieves the custom document field information from an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.ITemplatesApi.ListDocumentFields	(	string	accountId,
		string	templateId,
		string	documentId
	)

Gets the custom document fields for a an existing template document.

Retrieves the custom document fields for an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListDocumentFieldsAsync()

System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.ListDocumentFieldsAsync	(	string	accountId,
		string	templateId,
		string	documentId
	)

Gets the custom document fields for a an existing template document.

Retrieves the custom document fields for an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: Task of DocumentFieldsInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListDocumentFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.ITemplatesApi.ListDocumentFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId
	)

Gets the custom document fields for a an existing template document.

Retrieves the custom document fields for an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: Task of ApiResponse (DocumentFieldsInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.ListDocumentFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId
	)

Gets the custom document fields for a an existing template document.

Retrieves the custom document fields for an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ ListDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.ITemplatesApi.ListDocuments	(	string	accountId,
		string	templateId,
		TemplatesApi.ListDocumentsOptions	options = `null`
	)

Gets a list of documents associated with a template.

Retrieves a list of documents associated with the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ ListDocumentsAsync()

System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.ListDocumentsAsync	(	string	accountId,
		string	templateId,
		TemplatesApi.ListDocumentsOptions	options = `null`
	)

Gets a list of documents associated with a template.

Retrieves a list of documents associated with the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of TemplateDocumentsResult

◆ ListDocumentsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.ITemplatesApi.ListDocumentsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.ListDocumentsOptions	options = `null`
	)

Gets a list of documents associated with a template.

Retrieves a list of documents associated with the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (TemplateDocumentsResult)

◆ ListDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.ListDocumentsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.ListDocumentsOptions	options = `null`
	)

Gets a list of documents associated with a template.

Retrieves a list of documents associated with the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListRecipients()

Recipients DocuSign.eSign.Api.ITemplatesApi.ListRecipients	(	string	accountId,
		string	templateId,
		TemplatesApi.ListRecipientsOptions	options = `null`
	)

Gets recipient information from a template.

Retrieves the information for all recipients in the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ ListRecipientsAsync()

System.Threading.Tasks.Task<Recipients> DocuSign.eSign.Api.ITemplatesApi.ListRecipientsAsync	(	string	accountId,
		string	templateId,
		TemplatesApi.ListRecipientsOptions	options = `null`
	)

Gets recipient information from a template.

Retrieves the information for all recipients in the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of Recipients

◆ ListRecipientsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Recipients> > DocuSign.eSign.Api.ITemplatesApi.ListRecipientsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.ListRecipientsOptions	options = `null`
	)

Gets recipient information from a template.

Retrieves the information for all recipients in the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (Recipients)

◆ ListRecipientsWithHttpInfo()

ApiResponse<Recipients> DocuSign.eSign.Api.ITemplatesApi.ListRecipientsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplatesApi.ListRecipientsOptions	options = `null`
	)

Gets recipient information from a template.

Retrieves the information for all recipients in the specified template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.ListTabs	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplatesApi.ListTabsOptions	options = `null`
	)

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ ListTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.ListTabsAsync	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplatesApi.ListTabsOptions	options = `null`
	)

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of Tabs

◆ ListTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.ListTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplatesApi.ListTabsOptions	options = `null`
	)

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (Tabs)

◆ ListTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.ListTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplatesApi.ListTabsOptions	options = `null`
	)

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListTemplates()

EnvelopeTemplateResults DocuSign.eSign.Api.ITemplatesApi.ListTemplates	(	string	accountId,
		TemplatesApi.ListTemplatesOptions	options = `null`
	)

Gets the definition of a template.

Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ ListTemplatesAsync()

System.Threading.Tasks.Task<EnvelopeTemplateResults> DocuSign.eSign.Api.ITemplatesApi.ListTemplatesAsync	(	string	accountId,
		TemplatesApi.ListTemplatesOptions	options = `null`
	)

Gets the definition of a template.

Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of EnvelopeTemplateResults

◆ ListTemplatesAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<EnvelopeTemplateResults> > DocuSign.eSign.Api.ITemplatesApi.ListTemplatesAsyncWithHttpInfo	(	string	accountId,
		TemplatesApi.ListTemplatesOptions	options = `null`
	)

Gets the definition of a template.

Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (EnvelopeTemplateResults)

◆ ListTemplatesWithHttpInfo()

ApiResponse<EnvelopeTemplateResults> DocuSign.eSign.Api.ITemplatesApi.ListTemplatesWithHttpInfo	(	string	accountId,
		TemplatesApi.ListTemplatesOptions	options = `null`
	)

Gets the definition of a template.

Retrieves the list of templates for the specified account. The request can be limited to a specific folder.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ RotateDocumentPage()

void DocuSign.eSign.Api.ITemplatesApi.RotateDocumentPage	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Rotates page image from a template for display.

Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ RotateDocumentPageAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.ITemplatesApi.RotateDocumentPageAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Rotates page image from a template for display.

Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: Task of void

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ RotateDocumentPageAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ITemplatesApi.RotateDocumentPageAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Rotates page image from a template for display.

Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ RotateDocumentPageWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ITemplatesApi.RotateDocumentPageWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		string	pageNumber,
		PageRequest	pageRequest = `null`
	)

Rotates page image from a template for display.

Rotates page image from a template for display. The page image can be rotated to the left or right.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
pageNumber	The page number being accessed.
pageRequest	(optional)

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ Update()

TemplateUpdateSummary DocuSign.eSign.Api.ITemplatesApi.Update	(	string	accountId,
		string	templateId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Updates an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeTemplate	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateAsync()

System.Threading.Tasks.Task<TemplateUpdateSummary> DocuSign.eSign.Api.ITemplatesApi.UpdateAsync	(	string	accountId,
		string	templateId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Updates an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeTemplate	(optional)

Returns: Task of TemplateUpdateSummary

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TemplateUpdateSummary> > DocuSign.eSign.Api.ITemplatesApi.UpdateAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Updates an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeTemplate	(optional)

Returns: Task of ApiResponse (TemplateUpdateSummary)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateCustomFields()

CustomFields DocuSign.eSign.Api.ITemplatesApi.UpdateCustomFields	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Updates envelope custom fields in a template.

Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateCustomFieldsAsync()

System.Threading.Tasks.Task<CustomFields> DocuSign.eSign.Api.ITemplatesApi.UpdateCustomFieldsAsync	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Updates envelope custom fields in a template.

Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of CustomFields

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateCustomFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<CustomFields> > DocuSign.eSign.Api.ITemplatesApi.UpdateCustomFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Updates envelope custom fields in a template.

Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: Task of ApiResponse (CustomFields)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateCustomFieldsWithHttpInfo()

ApiResponse<CustomFields> DocuSign.eSign.Api.ITemplatesApi.UpdateCustomFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateCustomFields	templateCustomFields = `null`
	)

Updates envelope custom fields in a template.

Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateCustomFields	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocument()

EnvelopeDocument DocuSign.eSign.Api.ITemplatesApi.UpdateDocument	(	string	accountId,
		string	templateId,
		string	documentId,
		EnvelopeDefinition	envelopeDefinition = `null`,
		TemplatesApi.UpdateDocumentOptions	options = `null`
	)

Adds a document to a template document.

Adds the specified document to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
envelopeDefinition	(optional)
options	Options for modifying the behavior of the function.

Returns

◆ UpdateDocumentAsync()

System.Threading.Tasks.Task<EnvelopeDocument> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		EnvelopeDefinition	envelopeDefinition = `null`,
		TemplatesApi.UpdateDocumentOptions	options = `null`
	)

Adds a document to a template document.

Adds the specified document to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
envelopeDefinition	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of EnvelopeDocument

◆ UpdateDocumentAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<EnvelopeDocument> > DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		EnvelopeDefinition	envelopeDefinition = `null`,
		TemplatesApi.UpdateDocumentOptions	options = `null`
	)

Adds a document to a template document.

Adds the specified document to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
envelopeDefinition	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (EnvelopeDocument)

◆ UpdateDocumentFields()

DocumentFieldsInformation DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentFields	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Updates existing custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentFieldsAsync()

System.Threading.Tasks.Task<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentFieldsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Updates existing custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of DocumentFieldsInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentFieldsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<DocumentFieldsInformation> > DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentFieldsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Updates existing custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: Task of ApiResponse (DocumentFieldsInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentFieldsWithHttpInfo()

ApiResponse<DocumentFieldsInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentFieldsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		DocumentFieldsInformation	documentFieldsInformation = `null`
	)

Updates existing custom document fields in an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
documentFieldsInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocuments()

TemplateDocumentsResult DocuSign.eSign.Api.ITemplatesApi.UpdateDocuments	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Adds documents to a template document.

Adds one or more documents to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentsAsync()

System.Threading.Tasks.Task<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentsAsync	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Adds documents to a template document.

Adds one or more documents to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: Task of TemplateDocumentsResult

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TemplateDocumentsResult> > DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Adds documents to a template document.

Adds one or more documents to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: Task of ApiResponse (TemplateDocumentsResult)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentsWithHttpInfo()

ApiResponse<TemplateDocumentsResult> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentsWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeDefinition	envelopeDefinition = `null`
	)

Adds documents to a template document.

Adds one or more documents to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeDefinition	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateDocumentWithHttpInfo()

ApiResponse<EnvelopeDocument> DocuSign.eSign.Api.ITemplatesApi.UpdateDocumentWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		EnvelopeDefinition	envelopeDefinition = `null`,
		TemplatesApi.UpdateDocumentOptions	options = `null`
	)

Adds a document to a template document.

Adds the specified document to an existing template document.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
envelopeDefinition	(optional)
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ UpdateGroupShare()

GroupInformation DocuSign.eSign.Api.ITemplatesApi.UpdateGroupShare	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Shares a template with a group

Shares a template with the specified members group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateGroupShareAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateGroupShareAsync	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Shares a template with a group

Shares a template with the specified members group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: Task of GroupInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateGroupShareAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.ITemplatesApi.UpdateGroupShareAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Shares a template with a group

Shares a template with the specified members group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: Task of ApiResponse (GroupInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateGroupShareWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateGroupShareWithHttpInfo	(	string	accountId,
		string	templateId,
		string	templatePart,
		GroupInformation	groupInformation = `null`
	)

Shares a template with a group

Shares a template with the specified members group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templatePart	Currently, the only defined part is groups.
groupInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateLock()

LockInformation DocuSign.eSign.Api.ITemplatesApi.UpdateLock	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Updates a template lock.

Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateLockAsync()

System.Threading.Tasks.Task<LockInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateLockAsync	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Updates a template lock.

Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of LockInformation

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateLockAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<LockInformation> > DocuSign.eSign.Api.ITemplatesApi.UpdateLockAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Updates a template lock.

Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: Task of ApiResponse (LockInformation)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateLockWithHttpInfo()

ApiResponse<LockInformation> DocuSign.eSign.Api.ITemplatesApi.UpdateLockWithHttpInfo	(	string	accountId,
		string	templateId,
		LockRequest	lockRequest = `null`
	)

Updates a template lock.

Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
lockRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateNotificationSettings()

Notification DocuSign.eSign.Api.ITemplatesApi.UpdateNotificationSettings	(	string	accountId,
		string	templateId,
		TemplateNotificationRequest	templateNotificationRequest = `null`
	)

Updates the notification structure for an existing template.

Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateNotificationRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateNotificationSettingsAsync()

System.Threading.Tasks.Task<Notification> DocuSign.eSign.Api.ITemplatesApi.UpdateNotificationSettingsAsync	(	string	accountId,
		string	templateId,
		TemplateNotificationRequest	templateNotificationRequest = `null`
	)

Updates the notification structure for an existing template.

Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateNotificationRequest	(optional)

Returns: Task of Notification

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateNotificationSettingsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Notification> > DocuSign.eSign.Api.ITemplatesApi.UpdateNotificationSettingsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateNotificationRequest	templateNotificationRequest = `null`
	)

Updates the notification structure for an existing template.

Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateNotificationRequest	(optional)

Returns: Task of ApiResponse (Notification)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateNotificationSettingsWithHttpInfo()

ApiResponse<Notification> DocuSign.eSign.Api.ITemplatesApi.UpdateNotificationSettingsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateNotificationRequest	templateNotificationRequest = `null`
	)

Updates the notification structure for an existing template.

Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateNotificationRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateRecipients()

RecipientsUpdateSummary DocuSign.eSign.Api.ITemplatesApi.UpdateRecipients	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.UpdateRecipientsOptions	options = `null`
	)

Updates recipients in a template.

Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns

◆ UpdateRecipientsAsync()

System.Threading.Tasks.Task<RecipientsUpdateSummary> DocuSign.eSign.Api.ITemplatesApi.UpdateRecipientsAsync	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.UpdateRecipientsOptions	options = `null`
	)

Updates recipients in a template.

Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of RecipientsUpdateSummary

◆ UpdateRecipientsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<RecipientsUpdateSummary> > DocuSign.eSign.Api.ITemplatesApi.UpdateRecipientsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.UpdateRecipientsOptions	options = `null`
	)

Updates recipients in a template.

Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (RecipientsUpdateSummary)

◆ UpdateRecipientsWithHttpInfo()

ApiResponse<RecipientsUpdateSummary> DocuSign.eSign.Api.ITemplatesApi.UpdateRecipientsWithHttpInfo	(	string	accountId,
		string	templateId,
		TemplateRecipients	templateRecipients = `null`,
		TemplatesApi.UpdateRecipientsOptions	options = `null`
	)

Updates recipients in a template.

Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
templateRecipients	(optional)
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ UpdateTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.UpdateTabs	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.UpdateTabsAsync	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.UpdateTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.UpdateTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	recipientId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a recipient.

Updates one or more tabs for a recipient in a template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
recipientId	The ID of the recipient being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTemplateDocumentTabs()

Tabs DocuSign.eSign.Api.ITemplatesApi.UpdateTemplateDocumentTabs	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a template

Updates tabs in the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTemplateDocumentTabsAsync()

System.Threading.Tasks.Task<Tabs> DocuSign.eSign.Api.ITemplatesApi.UpdateTemplateDocumentTabsAsync	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a template

Updates tabs in the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of Tabs

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTemplateDocumentTabsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Tabs> > DocuSign.eSign.Api.ITemplatesApi.UpdateTemplateDocumentTabsAsyncWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a template

Updates tabs in the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: Task of ApiResponse (Tabs)

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateTemplateDocumentTabsWithHttpInfo()

ApiResponse<Tabs> DocuSign.eSign.Api.ITemplatesApi.UpdateTemplateDocumentTabsWithHttpInfo	(	string	accountId,
		string	templateId,
		string	documentId,
		TemplateTabs	templateTabs = `null`
	)

Updates the tabs for a template

Updates tabs in the document specified by `documentId` in the template specified by `templateId`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
documentId	The ID of the document being accessed.
templateTabs	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

◆ UpdateWithHttpInfo()

ApiResponse<TemplateUpdateSummary> DocuSign.eSign.Api.ITemplatesApi.UpdateWithHttpInfo	(	string	accountId,
		string	templateId,
		EnvelopeTemplate	envelopeTemplate = `null`
	)

Updates an existing template.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
templateId	The ID of the template being accessed.
envelopeTemplate	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.TemplatesApi.

The documentation for this interface was generated from the following file:

sdk/src/DocuSign.eSign/Api/TemplatesApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCustomFields()

◆ CreateCustomFieldsAsync()

◆ CreateCustomFieldsAsyncWithHttpInfo()

◆ CreateCustomFieldsWithHttpInfo()

◆ CreateDocumentFields()

◆ CreateDocumentFieldsAsync()

◆ CreateDocumentFieldsAsyncWithHttpInfo()

◆ CreateDocumentFieldsWithHttpInfo()

◆ CreateEditView()

◆ CreateEditViewAsync()

◆ CreateEditViewAsyncWithHttpInfo()

◆ CreateEditViewWithHttpInfo()

◆ CreateLock()

◆ CreateLockAsync()

◆ CreateLockAsyncWithHttpInfo()

◆ CreateLockWithHttpInfo()

◆ CreateRecipients()

◆ CreateRecipientsAsync()

◆ CreateRecipientsAsyncWithHttpInfo()

◆ CreateRecipientsWithHttpInfo()

◆ CreateTabs()

◆ CreateTabsAsync()

◆ CreateTabsAsyncWithHttpInfo()

◆ CreateTabsWithHttpInfo()

◆ CreateTemplate()

◆ CreateTemplateAsync()

◆ CreateTemplateAsyncWithHttpInfo()

◆ CreateTemplateDocumentResponsiveHtmlPreview()

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsync()

◆ CreateTemplateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo()

◆ CreateTemplateDocumentResponsiveHtmlPreviewWithHttpInfo()

◆ CreateTemplateDocumentTabs()

◆ CreateTemplateDocumentTabsAsync()

◆ CreateTemplateDocumentTabsAsyncWithHttpInfo()

◆ CreateTemplateDocumentTabsWithHttpInfo()

◆ CreateTemplateRecipientPreview()

◆ CreateTemplateRecipientPreviewAsync()

◆ CreateTemplateRecipientPreviewAsyncWithHttpInfo()

◆ CreateTemplateRecipientPreviewWithHttpInfo()

◆ CreateTemplateResponsiveHtmlPreview()

◆ CreateTemplateResponsiveHtmlPreviewAsync()

◆ CreateTemplateResponsiveHtmlPreviewAsyncWithHttpInfo()

◆ CreateTemplateResponsiveHtmlPreviewWithHttpInfo()

◆ CreateTemplateWithHttpInfo()

◆ DeleteCustomFields()

◆ DeleteCustomFieldsAsync()

◆ DeleteCustomFieldsAsyncWithHttpInfo()

◆ DeleteCustomFieldsWithHttpInfo()

◆ DeleteDocumentFields()

◆ DeleteDocumentFieldsAsync()

◆ DeleteDocumentFieldsAsyncWithHttpInfo()

◆ DeleteDocumentFieldsWithHttpInfo()

◆ DeleteDocumentPage()

◆ DeleteDocumentPageAsync()

◆ DeleteDocumentPageAsyncWithHttpInfo()

◆ DeleteDocumentPageWithHttpInfo()

◆ DeleteDocuments()

◆ DeleteDocumentsAsync()

◆ DeleteDocumentsAsyncWithHttpInfo()

◆ DeleteDocumentsWithHttpInfo()

◆ DeleteGroupShare()

◆ DeleteGroupShareAsync()

◆ DeleteGroupShareAsyncWithHttpInfo()

◆ DeleteGroupShareWithHttpInfo()

◆ DeleteLock()

◆ DeleteLockAsync()

◆ DeleteLockAsyncWithHttpInfo()

◆ DeleteLockWithHttpInfo()

◆ DeleteRecipient()

◆ DeleteRecipientAsync()

◆ DeleteRecipientAsyncWithHttpInfo()

◆ DeleteRecipients()

◆ DeleteRecipientsAsync()

◆ DeleteRecipientsAsyncWithHttpInfo()

◆ DeleteRecipientsWithHttpInfo()

◆ DeleteRecipientWithHttpInfo()