docusign

# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

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

  alias DocuSign.Connection
  import DocuSign.RequestBuilder

  @doc """
  Returns document visibility for the recipients


  ## Parameters

  - connection (DocuSign.Connection): Connection to server
  - account_id (String.t): The external account number (int) or account ID Guid.
  - recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  - template_id (String.t): The ID of the template being accessed.
  - opts (KeywordList): [optional] Optional parameters

  ## Returns

  {:ok, %DocuSign.Model.EnvelopeDocumentVisibility{}} on success
  {:error, info} on failure
  """
  @spec recipients_get_template_recipient_document_visibility(
          Tesla.Env.client(),
          String.t(),
          String.t(),
          String.t(),
          keyword()
        ) :: {:ok, DocuSign.Model.EnvelopeDocumentVisibility.t()} | {:error, Tesla.Env.t()}
  def recipients_get_template_recipient_document_visibility(
        connection,
        account_id,
        recipient_id,
        template_id,
        _opts \\ []
      ) do
    %{}
    |> method(:get)
    |> url(
      "/v2/accounts/#{account_id}/templates/#{template_id}/recipients/#{recipient_id}/document_visibility"
    )
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.EnvelopeDocumentVisibility{})
  end

  @doc """
  Updates document visibility for the recipients


  ## Parameters

  - connection (DocuSign.Connection): Connection to server
  - account_id (String.t): The external account number (int) or account ID Guid.
  - recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  - template_id (String.t): The ID of the template being accessed.
  - opts (KeywordList): [optional] Optional parameters
    - :template_document_visibility (TemplateDocumentVisibility): 

  ## Returns

  {:ok, %DocuSign.Model.TemplateDocumentVisibility{}} on success
  {:error, info} on failure
  """
  @spec recipients_put_template_recipient_document_visibility(
          Tesla.Env.client(),
          String.t(),
          String.t(),
          String.t(),
          keyword()
        ) :: {:ok, DocuSign.Model.TemplateDocumentVisibility.t()} | {:error, Tesla.Env.t()}
  def recipients_put_template_recipient_document_visibility(
        connection,
        account_id,
        recipient_id,
        template_id,
        opts \\ []
      ) do
    optional_params = %{
      TemplateDocumentVisibility: :body
    }

    %{}
    |> method(:put)
    |> url(
      "/v2/accounts/#{account_id}/templates/#{template_id}/recipients/#{recipient_id}/document_visibility"
    )
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.TemplateDocumentVisibility{})
  end

  @doc """
  Updates document visibility for the recipients


  ## 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 being accessed.
  - opts (KeywordList): [optional] Optional parameters
    - :template_document_visibility (TemplateDocumentVisibility): 

  ## Returns

  {:ok, %DocuSign.Model.TemplateDocumentVisibility{}} on success
  {:error, info} on failure
  """
  @spec recipients_put_template_recipients_document_visibility(
          Tesla.Env.client(),
          String.t(),
          String.t(),
          keyword()
        ) :: {:ok, DocuSign.Model.TemplateDocumentVisibility.t()} | {:error, Tesla.Env.t()}
  def recipients_put_template_recipients_document_visibility(
        connection,
        account_id,
        template_id,
        opts \\ []
      ) do
    optional_params = %{
      TemplateDocumentVisibility: :body
    }

    %{}
    |> method(:put)
    |> url("/v2/accounts/#{account_id}/templates/#{template_id}/recipients/document_visibility")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DocuSign.Model.TemplateDocumentVisibility{})
  end
end