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

shopline_sdk/apis/affiliate_campaigns/update_affiliate_campaign.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.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: Optional[str] = None
+    """Affiliate Campaign Name
+      推薦活動名稱"""
+    promotion_id: Optional[str] = None
+    """Promotion Id
+      套用優惠折扣 ID"""
+    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 的條款說明"""
+    partner_info: Optional[Dict[str, Any]] = None
+    """Partner info
+      合作夥伴資訊"""
+    campaign_products: Optional[List[CampaignProduct]] = None
+    """Add item without id param to array to create new campaign product.
+       Remove item from array to delete campaign product.
+       Update item is not allowed.
+      
+       藉由新增不含 id 的物件到陣列中，即可新增新的 Campaign Product。
+       從陣列中移除物件即可刪除該 Campaign Product。
+       不可更新任何已存在的 Campaign Product 其資料。"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> AffiliateCampaign:
+    """
+    Update Affiliate Campaign
+    
+    To update affiliate campaign.
+    更新推薦活動。
+    
+    Path: PUT /affiliate_campaigns/{id}
+    """
+    # 构建请求 URL
+    url = f"affiliate_campaigns/{id}"
+
+    # 构建请求头
+    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 == 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/agents/get_agent.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.agent import Agent
+
+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
+      結果只顯示哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Agent:
+    """
+    Get Agent
+    
+    To get agent information by inputing agent ID
+    輸入員工ID取得該員工資訊
+    
+    Path: GET /agents/{id}
+    """
+    # 构建请求 URL
+    url = f"agents/{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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Agent(**response_data)

shopline_sdk/apis/agents/get_agents.py

@@ -0,0 +1,77 @@
+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.agent import Agent
+from ...models.paginatable import Paginatable
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    sort_by: Optional[Literal['asc', 'desc']] = None
+    """Setting sorting direction
+      設定時間排序"""
+    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
+      結果只顯示哪些參數"""
+    channel_ids: Optional[List[str]] = None
+    """Show agents include one of channel_ids, length limit is 10
+      結果只顯示哪些員工，長度限制10個"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Agent]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Agents
+    
+    To get all agents with open API
+    透過open API獲取 Agents
+    
+    Path: GET /agents
+    """
+    # 构建请求 URL
+    url = "agents"
+
+    # 构建查询参数
+    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/bulk_operations/get_a_bulk_operation.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.job import Job
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Job:
+    """
+    Get a Bulk Operation
+    
+    To retrieve a bulk operation with its id
+    獲取批量操作
+    
+    Path: GET /bulk_operations/{id}
+    """
+    # 构建请求 URL
+    url = f"bulk_operations/{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 Job(**response_data)

shopline_sdk/apis/bulk_operations/get_bulk_operations.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.jobs import Jobs
+
+class Request(BaseModel):
+    """查询参数模型"""
+    status: Optional[Literal['all', 'pending', 'in_progress', 'done', 'failed', 'timeout']] = None
+    """Specify the status for bulk operations
+       指定批量操作狀態的過濾"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Jobs:
+    """
+    Get Bulk Operations
+    
+    To retrieve bulk operation list
+    獲取批量操作
+    
+    Path: GET /bulk_operations
+    """
+    # 构建请求 URL
+    url = "bulk_operations"
+
+    # 构建查询参数
+    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 Jobs(**response_data)

shopline_sdk/apis/cart_item_app_metafields/bulk_create_app_metafield.py

@@ -0,0 +1,52 @@
+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.app_metafield_value import AppMetafieldValue
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[Any]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AppMetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk create app metafield
+    
+    To create app metafield attached to cart items of specific cart
+    
+    Path: POST /carts/{cart_id}/items/app_metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/app_metafields/bulk"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/cart_item_app_metafields/bulk_delete_app_metafield.py

@@ -0,0 +1,61 @@
+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.metafield_value import MetafieldValue
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    resource_id: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    bulk delete app metafield
+    
+    bulk delete information of app metafield attached to cart items of specific cart
+    
+    Path: DELETE /carts/{cart_id}/items/app_metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/app_metafields/bulk"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.delete(
+        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/cart_item_app_metafields/bulk_update_app_metafield.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.app_metafield_value import AppMetafieldValue
+from ...models.metafield_value import MetafieldValue
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    resource_id: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AppMetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    bulk update app metafield
+    
+    bulk update information of app metafield attached to cart items of specific cart
+    
+    Path: PUT /carts/{cart_id}/items/app_metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/app_metafields/bulk"
+
+    # 构建请求头
+    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/cart_item_app_metafields/get_app_metafields_attached_to_cart_items_of_specific_cart.py

@@ -0,0 +1,61 @@
+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.app_metafield_value import AppMetafieldValue
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filters: Optional[List[str]] = None
+    """Search criteria
+       In format of {key}:{value}
+       {key} - required
+       {value} - optional"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AppMetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to cart items of specific cart
+    
+    To get information of app metafield attached to cart items of specific cart
+    
+    Path: GET /carts/{cart_id}/items/app_metafields
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/app_metafields"
+
+    # 构建查询参数
+    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/cart_item_metafields/bulk_create_metafield.py

@@ -0,0 +1,52 @@
+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.metafield_value import MetafieldValue
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[Any]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk create metafield
+    
+    To create metafield attached to cart items of specific cart
+    
+    Path: POST /carts/{cart_id}/items/metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/metafields/bulk"
+
+    # 构建请求头
+    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 Response(**response_data)