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

shopline_sdk/apis/addon_products/update_addon_product_stock.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.not_found_error import NotFoundError
+from ...models.product_stock import ProductStock
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    warehouse_id: str
+    """Warehouse’s id
+      倉庫 id
+      -----
+      Only warehouse with status "active" can be updated
+      只有 status “active” 的 warehouse stock 的可以更新"""
+    quantity: float
+    """Quantity
+      (新增/減少)商品數量
+      
+      Negative number is allowed
+      允許更新庫存為負值"""
+    is_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
+) -> ProductStock:
+    """
+    Update Addon Product Stock
+    
+    To update the addon product stock with its ID
+     使用商品 ID 更新加購品在各個倉庫的庫存
+    
+    Path: PUT /addon_products/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"addon_products/{id}/stocks"
+
+    # 构建请求头
+    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 == 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 ProductStock(**response_data)

shopline_sdk/apis/affiliate_campaigns/create_affiliate_campaign.py

@@ -0,0 +1,109 @@
+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.affiliate_campaign import AffiliateCampaign
+from ...models.campaign_product import CampaignProduct
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    name: str
+    """Affiliate Campaign Name
+      推薦活動名稱"""
+    reward_type: Optional[str] = None
+    """Reward type
+      訂單回饋類型"""
+    promotion_id: Optional[str] = None
+    """Promotion Id
+      套用優惠折扣 ID"""
+    code: str
+    """Affiliate code
+      推薦代碼"""
+    start_at: Optional[str] = None
+    """Affiliate campaign start time
+      推薦活動開始時間
+      -
+      *UTC Time"""
+    end_at: Optional[str] = None
+    """Affiliate campaign end time
+      推薦活動結束時間
+      -
+      *UTC Time"""
+    remarks_translations: Optional[Dict[str, Any]] = None
+    """Remarks translations
+      顯示於 KOL Hub 的條款說明"""
+    apply_on: Optional[Literal['order', 'product']] = None
+    """Apply on order or product
+      套用於訂單或商品"""
+    apply_method: Optional[Literal['all', 'product']] = None
+    """Apply method
+       套用方式:
+       - all: 全部
+       - item: 逐筆設定"""
+    affiliate_percentage: Optional[float] = None
+    """Affiliate percentage
+      分潤百分比"""
+    affiliate_amount: Optional[Dict[str, Any]] = None
+    """Affiliate amount
+      分潤固定金額"""
+    condition_min_amount: Optional[Dict[str, Any]] = None
+    """The threshold amount (for order level)
+      門檻金額 (for order level)"""
+    campaign_products: Optional[List[CampaignProduct]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> AffiliateCampaign:
+    """
+    Create Affiliate Campaign
+    
+    To create affiliate campaign.
+    建立推薦活動。
+    
+    Path: POST /affiliate_campaigns
+    """
+    # 构建请求 URL
+    url = "affiliate_campaigns"
+
+    # 构建请求头
+    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()
+            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 AffiliateCampaign(**response_data)

shopline_sdk/apis/affiliate_campaigns/delete_affiliate_campaign.py

@@ -0,0 +1,44 @@
+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
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Affiliate Campaign
+    
+    To delete affiliate campaign.
+    刪除推薦活動。
+    
+    Path: DELETE /affiliate_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{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
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/affiliate_campaigns/export_affiliate_campaign_report_to_partner.py

@@ -0,0 +1,60 @@
+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
+
+class Request(BaseModel):
+    """查询参数模型"""
+    locale_code: Optional[str] = None
+    """Partner Locale Code"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> None:
+    """
+    Export Affiliate Campaign Report to Partner
+    
+    Send Affiliate Campaign to Partner
+    
+    Path: POST /affiliate_campaigns/{id}/export_report
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{id}/export_report"
+
+    # 构建查询参数
+    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.post(
+        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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        # 无响应体，返回 None
+        return None

shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign.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.affiliate_campaign import AffiliateCampaign
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> AffiliateCampaign:
+    """
+    Get Affiliate Campaign
+    
+    To get affiliate campaign.
+    獲取推薦活動。
+    
+    Path: GET /affiliate_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{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()
+            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 AffiliateCampaign(**response_data)

shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign_orders.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.affiliate_campaign_orders import AffiliateCampaignOrders
+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 orders in the previous request."""
+    limit: Optional[int] = None
+    """Numbers of Orders
+      顯示 n 筆訂單"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> AffiliateCampaignOrders:
+    """
+    Get Affiliate Campaign Orders
+    
+    To get affiliate campaign order.
+    獲取使用特定推薦活動代碼的訂單。
+    
+    Path: GET /affiliate_campaigns/{id}/orders
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{id}/orders"
+
+    # 构建查询参数
+    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 AffiliateCampaignOrders(**response_data)

shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaign_summary.py

@@ -0,0 +1,49 @@
+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.money import Money
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Dict[str, Any]:
+    """
+    Get Affiliate Campaign Summary
+    
+    To get affiliate campaign 活動成效總覽。
+    
+    Path: GET /affiliate_campaigns/{id}/summary
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{id}/summary"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        url, 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_data

shopline_sdk/apis/affiliate_campaigns/get_affiliate_campaigns.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.affiliate_campaigns import AffiliateCampaigns
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    active_status: Optional[Literal['expired', 'ongoing']] = None
+    """The active status of affiliate campaign (expired or ongoing).
+       推薦活動的狀態 (已過期或進行中)。"""
+    partner_email: Optional[str] = None
+    """The partner's email (To encode it with URI encode before sending)."""
+    previous_id: Optional[str] = None
+    """The last ID of the campaigns in the previous request. (for cursor base; empty is mean first page)
+       前頁最後一筆編號(僅適用遊標取值，空值表示第一頁)"""
+    page: Optional[int] = None
+    """Page number (**Deprecated**)
+      頁數(已過時不建議使用)"""
+    per_page: Optional[int] = None
+    """Numbers of channels per page
+      每頁顯示資料筆數"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> AffiliateCampaigns:
+    """
+    Get Affiliate Campaigns
+    
+    To get affiliate campaigns.
+    獲取推薦活動清單。
+    
+    Path: GET /affiliate_campaigns
+    """
+    # 构建请求 URL
+    url = "affiliate_campaigns"
+
+    # 构建查询参数
+    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 AffiliateCampaigns(**response_data)

shopline_sdk/apis/affiliate_campaigns/get_products_sales_ranking_of_campaign.py

@@ -0,0 +1,73 @@
+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
+from ...models.translatable import Translatable
+
+class Request(BaseModel):
+    """查询参数模型"""
+    limit: Optional[int] = None
+    """Number of Order by request"""
+    next_product_id: Optional[str] = None
+    """The last Product Id of the products in the previous request."""
+    next_quantity: Optional[int] = None
+    """The last Quantity of the products in the previous request."""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Dict[str, Any]]] = None
+    cursor: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Products Sales Ranking of Campaign
+    
+    To get products sales ranking of campaign.
+    
+    Path: GET /affiliate_campaigns/{id}/get_products_sales_ranking
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{id}/get_products_sales_ranking"
+
+    # 构建查询参数
+    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)