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

shopline_sdk/__init__.py

@@ -0,0 +1,17 @@
+"""
+Shopline SDK for Python
+
+A Python SDK for interacting with the Shopline OpenAPI.
+"""
+
+__version__ = "0.1.0"
+__author__ = "Shopline"
+__description__ = "Shopline OpenAPI on python implement. (From https://open-api.docs.shoplineapp.com)"
+
+from .client import ShoplineAPIClient
+from .exceptions import *
+
+__all__ = [
+    "ShoplineAPIClient",
+    "__version__",
+]

shopline_sdk/apis/addon_products/bulk_update_addon_product_quantity_by_sku.py

@@ -0,0 +1,72 @@
+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.addon_product import AddonProduct
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    sku: Optional[str] = None
+    """Addon Product 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
+      增加/減少數量" """
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> AddonProduct:
+    """
+    Bulk Update Addon Product Quantity by SKU
+    
+    Update all add-on products quantity by input SKU
+    更新所有相同商品貨號加購品的庫存數量
+    
+    Path: PUT /addon_products/update_quantity
+    """
+    # 构建请求 URL
+    url = "addon_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 == 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 AddonProduct(**response_data)

shopline_sdk/apis/addon_products/create_addon_product.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.addon_product import AddonProduct
+from ...models.money import Money
+from ...models.translatable import Translatable
+
+
+class MainProductsItem(BaseModel):
+    """Item model for main_products"""
+    id: Optional[str] = Field(default=None, alias="_id")
+    addon_price: Optional[Money] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    title_translations: Optional[Translatable] = None
+    unlimited_quantity: Optional[bool] = None
+    sku: Optional[str] = None
+    weight: Optional[float] = None
+    media_ids: Optional[List[str]] = None
+    start_at: Optional[str] = None
+    end_at: Optional[str] = None
+    location_id: Optional[str] = None
+    tax_type: Optional[str] = None
+    oversea_tax_type: Optional[str] = None
+    product_id: Optional[str] = None
+    cost: Optional[Money] = None
+    main_products: Optional[List[MainProductsItem]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> AddonProduct:
+    """
+    Create Addon Product
+    
+    To create addon product
+    建立加購品
+    
+    Path: POST /addon_products
+    """
+    # 构建请求 URL
+    url = "addon_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
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return AddonProduct(**response_data)

shopline_sdk/apis/addon_products/get_addon_product.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.addon_product import AddonProduct
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> AddonProduct:
+    """
+    Get Addon Product
+    
+    To get detailed information for a specific addon product with its ID
+    使用加購品ID獲取特定一個商品的詳細資料
+    
+    Path: GET /addon_products/{id}
+    """
+    # 构建请求 URL
+    url = f"addon_products/{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 AddonProduct(**response_data)

shopline_sdk/apis/addon_products/get_addon_product_stocks.py

@@ -0,0 +1,66 @@
+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.stock import Stock
+from ...models.translatable import Translatable
+
+class Request(BaseModel):
+    """查询参数模型"""
+    excludes: Optional[List[str]] = None
+    """Could exclude certain parameters in the response
+      結果要排除哪些參數"""
+    fields: Optional[List[str]] = None
+    """Could only show certain parameters in the response
+      結果只顯示哪些參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    title_translations: Optional[Translatable] = None
+    stocks: Optional[List[Stock]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Addon Product Stocks
+    
+    To get stock information for a specific addon product with its ID
+     使用商品 ID 獲取特定一個加購品的庫存資料
+    
+    Path: GET /addon_products/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"addon_products/{id}/stocks"
+
+    # 构建查询参数
+    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/addon_products/get_addon_products.py

@@ -0,0 +1,84 @@
+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.addon_product import AddonProduct
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the addon products in the previous request.
+      前一筆加購品的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    include_fields: Optional[List[Literal['promotions']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+    main_product_id: Optional[str] = None
+    """Main Product ID
+      主商品ID"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AddonProduct]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Addon Products
+    
+    To get detailed information of addon products.
+    撈取加購品的詳細資訊
+    
+    Path: GET /addon_products
+    """
+    # 构建请求 URL
+    url = "addon_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/addon_products/search_addon_products.py

@@ -0,0 +1,113 @@
+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.addon_product import AddonProduct
+from ...models.paginatable import Paginatable
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the addon products in the previous request.
+      前一筆加購品的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    id: Optional[str] = None
+    """Addon Product ID
+      加購品ID"""
+    page: Optional[int] = None
+    """Page
+      頁數
+      (Default: 1)"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per page
+      每頁顯示 n 筆資料
+      (Default: 24, Max: 999)"""
+    status: Optional[Literal['active', 'draft']] = None
+    """Status
+      商品狀態"""
+    sort_by: Optional[Literal['desc', 'asc']] = None
+    """Sort by created_at"""
+    sku: Optional[str] = None
+    """SKU
+      貨物編號"""
+    quantity: Optional[str] = None
+    """Quantity
+      數量
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
+       quantity=100
+       quantity=not:100
+       quantity=lt:100
+       quantity=lte:100
+       quantity=gt:100
+       quantity=gte:100"""
+    updated_at: Optional[str] = None
+    """Update Time
+      更新時間
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
+       Example: "gt:2018-11-11 12:30:30" """
+    created_at: Optional[str] = None
+    """Created Time
+      創建時間
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
+      
+      Please fill in to the second level. Default value is 00:00:00 if only fill in dates.
+      請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00"""
+    include_fields: Optional[List[Literal['promotions']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AddonProduct]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Search Addon Products
+    
+    To search add-on products with specific conditions.
+    利用特殊條件搜尋加購品列表
+    
+    Path: GET /addon_products/search
+    """
+    # 构建请求 URL
+    url = "addon_products/search"
+
+    # 构建查询参数
+    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/addon_products/update_addon_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.addon_product import AddonProduct
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> AddonProduct:
+    """
+    Update Addon Product
+    
+    To update information about existing addon product with open API.
+    透過open API 更新加購品
+    
+    Path: PUT /addon_products/{id}
+    """
+    # 构建请求 URL
+    url = f"addon_products/{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 == 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 AddonProduct(**response_data)

shopline_sdk/apis/addon_products/update_addon_product_quantity.py

@@ -0,0 +1,96 @@
+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.addon_product import AddonProduct
+from ...models.forbidden_error import ForbiddenError
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    quantity: float
+    """Quantity
+      (新增/減少)加購品數量
+      -
+       *if replace sets as false, allows quantity to be negative number
+       如果 replace 為 false，准許 quantity 為負數"""
+    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
+) -> AddonProduct:
+    """
+    Update Addon Product Quantity
+    
+    To update quantity of add-on products with open API
+    透過open API 更新加購品數量
+    
+    Path: PUT /addon_products/{id}/update_quantity
+    """
+    # 构建请求 URL
+    url = f"addon_products/{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 == 403:
+                error_model = ForbiddenError(**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 AddonProduct(**response_data)