docspring 3.1.0 → 3.3.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 (64) hide show
  1. package/AGENTS.md +33 -0
  2. package/README.md +148 -215
  3. package/dist/ApiClient.js +3 -3
  4. package/dist/api/Client.js +9 -8
  5. package/dist/index.js +7 -0
  6. package/dist/model/AddFieldsData.js +2 -2
  7. package/dist/model/BatchGeneratePdfs201Response.js +17 -7
  8. package/dist/model/CombinePdfsData.js +3 -3
  9. package/dist/model/CombinedSubmission.js +13 -23
  10. package/dist/model/CombinedSubmissionAction.js +4 -2
  11. package/dist/model/CopyTemplateOptions.js +2 -2
  12. package/dist/model/CreateCombinedSubmissionResponse.js +28 -6
  13. package/dist/model/CreateCustomFileData.js +2 -2
  14. package/dist/model/CreateCustomFileResponse.js +15 -6
  15. package/dist/model/CreateFolderData.js +2 -2
  16. package/dist/model/CreateHtmlTemplate.js +2 -2
  17. package/dist/model/CreatePdfSubmissionData.js +3 -2
  18. package/dist/model/CreatePdfTemplate.js +2 -2
  19. package/dist/model/CreateSubmissionDataRequestData.js +2 -2
  20. package/dist/model/CreateSubmissionDataRequestEventRequest.js +2 -2
  21. package/dist/model/CreateSubmissionDataRequestEventResponse.js +15 -6
  22. package/dist/model/CreateSubmissionDataRequestResponse.js +15 -6
  23. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +15 -6
  24. package/dist/model/CreateSubmissionResponse.js +28 -6
  25. package/dist/model/CreateWebhookData.js +2 -2
  26. package/dist/model/CustomFile.js +4 -2
  27. package/dist/model/ErrorOrMultipleErrorsResponse.js +4 -2
  28. package/dist/model/ErrorResponse.js +4 -2
  29. package/dist/model/Folder.js +4 -2
  30. package/dist/model/ForbiddenErrorResponse.js +173 -0
  31. package/dist/model/JsonSchema.js +2 -2
  32. package/dist/model/ListSubmissionsResponse.js +7 -22
  33. package/dist/model/MoveFolderData.js +2 -2
  34. package/dist/model/MoveTemplateData.js +2 -2
  35. package/dist/model/MultipleErrorsResponse.js +4 -2
  36. package/dist/model/PublishVersionData.js +2 -2
  37. package/dist/model/RenameFolderData.js +2 -2
  38. package/dist/model/RestoreVersionData.js +2 -2
  39. package/dist/model/Submission.js +15 -42
  40. package/dist/model/Submission422Response.js +4 -7
  41. package/dist/model/SubmissionAction.js +4 -2
  42. package/dist/model/SubmissionBatch.js +4 -2
  43. package/dist/model/SubmissionBatchData.js +3 -2
  44. package/dist/model/SubmissionBatchWithSubmissions.js +7 -22
  45. package/dist/model/SubmissionDataRequest.js +4 -2
  46. package/dist/model/SubmissionDataRequestEvent.js +4 -2
  47. package/dist/model/SubmissionDataRequestShow.js +4 -2
  48. package/dist/model/SubmissionDataRequestToken.js +4 -2
  49. package/dist/model/SubmissionPreview.js +15 -42
  50. package/dist/model/SuccessErrorResponse.js +4 -2
  51. package/dist/model/SuccessMultipleErrorsResponse.js +4 -2
  52. package/dist/model/Template.js +18 -6
  53. package/dist/model/TemplateAddFieldsResponse.js +4 -2
  54. package/dist/model/TemplateDeleteResponse.js +4 -2
  55. package/dist/model/TemplateModelCodeResponse.js +4 -2
  56. package/dist/model/TemplatePreview.js +18 -6
  57. package/dist/model/TemplatePublishVersionResponse.js +4 -2
  58. package/dist/model/UpdateHtmlTemplate.js +2 -2
  59. package/dist/model/UpdatePdfTemplate.js +2 -2
  60. package/dist/model/UpdateSubmissionDataRequestData.js +2 -2
  61. package/dist/model/UpdateWebhookData.js +2 -2
  62. package/dist/model/UploadPresignResponse.js +4 -2
  63. package/dist/model/Webhook.js +4 -2
  64. package/package.json +13 -3
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The BatchGeneratePdfs201Response model module.
32
32
  * @module model/BatchGeneratePdfs201Response
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
36
36
  /**
37
37
  * Constructs a new <code>BatchGeneratePdfs201Response</code>.
38
38
  * @alias module:model/BatchGeneratePdfs201Response
39
+ * @extends Object
39
40
  * @param status {module:model/BatchGeneratePdfs201Response.StatusEnum}
40
41
  * @param submission_batch {module:model/SubmissionBatch}
41
42
  * @param submissions {Array.<Object>}
@@ -70,6 +71,7 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
70
71
  value: function constructFromObject(data, obj) {
71
72
  if (data) {
72
73
  obj = obj || new BatchGeneratePdfs201Response();
74
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
73
75
  if (data.hasOwnProperty('status')) {
74
76
  obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
75
77
  }
@@ -85,6 +87,9 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
85
87
  if (data.hasOwnProperty('submissions')) {
86
88
  obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
87
89
  }
90
+ if (data.hasOwnProperty('code')) {
91
+ obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
92
+ }
88
93
  }
89
94
  return obj;
90
95
  }
@@ -124,15 +129,14 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
124
129
  if (!Array.isArray(data['errors'])) {
125
130
  throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
126
131
  }
127
- // validate the optional field `submission_batch`
128
- if (data['submission_batch']) {
129
- // data not null
130
- _SubmissionBatch["default"].validateJSON(data['submission_batch']);
131
- }
132
132
  // ensure the json data is an array
133
133
  if (!Array.isArray(data['submissions'])) {
134
134
  throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
135
135
  }
136
+ // ensure the json data is a string
137
+ if (data['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
138
+ throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
139
+ }
136
140
  return true;
137
141
  }
138
142
  }]);
@@ -164,6 +168,12 @@ BatchGeneratePdfs201Response.prototype['submission_batch'] = undefined;
164
168
  */
165
169
  BatchGeneratePdfs201Response.prototype['submissions'] = undefined;
166
170
 
171
+ /**
172
+ * `insufficient_credits` when the response is a 402.
173
+ * @member {String} code
174
+ */
175
+ BatchGeneratePdfs201Response.prototype['code'] = undefined;
176
+
167
177
  /**
168
178
  * Allowed values for the <code>status</code> property.
169
179
  * @enum {String}
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CombinePdfsData model module.
31
31
  * @module model/CombinePdfsData
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CombinePdfsData = /*#__PURE__*/function () {
35
35
  /**
@@ -151,7 +151,7 @@ CombinePdfsData.prototype['password'] = undefined;
151
151
  CombinePdfsData.prototype['source_pdfs'] = undefined;
152
152
 
153
153
  /**
154
- * Deprecated, and has no effect. A combined PDF is a test or live document because of its source PDFs.
154
+ * Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs.
155
155
  * @member {Boolean} test
156
156
  */
157
157
  CombinePdfsData.prototype['test'] = undefined;
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The CombinedSubmission model module.
32
32
  * @module model/CombinedSubmission
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var CombinedSubmission = /*#__PURE__*/function () {
36
36
  /**
37
37
  * Constructs a new <code>CombinedSubmission</code>.
38
38
  * @alias module:model/CombinedSubmission
39
+ * @extends Object
39
40
  * @param id {String}
40
41
  * @param state {module:model/CombinedSubmission.StateEnum}
41
42
  * @param expired {Boolean}
@@ -92,6 +93,7 @@ var CombinedSubmission = /*#__PURE__*/function () {
92
93
  value: function constructFromObject(data, obj) {
93
94
  if (data) {
94
95
  obj = obj || new CombinedSubmission();
96
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
95
97
  if (data.hasOwnProperty('id')) {
96
98
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
97
99
  }
@@ -201,26 +203,9 @@ var CombinedSubmission = /*#__PURE__*/function () {
201
203
  if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
202
204
  throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
203
205
  }
204
- if (data['actions']) {
205
- // data not null
206
- // ensure the json data is an array
207
- if (!Array.isArray(data['actions'])) {
208
- throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
209
- }
210
- // validate the optional field `actions` (array)
211
- var _iterator2 = _createForOfIteratorHelper(data['actions']),
212
- _step2;
213
- try {
214
- for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
215
- var item = _step2.value;
216
- _CombinedSubmissionAction["default"].validateJSON(item);
217
- }
218
- } catch (err) {
219
- _iterator2.e(err);
220
- } finally {
221
- _iterator2.f();
222
- }
223
- ;
206
+ // ensure the json data is an array
207
+ if (!Array.isArray(data['actions'])) {
208
+ throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
224
209
  }
225
210
  return true;
226
211
  }
@@ -318,6 +303,11 @@ CombinedSubmission['StateEnum'] = {
318
303
  * value: "error"
319
304
  * @const
320
305
  */
321
- "error": "error"
306
+ "error": "error",
307
+ /**
308
+ * value: "insufficient_credits"
309
+ * @const
310
+ */
311
+ "insufficient_credits": "insufficient_credits"
322
312
  };
323
313
  var _default = exports["default"] = CombinedSubmission;
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CombinedSubmissionAction model module.
31
31
  * @module model/CombinedSubmissionAction
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CombinedSubmissionAction = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>CombinedSubmissionAction</code>.
37
37
  * @alias module:model/CombinedSubmissionAction
38
+ * @extends Object
38
39
  * @param id {String}
39
40
  * @param integration_id {String}
40
41
  * @param state {module:model/CombinedSubmissionAction.StateEnum}
@@ -77,6 +78,7 @@ var CombinedSubmissionAction = /*#__PURE__*/function () {
77
78
  value: function constructFromObject(data, obj) {
78
79
  if (data) {
79
80
  obj = obj || new CombinedSubmissionAction();
81
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
80
82
  if (data.hasOwnProperty('id')) {
81
83
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
82
84
  }
@@ -13,7 +13,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
13
13
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
14
14
  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); } /**
15
15
  * DocSpring API
16
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
16
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
17
17
  *
18
18
  * The version of the OpenAPI document: v1
19
19
  *
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
26
26
  /**
27
27
  * The CopyTemplateOptions model module.
28
28
  * @module model/CopyTemplateOptions
29
- * @version 3.1.0
29
+ * @version 3.3.0
30
30
  */
31
31
  var CopyTemplateOptions = /*#__PURE__*/function () {
32
32
  /**
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The CreateCombinedSubmissionResponse model module.
32
32
  * @module model/CreateCombinedSubmissionResponse
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
36
36
  /**
37
37
  * Constructs a new <code>CreateCombinedSubmissionResponse</code>.
38
38
  * @alias module:model/CreateCombinedSubmissionResponse
39
+ * @extends Object
39
40
  * @param status {module:model/CreateCombinedSubmissionResponse.StatusEnum}
40
41
  * @param combined_submission {module:model/CombinedSubmission}
41
42
  */
@@ -68,15 +69,22 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
68
69
  value: function constructFromObject(data, obj) {
69
70
  if (data) {
70
71
  obj = obj || new CreateCombinedSubmissionResponse();
72
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
71
73
  if (data.hasOwnProperty('status')) {
72
74
  obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
73
75
  }
74
76
  if (data.hasOwnProperty('combined_submission')) {
75
77
  obj['combined_submission'] = _CombinedSubmission["default"].constructFromObject(data['combined_submission']);
76
78
  }
79
+ if (data.hasOwnProperty('error')) {
80
+ obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
81
+ }
77
82
  if (data.hasOwnProperty('errors')) {
78
83
  obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
79
84
  }
85
+ if (data.hasOwnProperty('code')) {
86
+ obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
87
+ }
80
88
  }
81
89
  return obj;
82
90
  }
@@ -108,15 +116,18 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
108
116
  if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
109
117
  throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
110
118
  }
111
- // validate the optional field `combined_submission`
112
- if (data['combined_submission']) {
113
- // data not null
114
- _CombinedSubmission["default"].validateJSON(data['combined_submission']);
119
+ // ensure the json data is a string
120
+ if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
121
+ throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
115
122
  }
116
123
  // ensure the json data is an array
117
124
  if (!Array.isArray(data['errors'])) {
118
125
  throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
119
126
  }
127
+ // ensure the json data is a string
128
+ if (data['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
129
+ throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
130
+ }
120
131
  return true;
121
132
  }
122
133
  }]);
@@ -133,11 +144,22 @@ CreateCombinedSubmissionResponse.prototype['status'] = undefined;
133
144
  */
134
145
  CreateCombinedSubmissionResponse.prototype['combined_submission'] = undefined;
135
146
 
147
+ /**
148
+ * @member {String} error
149
+ */
150
+ CreateCombinedSubmissionResponse.prototype['error'] = undefined;
151
+
136
152
  /**
137
153
  * @member {Array.<String>} errors
138
154
  */
139
155
  CreateCombinedSubmissionResponse.prototype['errors'] = undefined;
140
156
 
157
+ /**
158
+ * `insufficient_credits` when the response is a 402.
159
+ * @member {String} code
160
+ */
161
+ CreateCombinedSubmissionResponse.prototype['code'] = undefined;
162
+
141
163
  /**
142
164
  * Allowed values for the <code>status</code> property.
143
165
  * @enum {String}
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CreateCustomFileData model module.
31
31
  * @module model/CreateCustomFileData
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CreateCustomFileData = /*#__PURE__*/function () {
35
35
  /**
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The CreateCustomFileResponse model module.
32
32
  * @module model/CreateCustomFileResponse
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var CreateCustomFileResponse = /*#__PURE__*/function () {
36
36
  /**
37
37
  * Constructs a new <code>CreateCustomFileResponse</code>.
38
38
  * @alias module:model/CreateCustomFileResponse
39
+ * @extends Object
39
40
  * @param status {module:model/CreateCustomFileResponse.StatusEnum}
40
41
  * @param custom_file {module:model/CustomFile}
41
42
  */
@@ -68,12 +69,16 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
68
69
  value: function constructFromObject(data, obj) {
69
70
  if (data) {
70
71
  obj = obj || new CreateCustomFileResponse();
72
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
71
73
  if (data.hasOwnProperty('status')) {
72
74
  obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
73
75
  }
74
76
  if (data.hasOwnProperty('custom_file')) {
75
77
  obj['custom_file'] = _CustomFile["default"].constructFromObject(data['custom_file']);
76
78
  }
79
+ if (data.hasOwnProperty('error')) {
80
+ obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
81
+ }
77
82
  if (data.hasOwnProperty('errors')) {
78
83
  obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
79
84
  }
@@ -108,10 +113,9 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
108
113
  if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
109
114
  throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
110
115
  }
111
- // validate the optional field `custom_file`
112
- if (data['custom_file']) {
113
- // data not null
114
- _CustomFile["default"].validateJSON(data['custom_file']);
116
+ // ensure the json data is a string
117
+ if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
118
+ throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
115
119
  }
116
120
  // ensure the json data is an array
117
121
  if (!Array.isArray(data['errors'])) {
@@ -133,6 +137,11 @@ CreateCustomFileResponse.prototype['status'] = undefined;
133
137
  */
134
138
  CreateCustomFileResponse.prototype['custom_file'] = undefined;
135
139
 
140
+ /**
141
+ * @member {String} error
142
+ */
143
+ CreateCustomFileResponse.prototype['error'] = undefined;
144
+
136
145
  /**
137
146
  * @member {Array.<String>} errors
138
147
  */
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CreateFolderData model module.
31
31
  * @module model/CreateFolderData
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CreateFolderData = /*#__PURE__*/function () {
35
35
  /**
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CreateHtmlTemplate model module.
31
31
  * @module model/CreateHtmlTemplate
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CreateHtmlTemplate = /*#__PURE__*/function () {
35
35
  /**
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The CreatePdfSubmissionData model module.
32
32
  * @module model/CreatePdfSubmissionData
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var CreatePdfSubmissionData = /*#__PURE__*/function () {
36
36
  /**
@@ -191,6 +191,7 @@ CreatePdfSubmissionData.prototype['metadata'] = undefined;
191
191
  CreatePdfSubmissionData.prototype['password'] = undefined;
192
192
 
193
193
  /**
194
+ * Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
194
195
  * @member {Boolean} test
195
196
  */
196
197
  CreatePdfSubmissionData.prototype['test'] = undefined;
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CreatePdfTemplate model module.
31
31
  * @module model/CreatePdfTemplate
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CreatePdfTemplate = /*#__PURE__*/function () {
35
35
  /**
@@ -13,7 +13,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
13
13
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
14
14
  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); } /**
15
15
  * DocSpring API
16
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
16
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
17
17
  *
18
18
  * The version of the OpenAPI document: v1
19
19
  *
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
26
26
  /**
27
27
  * The CreateSubmissionDataRequestData model module.
28
28
  * @module model/CreateSubmissionDataRequestData
29
- * @version 3.1.0
29
+ * @version 3.3.0
30
30
  */
31
31
  var CreateSubmissionDataRequestData = /*#__PURE__*/function () {
32
32
  /**
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
18
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CreateSubmissionDataRequestEventRequest model module.
31
31
  * @module model/CreateSubmissionDataRequestEventRequest
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var CreateSubmissionDataRequestEventRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
17
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
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
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.
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
21
  *
22
22
  * The version of the OpenAPI document: v1
23
23
  *
@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The CreateSubmissionDataRequestEventResponse model module.
32
32
  * @module model/CreateSubmissionDataRequestEventResponse
33
- * @version 3.1.0
33
+ * @version 3.3.0
34
34
  */
35
35
  var CreateSubmissionDataRequestEventResponse = /*#__PURE__*/function () {
36
36
  /**
37
37
  * Constructs a new <code>CreateSubmissionDataRequestEventResponse</code>.
38
38
  * @alias module:model/CreateSubmissionDataRequestEventResponse
39
+ * @extends Object
39
40
  * @param status {module:model/CreateSubmissionDataRequestEventResponse.StatusEnum}
40
41
  * @param event {module:model/SubmissionDataRequestEvent}
41
42
  */
@@ -68,12 +69,16 @@ var CreateSubmissionDataRequestEventResponse = /*#__PURE__*/function () {
68
69
  value: function constructFromObject(data, obj) {
69
70
  if (data) {
70
71
  obj = obj || new CreateSubmissionDataRequestEventResponse();
72
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
71
73
  if (data.hasOwnProperty('status')) {
72
74
  obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
73
75
  }
74
76
  if (data.hasOwnProperty('event')) {
75
77
  obj['event'] = _SubmissionDataRequestEvent["default"].constructFromObject(data['event']);
76
78
  }
79
+ if (data.hasOwnProperty('error')) {
80
+ obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
81
+ }
77
82
  if (data.hasOwnProperty('errors')) {
78
83
  obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
79
84
  }
@@ -108,10 +113,9 @@ var CreateSubmissionDataRequestEventResponse = /*#__PURE__*/function () {
108
113
  if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
109
114
  throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
110
115
  }
111
- // validate the optional field `event`
112
- if (data['event']) {
113
- // data not null
114
- _SubmissionDataRequestEvent["default"].validateJSON(data['event']);
116
+ // ensure the json data is a string
117
+ if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
118
+ throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
115
119
  }
116
120
  // ensure the json data is an array
117
121
  if (!Array.isArray(data['errors'])) {
@@ -133,6 +137,11 @@ CreateSubmissionDataRequestEventResponse.prototype['status'] = undefined;
133
137
  */
134
138
  CreateSubmissionDataRequestEventResponse.prototype['event'] = undefined;
135
139
 
140
+ /**
141
+ * @member {String} error
142
+ */
143
+ CreateSubmissionDataRequestEventResponse.prototype['error'] = undefined;
144
+
136
145
  /**
137
146
  * @member {Array.<String>} errors
138
147
  */