docspring-ts 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.
Files changed (43) hide show
  1. package/AGENTS.md +2 -0
  2. package/LICENSE +1 -1
  3. package/README.md +4 -1
  4. package/dist/RequestSchemas.js +84 -10
  5. package/dist/RequestSchemas.js.map +1 -1
  6. package/dist/apis/Client.d.ts +1 -1
  7. package/dist/apis/Client.js +4 -1
  8. package/dist/apis/Client.js.map +1 -1
  9. package/dist/http/isomorphic-fetch.js +1 -1
  10. package/dist/models/CreateTemplateRequest.d.ts +4 -0
  11. package/dist/models/CreateTemplateRequest.js +24 -0
  12. package/dist/models/CreateTemplateRequest.js.map +1 -1
  13. package/dist/models/ErrorInfo.d.ts +2 -0
  14. package/dist/models/ErrorInfo.js +12 -0
  15. package/dist/models/ErrorInfo.js.map +1 -1
  16. package/dist/models/ObjectSerializer.d.ts +2 -0
  17. package/dist/models/ObjectSerializer.js +6 -0
  18. package/dist/models/ObjectSerializer.js.map +1 -1
  19. package/dist/models/Template.d.ts +5 -0
  20. package/dist/models/Template.js +24 -0
  21. package/dist/models/Template.js.map +1 -1
  22. package/dist/models/TemplateFormSection.d.ts +23 -0
  23. package/dist/models/TemplateFormSection.js +41 -0
  24. package/dist/models/TemplateFormSection.js.map +1 -0
  25. package/dist/models/TemplateFormSectionInput.d.ts +23 -0
  26. package/dist/models/TemplateFormSectionInput.js +41 -0
  27. package/dist/models/TemplateFormSectionInput.js.map +1 -0
  28. package/dist/models/UpdateTemplateRequest.d.ts +5 -0
  29. package/dist/models/UpdateTemplateRequest.js +24 -0
  30. package/dist/models/UpdateTemplateRequest.js.map +1 -1
  31. package/dist/models/all.d.ts +2 -0
  32. package/dist/models/all.js +2 -0
  33. package/dist/models/all.js.map +1 -1
  34. package/dist/types/ObjectParamAPI.d.ts +1 -0
  35. package/dist/types/ObjectParamAPI.js +2 -2
  36. package/dist/types/ObjectParamAPI.js.map +1 -1
  37. package/dist/types/ObservableAPI.d.ts +2 -2
  38. package/dist/types/ObservableAPI.js +4 -4
  39. package/dist/types/ObservableAPI.js.map +1 -1
  40. package/dist/types/PromiseAPI.d.ts +2 -2
  41. package/dist/types/PromiseAPI.js +4 -4
  42. package/dist/types/PromiseAPI.js.map +1 -1
  43. 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-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.4.0.
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
 
package/dist/RequestSchemas.js CHANGED
@@ -1846,8 +1846,7 @@ exports.requestSchemas = {
1846
1846
  "type": [
1847
1847
  "string",
1848
1848
  "null"
1849
- ],
1850
- "format": "uri"
1849
+ ]
1851
1850
  },
1852
1851
  "signature_request_email_attachments": {
1853
1852
  "type": [
@@ -1897,6 +1896,23 @@ exports.requestSchemas = {
1897
1896
  ],
1898
1897
  "maxLength": 2048
1899
1898
  },
1899
+ "success_title": {
1900
+ "type": [
1901
+ "string",
1902
+ "null"
1903
+ ],
1904
+ "maxLength": 512
1905
+ },
1906
+ "success_message": {
1907
+ "type": [
1908
+ "string",
1909
+ "null"
1910
+ ],
1911
+ "maxLength": 5000
1912
+ },
1913
+ "show_fill_again_button": {
1914
+ "type": "boolean"
1915
+ },
1900
1916
  "slack_webhook_url": {
1901
1917
  "type": [
1902
1918
  "string",
@@ -2350,10 +2366,9 @@ exports.requestSchemas = {
2350
2366
  },
2351
2367
  "filename": {
2352
2368
  "type": "string",
2353
- "minLength": 1,
2354
2369
  "maxLength": 255,
2355
- "pattern": "^[^/\\\\]*[^/\\\\ \t\n\u000b\f\r…   - 

  　][^/\\\\]*$",
2356
- "x-pattern-message": "can't contain a slash (/ or \\)"
2370
+ "pattern": "^[^/\\\\]*[^/\\\\ \t\n\u000b\f\r…   - 

  　][^/\\\\]*$",
2371
+ "x-pattern-message": "can't be blank or contain a slash (/ or \\)"
2357
2372
  },
2358
2373
  "detect_fields": {
2359
2374
  "type": "boolean"
@@ -2379,6 +2394,9 @@ exports.requestSchemas = {
2379
2394
  "ai",
2380
2395
  "none"
2381
2396
  ]
2397
+ },
2398
+ "include_office_use_fields": {
2399
+ "type": "boolean"
2382
2400
  }
2383
2401
  },
2384
2402
  "required": [
@@ -4136,8 +4154,7 @@ exports.requestSchemas = {
4136
4154
  "type": [
4137
4155
  "string",
4138
4156
  "null"
4139
- ],
4140
- "format": "uri"
4157
+ ]
4141
4158
  },
4142
4159
  "signature_request_email_attachments": {
4143
4160
  "type": [
@@ -4187,6 +4204,23 @@ exports.requestSchemas = {
4187
4204
  ],
4188
4205
  "maxLength": 2048
4189
4206
  },
4207
+ "success_title": {
4208
+ "type": [
4209
+ "string",
4210
+ "null"
4211
+ ],
4212
+ "maxLength": 512
4213
+ },
4214
+ "success_message": {
4215
+ "type": [
4216
+ "string",
4217
+ "null"
4218
+ ],
4219
+ "maxLength": 5000
4220
+ },
4221
+ "show_fill_again_button": {
4222
+ "type": "boolean"
4223
+ },
4190
4224
  "slack_webhook_url": {
4191
4225
  "type": [
4192
4226
  "string",
@@ -4468,6 +4502,7 @@ exports.requestSchemas = {
4468
4502
  },
4469
4503
  "field_groups": {
4470
4504
  "type": "array",
4505
+ "minItems": 1,
4471
4506
  "items": {
4472
4507
  "type": "object",
4473
4508
  "properties": {
@@ -4508,6 +4543,43 @@ exports.requestSchemas = {
4508
4543
  "additionalProperties": false
4509
4544
  }
4510
4545
  },
4546
+ "form_sections": {
4547
+ "type": "array",
4548
+ "items": {
4549
+ "type": "object",
4550
+ "properties": {
4551
+ "id": {
4552
+ "type": "string",
4553
+ "maxLength": 255,
4554
+ "pattern": "[^ \t\n\u000b\f\r…   - 

  　]",
4555
+ "x-pattern-message": "can't be blank"
4556
+ },
4557
+ "title": {
4558
+ "type": "string",
4559
+ "maxLength": 512
4560
+ },
4561
+ "description": {
4562
+ "type": [
4563
+ "string",
4564
+ "null"
4565
+ ],
4566
+ "maxLength": 5000
4567
+ },
4568
+ "field_ids": {
4569
+ "type": "array",
4570
+ "items": {
4571
+ "type": "integer"
4572
+ }
4573
+ }
4574
+ },
4575
+ "required": [
4576
+ "id",
4577
+ "title",
4578
+ "field_ids"
4579
+ ],
4580
+ "additionalProperties": false
4581
+ }
4582
+ },
4511
4583
  "predefined_fields": {
4512
4584
  "type": "array",
4513
4585
  "items": {
@@ -4703,10 +4775,9 @@ exports.requestSchemas = {
4703
4775
  },
4704
4776
  "filename": {
4705
4777
  "type": "string",
4706
- "minLength": 1,
4707
4778
  "maxLength": 255,
4708
- "pattern": "^[^/\\\\]*[^/\\\\ \t\n\u000b\f\r…   - 

  　][^/\\\\]*$",
4709
- "x-pattern-message": "can't contain a slash (/ or \\)"
4779
+ "pattern": "^[^/\\\\]*[^/\\\\ \t\n\u000b\f\r…   - 

  　][^/\\\\]*$",
4780
+ "x-pattern-message": "can't be blank or contain a slash (/ or \\)"
4710
4781
  },
4711
4782
  "reimport_fields": {
4712
4783
  "type": "boolean"
@@ -5541,6 +5612,9 @@ exports.requestSchemas = {
5541
5612
  "docx",
5542
5613
  "odt"
5543
5614
  ]
5615
+ },
5616
+ "include_office_use_fields": {
5617
+ "type": "boolean"
5544
5618
  }
5545
5619
  },
5546
5620
  "additionalProperties": false