shopline-sdk-python 0.1.0__py3-none-any.whl

shopline_sdk/apis/products/update_product_variation_price.py

@@ -0,0 +1,92 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.bad_request_error import BadRequestError
+from ...models.not_found_error import NotFoundError
+from ...models.product_variation import ProductVariation
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    price: Optional[float] = None
+    """Price (Note: Cannot be set to null. Product with a price of 0 cannot be sold.)
+       原價格 (備註：不能設定為null。價格為0的商品不能被售出)"""
+    price_sale: Optional[float] = None
+    """Product Sale Price
+      特價"""
+    cost: Optional[float] = None
+    """Product Cost
+      成本價"""
+    member_price: Optional[float] = None
+    """Member Price
+      會員價"""
+    retail_price: Optional[float] = None
+    """Retail Price
+      零售價"""
+    product_price_tiers: Optional[Dict[str, str]] = None
+    """Membership tier's ID
+      會員等級ID"""
+
+async def call(
+    session: aiohttp.ClientSession, product_id: str, id: str, request: Optional[Request] = None
+) -> ProductVariation:
+    """
+    Update Product Variation Price
+    
+    To update product variation's price with open API
+    透過open API 更新規格金額
+    
+    Path: PUT /products/{product_id}/variations/{id}/update_price
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/variations/{id}/update_price"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 422:
+                error_model = UnprocessableEntityError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=422,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 500:
+                error_model = ServerError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=500,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return ProductVariation(**response_data)

shopline_sdk/apis/products/update_product_variation_quantity.py

@@ -0,0 +1,111 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.bad_request_error import BadRequestError
+from ...models.not_found_error import NotFoundError
+from ...models.product_variation import ProductVariation
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    quantity: float
+    """Quantity
+      (新增/減少)商品數量
+      -
+       This value should be between -9999999 and 9999999.
+       數值必須在 -9999999 和 9999999 之間。"""
+    replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+       - 
+       true: replace the product's quantity with the number you provided
+      取代原本數量
+      
+       false: increase/decrease the quantity with the number you provided
+      增加/減少數量"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    sku: Optional[str] = None
+    quantity: Optional[float] = None
+    updated_at: Optional[str] = None
+    product_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, product_id: str, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Product Variation Quantity
+    
+    To update product variation's quantity with open API
+    透過open API 更新規格數量
+    
+    Path: PUT /products/{product_id}/variations/{id}/update_quantity
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/variations/{id}/update_quantity"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 400:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=400,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 403:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=403,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 422:
+                error_model = UnprocessableEntityError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=422,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 500:
+                error_model = ServerError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=500,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/products/update_quantity_by_sku.py

@@ -0,0 +1,114 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.bad_request_error import BadRequestError
+from ...models.gift import Gift
+from ...models.not_found_error import NotFoundError
+from ...models.product import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    sku: Optional[str] = None
+    """Product or Product Variation sku
+      商品或商品規格的商品貨號"""
+    quantity: Optional[int] = None
+    """This value should be between -9999999 and 9999999.
+       數值必須在 -9999999 和 9999999 之間。"""
+    replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+       - 
+       true: replace the product's quantity with the number you provided
+      取代原本數量
+      
+       false: increase/decrease the quantity with the number you provided
+      增加/減少數量" """
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    sku: Optional[str] = None
+    quantity: Optional[float] = None
+    updated_at: Optional[str] = None
+    product_id: Optional[str] = None
+    items: Optional[List[Dict[str, Any]]] = None
+    errors: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Quantity by SKU
+    
+    Update all products or product variations quantity by input SKU
+    更新所有相同商品貨號的商品或商品規格庫存數量
+    
+    Path: PUT /products/update_quantity
+    """
+    # 构建请求 URL
+    url = "products/update_quantity"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 400:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=400,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 403:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=403,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 422:
+                error_model = UnprocessableEntityError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=422,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 500:
+                error_model = ServerError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=500,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/products/update_stock.py

@@ -0,0 +1,89 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.not_found_error import NotFoundError
+from ...models.product_stock import ProductStock
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    warehouse_id: str
+    """Warehouse’s id
+      倉庫 id
+      -----
+      Only warehouse with status "active" can be updated
+      只有 status “active” 的 warehouse stock 的可以更新"""
+    quantity: float
+    """Quantity
+      (新增/減少)商品數量
+      
+      Negative number is allowed
+      允許更新庫存為負值"""
+    variation_id: Optional[str] = None
+    """Product Variation's id
+      若更新選項的庫存，請指定選項id"""
+    is_replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+      
+      true: replace the product's quantity with the number you provided
+      取代原本數量
+      
+      false: increase/decrease the quantity with the number you provided
+      增加/減少數量"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> ProductStock:
+    """
+    Update Stock
+    
+    To update the product's stock with its ID
+    使用商品 ID 更新商品在各個倉庫的庫存
+    
+    Path: PUT /products/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"products/{id}/stocks"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 500:
+                error_model = ServerError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=500,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return ProductStock(**response_data)

shopline_sdk/apis/promotions/create_promotion.py

@@ -0,0 +1,45 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.promotion import Promotion
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> Promotion:
+    """
+    Create Promotion
+    
+    To create detailed information of couple promotions
+    建立優惠活動
+    
+    Path: POST /promotions
+    """
+    # 构建请求 URL
+    url = "promotions"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = data if data else None
+
+    # 发起 HTTP 请求
+    async with session.post(
+        url, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Promotion(**response_data)

shopline_sdk/apis/promotions/delete_promotion.py

@@ -0,0 +1,44 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Promotion
+    
+    To delete promotion with open API
+    透過open API刪除優惠活動
+    
+    Path: DELETE /promotions/{id}
+    """
+    # 构建请求 URL
+    url = f"promotions/{id}"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.delete(
+        url, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/promotions/get_customer_coupon_promotions.py

@@ -0,0 +1,61 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.customer_coupon_promotions import CustomerCouponPromotions
+
+class Request(BaseModel):
+    """查询参数模型"""
+    promotion_ids: List[str]
+    """優惠活動 ID"""
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, request: Optional[Request] = None
+) -> CustomerCouponPromotions:
+    """
+    Get Customer Coupon Promotions
+    
+    To get customer coupon promotions with promotion_ids.
+     The API returns promotions only if the given promotions whose type are draw.
+     And it returns the promotions which are available to draw or have already been drawn.
+     It returns null if the given promotions are not available.
+    
+     使用 promotion_ids 獲取用戶優惠活動。
+     此 API 只會回傳傳入的 promotion_ids 中，類型為領取型的優惠活動，並僅回傳已領取或可領取的優惠動。
+     若傳入的 promotion_ids 中有不可領取的優惠活動，則該優惠活動會回傳 null。
+    
+    Path: GET /customers/{customer_id}/coupon_promotions
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/coupon_promotions"
+
+    # 构建查询参数
+    params = {}
+    if request:
+        request_dict = request.model_dump(exclude_none=True)
+        for key, value in request_dict.items():
+            if value is not None:
+                params[key] = value
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        url, params=params, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return CustomerCouponPromotions(**response_data)

shopline_sdk/apis/promotions/get_customer_promotions.py

@@ -0,0 +1,63 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.customer_promotion import CustomerPromotion
+
+class Request(BaseModel):
+    """查询参数模型"""
+    coupon_status: Optional[Literal['valid', 'invalid', 'comingSoon']] = None
+    """優惠券狀態"""
+    available_platforms: Optional[List[Literal['ec', 'retail']]] = None
+    """優惠券適用渠道"""
+    coupon_type: Optional[List[Literal['draw', 'single', 'multi']]] = None
+    """優惠券形式"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[CustomerPromotion]] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Customer Promotions
+    
+    To get customer promotions
+    取得用戶優惠活動
+    
+    Path: GET /customers/{customer_id}/promotions
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/promotions"
+
+    # 构建查询参数
+    params = {}
+    if request:
+        request_dict = request.model_dump(exclude_none=True)
+        for key, value in request_dict.items():
+            if value is not None:
+                params[key] = value
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        url, params=params, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/promotions/get_promotion.py

@@ -0,0 +1,60 @@
+from typing import Any, Dict, List, Optional, Union
+import aiohttp
+from pydantic import BaseModel, ValidationError, Field
+from typing_extensions import Literal
+
+# 导入异常类
+from ...exceptions import ShoplineAPIError
+
+# 导入需要的模型
+from ...models.promotion import Promotion
+
+class Request(BaseModel):
+    """查询参数模型"""
+    show_whitelisted_membership_tier: Optional[bool] = None
+    """Response whitelisted MembershipTier Data
+      回傳指定會員資料"""
+    show_summary: Optional[bool] = None
+    """Respone Promotion Summary
+      回傳優惠活動概覽"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Promotion:
+    """
+    Get Promotion
+    
+    To get detailed information for a specific promotion with its ID
+    使用優惠活動ID獲取特定一個優惠活動的詳細資料
+    
+    Path: GET /promotions/{id}
+    """
+    # 构建请求 URL
+    url = f"promotions/{id}"
+
+    # 构建查询参数
+    params = {}
+    if request:
+        request_dict = request.model_dump(exclude_none=True)
+        for key, value in request_dict.items():
+            if value is not None:
+                params[key] = value
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        url, params=params, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Promotion(**response_data)