Documentation

__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

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

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

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

Return values

array<string|int, mixed> —

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

createChunkedUpload()

Operation createChunkedUpload


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

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

Return values

ChunkedUploadResponse —

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return values

array<string|int, mixed> —

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

createRecipientProofFileLink()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return values

array<string|int, mixed> —

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

getApiClient()

Get API client


    public
                getApiClient() : ApiClient

Return values

ApiClient —

get the API client

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return values

array<string|int, mixed> —

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

EnvelopesApi in package DocuSign eSign

Tags

Table of Contents

Properties

$apiClient

Methods

__construct()

Parameters

Return values

applyTemplate()

Parameters

Tags

Return values

applyTemplateToDocument()

Parameters

Tags

Return values

applyTemplateToDocumentWithHttpInfo()

Parameters

Tags

Return values

applyTemplateWithHttpInfo()

Parameters

Tags

Return values

createChunkedUpload()

Parameters

Tags

Return values

createChunkedUploadWithHttpInfo()

Parameters

Tags

Return values

createConsoleView()

Parameters

Tags

Return values

createConsoleViewWithHttpInfo()

Parameters

Tags

Return values

createCorrectView()

Parameters

Tags

Return values

createCorrectViewWithHttpInfo()

Parameters

Tags

Return values

createCustomFields()

Parameters

Tags

Return values

createCustomFieldsWithHttpInfo()

Parameters

Tags

Return values

createDocumentFields()

Parameters

Tags

Return values

createDocumentFieldsWithHttpInfo()

Parameters

Tags

Return values

createDocumentResponsiveHtmlPreview()

Parameters

Tags

Return values

createDocumentResponsiveHtmlPreviewWithHttpInfo()

Parameters

Tags

Return values

createDocumentTabs()

Parameters

Tags

Return values

createDocumentTabsWithHttpInfo()

Parameters

Tags

EnvelopesApi
in package

DocuSign

eSign