docspring 3.3.0 → 4.1.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 (184) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +74 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +3452 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1769 -921
  7. package/dist/index.js +847 -154
  8. package/dist/model/AddTemplateFieldsRequest.js +132 -0
  9. package/dist/model/AiFieldNamingLanguage.js +64 -0
  10. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  11. package/dist/model/BarcodeSymbology.js +89 -0
  12. package/dist/model/CheckCharacter.js +74 -0
  13. package/dist/model/CombinedFieldType.js +59 -0
  14. package/dist/model/CombinedPdf.js +294 -0
  15. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  16. package/dist/model/CombinedPdfList.js +132 -0
  17. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  18. package/dist/model/CombinedPdfSourceInput.js +270 -0
  19. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  20. package/dist/model/CombinedPdfSourceType.js +74 -0
  21. package/dist/model/CombinedPdfState.js +74 -0
  22. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  23. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  24. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  25. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  26. package/dist/model/{CreateCustomFileResponse.js → CreateSignatureRequestEventRequest.js} +49 -73
  27. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  28. package/dist/model/CreateSubmissionBatchRequest.js +192 -0
  29. package/dist/model/CreateSubmissionRequest.js +226 -0
  30. package/dist/model/CreateTemplateRequest.js +613 -0
  31. package/dist/model/CreateWebhookRequest.js +234 -0
  32. package/dist/model/CustomFile.js +67 -16
  33. package/dist/model/CustomFileList.js +132 -0
  34. package/dist/model/CustomFileSourcePdf.js +130 -0
  35. package/dist/model/ErrorCode.js +154 -0
  36. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  37. package/dist/model/ErrorInfo.js +211 -0
  38. package/dist/model/ErrorResponse.js +12 -41
  39. package/dist/model/ExpirationInterval.js +64 -0
  40. package/dist/model/Field.js +1230 -0
  41. package/dist/model/FieldComparisonCondition.js +137 -0
  42. package/dist/model/FieldComparisonOperator.js +69 -0
  43. package/dist/model/FieldDependency.js +154 -0
  44. package/dist/model/FieldDependencyInput.js +154 -0
  45. package/dist/model/FieldDisplayType.js +79 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  47. package/dist/model/FieldEqualsOperator.js +59 -0
  48. package/dist/model/FieldGroup.js +206 -0
  49. package/dist/model/FieldGroupInput.js +180 -0
  50. package/dist/model/FieldGroupType.js +59 -0
  51. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  52. package/dist/model/FieldInput.js +1012 -0
  53. package/dist/model/FieldOverride.js +722 -0
  54. package/dist/model/FieldPresenceCondition.js +126 -0
  55. package/dist/model/FieldPresenceOperator.js +59 -0
  56. package/dist/model/FieldRangeCondition.js +148 -0
  57. package/dist/model/FieldReimportState.js +69 -0
  58. package/dist/model/FieldSetupLogic.js +59 -0
  59. package/dist/model/FieldSetupNaming.js +59 -0
  60. package/dist/model/FieldSetupSource.js +64 -0
  61. package/dist/model/FieldType.js +124 -0
  62. package/dist/model/Folder.js +38 -11
  63. package/dist/model/FolderList.js +132 -0
  64. package/dist/model/GenerateFilesFormat.js +54 -0
  65. package/dist/model/GenerateSubmissionFilesRequest.js +115 -0
  66. package/dist/model/GeneratedFile.js +214 -0
  67. package/dist/model/GeneratedFileState.js +64 -0
  68. package/dist/model/HtmlEngineOptions.js +230 -0
  69. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  70. package/dist/model/ImageGravity.js +94 -0
  71. package/dist/model/ImageScaleType.js +64 -0
  72. package/dist/model/ModelCodeLanguage.js +94 -0
  73. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  74. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  75. package/dist/model/NumberConditionType.js +79 -0
  76. package/dist/model/OutputFormat.js +59 -0
  77. package/dist/model/PageFormat.js +114 -0
  78. package/dist/model/PageImage.js +220 -0
  79. package/dist/model/{TemplateDeleteResponse.js → PageImages.js} +57 -70
  80. package/dist/model/PredefinedField.js +183 -0
  81. package/dist/model/PredefinedFieldInput.js +183 -0
  82. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  83. package/dist/model/{AddFieldsData.js → RemoveTemplateFieldsRequest.js} +32 -30
  84. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  85. package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
  86. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  87. package/dist/model/ShapeType.js +79 -0
  88. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  89. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  90. package/dist/model/SignatureRequestAuthType.js +84 -0
  91. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  92. package/dist/model/SignatureRequestEventType.js +79 -0
  93. package/dist/model/SignatureRequestInput.js +278 -0
  94. package/dist/model/SignatureRequestMessageType.js +94 -0
  95. package/dist/model/SignatureRequestState.js +64 -0
  96. package/dist/model/SignatureRequestToken.js +195 -0
  97. package/dist/model/SignatureRequestTokenType.js +59 -0
  98. package/dist/model/StringConditionType.js +74 -0
  99. package/dist/model/Submission.js +198 -341
  100. package/dist/model/SubmissionAction.js +30 -115
  101. package/dist/model/SubmissionActionState.js +69 -0
  102. package/dist/model/SubmissionActionType.js +84 -0
  103. package/dist/model/SubmissionBatch.js +74 -55
  104. package/dist/model/SubmissionBatchState.js +64 -0
  105. package/dist/model/SubmissionFiles.js +117 -0
  106. package/dist/model/SubmissionInput.js +218 -0
  107. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  108. package/dist/model/SubmissionSource.js +69 -0
  109. package/dist/model/SubmissionSourcePdf.js +130 -0
  110. package/dist/model/SubmissionState.js +114 -0
  111. package/dist/model/{SubmissionBatchData.js → SubmissionValidation.js} +46 -48
  112. package/dist/model/Template.js +359 -560
  113. package/dist/model/TemplateActor.js +171 -0
  114. package/dist/model/TemplateActorType.js +64 -0
  115. package/dist/model/TemplateDefaults.js +307 -0
  116. package/dist/model/TemplateDefaultsInput.js +305 -0
  117. package/dist/model/TemplateDiff.js +206 -0
  118. package/dist/model/TemplateDiffSummary.js +165 -0
  119. package/dist/model/TemplateDocument.js +280 -0
  120. package/dist/model/TemplateDocumentState.js +84 -0
  121. package/dist/model/TemplateFieldChange.js +146 -0
  122. package/dist/model/TemplateFieldChanges.js +196 -0
  123. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  124. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  125. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  126. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  127. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  128. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  129. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  130. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  131. package/dist/model/{CreatePdfTemplate.js → TemplateFieldMove.js} +52 -28
  132. package/dist/model/TemplateFields.js +147 -0
  133. package/dist/model/TemplateFormMode.js +64 -0
  134. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  135. package/dist/model/TemplatePageAiError.js +69 -0
  136. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  137. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  138. package/dist/model/TemplatePageImageStatus.js +59 -0
  139. package/dist/model/TemplatePageImages.js +158 -0
  140. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  141. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  142. package/dist/model/TemplateSummary.js +560 -0
  143. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  144. package/dist/model/TemplateType.js +59 -0
  145. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  146. package/dist/model/TemplateVersionType.js +64 -0
  147. package/dist/model/TextAlignment.js +69 -0
  148. package/dist/model/TextOverflow.js +59 -0
  149. package/dist/model/TextVerticalAlignment.js +64 -0
  150. package/dist/model/Typeface.js +134 -0
  151. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  152. package/dist/model/UpdateTemplateDocumentRequest.js +139 -0
  153. package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
  154. package/dist/model/UpdateTemplateRequest.js +523 -0
  155. package/dist/model/UpdateWebhookRequest.js +209 -0
  156. package/dist/model/UploadMethod.js +54 -0
  157. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  158. package/dist/model/UrlSourcePdf.js +130 -0
  159. package/dist/model/ValidateSubmissionRequest.js +226 -0
  160. package/dist/model/Webhook.js +58 -73
  161. package/dist/model/WebhookEventType.js +174 -0
  162. package/dist/model/WebhookList.js +132 -0
  163. package/dist/model/WebhookMode.js +59 -0
  164. package/package.json +1 -1
  165. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  166. package/dist/model/CombinedSubmission.js +0 -313
  167. package/dist/model/CombinedSubmissionAction.js +0 -268
  168. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  169. package/dist/model/CreateHtmlTemplate.js +0 -108
  170. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  171. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  172. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  173. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  174. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  175. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  176. package/dist/model/JsonSchema.js +0 -205
  177. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  178. package/dist/model/SubmissionDataRequest.js +0 -496
  179. package/dist/model/SubmissionPreview.js +0 -509
  180. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  181. package/dist/model/TemplatePreview.js +0 -796
  182. package/dist/model/UpdateHtmlTemplate.js +0 -108
  183. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  184. package/dist/model/UpdateWebhookData.js +0 -108
@@ -16,9 +16,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  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
18
  * 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/).
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
- * The version of the OpenAPI document: v1
21
+ * The version of the OpenAPI document: v2
22
22
  *
23
23
  *
24
24
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,19 +27,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  *
28
28
  */
29
29
  /**
30
- * The CreateFolderData model module.
31
- * @module model/CreateFolderData
32
- * @version 3.3.0
30
+ * The CreateFolderRequest model module.
31
+ * @module model/CreateFolderRequest
32
+ * @version 4.1.0
33
33
  */
34
- var CreateFolderData = /*#__PURE__*/function () {
34
+ var CreateFolderRequest = /*#__PURE__*/function () {
35
35
  /**
36
- * Constructs a new <code>CreateFolderData</code>.
37
- * @alias module:model/CreateFolderData
38
- * @param folder {Object}
36
+ * Constructs a new <code>CreateFolderRequest</code>.
37
+ * The folder to create.
38
+ * @alias module:model/CreateFolderRequest
39
+ * @param name {String} The folder's name. It can't contain `/`, and is unique within its parent folder.
39
40
  */
40
- function CreateFolderData(folder) {
41
- _classCallCheck(this, CreateFolderData);
42
- CreateFolderData.initialize(this, folder);
41
+ function CreateFolderRequest(name) {
42
+ _classCallCheck(this, CreateFolderRequest);
43
+ CreateFolderRequest.initialize(this, name);
43
44
  }
44
45
 
45
46
  /**
@@ -47,41 +48,44 @@ var CreateFolderData = /*#__PURE__*/function () {
47
48
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
48
49
  * Only for internal use.
49
50
  */
50
- return _createClass(CreateFolderData, null, [{
51
+ return _createClass(CreateFolderRequest, null, [{
51
52
  key: "initialize",
52
- value: function initialize(obj, folder) {
53
- obj['folder'] = folder;
53
+ value: function initialize(obj, name) {
54
+ obj['name'] = name;
54
55
  }
55
56
 
56
57
  /**
57
- * Constructs a <code>CreateFolderData</code> from a plain JavaScript object, optionally creating a new instance.
58
+ * Constructs a <code>CreateFolderRequest</code> from a plain JavaScript object, optionally creating a new instance.
58
59
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
59
60
  * @param {Object} data The plain JavaScript object bearing properties of interest.
60
- * @param {module:model/CreateFolderData} obj Optional instance to populate.
61
- * @return {module:model/CreateFolderData} The populated <code>CreateFolderData</code> instance.
61
+ * @param {module:model/CreateFolderRequest} obj Optional instance to populate.
62
+ * @return {module:model/CreateFolderRequest} The populated <code>CreateFolderRequest</code> instance.
62
63
  */
63
64
  }, {
64
65
  key: "constructFromObject",
65
66
  value: function constructFromObject(data, obj) {
66
67
  if (data) {
67
- obj = obj || new CreateFolderData();
68
- if (data.hasOwnProperty('folder')) {
69
- obj['folder'] = _ApiClient["default"].convertToType(data['folder'], Object);
68
+ obj = obj || new CreateFolderRequest();
69
+ if (data.hasOwnProperty('name')) {
70
+ obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
71
+ }
72
+ if (data.hasOwnProperty('parent_folder_id')) {
73
+ obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
70
74
  }
71
75
  }
72
76
  return obj;
73
77
  }
74
78
 
75
79
  /**
76
- * Validates the JSON data with respect to <code>CreateFolderData</code>.
80
+ * Validates the JSON data with respect to <code>CreateFolderRequest</code>.
77
81
  * @param {Object} data The plain JavaScript object bearing properties of interest.
78
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateFolderData</code>.
82
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateFolderRequest</code>.
79
83
  */
80
84
  }, {
81
85
  key: "validateJSON",
82
86
  value: function validateJSON(data) {
83
87
  // check to make sure all required properties are present in the JSON string
84
- var _iterator = _createForOfIteratorHelper(CreateFolderData.RequiredProperties),
88
+ var _iterator = _createForOfIteratorHelper(CreateFolderRequest.RequiredProperties),
85
89
  _step;
86
90
  try {
87
91
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -90,19 +94,34 @@ var CreateFolderData = /*#__PURE__*/function () {
90
94
  throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
91
95
  }
92
96
  }
97
+ // ensure the json data is a string
93
98
  } catch (err) {
94
99
  _iterator.e(err);
95
100
  } finally {
96
101
  _iterator.f();
97
102
  }
103
+ if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
104
+ throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
105
+ }
106
+ // ensure the json data is a string
107
+ if (data['parent_folder_id'] && !(typeof data['parent_folder_id'] === 'string' || data['parent_folder_id'] instanceof String)) {
108
+ throw new Error("Expected the field `parent_folder_id` to be a primitive type in the JSON string but got " + data['parent_folder_id']);
109
+ }
98
110
  return true;
99
111
  }
100
112
  }]);
101
113
  }();
102
- CreateFolderData.RequiredProperties = ["folder"];
114
+ CreateFolderRequest.RequiredProperties = ["name"];
115
+
116
+ /**
117
+ * The folder's name. It can't contain `/`, and is unique within its parent folder.
118
+ * @member {String} name
119
+ */
120
+ CreateFolderRequest.prototype['name'] = undefined;
103
121
 
104
122
  /**
105
- * @member {Object} folder
123
+ * The ID of the folder this folder is in. Null for a folder at the root.
124
+ * @member {String} parent_folder_id
106
125
  */
107
- CreateFolderData.prototype['folder'] = undefined;
108
- var _default = exports["default"] = CreateFolderData;
126
+ CreateFolderRequest.prototype['parent_folder_id'] = undefined;
127
+ var _default = exports["default"] = CreateFolderRequest;
@@ -5,7 +5,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _CustomFile = _interopRequireDefault(require("./CustomFile"));
8
+ var _SignatureRequestEventType = _interopRequireDefault(require("./SignatureRequestEventType"));
9
+ var _SignatureRequestMessageType = _interopRequireDefault(require("./SignatureRequestMessageType"));
9
10
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
11
  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
12
  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 +18,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
18
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
19
  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
20
  * 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/).
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
22
  *
22
- * The version of the OpenAPI document: v1
23
+ * The version of the OpenAPI document: v2
23
24
  *
24
25
  *
25
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,21 +29,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
29
  *
29
30
  */
30
31
  /**
31
- * The CreateCustomFileResponse model module.
32
- * @module model/CreateCustomFileResponse
33
- * @version 3.3.0
32
+ * The CreateSignatureRequestEventRequest model module.
33
+ * @module model/CreateSignatureRequestEventRequest
34
+ * @version 4.1.0
34
35
  */
35
- var CreateCustomFileResponse = /*#__PURE__*/function () {
36
+ var CreateSignatureRequestEventRequest = /*#__PURE__*/function () {
36
37
  /**
37
- * Constructs a new <code>CreateCustomFileResponse</code>.
38
- * @alias module:model/CreateCustomFileResponse
39
- * @extends Object
40
- * @param status {module:model/CreateCustomFileResponse.StatusEnum}
41
- * @param custom_file {module:model/CustomFile}
38
+ * Constructs a new <code>CreateSignatureRequestEventRequest</code>.
39
+ * The event to record.
40
+ * @alias module:model/CreateSignatureRequestEventRequest
41
+ * @param event_type {module:model/SignatureRequestEventType} `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form.
42
42
  */
43
- function CreateCustomFileResponse(status, custom_file) {
44
- _classCallCheck(this, CreateCustomFileResponse);
45
- CreateCustomFileResponse.initialize(this, status, custom_file);
43
+ function CreateSignatureRequestEventRequest(event_type) {
44
+ _classCallCheck(this, CreateSignatureRequestEventRequest);
45
+ CreateSignatureRequestEventRequest.initialize(this, event_type);
46
46
  }
47
47
 
48
48
  /**
@@ -50,52 +50,50 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
50
50
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
51
51
  * Only for internal use.
52
52
  */
53
- return _createClass(CreateCustomFileResponse, null, [{
53
+ return _createClass(CreateSignatureRequestEventRequest, null, [{
54
54
  key: "initialize",
55
- value: function initialize(obj, status, custom_file) {
56
- obj['status'] = status;
57
- obj['custom_file'] = custom_file;
55
+ value: function initialize(obj, event_type) {
56
+ obj['event_type'] = event_type;
58
57
  }
59
58
 
60
59
  /**
61
- * Constructs a <code>CreateCustomFileResponse</code> from a plain JavaScript object, optionally creating a new instance.
60
+ * Constructs a <code>CreateSignatureRequestEventRequest</code> from a plain JavaScript object, optionally creating a new instance.
62
61
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
63
62
  * @param {Object} data The plain JavaScript object bearing properties of interest.
64
- * @param {module:model/CreateCustomFileResponse} obj Optional instance to populate.
65
- * @return {module:model/CreateCustomFileResponse} The populated <code>CreateCustomFileResponse</code> instance.
63
+ * @param {module:model/CreateSignatureRequestEventRequest} obj Optional instance to populate.
64
+ * @return {module:model/CreateSignatureRequestEventRequest} The populated <code>CreateSignatureRequestEventRequest</code> instance.
66
65
  */
67
66
  }, {
68
67
  key: "constructFromObject",
69
68
  value: function constructFromObject(data, obj) {
70
69
  if (data) {
71
- obj = obj || new CreateCustomFileResponse();
72
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
73
- if (data.hasOwnProperty('status')) {
74
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
70
+ obj = obj || new CreateSignatureRequestEventRequest();
71
+ if (data.hasOwnProperty('event_type')) {
72
+ obj['event_type'] = _ApiClient["default"].convertToType(data['event_type'], _SignatureRequestEventType["default"]);
75
73
  }
76
- if (data.hasOwnProperty('custom_file')) {
77
- obj['custom_file'] = _CustomFile["default"].constructFromObject(data['custom_file']);
74
+ if (data.hasOwnProperty('message_type')) {
75
+ obj['message_type'] = _ApiClient["default"].convertToType(data['message_type'], _SignatureRequestMessageType["default"]);
78
76
  }
79
- if (data.hasOwnProperty('error')) {
80
- obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
77
+ if (data.hasOwnProperty('message_recipient')) {
78
+ obj['message_recipient'] = _ApiClient["default"].convertToType(data['message_recipient'], 'String');
81
79
  }
82
- if (data.hasOwnProperty('errors')) {
83
- obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
80
+ if (data.hasOwnProperty('occurred_at')) {
81
+ obj['occurred_at'] = _ApiClient["default"].convertToType(data['occurred_at'], 'Date');
84
82
  }
85
83
  }
86
84
  return obj;
87
85
  }
88
86
 
89
87
  /**
90
- * Validates the JSON data with respect to <code>CreateCustomFileResponse</code>.
88
+ * Validates the JSON data with respect to <code>CreateSignatureRequestEventRequest</code>.
91
89
  * @param {Object} data The plain JavaScript object bearing properties of interest.
92
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateCustomFileResponse</code>.
90
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSignatureRequestEventRequest</code>.
93
91
  */
94
92
  }, {
95
93
  key: "validateJSON",
96
94
  value: function validateJSON(data) {
97
95
  // check to make sure all required properties are present in the JSON string
98
- var _iterator = _createForOfIteratorHelper(CreateCustomFileResponse.RequiredProperties),
96
+ var _iterator = _createForOfIteratorHelper(CreateSignatureRequestEventRequest.RequiredProperties),
99
97
  _step;
100
98
  try {
101
99
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -110,58 +108,36 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
110
108
  } finally {
111
109
  _iterator.f();
112
110
  }
113
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
114
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
115
- }
116
- // ensure the json data is a string
117
- if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
118
- throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
119
- }
120
- // ensure the json data is an array
121
- if (!Array.isArray(data['errors'])) {
122
- throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
111
+ if (data['message_recipient'] && !(typeof data['message_recipient'] === 'string' || data['message_recipient'] instanceof String)) {
112
+ throw new Error("Expected the field `message_recipient` to be a primitive type in the JSON string but got " + data['message_recipient']);
123
113
  }
124
114
  return true;
125
115
  }
126
116
  }]);
127
117
  }();
128
- CreateCustomFileResponse.RequiredProperties = ["status", "custom_file"];
129
-
130
- /**
131
- * @member {module:model/CreateCustomFileResponse.StatusEnum} status
132
- */
133
- CreateCustomFileResponse.prototype['status'] = undefined;
118
+ CreateSignatureRequestEventRequest.RequiredProperties = ["event_type"];
134
119
 
135
120
  /**
136
- * @member {module:model/CustomFile} custom_file
121
+ * `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form.
122
+ * @member {module:model/SignatureRequestEventType} event_type
137
123
  */
138
- CreateCustomFileResponse.prototype['custom_file'] = undefined;
124
+ CreateSignatureRequestEventRequest.prototype['event_type'] = undefined;
139
125
 
140
126
  /**
141
- * @member {String} error
127
+ * How you sent the request. Required for `send_request`.
128
+ * @member {module:model/SignatureRequestMessageType} message_type
142
129
  */
143
- CreateCustomFileResponse.prototype['error'] = undefined;
130
+ CreateSignatureRequestEventRequest.prototype['message_type'] = undefined;
144
131
 
145
132
  /**
146
- * @member {Array.<String>} errors
133
+ * Where you sent the request, such as an email address or a phone number. Required for `send_request`.
134
+ * @member {String} message_recipient
147
135
  */
148
- CreateCustomFileResponse.prototype['errors'] = undefined;
136
+ CreateSignatureRequestEventRequest.prototype['message_recipient'] = undefined;
149
137
 
150
138
  /**
151
- * Allowed values for the <code>status</code> property.
152
- * @enum {String}
153
- * @readonly
139
+ * When it happened. Default now.
140
+ * @member {Date} occurred_at
154
141
  */
155
- CreateCustomFileResponse['StatusEnum'] = {
156
- /**
157
- * value: "success"
158
- * @const
159
- */
160
- "success": "success",
161
- /**
162
- * value: "error"
163
- * @const
164
- */
165
- "error": "error"
166
- };
167
- var _default = exports["default"] = CreateCustomFileResponse;
142
+ CreateSignatureRequestEventRequest.prototype['occurred_at'] = undefined;
143
+ var _default = exports["default"] = CreateSignatureRequestEventRequest;
@@ -0,0 +1,88 @@
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 _SignatureRequestTokenType = _interopRequireDefault(require("./SignatureRequestTokenType"));
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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
12
+ 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); } }
13
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), 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
+ * The CreateSignatureRequestTokenRequest model module.
29
+ * @module model/CreateSignatureRequestTokenRequest
30
+ * @version 4.1.0
31
+ */
32
+ var CreateSignatureRequestTokenRequest = /*#__PURE__*/function () {
33
+ /**
34
+ * Constructs a new <code>CreateSignatureRequestTokenRequest</code>.
35
+ * The kind of link to make. Send no body for an `api` token.
36
+ * @alias module:model/CreateSignatureRequestTokenRequest
37
+ */
38
+ function CreateSignatureRequestTokenRequest() {
39
+ _classCallCheck(this, CreateSignatureRequestTokenRequest);
40
+ CreateSignatureRequestTokenRequest.initialize(this);
41
+ }
42
+
43
+ /**
44
+ * Initializes the fields of this object.
45
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
46
+ * Only for internal use.
47
+ */
48
+ return _createClass(CreateSignatureRequestTokenRequest, null, [{
49
+ key: "initialize",
50
+ value: function initialize(obj) {}
51
+
52
+ /**
53
+ * Constructs a <code>CreateSignatureRequestTokenRequest</code> from a plain JavaScript object, optionally creating a new instance.
54
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
55
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
56
+ * @param {module:model/CreateSignatureRequestTokenRequest} obj Optional instance to populate.
57
+ * @return {module:model/CreateSignatureRequestTokenRequest} The populated <code>CreateSignatureRequestTokenRequest</code> instance.
58
+ */
59
+ }, {
60
+ key: "constructFromObject",
61
+ value: function constructFromObject(data, obj) {
62
+ if (data) {
63
+ obj = obj || new CreateSignatureRequestTokenRequest();
64
+ if (data.hasOwnProperty('type')) {
65
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], _SignatureRequestTokenType["default"]);
66
+ }
67
+ }
68
+ return obj;
69
+ }
70
+
71
+ /**
72
+ * Validates the JSON data with respect to <code>CreateSignatureRequestTokenRequest</code>.
73
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
74
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSignatureRequestTokenRequest</code>.
75
+ */
76
+ }, {
77
+ key: "validateJSON",
78
+ value: function validateJSON(data) {
79
+ return true;
80
+ }
81
+ }]);
82
+ }();
83
+ /**
84
+ * `api` (the default): the link opens the signature request for 24 hours, for a form your app opens or a link it gives the person right away. `email`: 7 days, for a link you send by email.
85
+ * @member {module:model/SignatureRequestTokenType} type
86
+ */
87
+ CreateSignatureRequestTokenRequest.prototype['type'] = undefined;
88
+ var _default = exports["default"] = CreateSignatureRequestTokenRequest;
@@ -0,0 +1,192 @@
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 _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
9
+ var _SubmissionInput = _interopRequireDefault(require("./SubmissionInput"));
10
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
11
+ 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); }
12
+ 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; } } }; }
13
+ 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; } }
14
+ 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; }
15
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
16
+ 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); } }
17
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
19
+ 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); } /**
20
+ * DocSpring API
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
22
+ *
23
+ * The version of the OpenAPI document: v2
24
+ *
25
+ *
26
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
27
+ * https://openapi-generator.tech
28
+ * Do not edit the class manually.
29
+ *
30
+ */
31
+ /**
32
+ * The CreateSubmissionBatchRequest model module.
33
+ * @module model/CreateSubmissionBatchRequest
34
+ * @version 4.1.0
35
+ */
36
+ var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
37
+ /**
38
+ * Constructs a new <code>CreateSubmissionBatchRequest</code>.
39
+ * The submissions to create, and the settings they share.
40
+ * @alias module:model/CreateSubmissionBatchRequest
41
+ * @param submissions {Array.<module:model/SubmissionInput>} Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
42
+ */
43
+ function CreateSubmissionBatchRequest(submissions) {
44
+ _classCallCheck(this, CreateSubmissionBatchRequest);
45
+ CreateSubmissionBatchRequest.initialize(this, submissions);
46
+ }
47
+
48
+ /**
49
+ * Initializes the fields of this object.
50
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
51
+ * Only for internal use.
52
+ */
53
+ return _createClass(CreateSubmissionBatchRequest, null, [{
54
+ key: "initialize",
55
+ value: function initialize(obj, submissions) {
56
+ obj['submissions'] = submissions;
57
+ }
58
+
59
+ /**
60
+ * Constructs a <code>CreateSubmissionBatchRequest</code> from a plain JavaScript object, optionally creating a new instance.
61
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
62
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
63
+ * @param {module:model/CreateSubmissionBatchRequest} obj Optional instance to populate.
64
+ * @return {module:model/CreateSubmissionBatchRequest} The populated <code>CreateSubmissionBatchRequest</code> instance.
65
+ */
66
+ }, {
67
+ key: "constructFromObject",
68
+ value: function constructFromObject(data, obj) {
69
+ if (data) {
70
+ obj = obj || new CreateSubmissionBatchRequest();
71
+ if (data.hasOwnProperty('metadata')) {
72
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
73
+ 'String': Object
74
+ });
75
+ }
76
+ if (data.hasOwnProperty('template_id')) {
77
+ obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('template_version')) {
80
+ obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
81
+ }
82
+ if (data.hasOwnProperty('test')) {
83
+ obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
84
+ }
85
+ if (data.hasOwnProperty('output_formats')) {
86
+ obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
87
+ }
88
+ if (data.hasOwnProperty('submissions')) {
89
+ obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_SubmissionInput["default"]]);
90
+ }
91
+ }
92
+ return obj;
93
+ }
94
+
95
+ /**
96
+ * Validates the JSON data with respect to <code>CreateSubmissionBatchRequest</code>.
97
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
98
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSubmissionBatchRequest</code>.
99
+ */
100
+ }, {
101
+ key: "validateJSON",
102
+ value: function validateJSON(data) {
103
+ // check to make sure all required properties are present in the JSON string
104
+ var _iterator = _createForOfIteratorHelper(CreateSubmissionBatchRequest.RequiredProperties),
105
+ _step;
106
+ try {
107
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
108
+ var property = _step.value;
109
+ if (!data.hasOwnProperty(property)) {
110
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
111
+ }
112
+ }
113
+ // ensure the json data is a string
114
+ } catch (err) {
115
+ _iterator.e(err);
116
+ } finally {
117
+ _iterator.f();
118
+ }
119
+ if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
120
+ throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
121
+ }
122
+ // ensure the json data is a string
123
+ if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
124
+ throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
125
+ }
126
+ // ensure the json data is an array
127
+ if (!Array.isArray(data['output_formats'])) {
128
+ throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
129
+ }
130
+ if (data['submissions']) {
131
+ // data not null
132
+ // ensure the json data is an array
133
+ if (!Array.isArray(data['submissions'])) {
134
+ throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
135
+ }
136
+ // validate the optional field `submissions` (array)
137
+ var _iterator2 = _createForOfIteratorHelper(data['submissions']),
138
+ _step2;
139
+ try {
140
+ for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
141
+ var item = _step2.value;
142
+ _SubmissionInput["default"].validateJSON(item);
143
+ }
144
+ } catch (err) {
145
+ _iterator2.e(err);
146
+ } finally {
147
+ _iterator2.f();
148
+ }
149
+ ;
150
+ }
151
+ return true;
152
+ }
153
+ }]);
154
+ }();
155
+ CreateSubmissionBatchRequest.RequiredProperties = ["submissions"];
156
+
157
+ /**
158
+ * Your own data about the batch, such as an ID from your app.
159
+ * @member {Object.<String, Object>} metadata
160
+ */
161
+ CreateSubmissionBatchRequest.prototype['metadata'] = undefined;
162
+
163
+ /**
164
+ * The template for each submission that doesn't name its own `template_id`.
165
+ * @member {String} template_id
166
+ */
167
+ CreateSubmissionBatchRequest.prototype['template_id'] = undefined;
168
+
169
+ /**
170
+ * The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
171
+ * @member {String} template_version
172
+ */
173
+ CreateSubmissionBatchRequest.prototype['template_version'] = undefined;
174
+
175
+ /**
176
+ * The default `test` for each submission that doesn't set its own.
177
+ * @member {Boolean} test
178
+ */
179
+ CreateSubmissionBatchRequest.prototype['test'] = undefined;
180
+
181
+ /**
182
+ * The default `output_formats` for each submission that doesn't set its own.
183
+ * @member {Array.<module:model/OutputFormat>} output_formats
184
+ */
185
+ CreateSubmissionBatchRequest.prototype['output_formats'] = undefined;
186
+
187
+ /**
188
+ * Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
189
+ * @member {Array.<module:model/SubmissionInput>} submissions
190
+ */
191
+ CreateSubmissionBatchRequest.prototype['submissions'] = undefined;
192
+ var _default = exports["default"] = CreateSubmissionBatchRequest;