samplehc 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

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 (89) hide show
  1. samplehc/_base_client.py +8 -2
  2. samplehc/_client.py +105 -29
  3. samplehc/_models.py +37 -15
  4. samplehc/_streaming.py +12 -12
  5. samplehc/_types.py +3 -2
  6. samplehc/_utils/_sync.py +3 -31
  7. samplehc/_utils/_utils.py +1 -1
  8. samplehc/_version.py +1 -1
  9. samplehc/resources/v2/__init__.py +0 -28
  10. samplehc/resources/v2/documents/documents.py +8 -0
  11. samplehc/resources/v2/tasks/tasks.py +12 -3
  12. samplehc/resources/v2/v2.py +0 -64
  13. samplehc/types/v1_query_audit_logs_response.py +4 -0
  14. samplehc/types/v2/__init__.py +0 -2
  15. samplehc/types/v2/clearinghouse/claim_submit_response.py +5 -0
  16. samplehc/types/v2/clearinghouse/payer_list_response.py +2 -0
  17. samplehc/types/v2/clearinghouse/payer_search_response.py +2 -0
  18. samplehc/types/v2/clearinghouse_check_eligibility_response.py +4 -0
  19. samplehc/types/v2/clearinghouse_run_discovery_response.py +2 -0
  20. samplehc/types/v2/communication_send_fax_params.py +2 -0
  21. samplehc/types/v2/communication_send_fax_response.py +2 -0
  22. samplehc/types/v2/communication_send_letter_params.py +8 -0
  23. samplehc/types/v2/communication_send_letter_response.py +2 -0
  24. samplehc/types/v2/database_execute_sql_response.py +2 -0
  25. samplehc/types/v2/document_classify_params.py +2 -0
  26. samplehc/types/v2/document_classify_response.py +2 -0
  27. samplehc/types/v2/document_combine_response.py +4 -0
  28. samplehc/types/v2/document_create_from_splits_params.py +2 -0
  29. samplehc/types/v2/document_create_from_splits_response.py +2 -0
  30. samplehc/types/v2/document_extract_params.py +40 -3
  31. samplehc/types/v2/document_extract_response.py +2 -0
  32. samplehc/types/v2/document_generate_csv_response.py +4 -0
  33. samplehc/types/v2/document_presigned_upload_url_response.py +2 -0
  34. samplehc/types/v2/document_retrieve_csv_content_response.py +2 -0
  35. samplehc/types/v2/document_retrieve_metadata_response.py +2 -0
  36. samplehc/types/v2/document_search_response.py +2 -0
  37. samplehc/types/v2/document_split_params.py +2 -0
  38. samplehc/types/v2/document_split_response.py +2 -0
  39. samplehc/types/v2/documents/format_create_pdf_response.py +2 -0
  40. samplehc/types/v2/documents/legacy_extract_response.py +2 -0
  41. samplehc/types/v2/documents/legacy_reason_response.py +2 -0
  42. samplehc/types/v2/documents/legacy_split_params.py +2 -0
  43. samplehc/types/v2/documents/legacy_split_response.py +2 -0
  44. samplehc/types/v2/documents/pdf_template_retrieve_metadata_response.py +2 -0
  45. samplehc/types/v2/documents/template_render_document_response.py +2 -0
  46. samplehc/types/v2/hie/document_upload_params.py +2 -0
  47. samplehc/types/v2/integrations/glidian/prior_authorization_create_draft_response.py +2 -0
  48. samplehc/types/v2/integrations/glidian/prior_authorization_retrieve_record_response.py +2 -0
  49. samplehc/types/v2/integrations/glidian/prior_authorization_submit_response.py +2 -0
  50. samplehc/types/v2/integrations/glidian/prior_authorization_update_record_response.py +2 -0
  51. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_list_response.py +2 -0
  52. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_update_response.py +2 -0
  53. samplehc/types/v2/integrations/kno2/message_get_attachment_response.py +2 -0
  54. samplehc/types/v2/integrations/kno2/message_retrieve_response.py +2 -0
  55. samplehc/types/v2/policy_list_companies_response.py +2 -0
  56. samplehc/types/v2/policy_list_plans_response.py +2 -0
  57. samplehc/types/v2/policy_list_response.py +2 -0
  58. samplehc/types/v2/policy_retrieve_presigned_url_response.py +2 -0
  59. samplehc/types/v2/policy_retrieve_text_response.py +2 -0
  60. samplehc/types/v2/task_cancel_response.py +2 -0
  61. samplehc/types/v2/task_complete_response.py +2 -0
  62. samplehc/types/v2/task_update_column_params.py +6 -3
  63. samplehc/types/v2/workflow_run_resume_when_complete_response.py +2 -0
  64. samplehc/types/v2/workflow_run_retrieve_response.py +2 -0
  65. samplehc/types/v2/workflow_runs/step_get_output_response.py +2 -0
  66. samplehc/types/v2/workflow_start_response.py +2 -0
  67. {samplehc-0.14.0.dist-info → samplehc-0.15.0.dist-info}/METADATA +7 -6
  68. {samplehc-0.14.0.dist-info → samplehc-0.15.0.dist-info}/RECORD +70 -89
  69. {samplehc-0.14.0.dist-info → samplehc-0.15.0.dist-info}/licenses/LICENSE +1 -1
  70. samplehc/resources/v2/browser_agents/__init__.py +0 -33
  71. samplehc/resources/v2/browser_agents/browser_agents.py +0 -209
  72. samplehc/resources/v2/browser_agents/runs/__init__.py +0 -33
  73. samplehc/resources/v2/browser_agents/runs/help_requests.py +0 -191
  74. samplehc/resources/v2/browser_agents/runs/runs.py +0 -233
  75. samplehc/resources/v2/browser_automation/__init__.py +0 -33
  76. samplehc/resources/v2/browser_automation/availity.py +0 -249
  77. samplehc/resources/v2/browser_automation/browser_automation.py +0 -102
  78. samplehc/types/v2/browser_agent_invoke_params.py +0 -13
  79. samplehc/types/v2/browser_agent_invoke_response.py +0 -15
  80. samplehc/types/v2/browser_agents/__init__.py +0 -6
  81. samplehc/types/v2/browser_agents/run_list_events_params.py +0 -15
  82. samplehc/types/v2/browser_agents/run_list_events_response.py +0 -30
  83. samplehc/types/v2/browser_agents/runs/__init__.py +0 -6
  84. samplehc/types/v2/browser_agents/runs/help_request_resolve_params.py +0 -18
  85. samplehc/types/v2/browser_agents/runs/help_request_resolve_response.py +0 -28
  86. samplehc/types/v2/browser_automation/__init__.py +0 -6
  87. samplehc/types/v2/browser_automation/availity_submit_appeal_params.py +0 -59
  88. samplehc/types/v2/browser_automation/availity_submit_appeal_response.py +0 -12
  89. {samplehc-0.14.0.dist-info → samplehc-0.15.0.dist-info}/WHEEL +0 -0
@@ -108,22 +108,6 @@ from .workflow_runs.workflow_runs import (
108
108
  WorkflowRunsResourceWithStreamingResponse,
109
109
  AsyncWorkflowRunsResourceWithStreamingResponse,
110
110
  )
111
- from .browser_agents.browser_agents import (
112
- BrowserAgentsResource,
113
- AsyncBrowserAgentsResource,
114
- BrowserAgentsResourceWithRawResponse,
115
- AsyncBrowserAgentsResourceWithRawResponse,
116
- BrowserAgentsResourceWithStreamingResponse,
117
- AsyncBrowserAgentsResourceWithStreamingResponse,
118
- )
119
- from .browser_automation.browser_automation import (
120
- BrowserAutomationResource,
121
- AsyncBrowserAutomationResource,
122
- BrowserAutomationResourceWithRawResponse,
123
- AsyncBrowserAutomationResourceWithRawResponse,
124
- BrowserAutomationResourceWithStreamingResponse,
125
- AsyncBrowserAutomationResourceWithStreamingResponse,
126
- )
127
111
 
128
112
  __all__ = ["V2Resource", "AsyncV2Resource"]
129
113
 
@@ -169,10 +153,6 @@ class V2Resource(SyncAPIResource):
169
153
  def events(self) -> EventsResource:
170
154
  return EventsResource(self._client)
171
155
 
172
- @cached_property
173
- def browser_agents(self) -> BrowserAgentsResource:
174
- return BrowserAgentsResource(self._client)
175
-
176
156
  @cached_property
177
157
  def policies(self) -> PoliciesResource:
178
158
  return PoliciesResource(self._client)
@@ -185,10 +165,6 @@ class V2Resource(SyncAPIResource):
185
165
  def database(self) -> DatabaseResource:
186
166
  return DatabaseResource(self._client)
187
167
 
188
- @cached_property
189
- def browser_automation(self) -> BrowserAutomationResource:
190
- return BrowserAutomationResource(self._client)
191
-
192
168
  @cached_property
193
169
  def with_raw_response(self) -> V2ResourceWithRawResponse:
194
170
  """
@@ -250,10 +226,6 @@ class AsyncV2Resource(AsyncAPIResource):
250
226
  def events(self) -> AsyncEventsResource:
251
227
  return AsyncEventsResource(self._client)
252
228
 
253
- @cached_property
254
- def browser_agents(self) -> AsyncBrowserAgentsResource:
255
- return AsyncBrowserAgentsResource(self._client)
256
-
257
229
  @cached_property
258
230
  def policies(self) -> AsyncPoliciesResource:
259
231
  return AsyncPoliciesResource(self._client)
@@ -266,10 +238,6 @@ class AsyncV2Resource(AsyncAPIResource):
266
238
  def database(self) -> AsyncDatabaseResource:
267
239
  return AsyncDatabaseResource(self._client)
268
240
 
269
- @cached_property
270
- def browser_automation(self) -> AsyncBrowserAutomationResource:
271
- return AsyncBrowserAutomationResource(self._client)
272
-
273
241
  @cached_property
274
242
  def with_raw_response(self) -> AsyncV2ResourceWithRawResponse:
275
243
  """
@@ -334,10 +302,6 @@ class V2ResourceWithRawResponse:
334
302
  def events(self) -> EventsResourceWithRawResponse:
335
303
  return EventsResourceWithRawResponse(self._v2.events)
336
304
 
337
- @cached_property
338
- def browser_agents(self) -> BrowserAgentsResourceWithRawResponse:
339
- return BrowserAgentsResourceWithRawResponse(self._v2.browser_agents)
340
-
341
305
  @cached_property
342
306
  def policies(self) -> PoliciesResourceWithRawResponse:
343
307
  return PoliciesResourceWithRawResponse(self._v2.policies)
@@ -350,10 +314,6 @@ class V2ResourceWithRawResponse:
350
314
  def database(self) -> DatabaseResourceWithRawResponse:
351
315
  return DatabaseResourceWithRawResponse(self._v2.database)
352
316
 
353
- @cached_property
354
- def browser_automation(self) -> BrowserAutomationResourceWithRawResponse:
355
- return BrowserAutomationResourceWithRawResponse(self._v2.browser_automation)
356
-
357
317
 
358
318
  class AsyncV2ResourceWithRawResponse:
359
319
  def __init__(self, v2: AsyncV2Resource) -> None:
@@ -399,10 +359,6 @@ class AsyncV2ResourceWithRawResponse:
399
359
  def events(self) -> AsyncEventsResourceWithRawResponse:
400
360
  return AsyncEventsResourceWithRawResponse(self._v2.events)
401
361
 
402
- @cached_property
403
- def browser_agents(self) -> AsyncBrowserAgentsResourceWithRawResponse:
404
- return AsyncBrowserAgentsResourceWithRawResponse(self._v2.browser_agents)
405
-
406
362
  @cached_property
407
363
  def policies(self) -> AsyncPoliciesResourceWithRawResponse:
408
364
  return AsyncPoliciesResourceWithRawResponse(self._v2.policies)
@@ -415,10 +371,6 @@ class AsyncV2ResourceWithRawResponse:
415
371
  def database(self) -> AsyncDatabaseResourceWithRawResponse:
416
372
  return AsyncDatabaseResourceWithRawResponse(self._v2.database)
417
373
 
418
- @cached_property
419
- def browser_automation(self) -> AsyncBrowserAutomationResourceWithRawResponse:
420
- return AsyncBrowserAutomationResourceWithRawResponse(self._v2.browser_automation)
421
-
422
374
 
423
375
  class V2ResourceWithStreamingResponse:
424
376
  def __init__(self, v2: V2Resource) -> None:
@@ -464,10 +416,6 @@ class V2ResourceWithStreamingResponse:
464
416
  def events(self) -> EventsResourceWithStreamingResponse:
465
417
  return EventsResourceWithStreamingResponse(self._v2.events)
466
418
 
467
- @cached_property
468
- def browser_agents(self) -> BrowserAgentsResourceWithStreamingResponse:
469
- return BrowserAgentsResourceWithStreamingResponse(self._v2.browser_agents)
470
-
471
419
  @cached_property
472
420
  def policies(self) -> PoliciesResourceWithStreamingResponse:
473
421
  return PoliciesResourceWithStreamingResponse(self._v2.policies)
@@ -480,10 +428,6 @@ class V2ResourceWithStreamingResponse:
480
428
  def database(self) -> DatabaseResourceWithStreamingResponse:
481
429
  return DatabaseResourceWithStreamingResponse(self._v2.database)
482
430
 
483
- @cached_property
484
- def browser_automation(self) -> BrowserAutomationResourceWithStreamingResponse:
485
- return BrowserAutomationResourceWithStreamingResponse(self._v2.browser_automation)
486
-
487
431
 
488
432
  class AsyncV2ResourceWithStreamingResponse:
489
433
  def __init__(self, v2: AsyncV2Resource) -> None:
@@ -529,10 +473,6 @@ class AsyncV2ResourceWithStreamingResponse:
529
473
  def events(self) -> AsyncEventsResourceWithStreamingResponse:
530
474
  return AsyncEventsResourceWithStreamingResponse(self._v2.events)
531
475
 
532
- @cached_property
533
- def browser_agents(self) -> AsyncBrowserAgentsResourceWithStreamingResponse:
534
- return AsyncBrowserAgentsResourceWithStreamingResponse(self._v2.browser_agents)
535
-
536
476
  @cached_property
537
477
  def policies(self) -> AsyncPoliciesResourceWithStreamingResponse:
538
478
  return AsyncPoliciesResourceWithStreamingResponse(self._v2.policies)
@@ -544,7 +484,3 @@ class AsyncV2ResourceWithStreamingResponse:
544
484
  @cached_property
545
485
  def database(self) -> AsyncDatabaseResourceWithStreamingResponse:
546
486
  return AsyncDatabaseResourceWithStreamingResponse(self._v2.database)
547
-
548
- @cached_property
549
- def browser_automation(self) -> AsyncBrowserAutomationResourceWithStreamingResponse:
550
- return AsyncBrowserAutomationResourceWithStreamingResponse(self._v2.browser_automation)
@@ -8,5 +8,9 @@ __all__ = ["V1QueryAuditLogsResponse"]
8
8
 
9
9
 
10
10
  class V1QueryAuditLogsResponse(BaseModel):
11
+ """
12
+ A successful response containing a list of audit log entries that match the provided query.
13
+ """
14
+
11
15
  data: List[Dict[str, object]]
12
16
  """An array of audit log records matching the query."""
@@ -33,12 +33,10 @@ from .document_classify_response import DocumentClassifyResponse as DocumentClas
33
33
  from .document_retrieve_response import DocumentRetrieveResponse as DocumentRetrieveResponse
34
34
  from .policy_list_plans_response import PolicyListPlansResponse as PolicyListPlansResponse
35
35
  from .async_result_sleep_response import AsyncResultSleepResponse as AsyncResultSleepResponse
36
- from .browser_agent_invoke_params import BrowserAgentInvokeParams as BrowserAgentInvokeParams
37
36
  from .database_execute_sql_params import DatabaseExecuteSqlParams as DatabaseExecuteSqlParams
38
37
  from .task_update_column_response import TaskUpdateColumnResponse as TaskUpdateColumnResponse
39
38
  from .document_generate_csv_params import DocumentGenerateCsvParams as DocumentGenerateCsvParams
40
39
  from .policy_list_companies_params import PolicyListCompaniesParams as PolicyListCompaniesParams
41
- from .browser_agent_invoke_response import BrowserAgentInvokeResponse as BrowserAgentInvokeResponse
42
40
  from .communication_send_fax_params import CommunicationSendFaxParams as CommunicationSendFaxParams
43
41
  from .database_execute_sql_response import DatabaseExecuteSqlResponse as DatabaseExecuteSqlResponse
44
42
  from .document_unzip_async_response import DocumentUnzipAsyncResponse as DocumentUnzipAsyncResponse
@@ -8,6 +8,11 @@ __all__ = ["ClaimSubmitResponse"]
8
8
 
9
9
 
10
10
  class ClaimSubmitResponse(BaseModel):
11
+ """Claim submission initiated successfully.
12
+
13
+ Returns an ID to track the claim submission.
14
+ """
15
+
11
16
  claim_submission_id: str = FieldInfo(alias="claimSubmissionId")
12
17
  """Sample's internal ID of the claim submission."""
13
18
 
@@ -22,4 +22,6 @@ class Payer(BaseModel):
22
22
 
23
23
 
24
24
  class PayerListResponse(BaseModel):
25
+ """Successfully retrieved the list of payers."""
26
+
25
27
  payers: List[Payer]
@@ -28,4 +28,6 @@ class Payer(BaseModel):
28
28
 
29
29
 
30
30
  class PayerSearchResponse(BaseModel):
31
+ """Successfully retrieved the list of payers."""
32
+
31
33
  payers: List[Payer]
@@ -8,4 +8,8 @@ __all__ = ["ClearinghouseCheckEligibilityResponse"]
8
8
 
9
9
 
10
10
  class ClearinghouseCheckEligibilityResponse(BaseModel):
11
+ """
12
+ Successfully checked eligibility, returns the eligibility details from the payer.
13
+ """
14
+
11
15
  eligibility: Optional[object] = None
@@ -8,4 +8,6 @@ __all__ = ["ClearinghouseRunDiscoveryResponse"]
8
8
 
9
9
 
10
10
  class ClearinghouseRunDiscoveryResponse(BaseModel):
11
+ """Discovery process completed successfully."""
12
+
11
13
  result: Optional[object] = None
@@ -39,6 +39,8 @@ class CommunicationSendFaxParams(TypedDict, total=False):
39
39
 
40
40
 
41
41
  class Document(TypedDict, total=False):
42
+ """The document to be sent via fax"""
43
+
42
44
  id: Required[str]
43
45
 
44
46
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
@@ -8,5 +8,7 @@ __all__ = ["CommunicationSendFaxResponse"]
8
8
 
9
9
 
10
10
  class CommunicationSendFaxResponse(BaseModel):
11
+ """Accepted. Fax sending process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous fax sending task."""
@@ -34,12 +34,16 @@ class CommunicationSendLetterParams(TypedDict, total=False):
34
34
 
35
35
 
36
36
  class Document(TypedDict, total=False):
37
+ """The document to send"""
38
+
37
39
  id: Required[str]
38
40
 
39
41
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
40
42
 
41
43
 
42
44
  class ToAddressAddress(TypedDict, total=False):
45
+ """Recipient's mailing address"""
46
+
43
47
  city: Required[str]
44
48
 
45
49
  state: Required[str]
@@ -58,6 +62,8 @@ class ToAddress(TypedDict, total=False):
58
62
 
59
63
 
60
64
  class FromAddressAddress(TypedDict, total=False):
65
+ """Sender's mailing address"""
66
+
61
67
  city: Required[str]
62
68
 
63
69
  state: Required[str]
@@ -68,6 +74,8 @@ class FromAddressAddress(TypedDict, total=False):
68
74
 
69
75
 
70
76
  class FromAddress(TypedDict, total=False):
77
+ """Optional sender address (defaults to Sample Healthcare)"""
78
+
71
79
  address: Required[FromAddressAddress]
72
80
  """Sender's mailing address"""
73
81
 
@@ -8,5 +8,7 @@ __all__ = ["CommunicationSendLetterResponse"]
8
8
 
9
9
 
10
10
  class CommunicationSendLetterResponse(BaseModel):
11
+ """Letter sent successfully"""
12
+
11
13
  tracking_id: str = FieldInfo(alias="trackingId")
12
14
  """The letter ID for tracking the mail delivery"""
@@ -8,6 +8,8 @@ __all__ = ["DatabaseExecuteSqlResponse"]
8
8
 
9
9
 
10
10
  class DatabaseExecuteSqlResponse(BaseModel):
11
+ """The result of the SQL query execution."""
12
+
11
13
  rows: Union[List[Dict[str, object]], List[List[object]]]
12
14
  """An array of results from the query.
13
15
 
@@ -20,6 +20,8 @@ class DocumentClassifyParams(TypedDict, total=False):
20
20
 
21
21
 
22
22
  class Document(TypedDict, total=False):
23
+ """The document to be classified."""
24
+
23
25
  id: Required[str]
24
26
 
25
27
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
@@ -8,5 +8,7 @@ __all__ = ["DocumentClassifyResponse"]
8
8
 
9
9
 
10
10
  class DocumentClassifyResponse(BaseModel):
11
+ """Accepted. Document classification process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous classification task."""
@@ -8,11 +8,15 @@ __all__ = ["DocumentCombineResponse", "Document"]
8
8
 
9
9
 
10
10
  class Document(BaseModel):
11
+ """Metadata of the newly created combined PDF document."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
14
16
 
15
17
 
16
18
  class DocumentCombineResponse(BaseModel):
19
+ """Successfully combined documents into a single PDF."""
20
+
17
21
  document: Document
18
22
  """Metadata of the newly created combined PDF document."""
@@ -22,6 +22,8 @@ class DocumentCreateFromSplitsParams(TypedDict, total=False):
22
22
 
23
23
 
24
24
  class Document(TypedDict, total=False):
25
+ """The source document from which to create new documents based on splits."""
26
+
25
27
  id: Required[str]
26
28
 
27
29
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
@@ -22,5 +22,7 @@ class CreatedDocument(BaseModel):
22
22
 
23
23
 
24
24
  class DocumentCreateFromSplitsResponse(BaseModel):
25
+ """Successfully created new documents from splits."""
26
+
25
27
  created_documents: List[CreatedDocument] = FieldInfo(alias="createdDocuments")
26
28
  """An array of newly created document resources from the splits."""
@@ -2,12 +2,19 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- from typing import Dict, Iterable
6
- from typing_extensions import Literal, Required, Annotated, TypedDict
5
+ from typing import Dict, Union, Iterable
6
+ from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
7
7
 
8
8
  from ..._utils import PropertyInfo
9
9
 
10
- __all__ = ["DocumentExtractParams", "Document"]
10
+ __all__ = [
11
+ "DocumentExtractParams",
12
+ "Document",
13
+ "OcrEnhance",
14
+ "OcrEnhanceAgentic",
15
+ "OcrEnhanceAgenticUnionMember0",
16
+ "OcrEnhanceAgenticUnionMember1",
17
+ ]
11
18
 
12
19
 
13
20
  class DocumentExtractParams(TypedDict, total=False):
@@ -23,6 +30,9 @@ class DocumentExtractParams(TypedDict, total=False):
23
30
  model: Literal["reasoning-3-mini", "reasoning-3", "base-5", "base-5-mini", "base-5-nano"]
24
31
  """The model to use for extraction."""
25
32
 
33
+ ocr_enhance: Annotated[OcrEnhance, PropertyInfo(alias="ocrEnhance")]
34
+ """OCR enhancement configuration for figure and text analysis."""
35
+
26
36
  priority: Literal["interactive", "non-interactive"]
27
37
  """The priority of the extraction task. Non-interactive is lower priority."""
28
38
 
@@ -34,3 +44,30 @@ class Document(TypedDict, total=False):
34
44
  id: Required[str]
35
45
 
36
46
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
47
+
48
+
49
+ class OcrEnhanceAgenticUnionMember0(TypedDict, total=False):
50
+ prompt: Required[str]
51
+ """Prompt for figure analysis."""
52
+
53
+ scope: Required[Literal["figure"]]
54
+
55
+
56
+ class OcrEnhanceAgenticUnionMember1(TypedDict, total=False):
57
+ scope: Required[Literal["text"]]
58
+
59
+ prompt: str
60
+ """Optional prompt for text analysis."""
61
+
62
+
63
+ OcrEnhanceAgentic: TypeAlias = Union[OcrEnhanceAgenticUnionMember0, OcrEnhanceAgenticUnionMember1]
64
+
65
+
66
+ class OcrEnhance(TypedDict, total=False):
67
+ """OCR enhancement configuration for figure and text analysis."""
68
+
69
+ agentic: Required[Iterable[OcrEnhanceAgentic]]
70
+ """Agentic enhancement configuration."""
71
+
72
+ summarize_figures: Required[Annotated[bool, PropertyInfo(alias="summarizeFigures")]]
73
+ """Whether to summarize figures during OCR."""
@@ -8,5 +8,7 @@ __all__ = ["DocumentExtractResponse"]
8
8
 
9
9
 
10
10
  class DocumentExtractResponse(BaseModel):
11
+ """Accepted. Advanced extraction process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous extraction task."""
@@ -8,11 +8,15 @@ __all__ = ["DocumentGenerateCsvResponse", "Document"]
8
8
 
9
9
 
10
10
  class Document(BaseModel):
11
+ """Metadata of the newly generated CSV document."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
14
16
 
15
17
 
16
18
  class DocumentGenerateCsvResponse(BaseModel):
19
+ """CSV document generated successfully."""
20
+
17
21
  document: Document
18
22
  """Metadata of the newly generated CSV document."""
@@ -8,6 +8,8 @@ __all__ = ["DocumentPresignedUploadURLResponse"]
8
8
 
9
9
 
10
10
  class DocumentPresignedUploadURLResponse(BaseModel):
11
+ """Successfully generated presigned URL and initial document metadata."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
@@ -8,5 +8,7 @@ __all__ = ["DocumentRetrieveCsvContentResponse"]
8
8
 
9
9
 
10
10
  class DocumentRetrieveCsvContentResponse(BaseModel):
11
+ """Successfully retrieved CSV content."""
12
+
11
13
  data: List[Dict[str, str]]
12
14
  """An array of objects, where each object represents a row from the CSV."""
@@ -8,6 +8,8 @@ __all__ = ["DocumentRetrieveMetadataResponse"]
8
8
 
9
9
 
10
10
  class DocumentRetrieveMetadataResponse(BaseModel):
11
+ """Successfully retrieved document metadata."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
@@ -8,5 +8,7 @@ __all__ = ["DocumentSearchResponse"]
8
8
 
9
9
 
10
10
  class DocumentSearchResponse(BaseModel):
11
+ """Successfully retrieved search results."""
12
+
11
13
  results: List[object]
12
14
  """An array of search results. The structure of each result may vary."""
@@ -22,6 +22,8 @@ class DocumentSplitParams(TypedDict, total=False):
22
22
 
23
23
 
24
24
  class Document(TypedDict, total=False):
25
+ """The document to be split."""
26
+
25
27
  id: Required[str]
26
28
 
27
29
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
@@ -8,5 +8,7 @@ __all__ = ["DocumentSplitResponse"]
8
8
 
9
9
 
10
10
  class DocumentSplitResponse(BaseModel):
11
+ """Accepted. Document splitting process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous splitting task."""
@@ -8,6 +8,8 @@ __all__ = ["FormatCreatePdfResponse"]
8
8
 
9
9
 
10
10
  class FormatCreatePdfResponse(BaseModel):
11
+ """Successfully converted the document to PDF."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
@@ -8,5 +8,7 @@ __all__ = ["LegacyExtractResponse"]
8
8
 
9
9
 
10
10
  class LegacyExtractResponse(BaseModel):
11
+ """Accepted. Legacy extraction process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous legacy extraction task."""
@@ -8,5 +8,7 @@ __all__ = ["LegacyReasonResponse"]
8
8
 
9
9
 
10
10
  class LegacyReasonResponse(BaseModel):
11
+ """Accepted. Legacy reasoning process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous reasoning task."""
@@ -15,6 +15,8 @@ class LegacySplitParams(TypedDict, total=False):
15
15
 
16
16
 
17
17
  class Document(TypedDict, total=False):
18
+ """The document to be split."""
19
+
18
20
  id: Required[str]
19
21
 
20
22
  file_name: Required[Annotated[str, PropertyInfo(alias="fileName")]]
@@ -8,5 +8,7 @@ __all__ = ["LegacySplitResponse"]
8
8
 
9
9
 
10
10
  class LegacySplitResponse(BaseModel):
11
+ """Accepted. Document splitting process initiated."""
12
+
11
13
  async_result_id: str = FieldInfo(alias="asyncResultId")
12
14
  """The ID to track the asynchronous splitting task."""
@@ -8,6 +8,8 @@ __all__ = ["PdfTemplateRetrieveMetadataResponse"]
8
8
 
9
9
 
10
10
  class PdfTemplateRetrieveMetadataResponse(BaseModel):
11
+ """Successfully retrieved PDF template document metadata."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
@@ -8,5 +8,7 @@ __all__ = ["TemplateRenderDocumentResponse"]
8
8
 
9
9
 
10
10
  class TemplateRenderDocumentResponse(BaseModel):
11
+ """Successfully rendered document body."""
12
+
11
13
  body: Optional[object] = None
12
14
  """The rendered document body."""
@@ -45,6 +45,8 @@ class DocumentTypeCoding(TypedDict, total=False):
45
45
 
46
46
 
47
47
  class DocumentType(TypedDict, total=False):
48
+ """The type of document being uploaded."""
49
+
48
50
  text: Required[str]
49
51
  """Plain text representation of the document type."""
50
52
 
@@ -11,6 +11,8 @@ __all__ = ["PriorAuthorizationCreateDraftResponse"]
11
11
 
12
12
 
13
13
  class PriorAuthorizationCreateDraftResponse(BaseModel):
14
+ """Prior authorization draft creation result."""
15
+
14
16
  are_all_questions_answered: bool = FieldInfo(alias="areAllQuestionsAnswered")
15
17
 
16
18
  clinical_questions: List[object] = FieldInfo(alias="clinicalQuestions")
@@ -8,4 +8,6 @@ __all__ = ["PriorAuthorizationRetrieveRecordResponse"]
8
8
 
9
9
 
10
10
  class PriorAuthorizationRetrieveRecordResponse(BaseModel):
11
+ """Prior authorization record details."""
12
+
11
13
  record: Dict[str, object]
@@ -9,6 +9,8 @@ __all__ = ["PriorAuthorizationSubmitResponse"]
9
9
 
10
10
 
11
11
  class PriorAuthorizationSubmitResponse(BaseModel):
12
+ """Submission result."""
13
+
12
14
  status: Literal["submitted"]
13
15
 
14
16
  record: Optional[object] = None
@@ -9,6 +9,8 @@ __all__ = ["PriorAuthorizationUpdateRecordResponse"]
9
9
 
10
10
 
11
11
  class PriorAuthorizationUpdateRecordResponse(BaseModel):
12
+ """Prior authorization record update result."""
13
+
12
14
  status: Literal["updated"]
13
15
 
14
16
  record: Optional[object] = None
@@ -31,6 +31,8 @@ class Response(BaseModel):
31
31
 
32
32
 
33
33
  class ClinicalQuestionListResponse(BaseModel):
34
+ """Clinical questions for the record."""
35
+
34
36
  are_all_questions_answered: bool = FieldInfo(alias="areAllQuestionsAnswered")
35
37
 
36
38
  questions: List[Question]
@@ -10,6 +10,8 @@ __all__ = ["ClinicalQuestionUpdateResponse"]
10
10
 
11
11
 
12
12
  class ClinicalQuestionUpdateResponse(BaseModel):
13
+ """Updated clinical questions status."""
14
+
13
15
  are_all_questions_answered: bool = FieldInfo(alias="areAllQuestionsAnswered")
14
16
 
15
17
  can_submit: bool = FieldInfo(alias="canSubmit")
@@ -8,6 +8,8 @@ __all__ = ["MessageGetAttachmentResponse"]
8
8
 
9
9
 
10
10
  class MessageGetAttachmentResponse(BaseModel):
11
+ """Attachment retrieved successfully as a document resource."""
12
+
11
13
  id: str
12
14
 
13
15
  file_name: str = FieldInfo(alias="fileName")
@@ -8,4 +8,6 @@ __all__ = ["MessageRetrieveResponse"]
8
8
 
9
9
 
10
10
  class MessageRetrieveResponse(BaseModel):
11
+ """Message retrieved successfully."""
12
+
11
13
  message: Optional[object] = None