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

shopline_sdk/models/wish_list_item.py

@@ -0,0 +1,41 @@
+"""Shopline API 数据模型 - WishListItem"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .product import Product
+from .product_variation import ProductVariation
+from .translatable import Translatable
+
+
+
+class ProductConfig(BaseModel):
+    """Configuration model for product"""
+    id: Optional[str] = None
+    title_translations: Optional[Translatable] = None
+    field_titles: Optional[List[Dict[str, Any]]] = None
+    price: Optional[Money] = None
+    price_sale: Optional[Money] = None
+    hide_price: Optional[bool] = None
+    same_price: Optional[bool] = None
+    lowest_price: Optional[Money] = None
+    max_order_quantity: Optional[int] = None
+    status: Optional[Literal['active', 'draft', 'removed', 'hidden']] = None
+    sku: Optional[str] = None
+    flash_price_sets: Optional[List[Dict[str, Any]]] = None
+    member_price: Optional[Money] = None
+    unlimited_quantity: Optional[bool] = None
+    quantity: Optional[float] = None
+    available_start_time: Optional[str] = None
+    available_end_time: Optional[str] = None
+    variation: Optional[ProductVariation] = None
+
+class WishListItem(BaseModel):
+    id: Optional[str] = None
+    """Wish list item ID."""
+    product: Optional[ProductConfig] = None
+    variation_key: Optional[str] = None
+    """Variation key. Variation 的 key   If this wish list item is not a variation, the variation_key will be an empty string.  如果此 item 是一般商品不是規格，則 variation_key 會是空字串"""

shopline_sdk/models/wish_list_items.py

@@ -0,0 +1,15 @@
+"""Shopline API 数据模型 - WishListItems"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .cursor_based_paginatable import CursorBasedPaginatable
+from .wish_list_item import WishListItem
+
+
+class WishListItems(BaseModel):
+    last_id: Optional[str] = None
+    limit: Optional[int] = None
+    items: Optional[List[WishListItem]] = None

shopline_sdk_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: shopline-sdk-python
+Version: 0.1.0
+Summary: Shopline OpenAPI on python implement. (From https://open-api.docs.shoplineapp.com)
+Author-email: HsOjo <1134031392@qq.com>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/hsojo/shopline-sdk-python
+Project-URL: Documentation, https://open-api.docs.shoplineapp.com
+Project-URL: Repository, https://github.com/hsojo/shopline-sdk-python
+Project-URL: Bug Tracker, https://github.com/hsojo/shopline-sdk-python/issues
+Keywords: shopline,api,sdk,ecommerce
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.13.2
+Requires-Dist: pydantic>=2.12.3
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Dynamic: license-file
+
+# Shopline SDK for Python
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-GPL--3.0-green.svg)](LICENSE)
+[![PyPI Version](https://img.shields.io/badge/pypi-0.1.0-orange.svg)](https://pypi.org/project/shopline-sdk-python/)
+
+一个用于与 Shopline OpenAPI 交互的 Python SDK。基于 [Shopline OpenAPI 文档](https://open-api.docs.shoplineapp.com) 实现。
+
+## 特性
+
+- 🚀 **异步支持**: 基于 `aiohttp` 的异步 HTTP 客户端
+- 📝 **类型安全**: 使用 `pydantic` 进行数据验证和类型提示
+- 🛡️ **错误处理**: 完善的异常处理机制
+- 📚 **完整覆盖**: 支持 Shopline OpenAPI 的所有端点
+- 🔧 **易于使用**: 简洁的 API 设计，易于集成
+
+## 安装
+
+```bash
+pip install shopline-sdk-python
+```
+
+或者使用 uv：
+
+```bash
+uv add shopline-sdk-python
+```
+
+## 快速开始
+
+### 基本用法
+
+```python
+import asyncio
+import os
+from shopline_sdk.client import ShoplineAPIClient
+from shopline_sdk.apis.customers import get_customers
+
+async def main():
+    # 创建客户端
+    client = ShoplineAPIClient(os.getenv('SHOPLINE_ACCESS_TOKEN'))
+    
+    # 使用客户端会话
+    async with client.new_session() as session:
+        # 调用 API
+        response = await get_customers.call(session, get_customers.Request())
+        print(f"获取到 {len(response.items)} 个客户")
+
+# 运行异步函数
+asyncio.run(main())
+```
+
+### 带参数的 API 调用
+
+```python
+import asyncio
+from shopline_sdk.client import ShoplineAPIClient
+from shopline_sdk.apis.customers import get_customers
+
+async def get_recent_customers():
+    client = ShoplineAPIClient(os.getenv('SHOPLINE_ACCESS_TOKEN'))
+    
+    async with client.new_session() as session:
+        # 创建请求参数
+        request = get_customers.Request(
+            page=1,
+            per_page=10,
+            sort_by='desc',
+            include_fields=['metafields']
+        )
+        
+        # 调用 API
+        response = await get_customers.call(session, request)
+        
+        for customer in response.items:
+            print(f"客户: {customer.email}")
+
+asyncio.run(get_recent_customers())
+```
+
+### 创建资源示例
+
+```python
+import asyncio
+from shopline_sdk.client import ShoplineAPIClient
+from shopline_sdk.apis.addon_products import create_addon_product
+from shopline_sdk.models.money import Money
+from shopline_sdk.models.translatable import Translatable
+
+async def create_addon():
+    client = ShoplineAPIClient(os.getenv('SHOPLINE_ACCESS_TOKEN'))
+    
+    async with client.new_session() as session:
+        # 创建加购品请求
+        request = create_addon_product.Request(
+            title_translations=Translatable(
+                zh_tw="加購商品",
+                en="Addon Product"
+            ),
+            sku="ADDON-001",
+            unlimited_quantity=True,
+            cost=Money(amount="10.00", currency="USD")
+        )
+        
+        # 调用 API
+        addon_product = await create_addon_product.call(session, request)
+        print(f"创建的加购品 ID: {addon_product.id}")
+
+asyncio.run(create_addon())
+```
+
+## API 覆盖
+
+SDK 支持 Shopline OpenAPI 的所有主要功能模块：
+
+### 客户管理
+- 获取客户列表
+- 创建、更新、删除客户
+- 客户标签管理
+- 会员积分管理
+- 客户元数据管理
+
+### 产品管理
+- 产品 CRUD 操作
+- 产品变体管理
+- 库存管理
+- 加购品管理
+- 产品元数据管理
+
+### 订单管理
+- 订单查询和管理
+- 订单配送管理
+- 订单元数据管理
+
+### 营销工具
+- 促销活动管理
+- 联盟营销
+- 优惠券管理
+- 会员等级管理
+
+### 其他功能
+- 分类管理
+- 媒体文件管理
+- 主题设置
+- 批量操作
+
+## 错误处理
+
+SDK 提供了完善的错误处理机制：
+
+```python
+from shopline_sdk.exceptions import ShoplineAPIError
+
+async def handle_errors():
+    client = ShoplineAPIClient("invalid_token")
+    
+    try:
+        async with client.new_session() as session:
+            response = await get_customers.call(session)
+    except ShoplineAPIError as e:
+        print(f"API 错误: {e.status_code} - {e.message}")
+        print(f"错误代码: {e.code}")
+        if e.error:
+            print(f"详细错误: {e.error}")
+```
+
+## 配置
+
+### 环境变量
+
+建议使用环境变量来管理敏感信息：
+
+```bash
+export SHOPLINE_ACCESS_TOKEN="your_access_token_here"
+```
+
+### 自定义基础 URL
+
+```python
+client = ShoplineAPIClient(
+    access_token="your_token",
+    base_url="https://custom-api.shopline.io/v1"
+)
+```
+
+### 自定义请求头
+
+```python
+async with client.new_session(headers={"Custom-Header": "value"}) as session:
+    # 使用自定义请求头
+    response = await get_customers.call(session)
+```
+
+## 开发
+
+### 安装开发依赖
+
+```bash
+pip install -e ".[dev]"
+```
+
+### 运行测试
+
+```bash
+pytest
+```
+
+### 构建包
+
+```bash
+python -m build
+```
+
+## 许可证
+
+本项目采用 GPL-3.0 许可证。详见 [LICENSE](LICENSE) 文件。
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 链接
+
+- [Shopline OpenAPI 文档](https://open-api.docs.shoplineapp.com)
+- [GitHub 仓库](https://github.com/hsojo/shopline-sdk-python)
+- [PyPI 包](https://pypi.org/project/shopline-sdk-python/)
+
+## 更新日志
+
+### v0.1.0
+- 初始版本发布
+- 支持所有 Shopline OpenAPI 端点
+- 异步客户端实现