samplehc 0.14.0__py3-none-any.whl → 0.16.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 (102) hide show
  1. samplehc/_base_client.py +140 -11
  2. samplehc/_client.py +107 -35
  3. samplehc/_models.py +53 -16
  4. samplehc/_streaming.py +12 -12
  5. samplehc/_types.py +12 -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 -42
  10. samplehc/resources/v2/communication.py +5 -4
  11. samplehc/resources/v2/documents/documents.py +8 -0
  12. samplehc/resources/v2/tasks/tasks.py +12 -3
  13. samplehc/resources/v2/v2.py +0 -96
  14. samplehc/types/v1_query_audit_logs_response.py +4 -0
  15. samplehc/types/v2/__init__.py +1 -2
  16. samplehc/types/v2/clearinghouse/claim_submit_response.py +5 -0
  17. samplehc/types/v2/clearinghouse/payer_list_response.py +2 -0
  18. samplehc/types/v2/clearinghouse/payer_search_response.py +2 -0
  19. samplehc/types/v2/clearinghouse_check_eligibility_response.py +4 -0
  20. samplehc/types/v2/clearinghouse_run_discovery_response.py +2 -0
  21. samplehc/types/v2/communication_send_email_response.py +27 -0
  22. samplehc/types/v2/communication_send_fax_params.py +2 -0
  23. samplehc/types/v2/communication_send_fax_response.py +2 -0
  24. samplehc/types/v2/communication_send_letter_params.py +8 -0
  25. samplehc/types/v2/communication_send_letter_response.py +2 -0
  26. samplehc/types/v2/database_execute_sql_response.py +2 -0
  27. samplehc/types/v2/document_classify_params.py +2 -0
  28. samplehc/types/v2/document_classify_response.py +2 -0
  29. samplehc/types/v2/document_combine_response.py +4 -0
  30. samplehc/types/v2/document_create_from_splits_params.py +2 -0
  31. samplehc/types/v2/document_create_from_splits_response.py +2 -0
  32. samplehc/types/v2/document_extract_params.py +40 -3
  33. samplehc/types/v2/document_extract_response.py +2 -0
  34. samplehc/types/v2/document_generate_csv_response.py +4 -0
  35. samplehc/types/v2/document_presigned_upload_url_response.py +2 -0
  36. samplehc/types/v2/document_retrieve_csv_content_response.py +2 -0
  37. samplehc/types/v2/document_retrieve_metadata_response.py +2 -0
  38. samplehc/types/v2/document_search_response.py +2 -0
  39. samplehc/types/v2/document_split_params.py +2 -0
  40. samplehc/types/v2/document_split_response.py +2 -0
  41. samplehc/types/v2/documents/format_create_pdf_response.py +2 -0
  42. samplehc/types/v2/documents/legacy_extract_response.py +2 -0
  43. samplehc/types/v2/documents/legacy_reason_response.py +2 -0
  44. samplehc/types/v2/documents/legacy_split_params.py +2 -0
  45. samplehc/types/v2/documents/legacy_split_response.py +2 -0
  46. samplehc/types/v2/documents/pdf_template_retrieve_metadata_response.py +2 -0
  47. samplehc/types/v2/documents/template_render_document_response.py +2 -0
  48. samplehc/types/v2/hie/document_upload_params.py +2 -0
  49. samplehc/types/v2/integrations/glidian/prior_authorization_create_draft_response.py +2 -0
  50. samplehc/types/v2/integrations/glidian/prior_authorization_retrieve_record_response.py +2 -0
  51. samplehc/types/v2/integrations/glidian/prior_authorization_submit_response.py +2 -0
  52. samplehc/types/v2/integrations/glidian/prior_authorization_update_record_response.py +2 -0
  53. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_list_response.py +2 -0
  54. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_update_response.py +2 -0
  55. samplehc/types/v2/integrations/kno2/message_get_attachment_response.py +2 -0
  56. samplehc/types/v2/integrations/kno2/message_retrieve_response.py +2 -0
  57. samplehc/types/v2/ledger/__init__.py +0 -7
  58. samplehc/types/v2/policy_list_companies_response.py +2 -0
  59. samplehc/types/v2/policy_list_plans_response.py +2 -0
  60. samplehc/types/v2/policy_list_response.py +2 -0
  61. samplehc/types/v2/policy_retrieve_presigned_url_response.py +2 -0
  62. samplehc/types/v2/policy_retrieve_text_response.py +2 -0
  63. samplehc/types/v2/task_cancel_response.py +2 -0
  64. samplehc/types/v2/task_complete_response.py +2 -0
  65. samplehc/types/v2/task_update_column_params.py +6 -3
  66. samplehc/types/v2/workflow_run_resume_when_complete_response.py +2 -0
  67. samplehc/types/v2/workflow_run_retrieve_response.py +2 -0
  68. samplehc/types/v2/workflow_runs/step_get_output_response.py +2 -0
  69. samplehc/types/v2/workflow_start_response.py +2 -0
  70. {samplehc-0.14.0.dist-info → samplehc-0.16.0.dist-info}/METADATA +7 -6
  71. {samplehc-0.14.0.dist-info → samplehc-0.16.0.dist-info}/RECORD +73 -101
  72. {samplehc-0.14.0.dist-info → samplehc-0.16.0.dist-info}/licenses/LICENSE +1 -1
  73. samplehc/resources/v2/browser_agents/__init__.py +0 -33
  74. samplehc/resources/v2/browser_agents/browser_agents.py +0 -209
  75. samplehc/resources/v2/browser_agents/runs/__init__.py +0 -33
  76. samplehc/resources/v2/browser_agents/runs/help_requests.py +0 -191
  77. samplehc/resources/v2/browser_agents/runs/runs.py +0 -233
  78. samplehc/resources/v2/browser_automation/__init__.py +0 -33
  79. samplehc/resources/v2/browser_automation/availity.py +0 -249
  80. samplehc/resources/v2/browser_automation/browser_automation.py +0 -102
  81. samplehc/resources/v2/ledger/__init__.py +0 -47
  82. samplehc/resources/v2/ledger/account.py +0 -297
  83. samplehc/resources/v2/ledger/entry.py +0 -381
  84. samplehc/resources/v2/ledger/ledger.py +0 -134
  85. samplehc/types/v2/browser_agent_invoke_params.py +0 -13
  86. samplehc/types/v2/browser_agent_invoke_response.py +0 -15
  87. samplehc/types/v2/browser_agents/__init__.py +0 -6
  88. samplehc/types/v2/browser_agents/run_list_events_params.py +0 -15
  89. samplehc/types/v2/browser_agents/run_list_events_response.py +0 -30
  90. samplehc/types/v2/browser_agents/runs/__init__.py +0 -6
  91. samplehc/types/v2/browser_agents/runs/help_request_resolve_params.py +0 -18
  92. samplehc/types/v2/browser_agents/runs/help_request_resolve_response.py +0 -28
  93. samplehc/types/v2/browser_automation/__init__.py +0 -6
  94. samplehc/types/v2/browser_automation/availity_submit_appeal_params.py +0 -59
  95. samplehc/types/v2/browser_automation/availity_submit_appeal_response.py +0 -12
  96. samplehc/types/v2/ledger/account_writeoff_params.py +0 -23
  97. samplehc/types/v2/ledger/account_writeoff_response.py +0 -12
  98. samplehc/types/v2/ledger/entry_post_params.py +0 -60
  99. samplehc/types/v2/ledger/entry_post_response.py +0 -10
  100. samplehc/types/v2/ledger/entry_reverse_params.py +0 -18
  101. samplehc/types/v2/ledger/entry_reverse_response.py +0 -10
  102. {samplehc-0.14.0.dist-info → samplehc-0.16.0.dist-info}/WHEEL +0 -0
@@ -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
@@ -0,0 +1,27 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List
4
+
5
+ from pydantic import Field as FieldInfo
6
+
7
+ from ..._models import BaseModel
8
+
9
+ __all__ = ["CommunicationSendEmailResponse", "Attachment"]
10
+
11
+
12
+ class Attachment(BaseModel):
13
+ id: str
14
+
15
+ file_name: str = FieldInfo(alias="fileName")
16
+
17
+
18
+ class CommunicationSendEmailResponse(BaseModel):
19
+ """
20
+ Indicates the email request was accepted and processed (or queued for processing).
21
+ """
22
+
23
+ attachments: List[Attachment]
24
+ """The attachments that were sent with the email.
25
+
26
+ If zipAttachments was true, this will contain the single zipped file.
27
+ """
@@ -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
@@ -1,10 +1,3 @@
1
1
  # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  from __future__ import annotations
4
-
5
- from .entry_post_params import EntryPostParams as EntryPostParams
6
- from .entry_post_response import EntryPostResponse as EntryPostResponse
7
- from .entry_reverse_params import EntryReverseParams as EntryReverseParams
8
- from .entry_reverse_response import EntryReverseResponse as EntryReverseResponse
9
- from .account_writeoff_params import AccountWriteoffParams as AccountWriteoffParams
10
- from .account_writeoff_response import AccountWriteoffResponse as AccountWriteoffResponse
@@ -16,6 +16,8 @@ class Company(BaseModel):
16
16
 
17
17
 
18
18
  class PolicyListCompaniesResponse(BaseModel):
19
+ """Successfully retrieved companies"""
20
+
19
21
  companies: List[Company]
20
22
 
21
23
  count: float
@@ -22,6 +22,8 @@ class Plan(BaseModel):
22
22
 
23
23
 
24
24
  class PolicyListPlansResponse(BaseModel):
25
+ """Successfully retrieved plans"""
26
+
25
27
  count: float
26
28
  """Total number of plans available"""
27
29
 
@@ -59,6 +59,8 @@ class Policy(BaseModel):
59
59
 
60
60
 
61
61
  class PolicyListResponse(BaseModel):
62
+ """Successfully retrieved policies"""
63
+
62
64
  count: float
63
65
  """Total number of policies available"""
64
66
 
@@ -8,6 +8,8 @@ __all__ = ["PolicyRetrievePresignedURLResponse"]
8
8
 
9
9
 
10
10
  class PolicyRetrievePresignedURLResponse(BaseModel):
11
+ """Successfully retrieved presigned URL"""
12
+
11
13
  mime_type: str = FieldInfo(alias="mimeType")
12
14
  """MIME type of the policy document"""
13
15
 
@@ -6,5 +6,7 @@ __all__ = ["PolicyRetrieveTextResponse"]
6
6
 
7
7
 
8
8
  class PolicyRetrieveTextResponse(BaseModel):
9
+ """Successfully retrieved policy text"""
10
+
9
11
  text: str
10
12
  """Raw text content of the policy document"""
@@ -6,5 +6,7 @@ __all__ = ["TaskCancelResponse"]
6
6
 
7
7
 
8
8
  class TaskCancelResponse(BaseModel):
9
+ """Task cancelled successfully."""
10
+
9
11
  message: str
10
12
  """Confirmation message that the task has been cancelled."""
@@ -10,5 +10,7 @@ __all__ = ["TaskCompleteResponse"]
10
10
 
11
11
 
12
12
  class TaskCompleteResponse(BaseModel):
13
+ """Task completed successfully."""
14
+
13
15
  next_task_id: Optional[str] = FieldInfo(alias="nextTaskId", default=None)
14
16
  """The ID of the next task in the workflow, if any, or null."""
@@ -2,8 +2,8 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
- from typing import Optional
6
- from typing_extensions import Required, TypedDict
5
+ from typing import Union
6
+ from typing_extensions import Literal, Required, TypedDict
7
7
 
8
8
  __all__ = ["TaskUpdateColumnParams"]
9
9
 
@@ -12,5 +12,8 @@ class TaskUpdateColumnParams(TypedDict, total=False):
12
12
  key: Required[str]
13
13
  """The column key to update or insert."""
14
14
 
15
- value: Required[Optional[str]]
15
+ value: Required[Union[str, float, bool, None]]
16
16
  """The value to set for the column."""
17
+
18
+ type: Literal["string", "number", "boolean", "date", "datetime"]
19
+ """The semantic type of the column. Defaults to string when omitted."""
@@ -6,5 +6,7 @@ __all__ = ["WorkflowRunResumeWhenCompleteResponse"]
6
6
 
7
7
 
8
8
  class WorkflowRunResumeWhenCompleteResponse(BaseModel):
9
+ """Request accepted, processing to resume workflow has been initiated."""
10
+
9
11
  message: str
10
12
  """A message indicating the request has been accepted for processing."""
@@ -10,5 +10,7 @@ __all__ = ["WorkflowRunRetrieveResponse"]
10
10
 
11
11
 
12
12
  class WorkflowRunRetrieveResponse(BaseModel):
13
+ """Successfully retrieved workflow run details."""
14
+
13
15
  workflow_run: Optional[object] = FieldInfo(alias="workflowRun", default=None)
14
16
  """The detailed workflow run object."""
@@ -8,5 +8,7 @@ __all__ = ["StepGetOutputResponse"]
8
8
 
9
9
 
10
10
  class StepGetOutputResponse(BaseModel):
11
+ """Successfully retrieved step output data."""
12
+
11
13
  output: Optional[object] = None
12
14
  """The output data generated by the specified workflow step."""
@@ -10,6 +10,8 @@ __all__ = ["WorkflowStartResponse"]
10
10
 
11
11
 
12
12
  class WorkflowStartResponse(BaseModel):
13
+ """Workflow initiated successfully."""
14
+
13
15
  next_task_id: Optional[str] = FieldInfo(alias="nextTaskId", default=None)
14
16
  """
15
17
  The ID of the first task in the workflow run, or null if the workflow completes