docspring 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +4 -1
  3. package/dist/ApiClient.js +2 -2
  4. package/dist/RequestSchemas.js +75 -8
  5. package/dist/WebhookSignature.js +86 -0
  6. package/dist/api/Client.js +147 -15
  7. package/dist/index.js +42 -0
  8. package/dist/model/AddTemplateFieldsRequest.js +1 -1
  9. package/dist/model/AuthenticationCheck.js +1 -1
  10. package/dist/model/CombinedPdf.js +3 -3
  11. package/dist/model/CombinedPdfFiles.js +1 -1
  12. package/dist/model/CombinedPdfList.js +1 -1
  13. package/dist/model/CombinedPdfSource.js +1 -1
  14. package/dist/model/CombinedPdfSourceInput.js +1 -1
  15. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  16. package/dist/model/CopyTemplateRequest.js +1 -1
  17. package/dist/model/CreateCombinedPdfRequest.js +2 -2
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateFolderRequest.js +1 -1
  20. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  21. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  22. package/dist/model/CreateSubmissionBatchRequest.js +1 -1
  23. package/dist/model/CreateSubmissionRequest.js +3 -3
  24. package/dist/model/CreateTemplatePreviewRequest.js +112 -0
  25. package/dist/model/CreateTemplateRequest.js +11 -2
  26. package/dist/model/CreateWebhookRequest.js +1 -1
  27. package/dist/model/CustomFile.js +1 -1
  28. package/dist/model/CustomFileList.js +1 -1
  29. package/dist/model/CustomFileSourcePdf.js +1 -1
  30. package/dist/model/ErrorCode.js +11 -1
  31. package/dist/model/ErrorDetail.js +2 -2
  32. package/dist/model/ErrorInfo.js +6 -6
  33. package/dist/model/ErrorResponse.js +1 -1
  34. package/dist/model/Field.js +1 -1
  35. package/dist/model/FieldComparisonCondition.js +1 -1
  36. package/dist/model/FieldDependency.js +1 -1
  37. package/dist/model/FieldDependencyInput.js +1 -1
  38. package/dist/model/FieldEqualsCondition.js +1 -1
  39. package/dist/model/FieldGroup.js +1 -1
  40. package/dist/model/FieldGroupInput.js +1 -1
  41. package/dist/model/FieldInCondition.js +1 -1
  42. package/dist/model/FieldInput.js +1 -1
  43. package/dist/model/FieldOverride.js +1 -1
  44. package/dist/model/FieldPresenceCondition.js +1 -1
  45. package/dist/model/FieldRangeCondition.js +1 -1
  46. package/dist/model/Folder.js +1 -1
  47. package/dist/model/FolderList.js +1 -1
  48. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  49. package/dist/model/GeneratedFile.js +1 -1
  50. package/dist/model/HtmlEngineOptions.js +1 -1
  51. package/dist/model/HtmlEngineOptionsInput.js +1 -1
  52. package/dist/model/MoveFolderRequest.js +1 -1
  53. package/dist/model/MoveTemplateRequest.js +1 -1
  54. package/dist/model/PageImage.js +1 -1
  55. package/dist/model/PageImages.js +1 -1
  56. package/dist/model/PredefinedField.js +1 -1
  57. package/dist/model/PredefinedFieldInput.js +1 -1
  58. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  59. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  60. package/dist/model/RenameFolderRequest.js +1 -1
  61. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  62. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  63. package/dist/model/SignatureRequest.js +1 -1
  64. package/dist/model/SignatureRequestEvent.js +1 -1
  65. package/dist/model/SignatureRequestInput.js +1 -1
  66. package/dist/model/SignatureRequestToken.js +1 -1
  67. package/dist/model/Submission.js +75 -75
  68. package/dist/model/SubmissionAction.js +1 -1
  69. package/dist/model/SubmissionBatch.js +1 -1
  70. package/dist/model/SubmissionFiles.js +1 -1
  71. package/dist/model/SubmissionInput.js +3 -3
  72. package/dist/model/SubmissionList.js +5 -5
  73. package/dist/model/SubmissionSourcePdf.js +1 -1
  74. package/dist/model/SubmissionSummary.js +343 -0
  75. package/dist/model/SubmissionValidation.js +1 -1
  76. package/dist/model/Template.js +68 -57
  77. package/dist/model/TemplateActor.js +3 -3
  78. package/dist/model/TemplateDefaults.js +1 -1
  79. package/dist/model/TemplateDefaultsInput.js +1 -1
  80. package/dist/model/TemplateDiff.js +1 -1
  81. package/dist/model/TemplateDiffSummary.js +1 -1
  82. package/dist/model/TemplateDocument.js +33 -33
  83. package/dist/model/TemplateDocumentSummary.js +152 -0
  84. package/dist/model/TemplateFieldChange.js +1 -1
  85. package/dist/model/TemplateFieldChanges.js +1 -1
  86. package/dist/model/TemplateFieldDependency.js +1 -1
  87. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  88. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  89. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  90. package/dist/model/TemplateFieldMove.js +1 -1
  91. package/dist/model/TemplateFields.js +1 -1
  92. package/dist/model/TemplateModelCode.js +1 -1
  93. package/dist/model/TemplatePageImages.js +1 -1
  94. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  95. package/dist/model/TemplatePreview.js +211 -0
  96. package/dist/model/TemplatePreviewState.js +64 -0
  97. package/dist/model/TemplateSourcePdf.js +1 -1
  98. package/dist/model/TemplateSummary.js +14 -288
  99. package/dist/model/TemplateSummaryList.js +1 -1
  100. package/dist/model/TemplateVersion.js +1 -1
  101. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  102. package/dist/model/UpdateTemplateDocumentRequest.js +1 -1
  103. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  104. package/dist/model/UpdateTemplateRequest.js +11 -2
  105. package/dist/model/UpdateWebhookRequest.js +1 -1
  106. package/dist/model/UploadPresign.js +1 -1
  107. package/dist/model/UrlSourcePdf.js +1 -1
  108. package/dist/model/ValidateSubmissionRequest.js +3 -3
  109. package/dist/model/Webhook.js +1 -1
  110. package/dist/model/WebhookList.js +1 -1
  111. package/package.json +3 -2
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The ReorderTemplateFieldsRequest model module.
31
31
  * @module model/ReorderTemplateFieldsRequest
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var ReorderTemplateFieldsRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The RestoreTemplateVersionRequest model module.
31
31
  * @module model/RestoreTemplateVersionRequest
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var RestoreTemplateVersionRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The SignatureRequest model module.
34
34
  * @module model/SignatureRequest
35
- * @version 4.1.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var SignatureRequest = /*#__PURE__*/function () {
38
38
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The SignatureRequestEvent model module.
33
33
  * @module model/SignatureRequestEvent
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var SignatureRequestEvent = /*#__PURE__*/function () {
37
37
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The SignatureRequestInput model module.
33
33
  * @module model/SignatureRequestInput
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var SignatureRequestInput = /*#__PURE__*/function () {
37
37
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The SignatureRequestToken model module.
32
32
  * @module model/SignatureRequestToken
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var SignatureRequestToken = /*#__PURE__*/function () {
36
36
  /**
@@ -37,7 +37,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
37
37
  /**
38
38
  * The Submission model module.
39
39
  * @module model/Submission
40
- * @version 4.1.0
40
+ * @version 4.2.0
41
41
  */
42
42
  var Submission = /*#__PURE__*/function () {
43
43
  /**
@@ -54,26 +54,26 @@ var Submission = /*#__PURE__*/function () {
54
54
  * @param state {module:model/SubmissionState} `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
55
55
  * @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
56
56
  * @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
57
- * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
57
+ * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
58
58
  * @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
59
59
  * @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
60
- * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
61
- * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
62
- * @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
63
- * @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
64
- * @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
65
- * @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
60
+ * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
66
61
  * @param files {module:model/SubmissionFiles} The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
67
- * @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
68
62
  * @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
69
63
  * @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
70
64
  * @param processed_at {Date} When the PDF was generated. Null until then.
71
65
  * @param created_at {Date} When the submission was created.
72
66
  * @param updated_at {Date} When the submission was last updated.
67
+ * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
68
+ * @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
69
+ * @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
70
+ * @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
71
+ * @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
72
+ * @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
73
73
  */
74
- function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
74
+ function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
75
75
  _classCallCheck(this, Submission);
76
- Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at);
76
+ Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at);
77
77
  }
78
78
 
79
79
  /**
@@ -83,7 +83,7 @@ var Submission = /*#__PURE__*/function () {
83
83
  */
84
84
  return _createClass(Submission, null, [{
85
85
  key: "initialize",
86
- value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
86
+ value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
87
87
  obj['id'] = id;
88
88
  obj['template_id'] = template_id;
89
89
  obj['template_type'] = template_type;
@@ -97,18 +97,18 @@ var Submission = /*#__PURE__*/function () {
97
97
  obj['data_errors'] = data_errors;
98
98
  obj['error_message'] = error_message;
99
99
  obj['metadata'] = metadata;
100
- obj['has_password'] = has_password;
101
- obj['signature_requests'] = signature_requests;
102
- obj['actions'] = actions;
103
- obj['truncated_text'] = truncated_text;
104
- obj['output_formats'] = output_formats;
105
100
  obj['files'] = files;
106
- obj['preview_generated_at'] = preview_generated_at;
107
101
  obj['expired'] = expired;
108
102
  obj['expires_at'] = expires_at;
109
103
  obj['processed_at'] = processed_at;
110
104
  obj['created_at'] = created_at;
111
105
  obj['updated_at'] = updated_at;
106
+ obj['has_password'] = has_password;
107
+ obj['signature_requests'] = signature_requests;
108
+ obj['actions'] = actions;
109
+ obj['truncated_text'] = truncated_text;
110
+ obj['output_formats'] = output_formats;
111
+ obj['preview_generated_at'] = preview_generated_at;
112
112
  }
113
113
 
114
114
  /**
@@ -167,6 +167,24 @@ var Submission = /*#__PURE__*/function () {
167
167
  'String': Object
168
168
  });
169
169
  }
170
+ if (data.hasOwnProperty('files')) {
171
+ obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
172
+ }
173
+ if (data.hasOwnProperty('expired')) {
174
+ obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
175
+ }
176
+ if (data.hasOwnProperty('expires_at')) {
177
+ obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
178
+ }
179
+ if (data.hasOwnProperty('processed_at')) {
180
+ obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'Date');
181
+ }
182
+ if (data.hasOwnProperty('created_at')) {
183
+ obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
184
+ }
185
+ if (data.hasOwnProperty('updated_at')) {
186
+ obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
187
+ }
170
188
  if (data.hasOwnProperty('has_password')) {
171
189
  obj['has_password'] = _ApiClient["default"].convertToType(data['has_password'], 'Boolean');
172
190
  }
@@ -184,27 +202,9 @@ var Submission = /*#__PURE__*/function () {
184
202
  if (data.hasOwnProperty('output_formats')) {
185
203
  obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
186
204
  }
187
- if (data.hasOwnProperty('files')) {
188
- obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
189
- }
190
205
  if (data.hasOwnProperty('preview_generated_at')) {
191
206
  obj['preview_generated_at'] = _ApiClient["default"].convertToType(data['preview_generated_at'], 'Date');
192
207
  }
193
- if (data.hasOwnProperty('expired')) {
194
- obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
195
- }
196
- if (data.hasOwnProperty('expires_at')) {
197
- obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
198
- }
199
- if (data.hasOwnProperty('processed_at')) {
200
- obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'Date');
201
- }
202
- if (data.hasOwnProperty('created_at')) {
203
- obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
204
- }
205
- if (data.hasOwnProperty('updated_at')) {
206
- obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
207
- }
208
208
  }
209
209
  return obj;
210
210
  }
@@ -272,7 +272,7 @@ var Submission = /*#__PURE__*/function () {
272
272
  }
273
273
  }]);
274
274
  }();
275
- Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "has_password", "signature_requests", "actions", "truncated_text", "output_formats", "files", "preview_generated_at", "expired", "expires_at", "processed_at", "created_at", "updated_at"];
275
+ Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "files", "expired", "expires_at", "processed_at", "created_at", "updated_at", "has_password", "signature_requests", "actions", "truncated_text", "output_formats", "preview_generated_at"];
276
276
 
277
277
  /**
278
278
  * The submission's ID.
@@ -329,7 +329,7 @@ Submission.prototype['test'] = undefined;
329
329
  Submission.prototype['editable'] = undefined;
330
330
 
331
331
  /**
332
- * The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
332
+ * The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
333
333
  * @member {Object.<String, Object>} data
334
334
  */
335
335
  Submission.prototype['data'] = undefined;
@@ -347,53 +347,17 @@ Submission.prototype['data_errors'] = undefined;
347
347
  Submission.prototype['error_message'] = undefined;
348
348
 
349
349
  /**
350
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
350
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
351
351
  * @member {Object.<String, Object>} metadata
352
352
  */
353
353
  Submission.prototype['metadata'] = undefined;
354
354
 
355
- /**
356
- * Whether the PDF needs a password to open (`password`).
357
- * @member {Boolean} has_password
358
- */
359
- Submission.prototype['has_password'] = undefined;
360
-
361
- /**
362
- * The people asked to sign the submission (and fill in their fields), in order.
363
- * @member {Array.<module:model/SignatureRequest>} signature_requests
364
- */
365
- Submission.prototype['signature_requests'] = undefined;
366
-
367
- /**
368
- * The uploads of the submission's PDF to your storage (account integrations).
369
- * @member {Array.<module:model/SubmissionAction>} actions
370
- */
371
- Submission.prototype['actions'] = undefined;
372
-
373
- /**
374
- * The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
375
- * @member {Object.<String, Array.<String>>} truncated_text
376
- */
377
- Submission.prototype['truncated_text'] = undefined;
378
-
379
- /**
380
- * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
381
- * @member {Array.<module:model/OutputFormat>} output_formats
382
- */
383
- Submission.prototype['output_formats'] = undefined;
384
-
385
355
  /**
386
356
  * The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
387
357
  * @member {module:model/SubmissionFiles} files
388
358
  */
389
359
  Submission.prototype['files'] = undefined;
390
360
 
391
- /**
392
- * When the preview PDF was generated. Null if there is no preview.
393
- * @member {Date} preview_generated_at
394
- */
395
- Submission.prototype['preview_generated_at'] = undefined;
396
-
397
361
  /**
398
362
  * An expired submission's data, metadata, password and PDF have been deleted.
399
363
  * @member {Boolean} expired
@@ -423,4 +387,40 @@ Submission.prototype['created_at'] = undefined;
423
387
  * @member {Date} updated_at
424
388
  */
425
389
  Submission.prototype['updated_at'] = undefined;
390
+
391
+ /**
392
+ * Whether the PDF needs a password to open (`password`).
393
+ * @member {Boolean} has_password
394
+ */
395
+ Submission.prototype['has_password'] = undefined;
396
+
397
+ /**
398
+ * The people asked to sign the submission (and fill in their fields), in order.
399
+ * @member {Array.<module:model/SignatureRequest>} signature_requests
400
+ */
401
+ Submission.prototype['signature_requests'] = undefined;
402
+
403
+ /**
404
+ * The uploads of the submission's PDF to your storage (account integrations).
405
+ * @member {Array.<module:model/SubmissionAction>} actions
406
+ */
407
+ Submission.prototype['actions'] = undefined;
408
+
409
+ /**
410
+ * The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
411
+ * @member {Object.<String, Array.<String>>} truncated_text
412
+ */
413
+ Submission.prototype['truncated_text'] = undefined;
414
+
415
+ /**
416
+ * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
417
+ * @member {Array.<module:model/OutputFormat>} output_formats
418
+ */
419
+ Submission.prototype['output_formats'] = undefined;
420
+
421
+ /**
422
+ * When the preview PDF was generated. Null if there is no preview.
423
+ * @member {Date} preview_generated_at
424
+ */
425
+ Submission.prototype['preview_generated_at'] = undefined;
426
426
  var _default = exports["default"] = Submission;
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The SubmissionAction model module.
33
33
  * @module model/SubmissionAction
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var SubmissionAction = /*#__PURE__*/function () {
37
37
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The SubmissionBatch model module.
33
33
  * @module model/SubmissionBatch
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var SubmissionBatch = /*#__PURE__*/function () {
37
37
  /**
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
28
  /**
29
29
  * The SubmissionFiles model module.
30
30
  * @module model/SubmissionFiles
31
- * @version 4.1.0
31
+ * @version 4.2.0
32
32
  */
33
33
  var SubmissionFiles = /*#__PURE__*/function () {
34
34
  /**
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
28
  /**
29
29
  * The SubmissionInput model module.
30
30
  * @module model/SubmissionInput
31
- * @version 4.1.0
31
+ * @version 4.2.0
32
32
  */
33
33
  var SubmissionInput = /*#__PURE__*/function () {
34
34
  /**
@@ -163,7 +163,7 @@ SubmissionInput.prototype['editable'] = undefined;
163
163
  SubmissionInput.prototype['data'] = undefined;
164
164
 
165
165
  /**
166
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
166
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
167
167
  * @member {Object.<String, Object>} metadata
168
168
  */
169
169
  SubmissionInput.prototype['metadata'] = undefined;
@@ -199,7 +199,7 @@ SubmissionInput.prototype['field_overrides'] = undefined;
199
199
  SubmissionInput.prototype['html'] = undefined;
200
200
 
201
201
  /**
202
- * For an HTML template, CSS to use instead of the template's.
202
+ * For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
203
203
  * @member {String} css
204
204
  */
205
205
  SubmissionInput.prototype['css'] = undefined;
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _Submission = _interopRequireDefault(require("./Submission"));
8
+ var _SubmissionSummary = _interopRequireDefault(require("./SubmissionSummary"));
9
9
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
10
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
11
11
  function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The SubmissionList model module.
32
32
  * @module model/SubmissionList
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var SubmissionList = /*#__PURE__*/function () {
36
36
  /**
@@ -38,7 +38,7 @@ var SubmissionList = /*#__PURE__*/function () {
38
38
  * A page of submissions, newest first.
39
39
  * @alias module:model/SubmissionList
40
40
  * @extends Object
41
- * @param data {Array.<module:model/Submission>} The items on this page.
41
+ * @param data {Array.<module:model/SubmissionSummary>} The items on this page.
42
42
  * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
43
43
  */
44
44
  function SubmissionList(data, next_cursor) {
@@ -72,7 +72,7 @@ var SubmissionList = /*#__PURE__*/function () {
72
72
  obj = obj || new SubmissionList();
73
73
  _ApiClient["default"].constructFromObject(data, obj, 'Object');
74
74
  if (data.hasOwnProperty('data')) {
75
- obj['data'] = _ApiClient["default"].convertToType(data['data'], [_Submission["default"]]);
75
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], [_SubmissionSummary["default"]]);
76
76
  }
77
77
  if (data.hasOwnProperty('next_cursor')) {
78
78
  obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
@@ -120,7 +120,7 @@ SubmissionList.RequiredProperties = ["data", "next_cursor"];
120
120
 
121
121
  /**
122
122
  * The items on this page.
123
- * @member {Array.<module:model/Submission>} data
123
+ * @member {Array.<module:model/SubmissionSummary>} data
124
124
  */
125
125
  SubmissionList.prototype['data'] = undefined;
126
126
 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The SubmissionSourcePdf model module.
31
31
  * @module model/SubmissionSourcePdf
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var SubmissionSourcePdf = /*#__PURE__*/function () {
35
35
  /**