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.
Files changed (157) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +62 -27
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1345 -946
  7. package/dist/index.js +655 -151
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{AddFieldsData.js → AuthenticationCheck.js} +31 -31
  10. package/dist/model/BarcodeSymbology.js +89 -0
  11. package/dist/model/CheckCharacter.js +74 -0
  12. package/dist/model/CombinedFieldType.js +59 -0
  13. package/dist/model/CombinedPdf.js +294 -0
  14. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +26 -26
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{SubmissionDataRequestToken.js → CombinedPdfSource.js} +55 -52
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/{SuccessErrorResponse.js → CombinedPdfSourcePdf.js} +41 -55
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +25 -21
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +68 -52
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +24 -22
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +46 -27
  25. package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js} +41 -137
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{CreatePdfSubmissionData.js → CreateSubmissionBatchRequest.js} +63 -87
  28. package/dist/model/CreateSubmissionRequest.js +212 -0
  29. package/dist/model/CreateTemplateRequest.js +545 -0
  30. package/dist/model/CreateWebhookRequest.js +234 -0
  31. package/dist/model/CustomFile.js +66 -15
  32. package/dist/model/CustomFileList.js +132 -0
  33. package/dist/model/CustomFileSourcePdf.js +130 -0
  34. package/dist/model/ErrorCode.js +154 -0
  35. package/dist/model/{BatchGeneratePdfs201Response.js → ErrorDetail.js} +65 -76
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +11 -40
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/{CreateSubmissionResponse.js → FieldComparisonCondition.js} +46 -64
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/FieldEqualsCondition.js +137 -0
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/FieldInCondition.js +145 -0
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldPresenceCondition.js} +39 -54
  47. package/dist/model/FieldPresenceOperator.js +59 -0
  48. package/dist/model/FieldRangeCondition.js +148 -0
  49. package/dist/model/FieldReimportState.js +69 -0
  50. package/dist/model/FieldSetupLogic.js +59 -0
  51. package/dist/model/FieldSetupNaming.js +59 -0
  52. package/dist/model/FieldSetupSource.js +64 -0
  53. package/dist/model/Folder.js +37 -10
  54. package/dist/model/FolderList.js +132 -0
  55. package/dist/model/GeneratedFile.js +214 -0
  56. package/dist/model/GeneratedFileState.js +64 -0
  57. package/dist/model/HtmlEngineOptions.js +230 -0
  58. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  59. package/dist/model/ImageGravity.js +94 -0
  60. package/dist/model/ImageScaleType.js +64 -0
  61. package/dist/model/ModelCodeLanguage.js +94 -0
  62. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +33 -27
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +24 -34
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +32 -32
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +24 -22
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +24 -22
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +164 -239
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +66 -148
  74. package/dist/model/SignatureRequestEventType.js +79 -0
  75. package/dist/model/SignatureRequestInput.js +278 -0
  76. package/dist/model/SignatureRequestMessageType.js +94 -0
  77. package/dist/model/SignatureRequestState.js +64 -0
  78. package/dist/model/SignatureRequestToken.js +195 -0
  79. package/dist/model/SignatureRequestTokenType.js +59 -0
  80. package/dist/model/StringConditionType.js +74 -0
  81. package/dist/model/Submission.js +185 -339
  82. package/dist/model/SubmissionAction.js +29 -114
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +73 -54
  86. package/dist/model/SubmissionBatchState.js +64 -0
  87. package/dist/model/SubmissionFiles.js +108 -0
  88. package/dist/model/SubmissionInput.js +204 -0
  89. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +34 -41
  90. package/dist/model/SubmissionSource.js +69 -0
  91. package/dist/model/SubmissionSourcePdf.js +130 -0
  92. package/dist/model/SubmissionState.js +114 -0
  93. package/dist/model/Template.js +309 -572
  94. package/dist/model/TemplateActor.js +171 -0
  95. package/dist/model/TemplateActorType.js +64 -0
  96. package/dist/model/TemplateDefaults.js +307 -0
  97. package/dist/model/TemplateDefaultsInput.js +305 -0
  98. package/dist/model/TemplateDocument.js +280 -0
  99. package/dist/model/TemplateDocumentState.js +74 -0
  100. package/dist/model/TemplateFieldDependency.js +184 -0
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js} +50 -61
  103. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  104. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  105. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  106. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  107. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  108. package/dist/model/TemplateFormMode.js +64 -0
  109. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +33 -85
  110. package/dist/model/TemplatePageAiError.js +69 -0
  111. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  112. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  113. package/dist/model/TemplatePageImageStatus.js +59 -0
  114. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  115. package/dist/model/{SubmissionBatchData.js → TemplateSourcePdf.js} +49 -49
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessMultipleErrorsResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +59 -62
  120. package/dist/model/TemplateVersionType.js +64 -0
  121. package/dist/model/TextAlignment.js +69 -0
  122. package/dist/model/TextOverflow.js +59 -0
  123. package/dist/model/TextVerticalAlignment.js +64 -0
  124. package/dist/model/Typeface.js +134 -0
  125. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  126. package/dist/model/{ErrorOrMultipleErrorsResponse.js → UpdateTemplateDocumentRequest.js} +43 -60
  127. package/dist/model/UpdateTemplateRequest.js +450 -0
  128. package/dist/model/UpdateWebhookRequest.js +209 -0
  129. package/dist/model/UploadMethod.js +54 -0
  130. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +52 -57
  131. package/dist/model/UrlSourcePdf.js +130 -0
  132. package/dist/model/Webhook.js +57 -72
  133. package/dist/model/WebhookEventType.js +174 -0
  134. package/dist/model/WebhookList.js +132 -0
  135. package/dist/model/WebhookMode.js +59 -0
  136. package/package.json +1 -1
  137. package/dist/model/CombinedSubmission.js +0 -308
  138. package/dist/model/CombinedSubmissionAction.js +0 -268
  139. package/dist/model/CreateCustomFileResponse.js +0 -155
  140. package/dist/model/CreateHtmlTemplate.js +0 -108
  141. package/dist/model/CreatePdfTemplate.js +0 -108
  142. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  143. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -155
  144. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -155
  145. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -155
  146. package/dist/model/CreateWebhookData.js +0 -108
  147. package/dist/model/JsonSchema.js +0 -205
  148. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  149. package/dist/model/SubmissionDataRequest.js +0 -496
  150. package/dist/model/SubmissionPreview.js +0 -504
  151. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  152. package/dist/model/TemplateDeleteResponse.js +0 -168
  153. package/dist/model/TemplatePreview.js +0 -796
  154. package/dist/model/TemplatePublishVersionResponse.js +0 -154
  155. package/dist/model/UpdateHtmlTemplate.js +0 -108
  156. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  157. package/dist/model/UpdateWebhookData.js +0 -108
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class TextVerticalAlignment.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var TextVerticalAlignment = exports["default"] = /*#__PURE__*/function () {
33
+ function TextVerticalAlignment() {
34
+ _classCallCheck(this, TextVerticalAlignment);
35
+ }
36
+ return _createClass(TextVerticalAlignment, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>TextVerticalAlignment</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/TextVerticalAlignment} The enum <code>TextVerticalAlignment</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "bottom"
52
+ * @const
53
+ */
54
+ _defineProperty(TextVerticalAlignment, "bottom", "bottom");
55
+ /**
56
+ * value: "center"
57
+ * @const
58
+ */
59
+ _defineProperty(TextVerticalAlignment, "center", "center");
60
+ /**
61
+ * value: "top"
62
+ * @const
63
+ */
64
+ _defineProperty(TextVerticalAlignment, "top", "top");
@@ -0,0 +1,134 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class Typeface.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var Typeface = exports["default"] = /*#__PURE__*/function () {
33
+ function Typeface() {
34
+ _classCallCheck(this, Typeface);
35
+ }
36
+ return _createClass(Typeface, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>Typeface</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/Typeface} The enum <code>Typeface</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "Inconsolata"
52
+ * @const
53
+ */
54
+ _defineProperty(Typeface, "Inconsolata", "Inconsolata");
55
+ /**
56
+ * value: "Roboto Mono"
57
+ * @const
58
+ */
59
+ _defineProperty(Typeface, "Roboto Mono", "Roboto Mono");
60
+ /**
61
+ * value: "Ubuntu Mono"
62
+ * @const
63
+ */
64
+ _defineProperty(Typeface, "Ubuntu Mono", "Ubuntu Mono");
65
+ /**
66
+ * value: "Menlo"
67
+ * @const
68
+ */
69
+ _defineProperty(Typeface, "Menlo", "Menlo");
70
+ /**
71
+ * value: "Courier"
72
+ * @const
73
+ */
74
+ _defineProperty(Typeface, "Courier", "Courier");
75
+ /**
76
+ * value: "Helvetica"
77
+ * @const
78
+ */
79
+ _defineProperty(Typeface, "Helvetica", "Helvetica");
80
+ /**
81
+ * value: "Arial"
82
+ * @const
83
+ */
84
+ _defineProperty(Typeface, "Arial", "Arial");
85
+ /**
86
+ * value: "Calibri"
87
+ * @const
88
+ */
89
+ _defineProperty(Typeface, "Calibri", "Calibri");
90
+ /**
91
+ * value: "Open Sans"
92
+ * @const
93
+ */
94
+ _defineProperty(Typeface, "Open Sans", "Open Sans");
95
+ /**
96
+ * value: "Roboto"
97
+ * @const
98
+ */
99
+ _defineProperty(Typeface, "Roboto", "Roboto");
100
+ /**
101
+ * value: "Lato"
102
+ * @const
103
+ */
104
+ _defineProperty(Typeface, "Lato", "Lato");
105
+ /**
106
+ * value: "Poppins"
107
+ * @const
108
+ */
109
+ _defineProperty(Typeface, "Poppins", "Poppins");
110
+ /**
111
+ * value: "Public Sans"
112
+ * @const
113
+ */
114
+ _defineProperty(Typeface, "Public Sans", "Public Sans");
115
+ /**
116
+ * value: "Questrial"
117
+ * @const
118
+ */
119
+ _defineProperty(Typeface, "Questrial", "Questrial");
120
+ /**
121
+ * value: "Times New Roman"
122
+ * @const
123
+ */
124
+ _defineProperty(Typeface, "Times New Roman", "Times New Roman");
125
+ /**
126
+ * value: "Dancing Script"
127
+ * @const
128
+ */
129
+ _defineProperty(Typeface, "Dancing Script", "Dancing Script");
130
+ /**
131
+ * value: "Lovtony Script"
132
+ * @const
133
+ */
134
+ _defineProperty(Typeface, "Lovtony Script", "Lovtony Script");
@@ -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 _SignatureRequestAuthSecondFactorType = _interopRequireDefault(require("./SignatureRequestAuthSecondFactorType"));
9
+ var _SignatureRequestAuthType = _interopRequireDefault(require("./SignatureRequestAuthType"));
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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
13
+ 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); } }
14
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
15
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
16
+ 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); } /**
17
+ * DocSpring API
18
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ *
20
+ * The version of the OpenAPI document: v2
21
+ *
22
+ *
23
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
24
+ * https://openapi-generator.tech
25
+ * Do not edit the class manually.
26
+ *
27
+ */
28
+ /**
29
+ * The UpdateSignatureRequestRequest model module.
30
+ * @module model/UpdateSignatureRequestRequest
31
+ * @version 4.0.0
32
+ */
33
+ var UpdateSignatureRequestRequest = /*#__PURE__*/function () {
34
+ /**
35
+ * Constructs a new <code>UpdateSignatureRequestRequest</code>.
36
+ * The settings to change. Properties left out keep their values.
37
+ * @alias module:model/UpdateSignatureRequestRequest
38
+ */
39
+ function UpdateSignatureRequestRequest() {
40
+ _classCallCheck(this, UpdateSignatureRequestRequest);
41
+ UpdateSignatureRequestRequest.initialize(this);
42
+ }
43
+
44
+ /**
45
+ * Initializes the fields of this object.
46
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
47
+ * Only for internal use.
48
+ */
49
+ return _createClass(UpdateSignatureRequestRequest, null, [{
50
+ key: "initialize",
51
+ value: function initialize(obj) {}
52
+
53
+ /**
54
+ * Constructs a <code>UpdateSignatureRequestRequest</code> from a plain JavaScript object, optionally creating a new instance.
55
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
56
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
57
+ * @param {module:model/UpdateSignatureRequestRequest} obj Optional instance to populate.
58
+ * @return {module:model/UpdateSignatureRequestRequest} The populated <code>UpdateSignatureRequestRequest</code> instance.
59
+ */
60
+ }, {
61
+ key: "constructFromObject",
62
+ value: function constructFromObject(data, obj) {
63
+ if (data) {
64
+ obj = obj || new UpdateSignatureRequestRequest();
65
+ if (data.hasOwnProperty('metadata')) {
66
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
67
+ 'String': Object
68
+ });
69
+ }
70
+ if (data.hasOwnProperty('auth_type')) {
71
+ obj['auth_type'] = _ApiClient["default"].convertToType(data['auth_type'], _SignatureRequestAuthType["default"]);
72
+ }
73
+ if (data.hasOwnProperty('auth_second_factor_type')) {
74
+ obj['auth_second_factor_type'] = _ApiClient["default"].convertToType(data['auth_second_factor_type'], _SignatureRequestAuthSecondFactorType["default"]);
75
+ }
76
+ if (data.hasOwnProperty('auth_provider')) {
77
+ obj['auth_provider'] = _ApiClient["default"].convertToType(data['auth_provider'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('auth_session_started_at')) {
80
+ obj['auth_session_started_at'] = _ApiClient["default"].convertToType(data['auth_session_started_at'], 'Date');
81
+ }
82
+ if (data.hasOwnProperty('auth_session_id_hash')) {
83
+ obj['auth_session_id_hash'] = _ApiClient["default"].convertToType(data['auth_session_id_hash'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('auth_user_id_hash')) {
86
+ obj['auth_user_id_hash'] = _ApiClient["default"].convertToType(data['auth_user_id_hash'], 'String');
87
+ }
88
+ if (data.hasOwnProperty('auth_username_hash')) {
89
+ obj['auth_username_hash'] = _ApiClient["default"].convertToType(data['auth_username_hash'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('auth_phone_number_hash')) {
92
+ obj['auth_phone_number_hash'] = _ApiClient["default"].convertToType(data['auth_phone_number_hash'], 'String');
93
+ }
94
+ }
95
+ return obj;
96
+ }
97
+
98
+ /**
99
+ * Validates the JSON data with respect to <code>UpdateSignatureRequestRequest</code>.
100
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
101
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateSignatureRequestRequest</code>.
102
+ */
103
+ }, {
104
+ key: "validateJSON",
105
+ value: function validateJSON(data) {
106
+ // ensure the json data is a string
107
+ if (data['auth_provider'] && !(typeof data['auth_provider'] === 'string' || data['auth_provider'] instanceof String)) {
108
+ throw new Error("Expected the field `auth_provider` to be a primitive type in the JSON string but got " + data['auth_provider']);
109
+ }
110
+ // ensure the json data is a string
111
+ if (data['auth_session_id_hash'] && !(typeof data['auth_session_id_hash'] === 'string' || data['auth_session_id_hash'] instanceof String)) {
112
+ throw new Error("Expected the field `auth_session_id_hash` to be a primitive type in the JSON string but got " + data['auth_session_id_hash']);
113
+ }
114
+ // ensure the json data is a string
115
+ if (data['auth_user_id_hash'] && !(typeof data['auth_user_id_hash'] === 'string' || data['auth_user_id_hash'] instanceof String)) {
116
+ throw new Error("Expected the field `auth_user_id_hash` to be a primitive type in the JSON string but got " + data['auth_user_id_hash']);
117
+ }
118
+ // ensure the json data is a string
119
+ if (data['auth_username_hash'] && !(typeof data['auth_username_hash'] === 'string' || data['auth_username_hash'] instanceof String)) {
120
+ throw new Error("Expected the field `auth_username_hash` to be a primitive type in the JSON string but got " + data['auth_username_hash']);
121
+ }
122
+ // ensure the json data is a string
123
+ if (data['auth_phone_number_hash'] && !(typeof data['auth_phone_number_hash'] === 'string' || data['auth_phone_number_hash'] instanceof String)) {
124
+ throw new Error("Expected the field `auth_phone_number_hash` to be a primitive type in the JSON string but got " + data['auth_phone_number_hash']);
125
+ }
126
+ return true;
127
+ }
128
+ }]);
129
+ }();
130
+ /**
131
+ * Your own data about the signature request, such as an ID from your app.
132
+ * @member {Object.<String, Object>} metadata
133
+ */
134
+ UpdateSignatureRequestRequest.prototype['metadata'] = undefined;
135
+
136
+ /**
137
+ * How your app authenticated the person before it showed them the signature request.
138
+ * @member {module:model/SignatureRequestAuthType} auth_type
139
+ */
140
+ UpdateSignatureRequestRequest.prototype['auth_type'] = undefined;
141
+
142
+ /**
143
+ * The second factor your app authenticated them with, if any.
144
+ * @member {module:model/SignatureRequestAuthSecondFactorType} auth_second_factor_type
145
+ */
146
+ UpdateSignatureRequestRequest.prototype['auth_second_factor_type'] = undefined;
147
+
148
+ /**
149
+ * The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`.
150
+ * @member {String} auth_provider
151
+ */
152
+ UpdateSignatureRequestRequest.prototype['auth_provider'] = undefined;
153
+
154
+ /**
155
+ * When your app authenticated them. Set for you with `email_link`.
156
+ * @member {Date} auth_session_started_at
157
+ */
158
+ UpdateSignatureRequestRequest.prototype['auth_session_started_at'] = undefined;
159
+
160
+ /**
161
+ * A hash of your app's session ID, for the audit trail.
162
+ * @member {String} auth_session_id_hash
163
+ */
164
+ UpdateSignatureRequestRequest.prototype['auth_session_id_hash'] = undefined;
165
+
166
+ /**
167
+ * Their user ID in your app, or a SHA-256 hash of a salt and the user ID.
168
+ * @member {String} auth_user_id_hash
169
+ */
170
+ UpdateSignatureRequestRequest.prototype['auth_user_id_hash'] = undefined;
171
+
172
+ /**
173
+ * Their username in your app, or a SHA-256 hash of a salt and the username.
174
+ * @member {String} auth_username_hash
175
+ */
176
+ UpdateSignatureRequestRequest.prototype['auth_username_hash'] = undefined;
177
+
178
+ /**
179
+ * The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
180
+ * @member {String} auth_phone_number_hash
181
+ */
182
+ UpdateSignatureRequestRequest.prototype['auth_phone_number_hash'] = undefined;
183
+ var _default = exports["default"] = UpdateSignatureRequestRequest;
@@ -18,7 +18,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
18
18
  * DocSpring API
19
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,20 +27,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  *
28
28
  */
29
29
  /**
30
- * The ErrorOrMultipleErrorsResponse model module.
31
- * @module model/ErrorOrMultipleErrorsResponse
32
- * @version 3.2.0
30
+ * The UpdateTemplateDocumentRequest model module.
31
+ * @module model/UpdateTemplateDocumentRequest
32
+ * @version 4.0.0
33
33
  */
34
- var ErrorOrMultipleErrorsResponse = /*#__PURE__*/function () {
34
+ var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
35
35
  /**
36
- * Constructs a new <code>ErrorOrMultipleErrorsResponse</code>.
37
- * @alias module:model/ErrorOrMultipleErrorsResponse
38
- * @extends Object
39
- * @param status {module:model/ErrorOrMultipleErrorsResponse.StatusEnum}
36
+ * Constructs a new <code>UpdateTemplateDocumentRequest</code>.
37
+ * The new PDF.
38
+ * @alias module:model/UpdateTemplateDocumentRequest
39
+ * @param cache_id {String} The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign).
40
40
  */
41
- function ErrorOrMultipleErrorsResponse(status) {
42
- _classCallCheck(this, ErrorOrMultipleErrorsResponse);
43
- ErrorOrMultipleErrorsResponse.initialize(this, status);
41
+ function UpdateTemplateDocumentRequest(cache_id) {
42
+ _classCallCheck(this, UpdateTemplateDocumentRequest);
43
+ UpdateTemplateDocumentRequest.initialize(this, cache_id);
44
44
  }
45
45
 
46
46
  /**
@@ -48,48 +48,47 @@ var ErrorOrMultipleErrorsResponse = /*#__PURE__*/function () {
48
48
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
49
  * Only for internal use.
50
50
  */
51
- return _createClass(ErrorOrMultipleErrorsResponse, null, [{
51
+ return _createClass(UpdateTemplateDocumentRequest, null, [{
52
52
  key: "initialize",
53
- value: function initialize(obj, status) {
54
- obj['status'] = status;
53
+ value: function initialize(obj, cache_id) {
54
+ obj['cache_id'] = cache_id;
55
55
  }
56
56
 
57
57
  /**
58
- * Constructs a <code>ErrorOrMultipleErrorsResponse</code> from a plain JavaScript object, optionally creating a new instance.
58
+ * Constructs a <code>UpdateTemplateDocumentRequest</code> from a plain JavaScript object, optionally creating a new instance.
59
59
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
60
60
  * @param {Object} data The plain JavaScript object bearing properties of interest.
61
- * @param {module:model/ErrorOrMultipleErrorsResponse} obj Optional instance to populate.
62
- * @return {module:model/ErrorOrMultipleErrorsResponse} The populated <code>ErrorOrMultipleErrorsResponse</code> instance.
61
+ * @param {module:model/UpdateTemplateDocumentRequest} obj Optional instance to populate.
62
+ * @return {module:model/UpdateTemplateDocumentRequest} The populated <code>UpdateTemplateDocumentRequest</code> instance.
63
63
  */
64
64
  }, {
65
65
  key: "constructFromObject",
66
66
  value: function constructFromObject(data, obj) {
67
67
  if (data) {
68
- obj = obj || new ErrorOrMultipleErrorsResponse();
69
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
70
- if (data.hasOwnProperty('status')) {
71
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
68
+ obj = obj || new UpdateTemplateDocumentRequest();
69
+ if (data.hasOwnProperty('cache_id')) {
70
+ obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
72
71
  }
73
- if (data.hasOwnProperty('error')) {
74
- obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
72
+ if (data.hasOwnProperty('filename')) {
73
+ obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
75
74
  }
76
- if (data.hasOwnProperty('errors')) {
77
- obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
75
+ if (data.hasOwnProperty('reimport_fields')) {
76
+ obj['reimport_fields'] = _ApiClient["default"].convertToType(data['reimport_fields'], 'Boolean');
78
77
  }
79
78
  }
80
79
  return obj;
81
80
  }
82
81
 
83
82
  /**
84
- * Validates the JSON data with respect to <code>ErrorOrMultipleErrorsResponse</code>.
83
+ * Validates the JSON data with respect to <code>UpdateTemplateDocumentRequest</code>.
85
84
  * @param {Object} data The plain JavaScript object bearing properties of interest.
86
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ErrorOrMultipleErrorsResponse</code>.
85
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateTemplateDocumentRequest</code>.
87
86
  */
88
87
  }, {
89
88
  key: "validateJSON",
90
89
  value: function validateJSON(data) {
91
90
  // check to make sure all required properties are present in the JSON string
92
- var _iterator = _createForOfIteratorHelper(ErrorOrMultipleErrorsResponse.RequiredProperties),
91
+ var _iterator = _createForOfIteratorHelper(UpdateTemplateDocumentRequest.RequiredProperties),
93
92
  _step;
94
93
  try {
95
94
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -104,50 +103,34 @@ var ErrorOrMultipleErrorsResponse = /*#__PURE__*/function () {
104
103
  } finally {
105
104
  _iterator.f();
106
105
  }
107
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
108
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
106
+ if (data['cache_id'] && !(typeof data['cache_id'] === 'string' || data['cache_id'] instanceof String)) {
107
+ throw new Error("Expected the field `cache_id` to be a primitive type in the JSON string but got " + data['cache_id']);
109
108
  }
110
109
  // ensure the json data is a string
111
- if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
112
- throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
113
- }
114
- // ensure the json data is an array
115
- if (!Array.isArray(data['errors'])) {
116
- throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
110
+ if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
111
+ throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
117
112
  }
118
113
  return true;
119
114
  }
120
115
  }]);
121
116
  }();
122
- ErrorOrMultipleErrorsResponse.RequiredProperties = ["status"];
123
-
124
- /**
125
- * @member {module:model/ErrorOrMultipleErrorsResponse.StatusEnum} status
126
- */
127
- ErrorOrMultipleErrorsResponse.prototype['status'] = undefined;
117
+ UpdateTemplateDocumentRequest.RequiredProperties = ["cache_id"];
128
118
 
129
119
  /**
130
- * Single error message (when only one error occurred)
131
- * @member {String} error
120
+ * The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign).
121
+ * @member {String} cache_id
132
122
  */
133
- ErrorOrMultipleErrorsResponse.prototype['error'] = undefined;
123
+ UpdateTemplateDocumentRequest.prototype['cache_id'] = undefined;
134
124
 
135
125
  /**
136
- * Array of error messages (when multiple validation errors occurred)
137
- * @member {Array.<String>} errors
126
+ * The PDF's file name, for a `cache_id` (presigned uploads don't send one).
127
+ * @member {String} filename
138
128
  */
139
- ErrorOrMultipleErrorsResponse.prototype['errors'] = undefined;
129
+ UpdateTemplateDocumentRequest.prototype['filename'] = undefined;
140
130
 
141
131
  /**
142
- * Allowed values for the <code>status</code> property.
143
- * @enum {String}
144
- * @readonly
132
+ * Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
133
+ * @member {Boolean} reimport_fields
145
134
  */
146
- ErrorOrMultipleErrorsResponse['StatusEnum'] = {
147
- /**
148
- * value: "error"
149
- * @const
150
- */
151
- "error": "error"
152
- };
153
- var _default = exports["default"] = ErrorOrMultipleErrorsResponse;
135
+ UpdateTemplateDocumentRequest.prototype['reimport_fields'] = undefined;
136
+ var _default = exports["default"] = UpdateTemplateDocumentRequest;