Skip to content

Commit 3a6e6c4

Browse files
committed
Update to version 4.7.0 on 2026-11-18
- New: support for AI agents that use DocSpring. `ask_support_help` puts a question to DocSpring's AI help, which answers from the documentation (`get_support_help` gets the answer again). `send_support_feedback` tells us what got in the way, and nobody replies to it. `open_support_ticket` opens a ticket that a person on our team answers, with `list_support_tickets`, `get_support_ticket` and `reply_to_support_ticket` to follow it, and each ticket's `watch_url` says when it changes. Every API token can call them, whatever its scopes. See [Support for AI agents](https://docspring.com/docs/api-guide/support-for-ai-agents/).
1 parent 65db876 commit 3a6e6c4

96 files changed

Lines changed: 10460 additions & 3073 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
README.md
66
docs/AddTemplateFieldsRequest.md
77
docs/AiFieldNamingLanguage.md
8+
docs/AskSupportHelpRequest.md
89
docs/AuthenticationCheck.md
910
docs/BarcodeSymbology.md
1011
docs/CheckCharacter.md
@@ -94,6 +95,7 @@ docs/MoveFolderRequest.md
9495
docs/MoveTemplateRequest.md
9596
docs/NumberConditionType.md
9697
docs/NumberPart.md
98+
docs/OpenSupportTicketRequest.md
9799
docs/OutputFormat.md
98100
docs/PageFormat.md
99101
docs/PageImage.md
@@ -104,8 +106,10 @@ docs/PublishTemplateVersionRequest.md
104106
docs/RemoveTemplateFieldsRequest.md
105107
docs/RenameFolderRequest.md
106108
docs/ReorderTemplateFieldsRequest.md
109+
docs/ReplyToSupportTicketRequest.md
107110
docs/RestoreTemplateVersionRequest.md
108111
docs/SendAccountEmailActionTestEmailRequest.md
112+
docs/SendSupportFeedbackRequest.md
109113
docs/ShapeType.md
110114
docs/SignatureRequest.md
111115
docs/SignatureRequestAuthSecondFactorType.md
@@ -136,6 +140,28 @@ docs/SubmissionSourcePdf.md
136140
docs/SubmissionState.md
137141
docs/SubmissionSummary.md
138142
docs/SubmissionValidation.md
143+
docs/SupportFeedback.md
144+
docs/SupportHelp.md
145+
docs/SupportHelpSource.md
146+
docs/SupportHelpState.md
147+
docs/SupportHelpTurn.md
148+
docs/SupportHelpTurnRole.md
149+
docs/SupportMessage.md
150+
docs/SupportMessageAuthor.md
151+
docs/SupportReportAgent.md
152+
docs/SupportReportCategory.md
153+
docs/SupportReportImpact.md
154+
docs/SupportReportKind.md
155+
docs/SupportReportSource.md
156+
docs/SupportTicket.md
157+
docs/SupportTicketList.md
158+
docs/SupportTicketListStatus.md
159+
docs/SupportTicketNotifications.md
160+
docs/SupportTicketReply.md
161+
docs/SupportTicketReplyOutcome.md
162+
docs/SupportTicketResolution.md
163+
docs/SupportTicketStatus.md
164+
docs/SupportTicketWatch.md
139165
docs/Template.md
140166
docs/TemplateActor.md
141167
docs/TemplateActorType.md
@@ -208,6 +234,7 @@ docspring/exceptions.py
208234
docspring/models/__init__.py
209235
docspring/models/add_template_fields_request.py
210236
docspring/models/ai_field_naming_language.py
237+
docspring/models/ask_support_help_request.py
211238
docspring/models/authentication_check.py
212239
docspring/models/barcode_symbology.py
213240
docspring/models/check_character.py
@@ -296,6 +323,7 @@ docspring/models/move_folder_request.py
296323
docspring/models/move_template_request.py
297324
docspring/models/number_condition_type.py
298325
docspring/models/number_part.py
326+
docspring/models/open_support_ticket_request.py
299327
docspring/models/output_format.py
300328
docspring/models/page_format.py
301329
docspring/models/page_image.py
@@ -306,8 +334,10 @@ docspring/models/publish_template_version_request.py
306334
docspring/models/remove_template_fields_request.py
307335
docspring/models/rename_folder_request.py
308336
docspring/models/reorder_template_fields_request.py
337+
docspring/models/reply_to_support_ticket_request.py
309338
docspring/models/restore_template_version_request.py
310339
docspring/models/send_account_email_action_test_email_request.py
340+
docspring/models/send_support_feedback_request.py
311341
docspring/models/shape_type.py
312342
docspring/models/signature_request.py
313343
docspring/models/signature_request_auth_second_factor_type.py
@@ -338,6 +368,28 @@ docspring/models/submission_source_pdf.py
338368
docspring/models/submission_state.py
339369
docspring/models/submission_summary.py
340370
docspring/models/submission_validation.py
371+
docspring/models/support_feedback.py
372+
docspring/models/support_help.py
373+
docspring/models/support_help_source.py
374+
docspring/models/support_help_state.py
375+
docspring/models/support_help_turn.py
376+
docspring/models/support_help_turn_role.py
377+
docspring/models/support_message.py
378+
docspring/models/support_message_author.py
379+
docspring/models/support_report_agent.py
380+
docspring/models/support_report_category.py
381+
docspring/models/support_report_impact.py
382+
docspring/models/support_report_kind.py
383+
docspring/models/support_report_source.py
384+
docspring/models/support_ticket.py
385+
docspring/models/support_ticket_list.py
386+
docspring/models/support_ticket_list_status.py
387+
docspring/models/support_ticket_notifications.py
388+
docspring/models/support_ticket_reply.py
389+
docspring/models/support_ticket_reply_outcome.py
390+
docspring/models/support_ticket_resolution.py
391+
docspring/models/support_ticket_status.py
392+
docspring/models/support_ticket_watch.py
341393
docspring/models/template.py
342394
docspring/models/template_actor.py
343395
docspring/models/template_actor_type.py
@@ -411,6 +463,7 @@ test-requirements.txt
411463
test/__init__.py
412464
test/test_add_template_fields_request.py
413465
test/test_ai_field_naming_language.py
466+
test/test_ask_support_help_request.py
414467
test/test_authentication_check.py
415468
test/test_barcode_symbology.py
416469
test/test_check_character.py
@@ -500,6 +553,7 @@ test/test_move_folder_request.py
500553
test/test_move_template_request.py
501554
test/test_number_condition_type.py
502555
test/test_number_part.py
556+
test/test_open_support_ticket_request.py
503557
test/test_output_format.py
504558
test/test_page_format.py
505559
test/test_page_image.py
@@ -510,8 +564,10 @@ test/test_publish_template_version_request.py
510564
test/test_remove_template_fields_request.py
511565
test/test_rename_folder_request.py
512566
test/test_reorder_template_fields_request.py
567+
test/test_reply_to_support_ticket_request.py
513568
test/test_restore_template_version_request.py
514569
test/test_send_account_email_action_test_email_request.py
570+
test/test_send_support_feedback_request.py
515571
test/test_shape_type.py
516572
test/test_signature_request.py
517573
test/test_signature_request_auth_second_factor_type.py
@@ -542,6 +598,28 @@ test/test_submission_source_pdf.py
542598
test/test_submission_state.py
543599
test/test_submission_summary.py
544600
test/test_submission_validation.py
601+
test/test_support_feedback.py
602+
test/test_support_help.py
603+
test/test_support_help_source.py
604+
test/test_support_help_state.py
605+
test/test_support_help_turn.py
606+
test/test_support_help_turn_role.py
607+
test/test_support_message.py
608+
test/test_support_message_author.py
609+
test/test_support_report_agent.py
610+
test/test_support_report_category.py
611+
test/test_support_report_impact.py
612+
test/test_support_report_kind.py
613+
test/test_support_report_source.py
614+
test/test_support_ticket.py
615+
test/test_support_ticket_list.py
616+
test/test_support_ticket_list_status.py
617+
test/test_support_ticket_notifications.py
618+
test/test_support_ticket_reply.py
619+
test/test_support_ticket_reply_outcome.py
620+
test/test_support_ticket_resolution.py
621+
test/test_support_ticket_status.py
622+
test/test_support_ticket_watch.py
545623
test/test_template.py
546624
test/test_template_actor.py
547625
test/test_template_actor_type.py

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
### 4.7.0 [November 18, 2026]
2+
3+
- New: support for AI agents that use DocSpring. `ask_support_help` puts a question to DocSpring's AI help, which
4+
answers from the documentation (`get_support_help` gets the answer again). `send_support_feedback` tells us what got
5+
in the way, and nobody replies to it. `open_support_ticket` opens a ticket that a person on our team answers, with
6+
`list_support_tickets`, `get_support_ticket` and `reply_to_support_ticket` to follow it, and each ticket's
7+
`watch_url` says when it changes. Every API token can call them, whatever its scopes. See
8+
[Support for AI agents](https://docspring.com/docs/api-guide/support-for-ai-agents/).
9+
110
### 4.6.0 [November 17, 2026]
211

312
- New: `Field` has `comb_fill_from_right`, `comb_pad_with_zeros` and `print_digits_only`, which set how a comb

‎README.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pull requests are welcome.
1313
Outside Python code, the [DocSpring CLI](https://docspring.com/docs/cli/) calls the same API from a terminal or a
1414
shell script, and the [MCP server](https://docspring.com/docs/mcp/) connects AI assistants to your account.
1515

16-
Version 4.6.0. Requires Python >=3.10.
16+
Version 4.7.0. Requires Python >=3.10.
1717

1818
## Install and configure
1919

@@ -85,6 +85,7 @@ Python code for every method.
8585
| Method | Description |
8686
| ------ | ----------- |
8787
| [`add_template_fields`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#add_template_fields) | Add fields to a template |
88+
| [`ask_support_help`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#ask_support_help) | Ask for help |
8889
| [`copy_template`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#copy_template) | Copy a template |
8990
| [`create_account_email_action`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#create_account_email_action) | Create an account email action |
9091
| [`create_combined_pdf`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#create_combined_pdf) | Combine PDFs |
@@ -121,6 +122,8 @@ Python code for every method.
121122
| [`get_signature_request`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_signature_request) | Get a signature request |
122123
| [`get_submission`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_submission) | Get a submission |
123124
| [`get_submission_batch`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_submission_batch) | Get a batch |
125+
| [`get_support_help`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_support_help) | Get a help request |
126+
| [`get_support_ticket`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_support_ticket) | Get a support ticket |
124127
| [`get_template`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_template) | Get a template |
125128
| [`get_template_diff`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_template_diff) | Compare a version of a template with the one before it |
126129
| [`get_template_model_code`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#get_template_model_code) | Generate typed code for a template's submission data |
@@ -135,19 +138,23 @@ Python code for every method.
135138
| [`list_email_domains`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_email_domains) | List email domains |
136139
| [`list_folders`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_folders) | List folders |
137140
| [`list_submissions`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_submissions) | List submissions |
141+
| [`list_support_tickets`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_support_tickets) | List support tickets |
138142
| [`list_template_fields`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_template_fields) | List a template's fields |
139143
| [`list_template_submissions`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_template_submissions) | List a template's submissions |
140144
| [`list_templates`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_templates) | List templates |
141145
| [`list_webhooks`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#list_webhooks) | List webhooks |
142146
| [`move_folder`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#move_folder) | Move a folder |
143147
| [`move_template`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#move_template) | Move a template to a folder |
148+
| [`open_support_ticket`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#open_support_ticket) | Open a support ticket |
144149
| [`publish_template_version`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#publish_template_version) | Publish a template version |
145150
| [`remove_template_fields`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#remove_template_fields) | Remove fields from a template |
146151
| [`rename_folder`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#rename_folder) | Rename a folder |
147152
| [`reorder_template_fields`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#reorder_template_fields) | Reorder a template's fields |
153+
| [`reply_to_support_ticket`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#reply_to_support_ticket) | Reply to a support ticket |
148154
| [`restore_template_version`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#restore_template_version) | Restore a template version |
149155
| [`send_account_email_action_test_email`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#send_account_email_action_test_email) | Send a test email for an account email action |
150156
| [`send_email_action_test_email`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#send_email_action_test_email) | Send a test email |
157+
| [`send_support_feedback`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#send_support_feedback) | Send feedback |
151158
| [`test_authentication`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#test_authentication) | Test authentication |
152159
| [`update_account_email_action`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#update_account_email_action) | Update an account email action |
153160
| [`update_email_action`](https://github.com/DocSpring/docspring-python/blob/main/docs/Client.md#update_email_action) | Update an email action |

‎docs/AskSupportHelpRequest.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AskSupportHelpRequest
2+
3+
A question about DocSpring. Never include secrets, credentials or your users' data.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**question** | **str** | What you want to know, in a sentence or two. For a follow-up question, include what was asked and answered before that matters to it: each request is answered by itself. |
10+
**tool** | **str** | The API operation, MCP tool or CLI command involved, if any. | [optional]
11+
**error** | **str** | The exact error text, if any. | [optional]
12+
**conversation** | [**List[SupportHelpTurn]**](SupportHelpTurn.md) | For a chat: the questions and answers so far, oldest first, when `question` follows on from them. At most 40 turns: start a new conversation after that. | [optional]
13+
14+
## Example
15+
16+
```python
17+
from docspring.models.ask_support_help_request import AskSupportHelpRequest
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of AskSupportHelpRequest from a JSON string
22+
ask_support_help_request_instance = AskSupportHelpRequest.from_json(json)
23+
# print the JSON string representation of the object
24+
print(AskSupportHelpRequest.to_json())
25+
26+
# convert the object into a dict
27+
ask_support_help_request_dict = ask_support_help_request_instance.to_dict()
28+
# create an instance of AskSupportHelpRequest from a dict
29+
ask_support_help_request_from_dict = AskSupportHelpRequest.from_dict(ask_support_help_request_dict)
30+
```
31+
[[Back to Model list]](../README.md#methods) [[Back to API list]](../README.md#methods) [[Back to README]](../README.md)
32+
33+

0 commit comments

Comments
 (0)