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

shopline_sdk/apis/delivery_options/updatedeliveryoption_sstoreinformation.py

@@ -0,0 +1,67 @@
+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.delivery_option import DeliveryOption
+from ...models.translatable import Translatable
+
+
+class AddressesItem(BaseModel):
+    """Item model for addresses"""
+    level_1_translations: Optional[Translatable] = None
+    level_2_translations: Optional[Translatable] = None
+    level_3_translations: Optional[Translatable] = None
+    store_name_translations: Optional[Translatable] = None
+    store_address_translations: Optional[Translatable] = None
+    instruction_translations: Optional[Translatable] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    store_pickup_option: Optional[Dict[str, Any]] = None
+    addresses: Optional[List[AddressesItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    delivery_option: Optional[DeliveryOption] = None
+    errors: Optional[List[str]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Delivery Option(Store Pickup)'s Store Information
+    
+    To update a delivery option(store pickup)'s store information.
+    更新一個為什門市自取的送貨方式的門市資訊。
+    
+    Path: PUT /delivery_options/{id}/stores_info
+    """
+    # 构建请求 URL
+    url = f"delivery_options/{id}/stores_info"
+
+    # 构建请求头
+    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()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/event_trackers/create_an_event_tracker.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.event_tracker import EventTracker
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    version: Optional[str] = None
+    """控制 api version"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> EventTracker:
+    """
+    Create an event tracker
+    
+    To create a new third party's event tracker
+    創建新第三方事件追蹤
+    
+    Path: POST /event_trackers
+    """
+    # 构建请求 URL
+    url = "event_trackers"
+
+    # 构建查询参数
+    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"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.post(
+        url, params=params, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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 EventTracker(**response_data)

shopline_sdk/apis/event_trackers/delete_an_event_tracker.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
+
+class Request(BaseModel):
+    """查询参数模型"""
+    version: Optional[str] = None
+    """控制 api version"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Delete an event tracker
+    
+    To delete an event tracker
+    刪除第三方事件追蹤
+    
+    Path: DELETE /event_trackers/{id}
+    """
+    # 构建请求 URL
+    url = f"event_trackers/{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.delete(
+        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/event_trackers/get_an_event_tracker.py

@@ -0,0 +1,64 @@
+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.event_trackers import EventTrackers
+from ...models.not_found_error import NotFoundError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    version: Optional[str] = None
+    """控制 api version"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> EventTrackers:
+    """
+    Get an Event Tracker
+    
+    To get detailed information for a specific event tracker with its ID
+     使用事件追蹤ID獲取特定第三方事件追蹤的詳細資料
+    
+    Path: GET /event_trackers/{id}
+    """
+    # 构建请求 URL
+    url = f"event_trackers/{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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return EventTrackers(**response_data)

shopline_sdk/apis/event_trackers/get_event_trackers.py

@@ -0,0 +1,97 @@
+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.event_trackers import EventTrackers
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    event_type: Optional[Literal['loaded_home_page', 'added_product_to_cart', 'loaded_checkout_page', 'placed_an_order', 'loaded_any_page', 'all']] = None
+    """Filter event trackers by their event_type.
+       Default: all
+       按 event_type 過濾事件追踪資料
+       預設: all"""
+    tracker_types: Optional[List[Literal['tiktok', 'facebook_standard_pixel']]] = None
+    """Filter event trackers by their event_keys.
+       Default: []
+       按 event_key 過濾事件追踪資料
+       預設: []"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    version: Optional[str] = None
+    """控制 api version"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> EventTrackers:
+    """
+    Get Event Trackers
+    
+    To get detailed information of event trackers sorted by
+     event_type or event_keys
+     利用 event_type 或 event_keys 獲取第三方事件追蹤資料
+    
+    Path: GET /event_trackers
+    """
+    # 构建请求 URL
+    url = "event_trackers"
+
+    # 构建查询参数
+    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 == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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 EventTrackers(**response_data)

shopline_sdk/apis/event_trackers/update_event_tracker.py

@@ -0,0 +1,91 @@
+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.event_trackers import EventTrackers
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    version: Optional[str] = None
+    """控制 api version"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> EventTrackers:
+    """
+    Update Event Tracker
+    
+    To update an event tracker with open API
+    透過open API更新第三方事件追蹤
+    
+    Path: PUT /event_trackers/{id}
+    """
+    # 构建请求 URL
+    url = f"event_trackers/{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"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, params=params, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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 EventTrackers(**response_data)

shopline_sdk/apis/flash_price_campaigns/create_flash_price_campaign.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.flash_price_campaign import FlashPriceCampaign
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> FlashPriceCampaign:
+    """
+    Create Flash Price Campaign
+    
+    To create new flash price campaign
+    創建新商品限時促銷價活動
+    
+    Path: POST /flash_price_campaigns
+    """
+    # 构建请求 URL
+    url = "flash_price_campaigns"
+
+    # 构建请求头
+    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 FlashPriceCampaign(**response_data)

shopline_sdk/apis/flash_price_campaigns/delete_flash_price_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):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Flash Price Campaign
+    
+    To delete a flash price campaign
+    刪除商品限時促銷價活動
+    
+    Path: DELETE /flash_price_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"flash_price_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/flash_price_campaigns/get_a_flash_price_campaign.py

@@ -0,0 +1,43 @@
+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
+) -> FlashPriceCampaign:
+    """
+    Get a Flash Price Campaign
+    
+    To retrieve a flash price campaign with its id
+    獲取商品限時促銷價活動
+    
+    Path: GET /flash_price_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"flash_price_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()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return FlashPriceCampaign(**response_data)

shopline_sdk/apis/flash_price_campaigns/get_flash_price_campaigns.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.flash_price_campaigns import FlashPriceCampaigns
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filter_action: Optional[Literal['overlap']] = None
+    """Specify the filter action for flash price campaigns by the start time or/and end time
+       指定商品限時促銷價活動的過濾動作，此動作依據start_at或/及end_at進行過濾"""
+    start_at: Optional[str] = None
+    """Filter those flash price campaigns after specified start_at time.
+       取得大於指定start_at時間的商品限時促銷價活動
+       *Should use UTC time
+       *應使用UTC時間"""
+    end_at: Optional[str] = None
+    """Filter those flash price campaigns before specified end_at time.
+       取得小於指定end_at時間的商品限時促銷價活動
+       *Should use UTC time
+       *應使用UTC時間"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> FlashPriceCampaigns:
+    """
+    Get Flash Price Campaigns
+    
+    To retrieve flash price campaign list
+    獲取商品限時促銷價活動列表
+    
+    Path: GET /flash_price_campaigns
+    """
+    # 构建请求 URL
+    url = "flash_price_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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return FlashPriceCampaigns(**response_data)