DocuSign v0.2.4 DocuSign.Api.EnvelopeLocks View Source
API calls for all endpoints tagged `EnvelopeLocks`.
Link to this section Summary
Functions
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
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.
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
Link to this section Functions
lock_delete_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Sourcelock_delete_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
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
{:ok, %DocuSign.Model.EnvelopeLocks{}} on success {:error, info} on failure
lock_get_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Sourcelock_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
{:ok, %DocuSign.Model.EnvelopeLocks{}} on success {:error, info} on failure
lock_post_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Sourcelock_post_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
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
- :lock_request (LockRequest):
Returns
{:ok, %DocuSign.Model.EnvelopeLocks{}} on success {:error, info} on failure
lock_put_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Sourcelock_put_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
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
- :lock_request (LockRequest):
Returns
{:ok, %DocuSign.Model.EnvelopeLocks{}} on success {:error, info} on failure