DocuSign.Api.EnvelopeDocumentVisibility (DocuSign v2.2.0)
View SourceAPI calls for all endpoints tagged EnvelopeDocumentVisibility
.
Summary
Functions
Returns document visibility for a recipient This method returns information about document visibility for a recipient.
Updates document visibility for a recipient This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
Updates document visibility for recipients
This method updates document visibility for one or more recipients based on the recipientId
and visible
values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
Functions
@spec recipients_get_recipient_document_visibility( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.DocumentVisibilityList.t()} | {:error, Tesla.Env.t()}
Returns document visibility for a recipient This method returns information about document visibility for a recipient.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipient_id
(String.t): A local reference used to map recipients to other objects, such as specific document tabs. ArecipientId
must be either an integer or a GUID, and therecipientId
must be unique within an envelope. For example, many envelopes assign the first recipient arecipientId
of1
.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.DocumentVisibilityList.t}
on success{:error, Tesla.Env.t}
on failure
@spec recipients_put_recipient_document_visibility( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.DocumentVisibilityList.t()} | {:error, Tesla.Env.t()}
Updates document visibility for a recipient This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipient_id
(String.t): A local reference used to map recipients to other objects, such as specific document tabs. ArecipientId
must be either an integer or a GUID, and therecipientId
must be unique within an envelope. For example, many envelopes assign the first recipient arecipientId
of1
.opts
(keyword): Optional parameters:body
(DocumentVisibilityList):
Returns
{:ok, DocuSign.Model.DocumentVisibilityList.t}
on success{:error, Tesla.Env.t}
on failure
@spec recipients_put_recipients_document_visibility( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.DocumentVisibilityList.t()} | {:error, Tesla.Env.t()}
Updates document visibility for recipients
This method updates document visibility for one or more recipients based on the recipientId
and visible
values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts
(keyword): Optional parameters:body
(DocumentVisibilityList):
Returns
{:ok, DocuSign.Model.DocumentVisibilityList.t}
on success{:error, Tesla.Env.t}
on failure