docspring-ts 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.
- package/AGENTS.md +2 -0
- package/LICENSE +1 -1
- package/README.md +23 -1
- package/dist/RequestSchemas.js +1708 -88
- package/dist/RequestSchemas.js.map +1 -1
- package/dist/RequestValidator.js +3 -0
- package/dist/RequestValidator.js.map +1 -1
- package/dist/apis/Client.d.ts +82 -32
- package/dist/apis/Client.js +3661 -1666
- package/dist/apis/Client.js.map +1 -1
- package/dist/http/isomorphic-fetch.js +1 -1
- package/dist/models/CreateAccountEmailActionRequest.d.ts +42 -0
- package/dist/models/CreateAccountEmailActionRequest.js +131 -0
- package/dist/models/CreateAccountEmailActionRequest.js.map +1 -0
- package/dist/models/CreateEmailActionRequest.d.ts +40 -0
- package/dist/models/CreateEmailActionRequest.js +119 -0
- package/dist/models/CreateEmailActionRequest.js.map +1 -0
- package/dist/models/CreateEmailDomainRequest.d.ts +20 -0
- package/dist/models/CreateEmailDomainRequest.js +23 -0
- package/dist/models/CreateEmailDomainRequest.js.map +1 -0
- package/dist/models/CreateSubmissionRequest.d.ts +11 -0
- package/dist/models/CreateSubmissionRequest.js +54 -0
- package/dist/models/CreateSubmissionRequest.js.map +1 -1
- package/dist/models/CreateTemplateRequest.d.ts +15 -0
- package/dist/models/CreateTemplateRequest.js +72 -0
- package/dist/models/CreateTemplateRequest.js.map +1 -1
- package/dist/models/DnsRecordType.d.ts +6 -0
- package/dist/models/DnsRecordType.js +9 -0
- package/dist/models/DnsRecordType.js.map +1 -0
- package/dist/models/EmailAction.d.ts +54 -0
- package/dist/models/EmailAction.js +197 -0
- package/dist/models/EmailAction.js.map +1 -0
- package/dist/models/EmailActionConditions.d.ts +23 -0
- package/dist/models/EmailActionConditions.js +29 -0
- package/dist/models/EmailActionConditions.js.map +1 -0
- package/dist/models/EmailActionConditionsInput.d.ts +23 -0
- package/dist/models/EmailActionConditionsInput.js +29 -0
- package/dist/models/EmailActionConditionsInput.js.map +1 -0
- package/dist/models/EmailActionCustomization.d.ts +30 -0
- package/dist/models/EmailActionCustomization.js +77 -0
- package/dist/models/EmailActionCustomization.js.map +1 -0
- package/dist/models/EmailActionDelivery.d.ts +5 -0
- package/dist/models/EmailActionDelivery.js +8 -0
- package/dist/models/EmailActionDelivery.js.map +1 -0
- package/dist/models/EmailActionFileFormats.d.ts +7 -0
- package/dist/models/EmailActionFileFormats.js +10 -0
- package/dist/models/EmailActionFileFormats.js.map +1 -0
- package/dist/models/EmailActionList.d.ts +22 -0
- package/dist/models/EmailActionList.js +29 -0
- package/dist/models/EmailActionList.js.map +1 -0
- package/dist/models/EmailActionSetting.d.ts +17 -0
- package/dist/models/EmailActionSetting.js +20 -0
- package/dist/models/EmailActionSetting.js.map +1 -0
- package/dist/models/EmailActionSubmissionType.d.ts +6 -0
- package/dist/models/EmailActionSubmissionType.js +9 -0
- package/dist/models/EmailActionSubmissionType.js.map +1 -0
- package/dist/models/EmailActionTestEmail.d.ts +20 -0
- package/dist/models/EmailActionTestEmail.js +23 -0
- package/dist/models/EmailActionTestEmail.js.map +1 -0
- package/dist/models/EmailDomain.d.ts +33 -0
- package/dist/models/EmailDomain.js +83 -0
- package/dist/models/EmailDomain.js.map +1 -0
- package/dist/models/EmailDomainDnsRecord.d.ts +25 -0
- package/dist/models/EmailDomainDnsRecord.js +41 -0
- package/dist/models/EmailDomainDnsRecord.js.map +1 -0
- package/dist/models/EmailDomainDnsRecordPurpose.d.ts +6 -0
- package/dist/models/EmailDomainDnsRecordPurpose.js +9 -0
- package/dist/models/EmailDomainDnsRecordPurpose.js.map +1 -0
- package/dist/models/EmailDomainList.d.ts +22 -0
- package/dist/models/EmailDomainList.js +29 -0
- package/dist/models/EmailDomainList.js.map +1 -0
- package/dist/models/EmailDomainRecordState.d.ts +6 -0
- package/dist/models/EmailDomainRecordState.js +9 -0
- package/dist/models/EmailDomainRecordState.js.map +1 -0
- package/dist/models/EmailDomainState.d.ts +6 -0
- package/dist/models/EmailDomainState.js +9 -0
- package/dist/models/EmailDomainState.js.map +1 -0
- package/dist/models/ErrorCode.d.ts +2 -0
- package/dist/models/ErrorCode.js +2 -0
- package/dist/models/ErrorCode.js.map +1 -1
- package/dist/models/ErrorInfo.d.ts +5 -0
- package/dist/models/ErrorInfo.js +30 -0
- package/dist/models/ErrorInfo.js.map +1 -1
- package/dist/models/ObjectSerializer.d.ts +30 -0
- package/dist/models/ObjectSerializer.js +79 -0
- package/dist/models/ObjectSerializer.js.map +1 -1
- package/dist/models/SendAccountEmailActionTestEmailRequest.d.ts +20 -0
- package/dist/models/SendAccountEmailActionTestEmailRequest.js +23 -0
- package/dist/models/SendAccountEmailActionTestEmailRequest.js.map +1 -0
- package/dist/models/SignatureRequest.d.ts +5 -0
- package/dist/models/SignatureRequest.js +24 -0
- package/dist/models/SignatureRequest.js.map +1 -1
- package/dist/models/SignatureRequestEmailAttachments.d.ts +5 -0
- package/dist/models/SignatureRequestEmailAttachments.js +8 -0
- package/dist/models/SignatureRequestEmailAttachments.js.map +1 -0
- package/dist/models/SignatureRequestEmailStatus.d.ts +11 -0
- package/dist/models/SignatureRequestEmailStatus.js +14 -0
- package/dist/models/SignatureRequestEmailStatus.js.map +1 -0
- package/dist/models/SignatureRequestEventType.d.ts +2 -0
- package/dist/models/SignatureRequestEventType.js +3 -1
- package/dist/models/SignatureRequestEventType.js.map +1 -1
- package/dist/models/SignatureRequestInput.d.ts +3 -1
- package/dist/models/SignatureRequestInput.js +12 -0
- package/dist/models/SignatureRequestInput.js.map +1 -1
- package/dist/models/SignatureRequestReminders.d.ts +21 -0
- package/dist/models/SignatureRequestReminders.js +29 -0
- package/dist/models/SignatureRequestReminders.js.map +1 -0
- package/dist/models/SigningOrder.d.ts +5 -0
- package/dist/models/SigningOrder.js +8 -0
- package/dist/models/SigningOrder.js.map +1 -0
- package/dist/models/StringConditionType.d.ts +7 -0
- package/dist/models/StringConditionType.js +8 -1
- package/dist/models/StringConditionType.js.map +1 -1
- package/dist/models/Submission.d.ts +2 -0
- package/dist/models/Submission.js +6 -0
- package/dist/models/Submission.js.map +1 -1
- package/dist/models/SubmissionAction.d.ts +1 -0
- package/dist/models/SubmissionAction.js +6 -0
- package/dist/models/SubmissionAction.js.map +1 -1
- package/dist/models/Template.d.ts +16 -0
- package/dist/models/Template.js +72 -0
- package/dist/models/Template.js.map +1 -1
- package/dist/models/TemplateFormSection.d.ts +23 -0
- package/dist/models/TemplateFormSection.js +41 -0
- package/dist/models/TemplateFormSection.js.map +1 -0
- package/dist/models/TemplateFormSectionInput.d.ts +23 -0
- package/dist/models/TemplateFormSectionInput.js +41 -0
- package/dist/models/TemplateFormSectionInput.js.map +1 -0
- package/dist/models/TemplateType.d.ts +1 -0
- package/dist/models/TemplateType.js +2 -1
- package/dist/models/TemplateType.js.map +1 -1
- package/dist/models/UpdateAccountEmailActionRequest.d.ts +42 -0
- package/dist/models/UpdateAccountEmailActionRequest.js +131 -0
- package/dist/models/UpdateAccountEmailActionRequest.js.map +1 -0
- package/dist/models/UpdateEmailActionCustomizationRequest.d.ts +38 -0
- package/dist/models/UpdateEmailActionCustomizationRequest.js +107 -0
- package/dist/models/UpdateEmailActionCustomizationRequest.js.map +1 -0
- package/dist/models/UpdateEmailActionRequest.d.ts +40 -0
- package/dist/models/UpdateEmailActionRequest.js +119 -0
- package/dist/models/UpdateEmailActionRequest.js.map +1 -0
- package/dist/models/UpdateTemplateRequest.d.ts +16 -0
- package/dist/models/UpdateTemplateRequest.js +72 -0
- package/dist/models/UpdateTemplateRequest.js.map +1 -1
- package/dist/models/ValidateSubmissionRequest.d.ts +11 -0
- package/dist/models/ValidateSubmissionRequest.js +54 -0
- package/dist/models/ValidateSubmissionRequest.js.map +1 -1
- package/dist/models/WebhookEventType.d.ts +2 -0
- package/dist/models/WebhookEventType.js +2 -0
- package/dist/models/WebhookEventType.js.map +1 -1
- package/dist/models/all.d.ts +30 -0
- package/dist/models/all.js +30 -0
- package/dist/models/all.js.map +1 -1
- package/dist/types/ObjectParamAPI.d.ts +168 -0
- package/dist/types/ObjectParamAPI.js +182 -64
- package/dist/types/ObjectParamAPI.js.map +1 -1
- package/dist/types/ObservableAPI.d.ts +114 -64
- package/dist/types/ObservableAPI.js +819 -287
- package/dist/types/ObservableAPI.js.map +1 -1
- package/dist/types/PromiseAPI.d.ts +114 -64
- package/dist/types/PromiseAPI.js +318 -128
- package/dist/types/PromiseAPI.js.map +1 -1
- 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 TypeScript 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 TypeScript
|
|
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-
|
|
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
|
-
|
|
13
|
+
Outside TypeScript 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
|
|
|
@@ -95,8 +98,11 @@ TypeScript code for every method.
|
|
|
95
98
|
| ------ | ----------- |
|
|
96
99
|
| [`addTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#addtemplatefields) | Add fields to a template |
|
|
97
100
|
| [`copyTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#copytemplate) | Copy a template |
|
|
101
|
+
| [`createAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createaccountemailaction) | Create an account email action |
|
|
98
102
|
| [`createCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcombinedpdf) | Combine PDFs |
|
|
99
103
|
| [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a custom file from an upload |
|
|
104
|
+
| [`createEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createemailaction) | Create an email action |
|
|
105
|
+
| [`createEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createemaildomain) | Add an email domain |
|
|
100
106
|
| [`createFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createfolder) | Create a folder |
|
|
101
107
|
| [`createSignatureRequestEvent`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsignaturerequestevent) | Record a signature request event |
|
|
102
108
|
| [`createSignatureRequestToken`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsignaturerequesttoken) | Create a signature request token |
|
|
@@ -105,7 +111,11 @@ TypeScript code for every method.
|
|
|
105
111
|
| [`createTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplate) | Create a template |
|
|
106
112
|
| [`createTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplatepreview) | Preview a template with data |
|
|
107
113
|
| [`createWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createwebhook) | Create a webhook |
|
|
114
|
+
| [`deleteAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteaccountemailaction) | Delete an account email action |
|
|
108
115
|
| [`deleteCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletecustomfile) | Delete a custom file |
|
|
116
|
+
| [`deleteEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemailaction) | Delete an email action |
|
|
117
|
+
| [`deleteEmailActionCustomization`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemailactioncustomization) | Reset an account email action's customization |
|
|
118
|
+
| [`deleteEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deleteemaildomain) | Remove an email domain |
|
|
109
119
|
| [`deleteFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletefolder) | Delete a folder |
|
|
110
120
|
| [`deleteTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletetemplate) | Delete a template |
|
|
111
121
|
| [`deleteWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
|
|
@@ -113,8 +123,11 @@ TypeScript code for every method.
|
|
|
113
123
|
| [`expireSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expiresubmission) | Expire a submission |
|
|
114
124
|
| [`generateSubmissionFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionfiles) | Generate more files |
|
|
115
125
|
| [`generateSubmissionPreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionpreview) | Generate a preview PDF |
|
|
126
|
+
| [`getAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getaccountemailaction) | Get an account email action |
|
|
116
127
|
| [`getCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcombinedpdf) | Get a combined PDF |
|
|
117
128
|
| [`getCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcustomfile) | Get a custom file |
|
|
129
|
+
| [`getEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getemailaction) | Get an email action |
|
|
130
|
+
| [`getEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getemaildomain) | Get an email domain |
|
|
118
131
|
| [`getFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getfolder) | Get a folder |
|
|
119
132
|
| [`getPresignUrl`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getpresignurl) | Get a presigned URL to upload a file |
|
|
120
133
|
| [`getSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsignaturerequest) | Get a signature request |
|
|
@@ -127,8 +140,11 @@ TypeScript code for every method.
|
|
|
127
140
|
| [`getTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatepreview) | Get a template preview |
|
|
128
141
|
| [`getTemplateSchema`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplateschema) | Get the JSON Schema of a template's submission data |
|
|
129
142
|
| [`getWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
|
|
143
|
+
| [`listAccountEmailActions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listaccountemailactions) | List account email actions |
|
|
130
144
|
| [`listCombinedPdfs`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcombinedpdfs) | List combined PDFs |
|
|
131
145
|
| [`listCustomFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcustomfiles) | List custom files |
|
|
146
|
+
| [`listEmailActions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listemailactions) | List email actions |
|
|
147
|
+
| [`listEmailDomains`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listemaildomains) | List email domains |
|
|
132
148
|
| [`listFolders`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listfolders) | List folders |
|
|
133
149
|
| [`listSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listsubmissions) | List submissions |
|
|
134
150
|
| [`listTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatefields) | List a template's fields |
|
|
@@ -142,7 +158,12 @@ TypeScript code for every method.
|
|
|
142
158
|
| [`renameFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
|
|
143
159
|
| [`reorderTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#reordertemplatefields) | Reorder a template's fields |
|
|
144
160
|
| [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
|
|
161
|
+
| [`sendAccountEmailActionTestEmail`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#sendaccountemailactiontestemail) | Send a test email for an account email action |
|
|
162
|
+
| [`sendEmailActionTestEmail`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#sendemailactiontestemail) | Send a test email |
|
|
145
163
|
| [`testAuthentication`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#testauthentication) | Test authentication |
|
|
164
|
+
| [`updateAccountEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateaccountemailaction) | Update an account email action |
|
|
165
|
+
| [`updateEmailAction`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateemailaction) | Update an email action |
|
|
166
|
+
| [`updateEmailActionCustomization`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updateemailactioncustomization) | Customize an account email action for a template |
|
|
146
167
|
| [`updateSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatesignaturerequest) | Update a signature request |
|
|
147
168
|
| [`updateTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplate) | Update a template |
|
|
148
169
|
| [`updateTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's document |
|
|
@@ -151,6 +172,7 @@ TypeScript code for every method.
|
|
|
151
172
|
| [`uploadTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplate) | Create a template from an uploaded PDF or Word document |
|
|
152
173
|
| [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's document with an uploaded file |
|
|
153
174
|
| [`validateSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
|
|
175
|
+
| [`verifyEmailDomain`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#verifyemaildomain) | Verify an email domain |
|
|
154
176
|
|
|
155
177
|
## Errors
|
|
156
178
|
|