DocuSign.Api.EnvelopeLocks.lock_get_envelope_lock

You're seeing just the function lock_get_envelope_lock, go back to DocuSign.Api.EnvelopeLocks module for more information.
Link to this function

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

View Source

Specs

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

Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.

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

Returns

} on success {:error, info} on failure