docspring 4.4.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 +4 -1
- package/dist/ApiClient.js +2 -2
- package/dist/RequestSchemas.js +65 -10
- package/dist/api/Client.js +101 -98
- package/dist/index.js +14 -0
- package/dist/model/AddTemplateFieldsRequest.js +1 -1
- package/dist/model/AuthenticationCheck.js +1 -1
- package/dist/model/CombinedPdf.js +1 -1
- package/dist/model/CombinedPdfFiles.js +1 -1
- package/dist/model/CombinedPdfList.js +1 -1
- package/dist/model/CombinedPdfSource.js +1 -1
- package/dist/model/CombinedPdfSourceInput.js +1 -1
- package/dist/model/CombinedPdfSourcePdf.js +1 -1
- package/dist/model/CopyTemplateRequest.js +1 -1
- package/dist/model/CreateAccountEmailActionRequest.js +1 -1
- package/dist/model/CreateCombinedPdfRequest.js +1 -1
- package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
- package/dist/model/CreateEmailActionRequest.js +1 -1
- package/dist/model/CreateEmailDomainRequest.js +1 -1
- package/dist/model/CreateFolderRequest.js +1 -1
- package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
- package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
- package/dist/model/CreateSubmissionBatchRequest.js +1 -1
- package/dist/model/CreateSubmissionRequest.js +4 -4
- package/dist/model/CreateTemplatePreviewRequest.js +1 -1
- package/dist/model/CreateTemplateRequest.js +47 -3
- package/dist/model/CreateWebhookRequest.js +1 -1
- package/dist/model/CustomFile.js +1 -1
- package/dist/model/CustomFileList.js +1 -1
- package/dist/model/CustomFileSourcePdf.js +1 -1
- package/dist/model/EmailAction.js +1 -1
- package/dist/model/EmailActionConditions.js +1 -1
- package/dist/model/EmailActionConditionsInput.js +1 -1
- package/dist/model/EmailActionCustomization.js +1 -1
- package/dist/model/EmailActionList.js +1 -1
- package/dist/model/EmailActionTestEmail.js +1 -1
- package/dist/model/EmailDomain.js +1 -1
- package/dist/model/EmailDomainDnsRecord.js +1 -1
- package/dist/model/EmailDomainList.js +1 -1
- package/dist/model/ErrorDetail.js +1 -1
- package/dist/model/ErrorInfo.js +30 -4
- package/dist/model/ErrorResponse.js +1 -1
- package/dist/model/Field.js +1 -1
- package/dist/model/FieldComparisonCondition.js +1 -1
- package/dist/model/FieldDependency.js +1 -1
- package/dist/model/FieldDependencyInput.js +1 -1
- package/dist/model/FieldEqualsCondition.js +1 -1
- package/dist/model/FieldGroup.js +1 -1
- package/dist/model/FieldGroupInput.js +1 -1
- package/dist/model/FieldInCondition.js +1 -1
- package/dist/model/FieldInput.js +1 -1
- package/dist/model/FieldOverride.js +1 -1
- package/dist/model/FieldPresenceCondition.js +1 -1
- package/dist/model/FieldRangeCondition.js +1 -1
- package/dist/model/Folder.js +1 -1
- package/dist/model/FolderList.js +1 -1
- package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
- package/dist/model/GeneratedFile.js +1 -1
- package/dist/model/HtmlEngineOptions.js +7 -7
- package/dist/model/HtmlEngineOptionsInput.js +5 -5
- package/dist/model/MoveFolderRequest.js +1 -1
- package/dist/model/MoveTemplateRequest.js +1 -1
- package/dist/model/PageImage.js +1 -1
- package/dist/model/PageImages.js +1 -1
- package/dist/model/PredefinedField.js +1 -1
- package/dist/model/PredefinedFieldInput.js +1 -1
- package/dist/model/PublishTemplateVersionRequest.js +1 -1
- package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
- package/dist/model/RenameFolderRequest.js +1 -1
- package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
- package/dist/model/RestoreTemplateVersionRequest.js +1 -1
- package/dist/model/SendAccountEmailActionTestEmailRequest.js +1 -1
- package/dist/model/SignatureRequest.js +1 -1
- package/dist/model/SignatureRequestEvent.js +1 -1
- package/dist/model/SignatureRequestInput.js +1 -1
- package/dist/model/SignatureRequestReminders.js +1 -1
- package/dist/model/SignatureRequestToken.js +1 -1
- package/dist/model/Submission.js +1 -1
- package/dist/model/SubmissionAction.js +1 -1
- package/dist/model/SubmissionBatch.js +1 -1
- package/dist/model/SubmissionFiles.js +1 -1
- package/dist/model/SubmissionInput.js +2 -2
- package/dist/model/SubmissionList.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +1 -1
- package/dist/model/SubmissionSummary.js +1 -1
- package/dist/model/SubmissionValidation.js +1 -1
- package/dist/model/Template.js +66 -9
- package/dist/model/TemplateActor.js +1 -1
- package/dist/model/TemplateDefaults.js +1 -1
- package/dist/model/TemplateDefaultsInput.js +1 -1
- package/dist/model/TemplateDiff.js +1 -1
- package/dist/model/TemplateDiffSummary.js +1 -1
- package/dist/model/TemplateDocument.js +1 -1
- package/dist/model/TemplateDocumentSummary.js +1 -1
- package/dist/model/TemplateFieldChange.js +1 -1
- package/dist/model/TemplateFieldChanges.js +1 -1
- package/dist/model/TemplateFieldDependency.js +1 -1
- package/dist/model/TemplateFieldDependencyCondition.js +1 -1
- package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
- package/dist/model/TemplateFieldDependencyInput.js +1 -1
- package/dist/model/TemplateFieldMove.js +1 -1
- package/dist/model/TemplateFields.js +1 -1
- package/dist/model/TemplateFormSection.js +161 -0
- package/dist/model/TemplateFormSectionInput.js +157 -0
- package/dist/model/TemplateModelCode.js +1 -1
- package/dist/model/TemplatePageImages.js +1 -1
- package/dist/model/TemplatePageProcessingStatus.js +1 -1
- package/dist/model/TemplatePreview.js +1 -1
- package/dist/model/TemplateSourcePdf.js +1 -1
- package/dist/model/TemplateSummary.js +1 -1
- package/dist/model/TemplateSummaryList.js +1 -1
- package/dist/model/TemplateVersion.js +1 -1
- package/dist/model/UpdateAccountEmailActionRequest.js +1 -1
- package/dist/model/UpdateEmailActionCustomizationRequest.js +1 -1
- package/dist/model/UpdateEmailActionRequest.js +1 -1
- package/dist/model/UpdateSignatureRequestRequest.js +1 -1
- package/dist/model/UpdateTemplateDocumentRequest.js +1 -1
- package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
- package/dist/model/UpdateTemplateRequest.js +75 -9
- package/dist/model/UpdateWebhookRequest.js +1 -1
- package/dist/model/UploadPresign.js +1 -1
- package/dist/model/UrlSourcePdf.js +1 -1
- package/dist/model/ValidateSubmissionRequest.js +4 -4
- package/dist/model/Webhook.js +1 -1
- package/dist/model/WebhookList.js +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 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-
|
|
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 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
|
|
package/dist/ApiClient.js
CHANGED
|
@@ -38,7 +38,7 @@ function responseInfo(response) {
|
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* @module ApiClient
|
|
41
|
-
* @version 4.
|
|
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.
|
|
91
|
+
'User-Agent': 'docspring-javascript-4.5.0'
|
|
92
92
|
};
|
|
93
93
|
|
|
94
94
|
/**
|
package/dist/RequestSchemas.js
CHANGED
|
@@ -1256,8 +1256,7 @@ var _default = exports["default"] = {
|
|
|
1256
1256
|
"type": "boolean"
|
|
1257
1257
|
},
|
|
1258
1258
|
"redirect_url": {
|
|
1259
|
-
"type": ["string", "null"]
|
|
1260
|
-
"format": "uri"
|
|
1259
|
+
"type": ["string", "null"]
|
|
1261
1260
|
},
|
|
1262
1261
|
"signature_request_email_attachments": {
|
|
1263
1262
|
"type": ["string", "null"],
|
|
@@ -1288,6 +1287,17 @@ var _default = exports["default"] = {
|
|
|
1288
1287
|
"type": ["string", "null"],
|
|
1289
1288
|
"maxLength": 2048
|
|
1290
1289
|
},
|
|
1290
|
+
"success_title": {
|
|
1291
|
+
"type": ["string", "null"],
|
|
1292
|
+
"maxLength": 512
|
|
1293
|
+
},
|
|
1294
|
+
"success_message": {
|
|
1295
|
+
"type": ["string", "null"],
|
|
1296
|
+
"maxLength": 5000
|
|
1297
|
+
},
|
|
1298
|
+
"show_fill_again_button": {
|
|
1299
|
+
"type": "boolean"
|
|
1300
|
+
},
|
|
1291
1301
|
"slack_webhook_url": {
|
|
1292
1302
|
"type": ["string", "null"],
|
|
1293
1303
|
"format": "uri"
|
|
@@ -1543,10 +1553,9 @@ var _default = exports["default"] = {
|
|
|
1543
1553
|
},
|
|
1544
1554
|
"filename": {
|
|
1545
1555
|
"type": "string",
|
|
1546
|
-
"minLength": 1,
|
|
1547
1556
|
"maxLength": 255,
|
|
1548
|
-
"pattern": "^[^/\\\\]*$",
|
|
1549
|
-
"x-pattern-message": "can't contain a slash (/ or \\)"
|
|
1557
|
+
"pattern": "^[^/\\\\]*[^/\\\\ \t\n\x0B\f\r\x85\xA0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000][^/\\\\]*$",
|
|
1558
|
+
"x-pattern-message": "can't be blank or contain a slash (/ or \\)"
|
|
1550
1559
|
},
|
|
1551
1560
|
"detect_fields": {
|
|
1552
1561
|
"type": "boolean"
|
|
@@ -1562,6 +1571,9 @@ var _default = exports["default"] = {
|
|
|
1562
1571
|
"field_logic": {
|
|
1563
1572
|
"type": "string",
|
|
1564
1573
|
"enum": ["ai", "none"]
|
|
1574
|
+
},
|
|
1575
|
+
"include_office_use_fields": {
|
|
1576
|
+
"type": "boolean"
|
|
1565
1577
|
}
|
|
1566
1578
|
},
|
|
1567
1579
|
"required": ["template_type"],
|
|
@@ -2852,8 +2864,7 @@ var _default = exports["default"] = {
|
|
|
2852
2864
|
"type": "boolean"
|
|
2853
2865
|
},
|
|
2854
2866
|
"redirect_url": {
|
|
2855
|
-
"type": ["string", "null"]
|
|
2856
|
-
"format": "uri"
|
|
2867
|
+
"type": ["string", "null"]
|
|
2857
2868
|
},
|
|
2858
2869
|
"signature_request_email_attachments": {
|
|
2859
2870
|
"type": ["string", "null"],
|
|
@@ -2884,6 +2895,17 @@ var _default = exports["default"] = {
|
|
|
2884
2895
|
"type": ["string", "null"],
|
|
2885
2896
|
"maxLength": 2048
|
|
2886
2897
|
},
|
|
2898
|
+
"success_title": {
|
|
2899
|
+
"type": ["string", "null"],
|
|
2900
|
+
"maxLength": 512
|
|
2901
|
+
},
|
|
2902
|
+
"success_message": {
|
|
2903
|
+
"type": ["string", "null"],
|
|
2904
|
+
"maxLength": 5000
|
|
2905
|
+
},
|
|
2906
|
+
"show_fill_again_button": {
|
|
2907
|
+
"type": "boolean"
|
|
2908
|
+
},
|
|
2887
2909
|
"slack_webhook_url": {
|
|
2888
2910
|
"type": ["string", "null"],
|
|
2889
2911
|
"format": "uri"
|
|
@@ -3028,6 +3050,7 @@ var _default = exports["default"] = {
|
|
|
3028
3050
|
},
|
|
3029
3051
|
"field_groups": {
|
|
3030
3052
|
"type": "array",
|
|
3053
|
+
"minItems": 1,
|
|
3031
3054
|
"items": {
|
|
3032
3055
|
"type": "object",
|
|
3033
3056
|
"properties": {
|
|
@@ -3060,6 +3083,36 @@ var _default = exports["default"] = {
|
|
|
3060
3083
|
"additionalProperties": false
|
|
3061
3084
|
}
|
|
3062
3085
|
},
|
|
3086
|
+
"form_sections": {
|
|
3087
|
+
"type": "array",
|
|
3088
|
+
"items": {
|
|
3089
|
+
"type": "object",
|
|
3090
|
+
"properties": {
|
|
3091
|
+
"id": {
|
|
3092
|
+
"type": "string",
|
|
3093
|
+
"maxLength": 255,
|
|
3094
|
+
"pattern": "[^ \t\n\x0B\f\r\x85\xA0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000]",
|
|
3095
|
+
"x-pattern-message": "can't be blank"
|
|
3096
|
+
},
|
|
3097
|
+
"title": {
|
|
3098
|
+
"type": "string",
|
|
3099
|
+
"maxLength": 512
|
|
3100
|
+
},
|
|
3101
|
+
"description": {
|
|
3102
|
+
"type": ["string", "null"],
|
|
3103
|
+
"maxLength": 5000
|
|
3104
|
+
},
|
|
3105
|
+
"field_ids": {
|
|
3106
|
+
"type": "array",
|
|
3107
|
+
"items": {
|
|
3108
|
+
"type": "integer"
|
|
3109
|
+
}
|
|
3110
|
+
}
|
|
3111
|
+
},
|
|
3112
|
+
"required": ["id", "title", "field_ids"],
|
|
3113
|
+
"additionalProperties": false
|
|
3114
|
+
}
|
|
3115
|
+
},
|
|
3063
3116
|
"predefined_fields": {
|
|
3064
3117
|
"type": "array",
|
|
3065
3118
|
"items": {
|
|
@@ -3194,10 +3247,9 @@ var _default = exports["default"] = {
|
|
|
3194
3247
|
},
|
|
3195
3248
|
"filename": {
|
|
3196
3249
|
"type": "string",
|
|
3197
|
-
"minLength": 1,
|
|
3198
3250
|
"maxLength": 255,
|
|
3199
|
-
"pattern": "^[^/\\\\]*$",
|
|
3200
|
-
"x-pattern-message": "can't contain a slash (/ or \\)"
|
|
3251
|
+
"pattern": "^[^/\\\\]*[^/\\\\ \t\n\x0B\f\r\x85\xA0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000][^/\\\\]*$",
|
|
3252
|
+
"x-pattern-message": "can't be blank or contain a slash (/ or \\)"
|
|
3201
3253
|
},
|
|
3202
3254
|
"reimport_fields": {
|
|
3203
3255
|
"type": "boolean"
|
|
@@ -3717,6 +3769,9 @@ var _default = exports["default"] = {
|
|
|
3717
3769
|
"output_format": {
|
|
3718
3770
|
"type": "string",
|
|
3719
3771
|
"enum": ["pdf", "docx", "odt"]
|
|
3772
|
+
},
|
|
3773
|
+
"include_office_use_fields": {
|
|
3774
|
+
"type": "boolean"
|
|
3720
3775
|
}
|
|
3721
3776
|
},
|
|
3722
3777
|
"additionalProperties": false
|