Source: schemas/sign-request.generated.ts

  1. import * as schemas from '.';
  2. /**
  3.  * Box Sign request
  4.  *
  5.  * A Box Sign request object.
  6.  */
  7. export interface SignRequest extends schemas.SignRequestBase {
  8. 	/**
  9. 	 * object type
  10. 	 * Example: sign-request
  11. 	 */
  12. 	type?: 'sign-request';
  13. 	/**
  14. 	 * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
  15. 	 */
  16. 	source_files?: schemas.FileBase[];
  17. 	/**
  18. 	 * Array of signers for the signature request.
  19. 	 */
  20. 	signers?: schemas.SignRequestSigner[];
  21. 	/**
  22. 	 * Force a specific color for the signature (blue, black, or red).
  23. 	 * Example: blue
  24. 	 */
  25. 	signature_color?: string;
  26. 	/**
  27. 	 * Box Sign request ID.
  28. 	 * Example: 12345
  29. 	 */
  30. 	id?: string;
  31. 	/**
  32. 	 * This URL is returned if `is_document_preparation_needed` is
  33. 	 * set to `true` in the request. The parameter is used to prepare
  34. 	 * the signature request
  35. 	 * using the UI. The signature request is not
  36. 	 * sent until the preparation
  37. 	 * phase is complete.
  38. 	 * Example: https://prepareurl.com
  39. 	 */
  40. 	prepare_url?: string;
  41. 	/**
  42. 	 * Reference to a file that holds a log of all signer activity for
  43. 	 * the request.
  44. 	 */
  45. 	signing_log?: schemas.FileMini;
  46. 	/**
  47. 	 * Describes the status of the signature request.
  48. 	 * Example: converting
  49. 	 */
  50. 	status?:
  51. 		| 'converting'
  52. 		| 'created'
  53. 		| 'sent'
  54. 		| 'viewed'
  55. 		| 'signed'
  56. 		| 'cancelled'
  57. 		| 'declined'
  58. 		| 'error_converting'
  59. 		| 'error_sending'
  60. 		| 'expired'
  61. 		| 'finalizing'
  62. 		| 'error_finalizing';
  63. 	/**
  64. 	 * List of files that will be signed, which are copies of the original
  65. 	 * source files. A new version of these files are created as signers sign
  66. 	 * and can be downloaded at any point in the signing process.
  67. 	 */
  68. 	sign_files?: object;
  69. 	/**
  70. 	 * Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.
  71. 	 * Example: 2021-04-26T08:12:13.982Z
  72. 	 */
  73. 	auto_expire_at?: string;
  74. 	/**
  75. 	 * The destination folder to place final, signed document and signing
  76. 	 * log.
  77. 	 *
  78. 	 * When this value was not passed in when the signature request was
  79. 	 * created, then we will use a default folder which is either the parent
  80. 	 * folder of the first source file in the payload if we have the permission
  81. 	 * to upload to that folder or a folder called "My Sign Requests".
  82. 	 */
  83. 	parent_folder?: schemas.FolderMini;
  84. }