docspring 4.3.0 → 4.5.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 (145) hide show
  1. package/AGENTS.md +2 -0
  2. package/LICENSE +1 -1
  3. package/README.md +23 -1
  4. package/dist/ApiClient.js +2 -2
  5. package/dist/RequestSchemas.js +1212 -132
  6. package/dist/RequestValidator.js +4 -0
  7. package/dist/api/Client.js +1364 -207
  8. package/dist/index.js +210 -0
  9. package/dist/model/AddTemplateFieldsRequest.js +3 -3
  10. package/dist/model/AuthenticationCheck.js +1 -1
  11. package/dist/model/CombinedPdf.js +1 -1
  12. package/dist/model/CombinedPdfFiles.js +1 -1
  13. package/dist/model/CombinedPdfList.js +1 -1
  14. package/dist/model/CombinedPdfSource.js +2 -2
  15. package/dist/model/CombinedPdfSourceInput.js +2 -2
  16. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  17. package/dist/model/CopyTemplateRequest.js +1 -1
  18. package/dist/model/CreateAccountEmailActionRequest.js +306 -0
  19. package/dist/model/CreateCombinedPdfRequest.js +1 -1
  20. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  21. package/dist/model/CreateEmailActionRequest.js +280 -0
  22. package/dist/model/CreateEmailDomainRequest.js +114 -0
  23. package/dist/model/CreateFolderRequest.js +1 -1
  24. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  25. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  26. package/dist/model/CreateSubmissionBatchRequest.js +4 -4
  27. package/dist/model/CreateSubmissionRequest.js +114 -6
  28. package/dist/model/CreateTemplatePreviewRequest.js +1 -1
  29. package/dist/model/CreateTemplateRequest.js +148 -9
  30. package/dist/model/CreateWebhookRequest.js +1 -1
  31. package/dist/model/CustomFile.js +1 -1
  32. package/dist/model/CustomFileList.js +1 -1
  33. package/dist/model/CustomFileSourcePdf.js +1 -1
  34. package/dist/model/DnsRecordType.js +64 -0
  35. package/dist/model/EmailAction.js +510 -0
  36. package/dist/model/EmailActionConditions.js +142 -0
  37. package/dist/model/EmailActionConditionsInput.js +142 -0
  38. package/dist/model/EmailActionCustomization.js +222 -0
  39. package/dist/model/EmailActionDelivery.js +59 -0
  40. package/dist/model/EmailActionFileFormats.js +69 -0
  41. package/dist/model/EmailActionList.js +132 -0
  42. package/dist/model/EmailActionSetting.js +119 -0
  43. package/dist/model/EmailActionSubmissionType.js +64 -0
  44. package/dist/model/EmailActionTestEmail.js +116 -0
  45. package/dist/model/EmailDomain.js +245 -0
  46. package/dist/model/EmailDomainDnsRecord.js +155 -0
  47. package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
  48. package/dist/model/EmailDomainList.js +132 -0
  49. package/dist/model/EmailDomainRecordState.js +64 -0
  50. package/dist/model/EmailDomainState.js +64 -0
  51. package/dist/model/ErrorCode.js +10 -0
  52. package/dist/model/ErrorDetail.js +1 -1
  53. package/dist/model/ErrorInfo.js +72 -7
  54. package/dist/model/ErrorResponse.js +1 -1
  55. package/dist/model/Field.js +3 -3
  56. package/dist/model/FieldComparisonCondition.js +1 -1
  57. package/dist/model/FieldDependency.js +1 -1
  58. package/dist/model/FieldDependencyInput.js +1 -1
  59. package/dist/model/FieldEqualsCondition.js +1 -1
  60. package/dist/model/FieldGroup.js +1 -1
  61. package/dist/model/FieldGroupInput.js +1 -1
  62. package/dist/model/FieldInCondition.js +1 -1
  63. package/dist/model/FieldInput.js +2 -2
  64. package/dist/model/FieldOverride.js +1 -1
  65. package/dist/model/FieldPresenceCondition.js +1 -1
  66. package/dist/model/FieldRangeCondition.js +1 -1
  67. package/dist/model/Folder.js +1 -1
  68. package/dist/model/FolderList.js +1 -1
  69. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  70. package/dist/model/GeneratedFile.js +1 -1
  71. package/dist/model/HtmlEngineOptions.js +9 -9
  72. package/dist/model/HtmlEngineOptionsInput.js +6 -6
  73. package/dist/model/MoveFolderRequest.js +1 -1
  74. package/dist/model/MoveTemplateRequest.js +1 -1
  75. package/dist/model/PageImage.js +1 -1
  76. package/dist/model/PageImages.js +1 -1
  77. package/dist/model/PredefinedField.js +1 -1
  78. package/dist/model/PredefinedFieldInput.js +1 -1
  79. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  80. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  81. package/dist/model/RenameFolderRequest.js +1 -1
  82. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  83. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  84. package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
  85. package/dist/model/SignatureRequest.js +52 -7
  86. package/dist/model/SignatureRequestEmailAttachments.js +59 -0
  87. package/dist/model/SignatureRequestEmailStatus.js +89 -0
  88. package/dist/model/SignatureRequestEvent.js +1 -1
  89. package/dist/model/SignatureRequestEventType.js +11 -1
  90. package/dist/model/SignatureRequestInput.js +24 -8
  91. package/dist/model/SignatureRequestReminders.js +121 -0
  92. package/dist/model/SignatureRequestToken.js +1 -1
  93. package/dist/model/SigningOrder.js +59 -0
  94. package/dist/model/StringConditionType.js +36 -1
  95. package/dist/model/Submission.js +21 -9
  96. package/dist/model/SubmissionAction.js +27 -12
  97. package/dist/model/SubmissionBatch.js +1 -1
  98. package/dist/model/SubmissionFiles.js +1 -1
  99. package/dist/model/SubmissionInput.js +5 -5
  100. package/dist/model/SubmissionList.js +1 -1
  101. package/dist/model/SubmissionSourcePdf.js +1 -1
  102. package/dist/model/SubmissionSummary.js +3 -3
  103. package/dist/model/SubmissionValidation.js +1 -1
  104. package/dist/model/Template.js +189 -21
  105. package/dist/model/TemplateActor.js +1 -1
  106. package/dist/model/TemplateDefaults.js +1 -1
  107. package/dist/model/TemplateDefaultsInput.js +1 -1
  108. package/dist/model/TemplateDiff.js +1 -1
  109. package/dist/model/TemplateDiffSummary.js +1 -1
  110. package/dist/model/TemplateDocument.js +1 -1
  111. package/dist/model/TemplateDocumentSummary.js +1 -1
  112. package/dist/model/TemplateFieldChange.js +1 -1
  113. package/dist/model/TemplateFieldChanges.js +1 -1
  114. package/dist/model/TemplateFieldDependency.js +1 -1
  115. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  116. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  117. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  118. package/dist/model/TemplateFieldMove.js +1 -1
  119. package/dist/model/TemplateFields.js +1 -1
  120. package/dist/model/TemplateFormSection.js +161 -0
  121. package/dist/model/TemplateFormSectionInput.js +157 -0
  122. package/dist/model/TemplateModelCode.js +1 -1
  123. package/dist/model/TemplatePageImages.js +1 -1
  124. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  125. package/dist/model/TemplatePreview.js +1 -1
  126. package/dist/model/TemplateSourcePdf.js +2 -2
  127. package/dist/model/TemplateSummary.js +9 -9
  128. package/dist/model/TemplateSummaryList.js +1 -1
  129. package/dist/model/TemplateType.js +6 -1
  130. package/dist/model/TemplateVersion.js +1 -1
  131. package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
  132. package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
  133. package/dist/model/UpdateEmailActionRequest.js +280 -0
  134. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  135. package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
  136. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  137. package/dist/model/UpdateTemplateRequest.js +173 -12
  138. package/dist/model/UpdateWebhookRequest.js +1 -1
  139. package/dist/model/UploadPresign.js +1 -1
  140. package/dist/model/UrlSourcePdf.js +1 -1
  141. package/dist/model/ValidateSubmissionRequest.js +114 -6
  142. package/dist/model/Webhook.js +1 -1
  143. package/dist/model/WebhookEventType.js +10 -0
  144. package/dist/model/WebhookList.js +1 -1
  145. package/package.json +1 -1
package/AGENTS.md CHANGED
@@ -20,6 +20,8 @@ keeps it.
20
20
  - https://docspring.com/docs/: the guides. https://docspring.com/docs/api/: the API reference, with JavaScript code
21
21
  for every method.
22
22
  - https://docspring.com/api-docs/v2/openapi.json: the OpenAPI spec this SDK is generated from.
23
+ - https://docspring.com/docs/cli/: the DocSpring CLI (`docspring`), for scripts and terminal work outside JavaScript
24
+ code. https://docspring.com/docs/mcp/: the MCP server, which connects AI assistants to a DocSpring account.
23
25
 
24
26
  ## Set up
25
27
 
package/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright © 2018-2020 DocSpring, Inc.
1
+ Copyright © 2018-2026 DocSpring, Inc.
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
4
 
package/README.md CHANGED
@@ -10,7 +10,10 @@ e-signatures.
10
10
  The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
11
11
  pull requests are welcome.
12
12
 
13
- Version 4.3.0.
13
+ Outside JavaScript code, the [DocSpring CLI](https://docspring.com/docs/cli/) calls the same API from a terminal or a
14
+ shell script, and the [MCP server](https://docspring.com/docs/mcp/) connects AI assistants to your account.
15
+
16
+ Version 4.5.0.
14
17
 
15
18
  ## Install and configure
16
19
 
@@ -92,8 +95,11 @@ JavaScript code for every method.
92
95
  | ------ | ----------- |
93
96
  | [`addTemplateFields`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#addtemplatefields) | Add fields to a template |
94
97
  | [`copyTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#copytemplate) | Copy a template |
98
+ | [`createAccountEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createaccountemailaction) | Create an account email action |
95
99
  | [`createCombinedPdf`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createcombinedpdf) | Combine PDFs |
96
100
  | [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a custom file from an upload |
101
+ | [`createEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createemailaction) | Create an email action |
102
+ | [`createEmailDomain`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createemaildomain) | Add an email domain |
97
103
  | [`createFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createfolder) | Create a folder |
98
104
  | [`createSignatureRequestEvent`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createsignaturerequestevent) | Record a signature request event |
99
105
  | [`createSignatureRequestToken`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createsignaturerequesttoken) | Create a signature request token |
@@ -102,7 +108,11 @@ JavaScript code for every method.
102
108
  | [`createTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createtemplate) | Create a template |
103
109
  | [`createTemplatePreview`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createtemplatepreview) | Preview a template with data |
104
110
  | [`createWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createwebhook) | Create a webhook |
111
+ | [`deleteAccountEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deleteaccountemailaction) | Delete an account email action |
105
112
  | [`deleteCustomFile`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletecustomfile) | Delete a custom file |
113
+ | [`deleteEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deleteemailaction) | Delete an email action |
114
+ | [`deleteEmailActionCustomization`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deleteemailactioncustomization) | Reset an account email action's customization |
115
+ | [`deleteEmailDomain`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deleteemaildomain) | Remove an email domain |
106
116
  | [`deleteFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletefolder) | Delete a folder |
107
117
  | [`deleteTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletetemplate) | Delete a template |
108
118
  | [`deleteWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
@@ -110,8 +120,11 @@ JavaScript code for every method.
110
120
  | [`expireSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#expiresubmission) | Expire a submission |
111
121
  | [`generateSubmissionFiles`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#generatesubmissionfiles) | Generate more files |
112
122
  | [`generateSubmissionPreview`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#generatesubmissionpreview) | Generate a preview PDF |
123
+ | [`getAccountEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getaccountemailaction) | Get an account email action |
113
124
  | [`getCombinedPdf`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getcombinedpdf) | Get a combined PDF |
114
125
  | [`getCustomFile`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getcustomfile) | Get a custom file |
126
+ | [`getEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getemailaction) | Get an email action |
127
+ | [`getEmailDomain`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getemaildomain) | Get an email domain |
115
128
  | [`getFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getfolder) | Get a folder |
116
129
  | [`getPresignUrl`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getpresignurl) | Get a presigned URL to upload a file |
117
130
  | [`getSignatureRequest`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getsignaturerequest) | Get a signature request |
@@ -124,8 +137,11 @@ JavaScript code for every method.
124
137
  | [`getTemplatePreview`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#gettemplatepreview) | Get a template preview |
125
138
  | [`getTemplateSchema`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#gettemplateschema) | Get the JSON Schema of a template's submission data |
126
139
  | [`getWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
140
+ | [`listAccountEmailActions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listaccountemailactions) | List account email actions |
127
141
  | [`listCombinedPdfs`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listcombinedpdfs) | List combined PDFs |
128
142
  | [`listCustomFiles`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listcustomfiles) | List custom files |
143
+ | [`listEmailActions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listemailactions) | List email actions |
144
+ | [`listEmailDomains`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listemaildomains) | List email domains |
129
145
  | [`listFolders`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listfolders) | List folders |
130
146
  | [`listSubmissions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listsubmissions) | List submissions |
131
147
  | [`listTemplateFields`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listtemplatefields) | List a template's fields |
@@ -139,7 +155,12 @@ JavaScript code for every method.
139
155
  | [`renameFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
140
156
  | [`reorderTemplateFields`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#reordertemplatefields) | Reorder a template's fields |
141
157
  | [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
158
+ | [`sendAccountEmailActionTestEmail`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#sendaccountemailactiontestemail) | Send a test email for an account email action |
159
+ | [`sendEmailActionTestEmail`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#sendemailactiontestemail) | Send a test email |
142
160
  | [`testAuthentication`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#testauthentication) | Test authentication |
161
+ | [`updateAccountEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updateaccountemailaction) | Update an account email action |
162
+ | [`updateEmailAction`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updateemailaction) | Update an email action |
163
+ | [`updateEmailActionCustomization`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updateemailactioncustomization) | Customize an account email action for a template |
143
164
  | [`updateSignatureRequest`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatesignaturerequest) | Update a signature request |
144
165
  | [`updateTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatetemplate) | Update a template |
145
166
  | [`updateTemplateDocument`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's document |
@@ -148,6 +169,7 @@ JavaScript code for every method.
148
169
  | [`uploadTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#uploadtemplate) | Create a template from an uploaded PDF or Word document |
149
170
  | [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's document with an uploaded file |
150
171
  | [`validateSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
172
+ | [`verifyEmailDomain`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#verifyemaildomain) | Verify an email domain |
151
173
 
152
174
  ## Errors
153
175
 
package/dist/ApiClient.js CHANGED
@@ -38,7 +38,7 @@ function responseInfo(response) {
38
38
 
39
39
  /**
40
40
  * @module ApiClient
41
- * @version 4.3.0
41
+ * @version 4.5.0
42
42
  */
43
43
 
44
44
  /**
@@ -88,7 +88,7 @@ var ApiClient = /*#__PURE__*/function () {
88
88
  * @default {}
89
89
  */
90
90
  this.defaultHeaders = {
91
- 'User-Agent': 'docspring-javascript-4.3.0'
91
+ 'User-Agent': 'docspring-javascript-4.5.0'
92
92
  };
93
93
 
94
94
  /**