Source: schemas/template-signer.generated.ts

  1. import * as schemas from '.';
  2. /**
  3.  * Signer fields for Templates
  4.  *
  5.  * The schema for a Signer for Templates
  6.  */
  7. export interface TemplateSigner {
  8. 	inputs?: schemas.TemplateSignerInput[];
  9. 	/**
  10. 	 * Email address of the signer
  11. 	 * Example: example@mail.com
  12. 	 */
  13. 	email?: string;
  14. 	/**
  15. 	 * Defines the role of the signer in the signature request. A role of
  16. 	 * `signer` needs to sign the document, a role `approver`
  17. 	 * approves the document and
  18. 	 * a `final_copy_reader` role only
  19. 	 * receives the final signed document and signing log.
  20. 	 * Example: signer
  21. 	 * @default signer
  22. 	 */
  23. 	role?: 'signer' | 'approver' | 'final_copy_reader';
  24. 	/**
  25. 	 * Used in combination with an embed URL for a sender.
  26. 	 * After the sender signs, they will be
  27. 	 * redirected to the next `in_person` signer.
  28. 	 * Example: true
  29. 	 */
  30. 	is_in_person?: boolean;
  31. 	/**
  32. 	 * Order of the signer
  33. 	 * Example: 2
  34. 	 */
  35. 	order?: number;
  36. 	/**
  37. 	 * If provided, this value points signers that are assigned the same inputs and belongs to same signer group.
  38. 	 * A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used
  39. 	 * within Box Sign requests created from it.
  40. 	 * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
  41. 	 */
  42. 	signer_group_id?: string;
  43. }