docspring 4.6.0 → 4.7.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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/README.md +8 -1
  4. data/lib/docspring/api/client.rb +494 -0
  5. data/lib/docspring/api_client.rb +1 -1
  6. data/lib/docspring/models/ask_support_help_request.rb +217 -0
  7. data/lib/docspring/models/error_code.rb +4 -1
  8. data/lib/docspring/models/error_info.rb +12 -2
  9. data/lib/docspring/models/open_support_ticket_request.rb +363 -0
  10. data/lib/docspring/models/reply_to_support_ticket_request.rb +217 -0
  11. data/lib/docspring/models/send_support_feedback_request.rb +363 -0
  12. data/lib/docspring/models/support_feedback.rb +239 -0
  13. data/lib/docspring/models/support_help.rb +316 -0
  14. data/lib/docspring/models/support_help_source.rb +212 -0
  15. data/lib/docspring/models/support_help_state.rb +42 -0
  16. data/lib/docspring/models/support_help_turn.rb +234 -0
  17. data/lib/docspring/models/support_help_turn_role.rb +41 -0
  18. data/lib/docspring/models/support_message.rb +301 -0
  19. data/lib/docspring/models/support_message_author.rb +42 -0
  20. data/lib/docspring/models/support_report_agent.rb +188 -0
  21. data/lib/docspring/models/support_report_category.rb +57 -0
  22. data/lib/docspring/models/support_report_impact.rb +42 -0
  23. data/lib/docspring/models/support_report_kind.rb +47 -0
  24. data/lib/docspring/models/support_report_source.rb +41 -0
  25. data/lib/docspring/models/support_ticket.rb +637 -0
  26. data/lib/docspring/models/support_ticket_list.rb +200 -0
  27. data/lib/docspring/models/support_ticket_list_status.rb +42 -0
  28. data/lib/docspring/models/support_ticket_notifications.rb +197 -0
  29. data/lib/docspring/models/support_ticket_reply.rb +210 -0
  30. data/lib/docspring/models/support_ticket_reply_outcome.rb +41 -0
  31. data/lib/docspring/models/support_ticket_resolution.rb +45 -0
  32. data/lib/docspring/models/support_ticket_status.rb +43 -0
  33. data/lib/docspring/models/support_ticket_watch.rb +239 -0
  34. data/lib/docspring/request_schemas.json +426 -0
  35. data/lib/docspring/version.rb +1 -1
  36. data/lib/docspring.rb +26 -0
  37. metadata +27 -1
@@ -671,6 +671,70 @@
671
671
  }
672
672
  }
673
673
  },
674
+ "askSupportHelp": {
675
+ "query": {
676
+ "wait": {
677
+ "required": false,
678
+ "schema": {
679
+ "type": "boolean"
680
+ }
681
+ }
682
+ },
683
+ "body": {
684
+ "mediaType": "application/json",
685
+ "required": true,
686
+ "schema": {
687
+ "type": "object",
688
+ "required": [
689
+ "question"
690
+ ],
691
+ "properties": {
692
+ "question": {
693
+ "type": "string",
694
+ "minLength": 3,
695
+ "maxLength": 8000
696
+ },
697
+ "tool": {
698
+ "type": "string",
699
+ "minLength": 1,
700
+ "maxLength": 100
701
+ },
702
+ "error": {
703
+ "type": "string",
704
+ "minLength": 1,
705
+ "maxLength": 4000
706
+ },
707
+ "conversation": {
708
+ "type": "array",
709
+ "maxItems": 40,
710
+ "items": {
711
+ "type": "object",
712
+ "required": [
713
+ "role",
714
+ "text"
715
+ ],
716
+ "properties": {
717
+ "role": {
718
+ "type": "string",
719
+ "enum": [
720
+ "user",
721
+ "assistant"
722
+ ]
723
+ },
724
+ "text": {
725
+ "type": "string",
726
+ "minLength": 1,
727
+ "maxLength": 16000
728
+ }
729
+ },
730
+ "additionalProperties": false
731
+ }
732
+ }
733
+ },
734
+ "additionalProperties": false
735
+ }
736
+ }
737
+ },
674
738
  "copyTemplate": {
675
739
  "body": {
676
740
  "mediaType": "application/json",
@@ -2741,6 +2805,19 @@
2741
2805
  }
2742
2806
  }
2743
2807
  },
2808
+ "getSupportHelp": {},
2809
+ "getSupportTicket": {
2810
+ "query": {
2811
+ "after_message_id": {
2812
+ "required": false,
2813
+ "schema": {
2814
+ "type": "string",
2815
+ "pattern": "[^ \t\n\u000b\f\r…   - 

   ]",
2816
+ "x-pattern-message": "can't be blank"
2817
+ }
2818
+ }
2819
+ }
2820
+ },
2744
2821
  "getTemplate": {
2745
2822
  "query": {
2746
2823
  "version": {
@@ -3036,6 +3113,53 @@
3036
3113
  }
3037
3114
  }
3038
3115
  },
3116
+ "listSupportTickets": {
3117
+ "query": {
3118
+ "status": {
3119
+ "required": false,
3120
+ "schema": {
3121
+ "type": "string",
3122
+ "enum": [
3123
+ "open",
3124
+ "closed",
3125
+ "all"
3126
+ ]
3127
+ }
3128
+ },
3129
+ "session": {
3130
+ "required": false,
3131
+ "schema": {
3132
+ "type": "string",
3133
+ "maxLength": 100,
3134
+ "pattern": "[^ \t\n\u000b\f\r…   - 

   ]",
3135
+ "x-pattern-message": "can't be blank"
3136
+ }
3137
+ },
3138
+ "updated_since": {
3139
+ "required": false,
3140
+ "schema": {
3141
+ "type": "string",
3142
+ "format": "date-time"
3143
+ }
3144
+ },
3145
+ "limit": {
3146
+ "required": false,
3147
+ "schema": {
3148
+ "type": "integer",
3149
+ "minimum": 1,
3150
+ "maximum": 100
3151
+ }
3152
+ },
3153
+ "cursor": {
3154
+ "required": false,
3155
+ "schema": {
3156
+ "type": "string",
3157
+ "pattern": "[^ \t\n\u000b\f\r…   - 

   ]",
3158
+ "x-pattern-message": "can't be blank"
3159
+ }
3160
+ }
3161
+ }
3162
+ },
3039
3163
  "listTemplateFields": {
3040
3164
  "query": {
3041
3165
  "version": {
@@ -3292,6 +3416,140 @@
3292
3416
  }
3293
3417
  }
3294
3418
  },
3419
+ "openSupportTicket": {
3420
+ "body": {
3421
+ "mediaType": "application/json",
3422
+ "required": true,
3423
+ "schema": {
3424
+ "type": "object",
3425
+ "required": [
3426
+ "title",
3427
+ "kind",
3428
+ "description"
3429
+ ],
3430
+ "properties": {
3431
+ "title": {
3432
+ "type": "string",
3433
+ "minLength": 3,
3434
+ "maxLength": 200
3435
+ },
3436
+ "kind": {
3437
+ "type": "string",
3438
+ "enum": [
3439
+ "bug",
3440
+ "crash",
3441
+ "wrong_result",
3442
+ "confusing",
3443
+ "missing_feature",
3444
+ "docs",
3445
+ "question",
3446
+ "other"
3447
+ ]
3448
+ },
3449
+ "category": {
3450
+ "type": "string",
3451
+ "enum": [
3452
+ "pdf_templates",
3453
+ "html_templates",
3454
+ "word_templates",
3455
+ "page_designer",
3456
+ "template_editor",
3457
+ "submissions",
3458
+ "web_forms",
3459
+ "signature_requests",
3460
+ "api",
3461
+ "sdks",
3462
+ "cli",
3463
+ "mcp",
3464
+ "integrations",
3465
+ "webhooks",
3466
+ "billing",
3467
+ "account",
3468
+ "docs",
3469
+ "other"
3470
+ ]
3471
+ },
3472
+ "description": {
3473
+ "type": "string",
3474
+ "minLength": 1,
3475
+ "maxLength": 4000
3476
+ },
3477
+ "impact": {
3478
+ "type": "string",
3479
+ "enum": [
3480
+ "blocked",
3481
+ "worked_around",
3482
+ "friction"
3483
+ ]
3484
+ },
3485
+ "task": {
3486
+ "type": "string",
3487
+ "minLength": 1,
3488
+ "maxLength": 200
3489
+ },
3490
+ "request_ids": {
3491
+ "type": "array",
3492
+ "maxItems": 10,
3493
+ "items": {
3494
+ "type": "string",
3495
+ "maxLength": 255,
3496
+ "pattern": "[^ \t\n\u000b\f\r…   - 

   ]",
3497
+ "x-pattern-message": "can't be blank"
3498
+ }
3499
+ },
3500
+ "tool": {
3501
+ "type": "string",
3502
+ "minLength": 1,
3503
+ "maxLength": 100
3504
+ },
3505
+ "error": {
3506
+ "type": "string",
3507
+ "minLength": 1,
3508
+ "maxLength": 4000
3509
+ },
3510
+ "suggestion": {
3511
+ "type": "string",
3512
+ "minLength": 1,
3513
+ "maxLength": 2000
3514
+ },
3515
+ "source": {
3516
+ "type": "string",
3517
+ "enum": [
3518
+ "agent",
3519
+ "user"
3520
+ ]
3521
+ },
3522
+ "session": {
3523
+ "type": "string",
3524
+ "minLength": 1,
3525
+ "maxLength": 100
3526
+ },
3527
+ "agent": {
3528
+ "type": "object",
3529
+ "properties": {
3530
+ "name": {
3531
+ "type": "string",
3532
+ "minLength": 1,
3533
+ "maxLength": 100
3534
+ },
3535
+ "version": {
3536
+ "type": "string",
3537
+ "minLength": 1,
3538
+ "maxLength": 100
3539
+ },
3540
+ "model": {
3541
+ "type": "string",
3542
+ "minLength": 1,
3543
+ "maxLength": 100
3544
+ }
3545
+ },
3546
+ "additionalProperties": false
3547
+ }
3548
+ },
3549
+ "additionalProperties": false
3550
+ }
3551
+ }
3552
+ },
3295
3553
  "publishTemplateVersion": {
3296
3554
  "body": {
3297
3555
  "mediaType": "application/json",
@@ -3386,6 +3644,33 @@
3386
3644
  }
3387
3645
  }
3388
3646
  },
3647
+ "replyToSupportTicket": {
3648
+ "body": {
3649
+ "mediaType": "application/json",
3650
+ "required": true,
3651
+ "schema": {
3652
+ "type": "object",
3653
+ "required": [
3654
+ "body"
3655
+ ],
3656
+ "properties": {
3657
+ "body": {
3658
+ "type": "string",
3659
+ "minLength": 1,
3660
+ "maxLength": 4000
3661
+ },
3662
+ "outcome": {
3663
+ "type": "string",
3664
+ "enum": [
3665
+ "resolved",
3666
+ "still_broken"
3667
+ ]
3668
+ }
3669
+ },
3670
+ "additionalProperties": false
3671
+ }
3672
+ }
3673
+ },
3389
3674
  "restoreTemplateVersion": {
3390
3675
  "body": {
3391
3676
  "mediaType": "application/json",
@@ -3425,6 +3710,140 @@
3425
3710
  }
3426
3711
  },
3427
3712
  "sendEmailActionTestEmail": {},
3713
+ "sendSupportFeedback": {
3714
+ "body": {
3715
+ "mediaType": "application/json",
3716
+ "required": true,
3717
+ "schema": {
3718
+ "type": "object",
3719
+ "required": [
3720
+ "title",
3721
+ "kind",
3722
+ "description"
3723
+ ],
3724
+ "properties": {
3725
+ "title": {
3726
+ "type": "string",
3727
+ "minLength": 3,
3728
+ "maxLength": 200
3729
+ },
3730
+ "kind": {
3731
+ "type": "string",
3732
+ "enum": [
3733
+ "bug",
3734
+ "crash",
3735
+ "wrong_result",
3736
+ "confusing",
3737
+ "missing_feature",
3738
+ "docs",
3739
+ "question",
3740
+ "other"
3741
+ ]
3742
+ },
3743
+ "category": {
3744
+ "type": "string",
3745
+ "enum": [
3746
+ "pdf_templates",
3747
+ "html_templates",
3748
+ "word_templates",
3749
+ "page_designer",
3750
+ "template_editor",
3751
+ "submissions",
3752
+ "web_forms",
3753
+ "signature_requests",
3754
+ "api",
3755
+ "sdks",
3756
+ "cli",
3757
+ "mcp",
3758
+ "integrations",
3759
+ "webhooks",
3760
+ "billing",
3761
+ "account",
3762
+ "docs",
3763
+ "other"
3764
+ ]
3765
+ },
3766
+ "description": {
3767
+ "type": "string",
3768
+ "minLength": 1,
3769
+ "maxLength": 4000
3770
+ },
3771
+ "impact": {
3772
+ "type": "string",
3773
+ "enum": [
3774
+ "blocked",
3775
+ "worked_around",
3776
+ "friction"
3777
+ ]
3778
+ },
3779
+ "task": {
3780
+ "type": "string",
3781
+ "minLength": 1,
3782
+ "maxLength": 200
3783
+ },
3784
+ "request_ids": {
3785
+ "type": "array",
3786
+ "maxItems": 10,
3787
+ "items": {
3788
+ "type": "string",
3789
+ "maxLength": 255,
3790
+ "pattern": "[^ \t\n\u000b\f\r…   - 

   ]",
3791
+ "x-pattern-message": "can't be blank"
3792
+ }
3793
+ },
3794
+ "tool": {
3795
+ "type": "string",
3796
+ "minLength": 1,
3797
+ "maxLength": 100
3798
+ },
3799
+ "error": {
3800
+ "type": "string",
3801
+ "minLength": 1,
3802
+ "maxLength": 4000
3803
+ },
3804
+ "suggestion": {
3805
+ "type": "string",
3806
+ "minLength": 1,
3807
+ "maxLength": 2000
3808
+ },
3809
+ "source": {
3810
+ "type": "string",
3811
+ "enum": [
3812
+ "agent",
3813
+ "user"
3814
+ ]
3815
+ },
3816
+ "session": {
3817
+ "type": "string",
3818
+ "minLength": 1,
3819
+ "maxLength": 100
3820
+ },
3821
+ "agent": {
3822
+ "type": "object",
3823
+ "properties": {
3824
+ "name": {
3825
+ "type": "string",
3826
+ "minLength": 1,
3827
+ "maxLength": 100
3828
+ },
3829
+ "version": {
3830
+ "type": "string",
3831
+ "minLength": 1,
3832
+ "maxLength": 100
3833
+ },
3834
+ "model": {
3835
+ "type": "string",
3836
+ "minLength": 1,
3837
+ "maxLength": 100
3838
+ }
3839
+ },
3840
+ "additionalProperties": false
3841
+ }
3842
+ },
3843
+ "additionalProperties": false
3844
+ }
3845
+ }
3846
+ },
3428
3847
  "testAuthentication": {},
3429
3848
  "updateAccountEmailAction": {
3430
3849
  "body": {
@@ -6159,6 +6578,9 @@
6159
6578
  "GET /submissions": "listSubmissions",
6160
6579
  "GET /submissions/batches/{submission_batch_id}": "getSubmissionBatch",
6161
6580
  "GET /submissions/{submission_id}": "getSubmission",
6581
+ "GET /support/help/{support_help_id}": "getSupportHelp",
6582
+ "GET /support/tickets": "listSupportTickets",
6583
+ "GET /support/tickets/{ticket_id}": "getSupportTicket",
6162
6584
  "GET /templates": "listTemplates",
6163
6585
  "GET /templates/{template_id}": "getTemplate",
6164
6586
  "GET /templates/{template_id}/diff": "getTemplateDiff",
@@ -6187,6 +6609,10 @@
6187
6609
  "POST /submissions/batches": "createSubmissionBatch",
6188
6610
  "POST /submissions/{submission_id}/generate_files": "generateSubmissionFiles",
6189
6611
  "POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
6612
+ "POST /support/feedback": "sendSupportFeedback",
6613
+ "POST /support/help": "askSupportHelp",
6614
+ "POST /support/tickets": "openSupportTicket",
6615
+ "POST /support/tickets/{ticket_id}/replies": "replyToSupportTicket",
6190
6616
  "POST /templates": "createTemplate",
6191
6617
  "POST /templates/upload": "uploadTemplate",
6192
6618
  "POST /templates/{template_id}/copy": "copyTemplate",
@@ -11,5 +11,5 @@ Generator version: 7.26.0-DOCSPRING
11
11
  =end
12
12
 
13
13
  module DocSpring
14
- VERSION = '4.6.0'
14
+ VERSION = '4.7.0'
15
15
  end
data/lib/docspring.rb CHANGED
@@ -22,6 +22,7 @@ require 'docspring/configuration'
22
22
  # Models
23
23
  require 'docspring/models/add_template_fields_request'
24
24
  require 'docspring/models/ai_field_naming_language'
25
+ require 'docspring/models/ask_support_help_request'
25
26
  require 'docspring/models/authentication_check'
26
27
  require 'docspring/models/barcode_symbology'
27
28
  require 'docspring/models/check_character'
@@ -110,6 +111,7 @@ require 'docspring/models/move_folder_request'
110
111
  require 'docspring/models/move_template_request'
111
112
  require 'docspring/models/number_condition_type'
112
113
  require 'docspring/models/number_part'
114
+ require 'docspring/models/open_support_ticket_request'
113
115
  require 'docspring/models/output_format'
114
116
  require 'docspring/models/page_format'
115
117
  require 'docspring/models/page_image'
@@ -120,8 +122,10 @@ require 'docspring/models/publish_template_version_request'
120
122
  require 'docspring/models/remove_template_fields_request'
121
123
  require 'docspring/models/rename_folder_request'
122
124
  require 'docspring/models/reorder_template_fields_request'
125
+ require 'docspring/models/reply_to_support_ticket_request'
123
126
  require 'docspring/models/restore_template_version_request'
124
127
  require 'docspring/models/send_account_email_action_test_email_request'
128
+ require 'docspring/models/send_support_feedback_request'
125
129
  require 'docspring/models/shape_type'
126
130
  require 'docspring/models/signature_request'
127
131
  require 'docspring/models/signature_request_auth_second_factor_type'
@@ -152,6 +156,28 @@ require 'docspring/models/submission_source_pdf'
152
156
  require 'docspring/models/submission_state'
153
157
  require 'docspring/models/submission_summary'
154
158
  require 'docspring/models/submission_validation'
159
+ require 'docspring/models/support_feedback'
160
+ require 'docspring/models/support_help'
161
+ require 'docspring/models/support_help_source'
162
+ require 'docspring/models/support_help_state'
163
+ require 'docspring/models/support_help_turn'
164
+ require 'docspring/models/support_help_turn_role'
165
+ require 'docspring/models/support_message'
166
+ require 'docspring/models/support_message_author'
167
+ require 'docspring/models/support_report_agent'
168
+ require 'docspring/models/support_report_category'
169
+ require 'docspring/models/support_report_impact'
170
+ require 'docspring/models/support_report_kind'
171
+ require 'docspring/models/support_report_source'
172
+ require 'docspring/models/support_ticket'
173
+ require 'docspring/models/support_ticket_list'
174
+ require 'docspring/models/support_ticket_list_status'
175
+ require 'docspring/models/support_ticket_notifications'
176
+ require 'docspring/models/support_ticket_reply'
177
+ require 'docspring/models/support_ticket_reply_outcome'
178
+ require 'docspring/models/support_ticket_resolution'
179
+ require 'docspring/models/support_ticket_status'
180
+ require 'docspring/models/support_ticket_watch'
155
181
  require 'docspring/models/template'
156
182
  require 'docspring/models/template_actor'
157
183
  require 'docspring/models/template_actor_type'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docspring
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.6.0
4
+ version: 4.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocSpring
@@ -85,6 +85,7 @@ files:
85
85
  - lib/docspring/ethon_multipart_put_fix.rb
86
86
  - lib/docspring/models/add_template_fields_request.rb
87
87
  - lib/docspring/models/ai_field_naming_language.rb
88
+ - lib/docspring/models/ask_support_help_request.rb
88
89
  - lib/docspring/models/authentication_check.rb
89
90
  - lib/docspring/models/barcode_symbology.rb
90
91
  - lib/docspring/models/check_character.rb
@@ -173,6 +174,7 @@ files:
173
174
  - lib/docspring/models/move_template_request.rb
174
175
  - lib/docspring/models/number_condition_type.rb
175
176
  - lib/docspring/models/number_part.rb
177
+ - lib/docspring/models/open_support_ticket_request.rb
176
178
  - lib/docspring/models/output_format.rb
177
179
  - lib/docspring/models/page_format.rb
178
180
  - lib/docspring/models/page_image.rb
@@ -183,8 +185,10 @@ files:
183
185
  - lib/docspring/models/remove_template_fields_request.rb
184
186
  - lib/docspring/models/rename_folder_request.rb
185
187
  - lib/docspring/models/reorder_template_fields_request.rb
188
+ - lib/docspring/models/reply_to_support_ticket_request.rb
186
189
  - lib/docspring/models/restore_template_version_request.rb
187
190
  - lib/docspring/models/send_account_email_action_test_email_request.rb
191
+ - lib/docspring/models/send_support_feedback_request.rb
188
192
  - lib/docspring/models/shape_type.rb
189
193
  - lib/docspring/models/signature_request.rb
190
194
  - lib/docspring/models/signature_request_auth_second_factor_type.rb
@@ -215,6 +219,28 @@ files:
215
219
  - lib/docspring/models/submission_state.rb
216
220
  - lib/docspring/models/submission_summary.rb
217
221
  - lib/docspring/models/submission_validation.rb
222
+ - lib/docspring/models/support_feedback.rb
223
+ - lib/docspring/models/support_help.rb
224
+ - lib/docspring/models/support_help_source.rb
225
+ - lib/docspring/models/support_help_state.rb
226
+ - lib/docspring/models/support_help_turn.rb
227
+ - lib/docspring/models/support_help_turn_role.rb
228
+ - lib/docspring/models/support_message.rb
229
+ - lib/docspring/models/support_message_author.rb
230
+ - lib/docspring/models/support_report_agent.rb
231
+ - lib/docspring/models/support_report_category.rb
232
+ - lib/docspring/models/support_report_impact.rb
233
+ - lib/docspring/models/support_report_kind.rb
234
+ - lib/docspring/models/support_report_source.rb
235
+ - lib/docspring/models/support_ticket.rb
236
+ - lib/docspring/models/support_ticket_list.rb
237
+ - lib/docspring/models/support_ticket_list_status.rb
238
+ - lib/docspring/models/support_ticket_notifications.rb
239
+ - lib/docspring/models/support_ticket_reply.rb
240
+ - lib/docspring/models/support_ticket_reply_outcome.rb
241
+ - lib/docspring/models/support_ticket_resolution.rb
242
+ - lib/docspring/models/support_ticket_status.rb
243
+ - lib/docspring/models/support_ticket_watch.rb
218
244
  - lib/docspring/models/template.rb
219
245
  - lib/docspring/models/template_actor.rb
220
246
  - lib/docspring/models/template_actor_type.rb