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
@@ -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 UploadPresignResponse model module.
31
31
  * @module model/UploadPresignResponse
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var UploadPresignResponse = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>UploadPresignResponse</code>.
37
37
  * @alias module:model/UploadPresignResponse
38
+ * @extends Object
38
39
  * @param fields {Object}
39
40
  * @param headers {Object}
40
41
  * @param url {String}
@@ -69,6 +70,7 @@ var UploadPresignResponse = /*#__PURE__*/function () {
69
70
  value: function constructFromObject(data, obj) {
70
71
  if (data) {
71
72
  obj = obj || new UploadPresignResponse();
73
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
72
74
  if (data.hasOwnProperty('fields')) {
73
75
  obj['fields'] = _ApiClient["default"].convertToType(data['fields'], Object);
74
76
  }
@@ -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 Webhook model module.
31
31
  * @module model/Webhook
32
- * @version 3.1.0
32
+ * @version 3.3.0
33
33
  */
34
34
  var Webhook = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>Webhook</code>.
37
37
  * @alias module:model/Webhook
38
+ * @extends Object
38
39
  * @param id {String}
39
40
  * @param name {String}
40
41
  * @param url {String}
@@ -103,6 +104,7 @@ var Webhook = /*#__PURE__*/function () {
103
104
  value: function constructFromObject(data, obj) {
104
105
  if (data) {
105
106
  obj = obj || new Webhook();
107
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
106
108
  if (data.hasOwnProperty('id')) {
107
109
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
108
110
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "3.1.0",
3
+ "version": "3.3.0",
4
4
  "description": "An API client for the DocSpring PDF generation service",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -41,6 +41,16 @@
41
41
  "sinon": "^7.2.0"
42
42
  },
43
43
  "files": [
44
- "dist"
45
- ]
44
+ "dist",
45
+ "AGENTS.md"
46
+ ],
47
+ "homepage": "https://github.com/DocSpring/docspring-javascript#readme",
48
+ "repository": {
49
+ "type": "git",
50
+ "url": "https://github.com/DocSpring/docspring-javascript.git"
51
+ },
52
+ "bugs": {
53
+ "url": "https://github.com/DocSpring/docspring-javascript/issues"
54
+ },
55
+ "author": "DocSpring"
46
56
  }