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

shopline_sdk/apis/return_orders/create_return_order.py

@@ -0,0 +1,62 @@
+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.return_order import ReturnOrder
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> ReturnOrder:
+    """
+    Create return order
+    
+    To create a return order
+    創建一個退貨單
+    
+    Path: POST /return_orders
+    """
+    # 构建请求 URL
+    url = "return_orders"
+
+    # 构建请求头
+    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 == 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 ReturnOrder(**response_data)

shopline_sdk/apis/return_orders/get_return_order.py

@@ -0,0 +1,42 @@
+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.return_order import ReturnOrder
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> ReturnOrder:
+    """
+    Get return order
+    
+    To retrieve a specific return order by id
+    以id獲取一個退貨單
+    
+    Path: GET /return_orders/{id}
+    """
+    # 构建请求 URL
+    url = f"return_orders/{id}"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        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 ReturnOrder(**response_data)

shopline_sdk/apis/return_orders/get_return_orders.py

@@ -0,0 +1,95 @@
+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.return_orders import ReturnOrders
+
+class Request(BaseModel):
+    """查询参数模型"""
+    order_id: Optional[str] = None
+    """Order ID, the other parameters will be ineffective if passed.
+       訂單ID, 如果傳了其他參數將會失效"""
+    updated_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 updated_at 大於指定時間的退貨單(包含指定時間)
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 updated_at 小於指定時間的退貨單(包含指定時間)
+       *Should use UTC time'"""
+    created_after: Optional[str] = None
+    """Filter data by those created after specific time.
+       取得 created_at 大於指定時間的退貨單(包含指定時間)
+       *Should use UTC time'"""
+    created_before: Optional[str] = None
+    """Filter data by those created before specific time.
+       取得 created_at 小於指定時間的退貨單(包含指定時間)
+       *Should use UTC time'"""
+    status_filter: Optional[Literal['pending', 'confirmed', 'completed', 'cancelled']] = None
+    """Order Status
+      退货訂單狀態"""
+    payment_status_filter: Optional[Literal['pending', 'refunded']] = None
+    """Order payment status
+      訂單退款狀態"""
+    delivery_status_filter: Optional[Literal['return_collected', 'returning']] = None
+    """Order delivery status
+      訂單退貨狀態"""
+    inspect_status_filter: Optional[Literal['pending', 'inspected']] = None
+    """Order inspect status
+      驗貨狀態"""
+    query: Optional[str] = None
+    """Query
+      用於搜索退貨單，可搜索的字段有: "customer_phone", "customer_name", "customer_email", "delivery_data.recipient_name", "delivery_address.recipient_name", "tracking_number", "delivery_data.recipient_phone", "return_order_number" """
+    per_page: Optional[int] = None
+    """Numbers of Return Orders per Page
+      每頁顯示 n 筆資料"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    previous_id: Optional[str] = None
+    """前一筆退貨單 ID"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> ReturnOrders:
+    """
+    Get return orders
+    
+    To retrieve return order list
+    獲取退貨單列表
+    
+    Path: GET /return_orders
+    """
+    # 构建请求 URL
+    url = "return_orders"
+
+    # 构建查询参数
+    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 ReturnOrders(**response_data)

shopline_sdk/apis/return_orders/update_return_order.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.return_order import ReturnOrder
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> ReturnOrder:
+    """
+    Update return order
+    
+    To update a return order
+    更新一個退貨單
+    
+    Path: PUT /return_orders/{id}
+    """
+    # 构建请求 URL
+    url = f"return_orders/{id}"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = data if data 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 ReturnOrder(**response_data)

shopline_sdk/apis/sales/create_sale_products.py

@@ -0,0 +1,78 @@
+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.sale_product import SaleProduct
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+
+class ProductsItem(BaseModel):
+    """Item model for products"""
+    product_id: str
+    custom_numbers: Optional[List[str]] = None
+    custom_keys: Optional[List[str]] = None
+    variations: Optional[List[Dict[str, Any]]] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    products: List[ProductsItem]
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[SaleProduct]] = None
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Create sale products
+    
+    To create sale products
+    新增直播商品
+    
+    Path: POST /sales/{saleId}/products
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/products"
+
+    # 构建请求头
+    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()
+            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/sales/delete_sale_products.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 Request(BaseModel):
+    """请求体模型"""
+    product_ids: List[str]
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, request: Optional[Request] = None
+) -> str:
+    """
+    Delete sale products
+    
+    To delete sale products
+    刪除直播商品
+    
+    Path: POST /sales/{saleId}/delete_products
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/delete_products"
+
+    # 构建请求头
+    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
+            )
+        # 返回文本响应
+        return await response.text()

shopline_sdk/apis/sales/get_sale_comments.py

@@ -0,0 +1,77 @@
+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.cursor_based_paginatable import CursorBasedPaginatable
+from ...models.sale_comment import SaleComment
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    platform: Optional[List[Literal['FB_GROUP', 'FACEBOOK', 'INSTAGRAM', 'SHOPLINE', 'LINE']]] = None
+    """Get comments of the specified platform
+      獲取指定渠道的留言，不填則默認所有渠道"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    previous_id: Optional[str] = None
+    """The last ID of the comments in the previous request."""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[SaleComment]] = None
+    last_id: Optional[str] = None
+    limit: Optional[int] = None
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get sale comments
+    
+    To get sale comments
+    取得直播間的評論消息
+    
+    Path: GET /sales/{saleId}/comments
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/comments"
+
+    # 构建查询参数
+    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 == 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/sales/get_sale_customers.py

@@ -0,0 +1,69 @@
+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.sale_customer import SaleCustomer
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    post_sales_user_ids: List[str]
+    """The ID of the customer in the live room
+      直播間中顧客的 ID"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[SaleCustomer]] = None
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get sale customers
+    
+    To get sale customers
+    取得直播間顧客的信息
+    
+    Path: GET /sales/{saleId}/customers
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/customers"
+
+    # 构建查询参数
+    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 == 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/sales/get_sale_products.py

@@ -0,0 +1,74 @@
+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.paginatable import Paginatable
+from ...models.sale_product import SaleProduct
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[SaleProduct]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get sale products
+    
+    To get sale products
+    取得直播商品
+    
+    Path: GET /sales/{saleId}/products
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/products"
+
+    # 构建查询参数
+    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 == 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/sales/update_sale_product_status.py

@@ -0,0 +1,71 @@
+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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    status: Literal['INTRODUCING', 'DISPLAYING', 'HIDDEN']
+    """Product status in live room
+      商品在直播間中的狀態"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, saleId: str, spuId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update sale product status
+    
+    To update sale product status
+    更新直播間商品狀態
+    
+    Path: PUT /sales/{saleId}/products/{spuId}/status
+    """
+    # 构建请求 URL
+    url = f"sales/{saleId}/products/{spuId}/status"
+
+    # 构建请求头
+    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)