docspring 3.3.0 → 4.0.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 (158) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1346 -948
  7. package/dist/index.js +651 -154
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  10. package/dist/model/BarcodeSymbology.js +89 -0
  11. package/dist/model/CheckCharacter.js +74 -0
  12. package/dist/model/CombinedFieldType.js +59 -0
  13. package/dist/model/CombinedPdf.js +294 -0
  14. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  25. package/dist/model/{TemplateDeleteResponse.js → CreateSignatureRequestEventRequest.js} +49 -74
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{SubmissionBatchData.js → CreateSubmissionBatchRequest.js} +67 -42
  28. package/dist/model/CreateSubmissionRequest.js +212 -0
  29. package/dist/model/CreateTemplateRequest.js +545 -0
  30. package/dist/model/CreateWebhookRequest.js +234 -0
  31. package/dist/model/CustomFile.js +67 -16
  32. package/dist/model/CustomFileList.js +132 -0
  33. package/dist/model/CustomFileSourcePdf.js +130 -0
  34. package/dist/model/ErrorCode.js +154 -0
  35. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +12 -41
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/FieldComparisonCondition.js +137 -0
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/FieldPresenceCondition.js +126 -0
  47. package/dist/model/FieldPresenceOperator.js +59 -0
  48. package/dist/model/FieldRangeCondition.js +148 -0
  49. package/dist/model/FieldReimportState.js +69 -0
  50. package/dist/model/FieldSetupLogic.js +59 -0
  51. package/dist/model/FieldSetupNaming.js +59 -0
  52. package/dist/model/FieldSetupSource.js +64 -0
  53. package/dist/model/Folder.js +38 -11
  54. package/dist/model/FolderList.js +132 -0
  55. package/dist/model/GeneratedFile.js +214 -0
  56. package/dist/model/GeneratedFileState.js +64 -0
  57. package/dist/model/HtmlEngineOptions.js +230 -0
  58. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  59. package/dist/model/ImageGravity.js +94 -0
  60. package/dist/model/ImageScaleType.js +64 -0
  61. package/dist/model/ModelCodeLanguage.js +94 -0
  62. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  74. package/dist/model/SignatureRequestEventType.js +79 -0
  75. package/dist/model/SignatureRequestInput.js +278 -0
  76. package/dist/model/SignatureRequestMessageType.js +94 -0
  77. package/dist/model/SignatureRequestState.js +64 -0
  78. package/dist/model/SignatureRequestToken.js +195 -0
  79. package/dist/model/SignatureRequestTokenType.js +59 -0
  80. package/dist/model/StringConditionType.js +74 -0
  81. package/dist/model/Submission.js +186 -345
  82. package/dist/model/SubmissionAction.js +30 -115
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +74 -55
  86. package/dist/model/SubmissionBatchState.js +64 -0
  87. package/dist/model/SubmissionFiles.js +108 -0
  88. package/dist/model/SubmissionInput.js +204 -0
  89. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  90. package/dist/model/SubmissionSource.js +69 -0
  91. package/dist/model/SubmissionSourcePdf.js +130 -0
  92. package/dist/model/SubmissionState.js +114 -0
  93. package/dist/model/Template.js +310 -573
  94. package/dist/model/TemplateActor.js +171 -0
  95. package/dist/model/TemplateActorType.js +64 -0
  96. package/dist/model/TemplateDefaults.js +307 -0
  97. package/dist/model/TemplateDefaultsInput.js +305 -0
  98. package/dist/model/TemplateDocument.js +280 -0
  99. package/dist/model/TemplateDocumentState.js +74 -0
  100. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  103. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  104. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  105. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  106. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  107. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  108. package/dist/model/TemplateFormMode.js +64 -0
  109. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  110. package/dist/model/TemplatePageAiError.js +69 -0
  111. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  112. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  113. package/dist/model/TemplatePageImageStatus.js +59 -0
  114. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  115. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  120. package/dist/model/TemplateVersionType.js +64 -0
  121. package/dist/model/TextAlignment.js +69 -0
  122. package/dist/model/TextOverflow.js +59 -0
  123. package/dist/model/TextVerticalAlignment.js +64 -0
  124. package/dist/model/Typeface.js +134 -0
  125. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  126. package/dist/model/UpdateTemplateDocumentRequest.js +136 -0
  127. package/dist/model/UpdateTemplateRequest.js +450 -0
  128. package/dist/model/UpdateWebhookRequest.js +209 -0
  129. package/dist/model/UploadMethod.js +54 -0
  130. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  131. package/dist/model/{AddFieldsData.js → UrlSourcePdf.js} +49 -31
  132. package/dist/model/Webhook.js +58 -73
  133. package/dist/model/WebhookEventType.js +174 -0
  134. package/dist/model/WebhookList.js +132 -0
  135. package/dist/model/WebhookMode.js +59 -0
  136. package/package.json +1 -1
  137. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  138. package/dist/model/CombinedSubmission.js +0 -313
  139. package/dist/model/CombinedSubmissionAction.js +0 -268
  140. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  141. package/dist/model/CreateCustomFileResponse.js +0 -167
  142. package/dist/model/CreateHtmlTemplate.js +0 -108
  143. package/dist/model/CreatePdfTemplate.js +0 -108
  144. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  145. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  146. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  147. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  148. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  149. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  150. package/dist/model/JsonSchema.js +0 -205
  151. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  152. package/dist/model/SubmissionDataRequest.js +0 -496
  153. package/dist/model/SubmissionPreview.js +0 -509
  154. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  155. package/dist/model/TemplatePreview.js +0 -796
  156. package/dist/model/UpdateHtmlTemplate.js +0 -108
  157. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  158. package/dist/model/UpdateWebhookData.js +0 -108
@@ -5,7 +5,9 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _CreateSubmissionDataRequestData = _interopRequireDefault(require("./CreateSubmissionDataRequestData"));
8
+ var _TemplateFieldDependencyAction = _interopRequireDefault(require("./TemplateFieldDependencyAction"));
9
+ var _TemplateFieldDependencyCondition = _interopRequireDefault(require("./TemplateFieldDependencyCondition"));
10
+ var _TemplateFieldDependencyMatch = _interopRequireDefault(require("./TemplateFieldDependencyMatch"));
9
11
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
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); }
11
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; } } }; }
@@ -17,9 +19,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
19
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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); } /**
19
21
  * 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. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
22
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
23
  *
22
- * The version of the OpenAPI document: v1
24
+ * The version of the OpenAPI document: v2
23
25
  *
24
26
  *
25
27
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,19 +30,23 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
30
  *
29
31
  */
30
32
  /**
31
- * The CreatePdfSubmissionData model module.
32
- * @module model/CreatePdfSubmissionData
33
- * @version 3.3.0
33
+ * The TemplateFieldDependency model module.
34
+ * @module model/TemplateFieldDependency
35
+ * @version 4.0.0
34
36
  */
35
- var CreatePdfSubmissionData = /*#__PURE__*/function () {
37
+ var TemplateFieldDependency = /*#__PURE__*/function () {
36
38
  /**
37
- * Constructs a new <code>CreatePdfSubmissionData</code>.
38
- * @alias module:model/CreatePdfSubmissionData
39
- * @param data {Object}
39
+ * Constructs a new <code>TemplateFieldDependency</code>.
40
+ * A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
41
+ * @alias module:model/TemplateFieldDependency
42
+ * @extends Object
43
+ * @param action {module:model/TemplateFieldDependencyAction} What the rule does to its targets when its conditions are met.
44
+ * @param conditions {Array.<module:model/TemplateFieldDependencyCondition>} The conditions on other fields' values.
45
+ * @param targets {Array.<String>} The names of the fields the rule shows or makes required.
40
46
  */
41
- function CreatePdfSubmissionData(data) {
42
- _classCallCheck(this, CreatePdfSubmissionData);
43
- CreatePdfSubmissionData.initialize(this, data);
47
+ function TemplateFieldDependency(action, conditions, targets) {
48
+ _classCallCheck(this, TemplateFieldDependency);
49
+ TemplateFieldDependency.initialize(this, action, conditions, targets);
44
50
  }
45
51
 
46
52
  /**
@@ -48,65 +54,56 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
48
54
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
55
  * Only for internal use.
50
56
  */
51
- return _createClass(CreatePdfSubmissionData, null, [{
57
+ return _createClass(TemplateFieldDependency, null, [{
52
58
  key: "initialize",
53
- value: function initialize(obj, data) {
54
- obj['data'] = data;
59
+ value: function initialize(obj, action, conditions, targets) {
60
+ obj['action'] = action;
61
+ obj['conditions'] = conditions;
62
+ obj['targets'] = targets;
55
63
  }
56
64
 
57
65
  /**
58
- * Constructs a <code>CreatePdfSubmissionData</code> from a plain JavaScript object, optionally creating a new instance.
66
+ * Constructs a <code>TemplateFieldDependency</code> from a plain JavaScript object, optionally creating a new instance.
59
67
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
60
68
  * @param {Object} data The plain JavaScript object bearing properties of interest.
61
- * @param {module:model/CreatePdfSubmissionData} obj Optional instance to populate.
62
- * @return {module:model/CreatePdfSubmissionData} The populated <code>CreatePdfSubmissionData</code> instance.
69
+ * @param {module:model/TemplateFieldDependency} obj Optional instance to populate.
70
+ * @return {module:model/TemplateFieldDependency} The populated <code>TemplateFieldDependency</code> instance.
63
71
  */
64
72
  }, {
65
73
  key: "constructFromObject",
66
74
  value: function constructFromObject(data, obj) {
67
75
  if (data) {
68
- obj = obj || new CreatePdfSubmissionData();
69
- if (data.hasOwnProperty('data')) {
70
- obj['data'] = _ApiClient["default"].convertToType(data['data'], Object);
76
+ obj = obj || new TemplateFieldDependency();
77
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
78
+ if (data.hasOwnProperty('action')) {
79
+ obj['action'] = _ApiClient["default"].convertToType(data['action'], _TemplateFieldDependencyAction["default"]);
71
80
  }
72
- if (data.hasOwnProperty('data_requests')) {
73
- obj['data_requests'] = _ApiClient["default"].convertToType(data['data_requests'], [_CreateSubmissionDataRequestData["default"]]);
81
+ if (data.hasOwnProperty('match')) {
82
+ obj['match'] = _ApiClient["default"].convertToType(data['match'], _TemplateFieldDependencyMatch["default"]);
74
83
  }
75
- if (data.hasOwnProperty('editable')) {
76
- obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
84
+ if (data.hasOwnProperty('conditions')) {
85
+ obj['conditions'] = _ApiClient["default"].convertToType(data['conditions'], [_TemplateFieldDependencyCondition["default"]]);
77
86
  }
78
- if (data.hasOwnProperty('expires_in')) {
79
- obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
87
+ if (data.hasOwnProperty('targets')) {
88
+ obj['targets'] = _ApiClient["default"].convertToType(data['targets'], ['String']);
80
89
  }
81
- if (data.hasOwnProperty('field_overrides')) {
82
- obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], Object);
83
- }
84
- if (data.hasOwnProperty('metadata')) {
85
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
86
- }
87
- if (data.hasOwnProperty('password')) {
88
- obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
89
- }
90
- if (data.hasOwnProperty('test')) {
91
- obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
92
- }
93
- if (data.hasOwnProperty('version')) {
94
- obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
90
+ if (data.hasOwnProperty('group')) {
91
+ obj['group'] = _ApiClient["default"].convertToType(data['group'], 'String');
95
92
  }
96
93
  }
97
94
  return obj;
98
95
  }
99
96
 
100
97
  /**
101
- * Validates the JSON data with respect to <code>CreatePdfSubmissionData</code>.
98
+ * Validates the JSON data with respect to <code>TemplateFieldDependency</code>.
102
99
  * @param {Object} data The plain JavaScript object bearing properties of interest.
103
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreatePdfSubmissionData</code>.
100
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateFieldDependency</code>.
104
101
  */
105
102
  }, {
106
103
  key: "validateJSON",
107
104
  value: function validateJSON(data) {
108
105
  // check to make sure all required properties are present in the JSON string
109
- var _iterator = _createForOfIteratorHelper(CreatePdfSubmissionData.RequiredProperties),
106
+ var _iterator = _createForOfIteratorHelper(TemplateFieldDependency.RequiredProperties),
110
107
  _step;
111
108
  try {
112
109
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -120,19 +117,19 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
120
117
  } finally {
121
118
  _iterator.f();
122
119
  }
123
- if (data['data_requests']) {
120
+ if (data['conditions']) {
124
121
  // data not null
125
122
  // ensure the json data is an array
126
- if (!Array.isArray(data['data_requests'])) {
127
- throw new Error("Expected the field `data_requests` to be an array in the JSON data but got " + data['data_requests']);
123
+ if (!Array.isArray(data['conditions'])) {
124
+ throw new Error("Expected the field `conditions` to be an array in the JSON data but got " + data['conditions']);
128
125
  }
129
- // validate the optional field `data_requests` (array)
130
- var _iterator2 = _createForOfIteratorHelper(data['data_requests']),
126
+ // validate the optional field `conditions` (array)
127
+ var _iterator2 = _createForOfIteratorHelper(data['conditions']),
131
128
  _step2;
132
129
  try {
133
130
  for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
134
131
  var item = _step2.value;
135
- _CreateSubmissionDataRequestData["default"].validateJSON(item);
132
+ _TemplateFieldDependencyCondition["default"].validateJSON(item);
136
133
  }
137
134
  } catch (err) {
138
135
  _iterator2.e(err);
@@ -141,63 +138,47 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
141
138
  }
142
139
  ;
143
140
  }
144
- // ensure the json data is a string
145
- if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
146
- throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
141
+ // ensure the json data is an array
142
+ if (!Array.isArray(data['targets'])) {
143
+ throw new Error("Expected the field `targets` to be an array in the JSON data but got " + data['targets']);
147
144
  }
148
145
  // ensure the json data is a string
149
- if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
150
- throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
146
+ if (data['group'] && !(typeof data['group'] === 'string' || data['group'] instanceof String)) {
147
+ throw new Error("Expected the field `group` to be a primitive type in the JSON string but got " + data['group']);
151
148
  }
152
149
  return true;
153
150
  }
154
151
  }]);
155
152
  }();
156
- CreatePdfSubmissionData.RequiredProperties = ["data"];
157
-
158
- /**
159
- * @member {Object} data
160
- */
161
- CreatePdfSubmissionData.prototype['data'] = undefined;
162
-
163
- /**
164
- * @member {Array.<module:model/CreateSubmissionDataRequestData>} data_requests
165
- */
166
- CreatePdfSubmissionData.prototype['data_requests'] = undefined;
167
-
168
- /**
169
- * @member {Boolean} editable
170
- */
171
- CreatePdfSubmissionData.prototype['editable'] = undefined;
172
-
173
- /**
174
- * @member {Number} expires_in
175
- */
176
- CreatePdfSubmissionData.prototype['expires_in'] = undefined;
153
+ TemplateFieldDependency.RequiredProperties = ["action", "conditions", "targets"];
177
154
 
178
155
  /**
179
- * @member {Object} field_overrides
156
+ * What the rule does to its targets when its conditions are met.
157
+ * @member {module:model/TemplateFieldDependencyAction} action
180
158
  */
181
- CreatePdfSubmissionData.prototype['field_overrides'] = undefined;
159
+ TemplateFieldDependency.prototype['action'] = undefined;
182
160
 
183
161
  /**
184
- * @member {Object} metadata
162
+ * Whether all of the conditions (the default) or any of them must be met.
163
+ * @member {module:model/TemplateFieldDependencyMatch} match
185
164
  */
186
- CreatePdfSubmissionData.prototype['metadata'] = undefined;
165
+ TemplateFieldDependency.prototype['match'] = undefined;
187
166
 
188
167
  /**
189
- * @member {String} password
168
+ * The conditions on other fields' values.
169
+ * @member {Array.<module:model/TemplateFieldDependencyCondition>} conditions
190
170
  */
191
- CreatePdfSubmissionData.prototype['password'] = undefined;
171
+ TemplateFieldDependency.prototype['conditions'] = undefined;
192
172
 
193
173
  /**
194
- * Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
195
- * @member {Boolean} test
174
+ * The names of the fields the rule shows or makes required.
175
+ * @member {Array.<String>} targets
196
176
  */
197
- CreatePdfSubmissionData.prototype['test'] = undefined;
177
+ TemplateFieldDependency.prototype['targets'] = undefined;
198
178
 
199
179
  /**
200
- * @member {String} version
180
+ * Marks a rule made for a field group in the template editor. Its targets outside the group are removed when the template is saved, and the rule is removed once the group has no fields.
181
+ * @member {String} group
201
182
  */
202
- CreatePdfSubmissionData.prototype['version'] = undefined;
203
- var _default = exports["default"] = CreatePdfSubmissionData;
183
+ TemplateFieldDependency.prototype['group'] = undefined;
184
+ var _default = exports["default"] = TemplateFieldDependency;
@@ -0,0 +1,64 @@
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
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ 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); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class TemplateFieldDependencyAction.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var TemplateFieldDependencyAction = exports["default"] = /*#__PURE__*/function () {
33
+ function TemplateFieldDependencyAction() {
34
+ _classCallCheck(this, TemplateFieldDependencyAction);
35
+ }
36
+ return _createClass(TemplateFieldDependencyAction, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>TemplateFieldDependencyAction</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/TemplateFieldDependencyAction} The enum <code>TemplateFieldDependencyAction</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "require_and_show"
52
+ * @const
53
+ */
54
+ _defineProperty(TemplateFieldDependencyAction, "require_and_show", "require_and_show");
55
+ /**
56
+ * value: "show"
57
+ * @const
58
+ */
59
+ _defineProperty(TemplateFieldDependencyAction, "show", "show");
60
+ /**
61
+ * value: "require"
62
+ * @const
63
+ */
64
+ _defineProperty(TemplateFieldDependencyAction, "require", "require");
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _TemplateFieldDependencyOperator = _interopRequireDefault(require("./TemplateFieldDependencyOperator"));
8
9
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
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); }
10
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; } } }; }
@@ -16,9 +17,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
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); } /**
18
19
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
21
  *
21
- * The version of the OpenAPI document: v1
22
+ * The version of the OpenAPI document: v2
22
23
  *
23
24
  *
24
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,21 +28,21 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
28
  *
28
29
  */
29
30
  /**
30
- * The TemplatePublishVersionResponse model module.
31
- * @module model/TemplatePublishVersionResponse
32
- * @version 3.3.0
31
+ * The TemplateFieldDependencyCondition model module.
32
+ * @module model/TemplateFieldDependencyCondition
33
+ * @version 4.0.0
33
34
  */
34
- var TemplatePublishVersionResponse = /*#__PURE__*/function () {
35
+ var TemplateFieldDependencyCondition = /*#__PURE__*/function () {
35
36
  /**
36
- * Constructs a new <code>TemplatePublishVersionResponse</code>.
37
- * @alias module:model/TemplatePublishVersionResponse
38
- * @extends Object
39
- * @param status {module:model/TemplatePublishVersionResponse.StatusEnum}
40
- * @param result {Object}
37
+ * Constructs a new <code>TemplateFieldDependencyCondition</code>.
38
+ * A condition on a field's value.
39
+ * @alias module:model/TemplateFieldDependencyCondition
40
+ * @param field {String} The name of the field whose value is compared.
41
+ * @param operator {module:model/TemplateFieldDependencyOperator} How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`.
41
42
  */
42
- function TemplatePublishVersionResponse(status, result) {
43
- _classCallCheck(this, TemplatePublishVersionResponse);
44
- TemplatePublishVersionResponse.initialize(this, status, result);
43
+ function TemplateFieldDependencyCondition(field, operator) {
44
+ _classCallCheck(this, TemplateFieldDependencyCondition);
45
+ TemplateFieldDependencyCondition.initialize(this, field, operator);
45
46
  }
46
47
 
47
48
  /**
@@ -49,49 +50,51 @@ var TemplatePublishVersionResponse = /*#__PURE__*/function () {
49
50
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
50
51
  * Only for internal use.
51
52
  */
52
- return _createClass(TemplatePublishVersionResponse, null, [{
53
+ return _createClass(TemplateFieldDependencyCondition, null, [{
53
54
  key: "initialize",
54
- value: function initialize(obj, status, result) {
55
- obj['status'] = status;
56
- obj['result'] = result;
55
+ value: function initialize(obj, field, operator) {
56
+ obj['field'] = field;
57
+ obj['operator'] = operator;
57
58
  }
58
59
 
59
60
  /**
60
- * Constructs a <code>TemplatePublishVersionResponse</code> from a plain JavaScript object, optionally creating a new instance.
61
+ * Constructs a <code>TemplateFieldDependencyCondition</code> from a plain JavaScript object, optionally creating a new instance.
61
62
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
62
63
  * @param {Object} data The plain JavaScript object bearing properties of interest.
63
- * @param {module:model/TemplatePublishVersionResponse} obj Optional instance to populate.
64
- * @return {module:model/TemplatePublishVersionResponse} The populated <code>TemplatePublishVersionResponse</code> instance.
64
+ * @param {module:model/TemplateFieldDependencyCondition} obj Optional instance to populate.
65
+ * @return {module:model/TemplateFieldDependencyCondition} The populated <code>TemplateFieldDependencyCondition</code> instance.
65
66
  */
66
67
  }, {
67
68
  key: "constructFromObject",
68
69
  value: function constructFromObject(data, obj) {
69
70
  if (data) {
70
- obj = obj || new TemplatePublishVersionResponse();
71
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
72
- if (data.hasOwnProperty('status')) {
73
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
71
+ obj = obj || new TemplateFieldDependencyCondition();
72
+ if (data.hasOwnProperty('field')) {
73
+ obj['field'] = _ApiClient["default"].convertToType(data['field'], 'String');
74
74
  }
75
- if (data.hasOwnProperty('result')) {
76
- obj['result'] = _ApiClient["default"].convertToType(data['result'], Object);
75
+ if (data.hasOwnProperty('operator')) {
76
+ obj['operator'] = _ApiClient["default"].convertToType(data['operator'], _TemplateFieldDependencyOperator["default"]);
77
77
  }
78
- if (data.hasOwnProperty('errors')) {
79
- obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
78
+ if (data.hasOwnProperty('value')) {
79
+ obj['value'] = _ApiClient["default"].convertToType(data['value'], Object);
80
+ }
81
+ if (data.hasOwnProperty('range_max')) {
82
+ obj['range_max'] = _ApiClient["default"].convertToType(data['range_max'], Object);
80
83
  }
81
84
  }
82
85
  return obj;
83
86
  }
84
87
 
85
88
  /**
86
- * Validates the JSON data with respect to <code>TemplatePublishVersionResponse</code>.
89
+ * Validates the JSON data with respect to <code>TemplateFieldDependencyCondition</code>.
87
90
  * @param {Object} data The plain JavaScript object bearing properties of interest.
88
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplatePublishVersionResponse</code>.
91
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateFieldDependencyCondition</code>.
89
92
  */
90
93
  }, {
91
94
  key: "validateJSON",
92
95
  value: function validateJSON(data) {
93
96
  // check to make sure all required properties are present in the JSON string
94
- var _iterator = _createForOfIteratorHelper(TemplatePublishVersionResponse.RequiredProperties),
97
+ var _iterator = _createForOfIteratorHelper(TemplateFieldDependencyCondition.RequiredProperties),
95
98
  _step;
96
99
  try {
97
100
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -106,49 +109,36 @@ var TemplatePublishVersionResponse = /*#__PURE__*/function () {
106
109
  } finally {
107
110
  _iterator.f();
108
111
  }
109
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
110
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
111
- }
112
- // ensure the json data is an array
113
- if (!Array.isArray(data['errors'])) {
114
- throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
112
+ if (data['field'] && !(typeof data['field'] === 'string' || data['field'] instanceof String)) {
113
+ throw new Error("Expected the field `field` to be a primitive type in the JSON string but got " + data['field']);
115
114
  }
116
115
  return true;
117
116
  }
118
117
  }]);
119
118
  }();
120
- TemplatePublishVersionResponse.RequiredProperties = ["status", "result"];
119
+ TemplateFieldDependencyCondition.RequiredProperties = ["field", "operator"];
121
120
 
122
121
  /**
123
- * @member {module:model/TemplatePublishVersionResponse.StatusEnum} status
122
+ * The name of the field whose value is compared.
123
+ * @member {String} field
124
124
  */
125
- TemplatePublishVersionResponse.prototype['status'] = undefined;
125
+ TemplateFieldDependencyCondition.prototype['field'] = undefined;
126
126
 
127
127
  /**
128
- * @member {Object} result
128
+ * How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`.
129
+ * @member {module:model/TemplateFieldDependencyOperator} operator
129
130
  */
130
- TemplatePublishVersionResponse.prototype['result'] = undefined;
131
+ TemplateFieldDependencyCondition.prototype['operator'] = undefined;
131
132
 
132
133
  /**
133
- * @member {Array.<String>} errors
134
+ * The value to compare the field's value with.
135
+ * @member {Object} value
134
136
  */
135
- TemplatePublishVersionResponse.prototype['errors'] = undefined;
137
+ TemplateFieldDependencyCondition.prototype['value'] = undefined;
136
138
 
137
139
  /**
138
- * Allowed values for the <code>status</code> property.
139
- * @enum {String}
140
- * @readonly
140
+ * The upper end of a `range`, a number (or a number as a string, as the template editor saves it).
141
+ * @member {Object} range_max
141
142
  */
142
- TemplatePublishVersionResponse['StatusEnum'] = {
143
- /**
144
- * value: "success"
145
- * @const
146
- */
147
- "success": "success",
148
- /**
149
- * value: "error"
150
- * @const
151
- */
152
- "error": "error"
153
- };
154
- var _default = exports["default"] = TemplatePublishVersionResponse;
143
+ TemplateFieldDependencyCondition.prototype['range_max'] = undefined;
144
+ var _default = exports["default"] = TemplateFieldDependencyCondition;