shop_system_models 0.0.1.dev26551__py3-none-any.whl

shop_system_models/deployment_api/request/nocodb.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class NocoDBConfig(BaseModel):
+    nocodb_project_id: Optional[str] = None
+    nocodb_categories_table: Optional[str] = None
+    nocodb_products_table: Optional[str] = None
+    nocodb_orders_table: Optional[str] = None
+    nocodb_status_table: Optional[str] = None
+    nocodb_bot_commands_table: Optional[str] = None
+    nocodb_options_table: Optional[str] = ""
+    nocodb_options_category_table: Optional[str] = ""

shop_system_models/deployment_api/request/premium.py

@@ -0,0 +1,15 @@
+import enum
+
+from pydantic import BaseModel
+
+
+class PremiumPlanTypes(str, enum.Enum):
+    month = '1month'
+    three_months = '3months'
+    six_months = '6months'
+    year = '12months'
+
+
+class RequestPremiumModel(BaseModel):
+    shop_id: str
+    premium_type: PremiumPlanTypes

shop_system_models/deployment_api/request/processes.py

@@ -0,0 +1,14 @@
+from typing import Optional
+from pydantic import BaseModel
+
+
+class DeployVariables(BaseModel):
+    shop_name: str
+    shop_id: str
+    shop_template_id: str
+    orders_chat_id: int
+    contact_email: str
+    tg_admin_id: int
+    contact_phone: Optional[str]
+    bot_token: Optional[str]
+    invite_user: bool = True

shop_system_models/deployment_api/shared.py

@@ -0,0 +1,40 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class NocoDBConfig(BaseModel):
+    nocodb_project_id: str
+    nocodb_categories_table: str
+    nocodb_products_table: str
+    nocodb_orders_table: str
+    nocodb_status_table: str
+    nocodb_bot_commands_table: str
+    nocodb_options_table: Optional[str] = None
+    nocodb_options_category_table: Optional[str] = None
+
+
+class ShopDetailsModel(BaseModel):
+    shop_id: str
+    shop_name: str
+    friendly_name: str
+    shop_language: str = "RU"
+    shop_api_url: str
+    contact_phone: str | None = None
+    contact_email: str
+    orders_chat_id: int
+    orders_history_chat_id: Optional[int] = None
+    search_enabled: Optional[bool] = False
+    warehouse_accounting: bool = False
+    bot_url: str | None = None
+    bot_token: str
+    payment_token: str | None = None
+    placeholder: str
+    order_process: str
+
+    nocodb_config: Optional[NocoDBConfig] = None
+
+    topic_chat_id: Optional[int] = None
+    premium_expiration_date: Optional[datetime] = None
+    web_app_url: str

shop_system_models/deployment_api/users.py

@@ -0,0 +1,45 @@
+# import re
+
+
+from pydantic import BaseModel
+
+
+class UserHeadersUpdatingModel(BaseModel):
+    tg_id: int
+    first_name: str | None = ""
+    last_name: str | None = ""
+    tg_language: str | None = ""
+    username: str | None = None
+
+
+class UserModel(UserHeadersUpdatingModel):
+    password: str | None = None
+    preview_url: str | None = None
+    rights: str = "user"
+    delivery_addresses: list[str] | None = None
+
+
+class ReferralUser(BaseModel):
+    tg_id: int
+    first_name: str
+    last_name: str | None = None
+    username: str | None = None
+
+
+class InvitedUser(ReferralUser):
+    tg_language: str | None = ""
+    language: str | None = None
+
+
+class UserDeploymentModel(BaseModel):
+    id: str
+    first_name: str
+    last_name: str | None = None
+    username: str | None = None
+    tg_id: int
+    tg_language: str = ""
+    invited_by_id: str | None = None
+    invited_by_user: ReferralUser | None = None
+    roles: list[str] | None = None
+    shops_available: int = 5
+    invited_users: list[InvitedUser] | None

shop_system_models/shop_api/__init__.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel, Field
+
+
+class MetaBaseModel(BaseModel):
+    """Base model with metadata support for all shop system models."""
+    metadata: dict = Field(default_factory=dict, exclude=True) 

shop_system_models/shop_api/bot/__init__.py

@@ -0,0 +1 @@
+"""Bot-related models for the shop system.""" 

shop_system_models/shop_api/bot/request.py

@@ -0,0 +1,49 @@
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+import enum
+
+
+class OrderStatusTypes(str, enum.Enum):
+    CREATED = "CREATED"
+    CANCELLED = "CANCELLED"
+    PAID = "PAID"
+
+
+class OrderStatusModel(BaseModel):
+    name: str
+    message: str
+    in_timeline: bool | None = False
+    type: Optional[OrderStatusTypes] = None
+
+    # @field_validator('name', )
+    # def validate_name_len(cls, value):
+    #     if len(value) > 16:
+    #         return value[:16]
+    #     return value
+
+
+class MessagesType(str, Enum):
+    admin_order_created = "admin_order_created"
+    admin_order_updated = "admin_order_updated"
+    user_order_created = "user_order_created"
+    user_order_updated = "user_order_updated"
+
+
+class MessageModel(BaseModel):
+    type: MessagesType
+    text: str
+
+
+class ButtonType(str, Enum):
+    inline_url = "inline_url"
+    inline_payload = "inline_payload"
+    app_url = "app_url"
+
+
+class ButtonModel(BaseModel):
+    linked_status: OrderStatusModel | None = None
+    type: ButtonType
+    name: str
+    payload: str | None = ""

shop_system_models/shop_api/bot/response.py

@@ -0,0 +1,11 @@
+from shop_system_models.shop_api.bot.request import OrderStatusModel
+from pydantic import BaseModel
+
+
+class OrderStatusResponseModel(OrderStatusModel):
+    id: str
+
+
+class OrderStatusResponseModelWithShopName(BaseModel):
+    shop_name: str
+    order_statuses: list[OrderStatusResponseModel]

shop_system_models/shop_api/commands/__init__.py

@@ -0,0 +1 @@
+"""Command-related models for the shop system.""" 

shop_system_models/shop_api/commands/request.py

@@ -0,0 +1,20 @@
+from shop_system_models.shop_api.bot.request import ButtonModel
+from pydantic import BaseModel, field_validator
+
+
+class BotCommandModel(BaseModel):
+    name: str
+    message: str
+
+    @field_validator("name", mode="before")
+    def command_validation(cls, value):
+        if value.startswith("/"):
+            return value
+        raise ValueError('Bot command should start with "/"')
+
+
+class NotificationPayloadModel(BaseModel):
+    chat_id: int
+    message_id: int | None = -1
+    text: str
+    buttons: list[ButtonModel] = []

shop_system_models/shop_api/commands/response.py

@@ -0,0 +1,5 @@
+from shop_system_models.shop_api.commands.request import BotCommandModel
+
+
+class BotCommandResponseModel(BotCommandModel):
+    id: str

shop_system_models/shop_api/links.py

@@ -0,0 +1,36 @@
+from typing import Optional, Dict, Any
+from pydantic import Field, HttpUrl
+from fastapi import HTTPException
+from pydantic import BaseModel, field_validator
+
+
+
+from shop_system_models.shop_api import MetaBaseModel
+
+
+class ServiceLink(MetaBaseModel):
+    """Model representing a link to another service."""
+    service_name: str
+    url: HttpUrl
+    resource_id: str
+    link_metadata: Optional[Dict[str, Any]] = Field(default_factory=lambda: {})
+
+
+class ServiceLinkResponse(MetaBaseModel):
+    """Response model for service link operations."""
+    link_id: str
+    service_name: str
+    resource_id: str
+    success: bool = True
+    error: Optional[str] = None
+
+
+class LinkBlocksModel(BaseModel):
+    contacts: str | None = "https://teletype.in/@tg-shops/09hOkoJjizN"  # Teletype link
+    info: str | None = "https://teletype.in/@tg-shops/2vZa_0ykcCF"  # Teletype link
+
+    @field_validator("contacts", "info", mode="before")
+    def link_validation(cls, value):
+        if value and (not value.startswith("http://") and not value.startswith("https://")):
+            raise HTTPException(status_code=400, detail=f'Invalid link: "{value}"')
+        return value

shop_system_models/shop_api/processes/__init__.py

@@ -0,0 +1 @@
+"""Process-related models for the shop system.""" 

shop_system_models/shop_api/processes/request.py

@@ -0,0 +1,38 @@
+from shops_payment_processing.models.invoice import InvoiceWithPaymentLinkMessageModel # type: ignore
+
+from shop_system_models.shop_api.commands.request import NotificationPayloadModel
+from shop_system_models.shop_api.shop.request.orders import InvoiceTGMessageModel, InvoiceTONMessageModel
+from shop_system_models.shop_api.shop.request.orders import InvoiceWithPaymentLinkMessageModel as InvoiceWithPaymentLinkMessageModelLocal
+from pydantic import BaseModel
+
+
+class SetAdminMessageIdProcess(BaseModel):
+    admin_message_id: int | None = None
+
+
+class SetProcessStatus(BaseModel):
+    message: str | None = None
+    success: bool | None = None
+
+
+class ProcessModel(SetAdminMessageIdProcess, SetProcessStatus):
+    name: str
+    process_key: int
+    order_id: str
+
+
+class ProcessVariables(BaseModel):
+    order_id: str
+    shop_url: str
+    shop_id: str
+    shop_api_url: str
+    shop_bot_url: str
+    user_order_info: NotificationPayloadModel
+    admin_order_info: NotificationPayloadModel
+    payment_info: (InvoiceTGMessageModel
+                   | InvoiceTONMessageModel
+                   | InvoiceWithPaymentLinkMessageModel
+                   | InvoiceWithPaymentLinkMessageModelLocal
+                   | None) = None
+    send_to_admin_dm: bool = False
+    shop_language: str

shop_system_models/shop_api/processes/response.py

@@ -0,0 +1,12 @@
+from shop_system_models.shop_api.processes.request import ProcessModel
+from pydantic import BaseModel
+
+
+class ProcessResponseModel(ProcessModel):
+    id: str
+
+
+class UpdateMessageResponseModel(BaseModel):
+    text: str
+    status: str
+    order_number: str

shop_system_models/shop_api/shared.py

@@ -0,0 +1,20 @@
+from typing import Dict, Optional
+from pydantic import BaseModel
+
+class Thumbnail(BaseModel):
+    signedUrl: Optional[str] = None
+    path: Optional[str] = None
+
+class Thumbnails(BaseModel):
+    tiny: Optional[Thumbnail]
+    small: Optional[Thumbnail]
+    card_cover: Optional[Thumbnail]
+
+class ImageMetadata(BaseModel):
+    id: Optional[str] = None
+    url: Optional[str] = None
+    title: Optional[str] = None
+    mimetype: Optional[str] = None
+    thumbnails: Optional[Thumbnails]
+    path: Optional[str] = None
+    signedUrl: Optional[str] = None

shop_system_models/shop_api/shop/__init__.py

@@ -0,0 +1,4 @@
+"""Shop-related models for the shop system."""
+
+# from shop_system_models.shop_api.shop.request import *  # noqa
+# from shop_system_models.shop_api.shop.response import *  # noqa

shop_system_models/shop_api/shop/request/__init__.py

@@ -0,0 +1,13 @@
+"""Shop request models for API communication."""
+
+from shop_system_models.shop_api.shop.request.orders import (
+    OrderModel,
+    DeliveryTypeModel,
+    CreateOrderModel,
+    BookingOrderModel,
+    OrderDeliveryTypeModel,
+    ExtraField,
+    AddressModel,
+    Coordinates,
+    ExtraFieldPayload,
+) 

shop_system_models/shop_api/shop/request/baskets.py

@@ -0,0 +1,38 @@
+from typing import Annotated
+
+from annotated_types import Ge
+from pydantic import BaseModel
+from typing_extensions import Doc
+
+
+class DBProductInBasket(BaseModel):
+    id: str  # ID продукта
+    count: int  # его кол-во
+
+
+class BasketModel(BaseModel):
+    user_id: str | None = None  # Not uses in request
+    order_id: str | None = None  # Not uses in request
+    products_id: list[DBProductInBasket] = []
+    amount: float | None = 0  # Not uses in request
+    preview_url: str = ""
+
+
+class DBProductInBasketV2(BaseModel):
+    id: str  # product ID
+    unique_id: str  # unique product ID in the basket, used it for product deleting
+    extra_option_ids: list[str] = []
+
+
+class BasketModelV2(BaseModel):
+    user_id: str | None = None
+    order_id: str | None = None
+    products_id: list[DBProductInBasketV2] = []
+    coupon: str | None = None
+    coupon_discount: Annotated[float, Doc("The amount of discount from attached coupon, if any.")] = 0
+    amount: Annotated[float, Ge(0)] = 0  # this amount already includes discount
+    preview_url: str = ""
+
+
+class CouponInputData(BaseModel):
+    code: str

shop_system_models/shop_api/shop/request/categories.py

@@ -0,0 +1,24 @@
+from typing import List
+
+from pydantic import BaseModel, Field, field_validator
+
+from shop_system_models.shop_api.shared import ImageMetadata
+
+
+class SubmitParentCategoryModel(BaseModel):
+    parent_category: list[int] = Field(default_factory=list)
+
+
+class SubmitCategoryModel(BaseModel):
+    name: str
+    preview_url: str = ""
+
+    @field_validator("name", mode="before")
+    def name_validation(cls, value):
+        if not value:
+            raise ValueError("Name cannot be an empty string.")
+        return value
+
+
+class CategoryModel(SubmitCategoryModel, SubmitParentCategoryModel):
+    images: List[ImageMetadata] = []

shop_system_models/shop_api/shop/request/coupons.py

@@ -0,0 +1,43 @@
+import datetime
+from typing import Annotated
+
+from annotated_types import Ge, Le
+from pydantic import BaseModel, model_validator, StringConstraints
+
+
+class SubmitCouponModel(BaseModel):
+    exp_date: datetime.datetime | None = None
+    amount: Annotated[float, Ge(0)] | None = None
+    discount: Annotated[float, Ge(0), Le(100)] | None = None
+    available_qty: Annotated[int, Ge(0)]
+    code: Annotated[str, StringConstraints(min_length=1, max_length=10)]
+
+    @model_validator(mode="after")
+    def amount_xor_discount_validator(self):
+        if self.amount is None and self.discount is None:
+            raise ValueError("amount or discount must be specified")
+
+        if self.amount is not None and self.discount is not None:
+            raise ValueError("only one of amount and discount must be specified")
+
+        return self
+
+
+class CouponModel(SubmitCouponModel):
+    def get_discount_amount(self, basket_amount: float) -> float:
+        """
+        Calculate the discount amount.
+
+        It is guaranteed that the discount amount will be less than basket amount,
+        i.e. final basket amount won't go below zero.
+        """
+
+        if self.amount is not None:
+            discount_amount = self.amount
+        else:
+            assert self.discount is not None, "amount and discount are both None"  # for mypy
+
+            # Round down discount_amount with precision of 2 digits after point
+            discount_amount = int(self.discount * basket_amount) / 100
+
+        return min(discount_amount, basket_amount - 1)

shop_system_models/shop_api/shop/request/details.py

@@ -0,0 +1,37 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+
+
+class ShopDetailsModel(BaseModel):
+    shop_id: str
+    shop_name: str
+    friendly_name: str
+    shop_language: str = "RU"
+    shop_api_url: str = "https://marketplace-api-dev.tg-shops.com"
+    contact_phone: str | None = None
+    contact_email: str
+    orders_chat_id: int
+    orders_history_chat_id: Optional[int] = None
+    search_enabled: Optional[bool] = False
+    warehouse_accounting: bool = False
+    bot_url: str | None = None
+    bot_token: str
+    payment_token: str | None = None
+    placeholder: str
+    order_process: str
+    nocodb_project_id: str
+    nocodb_categories_table: str
+    nocodb_products_table: str
+    nocodb_orders_table: str
+    nocodb_status_table: str
+    nocodb_bot_commands_table: str
+    nocodb_options_table: Optional[str] = ""
+    nocodb_options_category_table: Optional[str] = ""
+    topic_chat_id: Optional[int] = None
+    premium_expiration_date: Optional[datetime] = None
+    web_app_url: str = ""
+

shop_system_models/shop_api/shop/request/orders.py

@@ -0,0 +1,143 @@
+from datetime import datetime
+from typing import Optional, List, Dict, Any, Union
+from pydantic import Field, field_validator, BaseModel
+
+from shop_system_models.shop_api import MetaBaseModel
+from shop_system_models.shop_api.shop.response.baskets import UserBasketResponseModelV2
+from shop_system_models.shop_api.shop.response.products import ProductResponseModel
+
+
+class ExtraFieldPayload(MetaBaseModel):
+    """Model for extra field data in orders."""
+    name: str
+    value: str
+
+
+class OrderDeliveryTypeModel(MetaBaseModel):
+    """Model for order delivery details."""
+    name: str
+    address: Optional[str] = ""
+    amount: Optional[float] = 0.0
+    extra_fields_payload: Optional[List[ExtraFieldPayload]] = Field(default_factory=lambda: [])
+
+
+class Coordinates(MetaBaseModel):
+    """Geographic coordinates."""
+    latitude: Optional[float] = None
+    longitude: Optional[float] = None
+
+
+class AddressModel(MetaBaseModel):
+    """Address model with optional coordinates."""
+    coordinates: Optional[Coordinates] = None
+    address: Optional[str] = None
+
+
+class ExtraField(MetaBaseModel):
+    """Model for defining extra fields."""
+    name: str
+    description: str
+    is_required: Optional[bool] = None
+
+
+class DeliveryTypeModel(MetaBaseModel):
+    """Delivery type configuration model."""
+    name: str
+    amount: float = 0.0
+    is_address_required: Optional[bool] = False
+    address_hint: Optional[str] = ""
+    extra_fields: List[ExtraField] = Field(default_factory=list)
+    is_timepicker_required: bool = False
+    details: Optional[str] = None
+    country: Optional[str] = None
+    country_code: Optional[str] = None  # ISO format, ex.: RU, KZ, BY...
+    city: Optional[str] = None
+    delivery_location: Optional[Coordinates] = None
+    delivery_radius: Optional[int] = None
+    delivery_min_hour: Optional[int] = None
+    delivery_max_hour: Optional[int] = None
+    delivery_minutes_interval: Optional[int] = None
+    delivery_min_day: Optional[int] = None
+    delivery_max_day: Optional[int] = None
+
+
+class BookingOrderModel(MetaBaseModel):
+    """Details for a booking order."""
+    booking_id: str
+    from_date: datetime
+    till_date: datetime
+    item_id: str
+
+
+class CreateOrderModel(MetaBaseModel):
+    """Model for creating a new order."""
+    delivery: Optional[OrderDeliveryTypeModel] = None
+    delivery_date_from: datetime = Field(default_factory=datetime.now)
+    comment: Optional[str] = None
+    user_contact_number: Optional[str] = None
+    payment_type_id: Optional[str] = None
+    booking_details: Optional[BookingOrderModel] = None
+    preview_url: Optional[str] = ""
+
+
+class ProductsInBasket(ProductResponseModel):
+    count_in_basket: int = 1
+
+
+# This depends on UserBasketResponseModelV2 which we'll define in a separate file
+# For now, we'll create a placeholder class that can be updated later
+class OrderModel(CreateOrderModel):
+    """Complete order model."""
+    basket: UserBasketResponseModelV2  # This will be implemented in basket models
+    user_id: Optional[str] = None
+    basket_id: Optional[str] = None
+    status: Optional[str] = None
+    client_coordinates: Optional[AddressModel] = None
+    created: datetime = Field(default_factory=datetime.now)
+    updated: datetime = Field(default_factory=datetime.now)
+    order_number: str = "#0001"
+    process_key: Optional[int] = None
+    coupon: Optional[str] = None
+    admin_message_id: str | None = None
+
+
+class LabeledPrice(BaseModel):
+    label: str
+    amount: int
+
+
+class InvoiceBaseModel(BaseModel):
+    chat_id: int
+    order_id: str
+    order_number: str  # order_number
+    payload: str  # <basket_id>_<order_id>_<order_number> from OrderResponseModel --> its subscription key
+    amount: float
+    currency: str  # fiat
+    payment_address: str
+    payment_timeout: int | None = None
+
+
+class InvoiceTGMessageModel(InvoiceBaseModel):
+    description: str  # order_products
+    provider_data: str | None = None
+    prices: list[LabeledPrice]  # label and amount in coins!
+    need_name: bool | None = False
+    need_phone_number: bool | None = False
+    need_email: bool | None = False
+    send_phone_number_to_provider: bool | None = False
+    send_email_to_provider: bool | None = False
+    is_flexible: bool | None = False
+    reply_markup: bool | None = None
+
+
+class InvoiceWithPaymentLinkMessageModel(InvoiceBaseModel):
+    payment_link: str
+
+
+class InvoiceTONMessageModel(InvoiceBaseModel):
+    approved_addresses: list[str] = []
+    ton_amount: float
+
+
+class PaidContentMessage(BaseModel):
+    message: str