docspring 3.2.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.
- package/AGENTS.md +79 -19
- package/README.md +65 -63
- package/dist/ApiClient.js +62 -27
- package/dist/RequestSchemas.js +2297 -0
- package/dist/RequestValidator.js +494 -0
- package/dist/api/Client.js +1345 -946
- package/dist/index.js +655 -151
- package/dist/model/AiFieldNamingLanguage.js +64 -0
- package/dist/model/{AddFieldsData.js → AuthenticationCheck.js} +31 -31
- package/dist/model/BarcodeSymbology.js +89 -0
- package/dist/model/CheckCharacter.js +74 -0
- package/dist/model/CombinedFieldType.js +59 -0
- package/dist/model/CombinedPdf.js +294 -0
- package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +26 -26
- package/dist/model/CombinedPdfList.js +132 -0
- package/dist/model/{SubmissionDataRequestToken.js → CombinedPdfSource.js} +55 -52
- package/dist/model/CombinedPdfSourceInput.js +270 -0
- package/dist/model/{SuccessErrorResponse.js → CombinedPdfSourcePdf.js} +41 -55
- package/dist/model/CombinedPdfSourceType.js +74 -0
- package/dist/model/CombinedPdfState.js +74 -0
- package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +25 -21
- package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +68 -52
- package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +24 -22
- package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +46 -27
- package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js} +41 -137
- package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
- package/dist/model/{CreatePdfSubmissionData.js → CreateSubmissionBatchRequest.js} +63 -87
- package/dist/model/CreateSubmissionRequest.js +212 -0
- package/dist/model/CreateTemplateRequest.js +545 -0
- package/dist/model/CreateWebhookRequest.js +234 -0
- package/dist/model/CustomFile.js +66 -15
- package/dist/model/CustomFileList.js +132 -0
- package/dist/model/CustomFileSourcePdf.js +130 -0
- package/dist/model/ErrorCode.js +154 -0
- package/dist/model/{BatchGeneratePdfs201Response.js → ErrorDetail.js} +65 -76
- package/dist/model/ErrorInfo.js +211 -0
- package/dist/model/ErrorResponse.js +11 -40
- package/dist/model/ExpirationInterval.js +64 -0
- package/dist/model/{CreateSubmissionResponse.js → FieldComparisonCondition.js} +46 -64
- package/dist/model/FieldComparisonOperator.js +69 -0
- package/dist/model/FieldDisplayType.js +79 -0
- package/dist/model/FieldEqualsCondition.js +137 -0
- package/dist/model/FieldEqualsOperator.js +59 -0
- package/dist/model/FieldInCondition.js +145 -0
- package/dist/model/FieldOverride.js +722 -0
- package/dist/model/{MultipleErrorsResponse.js → FieldPresenceCondition.js} +39 -54
- package/dist/model/FieldPresenceOperator.js +59 -0
- package/dist/model/FieldRangeCondition.js +148 -0
- package/dist/model/FieldReimportState.js +69 -0
- package/dist/model/FieldSetupLogic.js +59 -0
- package/dist/model/FieldSetupNaming.js +59 -0
- package/dist/model/FieldSetupSource.js +64 -0
- package/dist/model/Folder.js +37 -10
- package/dist/model/FolderList.js +132 -0
- package/dist/model/GeneratedFile.js +214 -0
- package/dist/model/GeneratedFileState.js +64 -0
- package/dist/model/HtmlEngineOptions.js +230 -0
- package/dist/model/HtmlEngineOptionsInput.js +193 -0
- package/dist/model/ImageGravity.js +94 -0
- package/dist/model/ImageScaleType.js +64 -0
- package/dist/model/ModelCodeLanguage.js +94 -0
- package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +33 -27
- package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +24 -34
- package/dist/model/NumberConditionType.js +79 -0
- package/dist/model/PageFormat.js +114 -0
- package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +32 -32
- package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +24 -22
- package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +24 -22
- package/dist/model/ShapeType.js +79 -0
- package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +164 -239
- package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
- package/dist/model/SignatureRequestAuthType.js +84 -0
- package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +66 -148
- package/dist/model/SignatureRequestEventType.js +79 -0
- package/dist/model/SignatureRequestInput.js +278 -0
- package/dist/model/SignatureRequestMessageType.js +94 -0
- package/dist/model/SignatureRequestState.js +64 -0
- package/dist/model/SignatureRequestToken.js +195 -0
- package/dist/model/SignatureRequestTokenType.js +59 -0
- package/dist/model/StringConditionType.js +74 -0
- package/dist/model/Submission.js +185 -339
- package/dist/model/SubmissionAction.js +29 -114
- package/dist/model/SubmissionActionState.js +69 -0
- package/dist/model/SubmissionActionType.js +84 -0
- package/dist/model/SubmissionBatch.js +73 -54
- package/dist/model/SubmissionBatchState.js +64 -0
- package/dist/model/SubmissionFiles.js +108 -0
- package/dist/model/SubmissionInput.js +204 -0
- package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +34 -41
- package/dist/model/SubmissionSource.js +69 -0
- package/dist/model/SubmissionSourcePdf.js +130 -0
- package/dist/model/SubmissionState.js +114 -0
- package/dist/model/Template.js +309 -572
- package/dist/model/TemplateActor.js +171 -0
- package/dist/model/TemplateActorType.js +64 -0
- package/dist/model/TemplateDefaults.js +307 -0
- package/dist/model/TemplateDefaultsInput.js +305 -0
- package/dist/model/TemplateDocument.js +280 -0
- package/dist/model/TemplateDocumentState.js +74 -0
- package/dist/model/TemplateFieldDependency.js +184 -0
- package/dist/model/TemplateFieldDependencyAction.js +64 -0
- package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js} +50 -61
- package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
- package/dist/model/TemplateFieldDependencyInput.js +182 -0
- package/dist/model/TemplateFieldDependencyMatch.js +59 -0
- package/dist/model/TemplateFieldDependencyOperator.js +99 -0
- package/dist/model/TemplateFieldLogicStatus.js +74 -0
- package/dist/model/TemplateFormMode.js +64 -0
- package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +33 -85
- package/dist/model/TemplatePageAiError.js +69 -0
- package/dist/model/TemplatePageAiNamingStatus.js +59 -0
- package/dist/model/TemplatePageFieldsStatus.js +74 -0
- package/dist/model/TemplatePageImageStatus.js +59 -0
- package/dist/model/TemplatePageProcessingStatus.js +162 -0
- package/dist/model/{SubmissionBatchData.js → TemplateSourcePdf.js} +49 -49
- package/dist/model/TemplateSummary.js +560 -0
- package/dist/model/{SuccessMultipleErrorsResponse.js → TemplateSummaryList.js} +43 -55
- package/dist/model/TemplateType.js +59 -0
- package/dist/model/{Submission422Response.js → TemplateVersion.js} +59 -62
- package/dist/model/TemplateVersionType.js +64 -0
- package/dist/model/TextAlignment.js +69 -0
- package/dist/model/TextOverflow.js +59 -0
- package/dist/model/TextVerticalAlignment.js +64 -0
- package/dist/model/Typeface.js +134 -0
- package/dist/model/UpdateSignatureRequestRequest.js +183 -0
- package/dist/model/{ErrorOrMultipleErrorsResponse.js → UpdateTemplateDocumentRequest.js} +43 -60
- package/dist/model/UpdateTemplateRequest.js +450 -0
- package/dist/model/UpdateWebhookRequest.js +209 -0
- package/dist/model/UploadMethod.js +54 -0
- package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +52 -57
- package/dist/model/UrlSourcePdf.js +130 -0
- package/dist/model/Webhook.js +57 -72
- package/dist/model/WebhookEventType.js +174 -0
- package/dist/model/WebhookList.js +132 -0
- package/dist/model/WebhookMode.js +59 -0
- package/package.json +1 -1
- package/dist/model/CombinedSubmission.js +0 -308
- package/dist/model/CombinedSubmissionAction.js +0 -268
- package/dist/model/CreateCustomFileResponse.js +0 -155
- package/dist/model/CreateHtmlTemplate.js +0 -108
- package/dist/model/CreatePdfTemplate.js +0 -108
- package/dist/model/CreateSubmissionDataRequestData.js +0 -314
- package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -155
- package/dist/model/CreateSubmissionDataRequestResponse.js +0 -155
- package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -155
- package/dist/model/CreateWebhookData.js +0 -108
- package/dist/model/JsonSchema.js +0 -205
- package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
- package/dist/model/SubmissionDataRequest.js +0 -496
- package/dist/model/SubmissionPreview.js +0 -504
- package/dist/model/TemplateAddFieldsResponse.js +0 -156
- package/dist/model/TemplateDeleteResponse.js +0 -168
- package/dist/model/TemplatePreview.js +0 -796
- package/dist/model/TemplatePublishVersionResponse.js +0 -154
- package/dist/model/UpdateHtmlTemplate.js +0 -108
- package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
- package/dist/model/UpdateWebhookData.js +0 -108
|
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var
|
|
8
|
+
var _SubmissionInput = _interopRequireDefault(require("./SubmissionInput"));
|
|
9
9
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
10
10
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
11
11
|
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
@@ -19,7 +19,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
19
19
|
* DocSpring API
|
|
20
20
|
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
21
21
|
*
|
|
22
|
-
* The version of the OpenAPI document:
|
|
22
|
+
* The version of the OpenAPI document: v2
|
|
23
23
|
*
|
|
24
24
|
*
|
|
25
25
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -28,19 +28,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
/**
|
|
31
|
-
* The
|
|
32
|
-
* @module model/
|
|
33
|
-
* @version
|
|
31
|
+
* The CreateSubmissionBatchRequest model module.
|
|
32
|
+
* @module model/CreateSubmissionBatchRequest
|
|
33
|
+
* @version 4.0.0
|
|
34
34
|
*/
|
|
35
|
-
var
|
|
35
|
+
var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
37
|
-
* Constructs a new <code>
|
|
38
|
-
*
|
|
39
|
-
* @
|
|
37
|
+
* Constructs a new <code>CreateSubmissionBatchRequest</code>.
|
|
38
|
+
* The submissions to create, and the settings they share.
|
|
39
|
+
* @alias module:model/CreateSubmissionBatchRequest
|
|
40
|
+
* @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.
|
|
40
41
|
*/
|
|
41
|
-
function
|
|
42
|
-
_classCallCheck(this,
|
|
43
|
-
|
|
42
|
+
function CreateSubmissionBatchRequest(submissions) {
|
|
43
|
+
_classCallCheck(this, CreateSubmissionBatchRequest);
|
|
44
|
+
CreateSubmissionBatchRequest.initialize(this, submissions);
|
|
44
45
|
}
|
|
45
46
|
|
|
46
47
|
/**
|
|
@@ -48,65 +49,55 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
|
|
|
48
49
|
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
49
50
|
* Only for internal use.
|
|
50
51
|
*/
|
|
51
|
-
return _createClass(
|
|
52
|
+
return _createClass(CreateSubmissionBatchRequest, null, [{
|
|
52
53
|
key: "initialize",
|
|
53
|
-
value: function initialize(obj,
|
|
54
|
-
obj['
|
|
54
|
+
value: function initialize(obj, submissions) {
|
|
55
|
+
obj['submissions'] = submissions;
|
|
55
56
|
}
|
|
56
57
|
|
|
57
58
|
/**
|
|
58
|
-
* Constructs a <code>
|
|
59
|
+
* Constructs a <code>CreateSubmissionBatchRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
59
60
|
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
60
61
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
61
|
-
* @param {module:model/
|
|
62
|
-
* @return {module:model/
|
|
62
|
+
* @param {module:model/CreateSubmissionBatchRequest} obj Optional instance to populate.
|
|
63
|
+
* @return {module:model/CreateSubmissionBatchRequest} The populated <code>CreateSubmissionBatchRequest</code> instance.
|
|
63
64
|
*/
|
|
64
65
|
}, {
|
|
65
66
|
key: "constructFromObject",
|
|
66
67
|
value: function constructFromObject(data, obj) {
|
|
67
68
|
if (data) {
|
|
68
|
-
obj = obj || new
|
|
69
|
-
if (data.hasOwnProperty('data')) {
|
|
70
|
-
obj['data'] = _ApiClient["default"].convertToType(data['data'], Object);
|
|
71
|
-
}
|
|
72
|
-
if (data.hasOwnProperty('data_requests')) {
|
|
73
|
-
obj['data_requests'] = _ApiClient["default"].convertToType(data['data_requests'], [_CreateSubmissionDataRequestData["default"]]);
|
|
74
|
-
}
|
|
75
|
-
if (data.hasOwnProperty('editable')) {
|
|
76
|
-
obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
|
|
77
|
-
}
|
|
78
|
-
if (data.hasOwnProperty('expires_in')) {
|
|
79
|
-
obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
|
|
80
|
-
}
|
|
81
|
-
if (data.hasOwnProperty('field_overrides')) {
|
|
82
|
-
obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], Object);
|
|
83
|
-
}
|
|
69
|
+
obj = obj || new CreateSubmissionBatchRequest();
|
|
84
70
|
if (data.hasOwnProperty('metadata')) {
|
|
85
|
-
obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'],
|
|
71
|
+
obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
|
|
72
|
+
'String': Object
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
if (data.hasOwnProperty('template_id')) {
|
|
76
|
+
obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
|
|
86
77
|
}
|
|
87
|
-
if (data.hasOwnProperty('
|
|
88
|
-
obj['
|
|
78
|
+
if (data.hasOwnProperty('template_version')) {
|
|
79
|
+
obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
|
|
89
80
|
}
|
|
90
81
|
if (data.hasOwnProperty('test')) {
|
|
91
82
|
obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
|
|
92
83
|
}
|
|
93
|
-
if (data.hasOwnProperty('
|
|
94
|
-
obj['
|
|
84
|
+
if (data.hasOwnProperty('submissions')) {
|
|
85
|
+
obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_SubmissionInput["default"]]);
|
|
95
86
|
}
|
|
96
87
|
}
|
|
97
88
|
return obj;
|
|
98
89
|
}
|
|
99
90
|
|
|
100
91
|
/**
|
|
101
|
-
* Validates the JSON data with respect to <code>
|
|
92
|
+
* Validates the JSON data with respect to <code>CreateSubmissionBatchRequest</code>.
|
|
102
93
|
* @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>
|
|
94
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSubmissionBatchRequest</code>.
|
|
104
95
|
*/
|
|
105
96
|
}, {
|
|
106
97
|
key: "validateJSON",
|
|
107
98
|
value: function validateJSON(data) {
|
|
108
99
|
// check to make sure all required properties are present in the JSON string
|
|
109
|
-
var _iterator = _createForOfIteratorHelper(
|
|
100
|
+
var _iterator = _createForOfIteratorHelper(CreateSubmissionBatchRequest.RequiredProperties),
|
|
110
101
|
_step;
|
|
111
102
|
try {
|
|
112
103
|
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
@@ -115,24 +106,32 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
|
|
|
115
106
|
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
116
107
|
}
|
|
117
108
|
}
|
|
109
|
+
// ensure the json data is a string
|
|
118
110
|
} catch (err) {
|
|
119
111
|
_iterator.e(err);
|
|
120
112
|
} finally {
|
|
121
113
|
_iterator.f();
|
|
122
114
|
}
|
|
123
|
-
if (data['
|
|
115
|
+
if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
|
|
116
|
+
throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
|
|
117
|
+
}
|
|
118
|
+
// ensure the json data is a string
|
|
119
|
+
if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
|
|
120
|
+
throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
|
|
121
|
+
}
|
|
122
|
+
if (data['submissions']) {
|
|
124
123
|
// data not null
|
|
125
124
|
// ensure the json data is an array
|
|
126
|
-
if (!Array.isArray(data['
|
|
127
|
-
throw new Error("Expected the field `
|
|
125
|
+
if (!Array.isArray(data['submissions'])) {
|
|
126
|
+
throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
|
|
128
127
|
}
|
|
129
|
-
// validate the optional field `
|
|
130
|
-
var _iterator2 = _createForOfIteratorHelper(data['
|
|
128
|
+
// validate the optional field `submissions` (array)
|
|
129
|
+
var _iterator2 = _createForOfIteratorHelper(data['submissions']),
|
|
131
130
|
_step2;
|
|
132
131
|
try {
|
|
133
132
|
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
|
134
133
|
var item = _step2.value;
|
|
135
|
-
|
|
134
|
+
_SubmissionInput["default"].validateJSON(item);
|
|
136
135
|
}
|
|
137
136
|
} catch (err) {
|
|
138
137
|
_iterator2.e(err);
|
|
@@ -141,62 +140,39 @@ var CreatePdfSubmissionData = /*#__PURE__*/function () {
|
|
|
141
140
|
}
|
|
142
141
|
;
|
|
143
142
|
}
|
|
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']);
|
|
147
|
-
}
|
|
148
|
-
// 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']);
|
|
151
|
-
}
|
|
152
143
|
return true;
|
|
153
144
|
}
|
|
154
145
|
}]);
|
|
155
146
|
}();
|
|
156
|
-
|
|
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;
|
|
147
|
+
CreateSubmissionBatchRequest.RequiredProperties = ["submissions"];
|
|
177
148
|
|
|
178
149
|
/**
|
|
179
|
-
*
|
|
150
|
+
* Your own data about the batch, such as an ID from your app.
|
|
151
|
+
* @member {Object.<String, Object>} metadata
|
|
180
152
|
*/
|
|
181
|
-
|
|
153
|
+
CreateSubmissionBatchRequest.prototype['metadata'] = undefined;
|
|
182
154
|
|
|
183
155
|
/**
|
|
184
|
-
*
|
|
156
|
+
* The template for each submission that doesn't name its own `template_id`.
|
|
157
|
+
* @member {String} template_id
|
|
185
158
|
*/
|
|
186
|
-
|
|
159
|
+
CreateSubmissionBatchRequest.prototype['template_id'] = undefined;
|
|
187
160
|
|
|
188
161
|
/**
|
|
189
|
-
*
|
|
162
|
+
* 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).
|
|
163
|
+
* @member {String} template_version
|
|
190
164
|
*/
|
|
191
|
-
|
|
165
|
+
CreateSubmissionBatchRequest.prototype['template_version'] = undefined;
|
|
192
166
|
|
|
193
167
|
/**
|
|
168
|
+
* The default `test` for each submission that doesn't set its own.
|
|
194
169
|
* @member {Boolean} test
|
|
195
170
|
*/
|
|
196
|
-
|
|
171
|
+
CreateSubmissionBatchRequest.prototype['test'] = undefined;
|
|
197
172
|
|
|
198
173
|
/**
|
|
199
|
-
*
|
|
174
|
+
* 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.
|
|
175
|
+
* @member {Array.<module:model/SubmissionInput>} submissions
|
|
200
176
|
*/
|
|
201
|
-
|
|
202
|
-
var _default = exports["default"] =
|
|
177
|
+
CreateSubmissionBatchRequest.prototype['submissions'] = undefined;
|
|
178
|
+
var _default = exports["default"] = CreateSubmissionBatchRequest;
|
|
@@ -0,0 +1,212 @@
|
|
|
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 _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
|
|
9
|
+
var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
|
|
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 CreateSubmissionRequest model module.
|
|
33
|
+
* @module model/CreateSubmissionRequest
|
|
34
|
+
* @version 4.0.0
|
|
35
|
+
*/
|
|
36
|
+
var CreateSubmissionRequest = /*#__PURE__*/function () {
|
|
37
|
+
/**
|
|
38
|
+
* Constructs a new <code>CreateSubmissionRequest</code>.
|
|
39
|
+
* The submission's data and settings.
|
|
40
|
+
* @alias module:model/CreateSubmissionRequest
|
|
41
|
+
*/
|
|
42
|
+
function CreateSubmissionRequest() {
|
|
43
|
+
_classCallCheck(this, CreateSubmissionRequest);
|
|
44
|
+
CreateSubmissionRequest.initialize(this);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Initializes the fields of this object.
|
|
49
|
+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
50
|
+
* Only for internal use.
|
|
51
|
+
*/
|
|
52
|
+
return _createClass(CreateSubmissionRequest, null, [{
|
|
53
|
+
key: "initialize",
|
|
54
|
+
value: function initialize(obj) {}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Constructs a <code>CreateSubmissionRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
58
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
59
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
60
|
+
* @param {module:model/CreateSubmissionRequest} obj Optional instance to populate.
|
|
61
|
+
* @return {module:model/CreateSubmissionRequest} The populated <code>CreateSubmissionRequest</code> instance.
|
|
62
|
+
*/
|
|
63
|
+
}, {
|
|
64
|
+
key: "constructFromObject",
|
|
65
|
+
value: function constructFromObject(data, obj) {
|
|
66
|
+
if (data) {
|
|
67
|
+
obj = obj || new CreateSubmissionRequest();
|
|
68
|
+
if (data.hasOwnProperty('test')) {
|
|
69
|
+
obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
|
|
70
|
+
}
|
|
71
|
+
if (data.hasOwnProperty('editable')) {
|
|
72
|
+
obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
|
|
73
|
+
}
|
|
74
|
+
if (data.hasOwnProperty('data')) {
|
|
75
|
+
obj['data'] = _ApiClient["default"].convertToType(data['data'], {
|
|
76
|
+
'String': Object
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
if (data.hasOwnProperty('metadata')) {
|
|
80
|
+
obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
|
|
81
|
+
'String': Object
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
if (data.hasOwnProperty('password')) {
|
|
85
|
+
obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
|
|
86
|
+
}
|
|
87
|
+
if (data.hasOwnProperty('expires_in')) {
|
|
88
|
+
obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
|
|
89
|
+
}
|
|
90
|
+
if (data.hasOwnProperty('field_overrides')) {
|
|
91
|
+
obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], {
|
|
92
|
+
'String': _FieldOverride["default"]
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
if (data.hasOwnProperty('html')) {
|
|
96
|
+
obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
|
|
97
|
+
}
|
|
98
|
+
if (data.hasOwnProperty('css')) {
|
|
99
|
+
obj['css'] = _ApiClient["default"].convertToType(data['css'], 'String');
|
|
100
|
+
}
|
|
101
|
+
if (data.hasOwnProperty('signature_requests')) {
|
|
102
|
+
obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
return obj;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Validates the JSON data with respect to <code>CreateSubmissionRequest</code>.
|
|
110
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
111
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSubmissionRequest</code>.
|
|
112
|
+
*/
|
|
113
|
+
}, {
|
|
114
|
+
key: "validateJSON",
|
|
115
|
+
value: function validateJSON(data) {
|
|
116
|
+
// ensure the json data is a string
|
|
117
|
+
if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
|
|
118
|
+
throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
|
|
119
|
+
}
|
|
120
|
+
// ensure the json data is a string
|
|
121
|
+
if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
|
|
122
|
+
throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
|
|
123
|
+
}
|
|
124
|
+
// ensure the json data is a string
|
|
125
|
+
if (data['css'] && !(typeof data['css'] === 'string' || data['css'] instanceof String)) {
|
|
126
|
+
throw new Error("Expected the field `css` to be a primitive type in the JSON string but got " + data['css']);
|
|
127
|
+
}
|
|
128
|
+
if (data['signature_requests']) {
|
|
129
|
+
// data not null
|
|
130
|
+
// ensure the json data is an array
|
|
131
|
+
if (!Array.isArray(data['signature_requests'])) {
|
|
132
|
+
throw new Error("Expected the field `signature_requests` to be an array in the JSON data but got " + data['signature_requests']);
|
|
133
|
+
}
|
|
134
|
+
// validate the optional field `signature_requests` (array)
|
|
135
|
+
var _iterator = _createForOfIteratorHelper(data['signature_requests']),
|
|
136
|
+
_step;
|
|
137
|
+
try {
|
|
138
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
139
|
+
var item = _step.value;
|
|
140
|
+
_SignatureRequestInput["default"].validateJSON(item);
|
|
141
|
+
}
|
|
142
|
+
} catch (err) {
|
|
143
|
+
_iterator.e(err);
|
|
144
|
+
} finally {
|
|
145
|
+
_iterator.f();
|
|
146
|
+
}
|
|
147
|
+
;
|
|
148
|
+
}
|
|
149
|
+
return true;
|
|
150
|
+
}
|
|
151
|
+
}]);
|
|
152
|
+
}();
|
|
153
|
+
/**
|
|
154
|
+
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
155
|
+
* @member {Boolean} test
|
|
156
|
+
*/
|
|
157
|
+
CreateSubmissionRequest.prototype['test'] = undefined;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
161
|
+
* @member {Boolean} editable
|
|
162
|
+
*/
|
|
163
|
+
CreateSubmissionRequest.prototype['editable'] = undefined;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
|
|
167
|
+
* @member {Object.<String, Object>} data
|
|
168
|
+
*/
|
|
169
|
+
CreateSubmissionRequest.prototype['data'] = undefined;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
|
|
173
|
+
* @member {Object.<String, Object>} metadata
|
|
174
|
+
*/
|
|
175
|
+
CreateSubmissionRequest.prototype['metadata'] = undefined;
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
|
|
179
|
+
* @member {String} password
|
|
180
|
+
*/
|
|
181
|
+
CreateSubmissionRequest.prototype['password'] = undefined;
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
|
|
185
|
+
* @member {Number} expires_in
|
|
186
|
+
*/
|
|
187
|
+
CreateSubmissionRequest.prototype['expires_in'] = undefined;
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
|
|
191
|
+
* @member {Object.<String, module:model/FieldOverride>} field_overrides
|
|
192
|
+
*/
|
|
193
|
+
CreateSubmissionRequest.prototype['field_overrides'] = undefined;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* For an HTML template, HTML to use instead of the template's.
|
|
197
|
+
* @member {String} html
|
|
198
|
+
*/
|
|
199
|
+
CreateSubmissionRequest.prototype['html'] = undefined;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* For an HTML template, CSS to use instead of the template's.
|
|
203
|
+
* @member {String} css
|
|
204
|
+
*/
|
|
205
|
+
CreateSubmissionRequest.prototype['css'] = undefined;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
|
|
209
|
+
* @member {Array.<module:model/SignatureRequestInput>} signature_requests
|
|
210
|
+
*/
|
|
211
|
+
CreateSubmissionRequest.prototype['signature_requests'] = undefined;
|
|
212
|
+
var _default = exports["default"] = CreateSubmissionRequest;
|