View Source DocuSign.Api.AccountWatermarks (DocuSign v1.2.0)
API calls for all endpoints tagged AccountWatermarks
.
Summary
Functions
Get watermark information. Enables you to preview a watermark specified by the request.
Get watermark preview. Update the watermark for the account. Note: Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.
Update watermark information. Returns information about the watermark for the account.
Functions
@spec watermark_get_watermark(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.Watermark.t()} | {:error, Tesla.Env.t()}
Get watermark information. Enables you to preview a watermark specified by the request.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.Watermark.t}
on success{:error, Tesla.Env.t}
on failure
watermark_preview_put_watermark_preview(connection, account_id, opts \\ [])
View Source@spec watermark_preview_put_watermark_preview( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.Watermark.t()} | {:error, Tesla.Env.t()}
Get watermark preview. Update the watermark for the account. Note: Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:body
(Watermark): When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.
Returns
{:ok, DocuSign.Model.Watermark.t}
on success{:error, Tesla.Env.t}
on failure
@spec watermark_put_watermark(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.Watermark.t()} | {:error, Tesla.Env.t()}
Update watermark information. Returns information about the watermark for the account.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:body
(Watermark): When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.
Returns
{:ok, DocuSign.Model.Watermark.t}
on success{:error, Tesla.Env.t}
on failure