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

shopline_sdk/apis/categories/create_category.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.category import Category
+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
+) -> Category:
+    """
+    Create Category
+    
+    To create a new category with open API
+    透過open API創造一個新的分類
+    
+    Path: POST /categories
+    """
+    # 构建请求 URL
+    url = "categories"
+
+    # 构建请求头
+    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 Category(**response_data)

shopline_sdk/apis/categories/delete_category.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.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Category
+    
+    To delete current categories with open API
+    透過open API刪除分類
+    
+    Path: DELETE /categories/{id}
+    """
+    # 构建请求 URL
+    url = f"categories/{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 == 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/categories/get_categories.py

@@ -0,0 +1,104 @@
+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.category import Category
+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 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    updated_after: Optional[str] = None
+    """Filter categories by those updated after specific time.
+      取得 updated_at 大於指定時間的分類(包含指定時間)
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter categories by those updated before specific time.
+      取得 updated_at 小於指定時間的分類(包含指定時間)
+       *Should use UTC time'"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    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
+      結果只顯示哪些參數"""
+    created_by_filter: Optional[Literal['admin', 'pos']] = None
+    """Filter categories by those created by. Default 'admin'. 
+      取得指定 created_by 的分類。預設為'admin'。"""
+    with_product_set: Optional[bool] = None
+    """Include product set in response. Default false.
+      是否在回應中包含商品集。預設為false。"""
+    include_fields: Optional[List[str]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+    category_ids: Optional[List[str]] = None
+    """The category ids to be included in the response
+      結果包含哪些分類"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Category]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Categories
+    
+    To get detailed information of couple categories sorted by time
+    利用時間範圍選取與排序獲取分類資料
+    
+    Path: GET /categories
+    """
+    # 构建请求 URL
+    url = "categories"
+
+    # 构建查询参数
+    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/categories/get_category.py

@@ -0,0 +1,76 @@
+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.category import Category
+from ...models.not_found_error import NotFoundError
+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
+      結果要排除哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Category:
+    """
+    Get Category
+    
+    To get detailed information of couple categories sorted by time
+    獲取分類資料
+    
+    Path: GET /categories/{id}
+    """
+    # 构建请求 URL
+    url = f"categories/{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 Category(**response_data)

shopline_sdk/apis/categories/update_category.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.category import Category
+from ...models.not_found_error import NotFoundError
+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
+) -> Category:
+    """
+    Update Category
+    
+    To update current categories information with open API.
+    透過open API更新既有分類資訊
+    
+    Path: PUT /categories/{id}
+    """
+    # 构建请求 URL
+    url = f"categories/{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 Category(**response_data)

shopline_sdk/apis/channels/create_product_channel_price.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.price_set import PriceSet
+
+async def call(
+    session: aiohttp.ClientSession, channel_id: str, id: str, data: Optional[Dict[str, Any]] = None
+) -> PriceSet:
+    """
+    Create Product Channel Price
+    
+    To create new product channel price
+    創建商品分店價格
+    
+    Path: POST /channels/{channel_id}/products/{id}/prices
+    """
+    # 构建请求 URL
+    url = f"channels/{channel_id}/products/{id}/prices"
+
+    # 构建请求头
+    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 PriceSet(**response_data)

shopline_sdk/apis/channels/get_channel.py

@@ -0,0 +1,76 @@
+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.channel import Channel
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    include_fields: Optional[List[Literal['e_invoice_setting', 'pin_codes']]] = None
+    """Some fields need to be specified in this parameter. Otherwise, it will not be returned.
+       有些欄位需要定義在此參數內，否則將不會返回這些欄位的值。"""
+    fields: Optional[List[Literal['items.mobile_logo_media_url']]] = None
+    """For mobile logo media, need to add items.mobile_logo_media_url to this field.
+       mobile logo media 必須加入 items.mobile_logo_media_url 到此欄位。"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Channel:
+    """
+    Get Channel
+    
+    To get detailed information for a specific channel with its ID
+    使用通路ID獲取特定一個通路的詳細資料
+    
+    Path: GET /channels/{id}
+    """
+    # 构建请求 URL
+    url = f"channels/{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 Channel(**response_data)

shopline_sdk/apis/channels/get_channels.py

@@ -0,0 +1,83 @@
+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.channels import Channels
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    belongs_to: Optional[Literal['staff', 'merchant']] = None
+    """Channels belongs to staff or merchant. Default is staff
+      網店通路或是 Staff 的通路，預設為 staff"""
+    platform: Optional[Literal['Shopee', 'shop_crm', 'online', 'pos', 'sc']] = None
+    """Filter channels by platform. It can only filter channel by sc or shop_crm if belogs_to is staff.
+       過濾通路屬於哪個平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。"""
+    platforms: Optional[List[Literal['Shopee', 'shop_crm', 'online', 'pos', 'sc']]] = None
+    """Filter multiple channels by platforms. It can only filter channel by sc or shop_crm if belogs_to is staff.
+       過濾通路屬於哪些平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。"""
+    include_fields: Optional[List[Literal['e_invoice_setting', 'pin_codes']]] = None
+    """Some fields need to be specified in this parameter. Otherwise, it will not be returned.
+       有些欄位需要定義在此參數內，否則將不會返回這些欄位的值。"""
+    fields: Optional[List[Literal['items.mobile_logo_media_url']]] = None
+    """For mobile logo media, need to add items.mobile_logo_media_url to this field.
+       mobile logo media 必須加入 items.mobile_logo_media_url 到此欄位。"""
+    page: Optional[int] = None
+    """Page number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of channels per page
+      每頁顯示資料筆數"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Channels:
+    """
+    Get Channels
+    
+    Get Channels
+    獲取 Channel 列表
+    
+    Path: GET /channels
+    """
+    # 构建请求 URL
+    url = "channels"
+
+    # 构建查询参数
+    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 Channels(**response_data)

shopline_sdk/apis/channels/get_product_channel_price.py

@@ -0,0 +1,75 @@
+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.price_sets import PriceSets
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the channel price in the previous request."""
+    limit: Optional[int] = None
+    """Numbers of PriceSet
+      顯示 n 筆商品通路價格"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> PriceSets:
+    """
+    Get Product Channel Price
+    
+    To get detailed information for product channel price with Channel ID
+    使用通路ID獲取商品通路價格
+    
+    Path: GET /channels/{id}/prices
+    """
+    # 构建请求 URL
+    url = f"channels/{id}/prices"
+
+    # 构建查询参数
+    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 PriceSets(**response_data)