docspring 3.1.0 → 3.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 (62) hide show
  1. package/AGENTS.md +33 -0
  2. package/README.md +148 -215
  3. package/dist/ApiClient.js +2 -2
  4. package/dist/api/Client.js +1 -1
  5. package/dist/model/AddFieldsData.js +1 -1
  6. package/dist/model/BatchGeneratePdfs201Response.js +3 -6
  7. package/dist/model/CombinePdfsData.js +1 -1
  8. package/dist/model/CombinedSubmission.js +6 -21
  9. package/dist/model/CombinedSubmissionAction.js +3 -1
  10. package/dist/model/CopyTemplateOptions.js +1 -1
  11. package/dist/model/CreateCombinedSubmissionResponse.js +3 -6
  12. package/dist/model/CreateCustomFileData.js +1 -1
  13. package/dist/model/CreateCustomFileResponse.js +3 -6
  14. package/dist/model/CreateFolderData.js +1 -1
  15. package/dist/model/CreateHtmlTemplate.js +1 -1
  16. package/dist/model/CreatePdfSubmissionData.js +1 -1
  17. package/dist/model/CreatePdfTemplate.js +1 -1
  18. package/dist/model/CreateSubmissionDataRequestData.js +1 -1
  19. package/dist/model/CreateSubmissionDataRequestEventRequest.js +1 -1
  20. package/dist/model/CreateSubmissionDataRequestEventResponse.js +3 -6
  21. package/dist/model/CreateSubmissionDataRequestResponse.js +3 -6
  22. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +3 -6
  23. package/dist/model/CreateSubmissionResponse.js +3 -6
  24. package/dist/model/CreateWebhookData.js +1 -1
  25. package/dist/model/CustomFile.js +3 -1
  26. package/dist/model/ErrorOrMultipleErrorsResponse.js +3 -1
  27. package/dist/model/ErrorResponse.js +3 -1
  28. package/dist/model/Folder.js +3 -1
  29. package/dist/model/JsonSchema.js +1 -1
  30. package/dist/model/ListSubmissionsResponse.js +6 -21
  31. package/dist/model/MoveFolderData.js +1 -1
  32. package/dist/model/MoveTemplateData.js +1 -1
  33. package/dist/model/MultipleErrorsResponse.js +3 -1
  34. package/dist/model/PublishVersionData.js +1 -1
  35. package/dist/model/RenameFolderData.js +1 -1
  36. package/dist/model/RestoreVersionData.js +1 -1
  37. package/dist/model/Submission.js +9 -41
  38. package/dist/model/Submission422Response.js +3 -6
  39. package/dist/model/SubmissionAction.js +3 -1
  40. package/dist/model/SubmissionBatch.js +3 -1
  41. package/dist/model/SubmissionBatchData.js +1 -1
  42. package/dist/model/SubmissionBatchWithSubmissions.js +6 -21
  43. package/dist/model/SubmissionDataRequest.js +3 -1
  44. package/dist/model/SubmissionDataRequestEvent.js +3 -1
  45. package/dist/model/SubmissionDataRequestShow.js +3 -1
  46. package/dist/model/SubmissionDataRequestToken.js +3 -1
  47. package/dist/model/SubmissionPreview.js +9 -41
  48. package/dist/model/SuccessErrorResponse.js +3 -1
  49. package/dist/model/SuccessMultipleErrorsResponse.js +3 -1
  50. package/dist/model/Template.js +17 -5
  51. package/dist/model/TemplateAddFieldsResponse.js +3 -1
  52. package/dist/model/TemplateDeleteResponse.js +3 -1
  53. package/dist/model/TemplateModelCodeResponse.js +3 -1
  54. package/dist/model/TemplatePreview.js +17 -5
  55. package/dist/model/TemplatePublishVersionResponse.js +3 -1
  56. package/dist/model/UpdateHtmlTemplate.js +1 -1
  57. package/dist/model/UpdatePdfTemplate.js +1 -1
  58. package/dist/model/UpdateSubmissionDataRequestData.js +1 -1
  59. package/dist/model/UpdateWebhookData.js +1 -1
  60. package/dist/model/UploadPresignResponse.js +3 -1
  61. package/dist/model/Webhook.js +3 -1
  62. package/package.json +13 -3
@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplatePreview model module.
31
31
  * @module model/TemplatePreview
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var TemplatePreview = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>TemplatePreview</code>.
37
37
  * @alias module:model/TemplatePreview
38
+ * @extends Object
38
39
  * @param add_data_request_submission_id_footers {Boolean}
39
40
  * @param allow_additional_properties {Boolean}
40
41
  * @param description {String}
@@ -64,6 +65,7 @@ var TemplatePreview = /*#__PURE__*/function () {
64
65
  * @param page_count {Number}
65
66
  * @param page_dimensions {Array.<Array.<Number>>}
66
67
  * @param parent_folder_id {String}
68
+ * @param parse_dates_using_template_date_format {Boolean}
67
69
  * @param path {String}
68
70
  * @param permanent_document_url {String}
69
71
  * @param public_submissions {Boolean}
@@ -84,9 +86,9 @@ var TemplatePreview = /*#__PURE__*/function () {
84
86
  * @param last_changed_by_external_email {String}
85
87
  * @param last_changed_by_external_id {String}
86
88
  */
87
- function TemplatePreview(add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id) {
89
+ function TemplatePreview(add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, parse_dates_using_template_date_format, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id) {
88
90
  _classCallCheck(this, TemplatePreview);
89
- TemplatePreview.initialize(this, add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id);
91
+ TemplatePreview.initialize(this, add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, parse_dates_using_template_date_format, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id);
90
92
  }
91
93
 
92
94
  /**
@@ -96,7 +98,7 @@ var TemplatePreview = /*#__PURE__*/function () {
96
98
  */
97
99
  return _createClass(TemplatePreview, null, [{
98
100
  key: "initialize",
99
- value: function initialize(obj, add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id) {
101
+ value: function initialize(obj, add_data_request_submission_id_footers, allow_additional_properties, description, document_filename, document_md5, document_parse_error, document_processed, document_state, document_url, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs_password, encrypt_pdfs, expiration_interval, expire_after, expire_submissions, external_predefined_fields_template_id, external_predefined_fields_template_name, first_template, id, locked, merge_audit_trail_pdf, name, page_count, page_dimensions, parent_folder_id, parse_dates_using_template_date_format, path, permanent_document_url, public_submissions, public_web_form, redirect_url, slack_webhook_url, template_type, updated_at, version_published_at, version, webhook_url, demo, latest_version, last_changed_at, last_changed_by_type, last_changed_by_id, last_changed_by_external_name, last_changed_by_external_email, last_changed_by_external_id) {
100
102
  obj['add_data_request_submission_id_footers'] = add_data_request_submission_id_footers;
101
103
  obj['allow_additional_properties'] = allow_additional_properties;
102
104
  obj['description'] = description;
@@ -126,6 +128,7 @@ var TemplatePreview = /*#__PURE__*/function () {
126
128
  obj['page_count'] = page_count;
127
129
  obj['page_dimensions'] = page_dimensions;
128
130
  obj['parent_folder_id'] = parent_folder_id;
131
+ obj['parse_dates_using_template_date_format'] = parse_dates_using_template_date_format;
129
132
  obj['path'] = path;
130
133
  obj['permanent_document_url'] = permanent_document_url;
131
134
  obj['public_submissions'] = public_submissions;
@@ -159,6 +162,7 @@ var TemplatePreview = /*#__PURE__*/function () {
159
162
  value: function constructFromObject(data, obj) {
160
163
  if (data) {
161
164
  obj = obj || new TemplatePreview();
165
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
162
166
  if (data.hasOwnProperty('add_data_request_submission_id_footers')) {
163
167
  obj['add_data_request_submission_id_footers'] = _ApiClient["default"].convertToType(data['add_data_request_submission_id_footers'], 'Boolean');
164
168
  }
@@ -246,6 +250,9 @@ var TemplatePreview = /*#__PURE__*/function () {
246
250
  if (data.hasOwnProperty('parent_folder_id')) {
247
251
  obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
248
252
  }
253
+ if (data.hasOwnProperty('parse_dates_using_template_date_format')) {
254
+ obj['parse_dates_using_template_date_format'] = _ApiClient["default"].convertToType(data['parse_dates_using_template_date_format'], 'Boolean');
255
+ }
249
256
  if (data.hasOwnProperty('path')) {
250
257
  obj['path'] = _ApiClient["default"].convertToType(data['path'], 'String');
251
258
  }
@@ -461,7 +468,7 @@ var TemplatePreview = /*#__PURE__*/function () {
461
468
  }
462
469
  }]);
463
470
  }();
464
- TemplatePreview.RequiredProperties = ["add_data_request_submission_id_footers", "allow_additional_properties", "description", "document_filename", "document_md5", "document_parse_error", "document_processed", "document_state", "document_url", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs_password", "encrypt_pdfs", "expiration_interval", "expire_after", "expire_submissions", "external_predefined_fields_template_id", "external_predefined_fields_template_name", "first_template", "id", "locked", "merge_audit_trail_pdf", "name", "page_count", "page_dimensions", "parent_folder_id", "path", "permanent_document_url", "public_submissions", "public_web_form", "redirect_url", "slack_webhook_url", "template_type", "updated_at", "version_published_at", "version", "webhook_url", "demo", "latest_version", "last_changed_at", "last_changed_by_type", "last_changed_by_id", "last_changed_by_external_name", "last_changed_by_external_email", "last_changed_by_external_id"];
471
+ TemplatePreview.RequiredProperties = ["add_data_request_submission_id_footers", "allow_additional_properties", "description", "document_filename", "document_md5", "document_parse_error", "document_processed", "document_state", "document_url", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs_password", "encrypt_pdfs", "expiration_interval", "expire_after", "expire_submissions", "external_predefined_fields_template_id", "external_predefined_fields_template_name", "first_template", "id", "locked", "merge_audit_trail_pdf", "name", "page_count", "page_dimensions", "parent_folder_id", "parse_dates_using_template_date_format", "path", "permanent_document_url", "public_submissions", "public_web_form", "redirect_url", "slack_webhook_url", "template_type", "updated_at", "version_published_at", "version", "webhook_url", "demo", "latest_version", "last_changed_at", "last_changed_by_type", "last_changed_by_id", "last_changed_by_external_name", "last_changed_by_external_email", "last_changed_by_external_id"];
465
472
 
466
473
  /**
467
474
  * @member {Boolean} add_data_request_submission_id_footers
@@ -608,6 +615,11 @@ TemplatePreview.prototype['page_dimensions'] = undefined;
608
615
  */
609
616
  TemplatePreview.prototype['parent_folder_id'] = undefined;
610
617
 
618
+ /**
619
+ * @member {Boolean} parse_dates_using_template_date_format
620
+ */
621
+ TemplatePreview.prototype['parse_dates_using_template_date_format'] = undefined;
622
+
611
623
  /**
612
624
  * @member {String} path
613
625
  */
@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplatePublishVersionResponse model module.
31
31
  * @module model/TemplatePublishVersionResponse
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var TemplatePublishVersionResponse = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>TemplatePublishVersionResponse</code>.
37
37
  * @alias module:model/TemplatePublishVersionResponse
38
+ * @extends Object
38
39
  * @param status {module:model/TemplatePublishVersionResponse.StatusEnum}
39
40
  * @param result {Object}
40
41
  */
@@ -67,6 +68,7 @@ var TemplatePublishVersionResponse = /*#__PURE__*/function () {
67
68
  value: function constructFromObject(data, obj) {
68
69
  if (data) {
69
70
  obj = obj || new TemplatePublishVersionResponse();
71
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
70
72
  if (data.hasOwnProperty('status')) {
71
73
  obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
72
74
  }
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The UpdateHtmlTemplate model module.
31
31
  * @module model/UpdateHtmlTemplate
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var UpdateHtmlTemplate = /*#__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 UpdatePdfTemplate model module.
31
31
  * @module model/UpdatePdfTemplate
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var UpdatePdfTemplate = /*#__PURE__*/function () {
35
35
  /**
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
26
26
  /**
27
27
  * The UpdateSubmissionDataRequestData model module.
28
28
  * @module model/UpdateSubmissionDataRequestData
29
- * @version 3.1.0
29
+ * @version 3.2.0
30
30
  */
31
31
  var UpdateSubmissionDataRequestData = /*#__PURE__*/function () {
32
32
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The UpdateWebhookData model module.
31
31
  * @module model/UpdateWebhookData
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var UpdateWebhookData = /*#__PURE__*/function () {
35
35
  /**
@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The UploadPresignResponse model module.
31
31
  * @module model/UploadPresignResponse
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var UploadPresignResponse = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>UploadPresignResponse</code>.
37
37
  * @alias module:model/UploadPresignResponse
38
+ * @extends Object
38
39
  * @param fields {Object}
39
40
  * @param headers {Object}
40
41
  * @param url {String}
@@ -69,6 +70,7 @@ var UploadPresignResponse = /*#__PURE__*/function () {
69
70
  value: function constructFromObject(data, obj) {
70
71
  if (data) {
71
72
  obj = obj || new UploadPresignResponse();
73
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
72
74
  if (data.hasOwnProperty('fields')) {
73
75
  obj['fields'] = _ApiClient["default"].convertToType(data['fields'], Object);
74
76
  }
@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The Webhook model module.
31
31
  * @module model/Webhook
32
- * @version 3.1.0
32
+ * @version 3.2.0
33
33
  */
34
34
  var Webhook = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>Webhook</code>.
37
37
  * @alias module:model/Webhook
38
+ * @extends Object
38
39
  * @param id {String}
39
40
  * @param name {String}
40
41
  * @param url {String}
@@ -103,6 +104,7 @@ var Webhook = /*#__PURE__*/function () {
103
104
  value: function constructFromObject(data, obj) {
104
105
  if (data) {
105
106
  obj = obj || new Webhook();
107
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
106
108
  if (data.hasOwnProperty('id')) {
107
109
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
108
110
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "3.1.0",
3
+ "version": "3.2.0",
4
4
  "description": "An API client for the DocSpring PDF generation service",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -41,6 +41,16 @@
41
41
  "sinon": "^7.2.0"
42
42
  },
43
43
  "files": [
44
- "dist"
45
- ]
44
+ "dist",
45
+ "AGENTS.md"
46
+ ],
47
+ "homepage": "https://github.com/DocSpring/docspring-javascript#readme",
48
+ "repository": {
49
+ "type": "git",
50
+ "url": "https://github.com/DocSpring/docspring-javascript.git"
51
+ },
52
+ "bugs": {
53
+ "url": "https://github.com/DocSpring/docspring-javascript/issues"
54
+ },
55
+ "author": "DocSpring"
46
56
  }