Documentation

EnvelopesApi
in package

EnvelopesApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$apiClient  : ApiClient
API Client
__construct()  : void
Constructor
applyTemplate()  : DocumentTemplateList
Operation applyTemplate
applyTemplateToDocument()  : DocumentTemplateList
Operation applyTemplateToDocument
applyTemplateToDocumentWithHttpInfo()  : array<string|int, mixed>
Operation applyTemplateToDocumentWithHttpInfo
applyTemplateWithHttpInfo()  : array<string|int, mixed>
Operation applyTemplateWithHttpInfo
createChunkedUpload()  : ChunkedUploadResponse
Operation createChunkedUpload
createChunkedUploadWithHttpInfo()  : array<string|int, mixed>
Operation createChunkedUploadWithHttpInfo
createConsoleView()  : ViewUrl
Operation createConsoleView
createConsoleViewWithHttpInfo()  : array<string|int, mixed>
Operation createConsoleViewWithHttpInfo
createCorrectView()  : ViewUrl
Operation createCorrectView
createCorrectViewWithHttpInfo()  : array<string|int, mixed>
Operation createCorrectViewWithHttpInfo
createCustomFields()  : CustomFields
Operation createCustomFields
createCustomFieldsWithHttpInfo()  : array<string|int, mixed>
Operation createCustomFieldsWithHttpInfo
createDocumentFields()  : DocumentFieldsInformation
Operation createDocumentFields
createDocumentFieldsWithHttpInfo()  : array<string|int, mixed>
Operation createDocumentFieldsWithHttpInfo
createDocumentResponsiveHtmlPreview()  : DocumentHtmlDefinitions
Operation createDocumentResponsiveHtmlPreview
createDocumentResponsiveHtmlPreviewWithHttpInfo()  : array<string|int, mixed>
Operation createDocumentResponsiveHtmlPreviewWithHttpInfo
createDocumentTabs()  : Tabs
Operation createDocumentTabs
createDocumentTabsWithHttpInfo()  : array<string|int, mixed>
Operation createDocumentTabsWithHttpInfo
createEditView()  : ViewUrl
Operation createEditView
createEditViewWithHttpInfo()  : array<string|int, mixed>
Operation createEditViewWithHttpInfo
createEmailSettings()  : EmailSettings
Operation createEmailSettings
createEmailSettingsWithHttpInfo()  : array<string|int, mixed>
Operation createEmailSettingsWithHttpInfo
createEnvelope()  : EnvelopeSummary
Operation createEnvelope
createEnvelopeComments()  : CommentHistoryResult
Operation createEnvelopeComments
createEnvelopeCommentsWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeCommentsWithHttpInfo
createEnvelopeRecipientPreview()  : ViewUrl
Operation createEnvelopeRecipientPreview
createEnvelopeRecipientPreviewWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeRecipientPreviewWithHttpInfo
createEnvelopeRecipientSharedView()  : ViewUrl
Operation createEnvelopeRecipientSharedView
createEnvelopeRecipientSharedViewWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeRecipientSharedViewWithHttpInfo
createEnvelopeTransferRules()  : EnvelopeTransferRuleInformation
Operation createEnvelopeTransferRules
createEnvelopeTransferRulesWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeTransferRulesWithHttpInfo
createEnvelopeWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeWithHttpInfo
createEnvelopeWorkflowStepDefinition()  : WorkflowStep
Operation createEnvelopeWorkflowStepDefinition
createEnvelopeWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation createEnvelopeWorkflowStepDefinitionWithHttpInfo
createHistoricalEnvelopePublishTransaction()  : EnvelopePublishTransaction
Operation createHistoricalEnvelopePublishTransaction
createHistoricalEnvelopePublishTransactionWithHttpInfo()  : array<string|int, mixed>
Operation createHistoricalEnvelopePublishTransactionWithHttpInfo
createLock()  : LockInformation
Operation createLock
createLockWithHttpInfo()  : array<string|int, mixed>
Operation createLockWithHttpInfo
createRecipient()  : Recipients
Operation createRecipient
createRecipientManualReviewView()  : ViewUrl
Operation createRecipientManualReviewView
createRecipientManualReviewViewWithHttpInfo()  : array<string|int, mixed>
Operation createRecipientManualReviewViewWithHttpInfo
createRecipientProofFileLink()  : IdEvidenceViewLink
Operation createRecipientProofFileLink
createRecipientProofFileLinkWithHttpInfo()  : array<string|int, mixed>
Operation createRecipientProofFileLinkWithHttpInfo
createRecipientProofFileResourceToken()  : IdEvidenceResourceToken
Operation createRecipientProofFileResourceToken
createRecipientProofFileResourceTokenWithHttpInfo()  : array<string|int, mixed>
Operation createRecipientProofFileResourceTokenWithHttpInfo
createRecipientView()  : ViewUrl
Operation createRecipientView
createRecipientViewWithHttpInfo()  : array<string|int, mixed>
Operation createRecipientViewWithHttpInfo
createRecipientWithHttpInfo()  : array<string|int, mixed>
Operation createRecipientWithHttpInfo
createResponsiveHtmlPreview()  : DocumentHtmlDefinitions
Operation createResponsiveHtmlPreview
createResponsiveHtmlPreviewWithHttpInfo()  : array<string|int, mixed>
Operation createResponsiveHtmlPreviewWithHttpInfo
createSenderView()  : ViewUrl
Operation createSenderView
createSenderViewWithHttpInfo()  : array<string|int, mixed>
Operation createSenderViewWithHttpInfo
createTabs()  : Tabs
Operation createTabs
createTabsWithHttpInfo()  : array<string|int, mixed>
Operation createTabsWithHttpInfo
createTemplateWorkflowStepDefinition()  : WorkflowStep
Operation createTemplateWorkflowStepDefinition
createTemplateWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation createTemplateWorkflowStepDefinitionWithHttpInfo
deleteAttachments()  : EnvelopeAttachmentsResult
Operation deleteAttachments
deleteAttachmentsWithHttpInfo()  : array<string|int, mixed>
Operation deleteAttachmentsWithHttpInfo
deleteChunkedUpload()  : ChunkedUploadResponse
Operation deleteChunkedUpload
deleteChunkedUploadWithHttpInfo()  : array<string|int, mixed>
Operation deleteChunkedUploadWithHttpInfo
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()  : EnvelopeDocumentsResult
Operation deleteDocuments
deleteDocumentsWithHttpInfo()  : array<string|int, mixed>
Operation deleteDocumentsWithHttpInfo
deleteDocumentTabs()  : Tabs
Operation deleteDocumentTabs
deleteDocumentTabsWithHttpInfo()  : array<string|int, mixed>
Operation deleteDocumentTabsWithHttpInfo
deleteEmailSettings()  : EmailSettings
Operation deleteEmailSettings
deleteEmailSettingsWithHttpInfo()  : array<string|int, mixed>
Operation deleteEmailSettingsWithHttpInfo
deleteEnvelopeCorrectView()  : mixed
Operation deleteEnvelopeCorrectView
deleteEnvelopeCorrectViewWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeCorrectViewWithHttpInfo
deleteEnvelopeDelayedRoutingDefinition()  : mixed
Operation deleteEnvelopeDelayedRoutingDefinition
deleteEnvelopeDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeDelayedRoutingDefinitionWithHttpInfo
deleteEnvelopeScheduledSendingDefinition()  : mixed
Operation deleteEnvelopeScheduledSendingDefinition
deleteEnvelopeScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeScheduledSendingDefinitionWithHttpInfo
deleteEnvelopeTransferRules()  : mixed
Operation deleteEnvelopeTransferRules
deleteEnvelopeTransferRulesWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeTransferRulesWithHttpInfo
deleteEnvelopeWorkflowDefinition()  : mixed
Operation deleteEnvelopeWorkflowDefinition
deleteEnvelopeWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeWorkflowDefinitionWithHttpInfo
deleteEnvelopeWorkflowStepDefinition()  : mixed
Operation deleteEnvelopeWorkflowStepDefinition
deleteEnvelopeWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteEnvelopeWorkflowStepDefinitionWithHttpInfo
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
deleteTemplateDelayedRoutingDefinition()  : mixed
Operation deleteTemplateDelayedRoutingDefinition
deleteTemplateDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteTemplateDelayedRoutingDefinitionWithHttpInfo
deleteTemplateScheduledSendingDefinition()  : mixed
Operation deleteTemplateScheduledSendingDefinition
deleteTemplateScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteTemplateScheduledSendingDefinitionWithHttpInfo
deleteTemplatesFromDocument()  : mixed
Operation deleteTemplatesFromDocument
deleteTemplatesFromDocumentWithHttpInfo()  : array<string|int, mixed>
Operation deleteTemplatesFromDocumentWithHttpInfo
deleteTemplateWorkflowDefinition()  : mixed
Operation deleteTemplateWorkflowDefinition
deleteTemplateWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteTemplateWorkflowDefinitionWithHttpInfo
deleteTemplateWorkflowStepDefinition()  : mixed
Operation deleteTemplateWorkflowStepDefinition
deleteTemplateWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation deleteTemplateWorkflowStepDefinitionWithHttpInfo
getApiClient()  : ApiClient
Get API client
getAttachment()  : mixed
Operation getAttachment
getAttachments()  : EnvelopeAttachmentsResult
Operation getAttachments
getAttachmentsWithHttpInfo()  : array<string|int, mixed>
Operation getAttachmentsWithHttpInfo
getAttachmentWithHttpInfo()  : array<string|int, mixed>
Operation getAttachmentWithHttpInfo
getChunkedUpload()  : ChunkedUploadResponse
Operation getChunkedUpload
getChunkedUploadWithHttpInfo()  : array<string|int, mixed>
Operation getChunkedUploadWithHttpInfo
getCommentsTranscript()  : SplFileObject
Operation getCommentsTranscript
getCommentsTranscriptWithHttpInfo()  : array<string|int, mixed>
Operation getCommentsTranscriptWithHttpInfo
getConsumerDisclosure()  : ConsumerDisclosure
Operation getConsumerDisclosure
getConsumerDisclosureDefault()  : ConsumerDisclosure
Operation getConsumerDisclosureDefault
getConsumerDisclosureDefaultWithHttpInfo()  : array<string|int, mixed>
Operation getConsumerDisclosureDefaultWithHttpInfo
getConsumerDisclosureWithHttpInfo()  : array<string|int, mixed>
Operation getConsumerDisclosureWithHttpInfo
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
getEmailSettings()  : EmailSettings
Operation getEmailSettings
getEmailSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getEmailSettingsWithHttpInfo
getEnvelope()  : Envelope
Operation getEnvelope
getEnvelopeDelayedRoutingDefinition()  : DelayedRouting
Operation getEnvelopeDelayedRoutingDefinition
getEnvelopeDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeDelayedRoutingDefinitionWithHttpInfo
getEnvelopeDocGenFormFields()  : DocGenFormFieldResponse
Operation getEnvelopeDocGenFormFields
getEnvelopeDocGenFormFieldsWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeDocGenFormFieldsWithHttpInfo
getEnvelopeDocumentHtmlDefinitions()  : DocumentHtmlDefinitionOriginals
Operation getEnvelopeDocumentHtmlDefinitions
getEnvelopeDocumentHtmlDefinitionsWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeDocumentHtmlDefinitionsWithHttpInfo
getEnvelopeHtmlDefinitions()  : DocumentHtmlDefinitionOriginals
Operation getEnvelopeHtmlDefinitions
getEnvelopeHtmlDefinitionsWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeHtmlDefinitionsWithHttpInfo
getEnvelopeScheduledSendingDefinition()  : ScheduledSending
Operation getEnvelopeScheduledSendingDefinition
getEnvelopeScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeScheduledSendingDefinitionWithHttpInfo
getEnvelopeTransferRules()  : EnvelopeTransferRuleInformation
Operation getEnvelopeTransferRules
getEnvelopeTransferRulesWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeTransferRulesWithHttpInfo
getEnvelopeWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeWithHttpInfo
getEnvelopeWorkflowDefinition()  : Workflow
Operation getEnvelopeWorkflowDefinition
getEnvelopeWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeWorkflowDefinitionWithHttpInfo
getEnvelopeWorkflowStepDefinition()  : WorkflowStep
Operation getEnvelopeWorkflowStepDefinition
getEnvelopeWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getEnvelopeWorkflowStepDefinitionWithHttpInfo
getFormData()  : EnvelopeFormData
Operation getFormData
getFormDataWithHttpInfo()  : array<string|int, mixed>
Operation getFormDataWithHttpInfo
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
getRecipientDocumentVisibility()  : DocumentVisibilityList
Operation getRecipientDocumentVisibility
getRecipientDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation getRecipientDocumentVisibilityWithHttpInfo
getRecipientInitialsImage()  : SplFileObject
Operation getRecipientInitialsImage
getRecipientInitialsImageWithHttpInfo()  : array<string|int, mixed>
Operation getRecipientInitialsImageWithHttpInfo
getRecipientSignature()  : UserSignature
Operation getRecipientSignature
getRecipientSignatureImage()  : SplFileObject
Operation getRecipientSignatureImage
getRecipientSignatureImageWithHttpInfo()  : array<string|int, mixed>
Operation getRecipientSignatureImageWithHttpInfo
getRecipientSignatureWithHttpInfo()  : array<string|int, mixed>
Operation getRecipientSignatureWithHttpInfo
getTabsBlob()  : mixed
Operation getTabsBlob
getTabsBlobWithHttpInfo()  : array<string|int, mixed>
Operation getTabsBlobWithHttpInfo
getTemplateDelayedRoutingDefinition()  : DelayedRouting
Operation getTemplateDelayedRoutingDefinition
getTemplateDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getTemplateDelayedRoutingDefinitionWithHttpInfo
getTemplateRecipientDocumentVisibility()  : DocumentVisibilityList
Operation getTemplateRecipientDocumentVisibility
getTemplateRecipientDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation getTemplateRecipientDocumentVisibilityWithHttpInfo
getTemplateScheduledSendingDefinition()  : ScheduledSending
Operation getTemplateScheduledSendingDefinition
getTemplateScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getTemplateScheduledSendingDefinitionWithHttpInfo
getTemplateWorkflowDefinition()  : Workflow
Operation getTemplateWorkflowDefinition
getTemplateWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getTemplateWorkflowDefinitionWithHttpInfo
getTemplateWorkflowStepDefinition()  : WorkflowStep
Operation getTemplateWorkflowStepDefinition
getTemplateWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation getTemplateWorkflowStepDefinitionWithHttpInfo
listAuditEvents()  : EnvelopeAuditEventResponse
Operation listAuditEvents
listAuditEventsWithHttpInfo()  : array<string|int, mixed>
Operation listAuditEventsWithHttpInfo
listCustomFields()  : CustomFieldsEnvelope
Operation listCustomFields
listCustomFieldsWithHttpInfo()  : array<string|int, mixed>
Operation listCustomFieldsWithHttpInfo
listDocumentFields()  : DocumentFieldsInformation
Operation listDocumentFields
listDocumentFieldsWithHttpInfo()  : array<string|int, mixed>
Operation listDocumentFieldsWithHttpInfo
listDocuments()  : EnvelopeDocumentsResult
Operation listDocuments
listDocumentsWithHttpInfo()  : array<string|int, mixed>
Operation listDocumentsWithHttpInfo
listRecipients()  : Recipients
Operation listRecipients
listRecipientsWithHttpInfo()  : array<string|int, mixed>
Operation listRecipientsWithHttpInfo
listStatus()  : EnvelopesInformation
Operation listStatus
listStatusChanges()  : EnvelopesInformation
Operation listStatusChanges
listStatusChangesWithHttpInfo()  : array<string|int, mixed>
Operation listStatusChangesWithHttpInfo
listStatusWithHttpInfo()  : array<string|int, mixed>
Operation listStatusWithHttpInfo
listTabs()  : Tabs
Operation listTabs
listTabsWithHttpInfo()  : array<string|int, mixed>
Operation listTabsWithHttpInfo
listTemplates()  : TemplateInformation
Operation listTemplates
listTemplatesForDocument()  : TemplateInformation
Operation listTemplatesForDocument
listTemplatesForDocumentWithHttpInfo()  : array<string|int, mixed>
Operation listTemplatesForDocumentWithHttpInfo
listTemplatesWithHttpInfo()  : array<string|int, mixed>
Operation listTemplatesWithHttpInfo
putAttachment()  : EnvelopeAttachmentsResult
Operation putAttachment
putAttachments()  : EnvelopeAttachmentsResult
Operation putAttachments
putAttachmentsWithHttpInfo()  : array<string|int, mixed>
Operation putAttachmentsWithHttpInfo
putAttachmentWithHttpInfo()  : array<string|int, mixed>
Operation putAttachmentWithHttpInfo
rotateDocumentPage()  : mixed
Operation rotateDocumentPage
rotateDocumentPageWithHttpInfo()  : array<string|int, mixed>
Operation rotateDocumentPageWithHttpInfo
setApiClient()  : self
Set the API client
update()  : EnvelopeUpdateSummary
Operation update
updateChunkedUpload()  : ChunkedUploadResponse
Operation updateChunkedUpload
updateChunkedUploadPart()  : ChunkedUploadResponse
Operation updateChunkedUploadPart
updateChunkedUploadPartWithHttpInfo()  : array<string|int, mixed>
Operation updateChunkedUploadPartWithHttpInfo
updateChunkedUploadWithHttpInfo()  : array<string|int, mixed>
Operation updateChunkedUploadWithHttpInfo
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()  : EnvelopeDocumentsResult
Operation updateDocuments
updateDocumentsWithHttpInfo()  : array<string|int, mixed>
Operation updateDocumentsWithHttpInfo
updateDocumentTabs()  : Tabs
Operation updateDocumentTabs
updateDocumentTabsWithHttpInfo()  : array<string|int, mixed>
Operation updateDocumentTabsWithHttpInfo
updateDocumentWithHttpInfo()  : array<string|int, mixed>
Operation updateDocumentWithHttpInfo
updateEmailSettings()  : EmailSettings
Operation updateEmailSettings
updateEmailSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateEmailSettingsWithHttpInfo
updateEnvelopeDelayedRoutingDefinition()  : DelayedRouting
Operation updateEnvelopeDelayedRoutingDefinition
updateEnvelopeDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeDelayedRoutingDefinitionWithHttpInfo
updateEnvelopeDocGenFormFields()  : DocGenFormFieldResponse
Operation updateEnvelopeDocGenFormFields
updateEnvelopeDocGenFormFieldsWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeDocGenFormFieldsWithHttpInfo
updateEnvelopeScheduledSendingDefinition()  : ScheduledSending
Operation updateEnvelopeScheduledSendingDefinition
updateEnvelopeScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeScheduledSendingDefinitionWithHttpInfo
updateEnvelopeTransferRule()  : EnvelopeTransferRule
Operation updateEnvelopeTransferRule
updateEnvelopeTransferRules()  : EnvelopeTransferRuleInformation
Operation updateEnvelopeTransferRules
updateEnvelopeTransferRulesWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeTransferRulesWithHttpInfo
updateEnvelopeTransferRuleWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeTransferRuleWithHttpInfo
updateEnvelopeWorkflowDefinition()  : Workflow
Operation updateEnvelopeWorkflowDefinition
updateEnvelopeWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeWorkflowDefinitionWithHttpInfo
updateEnvelopeWorkflowStepDefinition()  : WorkflowStep
Operation updateEnvelopeWorkflowStepDefinition
updateEnvelopeWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateEnvelopeWorkflowStepDefinitionWithHttpInfo
updateLock()  : LockInformation
Operation updateLock
updateLockWithHttpInfo()  : array<string|int, mixed>
Operation updateLockWithHttpInfo
updateNotificationSettings()  : Notification
Operation updateNotificationSettings
updateNotificationSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateNotificationSettingsWithHttpInfo
updateRecipientDocumentVisibility()  : DocumentVisibilityList
Operation updateRecipientDocumentVisibility
updateRecipientDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation updateRecipientDocumentVisibilityWithHttpInfo
updateRecipientInitialsImage()  : mixed
Operation updateRecipientInitialsImage
updateRecipientInitialsImageWithHttpInfo()  : array<string|int, mixed>
Operation updateRecipientInitialsImageWithHttpInfo
updateRecipients()  : RecipientsUpdateSummary
Operation updateRecipients
updateRecipientsDocumentVisibility()  : DocumentVisibilityList
Operation updateRecipientsDocumentVisibility
updateRecipientsDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation updateRecipientsDocumentVisibilityWithHttpInfo
updateRecipientSignatureImage()  : mixed
Operation updateRecipientSignatureImage
updateRecipientSignatureImageWithHttpInfo()  : array<string|int, mixed>
Operation updateRecipientSignatureImageWithHttpInfo
updateRecipientsWithHttpInfo()  : array<string|int, mixed>
Operation updateRecipientsWithHttpInfo
updateResourcePath()  : string
Update $resourcePath with $
updateTabs()  : Tabs
Operation updateTabs
updateTabsBlob()  : mixed
Operation updateTabsBlob
updateTabsBlobWithHttpInfo()  : array<string|int, mixed>
Operation updateTabsBlobWithHttpInfo
updateTabsWithHttpInfo()  : array<string|int, mixed>
Operation updateTabsWithHttpInfo
updateTemplateDelayedRoutingDefinition()  : DelayedRouting
Operation updateTemplateDelayedRoutingDefinition
updateTemplateDelayedRoutingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateDelayedRoutingDefinitionWithHttpInfo
updateTemplateRecipientDocumentVisibility()  : TemplateDocumentVisibilityList
Operation updateTemplateRecipientDocumentVisibility
updateTemplateRecipientDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateRecipientDocumentVisibilityWithHttpInfo
updateTemplateRecipientsDocumentVisibility()  : TemplateDocumentVisibilityList
Operation updateTemplateRecipientsDocumentVisibility
updateTemplateRecipientsDocumentVisibilityWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateRecipientsDocumentVisibilityWithHttpInfo
updateTemplateScheduledSendingDefinition()  : ScheduledSending
Operation updateTemplateScheduledSendingDefinition
updateTemplateScheduledSendingDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateScheduledSendingDefinitionWithHttpInfo
updateTemplateWorkflowDefinition()  : Workflow
Operation updateTemplateWorkflowDefinition
updateTemplateWorkflowDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateWorkflowDefinitionWithHttpInfo
updateTemplateWorkflowStepDefinition()  : WorkflowStep
Operation updateTemplateWorkflowStepDefinition
updateTemplateWorkflowStepDefinitionWithHttpInfo()  : array<string|int, mixed>
Operation updateTemplateWorkflowStepDefinitionWithHttpInfo
updateWithHttpInfo()  : array<string|int, mixed>
Operation updateWithHttpInfo

Properties

Methods

__construct()

Constructor

public __construct([ApiClient|null $apiClient = null ]) : void
Parameters
$apiClient : ApiClient|null = null

The api client to use

Return values
void

applyTemplate()

Operation applyTemplate

public applyTemplate(string|null $account_id, string|null $envelope_id[, DocumentTemplateList $document_template_list = null ][, ApplyTemplateOptions $options = null ]) : DocumentTemplateList

Adds templates to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_template_list : DocumentTemplateList = null

(optional)

$options : ApplyTemplateOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentTemplateList

applyTemplateToDocument()

Operation applyTemplateToDocument

public applyTemplateToDocument(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentTemplateList $document_template_list = null ][, ApplyTemplateToDocumentOptions $options = null ]) : DocumentTemplateList

Adds templates to a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_template_list : DocumentTemplateList = null

(optional)

$options : ApplyTemplateToDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentTemplateList

applyTemplateToDocumentWithHttpInfo()

Operation applyTemplateToDocumentWithHttpInfo

public applyTemplateToDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentTemplateList $document_template_list = null ][, ApplyTemplateToDocumentOptions $options = null ]) : array<string|int, mixed>

Adds templates to a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_template_list : DocumentTemplateList = null

(optional)

$options : ApplyTemplateToDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentTemplateList, HTTP status code, HTTP response headers (array of strings)

applyTemplateWithHttpInfo()

Operation applyTemplateWithHttpInfo

public applyTemplateWithHttpInfo(string|null $account_id, string|null $envelope_id[, DocumentTemplateList $document_template_list = null ][, ApplyTemplateOptions $options = null ]) : array<string|int, mixed>

Adds templates to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_template_list : DocumentTemplateList = null

(optional)

$options : ApplyTemplateOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentTemplateList, HTTP status code, HTTP response headers (array of strings)

createChunkedUploadWithHttpInfo()

Operation createChunkedUploadWithHttpInfo

public createChunkedUploadWithHttpInfo(string|null $account_id[, ChunkedUploadRequest $chunked_upload_request = null ]) : array<string|int, mixed>

Initiate a new ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_request : ChunkedUploadRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings)

createConsoleView()

Operation createConsoleView

public createConsoleView(string|null $account_id[, ConsoleViewRequest $console_view_request = null ]) : ViewUrl

Returns a URL to the authentication view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$console_view_request : ConsoleViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createConsoleViewWithHttpInfo()

Operation createConsoleViewWithHttpInfo

public createConsoleViewWithHttpInfo(string|null $account_id[, ConsoleViewRequest $console_view_request = null ]) : array<string|int, mixed>

Returns a URL to the authentication view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$console_view_request : ConsoleViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createCorrectView()

Operation createCorrectView

public createCorrectView(string|null $account_id, string|null $envelope_id[, CorrectViewRequest $correct_view_request = null ]) : ViewUrl

Returns a URL to the envelope correction UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$correct_view_request : CorrectViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createCorrectViewWithHttpInfo()

Operation createCorrectViewWithHttpInfo

public createCorrectViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, CorrectViewRequest $correct_view_request = null ]) : array<string|int, mixed>

Returns a URL to the envelope correction UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$correct_view_request : CorrectViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createCustomFields()

Operation createCustomFields

public createCustomFields(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : CustomFields

Updates envelope custom fields for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
CustomFields

createCustomFieldsWithHttpInfo()

Operation createCustomFieldsWithHttpInfo

public createCustomFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : array<string|int, mixed>

Updates envelope custom fields for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation

Creates custom document fields in an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentFieldsInformation

createDocumentFieldsWithHttpInfo()

Operation createDocumentFieldsWithHttpInfo

public createDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>

Creates custom document fields in an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentFieldsInformation, HTTP status code, HTTP response headers (array of strings)

createDocumentResponsiveHtmlPreview()

Operation createDocumentResponsiveHtmlPreview

public createDocumentResponsiveHtmlPreview(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentHtmlDefinition $document_html_definition = null ]) : DocumentHtmlDefinitions

Get Responsive HTML Preview for a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_html_definition : DocumentHtmlDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentHtmlDefinitions

createDocumentResponsiveHtmlPreviewWithHttpInfo()

Operation createDocumentResponsiveHtmlPreviewWithHttpInfo

public createDocumentResponsiveHtmlPreviewWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentHtmlDefinition $document_html_definition = null ]) : array<string|int, mixed>

Get Responsive HTML Preview for a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_html_definition : DocumentHtmlDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings)

createDocumentTabs()

Operation createDocumentTabs

public createDocumentTabs(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $tabs = null ]) : Tabs

Adds the tabs to 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

createDocumentTabsWithHttpInfo()

Operation createDocumentTabsWithHttpInfo

public createDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $tabs = null ]) : array<string|int, mixed>

Adds the tabs to 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

createEditView()

Operation createEditView

public createEditView(string|null $account_id, string|null $envelope_id[, ReturnUrlRequest $return_url_request = null ]) : ViewUrl

Returns a URL to the edit view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$return_url_request : ReturnUrlRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createEditViewWithHttpInfo()

Operation createEditViewWithHttpInfo

public createEditViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, ReturnUrlRequest $return_url_request = null ]) : array<string|int, mixed>

Returns a URL to the edit view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$return_url_request : ReturnUrlRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createEmailSettings()

Operation createEmailSettings

public createEmailSettings(string|null $account_id, string|null $envelope_id[, EmailSettings $email_settings = null ]) : EmailSettings

Adds email setting overrides to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$email_settings : EmailSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EmailSettings

createEmailSettingsWithHttpInfo()

Operation createEmailSettingsWithHttpInfo

public createEmailSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EmailSettings $email_settings = null ]) : array<string|int, mixed>

Adds email setting overrides to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$email_settings : EmailSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings)

createEnvelope()

Operation createEnvelope

public createEnvelope(string|null $account_id[, EnvelopeDefinition $envelope_definition = null ][, CreateEnvelopeOptions $options = null ]) : EnvelopeSummary

Creates an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_definition : EnvelopeDefinition = null

(optional)

$options : CreateEnvelopeOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeSummary

createEnvelopeComments()

Operation createEnvelopeComments

public createEnvelopeComments(string|null $account_id, string|null $envelope_id[, CommentsPublish $comments_publish = null ]) : CommentHistoryResult

Posts a list of comments for authorized user

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$comments_publish : CommentsPublish = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
CommentHistoryResult

createEnvelopeCommentsWithHttpInfo()

Operation createEnvelopeCommentsWithHttpInfo

public createEnvelopeCommentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, CommentsPublish $comments_publish = null ]) : array<string|int, mixed>

Posts a list of comments for authorized user

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$comments_publish : CommentsPublish = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\CommentHistoryResult, HTTP status code, HTTP response headers (array of strings)

createEnvelopeRecipientPreview()

Operation createEnvelopeRecipientPreview

public createEnvelopeRecipientPreview(string|null $account_id, string|null $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_preview_request : RecipientPreviewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createEnvelopeRecipientPreviewWithHttpInfo()

Operation createEnvelopeRecipientPreviewWithHttpInfo

public createEnvelopeRecipientPreviewWithHttpInfo(string|null $account_id, string|null $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_preview_request : RecipientPreviewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createEnvelopeRecipientSharedView()

Operation createEnvelopeRecipientSharedView

public createEnvelopeRecipientSharedView(string|null $account_id, string|null $envelope_id[, RecipientViewRequest $recipient_view_request = null ]) : ViewUrl

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_view_request : RecipientViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createEnvelopeRecipientSharedViewWithHttpInfo()

Operation createEnvelopeRecipientSharedViewWithHttpInfo

public createEnvelopeRecipientSharedViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, RecipientViewRequest $recipient_view_request = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_view_request : RecipientViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createEnvelopeTransferRules()

Operation createEnvelopeTransferRules

public createEnvelopeTransferRules(string|null $account_id[, EnvelopeTransferRuleRequest $envelope_transfer_rule_request = null ]) : EnvelopeTransferRuleInformation

Add envelope transfer rules to an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_request : EnvelopeTransferRuleRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeTransferRuleInformation

createEnvelopeTransferRulesWithHttpInfo()

Operation createEnvelopeTransferRulesWithHttpInfo

public createEnvelopeTransferRulesWithHttpInfo(string|null $account_id[, EnvelopeTransferRuleRequest $envelope_transfer_rule_request = null ]) : array<string|int, mixed>

Add envelope transfer rules to an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_request : EnvelopeTransferRuleRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeTransferRuleInformation, HTTP status code, HTTP response headers (array of strings)

createEnvelopeWithHttpInfo()

Operation createEnvelopeWithHttpInfo

public createEnvelopeWithHttpInfo(string|null $account_id[, EnvelopeDefinition $envelope_definition = null ][, CreateEnvelopeOptions $options = null ]) : array<string|int, mixed>

Creates an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_definition : EnvelopeDefinition = null

(optional)

$options : CreateEnvelopeOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeSummary, HTTP status code, HTTP response headers (array of strings)

createEnvelopeWorkflowStepDefinition()

Operation createEnvelopeWorkflowStepDefinition

public createEnvelopeWorkflowStepDefinition(string|null $account_id, string|null $envelope_id[, WorkflowStep $workflow_step = null ]) : WorkflowStep

Creates and adds a new workflow step definition for an envelope's workflow

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

createEnvelopeWorkflowStepDefinitionWithHttpInfo()

Operation createEnvelopeWorkflowStepDefinitionWithHttpInfo

public createEnvelopeWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id[, WorkflowStep $workflow_step = null ]) : array<string|int, mixed>

Creates and adds a new workflow step definition for an envelope's workflow

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

createHistoricalEnvelopePublishTransaction()

Operation createHistoricalEnvelopePublishTransaction

public createHistoricalEnvelopePublishTransaction(string|null $account_id[, ConnectHistoricalEnvelopeRepublish $connect_historical_envelope_republish = null ]) : EnvelopePublishTransaction

Submits a batch of historical envelopes for republish to an adhoc config.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$connect_historical_envelope_republish : ConnectHistoricalEnvelopeRepublish = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopePublishTransaction

createHistoricalEnvelopePublishTransactionWithHttpInfo()

Operation createHistoricalEnvelopePublishTransactionWithHttpInfo

public createHistoricalEnvelopePublishTransactionWithHttpInfo(string|null $account_id[, ConnectHistoricalEnvelopeRepublish $connect_historical_envelope_republish = null ]) : array<string|int, mixed>

Submits a batch of historical envelopes for republish to an adhoc config.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$connect_historical_envelope_republish : ConnectHistoricalEnvelopeRepublish = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopePublishTransaction, HTTP status code, HTTP response headers (array of strings)

createLock()

Operation createLock

public createLock(string|null $account_id, string|null $envelope_id[, LockRequest $lock_request = null ]) : LockInformation

Lock an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lock_request : LockRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
LockInformation

createLockWithHttpInfo()

Operation createLockWithHttpInfo

public createLockWithHttpInfo(string|null $account_id, string|null $envelope_id[, LockRequest $lock_request = null ]) : array<string|int, mixed>

Lock an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lock_request : LockRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings)

createRecipient()

Operation createRecipient

public createRecipient(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ][, CreateRecipientOptions $options = null ]) : Recipients

Adds one or more recipients to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

$options : CreateRecipientOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
Recipients

createRecipientManualReviewView()

Operation createRecipientManualReviewView

public createRecipientManualReviewView(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : ViewUrl

Provides a link to access the Identity manual review related to a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createRecipientManualReviewViewWithHttpInfo()

Operation createRecipientManualReviewViewWithHttpInfo

public createRecipientManualReviewViewWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Provides a link to access the Identity manual review related to a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

Operation createRecipientProofFileLink

public createRecipientProofFileLink(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : IdEvidenceViewLink

Returns a link to access to the identity events stored in the proof service related to this recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
IdEvidenceViewLink

createRecipientProofFileLinkWithHttpInfo()

Operation createRecipientProofFileLinkWithHttpInfo

public createRecipientProofFileLinkWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Returns a link to access to the identity events stored in the proof service related to this recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\IdEvidenceViewLink, HTTP status code, HTTP response headers (array of strings)

createRecipientProofFileResourceToken()

Operation createRecipientProofFileResourceToken

public createRecipientProofFileResourceToken(string|null $account_id, string|null $envelope_id, string|null $recipient_id, string|null $token_scopes) : IdEvidenceResourceToken

Returns a resource token to get access to the identity events stored in the proof service related to this recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$token_scopes : string|null
Tags
throws
ApiException

on non-2xx response

Return values
IdEvidenceResourceToken

createRecipientProofFileResourceTokenWithHttpInfo()

Operation createRecipientProofFileResourceTokenWithHttpInfo

public createRecipientProofFileResourceTokenWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id, string|null $token_scopes) : array<string|int, mixed>

Returns a resource token to get access to the identity events stored in the proof service related to this recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$token_scopes : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\IdEvidenceResourceToken, HTTP status code, HTTP response headers (array of strings)

createRecipientView()

Operation createRecipientView

public createRecipientView(string|null $account_id, string|null $envelope_id[, RecipientViewRequest $recipient_view_request = null ]) : ViewUrl

Returns a URL to the recipient view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_view_request : RecipientViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createRecipientViewWithHttpInfo()

Operation createRecipientViewWithHttpInfo

public createRecipientViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, RecipientViewRequest $recipient_view_request = null ]) : array<string|int, mixed>

Returns a URL to the recipient view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_view_request : RecipientViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createRecipientWithHttpInfo()

Operation createRecipientWithHttpInfo

public createRecipientWithHttpInfo(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ][, CreateRecipientOptions $options = null ]) : array<string|int, mixed>

Adds one or more recipients to an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

$options : CreateRecipientOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)

createResponsiveHtmlPreview()

Operation createResponsiveHtmlPreview

public createResponsiveHtmlPreview(string|null $account_id, string|null $envelope_id[, DocumentHtmlDefinition $document_html_definition = null ]) : DocumentHtmlDefinitions

Get Responsive HTML Preview for all documents in an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_html_definition : DocumentHtmlDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentHtmlDefinitions

createResponsiveHtmlPreviewWithHttpInfo()

Operation createResponsiveHtmlPreviewWithHttpInfo

public createResponsiveHtmlPreviewWithHttpInfo(string|null $account_id, string|null $envelope_id[, DocumentHtmlDefinition $document_html_definition = null ]) : array<string|int, mixed>

Get Responsive HTML Preview for all documents in an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_html_definition : DocumentHtmlDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings)

createSenderView()

Operation createSenderView

public createSenderView(string|null $account_id, string|null $envelope_id[, ReturnUrlRequest $return_url_request = null ]) : ViewUrl

Returns a URL to the sender view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$return_url_request : ReturnUrlRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ViewUrl

createSenderViewWithHttpInfo()

Operation createSenderViewWithHttpInfo

public createSenderViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, ReturnUrlRequest $return_url_request = null ]) : array<string|int, mixed>

Returns a URL to the sender view UI.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$return_url_request : ReturnUrlRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings)

createTabs()

Operation createTabs

public createTabs(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, Tabs $tabs = null ]) : Tabs

Adds tabs for a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

createTabsWithHttpInfo()

Operation createTabsWithHttpInfo

public createTabsWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, Tabs $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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

createTemplateWorkflowStepDefinition()

Operation createTemplateWorkflowStepDefinition

public createTemplateWorkflowStepDefinition(string|null $account_id, string|null $template_id[, WorkflowStep $workflow_step = null ]) : WorkflowStep

Creates and adds a new workflow step definition for a template's workflow

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.

$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

createTemplateWorkflowStepDefinitionWithHttpInfo()

Operation createTemplateWorkflowStepDefinitionWithHttpInfo

public createTemplateWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $template_id[, WorkflowStep $workflow_step = null ]) : array<string|int, mixed>

Creates and adds a new workflow step definition for a template's workflow

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.

$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

deleteAttachments()

Operation deleteAttachments

public deleteAttachments(string|null $account_id, string|null $envelope_id[, EnvelopeAttachmentsRequest $envelope_attachments_request = null ]) : EnvelopeAttachmentsResult

Delete one or more attachments from a DRAFT envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_attachments_request : EnvelopeAttachmentsRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeAttachmentsResult

deleteAttachmentsWithHttpInfo()

Operation deleteAttachmentsWithHttpInfo

public deleteAttachmentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EnvelopeAttachmentsRequest $envelope_attachments_request = null ]) : array<string|int, mixed>

Delete one or more attachments from a DRAFT envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_attachments_request : EnvelopeAttachmentsRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings)

deleteChunkedUpload()

Operation deleteChunkedUpload

public deleteChunkedUpload(string|null $account_id, string|null $chunked_upload_id) : ChunkedUploadResponse

Delete an existing ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
ChunkedUploadResponse

deleteChunkedUploadWithHttpInfo()

Operation deleteChunkedUploadWithHttpInfo

public deleteChunkedUploadWithHttpInfo(string|null $account_id, string|null $chunked_upload_id) : array<string|int, mixed>

Delete an existing ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings)

deleteCustomFields()

Operation deleteCustomFields

public deleteCustomFields(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : CustomFields

Deletes envelope custom fields for draft and in-process envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
CustomFields

deleteCustomFieldsWithHttpInfo()

Operation deleteCustomFieldsWithHttpInfo

public deleteCustomFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : array<string|int, mixed>

Deletes envelope custom fields for draft and in-process envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation

Deletes custom document fields from an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentFieldsInformation

deleteDocumentFieldsWithHttpInfo()

Operation deleteDocumentFieldsWithHttpInfo

public deleteDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>

Deletes custom document fields from an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $page_number) : mixed

Deletes a page from a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteDocumentPageWithHttpInfo()

Operation deleteDocumentPageWithHttpInfo

public deleteDocumentPageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number) : array<string|int, mixed>

Deletes a page from a document in an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, EnvelopeDefinition $envelope_definition = null ]) : EnvelopeDocumentsResult

Deletes documents from a draft envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_definition : EnvelopeDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeDocumentsResult

deleteDocumentsWithHttpInfo()

Operation deleteDocumentsWithHttpInfo

public deleteDocumentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EnvelopeDefinition $envelope_definition = null ]) : array<string|int, mixed>

Deletes documents from a draft envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_definition : EnvelopeDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeDocumentsResult, HTTP status code, HTTP response headers (array of strings)

deleteDocumentTabs()

Operation deleteDocumentTabs

public deleteDocumentTabs(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

deleteDocumentTabsWithHttpInfo()

Operation deleteDocumentTabsWithHttpInfo

public deleteDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

deleteEmailSettings()

Operation deleteEmailSettings

public deleteEmailSettings(string|null $account_id, string|null $envelope_id) : EmailSettings

Deletes the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
EmailSettings

deleteEmailSettingsWithHttpInfo()

Operation deleteEmailSettingsWithHttpInfo

public deleteEmailSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Deletes the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeCorrectView()

Operation deleteEnvelopeCorrectView

public deleteEnvelopeCorrectView(string|null $account_id, string|null $envelope_id[, CorrectViewRequest $correct_view_request = null ]) : mixed

Revokes the correction view URL to the Envelope UI

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$correct_view_request : CorrectViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeCorrectViewWithHttpInfo()

Operation deleteEnvelopeCorrectViewWithHttpInfo

public deleteEnvelopeCorrectViewWithHttpInfo(string|null $account_id, string|null $envelope_id[, CorrectViewRequest $correct_view_request = null ]) : array<string|int, mixed>

Revokes the correction view URL to the Envelope UI

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$correct_view_request : CorrectViewRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeDelayedRoutingDefinition()

Operation deleteEnvelopeDelayedRoutingDefinition

public deleteEnvelopeDelayedRoutingDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : mixed

Deletes the delayed routing rules for the specified envelope workflow step.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeDelayedRoutingDefinitionWithHttpInfo()

Operation deleteEnvelopeDelayedRoutingDefinitionWithHttpInfo

public deleteEnvelopeDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : array<string|int, mixed>

Deletes the delayed routing rules for the specified envelope workflow step.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeScheduledSendingDefinition()

Operation deleteEnvelopeScheduledSendingDefinition

public deleteEnvelopeScheduledSendingDefinition(string|null $account_id, string|null $envelope_id) : mixed

Deletes the scheduled sending rules for the envelope's workflow.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeScheduledSendingDefinitionWithHttpInfo()

Operation deleteEnvelopeScheduledSendingDefinitionWithHttpInfo

public deleteEnvelopeScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Deletes the scheduled sending rules for the envelope's workflow.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeTransferRules()

Operation deleteEnvelopeTransferRules

public deleteEnvelopeTransferRules(string|null $account_id, string|null $envelope_transfer_rule_id) : mixed

Delete envelope transfer rules for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeTransferRulesWithHttpInfo()

Operation deleteEnvelopeTransferRulesWithHttpInfo

public deleteEnvelopeTransferRulesWithHttpInfo(string|null $account_id, string|null $envelope_transfer_rule_id) : array<string|int, mixed>

Delete envelope transfer rules for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeWorkflowDefinition()

Operation deleteEnvelopeWorkflowDefinition

public deleteEnvelopeWorkflowDefinition(string|null $account_id, string|null $envelope_id) : mixed

Delete the workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeWorkflowDefinitionWithHttpInfo()

Operation deleteEnvelopeWorkflowDefinitionWithHttpInfo

public deleteEnvelopeWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Delete the workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteEnvelopeWorkflowStepDefinition()

Operation deleteEnvelopeWorkflowStepDefinition

public deleteEnvelopeWorkflowStepDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : mixed

Deletes the envelope workflow step definition for an envelope's workflow by step id.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEnvelopeWorkflowStepDefinitionWithHttpInfo()

Operation deleteEnvelopeWorkflowStepDefinitionWithHttpInfo

public deleteEnvelopeWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : array<string|int, mixed>

Deletes the envelope workflow step definition for an envelope's workflow by step id.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteLock()

Operation deleteLock

public deleteLock(string|null $account_id, string|null $envelope_id) : LockInformation

Deletes an envelope lock.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
LockInformation

deleteLockWithHttpInfo()

Operation deleteLockWithHttpInfo

public deleteLockWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Deletes an envelope lock.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $recipient_id) : Recipients

Deletes a recipient from an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
Recipients

deleteRecipients()

Operation deleteRecipients

public deleteRecipients(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ]) : Recipients

Deletes recipients from an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Recipients

deleteRecipientsWithHttpInfo()

Operation deleteRecipientsWithHttpInfo

public deleteRecipientsWithHttpInfo(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ]) : array<string|int, mixed>

Deletes recipients from an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Deletes a recipient from an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $recipient_id[, Tabs $tabs = null ]) : Tabs

Deletes the tabs associated with a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

deleteTabsWithHttpInfo()

Operation deleteTabsWithHttpInfo

public deleteTabsWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, Tabs $tabs = null ]) : array<string|int, mixed>

Deletes the tabs associated with a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

deleteTemplateDelayedRoutingDefinition()

Operation deleteTemplateDelayedRoutingDefinition

public deleteTemplateDelayedRoutingDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : mixed

Deletes the delayed routing rules for the specified template workflow step.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteTemplateDelayedRoutingDefinitionWithHttpInfo()

Operation deleteTemplateDelayedRoutingDefinitionWithHttpInfo

public deleteTemplateDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : array<string|int, mixed>

Deletes the delayed routing rules for the specified template workflow step.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteTemplateScheduledSendingDefinition()

Operation deleteTemplateScheduledSendingDefinition

public deleteTemplateScheduledSendingDefinition(string|null $account_id, string|null $template_id) : mixed

Deletes the scheduled sending rules for the template's workflow.

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
throws
ApiException

on non-2xx response

Return values
mixed

deleteTemplateScheduledSendingDefinitionWithHttpInfo()

Operation deleteTemplateScheduledSendingDefinitionWithHttpInfo

public deleteTemplateScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>

Deletes the scheduled sending rules for the template's workflow.

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
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteTemplatesFromDocument()

Operation deleteTemplatesFromDocument

public deleteTemplatesFromDocument(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $template_id) : mixed

Deletes a template from a document in an existing envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$template_id : string|null

The ID of the template being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteTemplatesFromDocumentWithHttpInfo()

Operation deleteTemplatesFromDocumentWithHttpInfo

public deleteTemplatesFromDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $template_id) : array<string|int, mixed>

Deletes a template from a document in an existing envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$template_id : string|null

The ID of the template being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteTemplateWorkflowDefinition()

Operation deleteTemplateWorkflowDefinition

public deleteTemplateWorkflowDefinition(string|null $account_id, string|null $template_id) : mixed

Delete the workflow definition 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.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteTemplateWorkflowDefinitionWithHttpInfo()

Operation deleteTemplateWorkflowDefinitionWithHttpInfo

public deleteTemplateWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>

Delete the workflow definition 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.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteTemplateWorkflowStepDefinition()

Operation deleteTemplateWorkflowStepDefinition

public deleteTemplateWorkflowStepDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : mixed

Deletes the workflow step definition for an template's workflow by step id.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteTemplateWorkflowStepDefinitionWithHttpInfo()

Operation deleteTemplateWorkflowStepDefinitionWithHttpInfo

public deleteTemplateWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : array<string|int, mixed>

Deletes the workflow step definition for an template's workflow by step id.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAttachment()

Operation getAttachment

public getAttachment(string|null $account_id, string|null $attachment_id, string|null $envelope_id) : mixed

Retrieves an attachment from the envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$attachment_id : string|null
$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

getAttachments()

Operation getAttachments

public getAttachments(string|null $account_id, string|null $envelope_id) : EnvelopeAttachmentsResult

Returns a list of attachments associated with the specified envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeAttachmentsResult

getAttachmentsWithHttpInfo()

Operation getAttachmentsWithHttpInfo

public getAttachmentsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Returns a list of attachments associated with the specified envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings)

getAttachmentWithHttpInfo()

Operation getAttachmentWithHttpInfo

public getAttachmentWithHttpInfo(string|null $account_id, string|null $attachment_id, string|null $envelope_id) : array<string|int, mixed>

Retrieves an attachment from the envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$attachment_id : string|null
$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getChunkedUpload()

Operation getChunkedUpload

public getChunkedUpload(string|null $account_id, string|null $chunked_upload_id[, GetChunkedUploadOptions $options = null ]) : ChunkedUploadResponse

Retrieves the current metadata of a ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$options : GetChunkedUploadOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ChunkedUploadResponse

getChunkedUploadWithHttpInfo()

Operation getChunkedUploadWithHttpInfo

public getChunkedUploadWithHttpInfo(string|null $account_id, string|null $chunked_upload_id[, GetChunkedUploadOptions $options = null ]) : array<string|int, mixed>

Retrieves the current metadata of a ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$options : GetChunkedUploadOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings)

getCommentsTranscript()

Operation getCommentsTranscript

public getCommentsTranscript(string|null $account_id, string|null $envelope_id[, GetCommentsTranscriptOptions $options = null ]) : SplFileObject

Gets comment transcript for envelope and user

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetCommentsTranscriptOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getCommentsTranscriptWithHttpInfo()

Operation getCommentsTranscriptWithHttpInfo

public getCommentsTranscriptWithHttpInfo(string|null $account_id, string|null $envelope_id[, GetCommentsTranscriptOptions $options = null ]) : array<string|int, mixed>

Gets comment transcript for envelope and user

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetCommentsTranscriptOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

getConsumerDisclosure()

Operation getConsumerDisclosure

public getConsumerDisclosure(string|null $account_id, string|null $envelope_id, string|null $lang_code, string|null $recipient_id[, GetConsumerDisclosureOptions $options = null ]) : ConsumerDisclosure

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lang_code : string|null

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetConsumerDisclosureOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConsumerDisclosure

getConsumerDisclosureDefault()

Operation getConsumerDisclosureDefault

public getConsumerDisclosureDefault(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetConsumerDisclosureDefaultOptions $options = null ]) : ConsumerDisclosure

Gets the Electronic Record and Signature Disclosure associated with the account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetConsumerDisclosureDefaultOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConsumerDisclosure

getConsumerDisclosureDefaultWithHttpInfo()

Operation getConsumerDisclosureDefaultWithHttpInfo

public getConsumerDisclosureDefaultWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetConsumerDisclosureDefaultOptions $options = null ]) : array<string|int, mixed>

Gets the Electronic Record and Signature Disclosure associated with the account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetConsumerDisclosureDefaultOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings)

getConsumerDisclosureWithHttpInfo()

Operation getConsumerDisclosureWithHttpInfo

public getConsumerDisclosureWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $lang_code, string|null $recipient_id[, GetConsumerDisclosureOptions $options = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lang_code : string|null

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetConsumerDisclosureOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings)

getDocument()

Operation getDocument

public getDocument(string|null $account_id, string|null $document_id, string|null $envelope_id[, GetDocumentOptions $options = null ]) : SplFileObject

Gets a document from an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getDocumentPageImage()

Operation getDocumentPageImage

public getDocumentPageImage(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number[, GetDocumentPageImageOptions $options = null ]) : SplFileObject

Gets a page image from an envelope 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

$options : GetDocumentPageImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getDocumentPageImageWithHttpInfo()

Operation getDocumentPageImageWithHttpInfo

public getDocumentPageImageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number[, GetDocumentPageImageOptions $options = null ]) : array<string|int, mixed>

Gets a page image from an envelope 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

$options : GetDocumentPageImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetDocumentTabsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

getDocumentTabsWithHttpInfo()

Operation getDocumentTabsWithHttpInfo

public getDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetDocumentTabsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, GetDocumentOptions $options = null ]) : array<string|int, mixed>

Gets a document from an envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

getEmailSettings()

Operation getEmailSettings

public getEmailSettings(string|null $account_id, string|null $envelope_id) : EmailSettings

Gets the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
EmailSettings

getEmailSettingsWithHttpInfo()

Operation getEmailSettingsWithHttpInfo

public getEmailSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Gets the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings)

getEnvelope()

Operation getEnvelope

public getEnvelope(string|null $account_id, string|null $envelope_id[, GetEnvelopeOptions $options = null ]) : Envelope

Gets the status of a envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetEnvelopeOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
Envelope

getEnvelopeDelayedRoutingDefinition()

Operation getEnvelopeDelayedRoutingDefinition

public getEnvelopeDelayedRoutingDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : DelayedRouting

Returns the delayed routing rules for an envelope's workflow step definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
DelayedRouting

getEnvelopeDelayedRoutingDefinitionWithHttpInfo()

Operation getEnvelopeDelayedRoutingDefinitionWithHttpInfo

public getEnvelopeDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : array<string|int, mixed>

Returns the delayed routing rules for an envelope's workflow step definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DelayedRouting, HTTP status code, HTTP response headers (array of strings)

getEnvelopeDocGenFormFields()

Operation getEnvelopeDocGenFormFields

public getEnvelopeDocGenFormFields(string|null $account_id, string|null $envelope_id) : DocGenFormFieldResponse

Returns formfields for an envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
DocGenFormFieldResponse

getEnvelopeDocGenFormFieldsWithHttpInfo()

Operation getEnvelopeDocGenFormFieldsWithHttpInfo

public getEnvelopeDocGenFormFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Returns formfields for an envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocGenFormFieldResponse, HTTP status code, HTTP response headers (array of strings)

getEnvelopeDocumentHtmlDefinitions()

Operation getEnvelopeDocumentHtmlDefinitions

public getEnvelopeDocumentHtmlDefinitions(string|null $account_id, string|null $document_id, string|null $envelope_id) : DocumentHtmlDefinitionOriginals

Get the Original HTML Definition used to generate the Responsive HTML for a given 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
DocumentHtmlDefinitionOriginals

getEnvelopeDocumentHtmlDefinitionsWithHttpInfo()

Operation getEnvelopeDocumentHtmlDefinitionsWithHttpInfo

public getEnvelopeDocumentHtmlDefinitionsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id) : array<string|int, mixed>

Get the Original HTML Definition used to generate the Responsive HTML for a given 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings)

getEnvelopeHtmlDefinitions()

Operation getEnvelopeHtmlDefinitions

public getEnvelopeHtmlDefinitions(string|null $account_id, string|null $envelope_id) : DocumentHtmlDefinitionOriginals

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
DocumentHtmlDefinitionOriginals

getEnvelopeHtmlDefinitionsWithHttpInfo()

Operation getEnvelopeHtmlDefinitionsWithHttpInfo

public getEnvelopeHtmlDefinitionsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings)

getEnvelopeScheduledSendingDefinition()

Operation getEnvelopeScheduledSendingDefinition

public getEnvelopeScheduledSendingDefinition(string|null $account_id, string|null $envelope_id) : ScheduledSending

Returns the scheduled sending rules for an envelope's workflow definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
ScheduledSending

getEnvelopeScheduledSendingDefinitionWithHttpInfo()

Operation getEnvelopeScheduledSendingDefinitionWithHttpInfo

public getEnvelopeScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Returns the scheduled sending rules for an envelope's workflow definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ScheduledSending, HTTP status code, HTTP response headers (array of strings)

getEnvelopeTransferRules()

Operation getEnvelopeTransferRules

public getEnvelopeTransferRules(string|null $account_id[, GetEnvelopeTransferRulesOptions $options = null ]) : EnvelopeTransferRuleInformation

Returns a list of envelope transfer rules in the specified account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$options : GetEnvelopeTransferRulesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeTransferRuleInformation

getEnvelopeTransferRulesWithHttpInfo()

Operation getEnvelopeTransferRulesWithHttpInfo

public getEnvelopeTransferRulesWithHttpInfo(string|null $account_id[, GetEnvelopeTransferRulesOptions $options = null ]) : array<string|int, mixed>

Returns a list of envelope transfer rules in the specified account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$options : GetEnvelopeTransferRulesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeTransferRuleInformation, HTTP status code, HTTP response headers (array of strings)

getEnvelopeWithHttpInfo()

Operation getEnvelopeWithHttpInfo

public getEnvelopeWithHttpInfo(string|null $account_id, string|null $envelope_id[, GetEnvelopeOptions $options = null ]) : array<string|int, mixed>

Gets the status of a envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetEnvelopeOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Envelope, HTTP status code, HTTP response headers (array of strings)

getEnvelopeWorkflowDefinition()

Operation getEnvelopeWorkflowDefinition

public getEnvelopeWorkflowDefinition(string|null $account_id, string|null $envelope_id) : Workflow

Returns the workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
Workflow

getEnvelopeWorkflowDefinitionWithHttpInfo()

Operation getEnvelopeWorkflowDefinitionWithHttpInfo

public getEnvelopeWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Returns the workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Workflow, HTTP status code, HTTP response headers (array of strings)

getEnvelopeWorkflowStepDefinition()

Operation getEnvelopeWorkflowStepDefinition

public getEnvelopeWorkflowStepDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : WorkflowStep

Returns the workflow step definition for an envelope by step id.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

getEnvelopeWorkflowStepDefinitionWithHttpInfo()

Operation getEnvelopeWorkflowStepDefinitionWithHttpInfo

public getEnvelopeWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id) : array<string|int, mixed>

Returns the workflow step definition for an envelope by step id.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

getFormData()

Operation getFormData

public getFormData(string|null $account_id, string|null $envelope_id) : EnvelopeFormData

Returns envelope form data for an existing envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeFormData

getFormDataWithHttpInfo()

Operation getFormDataWithHttpInfo

public getFormDataWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Returns envelope form data for an existing envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeFormData, HTTP status code, HTTP response headers (array of strings)

getLock()

Operation getLock

public getLock(string|null $account_id, string|null $envelope_id) : LockInformation

Gets envelope lock information.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
LockInformation

getLockWithHttpInfo()

Operation getLockWithHttpInfo

public getLockWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Gets envelope lock information.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_id) : Notification

Gets envelope notification information.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
Notification

getNotificationSettingsWithHttpInfo()

Operation getNotificationSettingsWithHttpInfo

public getNotificationSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Gets envelope notification information.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetPagesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
PageImages

getPagesWithHttpInfo()

Operation getPagesWithHttpInfo

public getPagesWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : GetPagesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $page_number) : 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

getPageTabsWithHttpInfo()

Operation getPageTabsWithHttpInfo

public getPageTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number) : 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

getRecipientDocumentVisibility()

Operation getRecipientDocumentVisibility

public getRecipientDocumentVisibility(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : DocumentVisibilityList

Returns document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
DocumentVisibilityList

getRecipientDocumentVisibilityWithHttpInfo()

Operation getRecipientDocumentVisibilityWithHttpInfo

public getRecipientDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Returns document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

getRecipientInitialsImage()

Operation getRecipientInitialsImage

public getRecipientInitialsImage(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetRecipientInitialsImageOptions $options = null ]) : SplFileObject

Gets the initials image for a user.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetRecipientInitialsImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getRecipientInitialsImageWithHttpInfo()

Operation getRecipientInitialsImageWithHttpInfo

public getRecipientInitialsImageWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetRecipientInitialsImageOptions $options = null ]) : array<string|int, mixed>

Gets the initials image for a user.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetRecipientInitialsImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

getRecipientSignature()

Operation getRecipientSignature

public getRecipientSignature(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : UserSignature

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
UserSignature

getRecipientSignatureImage()

Operation getRecipientSignatureImage

public getRecipientSignatureImage(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetRecipientSignatureImageOptions $options = null ]) : SplFileObject

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetRecipientSignatureImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getRecipientSignatureImageWithHttpInfo()

Operation getRecipientSignatureImageWithHttpInfo

public getRecipientSignatureImageWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, GetRecipientSignatureImageOptions $options = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : GetRecipientSignatureImageOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

getRecipientSignatureWithHttpInfo()

Operation getRecipientSignatureWithHttpInfo

public getRecipientSignatureWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\UserSignature, HTTP status code, HTTP response headers (array of strings)

getTabsBlob()

Operation getTabsBlob

public getTabsBlob(string|null $account_id, string|null $envelope_id) : mixed

Get encrypted tabs for envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

getTabsBlobWithHttpInfo()

Operation getTabsBlobWithHttpInfo

public getTabsBlobWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Get encrypted tabs for envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getTemplateDelayedRoutingDefinition()

Operation getTemplateDelayedRoutingDefinition

public getTemplateDelayedRoutingDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : DelayedRouting

Returns the delayed routing rules for a template's workflow step definition.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
DelayedRouting

getTemplateDelayedRoutingDefinitionWithHttpInfo()

Operation getTemplateDelayedRoutingDefinitionWithHttpInfo

public getTemplateDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : array<string|int, mixed>

Returns the delayed routing rules for a template's workflow step definition.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DelayedRouting, HTTP status code, HTTP response headers (array of strings)

getTemplateRecipientDocumentVisibility()

Operation getTemplateRecipientDocumentVisibility

public getTemplateRecipientDocumentVisibility(string|null $account_id, string|null $recipient_id, string|null $template_id) : DocumentVisibilityList

Returns document visibility for the recipients

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.

Tags
throws
ApiException

on non-2xx response

Return values
DocumentVisibilityList

getTemplateRecipientDocumentVisibilityWithHttpInfo()

Operation getTemplateRecipientDocumentVisibilityWithHttpInfo

public getTemplateRecipientDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id) : array<string|int, mixed>

Returns document visibility for the recipients

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.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

getTemplateScheduledSendingDefinition()

Operation getTemplateScheduledSendingDefinition

public getTemplateScheduledSendingDefinition(string|null $account_id, string|null $template_id) : ScheduledSending

Returns the scheduled sending rules for a template's workflow definition.

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
throws
ApiException

on non-2xx response

Return values
ScheduledSending

getTemplateScheduledSendingDefinitionWithHttpInfo()

Operation getTemplateScheduledSendingDefinitionWithHttpInfo

public getTemplateScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>

Returns the scheduled sending rules for a template's workflow definition.

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
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ScheduledSending, HTTP status code, HTTP response headers (array of strings)

getTemplateWorkflowDefinition()

Operation getTemplateWorkflowDefinition

public getTemplateWorkflowDefinition(string|null $account_id, string|null $template_id) : Workflow

Returns the workflow definition 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.

Tags
throws
ApiException

on non-2xx response

Return values
Workflow

getTemplateWorkflowDefinitionWithHttpInfo()

Operation getTemplateWorkflowDefinitionWithHttpInfo

public getTemplateWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $template_id) : array<string|int, mixed>

Returns the workflow definition 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.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Workflow, HTTP status code, HTTP response headers (array of strings)

getTemplateWorkflowStepDefinition()

Operation getTemplateWorkflowStepDefinition

public getTemplateWorkflowStepDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : WorkflowStep

Returns the workflow step definition for a template by step id.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

getTemplateWorkflowStepDefinitionWithHttpInfo()

Operation getTemplateWorkflowStepDefinitionWithHttpInfo

public getTemplateWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id) : array<string|int, mixed>

Returns the workflow step definition for a template by step id.

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.

$workflow_step_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

listAuditEvents()

Operation listAuditEvents

public listAuditEvents(string|null $account_id, string|null $envelope_id) : EnvelopeAuditEventResponse

Gets the envelope audit events for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeAuditEventResponse

listAuditEventsWithHttpInfo()

Operation listAuditEventsWithHttpInfo

public listAuditEventsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Gets the envelope audit events for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeAuditEventResponse, HTTP status code, HTTP response headers (array of strings)

listCustomFields()

Operation listCustomFields

public listCustomFields(string|null $account_id, string|null $envelope_id) : CustomFieldsEnvelope

Gets the custom field information for the specified envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
CustomFieldsEnvelope

listCustomFieldsWithHttpInfo()

Operation listCustomFieldsWithHttpInfo

public listCustomFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Gets the custom field information for the specified envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\CustomFieldsEnvelope, HTTP status code, HTTP response headers (array of strings)

listDocumentFields()

Operation listDocumentFields

public listDocumentFields(string|null $account_id, string|null $document_id, string|null $envelope_id) : DocumentFieldsInformation

Gets the custom document fields from an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
DocumentFieldsInformation

listDocumentFieldsWithHttpInfo()

Operation listDocumentFieldsWithHttpInfo

public listDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id) : array<string|int, mixed>

Gets the custom document fields from an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, ListDocumentsOptions $options = null ]) : EnvelopeDocumentsResult

Gets a list of envelope documents.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListDocumentsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeDocumentsResult

listDocumentsWithHttpInfo()

Operation listDocumentsWithHttpInfo

public listDocumentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, ListDocumentsOptions $options = null ]) : array<string|int, mixed>

Gets a list of envelope documents.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListDocumentsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeDocumentsResult, HTTP status code, HTTP response headers (array of strings)

listRecipients()

Operation listRecipients

public listRecipients(string|null $account_id, string|null $envelope_id[, ListRecipientsOptions $options = null ]) : Recipients

Gets the status of recipients for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListRecipientsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
Recipients

listRecipientsWithHttpInfo()

Operation listRecipientsWithHttpInfo

public listRecipientsWithHttpInfo(string|null $account_id, string|null $envelope_id[, ListRecipientsOptions $options = null ]) : array<string|int, mixed>

Gets the status of recipients for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListRecipientsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings)

listStatus()

Operation listStatus

public listStatus(string|null $account_id[, EnvelopeIdsRequest $envelope_ids_request = null ][, ListStatusOptions $options = null ]) : EnvelopesInformation

Gets the envelope status for the specified envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_ids_request : EnvelopeIdsRequest = null

(optional)

$options : ListStatusOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopesInformation

listStatusChanges()

Operation listStatusChanges

public listStatusChanges(string|null $account_id[, ListStatusChangesOptions $options = null ]) : EnvelopesInformation

Gets status changes for one or more envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$options : ListStatusChangesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopesInformation

listStatusChangesWithHttpInfo()

Operation listStatusChangesWithHttpInfo

public listStatusChangesWithHttpInfo(string|null $account_id[, ListStatusChangesOptions $options = null ]) : array<string|int, mixed>

Gets status changes for one or more envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$options : ListStatusChangesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopesInformation, HTTP status code, HTTP response headers (array of strings)

listStatusWithHttpInfo()

Operation listStatusWithHttpInfo

public listStatusWithHttpInfo(string|null $account_id[, EnvelopeIdsRequest $envelope_ids_request = null ][, ListStatusOptions $options = null ]) : array<string|int, mixed>

Gets the envelope status for the specified envelopes.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_ids_request : EnvelopeIdsRequest = null

(optional)

$options : ListStatusOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopesInformation, HTTP status code, HTTP response headers (array of strings)

listTabs()

Operation listTabs

public listTabs(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, ListTabsOptions $options = null ]) : Tabs

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : ListTabsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

listTabsWithHttpInfo()

Operation listTabsWithHttpInfo

public listTabsWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, ListTabsOptions $options = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$options : ListTabsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

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, string|null $envelope_id[, ListTemplatesOptions $options = null ]) : TemplateInformation

Get List of Templates used in an Envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListTemplatesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
TemplateInformation

listTemplatesForDocument()

Operation listTemplatesForDocument

public listTemplatesForDocument(string|null $account_id, string|null $document_id, string|null $envelope_id[, ListTemplatesForDocumentOptions $options = null ]) : TemplateInformation

Gets the templates associated with a document in an existing envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListTemplatesForDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
TemplateInformation

listTemplatesForDocumentWithHttpInfo()

Operation listTemplatesForDocumentWithHttpInfo

public listTemplatesForDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, ListTemplatesForDocumentOptions $options = null ]) : array<string|int, mixed>

Gets the templates associated with a document in an existing envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListTemplatesForDocumentOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\TemplateInformation, HTTP status code, HTTP response headers (array of strings)

listTemplatesWithHttpInfo()

Operation listTemplatesWithHttpInfo

public listTemplatesWithHttpInfo(string|null $account_id, string|null $envelope_id[, ListTemplatesOptions $options = null ]) : array<string|int, mixed>

Get List of Templates used in an Envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$options : ListTemplatesOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\TemplateInformation, HTTP status code, HTTP response headers (array of strings)

putAttachment()

Operation putAttachment

public putAttachment(string|null $account_id, string|null $attachment_id, string|null $envelope_id[, Attachment $attachment = null ]) : EnvelopeAttachmentsResult

Add an attachment to a DRAFT or IN-PROCESS envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$attachment_id : string|null
$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$attachment : Attachment = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeAttachmentsResult

putAttachments()

Operation putAttachments

public putAttachments(string|null $account_id, string|null $envelope_id[, EnvelopeAttachmentsRequest $envelope_attachments_request = null ]) : EnvelopeAttachmentsResult

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_attachments_request : EnvelopeAttachmentsRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeAttachmentsResult

putAttachmentsWithHttpInfo()

Operation putAttachmentsWithHttpInfo

public putAttachmentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EnvelopeAttachmentsRequest $envelope_attachments_request = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_attachments_request : EnvelopeAttachmentsRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings)

putAttachmentWithHttpInfo()

Operation putAttachmentWithHttpInfo

public putAttachmentWithHttpInfo(string|null $account_id, string|null $attachment_id, string|null $envelope_id[, Attachment $attachment = null ]) : array<string|int, mixed>

Add an attachment to a DRAFT or IN-PROCESS envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$attachment_id : string|null
$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$attachment : Attachment = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings)

rotateDocumentPage()

Operation rotateDocumentPage

public rotateDocumentPage(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number[, PageRequest $page_request = null ]) : mixed

Rotates page image from an envelope 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

$page_request : PageRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
mixed

rotateDocumentPageWithHttpInfo()

Operation rotateDocumentPageWithHttpInfo

public rotateDocumentPageWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $page_number[, PageRequest $page_request = null ]) : array<string|int, mixed>

Rotates page image from an envelope 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$page_number : string|null

The page number being accessed.

$page_request : PageRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, Envelope $envelope = null ][, UpdateOptions $options = null ]) : EnvelopeUpdateSummary

Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope : Envelope = null

(optional)

$options : UpdateOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeUpdateSummary

updateChunkedUpload()

Operation updateChunkedUpload

public updateChunkedUpload(string|null $account_id, string|null $chunked_upload_id[, UpdateChunkedUploadOptions $options = null ]) : ChunkedUploadResponse

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$options : UpdateChunkedUploadOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ChunkedUploadResponse

updateChunkedUploadPart()

Operation updateChunkedUploadPart

public updateChunkedUploadPart(string|null $account_id, string|null $chunked_upload_id, string|null $chunked_upload_part_seq[, ChunkedUploadRequest $chunked_upload_request = null ]) : ChunkedUploadResponse

Add a chunk, a chunk 'part', to an existing ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$chunked_upload_part_seq : string|null
$chunked_upload_request : ChunkedUploadRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ChunkedUploadResponse

updateChunkedUploadPartWithHttpInfo()

Operation updateChunkedUploadPartWithHttpInfo

public updateChunkedUploadPartWithHttpInfo(string|null $account_id, string|null $chunked_upload_id, string|null $chunked_upload_part_seq[, ChunkedUploadRequest $chunked_upload_request = null ]) : array<string|int, mixed>

Add a chunk, a chunk 'part', to an existing ChunkedUpload.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$chunked_upload_part_seq : string|null
$chunked_upload_request : ChunkedUploadRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings)

updateChunkedUploadWithHttpInfo()

Operation updateChunkedUploadWithHttpInfo

public updateChunkedUploadWithHttpInfo(string|null $account_id, string|null $chunked_upload_id[, UpdateChunkedUploadOptions $options = null ]) : array<string|int, mixed>

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$chunked_upload_id : string|null
$options : UpdateChunkedUploadOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings)

updateCustomFields()

Operation updateCustomFields

public updateCustomFields(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : CustomFields

Updates envelope custom fields in an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
CustomFields

updateCustomFieldsWithHttpInfo()

Operation updateCustomFieldsWithHttpInfo

public updateCustomFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id[, CustomFields $custom_fields = null ]) : array<string|int, mixed>

Updates envelope custom fields in an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$custom_fields : CustomFields = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $document_file_bytes) : EnvelopeDocument

Adds a document to an existing draft envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_file_bytes : string|null

Updated document content. (required)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeDocument

updateDocumentFields()

Operation updateDocumentFields

public updateDocumentFields(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : DocumentFieldsInformation

Updates existing custom document fields in an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentFieldsInformation

updateDocumentFieldsWithHttpInfo()

Operation updateDocumentFieldsWithHttpInfo

public updateDocumentFieldsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, DocumentFieldsInformation $document_fields_information = null ]) : array<string|int, mixed>

Updates existing custom document fields in an existing 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_fields_information : DocumentFieldsInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, EnvelopeDefinition $envelope_definition = null ]) : EnvelopeDocumentsResult

Adds one or more documents to an existing envelope document.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_definition : EnvelopeDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeDocumentsResult

updateDocumentsWithHttpInfo()

Operation updateDocumentsWithHttpInfo

public updateDocumentsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EnvelopeDefinition $envelope_definition = null ]) : array<string|int, mixed>

Adds one or more documents to an existing envelope document.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_definition : EnvelopeDefinition = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeDocumentsResult, HTTP status code, HTTP response headers (array of strings)

updateDocumentTabs()

Operation updateDocumentTabs

public updateDocumentTabs(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $tabs = null ]) : Tabs

Updates the tabs for 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

updateDocumentTabsWithHttpInfo()

Operation updateDocumentTabsWithHttpInfo

public updateDocumentTabsWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id[, Tabs $tabs = null ]) : array<string|int, mixed>

Updates the tabs for 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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

updateDocumentWithHttpInfo()

Operation updateDocumentWithHttpInfo

public updateDocumentWithHttpInfo(string|null $account_id, string|null $document_id, string|null $envelope_id, string|null $document_file_bytes) : array<string|int, mixed>

Adds a document to an existing draft envelope.

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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_file_bytes : string|null

Updated document content. (required)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeDocument, HTTP status code, HTTP response headers (array of strings)

updateEmailSettings()

Operation updateEmailSettings

public updateEmailSettings(string|null $account_id, string|null $envelope_id[, EmailSettings $email_settings = null ]) : EmailSettings

Updates the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$email_settings : EmailSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EmailSettings

updateEmailSettingsWithHttpInfo()

Operation updateEmailSettingsWithHttpInfo

public updateEmailSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EmailSettings $email_settings = null ]) : array<string|int, mixed>

Updates the email setting overrides for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$email_settings : EmailSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeDelayedRoutingDefinition()

Operation updateEnvelopeDelayedRoutingDefinition

public updateEnvelopeDelayedRoutingDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id[, DelayedRouting $delayed_routing = null ]) : DelayedRouting

Updates the delayed routing rules for an envelope's workflow step definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
$delayed_routing : DelayedRouting = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DelayedRouting

updateEnvelopeDelayedRoutingDefinitionWithHttpInfo()

Operation updateEnvelopeDelayedRoutingDefinitionWithHttpInfo

public updateEnvelopeDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id[, DelayedRouting $delayed_routing = null ]) : array<string|int, mixed>

Updates the delayed routing rules for an envelope's workflow step definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
$delayed_routing : DelayedRouting = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DelayedRouting, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeDocGenFormFields()

Operation updateEnvelopeDocGenFormFields

public updateEnvelopeDocGenFormFields(string|null $account_id, string|null $envelope_id[, DocGenFormFieldRequest $doc_gen_form_field_request = null ][, UpdateEnvelopeDocGenFormFieldsOptions $options = null ]) : DocGenFormFieldResponse

Updates formfields for an envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$doc_gen_form_field_request : DocGenFormFieldRequest = null

(optional)

$options : UpdateEnvelopeDocGenFormFieldsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocGenFormFieldResponse

updateEnvelopeDocGenFormFieldsWithHttpInfo()

Operation updateEnvelopeDocGenFormFieldsWithHttpInfo

public updateEnvelopeDocGenFormFieldsWithHttpInfo(string|null $account_id, string|null $envelope_id[, DocGenFormFieldRequest $doc_gen_form_field_request = null ][, UpdateEnvelopeDocGenFormFieldsOptions $options = null ]) : array<string|int, mixed>

Updates formfields for an envelope

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$doc_gen_form_field_request : DocGenFormFieldRequest = null

(optional)

$options : UpdateEnvelopeDocGenFormFieldsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocGenFormFieldResponse, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeScheduledSendingDefinition()

Operation updateEnvelopeScheduledSendingDefinition

public updateEnvelopeScheduledSendingDefinition(string|null $account_id, string|null $envelope_id[, ScheduledSending $scheduled_sending = null ]) : ScheduledSending

Updates the scheduled sending rules for an envelope's workflow definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$scheduled_sending : ScheduledSending = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ScheduledSending

updateEnvelopeScheduledSendingDefinitionWithHttpInfo()

Operation updateEnvelopeScheduledSendingDefinitionWithHttpInfo

public updateEnvelopeScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id[, ScheduledSending $scheduled_sending = null ]) : array<string|int, mixed>

Updates the scheduled sending rules for an envelope's workflow definition.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$scheduled_sending : ScheduledSending = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ScheduledSending, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeTransferRule()

Operation updateEnvelopeTransferRule

public updateEnvelopeTransferRule(string|null $account_id, string|null $envelope_transfer_rule_id[, EnvelopeTransferRule $envelope_transfer_rule = null ]) : EnvelopeTransferRule

Update an envelope transfer rule for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_id : string|null
$envelope_transfer_rule : EnvelopeTransferRule = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeTransferRule

updateEnvelopeTransferRules()

Operation updateEnvelopeTransferRules

public updateEnvelopeTransferRules(string|null $account_id[, EnvelopeTransferRuleInformation $envelope_transfer_rule_information = null ]) : EnvelopeTransferRuleInformation

Update envelope transfer rules for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_information : EnvelopeTransferRuleInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
EnvelopeTransferRuleInformation

updateEnvelopeTransferRulesWithHttpInfo()

Operation updateEnvelopeTransferRulesWithHttpInfo

public updateEnvelopeTransferRulesWithHttpInfo(string|null $account_id[, EnvelopeTransferRuleInformation $envelope_transfer_rule_information = null ]) : array<string|int, mixed>

Update envelope transfer rules for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_information : EnvelopeTransferRuleInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeTransferRuleInformation, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeTransferRuleWithHttpInfo()

Operation updateEnvelopeTransferRuleWithHttpInfo

public updateEnvelopeTransferRuleWithHttpInfo(string|null $account_id, string|null $envelope_transfer_rule_id[, EnvelopeTransferRule $envelope_transfer_rule = null ]) : array<string|int, mixed>

Update an envelope transfer rule for an account.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_transfer_rule_id : string|null
$envelope_transfer_rule : EnvelopeTransferRule = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeTransferRule, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeWorkflowDefinition()

Operation updateEnvelopeWorkflowDefinition

public updateEnvelopeWorkflowDefinition(string|null $account_id, string|null $envelope_id[, Workflow $workflow = null ]) : Workflow

Updates the envelope workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow : Workflow = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Workflow

updateEnvelopeWorkflowDefinitionWithHttpInfo()

Operation updateEnvelopeWorkflowDefinitionWithHttpInfo

public updateEnvelopeWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id[, Workflow $workflow = null ]) : array<string|int, mixed>

Updates the envelope workflow definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow : Workflow = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Workflow, HTTP status code, HTTP response headers (array of strings)

updateEnvelopeWorkflowStepDefinition()

Operation updateEnvelopeWorkflowStepDefinition

public updateEnvelopeWorkflowStepDefinition(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id[, WorkflowStep $workflow_step = null ]) : WorkflowStep

Updates the envelope workflow step definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

updateEnvelopeWorkflowStepDefinitionWithHttpInfo()

Operation updateEnvelopeWorkflowStepDefinitionWithHttpInfo

public updateEnvelopeWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $workflow_step_id[, WorkflowStep $workflow_step = null ]) : array<string|int, mixed>

Updates the envelope workflow step definition for an envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$workflow_step_id : string|null
$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

updateLock()

Operation updateLock

public updateLock(string|null $account_id, string|null $envelope_id[, LockRequest $lock_request = null ]) : LockInformation

Updates an envelope lock.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lock_request : LockRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
LockInformation

updateLockWithHttpInfo()

Operation updateLockWithHttpInfo

public updateLockWithHttpInfo(string|null $account_id, string|null $envelope_id[, LockRequest $lock_request = null ]) : array<string|int, mixed>

Updates an envelope lock.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$lock_request : LockRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id[, EnvelopeNotificationRequest $envelope_notification_request = null ]) : Notification

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_notification_request : EnvelopeNotificationRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Notification

updateNotificationSettingsWithHttpInfo()

Operation updateNotificationSettingsWithHttpInfo

public updateNotificationSettingsWithHttpInfo(string|null $account_id, string|null $envelope_id[, EnvelopeNotificationRequest $envelope_notification_request = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope_notification_request : EnvelopeNotificationRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings)

updateRecipientDocumentVisibility()

Operation updateRecipientDocumentVisibility

public updateRecipientDocumentVisibility(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, DocumentVisibilityList $document_visibility_list = null ]) : DocumentVisibilityList

Updates document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$document_visibility_list : DocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentVisibilityList

updateRecipientDocumentVisibilityWithHttpInfo()

Operation updateRecipientDocumentVisibilityWithHttpInfo

public updateRecipientDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, DocumentVisibilityList $document_visibility_list = null ]) : array<string|int, mixed>

Updates document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$document_visibility_list : DocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

updateRecipientInitialsImage()

Operation updateRecipientInitialsImage

public updateRecipientInitialsImage(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : mixed

Sets the initials image for an accountless signer.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

updateRecipientInitialsImageWithHttpInfo()

Operation updateRecipientInitialsImageWithHttpInfo

public updateRecipientInitialsImageWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Sets the initials image for an accountless signer.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

updateRecipients()

Operation updateRecipients

public updateRecipients(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ][, UpdateRecipientsOptions $options = null ]) : RecipientsUpdateSummary

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

$options : UpdateRecipientsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
RecipientsUpdateSummary

updateRecipientsDocumentVisibility()

Operation updateRecipientsDocumentVisibility

public updateRecipientsDocumentVisibility(string|null $account_id, string|null $envelope_id[, DocumentVisibilityList $document_visibility_list = null ]) : DocumentVisibilityList

Updates document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_visibility_list : DocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DocumentVisibilityList

updateRecipientsDocumentVisibilityWithHttpInfo()

Operation updateRecipientsDocumentVisibilityWithHttpInfo

public updateRecipientsDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $envelope_id[, DocumentVisibilityList $document_visibility_list = null ]) : array<string|int, mixed>

Updates document visibility for the recipients

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$document_visibility_list : DocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

updateRecipientSignatureImage()

Operation updateRecipientSignatureImage

public updateRecipientSignatureImage(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : mixed

Sets the signature image for an accountless signer.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

updateRecipientSignatureImageWithHttpInfo()

Operation updateRecipientSignatureImageWithHttpInfo

public updateRecipientSignatureImageWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id) : array<string|int, mixed>

Sets the signature image for an accountless signer.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

updateRecipientsWithHttpInfo()

Operation updateRecipientsWithHttpInfo

public updateRecipientsWithHttpInfo(string|null $account_id, string|null $envelope_id[, Recipients $recipients = null ][, UpdateRecipientsOptions $options = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipients : Recipients = null

(optional)

$options : UpdateRecipientsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

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 $envelope_id, string|null $recipient_id[, Tabs $tabs = null ]) : Tabs

Updates the tabs for a recipient.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Tabs

updateTabsBlob()

Operation updateTabsBlob

public updateTabsBlob(string|null $account_id, string|null $envelope_id) : mixed

Update encrypted tabs for envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

updateTabsBlobWithHttpInfo()

Operation updateTabsBlobWithHttpInfo

public updateTabsBlobWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Update encrypted tabs for envelope.

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

updateTabsWithHttpInfo()

Operation updateTabsWithHttpInfo

public updateTabsWithHttpInfo(string|null $account_id, string|null $envelope_id, string|null $recipient_id[, Tabs $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.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$recipient_id : string|null

The ID of the recipient being accessed.

$tabs : Tabs = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings)

updateTemplateDelayedRoutingDefinition()

Operation updateTemplateDelayedRoutingDefinition

public updateTemplateDelayedRoutingDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id[, DelayedRouting $delayed_routing = null ]) : DelayedRouting

Updates the delayed routing rules for a template's workflow step definition.

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.

$workflow_step_id : string|null
$delayed_routing : DelayedRouting = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
DelayedRouting

updateTemplateDelayedRoutingDefinitionWithHttpInfo()

Operation updateTemplateDelayedRoutingDefinitionWithHttpInfo

public updateTemplateDelayedRoutingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id[, DelayedRouting $delayed_routing = null ]) : array<string|int, mixed>

Updates the delayed routing rules for a template's workflow step definition.

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.

$workflow_step_id : string|null
$delayed_routing : DelayedRouting = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\DelayedRouting, HTTP status code, HTTP response headers (array of strings)

updateTemplateRecipientDocumentVisibility()

Operation updateTemplateRecipientDocumentVisibility

public updateTemplateRecipientDocumentVisibility(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateDocumentVisibilityList $template_document_visibility_list = null ]) : TemplateDocumentVisibilityList

Updates document visibility for the recipients

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_document_visibility_list : TemplateDocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
TemplateDocumentVisibilityList

updateTemplateRecipientDocumentVisibilityWithHttpInfo()

Operation updateTemplateRecipientDocumentVisibilityWithHttpInfo

public updateTemplateRecipientDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $recipient_id, string|null $template_id[, TemplateDocumentVisibilityList $template_document_visibility_list = null ]) : array<string|int, mixed>

Updates document visibility for the recipients

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_document_visibility_list : TemplateDocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\TemplateDocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

updateTemplateRecipientsDocumentVisibility()

Operation updateTemplateRecipientsDocumentVisibility

public updateTemplateRecipientsDocumentVisibility(string|null $account_id, string|null $template_id[, TemplateDocumentVisibilityList $template_document_visibility_list = null ]) : TemplateDocumentVisibilityList

Updates document visibility for the recipients

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_document_visibility_list : TemplateDocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
TemplateDocumentVisibilityList

updateTemplateRecipientsDocumentVisibilityWithHttpInfo()

Operation updateTemplateRecipientsDocumentVisibilityWithHttpInfo

public updateTemplateRecipientsDocumentVisibilityWithHttpInfo(string|null $account_id, string|null $template_id[, TemplateDocumentVisibilityList $template_document_visibility_list = null ]) : array<string|int, mixed>

Updates document visibility for the recipients

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_document_visibility_list : TemplateDocumentVisibilityList = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\TemplateDocumentVisibilityList, HTTP status code, HTTP response headers (array of strings)

updateTemplateScheduledSendingDefinition()

Operation updateTemplateScheduledSendingDefinition

public updateTemplateScheduledSendingDefinition(string|null $account_id, string|null $template_id[, ScheduledSending $scheduled_sending = null ]) : ScheduledSending

Updates the scheduled sending rules for a template's workflow definition.

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.

$scheduled_sending : ScheduledSending = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ScheduledSending

updateTemplateScheduledSendingDefinitionWithHttpInfo()

Operation updateTemplateScheduledSendingDefinitionWithHttpInfo

public updateTemplateScheduledSendingDefinitionWithHttpInfo(string|null $account_id, string|null $template_id[, ScheduledSending $scheduled_sending = null ]) : array<string|int, mixed>

Updates the scheduled sending rules for a template's workflow definition.

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.

$scheduled_sending : ScheduledSending = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ScheduledSending, HTTP status code, HTTP response headers (array of strings)

updateTemplateWorkflowDefinition()

Operation updateTemplateWorkflowDefinition

public updateTemplateWorkflowDefinition(string|null $account_id, string|null $template_id[, Workflow $workflow = null ]) : Workflow

Updates the workflow definition 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.

$workflow : Workflow = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
Workflow

updateTemplateWorkflowDefinitionWithHttpInfo()

Operation updateTemplateWorkflowDefinitionWithHttpInfo

public updateTemplateWorkflowDefinitionWithHttpInfo(string|null $account_id, string|null $template_id[, Workflow $workflow = null ]) : array<string|int, mixed>

Updates the workflow definition 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.

$workflow : Workflow = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\Workflow, HTTP status code, HTTP response headers (array of strings)

updateTemplateWorkflowStepDefinition()

Operation updateTemplateWorkflowStepDefinition

public updateTemplateWorkflowStepDefinition(string|null $account_id, string|null $template_id, string|null $workflow_step_id[, WorkflowStep $workflow_step = null ]) : WorkflowStep

Updates the template workflow step definition for an envelope.

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.

$workflow_step_id : string|null
$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
WorkflowStep

updateTemplateWorkflowStepDefinitionWithHttpInfo()

Operation updateTemplateWorkflowStepDefinitionWithHttpInfo

public updateTemplateWorkflowStepDefinitionWithHttpInfo(string|null $account_id, string|null $template_id, string|null $workflow_step_id[, WorkflowStep $workflow_step = null ]) : array<string|int, mixed>

Updates the template workflow step definition for an envelope.

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.

$workflow_step_id : string|null
$workflow_step : WorkflowStep = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\WorkflowStep, HTTP status code, HTTP response headers (array of strings)

updateWithHttpInfo()

Operation updateWithHttpInfo

public updateWithHttpInfo(string|null $account_id, string|null $envelope_id[, Envelope $envelope = null ][, UpdateOptions $options = null ]) : array<string|int, mixed>

Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft

Parameters
$account_id : string|null

The external account number (int) or account ID Guid.

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

$envelope : Envelope = null

(optional)

$options : UpdateOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\EnvelopeUpdateSummary, HTTP status code, HTTP response headers (array of strings)

Search results