docusign

# NOTE: This file is auto generated by OpenAPI Generator
# https://openapi-generator.tech
# Do not edit this file manually.

defmodule DocuSign.Api.TemplateResponsiveHtmlPreview do
  @moduledoc """
  API calls for all endpoints tagged `TemplateResponsiveHtmlPreview`.
  """

  import DocuSign.RequestBuilder

  alias DocuSign.Connection
  alias DocuSign.Model.DocumentHtmlDefinitions
  alias DocuSign.Model.ErrorDetails

  @doc """
  Creates a preview of the responsive versions of all of the documents associated with a template.
  Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. 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.
  - `template_id` (String.t): The ID of the template.
  - `opts` (keyword): Optional parameters
    - `:body` (DocumentHtmlDefinition): 

  ### Returns

  - `{:ok, DocuSign.Model.DocumentHtmlDefinitions.t}` on success
  - `{:error, Req.Response.t}` on failure
  """
  @spec responsive_html_post_template_responsive_html_preview(
          DocuSign.Connection.t(),
          String.t(),
          String.t(),
          keyword()
        ) ::
          {:ok, DocumentHtmlDefinitions.t()}
          | {:error, Req.Response.t()}
  def responsive_html_post_template_responsive_html_preview(connection, account_id, template_id, opts \\ []) do
    optional_params = %{
      :body => :body
    }

    request =
      %{}
      |> method(:post)
      |> url("/v2.1/accounts/#{account_id}/templates/#{template_id}/responsive_html_preview")
      |> add_optional_params(optional_params, opts)
      |> ensure_body()
      |> Enum.to_list()

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {201, DocumentHtmlDefinitions},
      {400, ErrorDetails}
    ])
  end
end