schema.py 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. from datetime import datetime
  2. from typing import Literal
  3. from pydantic import BaseModel
  4. # -- settings --
  5. class SettingsLocalDB(BaseModel):
  6. filepath: str
  7. class SettingsOrderUpload(BaseModel):
  8. filepath: str
  9. class SettingsCurrency(BaseModel):
  10. default: str
  11. now_payments: str
  12. class Settings(BaseModel):
  13. git_repo: str
  14. document_match: list[str]
  15. document_exclude: list[str]
  16. block_types: list[str]
  17. local_db: SettingsLocalDB
  18. order_upload: SettingsOrderUpload
  19. currency: SettingsCurrency
  20. # -- cart --
  21. # session-related data structures
  22. class CartSessionMeta(BaseModel):
  23. order_id: str
  24. currency: str
  25. subtotal: int = 0
  26. shipping: float = 0.0
  27. total: float = 0.0
  28. item_amount: int = 0
  29. class CartSessionItemOptions(BaseModel):
  30. product_variation_id: str | None = None
  31. size: Literal["s", "m", "l", "xl", "xxl"] | None
  32. style: str | None
  33. class CartSessionItem(BaseModel):
  34. product_id: str
  35. options: CartSessionItemOptions
  36. price: int = 0
  37. quantity: int = 0
  38. availability: bool = False
  39. class CartSession(BaseModel):
  40. meta: CartSessionMeta
  41. items: dict[str, CartSessionItem]
  42. class CartUpdate(BaseModel):
  43. operation: Literal["add", "remove", "delete", "manual"]
  44. product_id: str
  45. options: CartSessionItemOptions
  46. price: int = 0
  47. # view-related data structures
  48. class CheckoutItemImage(BaseModel):
  49. url: str
  50. width: int
  51. height: int
  52. class CheckoutItem(CartSessionItem):
  53. path: str
  54. title: str
  55. image: CheckoutItemImage
  56. product_id: str
  57. options: CartSessionItemOptions
  58. price: int = 0
  59. weight: int
  60. quantity: int = 0
  61. total: int = 0
  62. availability: bool = False
  63. is_selectable: bool = False
  64. class CheckoutItemUpdate(BaseModel):
  65. quantity: int = 0
  66. total: int = 0
  67. is_selectable: bool = False
  68. class CartOrderInfo(BaseModel):
  69. code: str
  70. title: str
  71. price: int = 0
  72. quantity: int = 0
  73. options: CartSessionItemOptions
  74. class ProductInfoCode(BaseModel):
  75. path: str
  76. options: CartSessionItemOptions
  77. quantity: int
  78. # -- shipping info
  79. class ShippingInfo(BaseModel):
  80. email: str
  81. first_name: str | None = None
  82. last_name: str
  83. address: str
  84. address_no: str
  85. address_extra: str | None = None
  86. postal_code: str
  87. city: str
  88. country: str
  89. phone_number: str | None = None
  90. note: str | None = None
  91. # -- shipping cost
  92. class ShippingCostEntry(BaseModel):
  93. price: float
  94. min: int
  95. max: int | None
  96. class ShippingRate(BaseModel):
  97. price: float
  98. area: str
  99. class ProductShippingMeta(BaseModel):
  100. weight: int
  101. customs_tariff_code: str
  102. origin_country_iso: str
  103. # -- documents --
  104. class DocumentBlockImageInfo(BaseModel):
  105. width: int
  106. height: int
  107. class DocumentBlock(BaseModel):
  108. type: str
  109. value: str | None = None
  110. url: str | None = None
  111. caption: str | None = None
  112. info: DocumentBlockImageInfo | None = None
  113. # -- document: site
  114. class DocumentMetaLink(BaseModel):
  115. label: str
  116. url: str
  117. class DocumentSiteMeta(BaseModel):
  118. type: str
  119. title: str
  120. template: str
  121. path: str | None = None
  122. footer: list[DocumentMetaLink]
  123. class DocumentSite(BaseModel):
  124. meta: DocumentSiteMeta
  125. blocks: list[DocumentBlock]
  126. # -- document: index
  127. class DocumentIndexMeta(BaseModel):
  128. type: str
  129. title: str
  130. template: str
  131. path: str | None = None
  132. class DocumentIndex(BaseModel):
  133. meta: DocumentIndexMeta
  134. blocks: list[DocumentBlock]
  135. # -- document: page --
  136. class DocumentPageMeta(BaseModel):
  137. type: str
  138. title: str
  139. template: str
  140. category: str | None = None
  141. path: str | None = None
  142. class DocumentPage(BaseModel):
  143. meta: DocumentPageMeta
  144. blocks: list[DocumentBlock]
  145. # -- document: products index --
  146. class DocumentProductIndexMeta(BaseModel):
  147. type: str
  148. title: str
  149. template: str
  150. path: str | None = None
  151. class DocumentProductIndex(BaseModel):
  152. meta: DocumentProductIndexMeta
  153. blocks: list[DocumentBlock]
  154. # -- document: product
  155. class DocumentProductMetaOptions(BaseModel):
  156. size: list[str] | None = None
  157. style: list[str] | None = None
  158. class DocumentProductMetaInventory(BaseModel):
  159. product_variation_id: str | None = None
  160. size: str | None = None
  161. style: str | None = None
  162. amount: int
  163. class DocumentProductMeta(BaseModel):
  164. type: str
  165. title: str
  166. template: str
  167. code: str
  168. product_id: str
  169. price: int
  170. weight: int
  171. customs_tariff_code: str
  172. origin_country_iso: str
  173. category: str
  174. inventory: list[DocumentProductMetaInventory]
  175. options: DocumentProductMetaOptions | None = None
  176. path: str | None = None
  177. class DocumentProduct(BaseModel):
  178. meta: DocumentProductMeta
  179. blocks: list[DocumentBlock]
  180. # -- document: orders
  181. class DocumentOrdersMeta(BaseModel):
  182. type: str
  183. title: str
  184. template: str
  185. path: str | None = None
  186. class OrdersBlockItem(BaseModel):
  187. code: str
  188. title: str
  189. quantity: int
  190. price: int
  191. class OrdersBlockShippingInfo(BaseModel):
  192. first_name: str | None
  193. last_name: str
  194. address: str
  195. address_no: str
  196. address_extra: str | None
  197. postal_code: str
  198. city: str
  199. country: str
  200. note: str | None
  201. phone_number: str | None
  202. email: str
  203. class OrdersBlock(BaseModel):
  204. type: str
  205. date: datetime
  206. order_id: str
  207. product_list: str
  208. payment_provider: str
  209. payment_reference: str
  210. status: str
  211. items: list[OrdersBlockItem]
  212. currency: str
  213. subtotal: int
  214. shipping: float
  215. total: float
  216. shipping_info: OrdersBlockShippingInfo
  217. class DocumentOrders(BaseModel):
  218. meta: DocumentOrdersMeta
  219. blocks: list[OrdersBlock]
  220. # -- document: checkout
  221. class DocumentCheckoutMeta(BaseModel):
  222. type: str
  223. title: str
  224. template: str
  225. path: str | None = None
  226. class DocumentCheckout(BaseModel):
  227. meta: DocumentCheckoutMeta
  228. blocks: list[DocumentBlock]
  229. # -- document: checkout product info
  230. class DocumentCheckoutProductInfo(BaseModel):
  231. filename: str
  232. quantity: int
  233. size: Literal["s", "m", "l", "xl", "xxl"] | None
  234. style: str | None
  235. # -- document: email
  236. class DocumentEmailMeta(BaseModel):
  237. type: str
  238. title: str
  239. template: str
  240. sender: str
  241. path: str | None = None
  242. class DocumentEmail(BaseModel):
  243. meta: DocumentEmailMeta
  244. blocks: list[DocumentBlock]
  245. # -- NOW Payments invoice payload
  246. class NowPaymentsInvoice(BaseModel):
  247. price_amount: float
  248. price_currency: str
  249. ipn_callback_url: str
  250. order_id: str
  251. success_url: str | None = None
  252. cancel_url: str | None = None