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

shopline_sdk/apis/flash_price_campaigns/update_flash_price_campaign.py

@@ -0,0 +1,46 @@
+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.flash_price_campaign import FlashPriceCampaign
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> FlashPriceCampaign:
+    """
+    Update Flash Price Campaign
+    
+    To update new flash price campaign
+    更新商品限時促銷價活動
+    
+    Path: PUT /flash_price_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"flash_price_campaigns/{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 FlashPriceCampaign(**response_data)

shopline_sdk/apis/gifts/bulk_update_quantity_by_sku.py

@@ -0,0 +1,106 @@
+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.bad_request_error import BadRequestError
+from ...models.gift import Gift
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    sku: str
+    """Gift's SKU
+      贈品的商品貨號"""
+    quantity: int
+    """This value should be between -9999999 and 9999999.
+       數值必須在 -9999999 和 9999999 之間。"""
+    replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    sku: Optional[str] = None
+    quantity: Optional[float] = None
+    updated_at: Optional[str] = None
+    items: Optional[List[Dict[str, Any]]] = None
+    errors: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Update Quantity by SKU
+    
+    Update all gifts quantity by input SKU
+    更新所有相同商品貨號的贈品庫存數量
+    
+    Path: PUT /gifts/update_quantity
+    """
+    # 构建请求 URL
+    url = "gifts/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 == 400:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=400,
+                    error=error_model,
+                    **error_data
+                )
+            if response.status == 403:
+                error_model = BadRequestError(**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 Response(**response_data)

shopline_sdk/apis/gifts/create_gift.py

@@ -0,0 +1,57 @@
+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.gift import Gift
+from ...models.translatable import Translatable
+
+class Request(BaseModel):
+    """请求体模型"""
+    title_translations: Optional[Translatable] = None
+    unlimited_quantity: Optional[bool] = None
+    sku: Optional[str] = None
+    weight: Optional[float] = None
+    cost: Optional[Translatable] = None
+    quantity: Optional[float] = None
+    media_ids: Optional[List[str]] = None
+    product_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Gift:
+    """
+    Create Gift
+    
+    To create gift
+    建立贈品
+    
+    Path: POST /gifts
+    """
+    # 构建请求 URL
+    url = "gifts"
+
+    # 构建请求头
+    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 Gift(**response_data)

shopline_sdk/apis/gifts/get_gift_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 Gift Stocks
+    
+    To get stock information for a specific gift with its ID
+     使用商品 ID 獲取特定一個贈品的庫存資料
+    
+    Path: GET /gifts/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"gifts/{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/gifts/get_gifts.py

@@ -0,0 +1,86 @@
+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.gift import Gift
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the gifts in the previous request. Results are returned in descending order of creation time.
+      前一筆贈品 ID，按照創建時間降冪排序返回。 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Gifts per page
+      每頁顯示 n 筆資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Gift]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Gifts
+    
+    To get detailed information of gifts.
+     撈取贈品的詳細資訊
+    
+    Path: GET /gifts
+    """
+    # 构建请求 URL
+    url = "gifts"
+
+    # 构建查询参数
+    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 Response(**response_data)

shopline_sdk/apis/gifts/search_gifts.py

@@ -0,0 +1,110 @@
+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.gift import Gift
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the gifts in the previous request.
+      前一筆贈品的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    id: Optional[str] = None
+    """Gift's ID
+      贈品 ID"""
+    page: Optional[int] = None
+    """Page Number
+      頁數（第n頁）"""
+    per_page: Optional[int] = None
+    """Numbers of Gifts per page
+      每頁顯示 n 筆資料"""
+    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
+       支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    updated_at: Optional[str] = None
+    """Updated Time
+      更新時間
+       Support equal or not equal or less than or less than or equal or greater than or greater than or equal
+       支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    created_at: Optional[str] = None
+    """Created Time
+      創建時間"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Gift]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Search Gifts
+    
+    To search gifts with specific conditions.
+    利用特殊條件搜尋贈品列表。
+    
+    Path: GET /gifts/search
+    """
+    # 构建请求 URL
+    url = "gifts/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()
+            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/gifts/update_gift.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.gift import Gift
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> Gift:
+    """
+    Update Gift
+    
+    To update information about existing gift with open API.
+    透過open API 更新贈品
+    
+    Path: PUT /gifts/{id}
+    """
+    # 构建请求 URL
+    url = f"gifts/{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 Gift(**response_data)

shopline_sdk/apis/gifts/update_gift_quantity.py

@@ -0,0 +1,100 @@
+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.forbidden_error import ForbiddenError
+from ...models.gift import Gift
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    quantity: Optional[float] = None
+    """Quantity
+      (新增/減少)贈品數量"""
+    replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+      -
+       true: replace the quantity with the number you provided
+      取代原本數量
+      
+       false: increase/decrease the quantity with the number you provided
+      增加/減少數量"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    sku: Optional[str] = None
+    quantity: Optional[float] = None
+    updated_at: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Gift Quantity
+    
+    To update quantity of gifts with open API
+    透過open API 更新贈品數量
+    
+    Path: PUT /gifts/{id}/update_quantity
+    """
+    # 构建请求 URL
+    url = f"gifts/{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 Response(**response_data)