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

shopline_sdk/apis/orders/get_all_orders_tags.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.server_error import ServerError
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    Get all orders tags
+    
+    To get all of the orders tags sorted by alphabetical order
+     獲取全部訂單標籤資料
+    
+    Path: GET /orders/tags
+    """
+    # 构建请求 URL
+    url = "orders/tags"
+
+    # 构建请求头
+    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(**response_data)

shopline_sdk/apis/orders/get_order.py

@@ -0,0 +1,78 @@
+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.order import Order
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    include_fields: Optional[List[Literal['affiliate_campaign', 'agent_id', 'auto_reward_credit_summary', 'member_point_summary']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+    fields: Optional[List[str]] = None
+    """Only return the provided fields in the responses
+      結果只包含輸入的參數 
+       This parameter will override include_fields[]
+      此參數會覆蓋include_fields[]。"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Order:
+    """
+    Get Order
+    
+    To get detailed information for a specific order with its ID
+    使用訂單ID獲取特定一筆訂單的詳細資料
+    
+    Path: GET /orders/{id}
+    """
+    # 构建请求 URL
+    url = f"orders/{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
+                )
+            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/get_order_action_logs.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.order_action_logs import OrderActionLogs
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> OrderActionLogs:
+    """
+    Get order action logs
+    
+    To get order action logs with order ID.
+     取得訂單活動紀錄。
+     Return empty array if order not found.
+     如果找不到訂單紀錄，返回empty array。
+    
+    
+    Path: GET /orders/{id}/action_logs
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/action_logs"
+
+    # 构建请求头
+    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 OrderActionLogs(**response_data)

shopline_sdk/apis/orders/get_order_labels_of_delivery.py

@@ -0,0 +1,94 @@
+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):
+    """查询参数模型"""
+    ids: List[str]
+    """Order ID
+      訂單ID
+      -
+      Allow 24 order IDs in one batch
+      一次最多輸入24筆訂單ID"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    fmt_b2c: Optional[List[str]] = None
+    fmt_c2c: Optional[List[str]] = None
+    seven_eleven_b2c: Optional[List[str]] = None
+    tcat_roomtemp: Optional[List[str]] = None
+    tcat_refrigerated: Optional[List[str]] = None
+    tcat_frozen: Optional[List[str]] = None
+    sfexpress: Optional[List[str]] = None
+    sf_pickup: Optional[List[str]] = None
+    hct_roomtemp: Optional[List[str]] = None
+    hct_refrigerated: Optional[List[str]] = None
+    hct_frozen: Optional[List[str]] = None
+    failed_orders: Optional[Dict[str, List[Dict[str, Any]]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Order Labels of Delivery
+    
+    To get delivery labels with order IDs.
+    使用訂單ID獲取寄貨標籤。
+     If validations are passed, those partially failed orders will be return, for *fmt_c2, fmt_b2, seven_eleven_b2c, tcat_roomtem, tcat_refrigerate, tcat_froze* orders.
+     如果通過訂單資訊的驗證，如有部份*fmt_c2, fmt_b2, seven_eleven_b2c, tcat_roomtem, tcat_refrigerate, tcat_froze*單操作失敗， 部份失敗的訂單訊息將會被返回。
+     The list of failed *fmt_c2, fmt_b2, seven_eleven_b2c, tcat_roomtem, tcat_refrigerate, tcat_froze*orders can be found from the *failed_orders* property. The property will be hidden if there are no errors.
+     不成功的*fmt_c2, fmt_b2, seven_eleven_b2c, tcat_roomtem, tcat_refrigerate, tcat_froze* orders 將會出現在*failed_orders* 內。
+    
+    Path: GET /orders/label
+    """
+    # 构建请求 URL
+    url = "orders/label"
+
+    # 构建查询参数
+    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/orders/get_order_transaction_by_order_ids.py

@@ -0,0 +1,58 @@
+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_transaction import OrderTransaction
+
+class Request(BaseModel):
+    """查询参数模型"""
+    orderIds: List[str]
+    """Order Ids"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[OrderTransaction]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get order transaction by orderIds
+    
+    To get POS order_transactions of POS orders.
+    
+    Path: GET /orders/transactions
+    """
+    # 构建请求 URL
+    url = "orders/transactions"
+
+    # 构建查询参数
+    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/get_orders.py

@@ -0,0 +1,111 @@
+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.paginatable import Paginatable
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    default_visible_channels: Optional[bool] = None
+    """filter online orders when the prop is true.
+       篩選線上訂單"""
+    updated_after: Optional[str] = None
+    """Filter orders by those updated after specific time.
+       取得 updated_at 大於指定時間的分類(包含指定時間)
+       *Should use UTC time"""
+    updated_before: Optional[str] = None
+    """Filter orders by those updated before specific time.
+       取得 updated_at 小於指定時間的分類(包含指定時間)
+       *Should use UTC time"""
+    created_after: Optional[str] = None
+    """Filter orders by those updated after specific time.
+       取得 created_at 大於指定時間的分類(包含指定時間)
+       *Should use UTC time"""
+    created_before: Optional[str] = None
+    """Filter orders by those updated before specific time.
+       取得 created_at 小於指定時間的分類(包含指定時間)
+       *Should use UTC time"""
+    order_ids: Optional[List[str]] = None
+    """Order IDs
+      指定Order ID"""
+    previous_id: Optional[str] = None
+    """To fetch data for the next page, include the ID of the last order from the previous page. 
+       用於拿取下一分頁資料，請帶入前一分頁的最後一筆訂單 ID 
+      
+       When fetching orders for the first page, this parameter is not required. 
+       拿取第一頁訂單時，可以不用帶此參數"""
+    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 sort by created time
+      設定創建時間排序"""
+    customer_id: Optional[str] = None
+    """filter by customer ID
+      篩選顧客 ID"""
+    include_fields: Optional[List[Literal['affiliate_campaign']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Order]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Orders
+    
+    To get detailed information of couple orders sorted by time
+    利用時間範圍選取與排序獲取數筆訂單資料
+    
+    Path: GET /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"}
+
+    # 发起 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)