DocuSign.Api.Uncategorized (DocuSign v0.3.3) View Source

API calls for all endpoints tagged Uncategorized.

Link to this section Summary

Functions

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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :encoding (String.t):

Returns

} on success {:error, info} on failure

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • transaction_id (String.t): Specifies the Transaction ID from the AppStore.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • transaction_id (String.t): Specifies the Transaction ID from the AppStore.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_publish_request (EnvelopePublishRequest):

Returns

} on success {:error, info} on failure

Parameters

  • connection (DocuSign.Connection): Connection to server
  • organization_id (String.t):
  • result_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

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.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

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
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

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
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

Link to this section Functions

Link to this function

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

View Source

Specs

comments_get_comments_transcript(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :encoding (String.t):

Returns

} on success {:error, info} on failure

Link to this function

envelope_publish_get_envelope_publish_transaction_list(connection, account_id, opts \\ [])

View Source

Specs

envelope_publish_get_envelope_publish_transaction_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopePublishTransactionList.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

envelope_publish_get_envelope_publish_transaction_meta_data(connection, account_id, transaction_id, opts \\ [])

View Source

Specs

envelope_publish_get_envelope_publish_transaction_meta_data(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopePublishTransaction.t()} | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • transaction_id (String.t): Specifies the Transaction ID from the AppStore.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

envelope_publish_get_envelope_publish_transaction_results(connection, account_id, transaction_id, opts \\ [])

View Source

Specs

envelope_publish_get_envelope_publish_transaction_results(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • transaction_id (String.t): Specifies the Transaction ID from the AppStore.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

envelope_publish_post_envelope_publish_transaction(connection, account_id, opts \\ [])

View Source

Specs

envelope_publish_post_envelope_publish_transaction(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopePublishTransaction.t()} | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_publish_request (EnvelopePublishRequest):

Returns

} on success {:error, info} on failure

Link to this function

organization_exports_get_account_settings_export(connection, organization_id, result_id, opts \\ [])

View Source

Specs

organization_exports_get_account_settings_export(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • organization_id (String.t):
  • result_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

responsive_html_post_document_responsive_html_preview(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

responsive_html_post_document_responsive_html_preview(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.DocumentHtmlDefinitions.t()} | {:error, Tesla.Env.t()}

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.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

Link to this function

responsive_html_post_template_document_responsive_html_preview(connection, account_id, document_id, template_id, opts \\ [])

View Source

Specs

responsive_html_post_template_document_responsive_html_preview(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.DocumentHtmlDefinitions.t()} | {:error, Tesla.Env.t()}

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
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure

Link to this function

responsive_html_post_template_responsive_html_preview(connection, account_id, template_id, opts \\ [])

View Source

Specs

responsive_html_post_template_responsive_html_preview(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.DocumentHtmlDefinitions.t()} | {:error, Tesla.Env.t()}

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
    • :document_html_definition (DocumentHtmlDefinition):

Returns

} on success {:error, info} on failure