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

shopline_sdk/apis/products/bulk_update_stock.py

@@ -0,0 +1,81 @@
+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.product import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    bulk_data: Optional[List[Any]] = None
+    """Product, Product Variation's ID and warehouse ID, 
+      商品、商品規格、贈品或加購品的商品貨號"""
+    is_replace: bool
+    """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):
+    """响应体模型"""
+    errors: Optional[List[Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Update Stock
+    
+    To update the mutiple product's stock with its ID
+    使用多個商品 ID 更新商品在各個倉庫的庫存
+    
+    Path: PUT /products/bulk_update_stocks
+    """
+    # 构建请求 URL
+    url = "products/bulk_update_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 == 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/bulkpublish_unpublishproductinonlinestore.py

@@ -0,0 +1,64 @@
+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.status import status
+
+
+class ProductsItem(BaseModel):
+    """Item model for products"""
+    id: Optional[str] = None
+    """The id of the product that will be published/unpublished.
+       Max delete 100 products at a time.
+       需要上架/下架的商品id，每次最多只能上架/下架100個商品。"""
+    status: Optional[status] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    products: Optional[List[ProductsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    updated_product_ids: Optional[List[str]] = None
+    errors: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Publish/Unpublish Product in Online Store
+    
+    To bulk publish/unpublish products in Online Store.
+     在網店批量上架/下架商品。
+    
+    Path: PUT /products/status/bulk
+    """
+    # 构建请求 URL
+    url = "products/status/bulk"
+
+    # 构建请求头
+    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()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/products/bulkpublish_unpublishproductinretailstore.py

@@ -0,0 +1,64 @@
+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.retail_status import retail_status
+
+
+class ProductsItem(BaseModel):
+    """Item model for products"""
+    id: Optional[str] = None
+    """The id of the product that will be published/unpublished.
+       Max delete 100 products at a time.
+       需要上架/下架的商品id，每次最多只能上架/下架100個商品。"""
+    retail_status: Optional[retail_status] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    products: Optional[List[ProductsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    updated_product_ids: Optional[List[str]] = None
+    errors: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Publish/Unpublish Product in Retail Store
+    
+    To bulk publish/unpublish products in Retail Store.
+     在實體店批量上架/下架商品。
+    
+    Path: PUT /products/retail_status/bulk
+    """
+    # 构建请求 URL
+    url = "products/retail_status/bulk"
+
+    # 构建请求头
+    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()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/products/create_product.py

@@ -0,0 +1,54 @@
+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.product import Product
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> Product:
+    """
+    Create Product
+    
+    To create new products with open API
+    透過open API創建新商品
+    
+    Path: POST /products
+    """
+    # 构建请求 URL
+    url = "products"
+
+    # 构建请求头
+    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()
+            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 Product(**response_data)

shopline_sdk/apis/products/create_product_variation.py

@@ -0,0 +1,70 @@
+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 import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+async def call(
+    session: aiohttp.ClientSession, product_id: str, data: Optional[Dict[str, Any]] = None
+) -> Product:
+    """
+    Create Product Variation
+    
+    Add a variation product under an existing main product.
+    在現有主商品之下新增規格商品
+    
+    Path: POST /products/{product_id}/variations
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/variations"
+
+    # 构建请求头
+    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()
+            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 Product(**response_data)

shopline_sdk/apis/products/delete_product.py

@@ -0,0 +1,70 @@
+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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Product
+    
+    To delete a product with open API
+    透過Open API刪除商品
+    
+    Path: DELETE /products/{id}
+    """
+    # 构建请求 URL
+    url = f"products/{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()
+            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/delete_product_images.py

@@ -0,0 +1,54 @@
+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 Request(BaseModel):
+    """请求体模型"""
+    media_ids: Optional[List[str]] = None
+    """Ids of the Images
+      需要被刪除圖片的IDs"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Delete Product Images
+    
+    To delete product images with open API
+    透過open API刪除主商品圖片/商品資訊圖片
+    
+    
+    Path: DELETE /products/{id}/delete_images
+    """
+    # 构建请求 URL
+    url = f"products/{id}/delete_images"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.delete(
+        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 Response(**response_data)

shopline_sdk/apis/products/delete_product_variation.py

@@ -0,0 +1,70 @@
+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.server_error import ServerError
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, product_id: str, id: str
+) -> Response:
+    """
+    Delete Product Variation
+    
+    To delete a product variation with open API
+    透過Open API刪除規格商品
+    
+    Path: DELETE /products/{product_id}/variations/{id}
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/variations/{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()
+            if response.status == 400:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=400,
+                    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 == 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/get_locked_inventory_count.py

@@ -0,0 +1,53 @@
+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 Request(BaseModel):
+    """请求体模型"""
+    product_ids: Optional[List[Any]] = None
+    """Product IDs
+      商品ID
+      (Max: 1000)"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Locked Inventory Count
+    
+    Get Locked Inventory Count
+    取得直播保留庫存數字
+    
+    Path: POST /products/locked_inventory_count
+    """
+    # 构建请求 URL
+    url = "products/locked_inventory_count"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request 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 Response(**response_data)

shopline_sdk/apis/products/get_product.py

@@ -0,0 +1,79 @@
+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 import Product
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    fields: Optional[List[str]] = None
+    """Could only show certain parameters in the response
+      結果只顯示哪些參數"""
+    excludes: Optional[List[str]] = None
+    """Could exclude certain parameters in the response
+      結果要排除哪些參數"""
+    include_fields: Optional[List[Literal['labels']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Product:
+    """
+    Get Product
+    
+    To get detailed information for a specific product with its ID
+    使用商品ID獲取特定一個商品的詳細資料
+    
+    Path: GET /products/{id}
+    """
+    # 构建请求 URL
+    url = f"products/{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()
+            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 Product(**response_data)