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

shopline_sdk/apis/order_deliveries/get_order_delivery.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.order_delivery import OrderDelivery
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> OrderDelivery:
+    """
+    Get Order Delivery
+    
+    To get detailed information for a specific order delivery with its ID
+    使用訂單ID配送獲取特定一筆訂單配送的詳細資料
+    
+    Path: GET /order_deliveries/{id}
+    """
+    # 构建请求 URL
+    url = f"order_deliveries/{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 OrderDelivery(**response_data)

shopline_sdk/apis/order_deliveries/update_order_delivery.py

@@ -0,0 +1,63 @@
+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.order_delivery import OrderDelivery
+
+class Request(BaseModel):
+    """请求体模型"""
+    remark: Optional[str] = None
+    """Delivery remark
+      出貨備註 Up to 255 words.
+      最多只能填寫255個字。"""
+    status: Optional[str] = None
+    """Order delivery status
+      訂單送貨狀態 Order delivery Status only allows
+      訂單送貨狀態只可以填入 pending 備貨中
+       shipping 發貨中
+       shipped 已發貨
+       arrived 已到達
+       collected 已取貨
+       returned 已退貨
+       returning 退貨中"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> OrderDelivery:
+    """
+    Update Order Delivery
+    
+    To update a specific order delivery with its ID
+    使用訂單ID配送更新特定一筆訂單配送的資料
+    
+    Path: PUT /order_deliveries/{id}
+    """
+    # 构建请求 URL
+    url = f"order_deliveries/{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()
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return OrderDelivery(**response_data)

shopline_sdk/apis/order_item_app_metafields/get_app_metafields_attached_to_order_items_of_specific_order.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, order_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to order items of specific order
+    
+    To get information of app metafield attached to order items of specific order
+    
+    Path: GET /orders/{order_id}/items/app_metafields
+    """
+    # 构建请求 URL
+    url = f"orders/{order_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/order_item_metafields/get_metafields_attached_to_order_items_of_specific_order.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.metafield_value import MetafieldValue
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filters: Optional[List[str]] = None
+    """Search criteria
+       In format of {namespace}.{key}:{value}
+       {namespace} - required
+       {key} - required
+       {value} - optional"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, order_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to order items of specific order
+    
+    To get information of metafield attached to order items of specific order
+    
+    Path: GET /orders/{order_id}/items/metafields
+    """
+    # 构建请求 URL
+    url = f"orders/{order_id}/items/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/order_metafields/get_metafields_attached_to_specific_order.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.metafield_value import MetafieldValue
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filters: Optional[List[str]] = None
+    """Search criteria
+       In format of {namespace}.{key}:{value}
+       {namespace} - required
+       {key} - required
+       {value} - optional"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, order_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to specific order
+    
+    To get information of metafield attached to specific order
+    
+    Path: GET /orders/{order_id}/metafields
+    """
+    # 构建请求 URL
+    url = f"orders/{order_id}/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/orders/bulk_execute_shipment.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.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    orderIds: Optional[List[str]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    processingOrderIds: Optional[List[Any]] = None
+    processingFailedOrderIds: Optional[List[Any]] = None
+    statusErrorOrderIds: Optional[List[Any]] = None
+    platformNotSupportOrderIds: Optional[List[Any]] = None
+    notFoundOrderIds: Optional[List[Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Execute Shipment
+    
+    To bulk update the order delivery status. Note that any update failure will be ignored. 
+     批量更新訂單送貨狀態。注意任何更新錯誤會被忽略。 
+     We support order with following delivery service: 7-11 Cross Border, FMT Freeze, Tcat.
+     目前支援以下物流：7-11 跨境、全家冷凍、黑貓宅配
+     * Currently, this endpoint only support updating orders delivery status with same status.
+     * 現階段只支持批量更新相同的訂單送貨狀態。
+    
+    
+    Path: PATCH /orders/execute_shipment
+    """
+    # 构建请求 URL
+    url = "orders/execute_shipment"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.patch(
+        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 Response(**response_data)

shopline_sdk/apis/orders/cancel_order.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
+
+class Request(BaseModel):
+    """请求体模型"""
+    cancelled_reason: Optional[Dict[str, Any]] = None
+    revert_credits: Optional[Dict[str, Any]] = None
+    """revert credits information
+      回補購物金資訊"""
+    revert_member_points: Optional[Dict[str, Any]] = None
+    """revert member points information
+      回補點數資訊"""
+    operated_by: Optional[Literal['merchant', 'customer']] = None
+    """where to cancel the order, the default is customer
+      從哪裡取消訂單，預設是 customer"""
+    refund_order: Optional[bool] = None
+    """Do you want to refund the order? 
+      是否要退款此筆訂單
+      -
+      *Default:true"""
+    mail_notify: Optional[bool] = None
+    """Do you want to notify the customer via email when the order is cancelled? 
+      此筆訂單取消之後是否要通知顧客？
+      -
+      *Default:true"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    order_items_stock_tag: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, orderId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Cancel Order
+    
+    To cancel order
+    取消訂單
+    
+    Path: PATCH /orders/{orderId}/cancel
+    """
+    # 构建请求 URL
+    url = f"orders/{orderId}/cancel"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.patch(
+        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/orders/create_archived_orders_report.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    filters: Optional[List[Dict[str, Any]]] = None
+    callback_url: Optional[str] = None
+    """merchant's callback url
+      店家提供 callback url"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[List[Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Create Archived Orders Report
+    
+    Create Archived Orders Report
+    查詢冷區訂單資料
+    
+    Path: POST /orders/archived_orders
+    """
+    # 构建请求 URL
+    url = "orders/archived_orders"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/orders/create_order.py

@@ -0,0 +1,90 @@
+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.order import Order
+from ...models.order_delivery_address import OrderDeliveryAddress
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    order: Optional[Dict[str, Any]] = None
+    is_registering_as_member: Optional[bool] = None
+    """Do you want to set the customer as a member?
+      是否要將此筆訂單顧客設為會員？
+      -
+      *Default: false"""
+    is_inventory_fulfillment: Optional[bool] = None
+    """Do you want to deduct the inventory numbers after the order is created?
+      此筆訂單是否要扣掉庫存？
+      -
+      *Default:false"""
+    mail_notify: Optional[bool] = None
+    """Do you want to notify the customer of the order creation by email ?
+      此筆訂單成立之後是否要通知顧客？
+      -
+      *Default:false"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Order:
+    """
+    Create Order
+    
+    To create an order with open API
+    透過open API創建一筆新訂單
+    
+    Path: POST /orders
+    """
+    # 构建请求 URL
+    url = "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"}
+
+    # 构建请求体
+    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 == 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 Order(**response_data)

shopline_sdk/apis/orders/execute_shipment.py

@@ -0,0 +1,63 @@
+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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Response(BaseModel):
+    """响应体模型"""
+    delivery_status: Optional[Literal['request_accepted', 'request_authorized', 'request_submitted']] = None
+    tracking_number: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Execute Shipment
+    
+    Execute shipment, currently we support order with following delivery service: 7-11 B2C/7-11 C2C/FMT B2C/FMT C2C/T-cat/SF/HCT 
+     Only applicable to order in pending delivery status.
+    
+    Path: PATCH /orders/{id}/execute_shipment
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/execute_shipment"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.patch(
+        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 Response(**response_data)