Skip to content

schemas.import_schemas

src.schemas.import_schemas

Import schemas for file upload API.

Request and response schemas for file import endpoints.

Reference
  • docs/architecture/api-design-patterns.md

Classes

ImportResponse

Bases: BaseModel

Response schema for file import.

Attributes:

Name Type Description
connection_id UUID

Provider connection ID.
accounts_created int

Number of new accounts created.
accounts_updated int

Number of existing accounts updated.
transactions_created int

Number of new transactions imported.
transactions_skipped int

Number of duplicate transactions skipped.
message str

Human-readable summary.
Source code in src/schemas/import_schemas.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class ImportResponse(BaseModel):
    """Response schema for file import.

    Attributes:
        connection_id: Provider connection ID.
        accounts_created: Number of new accounts created.
        accounts_updated: Number of existing accounts updated.
        transactions_created: Number of new transactions imported.
        transactions_skipped: Number of duplicate transactions skipped.
        message: Human-readable summary.
    """

    connection_id: UUID = Field(description="Provider connection ID")
    accounts_created: int = Field(description="Number of new accounts created")
    accounts_updated: int = Field(description="Number of existing accounts updated")
    transactions_created: int = Field(description="Number of new transactions imported")
    transactions_skipped: int = Field(
        description="Number of duplicate transactions skipped"
    )
    message: str = Field(description="Human-readable summary")

    @classmethod
    def from_result(cls, result: ImportResult) -> "ImportResponse":
        """Create response from ImportResult.

        Args:
            result: Handler result.

        Returns:
            ImportResponse instance.
        """
        return cls(
            connection_id=result.connection_id,
            accounts_created=result.accounts_created,
            accounts_updated=result.accounts_updated,
            transactions_created=result.transactions_created,
            transactions_skipped=result.transactions_skipped,
            message=result.message,
        )

    model_config = {
        "json_schema_extra": {
            "example": {
                "connection_id": "01234567-89ab-cdef-0123-456789abcdef",
                "accounts_created": 1,
                "accounts_updated": 0,
                "transactions_created": 25,
                "transactions_skipped": 0,
                "message": "Imported from Chase_Activity.QFX: 1 accounts created, 0 updated, 25 transactions imported, 0 skipped",
            }
        }
    }
Functions
from_result classmethod 
from_result(result: ImportResult) -> ImportResponse

Create response from ImportResult.

Parameters:

Name Type Description Default
result ImportResult

Handler result.

 required

Returns:

Type Description
ImportResponse

ImportResponse instance.
Source code in src/schemas/import_schemas.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@classmethod
def from_result(cls, result: ImportResult) -> "ImportResponse":
    """Create response from ImportResult.

    Args:
        result: Handler result.

    Returns:
        ImportResponse instance.
    """
    return cls(
        connection_id=result.connection_id,
        accounts_created=result.accounts_created,
        accounts_updated=result.accounts_updated,
        transactions_created=result.transactions_created,
        transactions_skipped=result.transactions_skipped,
        message=result.message,
    )

SupportedFormatsResponse

Bases: BaseModel

Response schema for supported file formats.

Attributes:

Name Type Description
formats list[FileFormatInfo]

List of supported file format objects.
Source code in src/schemas/import_schemas.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class SupportedFormatsResponse(BaseModel):
    """Response schema for supported file formats.

    Attributes:
        formats: List of supported file format objects.
    """

    formats: list["FileFormatInfo"] = Field(description="List of supported formats")

    model_config = {
        "json_schema_extra": {
            "example": {
                "formats": [
                    {
                        "format": "qfx",
                        "name": "Quicken Financial Exchange",
                        "extensions": [".qfx"],
                        "provider_slugs": ["chase_file"],
                    },
                    {
                        "format": "ofx",
                        "name": "Open Financial Exchange",
                        "extensions": [".ofx"],
                        "provider_slugs": ["chase_file"],
                    },
                ]
            }
        }
    }

FileFormatInfo

Bases: BaseModel

Information about a supported file format.

Attributes:

Name Type Description
format str

Format identifier.
name str

Human-readable format name.
extensions list[str]

File extensions for this format.
provider_slugs list[str]

Providers that support this format.
Source code in src/schemas/import_schemas.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
class FileFormatInfo(BaseModel):
    """Information about a supported file format.

    Attributes:
        format: Format identifier.
        name: Human-readable format name.
        extensions: File extensions for this format.
        provider_slugs: Providers that support this format.
    """

    format: str = Field(description="Format identifier")
    name: str = Field(description="Human-readable format name")
    extensions: list[str] = Field(description="File extensions")
    provider_slugs: list[str] = Field(description="Providers supporting this format")