inventory/models.py at main · lnbits/inventory · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
68
69
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
from datetime import datetime, timezone

from lnbits.db import FilterModel
from pydantic import BaseModel, Field


class CreateInventory(BaseModel):
    name: str
    currency: str
    global_discount_percentage: float = 0.0
    default_tax_rate: float = 0.0
    is_tax_inclusive: bool = True
    tags: str | None = None
    omit_tags: str | None = None


class PublicInventory(CreateInventory):
    id: str
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))


class Inventory(PublicInventory):
    user_id: str


class CreateItem(BaseModel):
    inventory_id: str
    name: str
    description: str | None = None
    images: str | None = None
    sku: str | None = None
    quantity_in_stock: int | None = None
    price: float
    discount_percentage: float | None = None
    tax_rate: float | None = None
    reorder_threshold: int | None = None
    weight_grams: int | None = None
    unit_cost: float | None = None
    external_id: str | None = None
    tags: str | None = None
    omit_tags: str | None = None
    is_active: bool = True
    internal_note: str | None = None
    manager_id: str | None = None
    is_approved: bool = True


class PublicItem(BaseModel):
    id: str
    inventory_id: str
    name: str
    description: str | None = None
    images: str | None = None
    sku: str | None = None
    quantity_in_stock: int | None = None
    price: float
    discount_percentage: float | None
    tax_rate: float | None
    weight_grams: int | None = None
    external_id: str | None = None
    tags: str | None = None
    omit_tags: str | None = None
    is_active: bool
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))


class Item(PublicItem):
    external_id: str | None = None
    manager_id: str | None = None
    internal_note: str | None = None
    unit_cost: float | None = None
    reorder_threshold: int | None = None
    weight_grams: int | None = None
    is_approved: bool = False


class ItemFilters(FilterModel):
    __search_fields__: list[str] = [  # noqa: RUF012
        "name",
        "description",
        "sku",
        "is_active",
        "internal_note",
        "manager_id",
        "tags",
        "is_approved",
    ]

    __sort_fields__: list[str] | None = [  # noqa: RUF012
        "name",
        "created_at",
        "price",
        "quantity_in_stock",
        "tags",
    ]

    name: str | None = None
    description: str | None = None
    sku: str | None = None
    is_active: bool | None = None
    internal_note: str | None = None
    tags: str | None = None
    manager_id: str | None = None
    is_approved: bool | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None


# Inventory owner can assign managers to help manage items and stock
class CreateManager(BaseModel):
    inventory_id: str
    name: str
    email: str | None = None
    tags: str | None = None


class Manager(CreateManager):
    id: str
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))


class ManagerQuantityUpdate(BaseModel):
    inventory_id: str
    quantity_in_stock: int


# Inventory update logs
class InventoryUpdateMetadata(BaseModel):
    order_id: int | None = None
    transaction_id: str | None = None
    note: str | None = None


class CreateInventoryUpdateLog(BaseModel):
    inventory_id: str
    item_id: str
    quantity_change: int
    quantity_before: int
    quantity_after: int
    source: str = "webhook"
    idempotency_key: str
    metadata: InventoryUpdateMetadata | None = None


class InventoryUpdateLog(CreateInventoryUpdateLog):
    id: int
    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))


class InventoryLogFilters(FilterModel):
    __search_fields__: list[str] = ["idempotency_key", "item_id"]  # noqa: RUF012

    __sort_fields__: list[str] | None = [  # noqa: RUF012
        "created_at",
        "item_id",
        "quantity_change",
        "source",
    ]

    idempotency_key: str | None = None
    item_id: str | None = None
    created_at: datetime | None = None
    source: str | None = None


class ImportItem(BaseModel):
    name: str
    price: float
    description: str | None = None
    images: list[str] | str | None = None
    sku: str | None = None
    quantity_in_stock: int | None = None
    discount_percentage: float | None = None
    tax_rate: float | None = None
    reorder_threshold: int | None = None
    weight_grams: int | None = None
    unit_cost: float | None = None
    external_id: str | None = None
    tags: list[str] | str | None = None
    omit_tags: list[str] | str | None = None
    is_active: bool | None = True
    internal_note: str | None = None
    manager_id: str | None = None
    is_approved: bool | None = True

    class Config:
        extra = "ignore"


class ImportItemsPayload(BaseModel):
    items: list[ImportItem]