Added tests and fixed some APIs

Author: mmzeynalli

docs/en/docs/integrations/clopos/api-reference/response.md

@@ -54,8 +54,6 @@
 
 ::: integrify.clopos.schemas.objects.sub.ModifierGroup
 
-::: integrify.clopos.schemas.objects.sub.Recipe
-
 ::: integrify.clopos.schemas.objects.sub.Package
 
 ::: integrify.clopos.schemas.objects.sub.Tax
@@ -80,10 +78,12 @@
 
 ::: integrify.clopos.schemas.objects.sub.OrderProductProduct
 
-::: integrify.clopos.schemas.objects.sub.LineItem
-
 ::: integrify.clopos.schemas.objects.sub.ReceiptPaymentMethod
 
+::: integrify.clopos.schemas.objects.sub.ReceiptProduct
+
 ### Helper Type
 
 ::: integrify.clopos.helpers.IsoDateTime
+
+::: integrify.clopos.helpers.BoolInt

docs/en/partial.yml

@@ -1,6 +1,6 @@
 Clopos:
-  - About: "integrations/clopos/about.md"
-  - Env Variables: "integrations/clopos/env.md"
+  - "integrations/clopos/about.md"
+  - "integrations/clopos/env.md"
   - API Reference:
     - API Client: "integrations/clopos/api-reference/client.md"
     - Schemas:

pyproject.toml

@@ -35,9 +35,7 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
     "Topic :: Internet :: WWW/HTTP",
 ]
-dependencies = [
-    "integrify-core",
-]
+dependencies = ["integrify-core"]
 
 [project.urls]
 Homepage = "https://integrify.mmzeynalli.dev/integrations/clopos/about"
@@ -67,6 +65,7 @@ dev = [
 docs = [
     "mkdocs-material[imaging]>=9.6.4,<10",
     "mkdocstrings[python]>=0.28.1,<1.0.0",
+    "mkdocs-panzoom-plugin>=0.1.3,<0.2",
     "griffe-pydantic>=1.1.0,<2",
 ]
 

src/integrify/clopos/client.py

@@ -1,6 +1,5 @@
 import os
 from enum import Enum
-from warnings import warn
 
 from integrify.utils import Environment
 
@@ -14,13 +13,6 @@
 CLOPOS_ENV: str = os.getenv('CLOPOS_ENV', Environment.TEST.value)
 
 
-if not CLOPOS_CLIENT_ID or not CLOPOS_CLIENT_SECRET:  # pragma: no cover
-    warn(
-        'If you do not set CLOPOS_CLIENT_ID and CLOPOS_CLIENT_SECRET environment variables, '
-        'the integration might not work. '
-    )
-
-
 class API(str, Enum):
     """Endpoint constant-ları"""
 

src/integrify/clopos/env.py

@@ -24,6 +24,7 @@
     GetCustomersRequest,
     GetOrdersRequest,
     GetPaginatedDataRequest,
+    GetProductByIDRequest,
     GetProductsRequest,
     GetStationsRequest,
     UpdateOrderRequest,
@@ -152,6 +153,16 @@ def post_handle_payload(self, data):
         return json.dumps(data)  # for urlencoding
 
 
+class GetProductByIDHandler(AuthedAPIPayloadHandler):
+    def __init__(
+        self,
+        req_model=GetProductByIDRequest,
+        resp_model=ObjectResponse[Product],
+        dry=False,
+    ):
+        super().__init__(req_model, resp_model, dry)
+
+
 class GetOrdersHandler(AuthedAPIPayloadHandler):
     def __init__(
         self,

src/integrify/clopos/handlers.py

@@ -1,10 +1,13 @@
 from datetime import datetime
 from typing import Annotated, Union
 
-from pydantic import BeforeValidator, Field
+from pydantic import BeforeValidator
 
 IsoDateTime = Annotated[
     Union[str, datetime, None],
-    Field(BeforeValidator(lambda v: v.isoformat() if isinstance(v, datetime) else v)),
+    BeforeValidator(lambda v: v.isoformat() if isinstance(v, datetime) else v),
 ]
 """ISO 8601 date-time format Pydantic field validator."""
+
+BoolInt = Annotated[int, BeforeValidator(lambda v: int(bool(v)))]
+"""Boolean to integer Pydantic field validator."""

src/integrify/clopos/helpers.py

@@ -13,14 +13,15 @@ class ProductType(str, Enum):
     TIMER = 'TIMER'
     PREPARATION = 'PREPARATION'
     INGREDIENT = 'INGREDIENT'
-    MODIFICATION = 'MODIFICATION '
+    MODIFICATION = 'MODIFICATION'
 
 
 class OrderStatus(str, Enum):
     IN_PROGRESS = 'IN_PROGRESS'
     PENDING = 'PENDING'
     CONFIRMED = 'CONFIRMED'
     COMPLETED = 'COMPLETED'
+    RECEIVED = 'RECEIVED'
     CANCELLED = 'CANCELLED'
     IGNORE = 'IGNORE'
 

src/integrify/clopos/schemas/enums.py

@@ -1,9 +1,9 @@
 from decimal import Decimal
-from typing import Optional
 
 from pydantic import BaseModel
 
 from integrify.clopos.helpers import IsoDateTime
+from integrify.utils import UnsetField, UnsetOrNoneField
 
 
 class PaymentMethodIn(BaseModel):
@@ -17,8 +17,39 @@ class PaymentMethodIn(BaseModel):
     """The amount of the payment method"""
 
 
-class ReceiptProductIn(BaseModel):
+class ServiceIn(BaseModel):
+    sale_type_id: int
+    sale_type_name: str
+    venue_id: int
+    venue_name: str
+
+
+class CustomerIn(BaseModel):
     id: int
+    name: str
+    customer_discount_type: UnsetField[int] = None
+    phone: UnsetField[str] = None
+    address: UnsetOrNoneField[str]
+
+
+class ProductIn(BaseModel):
+    product_id: int
+    count: int
+    product_modificators: UnsetOrNoneField[list[dict]]
+    meta: UnsetOrNoneField[dict]
+
+
+class OrderPayloadIn(BaseModel):
+    service: ServiceIn
+    customer: CustomerIn
+    products: list[ProductIn]
+    meta: UnsetOrNoneField[dict]
+
+
+class ReceiptProductIn(BaseModel):
+    model_config = {'extra': 'allow'}
+
+    id: UnsetField[int]
     """The unique identifier for the receipt product"""
 
     cid: str
@@ -27,12 +58,6 @@ class ReceiptProductIn(BaseModel):
     product_id: int
     """The ID of the product associated with the receipt product"""
 
-    receipt_id: int
-    """The ID of the receipt associated with the receipt product"""
-
-    product_hash: str
-    """The hash of the product associated with the receipt product"""
-
     meta: dict
     """The meta data of the receipt product"""
 
@@ -48,62 +73,20 @@ class ReceiptProductIn(BaseModel):
     price: Decimal
     """The price of the receipt product"""
 
-    cost: Decimal
+    cost: UnsetField[Decimal]
     """The cost of the receipt product"""
 
     is_gift: bool
     """Whether the receipt product is a gift"""
 
-    preprint_count: int
-    """The preprint count of the receipt product"""
-
-    station_printed_count: int
-    """The station printed count of the receipt product"""
-
-    station_aborted_count: int
-    """The station aborted count of the receipt product"""
-
-    seller_id: int
-    """The ID of the seller associated with the receipt product"""
-
-    loyalty_type: Optional[str]
-    """The loyalty type of the receipt product"""
-
-    loyalty_value: Optional[Decimal]
-    """The loyalty value of the receipt product"""
-
-    discount_rate: Decimal
-    """The discount rate of the receipt product"""
-
-    discount_value: Decimal
-    """The discount value of the receipt product"""
-
-    discount_type: Decimal
-    """The discount type of the receipt product"""
-
-    total_discount: Decimal
-    """The total discount of the receipt product"""
-
-    subtotal: Decimal
-    """The subtotal of the receipt product"""
-
-    receipt_discount: Decimal
-    """The receipt discount of the receipt product"""
-
-    created_at: IsoDateTime
+    created_at: UnsetField[IsoDateTime]
     """The created at of the receipt product"""
 
-    updated_at: IsoDateTime
+    updated_at: UnsetField[IsoDateTime]
     """The updated at of the receipt product"""
 
-    terminal_updated_at: IsoDateTime
+    terminal_updated_at: UnsetField[IsoDateTime]
     """The terminal updated at of the receipt product"""
 
-    deleted_at: IsoDateTime
+    deleted_at: UnsetField[IsoDateTime]
     """The deleted at of the receipt product"""
-
-    receipt_product_modificators: list
-    """The receipt product modificators of the receipt product"""
-
-    taxes: list
-    """The taxes of the receipt product"""

src/integrify/clopos/schemas/objects/input.py

@@ -4,7 +4,6 @@
 from pydantic import BaseModel, Field
 
 from integrify.clopos.schemas.enums import CategoryType, DiscountType, OrderStatus, ProductType
-from integrify.clopos.schemas.objects.input import ReceiptProductIn
 from integrify.clopos.schemas.objects.sub import (
     Balance,
     Image,
@@ -15,7 +14,7 @@
     Package,
     Price,
     ReceiptPaymentMethod,
-    Recipe,
+    ReceiptProduct,
     Tax,
     TimerSetting,
     Timestamp,
@@ -334,7 +333,7 @@ class Product(Timestamp):
     net_output: UnsetOrNoneField[int]
     """Net output of the product"""
 
-    type: ProductType
+    type: UnsetOrNoneField[ProductType]
     """product, ingredient, accounting"""
 
     name: str
@@ -361,7 +360,7 @@ class Product(Timestamp):
     cost: UnsetOrNoneField[Decimal]
     """The cost of the product"""
 
-    status: int
+    status: UnsetOrNoneField[int]
     """1 = active, 0 = inactive"""
 
     hidden: UnsetOrNoneField[bool]
@@ -394,7 +393,7 @@ class Product(Timestamp):
     modificator_groups: UnsetOrNoneField[list[ModifierGroup]]
     """List of modificator groups for GOODS type products. See Modificator Group Object"""
 
-    recipe: UnsetOrNoneField[Recipe]
+    recipe: UnsetOrNoneField[list['Product']]
     """Recipe for DISH or PREPARATION type products. See Recipe Item."""
 
     packages: UnsetOrNoneField[list[Package]]
@@ -466,10 +465,10 @@ class Product(Timestamp):
     venues: UnsetOrNoneField[list[Venue]]
     """The venues the product is available in"""
 
-    properties: UnsetOrNoneField[list[dict]]
+    properties: UnsetOrNoneField[Union[dict, list]]
     """The properties of the product"""
 
-    media: list[Media]
+    media: UnsetOrNoneField[list[Media]]
     """Media of the product"""
 
     tags: UnsetOrNoneField[list[dict]]
@@ -487,6 +486,12 @@ class Product(Timestamp):
     open_receipts_count: UnsetOrNoneField[int]
     """The number of open receipts for the product"""
 
+    created_at: UnsetOrNoneField[str]  # type: ignore[assignment]
+    """The timestamp when the object was created"""
+
+    updated_at: UnsetOrNoneField[str]  # type: ignore[assignment]
+    """The timestamp when the object was last updated"""
+
 
 class PaymentMethod(Timestamp):
     id: int
@@ -545,7 +550,7 @@ class SaleType(Timestamp):
     payment_method: UnsetOrNoneField[PaymentMethod]
     """An object containing details of the associated payment method"""
 
-    media: list[Media]
+    media: UnsetOrNoneField[list[Media]]
     """Media of the sale type"""
 
 
@@ -783,7 +788,7 @@ class Receipt(Timestamp):
     order_number: UnsetOrNoneField[str]
     """Order number"""
 
-    receipt_products: UnsetOrNoneField[list[ReceiptProductIn]] = None
+    receipt_products: UnsetOrNoneField[list[ReceiptProduct]] = None
     """Receipt products"""
 
     terminal_updated_at: UnsetOrNoneField[str]