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

shopline_sdk/apis/webhooks/create_webhook.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.webhook import Webhook
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> Webhook:
+    """
+    Create Webhook
+    
+    To create a webhook
+    創建一個webhook
+    
+    Path: POST /webhooks
+    """
+    # 构建请求 URL
+    url = "webhooks"
+
+    # 构建请求头
+    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 Webhook(**response_data)

shopline_sdk/apis/webhooks/delete_webhook.py

@@ -0,0 +1,37 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> str:
+    """
+    Delete Webhook
+    
+    To delete a specific subscribed webhook by id
+    以id刪除一個已訂閱的webhook
+    
+    Path: DELETE /webhooks/{id}
+    """
+    # 构建请求 URL
+    url = f"webhooks/{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
+            )
+        # 返回文本响应
+        return await response.text()

shopline_sdk/apis/webhooks/get_webhook.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.webhook import Webhook
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Webhook:
+    """
+    Get Webhook
+    
+    To retrieve a specific subscribed webhook by id
+    以id獲取一個已訂閱的webhook
+    
+    Path: GET /webhooks/{id}
+    """
+    # 构建请求 URL
+    url = f"webhooks/{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 Webhook(**response_data)

shopline_sdk/apis/webhooks/get_webhooks.py

@@ -0,0 +1,59 @@
+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.webhooks import Webhooks
+
+class Request(BaseModel):
+    """查询参数模型"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Webhooks:
+    """
+    Get Webhooks
+    
+    To retrieve subscribed webhooks
+    獲取已訂閱的webhook
+    
+    Path: GET /webhooks
+    """
+    # 构建请求 URL
+    url = "webhooks"
+
+    # 构建查询参数
+    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 Webhooks(**response_data)

shopline_sdk/apis/webhooks/update_webhook.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.webhook import Webhook
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> Webhook:
+    """
+    Update Webhook
+    
+    To update a specific subscribed webhook by id
+    以id更新一個已訂閱的webhook
+    
+    Path: PUT /webhooks/{id}
+    """
+    # 构建请求 URL
+    url = f"webhooks/{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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Webhook(**response_data)

shopline_sdk/apis/wish_list_items/create_wish_list_item.py

@@ -0,0 +1,68 @@
+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 Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    customer_id: Optional[str] = None
+    product_id: Optional[str] = None
+    variation_key: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> Response:
+    """
+    Create Wish List Item
+    
+    To create wish list item
+    創建追蹤清單
+    
+    Path: POST /wish_list_items
+    """
+    # 构建请求 URL
+    url = "wish_list_items"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/wish_list_items/delete_wish_list_item.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    id: Optional[str] = None
+    """Wish List Item ID
+      追蹤清單項目ID"""
+    customer_id: Optional[str] = None
+    """Customer ID
+      顧客 ID"""
+    product_id: Optional[str] = None
+    """Product ID
+      商品ID"""
+    variation_key: Optional[str] = None
+    """Product's variation's key
+      商品規格key
+       If product does not have variations, please set to empty string.
+      若商品無規格，請填入空字串"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Delete Wish List Item
+    
+    To delete wish list item with open API
+    刪除追蹤清單
+    
+    Path: DELETE /wish_list_items
+    """
+    # 构建请求 URL
+    url = "wish_list_items"
+
+    # 构建查询参数
+    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.delete(
+        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 == 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_data

shopline_sdk/apis/wish_list_items/get_wish_list_items.py

@@ -0,0 +1,88 @@
+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
+from ...models.wish_list_items import WishListItems
+
+class Request(BaseModel):
+    """查询参数模型"""
+    customer_id: str
+    """The ID of the customer.
+      顧客 ID"""
+    previous_id: Optional[str] = None
+    """The last ID of the wish list item in the previous request.
+       上一次請求的最後一筆 wish list item 的 ID"""
+    limit: Optional[int] = None
+    """Numbers of result
+      顯示 n 筆結果"""
+    simplified: Optional[bool] = None
+    """Is response simplified
+      是否簡化回傳結果"""
+    product_ids: Optional[List[str]] = None
+    """Product IDs
+      指定商品ID"""
+    order_by: Optional[Literal['desc', 'asc']] = None
+    """Specify the sorting order based on the created_at field as either asc or desc.
+       依照 created_at 欄位指定排序方式為升冪或降冪"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> WishListItems:
+    """
+    Get wish list items
+    
+    To get wish list items.
+    獲取追蹤清單。
+    
+    Path: GET /wish_list_items
+    """
+    # 构建请求 URL
+    url = "wish_list_items"
+
+    # 构建查询参数
+    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 == 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 WishListItems(**response_data)

shopline_sdk/client.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+import aiohttp
+
+
+class ShoplineAPIClient:
+    def __init__(self, access_token, base_url='https://open.shopline.io/v1'):
+        self.base_url = base_url.rstrip('/') + '/'
+        self.access_token = access_token
+
+    def new_session(self, headers: Optional[dict] = None, **kwargs):
+        authed_headers = {'Authorization': f'Bearer {self.access_token}'}
+        if headers:
+            authed_headers.update(headers)
+        return aiohttp.ClientSession(base_url=self.base_url, headers=authed_headers, **kwargs)

shopline_sdk/exceptions.py

@@ -0,0 +1,48 @@
+"""
+Shopline SDK 异常类
+"""
+
+from typing import Any, Optional
+from pydantic import BaseModel
+
+
+class ShoplineAPIError(Exception):
+    """Shopline API 错误异常"""
+    
+    def __init__(
+        self, 
+        code: str = "UNKNOWN", 
+        message: str = "Unknown error", 
+        status_code: int = 500,
+        error: Optional[BaseModel] = None,
+        **kwargs
+    ):
+        """
+        初始化 Shopline API 错误
+        
+        Args:
+            code: 错误代码
+            message: 错误消息
+            status_code: HTTP 状态码
+            error: 错误响应模型实例
+            **kwargs: 其他错误数据
+        """
+        self.code = code
+        self.message = message
+        self.status_code = status_code
+        self.error = error
+        
+        # 存储额外的错误数据
+        for key, value in kwargs.items():
+            setattr(self, key, value)
+        
+        super().__init__(f"[{code}] {message}")
+    
+    def __str__(self) -> str:
+        return f"ShoplineAPIError({self.status_code}): [{self.code}] {self.message}"
+    
+    def __repr__(self) -> str:
+        return (
+            f"ShoplineAPIError(code='{self.code}', message='{self.message}', "
+            f"status_code={self.status_code}, error={self.error})"
+        )

shopline_sdk/helper.py

@@ -0,0 +1,84 @@
+import hashlib
+import hmac
+import json
+from typing import Any, Dict
+
+
+def _sort_dict_by_keys(obj: Any) -> Any:
+    """
+    递归地对字典按键排序
+    
+    Args:
+        obj: 需要排序的对象，可以是dict、list或其他类型
+    
+    Returns:
+        排序后的对象
+    """
+    if isinstance(obj, dict):
+        # 对字典按键排序，并递归处理嵌套的字典和列表
+        sorted_dict = {}
+        for key in sorted(obj.keys()):
+            sorted_dict[key] = _sort_dict_by_keys(obj[key])
+        return sorted_dict
+    elif isinstance(obj, list):
+        # 对列表中的每个元素递归处理
+        return [_sort_dict_by_keys(item) for item in obj]
+    else:
+        # 其他类型直接返回
+        return obj
+
+
+def _serialize_payload(payload: Dict[str, Any]) -> str:
+    """
+    序列化payload，确保排序和格式与SHOPLINE一致
+    
+    Args:
+        payload: 需要序列化的payload
+    
+    Returns:
+        序列化后的字符串
+    """
+    # 按键排序
+    sorted_payload = _sort_dict_by_keys(payload)
+
+    # 序列化为JSON字符串，确保没有多余的空格
+    # separators参数确保紧凑格式，与SHOPLINE保持一致
+    return json.dumps(sorted_payload, separators=(',', ':'), ensure_ascii=False)
+
+
+def verify_webhook_request(payload: Dict[str, Any], signature: str, secret: str, timestamp: str) -> bool:
+    """
+    Webhook 请求验签（根据SHOPLINE最新文档实现）
+    
+    根据SHOPLINE最新文档实现的验签方法：
+    1. 获取timestamp和payload
+    2. 对payload按键排序
+    3. 序列化payload
+    4. 组合message: timestamp + ":" + serialized_payload
+    5. 使用HMAC-SHA256生成签名
+    6. 与提供的签名比较
+    
+    Args:
+        payload: 请求体解析后的JSON对象
+        signature: 查询参数中的签名
+        secret: 应用密钥
+        timestamp: 请求头中的timestamp
+    
+    Returns:
+        bool: 验签是否成功
+    """
+    if not secret or not signature or not timestamp:
+        return False
+
+    # 序列化payload
+    serialized_payload = _serialize_payload(payload)
+
+    # 组合message
+    message = f"{timestamp}:{serialized_payload}"
+
+    # 生成签名
+    mac = hmac.new(secret.encode('utf-8'), message.encode('utf-8'), hashlib.sha256)
+    expected_signature = mac.hexdigest()
+
+    # 比较签名（不区分大小写）
+    return expected_signature.lower() == signature.lower()