Skip to content

FileDetail

Source code in docs_src/capo_partnercentral_benefits/types/file_detail.py
class FileDetail(TypedDict, closed=True):
    file_uri: "capo_partnercentral_benefits.types.file_uri.FileURI"
    """<p>The URI or location where the file is stored.</p>"""
    business_use_case: NotRequired["str"]
    """<p>The business purpose or use case that this file supports in the benefit application.</p>"""
    file_name: NotRequired["str"]
    """<p>The original name of the uploaded file.</p>"""
    file_status: NotRequired["str"]
    """<p>The current processing status of the file (e.g., uploaded, processing, approved, rejected).</p>"""
    file_status_reason: NotRequired["str"]
    """<p>The reason for that particulat file status.</p>"""
    file_type: NotRequired["capo_partnercentral_benefits.types.file_type.FileType"]
    """<p>The type or category of the file (e.g., document, image, spreadsheet).</p>"""
    created_by: NotRequired["str"]
    """<p>The identifier of the user who uploaded the file.</p>"""
    created_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the file was uploaded.</p>"""

business_use_case instance-attribute

business_use_case: NotRequired[str]

The business purpose or use case that this file supports in the benefit application.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp when the file was uploaded.

created_by instance-attribute

created_by: NotRequired[str]

The identifier of the user who uploaded the file.

file_name instance-attribute

file_name: NotRequired[str]

The original name of the uploaded file.

file_status instance-attribute

file_status: NotRequired[str]

The current processing status of the file (e.g., uploaded, processing, approved, rejected).

file_status_reason instance-attribute

file_status_reason: NotRequired[str]

The reason for that particulat file status.

file_type instance-attribute

file_type: NotRequired[FileType]

The type or category of the file (e.g., document, image, spreadsheet).

file_uri instance-attribute

file_uri: FileURI

The URI or location where the file is stored.