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

API calls for all endpoints tagged TemplateLocks.

Link to this section Summary

Functions

Deletes a template lock. Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field 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 a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to true for the user).

Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. 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

Link to this function

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

View Source

Specs

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

Deletes a template lock. Deletes the lock from the specified template. 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :lock_request (LockRequest):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets template lock information. Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Lock a template. Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :lock_request (LockRequest):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Updates a template lock. Updates the lock duration time or update the `lockedByApp` property information for the specified template. 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :lock_request (LockRequest):

Returns

} on success {:error, info} on failure