View Source DocuSign.Api.ResponsiveHtmlPreview (DocuSign v1.2.0)

API calls for all endpoints tagged ResponsiveHtmlPreview.

Summary

Functions

Creates a preview of the responsive versions of all of the documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Functions

Link to this function

responsive_html_post_responsive_html_preview(connection, account_id, envelope_id, opts \\ [])

View Source
@spec responsive_html_post_responsive_html_preview(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.DocumentHtmlDefinitions.t()}
  | {:error, Tesla.Env.t()}

Creates a preview of the responsive versions of all of the documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_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 (DocumentHtmlDefinition):

Returns

  • {:ok, DocuSign.Model.DocumentHtmlDefinitions.t} on success
  • {:error, Tesla.Env.t} on failure