docspring 4.0.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 (116) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +13 -1
  3. package/dist/ApiClient.js +2 -2
  4. package/dist/RequestSchemas.js +1231 -9
  5. package/dist/WebhookSignature.js +86 -0
  6. package/dist/api/Client.js +620 -38
  7. package/dist/index.js +238 -0
  8. package/dist/model/AddTemplateFieldsRequest.js +132 -0
  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 +15 -1
  23. package/dist/model/CreateSubmissionRequest.js +17 -3
  24. package/dist/model/CreateTemplatePreviewRequest.js +112 -0
  25. package/dist/model/CreateTemplateRequest.js +81 -4
  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 +1230 -0
  35. package/dist/model/FieldComparisonCondition.js +1 -1
  36. package/dist/model/FieldDependency.js +154 -0
  37. package/dist/model/FieldDependencyInput.js +154 -0
  38. package/dist/model/FieldEqualsCondition.js +1 -1
  39. package/dist/model/FieldGroup.js +206 -0
  40. package/dist/model/FieldGroupInput.js +180 -0
  41. package/dist/model/FieldGroupType.js +59 -0
  42. package/dist/model/FieldInCondition.js +1 -1
  43. package/dist/model/FieldInput.js +1012 -0
  44. package/dist/model/FieldOverride.js +1 -1
  45. package/dist/model/FieldPresenceCondition.js +1 -1
  46. package/dist/model/FieldRangeCondition.js +1 -1
  47. package/dist/model/FieldType.js +124 -0
  48. package/dist/model/Folder.js +1 -1
  49. package/dist/model/FolderList.js +1 -1
  50. package/dist/model/GenerateFilesFormat.js +54 -0
  51. package/dist/model/GenerateSubmissionFilesRequest.js +115 -0
  52. package/dist/model/GeneratedFile.js +1 -1
  53. package/dist/model/HtmlEngineOptions.js +1 -1
  54. package/dist/model/HtmlEngineOptionsInput.js +1 -1
  55. package/dist/model/MoveFolderRequest.js +1 -1
  56. package/dist/model/MoveTemplateRequest.js +1 -1
  57. package/dist/model/OutputFormat.js +59 -0
  58. package/dist/model/PageImage.js +220 -0
  59. package/dist/model/PageImages.js +155 -0
  60. package/dist/model/PredefinedField.js +183 -0
  61. package/dist/model/PredefinedFieldInput.js +183 -0
  62. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  63. package/dist/model/RemoveTemplateFieldsRequest.js +114 -0
  64. package/dist/model/RenameFolderRequest.js +1 -1
  65. package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
  66. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  67. package/dist/model/SignatureRequest.js +1 -1
  68. package/dist/model/SignatureRequestEvent.js +1 -1
  69. package/dist/model/SignatureRequestInput.js +1 -1
  70. package/dist/model/SignatureRequestToken.js +1 -1
  71. package/dist/model/Submission.js +84 -68
  72. package/dist/model/SubmissionAction.js +1 -1
  73. package/dist/model/SubmissionBatch.js +1 -1
  74. package/dist/model/SubmissionFiles.js +10 -1
  75. package/dist/model/SubmissionInput.js +17 -3
  76. package/dist/model/SubmissionList.js +5 -5
  77. package/dist/model/SubmissionSourcePdf.js +1 -1
  78. package/dist/model/SubmissionSummary.js +343 -0
  79. package/dist/model/SubmissionValidation.js +151 -0
  80. package/dist/model/Template.js +129 -56
  81. package/dist/model/TemplateActor.js +3 -3
  82. package/dist/model/TemplateDefaults.js +1 -1
  83. package/dist/model/TemplateDefaultsInput.js +1 -1
  84. package/dist/model/TemplateDiff.js +206 -0
  85. package/dist/model/TemplateDiffSummary.js +165 -0
  86. package/dist/model/TemplateDocument.js +36 -36
  87. package/dist/model/TemplateDocumentState.js +11 -1
  88. package/dist/model/TemplateDocumentSummary.js +152 -0
  89. package/dist/model/TemplateFieldChange.js +146 -0
  90. package/dist/model/TemplateFieldChanges.js +196 -0
  91. package/dist/model/TemplateFieldDependency.js +3 -3
  92. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  93. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  94. package/dist/model/TemplateFieldDependencyInput.js +3 -3
  95. package/dist/model/TemplateFieldMove.js +132 -0
  96. package/dist/model/TemplateFields.js +147 -0
  97. package/dist/model/TemplateModelCode.js +1 -1
  98. package/dist/model/TemplatePageImages.js +158 -0
  99. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  100. package/dist/model/TemplatePreview.js +211 -0
  101. package/dist/model/TemplatePreviewState.js +64 -0
  102. package/dist/model/TemplateSourcePdf.js +1 -1
  103. package/dist/model/TemplateSummary.js +14 -288
  104. package/dist/model/TemplateSummaryList.js +1 -1
  105. package/dist/model/TemplateVersion.js +1 -1
  106. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  107. package/dist/model/UpdateTemplateDocumentRequest.js +33 -30
  108. package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
  109. package/dist/model/UpdateTemplateRequest.js +84 -2
  110. package/dist/model/UpdateWebhookRequest.js +1 -1
  111. package/dist/model/UploadPresign.js +1 -1
  112. package/dist/model/UrlSourcePdf.js +1 -1
  113. package/dist/model/ValidateSubmissionRequest.js +226 -0
  114. package/dist/model/Webhook.js +1 -1
  115. package/dist/model/WebhookList.js +1 -1
  116. package/package.json +3 -2
@@ -0,0 +1,152 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _TemplateDocumentState = _interopRequireDefault(require("./TemplateDocumentState"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
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
+ 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; } } }; }
12
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
13
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The TemplateDocumentSummary model module.
32
+ * @module model/TemplateDocumentSummary
33
+ * @version 4.2.0
34
+ */
35
+ var TemplateDocumentSummary = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>TemplateDocumentSummary</code>.
38
+ * A PDF template's PDF, as template lists show it.
39
+ * @alias module:model/TemplateDocumentSummary
40
+ * @param filename {String} The PDF's file name. Null until a `document_url` has been downloaded.
41
+ * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
42
+ * @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
43
+ * @param page_count {Number} 0 until the PDF has been processed.
44
+ */
45
+ function TemplateDocumentSummary(filename, state, error_message, page_count) {
46
+ _classCallCheck(this, TemplateDocumentSummary);
47
+ TemplateDocumentSummary.initialize(this, filename, state, error_message, page_count);
48
+ }
49
+
50
+ /**
51
+ * Initializes the fields of this object.
52
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
53
+ * Only for internal use.
54
+ */
55
+ return _createClass(TemplateDocumentSummary, null, [{
56
+ key: "initialize",
57
+ value: function initialize(obj, filename, state, error_message, page_count) {
58
+ obj['filename'] = filename;
59
+ obj['state'] = state;
60
+ obj['error_message'] = error_message;
61
+ obj['page_count'] = page_count;
62
+ }
63
+
64
+ /**
65
+ * Constructs a <code>TemplateDocumentSummary</code> from a plain JavaScript object, optionally creating a new instance.
66
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
67
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
68
+ * @param {module:model/TemplateDocumentSummary} obj Optional instance to populate.
69
+ * @return {module:model/TemplateDocumentSummary} The populated <code>TemplateDocumentSummary</code> instance.
70
+ */
71
+ }, {
72
+ key: "constructFromObject",
73
+ value: function constructFromObject(data, obj) {
74
+ if (data) {
75
+ obj = obj || new TemplateDocumentSummary();
76
+ if (data.hasOwnProperty('filename')) {
77
+ obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('state')) {
80
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplateDocumentState["default"]);
81
+ }
82
+ if (data.hasOwnProperty('error_message')) {
83
+ obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('page_count')) {
86
+ obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
87
+ }
88
+ }
89
+ return obj;
90
+ }
91
+
92
+ /**
93
+ * Validates the JSON data with respect to <code>TemplateDocumentSummary</code>.
94
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
95
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateDocumentSummary</code>.
96
+ */
97
+ }, {
98
+ key: "validateJSON",
99
+ value: function validateJSON(data) {
100
+ // check to make sure all required properties are present in the JSON string
101
+ var _iterator = _createForOfIteratorHelper(TemplateDocumentSummary.RequiredProperties),
102
+ _step;
103
+ try {
104
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
105
+ var property = _step.value;
106
+ if (!data.hasOwnProperty(property)) {
107
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
108
+ }
109
+ }
110
+ // ensure the json data is a string
111
+ } catch (err) {
112
+ _iterator.e(err);
113
+ } finally {
114
+ _iterator.f();
115
+ }
116
+ if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
117
+ throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
118
+ }
119
+ // ensure the json data is a string
120
+ if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
121
+ throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
122
+ }
123
+ return true;
124
+ }
125
+ }]);
126
+ }();
127
+ TemplateDocumentSummary.RequiredProperties = ["filename", "state", "error_message", "page_count"];
128
+
129
+ /**
130
+ * The PDF's file name. Null until a `document_url` has been downloaded.
131
+ * @member {String} filename
132
+ */
133
+ TemplateDocumentSummary.prototype['filename'] = undefined;
134
+
135
+ /**
136
+ * `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
137
+ * @member {module:model/TemplateDocumentState} state
138
+ */
139
+ TemplateDocumentSummary.prototype['state'] = undefined;
140
+
141
+ /**
142
+ * Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
143
+ * @member {String} error_message
144
+ */
145
+ TemplateDocumentSummary.prototype['error_message'] = undefined;
146
+
147
+ /**
148
+ * 0 until the PDF has been processed.
149
+ * @member {Number} page_count
150
+ */
151
+ TemplateDocumentSummary.prototype['page_count'] = undefined;
152
+ var _default = exports["default"] = TemplateDocumentSummary;
@@ -0,0 +1,146 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _Field = _interopRequireDefault(require("./Field"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
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
+ 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; } } }; }
12
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
13
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The TemplateFieldChange model module.
32
+ * @module model/TemplateFieldChange
33
+ * @version 4.2.0
34
+ */
35
+ var TemplateFieldChange = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>TemplateFieldChange</code>.
38
+ * A field whose settings changed between two versions of a template.
39
+ * @alias module:model/TemplateFieldChange
40
+ * @param id {Number} The field's ID.
41
+ * @param changed_settings {Array.<String>} The names of the settings that changed, such as `x` or `required`.
42
+ * @param old {module:model/Field}
43
+ * @param _new {module:model/Field}
44
+ */
45
+ function TemplateFieldChange(id, changed_settings, old, _new) {
46
+ _classCallCheck(this, TemplateFieldChange);
47
+ TemplateFieldChange.initialize(this, id, changed_settings, old, _new);
48
+ }
49
+
50
+ /**
51
+ * Initializes the fields of this object.
52
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
53
+ * Only for internal use.
54
+ */
55
+ return _createClass(TemplateFieldChange, null, [{
56
+ key: "initialize",
57
+ value: function initialize(obj, id, changed_settings, old, _new) {
58
+ obj['id'] = id;
59
+ obj['changed_settings'] = changed_settings;
60
+ obj['old'] = old;
61
+ obj['new'] = _new;
62
+ }
63
+
64
+ /**
65
+ * Constructs a <code>TemplateFieldChange</code> from a plain JavaScript object, optionally creating a new instance.
66
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
67
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
68
+ * @param {module:model/TemplateFieldChange} obj Optional instance to populate.
69
+ * @return {module:model/TemplateFieldChange} The populated <code>TemplateFieldChange</code> instance.
70
+ */
71
+ }, {
72
+ key: "constructFromObject",
73
+ value: function constructFromObject(data, obj) {
74
+ if (data) {
75
+ obj = obj || new TemplateFieldChange();
76
+ if (data.hasOwnProperty('id')) {
77
+ obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
78
+ }
79
+ if (data.hasOwnProperty('changed_settings')) {
80
+ obj['changed_settings'] = _ApiClient["default"].convertToType(data['changed_settings'], ['String']);
81
+ }
82
+ if (data.hasOwnProperty('old')) {
83
+ obj['old'] = data['old'] === null ? null : _Field["default"].constructFromObject(data['old']);
84
+ }
85
+ if (data.hasOwnProperty('new')) {
86
+ obj['new'] = data['new'] === null ? null : _Field["default"].constructFromObject(data['new']);
87
+ }
88
+ }
89
+ return obj;
90
+ }
91
+
92
+ /**
93
+ * Validates the JSON data with respect to <code>TemplateFieldChange</code>.
94
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
95
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateFieldChange</code>.
96
+ */
97
+ }, {
98
+ key: "validateJSON",
99
+ value: function validateJSON(data) {
100
+ // check to make sure all required properties are present in the JSON string
101
+ var _iterator = _createForOfIteratorHelper(TemplateFieldChange.RequiredProperties),
102
+ _step;
103
+ try {
104
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
105
+ var property = _step.value;
106
+ if (!data.hasOwnProperty(property)) {
107
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
108
+ }
109
+ }
110
+ // ensure the json data is an array
111
+ } catch (err) {
112
+ _iterator.e(err);
113
+ } finally {
114
+ _iterator.f();
115
+ }
116
+ if (!Array.isArray(data['changed_settings'])) {
117
+ throw new Error("Expected the field `changed_settings` to be an array in the JSON data but got " + data['changed_settings']);
118
+ }
119
+ return true;
120
+ }
121
+ }]);
122
+ }();
123
+ TemplateFieldChange.RequiredProperties = ["id", "changed_settings", "old", "new"];
124
+
125
+ /**
126
+ * The field's ID.
127
+ * @member {Number} id
128
+ */
129
+ TemplateFieldChange.prototype['id'] = undefined;
130
+
131
+ /**
132
+ * The names of the settings that changed, such as `x` or `required`.
133
+ * @member {Array.<String>} changed_settings
134
+ */
135
+ TemplateFieldChange.prototype['changed_settings'] = undefined;
136
+
137
+ /**
138
+ * @member {module:model/Field} old
139
+ */
140
+ TemplateFieldChange.prototype['old'] = undefined;
141
+
142
+ /**
143
+ * @member {module:model/Field} new
144
+ */
145
+ TemplateFieldChange.prototype['new'] = undefined;
146
+ var _default = exports["default"] = TemplateFieldChange;
@@ -0,0 +1,196 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _Field = _interopRequireDefault(require("./Field"));
9
+ var _TemplateFieldChange = _interopRequireDefault(require("./TemplateFieldChange"));
10
+ var _TemplateFieldMove = _interopRequireDefault(require("./TemplateFieldMove"));
11
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
12
+ 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); }
13
+ 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; } } }; }
14
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
15
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
16
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
17
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
18
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
19
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
20
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
21
+ * DocSpring API
22
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
23
+ *
24
+ * The version of the OpenAPI document: v2
25
+ *
26
+ *
27
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28
+ * https://openapi-generator.tech
29
+ * Do not edit the class manually.
30
+ *
31
+ */
32
+ /**
33
+ * The TemplateFieldChanges model module.
34
+ * @module model/TemplateFieldChanges
35
+ * @version 4.2.0
36
+ */
37
+ var TemplateFieldChanges = /*#__PURE__*/function () {
38
+ /**
39
+ * Constructs a new <code>TemplateFieldChanges</code>.
40
+ * The fields that changed between two versions of a template.
41
+ * @alias module:model/TemplateFieldChanges
42
+ * @param added {Array.<module:model/Field>} The fields that `to_version` has and `from_version` doesn't.
43
+ * @param removed {Array.<module:model/Field>} The fields that `from_version` has and `to_version` doesn't, as they were.
44
+ * @param changed {Array.<module:model/TemplateFieldChange>} The fields with changed settings.
45
+ * @param reordered {Array.<module:model/TemplateFieldMove>} The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed.
46
+ */
47
+ function TemplateFieldChanges(added, removed, changed, reordered) {
48
+ _classCallCheck(this, TemplateFieldChanges);
49
+ TemplateFieldChanges.initialize(this, added, removed, changed, reordered);
50
+ }
51
+
52
+ /**
53
+ * Initializes the fields of this object.
54
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
55
+ * Only for internal use.
56
+ */
57
+ return _createClass(TemplateFieldChanges, null, [{
58
+ key: "initialize",
59
+ value: function initialize(obj, added, removed, changed, reordered) {
60
+ obj['added'] = added;
61
+ obj['removed'] = removed;
62
+ obj['changed'] = changed;
63
+ obj['reordered'] = reordered;
64
+ }
65
+
66
+ /**
67
+ * Constructs a <code>TemplateFieldChanges</code> from a plain JavaScript object, optionally creating a new instance.
68
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
69
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
70
+ * @param {module:model/TemplateFieldChanges} obj Optional instance to populate.
71
+ * @return {module:model/TemplateFieldChanges} The populated <code>TemplateFieldChanges</code> instance.
72
+ */
73
+ }, {
74
+ key: "constructFromObject",
75
+ value: function constructFromObject(data, obj) {
76
+ if (data) {
77
+ obj = obj || new TemplateFieldChanges();
78
+ if (data.hasOwnProperty('added')) {
79
+ obj['added'] = _ApiClient["default"].convertToType(data['added'], [_Field["default"]]);
80
+ }
81
+ if (data.hasOwnProperty('removed')) {
82
+ obj['removed'] = _ApiClient["default"].convertToType(data['removed'], [_Field["default"]]);
83
+ }
84
+ if (data.hasOwnProperty('changed')) {
85
+ obj['changed'] = _ApiClient["default"].convertToType(data['changed'], [_TemplateFieldChange["default"]]);
86
+ }
87
+ if (data.hasOwnProperty('reordered')) {
88
+ obj['reordered'] = _ApiClient["default"].convertToType(data['reordered'], [_TemplateFieldMove["default"]]);
89
+ }
90
+ }
91
+ return obj;
92
+ }
93
+
94
+ /**
95
+ * Validates the JSON data with respect to <code>TemplateFieldChanges</code>.
96
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
97
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateFieldChanges</code>.
98
+ */
99
+ }, {
100
+ key: "validateJSON",
101
+ value: function validateJSON(data) {
102
+ // check to make sure all required properties are present in the JSON string
103
+ var _iterator = _createForOfIteratorHelper(TemplateFieldChanges.RequiredProperties),
104
+ _step;
105
+ try {
106
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
107
+ var property = _step.value;
108
+ if (!data.hasOwnProperty(property)) {
109
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
110
+ }
111
+ }
112
+ // ensure the json data is an array
113
+ } catch (err) {
114
+ _iterator.e(err);
115
+ } finally {
116
+ _iterator.f();
117
+ }
118
+ if (!Array.isArray(data['added'])) {
119
+ throw new Error("Expected the field `added` to be an array in the JSON data but got " + data['added']);
120
+ }
121
+ // ensure the json data is an array
122
+ if (!Array.isArray(data['removed'])) {
123
+ throw new Error("Expected the field `removed` to be an array in the JSON data but got " + data['removed']);
124
+ }
125
+ if (data['changed']) {
126
+ // data not null
127
+ // ensure the json data is an array
128
+ if (!Array.isArray(data['changed'])) {
129
+ throw new Error("Expected the field `changed` to be an array in the JSON data but got " + data['changed']);
130
+ }
131
+ // validate the optional field `changed` (array)
132
+ var _iterator2 = _createForOfIteratorHelper(data['changed']),
133
+ _step2;
134
+ try {
135
+ for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
136
+ var item = _step2.value;
137
+ _TemplateFieldChange["default"].validateJSON(item);
138
+ }
139
+ } catch (err) {
140
+ _iterator2.e(err);
141
+ } finally {
142
+ _iterator2.f();
143
+ }
144
+ ;
145
+ }
146
+ if (data['reordered']) {
147
+ // data not null
148
+ // ensure the json data is an array
149
+ if (!Array.isArray(data['reordered'])) {
150
+ throw new Error("Expected the field `reordered` to be an array in the JSON data but got " + data['reordered']);
151
+ }
152
+ // validate the optional field `reordered` (array)
153
+ var _iterator3 = _createForOfIteratorHelper(data['reordered']),
154
+ _step3;
155
+ try {
156
+ for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
157
+ var _item = _step3.value;
158
+ _TemplateFieldMove["default"].validateJSON(_item);
159
+ }
160
+ } catch (err) {
161
+ _iterator3.e(err);
162
+ } finally {
163
+ _iterator3.f();
164
+ }
165
+ ;
166
+ }
167
+ return true;
168
+ }
169
+ }]);
170
+ }();
171
+ TemplateFieldChanges.RequiredProperties = ["added", "removed", "changed", "reordered"];
172
+
173
+ /**
174
+ * The fields that `to_version` has and `from_version` doesn't.
175
+ * @member {Array.<module:model/Field>} added
176
+ */
177
+ TemplateFieldChanges.prototype['added'] = undefined;
178
+
179
+ /**
180
+ * The fields that `from_version` has and `to_version` doesn't, as they were.
181
+ * @member {Array.<module:model/Field>} removed
182
+ */
183
+ TemplateFieldChanges.prototype['removed'] = undefined;
184
+
185
+ /**
186
+ * The fields with changed settings.
187
+ * @member {Array.<module:model/TemplateFieldChange>} changed
188
+ */
189
+ TemplateFieldChanges.prototype['changed'] = undefined;
190
+
191
+ /**
192
+ * The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed.
193
+ * @member {Array.<module:model/TemplateFieldMove>} reordered
194
+ */
195
+ TemplateFieldChanges.prototype['reordered'] = undefined;
196
+ var _default = exports["default"] = TemplateFieldChanges;
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependency model module.
34
34
  * @module model/TemplateFieldDependency
35
- * @version 4.0.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var TemplateFieldDependency = /*#__PURE__*/function () {
38
38
  /**
@@ -40,7 +40,7 @@ var TemplateFieldDependency = /*#__PURE__*/function () {
40
40
  * A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
41
41
  * @alias module:model/TemplateFieldDependency
42
42
  * @extends Object
43
- * @param action {module:model/TemplateFieldDependencyAction} What the rule does to its targets when its conditions are met.
43
+ * @param action {module:model/TemplateFieldDependencyAction} What the rule does to the fields it applies to when its conditions are met.
44
44
  * @param conditions {Array.<module:model/TemplateFieldDependencyCondition>} The conditions on other fields' values.
45
45
  * @param targets {Array.<String>} The names of the fields the rule shows or makes required.
46
46
  */
@@ -153,7 +153,7 @@ var TemplateFieldDependency = /*#__PURE__*/function () {
153
153
  TemplateFieldDependency.RequiredProperties = ["action", "conditions", "targets"];
154
154
 
155
155
  /**
156
- * What the rule does to its targets when its conditions are met.
156
+ * What the rule does to the fields it applies to when its conditions are met.
157
157
  * @member {module:model/TemplateFieldDependencyAction} action
158
158
  */
159
159
  TemplateFieldDependency.prototype['action'] = undefined;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFieldDependencyCondition model module.
32
32
  * @module model/TemplateFieldDependencyCondition
33
- * @version 4.0.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplateFieldDependencyCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplateFieldDependencyConditionInput model module.
35
35
  * @module model/TemplateFieldDependencyConditionInput
36
- * @version 4.0.0
36
+ * @version 4.2.0
37
37
  */
38
38
  var TemplateFieldDependencyConditionInput = /*#__PURE__*/function () {
39
39
  /**
@@ -32,14 +32,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependencyInput model module.
34
34
  * @module model/TemplateFieldDependencyInput
35
- * @version 4.0.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var TemplateFieldDependencyInput = /*#__PURE__*/function () {
38
38
  /**
39
39
  * Constructs a new <code>TemplateFieldDependencyInput</code>.
40
40
  * A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
41
41
  * @alias module:model/TemplateFieldDependencyInput
42
- * @param action {module:model/TemplateFieldDependencyAction} What the rule does to its targets when its conditions are met.
42
+ * @param action {module:model/TemplateFieldDependencyAction} What the rule does to the fields it applies to when its conditions are met.
43
43
  * @param conditions {Array.<module:model/TemplateFieldDependencyConditionInput>} The conditions on other fields' values.
44
44
  * @param targets {Array.<String>} The names of the fields the rule shows or makes required.
45
45
  */
@@ -151,7 +151,7 @@ var TemplateFieldDependencyInput = /*#__PURE__*/function () {
151
151
  TemplateFieldDependencyInput.RequiredProperties = ["action", "conditions", "targets"];
152
152
 
153
153
  /**
154
- * What the rule does to its targets when its conditions are met.
154
+ * What the rule does to the fields it applies to when its conditions are met.
155
155
  * @member {module:model/TemplateFieldDependencyAction} action
156
156
  */
157
157
  TemplateFieldDependencyInput.prototype['action'] = undefined;