DocuSign v0.1.2 DocuSign.Api.TemplateDocuments View Source
API calls for all endpoints tagged TemplateDocuments
.
Link to this section Summary
Functions
Deletes documents from a template. Deletes one or more documents from an existing template
Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template
Adds a document to a template document. Adds the specified document to an existing template document
Adds documents to a template document. Adds one or more documents to an existing template document
Link to this section Functions
documents_delete_template_documents( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateDocuments.t()} | {:error, Tesla.Env.t()}
Deletes documents from a template. Deletes one or more documents from an existing template.
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
- :envelope_definition (EnvelopeDefinition):
Returns
{:ok, %DocuSign.Model.TemplateDocuments{}} on success {:error, info} on failure
documents_get_template_document( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, String.t()} | {:error, Tesla.Env.t()}
Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- document_id (String.t): The ID of the document being accessed.
- template_id (String.t): The ID of the template being accessed.
opts (KeywordList): [optional] Optional parameters
- :encrypt (String.t):
- :show_changes (String.t):
Returns
{:ok, %DocuSign.Model.String.t{}} on success {:error, info} on failure
documents_get_template_documents( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateDocuments.t()} | {:error, Tesla.Env.t()}
Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template.
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
Returns
{:ok, %DocuSign.Model.TemplateDocuments{}} on success {:error, info} on failure
documents_put_template_document( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.EnvelopeDocument.t()} | {:error, Tesla.Env.t()}
Adds a document to a template document. Adds the specified document to an existing template document.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- document_id (String.t): The ID of the document being accessed.
- template_id (String.t): The ID of the template being accessed.
opts (KeywordList): [optional] Optional parameters
- :apply_document_fields (String.t): When true, document fields can be added or modified while adding or modifying envelope documents.
- :is_envelope_definition (String.t):
- :envelope_definition (EnvelopeDefinition):
Returns
{:ok, %DocuSign.Model.EnvelopeDocument{}} on success {:error, info} on failure
documents_put_template_documents( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateDocuments.t()} | {:error, Tesla.Env.t()}
Adds documents to a template document. Adds one or more documents to an existing template document.
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
- :apply_document_fields (String.t): When true, document fields can be added or modified while adding or modifying envelope documents.
- :persist_tabs (String.t):
- :envelope_definition (EnvelopeDefinition):
Returns
{:ok, %DocuSign.Model.TemplateDocuments{}} on success {:error, info} on failure