TemplatesApi
in package
TemplatesApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createCustomFields() : CustomFields
- Operation createCustomFields
- createCustomFieldsWithHttpInfo() : array<string|int, mixed>
- Operation createCustomFieldsWithHttpInfo
- createDocumentFields() : DocumentFieldsInformation
- Operation createDocumentFields
- createDocumentFieldsWithHttpInfo() : array<string|int, mixed>
- Operation createDocumentFieldsWithHttpInfo
- createEditView() : ViewUrl
- Operation createEditView
- createEditViewWithHttpInfo() : array<string|int, mixed>
- Operation createEditViewWithHttpInfo
- createLock() : LockInformation
- Operation createLock
- createLockWithHttpInfo() : array<string|int, mixed>
- Operation createLockWithHttpInfo
- createRecipients() : Recipients
- Operation createRecipients
- createRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation createRecipientsWithHttpInfo
- createTabs() : Tabs
- Operation createTabs
- createTabsWithHttpInfo() : array<string|int, mixed>
- Operation createTabsWithHttpInfo
- createTemplate() : TemplateSummary
- Operation createTemplate
- createTemplateDocumentResponsiveHtmlPreview() : DocumentHtmlDefinitions
- Operation createTemplateDocumentResponsiveHtmlPreview
- createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo
- createTemplateDocumentTabs() : Tabs
- Operation createTemplateDocumentTabs
- createTemplateDocumentTabsWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateDocumentTabsWithHttpInfo
- createTemplateRecipientPreview() : ViewUrl
- Operation createTemplateRecipientPreview
- createTemplateRecipientPreviewWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateRecipientPreviewWithHttpInfo
- createTemplateResponsiveHtmlPreview() : DocumentHtmlDefinitions
- Operation createTemplateResponsiveHtmlPreview
- createTemplateResponsiveHtmlPreviewWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateResponsiveHtmlPreviewWithHttpInfo
- createTemplateWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateWithHttpInfo
- deleteCustomFields() : CustomFields
- Operation deleteCustomFields
- deleteCustomFieldsWithHttpInfo() : array<string|int, mixed>
- Operation deleteCustomFieldsWithHttpInfo
- deleteDocumentFields() : DocumentFieldsInformation
- Operation deleteDocumentFields
- deleteDocumentFieldsWithHttpInfo() : array<string|int, mixed>
- Operation deleteDocumentFieldsWithHttpInfo
- deleteDocumentPage() : mixed
- Operation deleteDocumentPage
- deleteDocumentPageWithHttpInfo() : array<string|int, mixed>
- Operation deleteDocumentPageWithHttpInfo
- deleteDocuments() : TemplateDocumentsResult
- Operation deleteDocuments
- deleteDocumentsWithHttpInfo() : array<string|int, mixed>
- Operation deleteDocumentsWithHttpInfo
- deleteGroupShare() : GroupInformation
- Operation deleteGroupShare
- deleteGroupShareWithHttpInfo() : array<string|int, mixed>
- Operation deleteGroupShareWithHttpInfo
- deleteLock() : LockInformation
- Operation deleteLock
- deleteLockWithHttpInfo() : array<string|int, mixed>
- Operation deleteLockWithHttpInfo
- deleteRecipient() : Recipients
- Operation deleteRecipient
- deleteRecipients() : Recipients
- Operation deleteRecipients
- deleteRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation deleteRecipientsWithHttpInfo
- deleteRecipientWithHttpInfo() : array<string|int, mixed>
- Operation deleteRecipientWithHttpInfo
- deleteTabs() : Tabs
- Operation deleteTabs
- deleteTabsWithHttpInfo() : array<string|int, mixed>
- Operation deleteTabsWithHttpInfo
- deleteTemplateDocumentTabs() : Tabs
- Operation deleteTemplateDocumentTabs
- deleteTemplateDocumentTabsWithHttpInfo() : array<string|int, mixed>
- Operation deleteTemplateDocumentTabsWithHttpInfo
- get() : EnvelopeTemplate
- Operation get
- getApiClient() : ApiClient
- Get API client
- getDocument() : SplFileObject
- Operation getDocument
- getDocumentPageImage() : SplFileObject
- Operation getDocumentPageImage
- getDocumentPageImageWithHttpInfo() : array<string|int, mixed>
- Operation getDocumentPageImageWithHttpInfo
- getDocumentTabs() : Tabs
- Operation getDocumentTabs
- getDocumentTabsWithHttpInfo() : array<string|int, mixed>
- Operation getDocumentTabsWithHttpInfo
- getDocumentWithHttpInfo() : array<string|int, mixed>
- Operation getDocumentWithHttpInfo
- getLock() : LockInformation
- Operation getLock
- getLockWithHttpInfo() : array<string|int, mixed>
- Operation getLockWithHttpInfo
- getNotificationSettings() : Notification
- Operation getNotificationSettings
- getNotificationSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getNotificationSettingsWithHttpInfo
- getPages() : PageImages
- Operation getPages
- getPagesWithHttpInfo() : array<string|int, mixed>
- Operation getPagesWithHttpInfo
- getPageTabs() : Tabs
- Operation getPageTabs
- getPageTabsWithHttpInfo() : array<string|int, mixed>
- Operation getPageTabsWithHttpInfo
- getTemplateDocumentHtmlDefinitions() : DocumentHtmlDefinitionOriginals
- Operation getTemplateDocumentHtmlDefinitions
- getTemplateDocumentHtmlDefinitionsWithHttpInfo() : array<string|int, mixed>
- Operation getTemplateDocumentHtmlDefinitionsWithHttpInfo
- getTemplateHtmlDefinitions() : DocumentHtmlDefinitionOriginals
- Operation getTemplateHtmlDefinitions
- getTemplateHtmlDefinitionsWithHttpInfo() : array<string|int, mixed>
- Operation getTemplateHtmlDefinitionsWithHttpInfo
- getWithHttpInfo() : array<string|int, mixed>
- Operation getWithHttpInfo
- listCustomFields() : CustomFields
- Operation listCustomFields
- listCustomFieldsWithHttpInfo() : array<string|int, mixed>
- Operation listCustomFieldsWithHttpInfo
- listDocumentFields() : DocumentFieldsInformation
- Operation listDocumentFields
- listDocumentFieldsWithHttpInfo() : array<string|int, mixed>
- Operation listDocumentFieldsWithHttpInfo
- listDocuments() : TemplateDocumentsResult
- Operation listDocuments
- listDocumentsWithHttpInfo() : array<string|int, mixed>
- Operation listDocumentsWithHttpInfo
- listRecipients() : Recipients
- Operation listRecipients
- listRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation listRecipientsWithHttpInfo
- listTabs() : Tabs
- Operation listTabs
- listTabsWithHttpInfo() : array<string|int, mixed>
- Operation listTabsWithHttpInfo
- listTemplates() : EnvelopeTemplateResults
- Operation listTemplates
- listTemplatesWithHttpInfo() : array<string|int, mixed>
- Operation listTemplatesWithHttpInfo
- rotateDocumentPage() : mixed
- Operation rotateDocumentPage
- rotateDocumentPageWithHttpInfo() : array<string|int, mixed>
- Operation rotateDocumentPageWithHttpInfo
- setApiClient() : self
- Set the API client
- update() : TemplateUpdateSummary
- Operation update
- updateCustomFields() : CustomFields
- Operation updateCustomFields
- updateCustomFieldsWithHttpInfo() : array<string|int, mixed>
- Operation updateCustomFieldsWithHttpInfo
- updateDocument() : EnvelopeDocument
- Operation updateDocument
- updateDocumentFields() : DocumentFieldsInformation
- Operation updateDocumentFields
- updateDocumentFieldsWithHttpInfo() : array<string|int, mixed>
- Operation updateDocumentFieldsWithHttpInfo
- updateDocuments() : TemplateDocumentsResult
- Operation updateDocuments
- updateDocumentsWithHttpInfo() : array<string|int, mixed>
- Operation updateDocumentsWithHttpInfo
- updateDocumentWithHttpInfo() : array<string|int, mixed>
- Operation updateDocumentWithHttpInfo
- updateGroupShare() : GroupInformation
- Operation updateGroupShare
- updateGroupShareWithHttpInfo() : array<string|int, mixed>
- Operation updateGroupShareWithHttpInfo
- updateLock() : LockInformation
- Operation updateLock
- updateLockWithHttpInfo() : array<string|int, mixed>
- Operation updateLockWithHttpInfo
- updateNotificationSettings() : Notification
- Operation updateNotificationSettings
- updateNotificationSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateNotificationSettingsWithHttpInfo
- updateRecipients() : RecipientsUpdateSummary
- Operation updateRecipients
- updateRecipientsWithHttpInfo() : array<string|int, mixed>
- Operation updateRecipientsWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateTabs() : Tabs
- Operation updateTabs
- updateTabsWithHttpInfo() : array<string|int, mixed>
- Operation updateTabsWithHttpInfo
- updateTemplateDocumentTabs() : Tabs
- Operation updateTemplateDocumentTabs
- updateTemplateDocumentTabsWithHttpInfo() : array<string|int, mixed>
- Operation updateTemplateDocumentTabsWithHttpInfo
- updateWithHttpInfo() : array<string|int, mixed>
- Operation updateWithHttpInfo
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —createCustomFields()
Operation createCustomFields
public
createCustomFields(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : CustomFields
Creates custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
CustomFields —createCustomFieldsWithHttpInfo()
Operation createCustomFieldsWithHttpInfo
public
createCustomFieldsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : array<string|int, mixed>
Creates custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
createDocumentFields()
Operation createDocumentFields
public
createDocumentFields(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation
Creates custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
DocumentFieldsInformation —createDocumentFieldsWithHttpInfo()
Operation createDocumentFieldsWithHttpInfo
public
createDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>
Creates custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentFieldsInformation, HTTP status code, HTTP response headers (array of strings)
createEditView()
Operation createEditView
public
createEditView(string|null $account_id, string|null $template_id[, ReturnUrlRequest $return_url_request = null ]) : ViewUrl
Provides a URL to start an edit view of the Template UI
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $return_url_request : ReturnUrlRequest = null
-
(optional)
Tags
Return values
ViewUrl —createEditViewWithHttpInfo()
Operation createEditViewWithHttpInfo
public
createEditViewWithHttpInfo(string|null $account_id, string|null $template_id[, ReturnUrlRequest $return_url_request = null ]) : array<string|int, mixed>
Provides a URL to start an edit view of the Template UI
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $return_url_request : ReturnUrlRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)
createLock()
Operation createLock
public
createLock(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : LockInformation
Lock a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
LockInformation —createLockWithHttpInfo()
Operation createLockWithHttpInfo
public
createLockWithHttpInfo(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : array<string|int, mixed>
Lock a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings)
createRecipients()
Operation createRecipients
public
createRecipients(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ][, CreateRecipientsOptions $options = null ]) : Recipients
Adds tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
- $options : CreateRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Recipients —createRecipientsWithHttpInfo()
Operation createRecipientsWithHttpInfo
public
createRecipientsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ][, CreateRecipientsOptions $options = null ]) : array<string|int, mixed>
Adds tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
- $options : CreateRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)
createTabs()
Operation createTabs
public
createTabs(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Adds tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —createTabsWithHttpInfo()
Operation createTabsWithHttpInfo
public
createTabsWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Adds tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
createTemplate()
Operation createTemplate
public
createTemplate(string|null $account_id[, EnvelopeTemplate $envelope_template = null ]) : TemplateSummary
Creates an envelope from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $envelope_template : EnvelopeTemplate = null
-
(optional)
Tags
Return values
TemplateSummary —createTemplateDocumentResponsiveHtmlPreview()
Operation createTemplateDocumentResponsiveHtmlPreview
public
createTemplateDocumentResponsiveHtmlPreview(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentHtmlDefinition $document_html_definition = null ]) : DocumentHtmlDefinitions
Post Responsive HTML Preview for a document in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_html_definition : DocumentHtmlDefinition = null
-
(optional)
Tags
Return values
DocumentHtmlDefinitions —createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo()
Operation createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo
public
createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentHtmlDefinition $document_html_definition = null ]) : array<string|int, mixed>
Post Responsive HTML Preview for a document in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_html_definition : DocumentHtmlDefinition = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings)
createTemplateDocumentTabs()
Operation createTemplateDocumentTabs
public
createTemplateDocumentTabs(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Adds the tabs to a tempate
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —createTemplateDocumentTabsWithHttpInfo()
Operation createTemplateDocumentTabsWithHttpInfo
public
createTemplateDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Adds the tabs to a tempate
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
createTemplateRecipientPreview()
Operation createTemplateRecipientPreview
public
createTemplateRecipientPreview(string|null $account_id, string|null $template_id[, RecipientPreviewRequest $recipient_preview_request = null ]) : ViewUrl
Provides a URL to start a recipient view of the Envelope UI
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $recipient_preview_request : RecipientPreviewRequest = null
-
(optional)
Tags
Return values
ViewUrl —createTemplateRecipientPreviewWithHttpInfo()
Operation createTemplateRecipientPreviewWithHttpInfo
public
createTemplateRecipientPreviewWithHttpInfo(string|null $account_id, string|null $template_id[, RecipientPreviewRequest $recipient_preview_request = null ]) : array<string|int, mixed>
Provides a URL to start a recipient view of the Envelope UI
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $recipient_preview_request : RecipientPreviewRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)
createTemplateResponsiveHtmlPreview()
Operation createTemplateResponsiveHtmlPreview
public
createTemplateResponsiveHtmlPreview(string|null $account_id, string|null $template_id[, DocumentHtmlDefinition $document_html_definition = null ]) : DocumentHtmlDefinitions
Get Responsive HTML Preview for all documents in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_html_definition : DocumentHtmlDefinition = null
-
(optional)
Tags
Return values
DocumentHtmlDefinitions —createTemplateResponsiveHtmlPreviewWithHttpInfo()
Operation createTemplateResponsiveHtmlPreviewWithHttpInfo
public
createTemplateResponsiveHtmlPreviewWithHttpInfo(string|null $account_id, string|null $template_id[, DocumentHtmlDefinition $document_html_definition = null ]) : array<string|int, mixed>
Get Responsive HTML Preview for all documents in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_html_definition : DocumentHtmlDefinition = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings)
createTemplateWithHttpInfo()
Operation createTemplateWithHttpInfo
public
createTemplateWithHttpInfo(string|null $account_id[, EnvelopeTemplate $envelope_template = null ]) : array<string|int, mixed>
Creates an envelope from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $envelope_template : EnvelopeTemplate = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TemplateSummary, HTTP status code, HTTP response headers (array of strings)
deleteCustomFields()
Operation deleteCustomFields
public
deleteCustomFields(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : CustomFields
Deletes envelope custom fields in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
CustomFields —deleteCustomFieldsWithHttpInfo()
Operation deleteCustomFieldsWithHttpInfo
public
deleteCustomFieldsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : array<string|int, mixed>
Deletes envelope custom fields in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
deleteDocumentFields()
Operation deleteDocumentFields
public
deleteDocumentFields(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation
Deletes custom document fields from an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
DocumentFieldsInformation —deleteDocumentFieldsWithHttpInfo()
Operation deleteDocumentFieldsWithHttpInfo
public
deleteDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>
Deletes custom document fields from an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentFieldsInformation, HTTP status code, HTTP response headers (array of strings)
deleteDocumentPage()
Operation deleteDocumentPage
public
deleteDocumentPage(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, PageRequest $page_request = null ]) : mixed
Deletes a page from a document in an template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $page_request : PageRequest = null
-
(optional)
Tags
Return values
mixed —deleteDocumentPageWithHttpInfo()
Operation deleteDocumentPageWithHttpInfo
public
deleteDocumentPageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, PageRequest $page_request = null ]) : array<string|int, mixed>
Deletes a page from a document in an template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $page_request : PageRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteDocuments()
Operation deleteDocuments
public
deleteDocuments(string|null $account_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ]) : TemplateDocumentsResult
Deletes documents from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
Tags
Return values
TemplateDocumentsResult —deleteDocumentsWithHttpInfo()
Operation deleteDocumentsWithHttpInfo
public
deleteDocumentsWithHttpInfo(string|null $account_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ]) : array<string|int, mixed>
Deletes documents from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TemplateDocumentsResult, HTTP status code, HTTP response headers (array of strings)
deleteGroupShare()
Operation deleteGroupShare
public
deleteGroupShare(string|null $account_id, string|null $template_id, string|null $template_part[, GroupInformation $group_information = null ]) : GroupInformation
Removes a member group's sharing permissions for a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_part : string|null
-
Currently, the only defined part is groups.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
GroupInformation —deleteGroupShareWithHttpInfo()
Operation deleteGroupShareWithHttpInfo
public
deleteGroupShareWithHttpInfo(string|null $account_id, string|null $template_id, string|null $template_part[, GroupInformation $group_information = null ]) : array<string|int, mixed>
Removes a member group's sharing permissions for a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_part : string|null
-
Currently, the only defined part is groups.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
deleteLock()
Operation deleteLock
public
deleteLock(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : LockInformation
Deletes a template lock.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
LockInformation —deleteLockWithHttpInfo()
Operation deleteLockWithHttpInfo
public
deleteLockWithHttpInfo(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : array<string|int, mixed>
Deletes a template lock.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings)
deleteRecipient()
Operation deleteRecipient
public
deleteRecipient(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateRecipients $template_recipients = null ]) : Recipients
Deletes the specified recipient file from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
Tags
Return values
Recipients —deleteRecipients()
Operation deleteRecipients
public
deleteRecipients(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ]) : Recipients
Deletes recipients from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
Tags
Return values
Recipients —deleteRecipientsWithHttpInfo()
Operation deleteRecipientsWithHttpInfo
public
deleteRecipientsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ]) : array<string|int, mixed>
Deletes recipients from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)
deleteRecipientWithHttpInfo()
Operation deleteRecipientWithHttpInfo
public
deleteRecipientWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateRecipients $template_recipients = null ]) : array<string|int, mixed>
Deletes the specified recipient file from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)
deleteTabs()
Operation deleteTabs
public
deleteTabs(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Deletes the tabs associated with a recipient in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —deleteTabsWithHttpInfo()
Operation deleteTabsWithHttpInfo
public
deleteTabsWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Deletes the tabs associated with a recipient in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
deleteTemplateDocumentTabs()
Operation deleteTemplateDocumentTabs
public
deleteTemplateDocumentTabs(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Deletes tabs from an envelope document
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —deleteTemplateDocumentTabsWithHttpInfo()
Operation deleteTemplateDocumentTabsWithHttpInfo
public
deleteTemplateDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Deletes tabs from an envelope document
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
get()
Operation get
public
get(string|null $account_id, string|null $template_id[, GetOptions $options = null ]) : EnvelopeTemplate
Gets a list of templates for a specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
EnvelopeTemplate —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getDocument()
Operation getDocument
public
getDocument(string|null $account_id, string|null $document_id, string|null $template_id[, GetDocumentOptions $options = null ]) : SplFileObject
Gets PDF documents from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getDocumentPageImage()
Operation getDocumentPageImage
public
getDocumentPageImage(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, GetDocumentPageImageOptions $options = null ]) : SplFileObject
Gets a page image from a template for display.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentPageImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getDocumentPageImageWithHttpInfo()
Operation getDocumentPageImageWithHttpInfo
public
getDocumentPageImageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, GetDocumentPageImageOptions $options = null ]) : array<string|int, mixed>
Gets a page image from a template for display.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentPageImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getDocumentTabs()
Operation getDocumentTabs
public
getDocumentTabs(string|null $account_id, string|null $document_id, string|null $template_id[, GetDocumentTabsOptions $options = null ]) : Tabs
Returns tabs on the document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentTabsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Tabs —getDocumentTabsWithHttpInfo()
Operation getDocumentTabsWithHttpInfo
public
getDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, GetDocumentTabsOptions $options = null ]) : array<string|int, mixed>
Returns tabs on the document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentTabsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
getDocumentWithHttpInfo()
Operation getDocumentWithHttpInfo
public
getDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, GetDocumentOptions $options = null ]) : array<string|int, mixed>
Gets PDF documents from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetDocumentOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getLock()
Operation getLock
public
getLock(string|null $account_id, string|null $template_id) : LockInformation
Gets template lock information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
LockInformation —getLockWithHttpInfo()
Operation getLockWithHttpInfo
public
getLockWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>
Gets template lock information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings)
getNotificationSettings()
Operation getNotificationSettings
public
getNotificationSettings(string|null $account_id, string|null $template_id) : Notification
Gets template notification information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
Notification —getNotificationSettingsWithHttpInfo()
Operation getNotificationSettingsWithHttpInfo
public
getNotificationSettingsWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>
Gets template notification information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings)
getPages()
Operation getPages
public
getPages(string|null $account_id, string|null $document_id, string|null $template_id[, GetPagesOptions $options = null ]) : PageImages
Returns document page image(s) based on input.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetPagesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PageImages —getPagesWithHttpInfo()
Operation getPagesWithHttpInfo
public
getPagesWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, GetPagesOptions $options = null ]) : array<string|int, mixed>
Returns document page image(s) based on input.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetPagesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PageImages, HTTP status code, HTTP response headers (array of strings)
getPageTabs()
Operation getPageTabs
public
getPageTabs(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id) : Tabs
Returns tabs on the specified page.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
Tabs —getPageTabsWithHttpInfo()
Operation getPageTabsWithHttpInfo
public
getPageTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id) : array<string|int, mixed>
Returns tabs on the specified page.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
getTemplateDocumentHtmlDefinitions()
Operation getTemplateDocumentHtmlDefinitions
public
getTemplateDocumentHtmlDefinitions(string|null $account_id, string|null $document_id, string|null $template_id) : DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
DocumentHtmlDefinitionOriginals —getTemplateDocumentHtmlDefinitionsWithHttpInfo()
Operation getTemplateDocumentHtmlDefinitionsWithHttpInfo
public
getTemplateDocumentHtmlDefinitionsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id) : array<string|int, mixed>
Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings)
getTemplateHtmlDefinitions()
Operation getTemplateHtmlDefinitions
public
getTemplateHtmlDefinitions(string|null $account_id, string|null $template_id) : DocumentHtmlDefinitionOriginals
Get the Original HTML Definition used to generate the Responsive HTML for the template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
DocumentHtmlDefinitionOriginals —getTemplateHtmlDefinitionsWithHttpInfo()
Operation getTemplateHtmlDefinitionsWithHttpInfo
public
getTemplateHtmlDefinitionsWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>
Get the Original HTML Definition used to generate the Responsive HTML for the template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings)
getWithHttpInfo()
Operation getWithHttpInfo
public
getWithHttpInfo(string|null $account_id, string|null $template_id[, GetOptions $options = null ]) : array<string|int, mixed>
Gets a list of templates for a specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : GetOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopeTemplate, HTTP status code, HTTP response headers (array of strings)
listCustomFields()
Operation listCustomFields
public
listCustomFields(string|null $account_id, string|null $template_id) : CustomFields
Gets the custom document fields from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
CustomFields —listCustomFieldsWithHttpInfo()
Operation listCustomFieldsWithHttpInfo
public
listCustomFieldsWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>
Gets the custom document fields from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
listDocumentFields()
Operation listDocumentFields
public
listDocumentFields(string|null $account_id, string|null $document_id, string|null $template_id) : DocumentFieldsInformation
Gets the custom document fields for a an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
DocumentFieldsInformation —listDocumentFieldsWithHttpInfo()
Operation listDocumentFieldsWithHttpInfo
public
listDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id) : array<string|int, mixed>
Gets the custom document fields for a an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentFieldsInformation, HTTP status code, HTTP response headers (array of strings)
listDocuments()
Operation listDocuments
public
listDocuments(string|null $account_id, string|null $template_id[, ListDocumentsOptions $options = null ]) : TemplateDocumentsResult
Gets a list of documents associated with a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListDocumentsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
TemplateDocumentsResult —listDocumentsWithHttpInfo()
Operation listDocumentsWithHttpInfo
public
listDocumentsWithHttpInfo(string|null $account_id, string|null $template_id[, ListDocumentsOptions $options = null ]) : array<string|int, mixed>
Gets a list of documents associated with a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListDocumentsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TemplateDocumentsResult, HTTP status code, HTTP response headers (array of strings)
listRecipients()
Operation listRecipients
public
listRecipients(string|null $account_id, string|null $template_id[, ListRecipientsOptions $options = null ]) : Recipients
Gets recipient information from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Recipients —listRecipientsWithHttpInfo()
Operation listRecipientsWithHttpInfo
public
listRecipientsWithHttpInfo(string|null $account_id, string|null $template_id[, ListRecipientsOptions $options = null ]) : array<string|int, mixed>
Gets recipient information from a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)
listTabs()
Operation listTabs
public
listTabs(string|null $account_id, string|null $recipient_id, string|null $template_id[, ListTabsOptions $options = null ]) : Tabs
Gets the tabs information for a signer or sign-in-person recipient in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListTabsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
Tabs —listTabsWithHttpInfo()
Operation listTabsWithHttpInfo
public
listTabsWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, ListTabsOptions $options = null ]) : array<string|int, mixed>
Gets the tabs information for a signer or sign-in-person recipient in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $options : ListTabsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
listTemplates()
Operation listTemplates
public
listTemplates(string|null $account_id[, ListTemplatesOptions $options = null ]) : EnvelopeTemplateResults
Gets the definition of a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListTemplatesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
EnvelopeTemplateResults —listTemplatesWithHttpInfo()
Operation listTemplatesWithHttpInfo
public
listTemplatesWithHttpInfo(string|null $account_id[, ListTemplatesOptions $options = null ]) : array<string|int, mixed>
Gets the definition of a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListTemplatesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopeTemplateResults, HTTP status code, HTTP response headers (array of strings)
rotateDocumentPage()
Operation rotateDocumentPage
public
rotateDocumentPage(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, PageRequest $page_request = null ]) : mixed
Rotates page image from a template for display.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $page_request : PageRequest = null
-
(optional)
Tags
Return values
mixed —rotateDocumentPageWithHttpInfo()
Operation rotateDocumentPageWithHttpInfo
public
rotateDocumentPageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $page_number, string|null $template_id[, PageRequest $page_request = null ]) : array<string|int, mixed>
Rotates page image from a template for display.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $page_number : string|null
-
The page number being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $page_request : PageRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —update()
Operation update
public
update(string|null $account_id, string|null $template_id[, EnvelopeTemplate $envelope_template = null ]) : TemplateUpdateSummary
Updates an existing template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_template : EnvelopeTemplate = null
-
(optional)
Tags
Return values
TemplateUpdateSummary —updateCustomFields()
Operation updateCustomFields
public
updateCustomFields(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : CustomFields
Updates envelope custom fields in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
CustomFields —updateCustomFieldsWithHttpInfo()
Operation updateCustomFieldsWithHttpInfo
public
updateCustomFieldsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateCustomFields $template_custom_fields = null ]) : array<string|int, mixed>
Updates envelope custom fields in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_custom_fields : TemplateCustomFields = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings)
updateDocument()
Operation updateDocument
public
updateDocument(string|null $account_id, string|null $document_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ][, UpdateDocumentOptions $options = null ]) : EnvelopeDocument
Adds a document to a template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
- $options : UpdateDocumentOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
EnvelopeDocument —updateDocumentFields()
Operation updateDocumentFields
public
updateDocumentFields(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation
Updates existing custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
DocumentFieldsInformation —updateDocumentFieldsWithHttpInfo()
Operation updateDocumentFieldsWithHttpInfo
public
updateDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>
Updates existing custom document fields in an existing template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $document_fields_information : DocumentFieldsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DocumentFieldsInformation, HTTP status code, HTTP response headers (array of strings)
updateDocuments()
Operation updateDocuments
public
updateDocuments(string|null $account_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ]) : TemplateDocumentsResult
Adds documents to a template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
Tags
Return values
TemplateDocumentsResult —updateDocumentsWithHttpInfo()
Operation updateDocumentsWithHttpInfo
public
updateDocumentsWithHttpInfo(string|null $account_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ]) : array<string|int, mixed>
Adds documents to a template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TemplateDocumentsResult, HTTP status code, HTTP response headers (array of strings)
updateDocumentWithHttpInfo()
Operation updateDocumentWithHttpInfo
public
updateDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, EnvelopeDefinition $envelope_definition = null ][, UpdateDocumentOptions $options = null ]) : array<string|int, mixed>
Adds a document to a template document.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_definition : EnvelopeDefinition = null
-
(optional)
- $options : UpdateDocumentOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopeDocument, HTTP status code, HTTP response headers (array of strings)
updateGroupShare()
Operation updateGroupShare
public
updateGroupShare(string|null $account_id, string|null $template_id, string|null $template_part[, GroupInformation $group_information = null ]) : GroupInformation
Shares a template with a group
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_part : string|null
-
Currently, the only defined part is groups.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
GroupInformation —updateGroupShareWithHttpInfo()
Operation updateGroupShareWithHttpInfo
public
updateGroupShareWithHttpInfo(string|null $account_id, string|null $template_id, string|null $template_part[, GroupInformation $group_information = null ]) : array<string|int, mixed>
Shares a template with a group
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_part : string|null
-
Currently, the only defined part is groups.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
updateLock()
Operation updateLock
public
updateLock(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : LockInformation
Updates a template lock.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
LockInformation —updateLockWithHttpInfo()
Operation updateLockWithHttpInfo
public
updateLockWithHttpInfo(string|null $account_id, string|null $template_id[, LockRequest $lock_request = null ]) : array<string|int, mixed>
Updates a template lock.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $lock_request : LockRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings)
updateNotificationSettings()
Operation updateNotificationSettings
public
updateNotificationSettings(string|null $account_id, string|null $template_id[, TemplateNotificationRequest $template_notification_request = null ]) : Notification
Updates the notification structure for an existing template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_notification_request : TemplateNotificationRequest = null
-
(optional)
Tags
Return values
Notification —updateNotificationSettingsWithHttpInfo()
Operation updateNotificationSettingsWithHttpInfo
public
updateNotificationSettingsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateNotificationRequest $template_notification_request = null ]) : array<string|int, mixed>
Updates the notification structure for an existing template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_notification_request : TemplateNotificationRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings)
updateRecipients()
Operation updateRecipients
public
updateRecipients(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ][, UpdateRecipientsOptions $options = null ]) : RecipientsUpdateSummary
Updates recipients in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
- $options : UpdateRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
RecipientsUpdateSummary —updateRecipientsWithHttpInfo()
Operation updateRecipientsWithHttpInfo
public
updateRecipientsWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateRecipients $template_recipients = null ][, UpdateRecipientsOptions $options = null ]) : array<string|int, mixed>
Updates recipients in a template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_recipients : TemplateRecipients = null
-
(optional)
- $options : UpdateRecipientsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\RecipientsUpdateSummary, HTTP status code, HTTP response headers (array of strings)
updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name
Return values
string —updateTabs()
Operation updateTabs
public
updateTabs(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Updates the tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —updateTabsWithHttpInfo()
Operation updateTabsWithHttpInfo
public
updateTabsWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Updates the tabs for a recipient.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $recipient_id : string|null
-
The ID of the recipient being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
updateTemplateDocumentTabs()
Operation updateTemplateDocumentTabs
public
updateTemplateDocumentTabs(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : Tabs
Updates the tabs for a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
Tabs —updateTemplateDocumentTabsWithHttpInfo()
Operation updateTemplateDocumentTabsWithHttpInfo
public
updateTemplateDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $template_id[, TemplateTabs $template_tabs = null ]) : array<string|int, mixed>
Updates the tabs for a template
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $document_id : string|null
-
The ID of the document being accessed.
- $template_id : string|null
-
The ID of the template being accessed.
- $template_tabs : TemplateTabs = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)
updateWithHttpInfo()
Operation updateWithHttpInfo
public
updateWithHttpInfo(string|null $account_id, string|null $template_id[, EnvelopeTemplate $envelope_template = null ]) : array<string|int, mixed>
Updates an existing template.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $template_id : string|null
-
The ID of the template being accessed.
- $envelope_template : EnvelopeTemplate = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TemplateUpdateSummary, HTTP status code, HTTP response headers (array of strings)