DocuSign.Api.UserSignatures.user_signatures_delete_user_signature_image

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

user_signatures_delete_user_signature_image(connection, account_id, image_type, signature_id, user_id, opts \\ [])

View Source

Specs

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

Deletes the user initials image or the user signature image for the specified user. Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • image_type (String.t): One of signature_image or initials_image.
  • signature_id (String.t): The ID of the signature being accessed.
  • user_id (String.t): The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure