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.
- package/AGENTS.md +79 -19
- package/README.md +74 -63
- package/dist/ApiClient.js +63 -28
- package/dist/RequestSchemas.js +3452 -0
- package/dist/RequestValidator.js +494 -0
- package/dist/api/Client.js +1769 -921
- package/dist/index.js +847 -154
- package/dist/model/AddTemplateFieldsRequest.js +132 -0
- package/dist/model/AiFieldNamingLanguage.js +64 -0
- package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
- 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} +27 -27
- package/dist/model/CombinedPdfList.js +132 -0
- package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
- package/dist/model/CombinedPdfSourceInput.js +270 -0
- package/dist/model/CombinedPdfSourcePdf.js +130 -0
- package/dist/model/CombinedPdfSourceType.js +74 -0
- package/dist/model/CombinedPdfState.js +74 -0
- package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
- package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
- package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
- package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
- package/dist/model/{CreateCustomFileResponse.js → CreateSignatureRequestEventRequest.js} +49 -73
- package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
- package/dist/model/CreateSubmissionBatchRequest.js +192 -0
- package/dist/model/CreateSubmissionRequest.js +226 -0
- package/dist/model/CreateTemplateRequest.js +613 -0
- package/dist/model/CreateWebhookRequest.js +234 -0
- package/dist/model/CustomFile.js +67 -16
- package/dist/model/CustomFileList.js +132 -0
- package/dist/model/CustomFileSourcePdf.js +130 -0
- package/dist/model/ErrorCode.js +154 -0
- package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
- package/dist/model/ErrorInfo.js +211 -0
- package/dist/model/ErrorResponse.js +12 -41
- package/dist/model/ExpirationInterval.js +64 -0
- package/dist/model/Field.js +1230 -0
- package/dist/model/FieldComparisonCondition.js +137 -0
- package/dist/model/FieldComparisonOperator.js +69 -0
- package/dist/model/FieldDependency.js +154 -0
- package/dist/model/FieldDependencyInput.js +154 -0
- package/dist/model/FieldDisplayType.js +79 -0
- package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
- package/dist/model/FieldEqualsOperator.js +59 -0
- package/dist/model/FieldGroup.js +206 -0
- package/dist/model/FieldGroupInput.js +180 -0
- package/dist/model/FieldGroupType.js +59 -0
- package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
- package/dist/model/FieldInput.js +1012 -0
- package/dist/model/FieldOverride.js +722 -0
- package/dist/model/FieldPresenceCondition.js +126 -0
- 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/FieldType.js +124 -0
- package/dist/model/Folder.js +38 -11
- package/dist/model/FolderList.js +132 -0
- package/dist/model/GenerateFilesFormat.js +54 -0
- package/dist/model/GenerateSubmissionFilesRequest.js +115 -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} +34 -28
- package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
- package/dist/model/NumberConditionType.js +79 -0
- package/dist/model/OutputFormat.js +59 -0
- package/dist/model/PageFormat.js +114 -0
- package/dist/model/PageImage.js +220 -0
- package/dist/model/{TemplateDeleteResponse.js → PageImages.js} +57 -70
- package/dist/model/PredefinedField.js +183 -0
- package/dist/model/PredefinedFieldInput.js +183 -0
- package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
- package/dist/model/{AddFieldsData.js → RemoveTemplateFieldsRequest.js} +32 -30
- package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
- package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
- package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
- package/dist/model/ShapeType.js +79 -0
- package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
- package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
- package/dist/model/SignatureRequestAuthType.js +84 -0
- package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
- 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 +198 -341
- package/dist/model/SubmissionAction.js +30 -115
- package/dist/model/SubmissionActionState.js +69 -0
- package/dist/model/SubmissionActionType.js +84 -0
- package/dist/model/SubmissionBatch.js +74 -55
- package/dist/model/SubmissionBatchState.js +64 -0
- package/dist/model/SubmissionFiles.js +117 -0
- package/dist/model/SubmissionInput.js +218 -0
- package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
- package/dist/model/SubmissionSource.js +69 -0
- package/dist/model/SubmissionSourcePdf.js +130 -0
- package/dist/model/SubmissionState.js +114 -0
- package/dist/model/{SubmissionBatchData.js → SubmissionValidation.js} +46 -48
- package/dist/model/Template.js +359 -560
- 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/TemplateDiff.js +206 -0
- package/dist/model/TemplateDiffSummary.js +165 -0
- package/dist/model/TemplateDocument.js +280 -0
- package/dist/model/TemplateDocumentState.js +84 -0
- package/dist/model/TemplateFieldChange.js +146 -0
- package/dist/model/TemplateFieldChanges.js +196 -0
- package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
- package/dist/model/TemplateFieldDependencyAction.js +64 -0
- package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -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/{CreatePdfTemplate.js → TemplateFieldMove.js} +52 -28
- package/dist/model/TemplateFields.js +147 -0
- package/dist/model/TemplateFormMode.js +64 -0
- package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
- 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/TemplatePageImages.js +158 -0
- package/dist/model/TemplatePageProcessingStatus.js +162 -0
- package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
- package/dist/model/TemplateSummary.js +560 -0
- package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
- package/dist/model/TemplateType.js +59 -0
- package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
- 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/UpdateTemplateDocumentRequest.js +139 -0
- package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
- package/dist/model/UpdateTemplateRequest.js +523 -0
- package/dist/model/UpdateWebhookRequest.js +209 -0
- package/dist/model/UploadMethod.js +54 -0
- package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
- package/dist/model/UrlSourcePdf.js +130 -0
- package/dist/model/ValidateSubmissionRequest.js +226 -0
- package/dist/model/Webhook.js +58 -73
- 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/BatchGeneratePdfs201Response.js +0 -194
- package/dist/model/CombinedSubmission.js +0 -313
- package/dist/model/CombinedSubmissionAction.js +0 -268
- package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
- package/dist/model/CreateHtmlTemplate.js +0 -108
- package/dist/model/CreateSubmissionDataRequestData.js +0 -314
- package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
- package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
- package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
- package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
- package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
- 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 -509
- package/dist/model/TemplateAddFieldsResponse.js +0 -156
- package/dist/model/TemplatePreview.js +0 -796
- package/dist/model/UpdateHtmlTemplate.js +0 -108
- package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
- package/dist/model/UpdateWebhookData.js +0 -108
|
@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _GeneratedFileState = _interopRequireDefault(require("./GeneratedFileState"));
|
|
9
|
+
var _PageImage = _interopRequireDefault(require("./PageImage"));
|
|
8
10
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
9
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); }
|
|
10
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; } } }; }
|
|
@@ -16,9 +18,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
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); } /**
|
|
18
20
|
* 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.
|
|
21
|
+
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
20
22
|
*
|
|
21
|
-
* The version of the OpenAPI document:
|
|
23
|
+
* The version of the OpenAPI document: v2
|
|
22
24
|
*
|
|
23
25
|
*
|
|
24
26
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -27,20 +29,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
27
29
|
*
|
|
28
30
|
*/
|
|
29
31
|
/**
|
|
30
|
-
* The
|
|
31
|
-
* @module model/
|
|
32
|
-
* @version
|
|
32
|
+
* The PageImages model module.
|
|
33
|
+
* @module model/PageImages
|
|
34
|
+
* @version 4.1.0
|
|
33
35
|
*/
|
|
34
|
-
var
|
|
36
|
+
var PageImages = /*#__PURE__*/function () {
|
|
35
37
|
/**
|
|
36
|
-
* Constructs a new <code>
|
|
37
|
-
*
|
|
38
|
+
* Constructs a new <code>PageImages</code>.
|
|
39
|
+
* A PNG image of each page of the submission's PDF (the `png` output format), at 140 DPI: a US Letter page is 1190 x 1540 pixels.
|
|
40
|
+
* @alias module:model/PageImages
|
|
38
41
|
* @extends Object
|
|
39
|
-
* @param
|
|
42
|
+
* @param state {module:model/GeneratedFileState} `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`).
|
|
43
|
+
* @param error_message {String} Why the images couldn't be made, when `state` is `error`.
|
|
44
|
+
* @param page_count {Number} How many pages have an image. Null until the images have been made.
|
|
45
|
+
* @param pages {Array.<module:model/PageImage>} An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made.
|
|
40
46
|
*/
|
|
41
|
-
function
|
|
42
|
-
_classCallCheck(this,
|
|
43
|
-
|
|
47
|
+
function PageImages(state, error_message, page_count, pages) {
|
|
48
|
+
_classCallCheck(this, PageImages);
|
|
49
|
+
PageImages.initialize(this, state, error_message, page_count, pages);
|
|
44
50
|
}
|
|
45
51
|
|
|
46
52
|
/**
|
|
@@ -48,51 +54,54 @@ var TemplateDeleteResponse = /*#__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(
|
|
57
|
+
return _createClass(PageImages, null, [{
|
|
52
58
|
key: "initialize",
|
|
53
|
-
value: function initialize(obj,
|
|
54
|
-
obj['
|
|
59
|
+
value: function initialize(obj, state, error_message, page_count, pages) {
|
|
60
|
+
obj['state'] = state;
|
|
61
|
+
obj['error_message'] = error_message;
|
|
62
|
+
obj['page_count'] = page_count;
|
|
63
|
+
obj['pages'] = pages;
|
|
55
64
|
}
|
|
56
65
|
|
|
57
66
|
/**
|
|
58
|
-
* Constructs a <code>
|
|
67
|
+
* Constructs a <code>PageImages</code> from a plain JavaScript object, optionally creating a new instance.
|
|
59
68
|
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
60
69
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
61
|
-
* @param {module:model/
|
|
62
|
-
* @return {module:model/
|
|
70
|
+
* @param {module:model/PageImages} obj Optional instance to populate.
|
|
71
|
+
* @return {module:model/PageImages} The populated <code>PageImages</code> instance.
|
|
63
72
|
*/
|
|
64
73
|
}, {
|
|
65
74
|
key: "constructFromObject",
|
|
66
75
|
value: function constructFromObject(data, obj) {
|
|
67
76
|
if (data) {
|
|
68
|
-
obj = obj || new
|
|
77
|
+
obj = obj || new PageImages();
|
|
69
78
|
_ApiClient["default"].constructFromObject(data, obj, 'Object');
|
|
70
|
-
if (data.hasOwnProperty('
|
|
71
|
-
obj['
|
|
79
|
+
if (data.hasOwnProperty('state')) {
|
|
80
|
+
obj['state'] = _ApiClient["default"].convertToType(data['state'], _GeneratedFileState["default"]);
|
|
72
81
|
}
|
|
73
|
-
if (data.hasOwnProperty('
|
|
74
|
-
obj['
|
|
82
|
+
if (data.hasOwnProperty('error_message')) {
|
|
83
|
+
obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
|
|
75
84
|
}
|
|
76
|
-
if (data.hasOwnProperty('
|
|
77
|
-
obj['
|
|
85
|
+
if (data.hasOwnProperty('page_count')) {
|
|
86
|
+
obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
|
|
78
87
|
}
|
|
79
|
-
if (data.hasOwnProperty('
|
|
80
|
-
obj['
|
|
88
|
+
if (data.hasOwnProperty('pages')) {
|
|
89
|
+
obj['pages'] = _ApiClient["default"].convertToType(data['pages'], [_PageImage["default"]]);
|
|
81
90
|
}
|
|
82
91
|
}
|
|
83
92
|
return obj;
|
|
84
93
|
}
|
|
85
94
|
|
|
86
95
|
/**
|
|
87
|
-
* Validates the JSON data with respect to <code>
|
|
96
|
+
* Validates the JSON data with respect to <code>PageImages</code>.
|
|
88
97
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
89
|
-
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>
|
|
98
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>PageImages</code>.
|
|
90
99
|
*/
|
|
91
100
|
}, {
|
|
92
101
|
key: "validateJSON",
|
|
93
102
|
value: function validateJSON(data) {
|
|
94
103
|
// check to make sure all required properties are present in the JSON string
|
|
95
|
-
var _iterator = _createForOfIteratorHelper(
|
|
104
|
+
var _iterator = _createForOfIteratorHelper(PageImages.RequiredProperties),
|
|
96
105
|
_step;
|
|
97
106
|
try {
|
|
98
107
|
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
@@ -107,62 +116,40 @@ var TemplateDeleteResponse = /*#__PURE__*/function () {
|
|
|
107
116
|
} finally {
|
|
108
117
|
_iterator.f();
|
|
109
118
|
}
|
|
110
|
-
if (data['
|
|
111
|
-
throw new Error("Expected the field `
|
|
119
|
+
if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
|
|
120
|
+
throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
|
|
112
121
|
}
|
|
113
122
|
// ensure the json data is an array
|
|
114
|
-
if (!Array.isArray(data['
|
|
115
|
-
throw new Error("Expected the field `
|
|
116
|
-
}
|
|
117
|
-
// ensure the json data is a string
|
|
118
|
-
if (data['latest_version'] && !(typeof data['latest_version'] === 'string' || data['latest_version'] instanceof String)) {
|
|
119
|
-
throw new Error("Expected the field `latest_version` to be a primitive type in the JSON string but got " + data['latest_version']);
|
|
120
|
-
}
|
|
121
|
-
// ensure the json data is an array
|
|
122
|
-
if (!Array.isArray(data['versions'])) {
|
|
123
|
-
throw new Error("Expected the field `versions` to be an array in the JSON data but got " + data['versions']);
|
|
123
|
+
if (!Array.isArray(data['pages'])) {
|
|
124
|
+
throw new Error("Expected the field `pages` to be an array in the JSON data but got " + data['pages']);
|
|
124
125
|
}
|
|
125
126
|
return true;
|
|
126
127
|
}
|
|
127
128
|
}]);
|
|
128
129
|
}();
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* @member {module:model/TemplateDeleteResponse.StatusEnum} status
|
|
133
|
-
*/
|
|
134
|
-
TemplateDeleteResponse.prototype['status'] = undefined;
|
|
130
|
+
PageImages.RequiredProperties = ["state", "error_message", "page_count", "pages"];
|
|
135
131
|
|
|
136
132
|
/**
|
|
137
|
-
*
|
|
133
|
+
* `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`).
|
|
134
|
+
* @member {module:model/GeneratedFileState} state
|
|
138
135
|
*/
|
|
139
|
-
|
|
136
|
+
PageImages.prototype['state'] = undefined;
|
|
140
137
|
|
|
141
138
|
/**
|
|
142
|
-
*
|
|
139
|
+
* Why the images couldn't be made, when `state` is `error`.
|
|
140
|
+
* @member {String} error_message
|
|
143
141
|
*/
|
|
144
|
-
|
|
142
|
+
PageImages.prototype['error_message'] = undefined;
|
|
145
143
|
|
|
146
144
|
/**
|
|
147
|
-
*
|
|
145
|
+
* How many pages have an image. Null until the images have been made.
|
|
146
|
+
* @member {Number} page_count
|
|
148
147
|
*/
|
|
149
|
-
|
|
148
|
+
PageImages.prototype['page_count'] = undefined;
|
|
150
149
|
|
|
151
150
|
/**
|
|
152
|
-
*
|
|
153
|
-
* @
|
|
154
|
-
* @readonly
|
|
151
|
+
* An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made.
|
|
152
|
+
* @member {Array.<module:model/PageImage>} pages
|
|
155
153
|
*/
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
* value: "success"
|
|
159
|
-
* @const
|
|
160
|
-
*/
|
|
161
|
-
"success": "success",
|
|
162
|
-
/**
|
|
163
|
-
* value: "error"
|
|
164
|
-
* @const
|
|
165
|
-
*/
|
|
166
|
-
"error": "error"
|
|
167
|
-
};
|
|
168
|
-
var _default = exports["default"] = TemplateDeleteResponse;
|
|
154
|
+
PageImages.prototype['pages'] = undefined;
|
|
155
|
+
var _default = exports["default"] = PageImages;
|
|
@@ -0,0 +1,183 @@
|
|
|
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 _FieldType = _interopRequireDefault(require("./FieldType"));
|
|
9
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
10
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
11
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
12
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
13
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
14
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
15
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
16
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
17
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
|
+
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
19
|
+
* DocSpring API
|
|
20
|
+
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
21
|
+
*
|
|
22
|
+
* The version of the OpenAPI document: v2
|
|
23
|
+
*
|
|
24
|
+
*
|
|
25
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
26
|
+
* https://openapi-generator.tech
|
|
27
|
+
* Do not edit the class manually.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* The PredefinedField model module.
|
|
32
|
+
* @module model/PredefinedField
|
|
33
|
+
* @version 4.1.0
|
|
34
|
+
*/
|
|
35
|
+
var PredefinedField = /*#__PURE__*/function () {
|
|
36
|
+
/**
|
|
37
|
+
* Constructs a new <code>PredefinedField</code>.
|
|
38
|
+
* A field name that people using the embedded template editor can choose from, with the data type and settings a field gets when it's given that name.
|
|
39
|
+
* @alias module:model/PredefinedField
|
|
40
|
+
* @param name {String} The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
|
|
41
|
+
* @param type {module:model/FieldType} The data type a field gets when it's given this name, as a field's `type`.
|
|
42
|
+
*/
|
|
43
|
+
function PredefinedField(name, type) {
|
|
44
|
+
_classCallCheck(this, PredefinedField);
|
|
45
|
+
PredefinedField.initialize(this, name, type);
|
|
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(PredefinedField, null, [{
|
|
54
|
+
key: "initialize",
|
|
55
|
+
value: function initialize(obj, name, type) {
|
|
56
|
+
obj['name'] = name;
|
|
57
|
+
obj['type'] = type;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Constructs a <code>PredefinedField</code> from a plain JavaScript object, optionally creating a new instance.
|
|
62
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
63
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
64
|
+
* @param {module:model/PredefinedField} obj Optional instance to populate.
|
|
65
|
+
* @return {module:model/PredefinedField} The populated <code>PredefinedField</code> instance.
|
|
66
|
+
*/
|
|
67
|
+
}, {
|
|
68
|
+
key: "constructFromObject",
|
|
69
|
+
value: function constructFromObject(data, obj) {
|
|
70
|
+
if (data) {
|
|
71
|
+
obj = obj || new PredefinedField();
|
|
72
|
+
if (data.hasOwnProperty('name')) {
|
|
73
|
+
obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
|
|
74
|
+
}
|
|
75
|
+
if (data.hasOwnProperty('display_name')) {
|
|
76
|
+
obj['display_name'] = _ApiClient["default"].convertToType(data['display_name'], 'String');
|
|
77
|
+
}
|
|
78
|
+
if (data.hasOwnProperty('title')) {
|
|
79
|
+
obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
|
|
80
|
+
}
|
|
81
|
+
if (data.hasOwnProperty('type')) {
|
|
82
|
+
obj['type'] = _ApiClient["default"].convertToType(data['type'], _FieldType["default"]);
|
|
83
|
+
}
|
|
84
|
+
if (data.hasOwnProperty('option_list')) {
|
|
85
|
+
obj['option_list'] = _ApiClient["default"].convertToType(data['option_list'], 'String');
|
|
86
|
+
}
|
|
87
|
+
if (data.hasOwnProperty('required_in_template')) {
|
|
88
|
+
obj['required_in_template'] = _ApiClient["default"].convertToType(data['required_in_template'], 'Boolean');
|
|
89
|
+
}
|
|
90
|
+
if (data.hasOwnProperty('field_required')) {
|
|
91
|
+
obj['field_required'] = _ApiClient["default"].convertToType(data['field_required'], 'Boolean');
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
return obj;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Validates the JSON data with respect to <code>PredefinedField</code>.
|
|
99
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
100
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>PredefinedField</code>.
|
|
101
|
+
*/
|
|
102
|
+
}, {
|
|
103
|
+
key: "validateJSON",
|
|
104
|
+
value: function validateJSON(data) {
|
|
105
|
+
// check to make sure all required properties are present in the JSON string
|
|
106
|
+
var _iterator = _createForOfIteratorHelper(PredefinedField.RequiredProperties),
|
|
107
|
+
_step;
|
|
108
|
+
try {
|
|
109
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
110
|
+
var property = _step.value;
|
|
111
|
+
if (!data.hasOwnProperty(property)) {
|
|
112
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
// ensure the json data is a string
|
|
116
|
+
} catch (err) {
|
|
117
|
+
_iterator.e(err);
|
|
118
|
+
} finally {
|
|
119
|
+
_iterator.f();
|
|
120
|
+
}
|
|
121
|
+
if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
|
|
122
|
+
throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
|
|
123
|
+
}
|
|
124
|
+
// ensure the json data is a string
|
|
125
|
+
if (data['display_name'] && !(typeof data['display_name'] === 'string' || data['display_name'] instanceof String)) {
|
|
126
|
+
throw new Error("Expected the field `display_name` to be a primitive type in the JSON string but got " + data['display_name']);
|
|
127
|
+
}
|
|
128
|
+
// ensure the json data is a string
|
|
129
|
+
if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
|
|
130
|
+
throw new Error("Expected the field `title` to be a primitive type in the JSON string but got " + data['title']);
|
|
131
|
+
}
|
|
132
|
+
// ensure the json data is a string
|
|
133
|
+
if (data['option_list'] && !(typeof data['option_list'] === 'string' || data['option_list'] instanceof String)) {
|
|
134
|
+
throw new Error("Expected the field `option_list` to be a primitive type in the JSON string but got " + data['option_list']);
|
|
135
|
+
}
|
|
136
|
+
return true;
|
|
137
|
+
}
|
|
138
|
+
}]);
|
|
139
|
+
}();
|
|
140
|
+
PredefinedField.RequiredProperties = ["name", "type"];
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
|
|
144
|
+
* @member {String} name
|
|
145
|
+
*/
|
|
146
|
+
PredefinedField.prototype['name'] = undefined;
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name.
|
|
150
|
+
* @member {String} display_name
|
|
151
|
+
*/
|
|
152
|
+
PredefinedField.prototype['display_name'] = undefined;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* The Title setting a field gets when it's given this name. Null leaves the field's title as it is.
|
|
156
|
+
* @member {String} title
|
|
157
|
+
*/
|
|
158
|
+
PredefinedField.prototype['title'] = undefined;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* The data type a field gets when it's given this name, as a field's `type`.
|
|
162
|
+
* @member {module:model/FieldType} type
|
|
163
|
+
*/
|
|
164
|
+
PredefinedField.prototype['type'] = undefined;
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value.
|
|
168
|
+
* @member {String} option_list
|
|
169
|
+
*/
|
|
170
|
+
PredefinedField.prototype['option_list'] = undefined;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false.
|
|
174
|
+
* @member {Boolean} required_in_template
|
|
175
|
+
*/
|
|
176
|
+
PredefinedField.prototype['required_in_template'] = undefined;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* The Required setting a field gets when it's given this name. Default true.
|
|
180
|
+
* @member {Boolean} field_required
|
|
181
|
+
*/
|
|
182
|
+
PredefinedField.prototype['field_required'] = undefined;
|
|
183
|
+
var _default = exports["default"] = PredefinedField;
|
|
@@ -0,0 +1,183 @@
|
|
|
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 _FieldType = _interopRequireDefault(require("./FieldType"));
|
|
9
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
10
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
11
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
12
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
13
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
14
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
15
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
16
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
17
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
|
+
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
19
|
+
* DocSpring API
|
|
20
|
+
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
21
|
+
*
|
|
22
|
+
* The version of the OpenAPI document: v2
|
|
23
|
+
*
|
|
24
|
+
*
|
|
25
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
26
|
+
* https://openapi-generator.tech
|
|
27
|
+
* Do not edit the class manually.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* The PredefinedFieldInput model module.
|
|
32
|
+
* @module model/PredefinedFieldInput
|
|
33
|
+
* @version 4.1.0
|
|
34
|
+
*/
|
|
35
|
+
var PredefinedFieldInput = /*#__PURE__*/function () {
|
|
36
|
+
/**
|
|
37
|
+
* Constructs a new <code>PredefinedFieldInput</code>.
|
|
38
|
+
* A field name that people using the embedded template editor can choose from, with the data type and settings a field gets when it's given that name.
|
|
39
|
+
* @alias module:model/PredefinedFieldInput
|
|
40
|
+
* @param name {String} The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
|
|
41
|
+
* @param type {module:model/FieldType} The data type a field gets when it's given this name, as a field's `type`.
|
|
42
|
+
*/
|
|
43
|
+
function PredefinedFieldInput(name, type) {
|
|
44
|
+
_classCallCheck(this, PredefinedFieldInput);
|
|
45
|
+
PredefinedFieldInput.initialize(this, name, type);
|
|
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(PredefinedFieldInput, null, [{
|
|
54
|
+
key: "initialize",
|
|
55
|
+
value: function initialize(obj, name, type) {
|
|
56
|
+
obj['name'] = name;
|
|
57
|
+
obj['type'] = type;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Constructs a <code>PredefinedFieldInput</code> from a plain JavaScript object, optionally creating a new instance.
|
|
62
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
63
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
64
|
+
* @param {module:model/PredefinedFieldInput} obj Optional instance to populate.
|
|
65
|
+
* @return {module:model/PredefinedFieldInput} The populated <code>PredefinedFieldInput</code> instance.
|
|
66
|
+
*/
|
|
67
|
+
}, {
|
|
68
|
+
key: "constructFromObject",
|
|
69
|
+
value: function constructFromObject(data, obj) {
|
|
70
|
+
if (data) {
|
|
71
|
+
obj = obj || new PredefinedFieldInput();
|
|
72
|
+
if (data.hasOwnProperty('name')) {
|
|
73
|
+
obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
|
|
74
|
+
}
|
|
75
|
+
if (data.hasOwnProperty('display_name')) {
|
|
76
|
+
obj['display_name'] = _ApiClient["default"].convertToType(data['display_name'], 'String');
|
|
77
|
+
}
|
|
78
|
+
if (data.hasOwnProperty('title')) {
|
|
79
|
+
obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
|
|
80
|
+
}
|
|
81
|
+
if (data.hasOwnProperty('type')) {
|
|
82
|
+
obj['type'] = _ApiClient["default"].convertToType(data['type'], _FieldType["default"]);
|
|
83
|
+
}
|
|
84
|
+
if (data.hasOwnProperty('option_list')) {
|
|
85
|
+
obj['option_list'] = _ApiClient["default"].convertToType(data['option_list'], 'String');
|
|
86
|
+
}
|
|
87
|
+
if (data.hasOwnProperty('required_in_template')) {
|
|
88
|
+
obj['required_in_template'] = _ApiClient["default"].convertToType(data['required_in_template'], 'Boolean');
|
|
89
|
+
}
|
|
90
|
+
if (data.hasOwnProperty('field_required')) {
|
|
91
|
+
obj['field_required'] = _ApiClient["default"].convertToType(data['field_required'], 'Boolean');
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
return obj;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Validates the JSON data with respect to <code>PredefinedFieldInput</code>.
|
|
99
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
100
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>PredefinedFieldInput</code>.
|
|
101
|
+
*/
|
|
102
|
+
}, {
|
|
103
|
+
key: "validateJSON",
|
|
104
|
+
value: function validateJSON(data) {
|
|
105
|
+
// check to make sure all required properties are present in the JSON string
|
|
106
|
+
var _iterator = _createForOfIteratorHelper(PredefinedFieldInput.RequiredProperties),
|
|
107
|
+
_step;
|
|
108
|
+
try {
|
|
109
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
110
|
+
var property = _step.value;
|
|
111
|
+
if (!data.hasOwnProperty(property)) {
|
|
112
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
// ensure the json data is a string
|
|
116
|
+
} catch (err) {
|
|
117
|
+
_iterator.e(err);
|
|
118
|
+
} finally {
|
|
119
|
+
_iterator.f();
|
|
120
|
+
}
|
|
121
|
+
if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
|
|
122
|
+
throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
|
|
123
|
+
}
|
|
124
|
+
// ensure the json data is a string
|
|
125
|
+
if (data['display_name'] && !(typeof data['display_name'] === 'string' || data['display_name'] instanceof String)) {
|
|
126
|
+
throw new Error("Expected the field `display_name` to be a primitive type in the JSON string but got " + data['display_name']);
|
|
127
|
+
}
|
|
128
|
+
// ensure the json data is a string
|
|
129
|
+
if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
|
|
130
|
+
throw new Error("Expected the field `title` to be a primitive type in the JSON string but got " + data['title']);
|
|
131
|
+
}
|
|
132
|
+
// ensure the json data is a string
|
|
133
|
+
if (data['option_list'] && !(typeof data['option_list'] === 'string' || data['option_list'] instanceof String)) {
|
|
134
|
+
throw new Error("Expected the field `option_list` to be a primitive type in the JSON string but got " + data['option_list']);
|
|
135
|
+
}
|
|
136
|
+
return true;
|
|
137
|
+
}
|
|
138
|
+
}]);
|
|
139
|
+
}();
|
|
140
|
+
PredefinedFieldInput.RequiredProperties = ["name", "type"];
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
|
|
144
|
+
* @member {String} name
|
|
145
|
+
*/
|
|
146
|
+
PredefinedFieldInput.prototype['name'] = undefined;
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name.
|
|
150
|
+
* @member {String} display_name
|
|
151
|
+
*/
|
|
152
|
+
PredefinedFieldInput.prototype['display_name'] = undefined;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* The Title setting a field gets when it's given this name. Null leaves the field's title as it is.
|
|
156
|
+
* @member {String} title
|
|
157
|
+
*/
|
|
158
|
+
PredefinedFieldInput.prototype['title'] = undefined;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* The data type a field gets when it's given this name, as a field's `type`.
|
|
162
|
+
* @member {module:model/FieldType} type
|
|
163
|
+
*/
|
|
164
|
+
PredefinedFieldInput.prototype['type'] = undefined;
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value.
|
|
168
|
+
* @member {String} option_list
|
|
169
|
+
*/
|
|
170
|
+
PredefinedFieldInput.prototype['option_list'] = undefined;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false.
|
|
174
|
+
* @member {Boolean} required_in_template
|
|
175
|
+
*/
|
|
176
|
+
PredefinedFieldInput.prototype['required_in_template'] = undefined;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* The Required setting a field gets when it's given this name. Default true.
|
|
180
|
+
* @member {Boolean} field_required
|
|
181
|
+
*/
|
|
182
|
+
PredefinedFieldInput.prototype['field_required'] = undefined;
|
|
183
|
+
var _default = exports["default"] = PredefinedFieldInput;
|