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

shopline_sdk/apis/orders/update_order_payment_status.py

@@ -0,0 +1,92 @@
+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_payment import OrderPayment
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    status: Optional[Literal['pending', 'failed', 'expired', 'completed', 'refunding', 'refunded']] = None
+    mail_notify: Optional[bool] = None
+    """Do you want to notify the customer via email with the change?
+      此更新是否要以email通知顧客？
+      (Default: false)"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    order_id: Optional[str] = None
+    status: Optional[Literal['pending', 'failed', 'expired', 'completed', 'refunding', 'refunded']] = None
+    updated_at: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Order Payment Status
+    
+    To update order's payment status
+    更新訂單付款狀態
+    
+    Path: PATCH /orders/{id}/order_payment_status
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/order_payment_status"
+
+    # 构建查询参数
+    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.patch(
+        url, params=params, 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 == 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/update_order_status.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.bad_request_error import BadRequestError
+from ...models.not_found_error import NotFoundError
+from ...models.order import Order
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    status: Optional[Literal['temp', 'pending', 'removed', 'confirmed', 'completed', 'cancelled']] = None
+    mail_notify: Optional[bool] = None
+    """Do you want to notify the customer via email with the change?
+      此更新是否要以email通知顧客？
+      (Default: false)"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Order:
+    """
+    Update Order Status
+    
+    To update order status
+    更新訂單狀態
+    
+    Path: PATCH /orders/{id}/status
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/status"
+
+    # 构建查询参数
+    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.patch(
+        url, params=params, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 400:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=400,
+                    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 Order(**response_data)

shopline_sdk/apis/orders/update_order_tags.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.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.taggable import Taggable
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    tags: Optional[Taggable] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    tags: Optional[Taggable] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update order tags
+    
+    To update order tags with order IDs.
+     Each tag mush have at least 3 characters and at most 40 characters.
+     Each order can have at most 10 order tags.
+     The maximum of order tags in one store is 100.
+     When update with invalid length of tags, the update will fail and the respond will be 422.
+     When the amount of order tags exceed 10 or the amount of order tags plus
+     the amount of order tags in one store exceeds 100,
+     the update will fail and return the current valid tags of that order with status code 200.
+     使用訂單ID更新訂單標籤。
+     每一個訂單標籤必須有最少3個字完及最多40個字完。
+     每一張訂單最多只能有10個訂單標籤。
+     每一名店家最多只能有100個訂單標籤。
+     若需更新的訂單標籤其中之一不符字完長度規範，更新不會成功及將回傳狀態碼422。 若需更新的訂單標籤超過10個時，又或需更新的訂單標籤加上店家已存在的訂單標籤數量超過100個時，
+     更新將不會成功，且仍會回傳狀態碼200及當前訂單的有效訂單標籤。
+    
+    
+    Path: PUT /orders/{id}/tags
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/tags"
+
+    # 构建请求头
+    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 == 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/payments/get_payment.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.payment import Payment
+
+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
+) -> Payment:
+    """
+    Get Payment
+    
+    To get payment method information by inputing payment method ID
+    輸入付款方式ID取得該付款方式資訊
+    
+    Path: GET /payments/{id}
+    """
+    # 构建请求 URL
+    url = f"payments/{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 Payment(**response_data)

shopline_sdk/apis/payments/get_payments.py

@@ -0,0 +1,88 @@
+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.paginatable import Paginatable
+from ...models.payment import Payment
+
+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
+      設定時間排序"""
+    order_by: Optional[Literal['created_at', 'priority']] = None
+    """Setting sorting attribute
+      設定排序使用值"""
+    updated_after: Optional[str] = None
+    """Filter payments by those updated after specific time.
+      取得 updated_at 大於指定時間的付款方式(包含指定時間)
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter payments by those updated before specific time.
+      取得 updated_at 小於指定時間的付款方式(包含指定時間)
+       *Should use UTC time'"""
+    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_id: Optional[str] = None
+    """Filter payments by channel approved sl-payments methods.
+      取得門店可用付款方式"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Payment]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Payments
+    
+    To get all kinds of payment methods with open API
+    透過open API獲取所有的付款方式
+    
+    Path: GET /payments
+    """
+    # 构建请求 URL
+    url = "payments"
+
+    # 构建查询参数
+    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/product_app_metafields/get_app_metafields_attached_to_specific_product.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, product_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to specific product
+    
+    To get information of app metafield attached to specific product
+    
+    Path: GET /products/{product_id}/app_metafields
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/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/product_metafields/get_metafields_attached_to_specific_product.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, product_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to specific product
+    
+    To get information of metafield attached to specific product
+    
+    Path: GET /products/{product_id}/metafields
+    """
+    # 构建请求 URL
+    url = f"products/{product_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/product_review_comments/bulk_create_product_review_comments.py

@@ -0,0 +1,66 @@
+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.product_review_comment import ProductReviewComment
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    product_id: str
+    score: int
+    comment: str
+    user_id: Optional[str] = None
+    order_id: Optional[str] = None
+    status: Optional[str] = None
+    user_name: Optional[str] = None
+    media_ids: Optional[Any] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+    count: Optional[int] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Create Product Review Comments
+    
+    To bulk create product review comments.
+    批量創建商品評價。
+    
+    Path: POST /product_review_comments/bulk
+    """
+    # 构建请求 URL
+    url = "product_review_comments/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/product_review_comments/bulk_delete_product_review_comments.py

@@ -0,0 +1,46 @@
+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
+) -> Response:
+    """
+    Bulk Delete Product Review Comments
+    
+    To bulk delete product review comments.
+    批量刪除商品評價。
+     ids of product review comments
+    商品評價id
+     example:in:5d7a026ce388095474c7b5fa,5e44c892e3880946bb3ababd
+    
+    Path: DELETE /product_review_comments/bulk
+    """
+    # 构建请求 URL
+    url = "product_review_comments/bulk"
+
+    # 构建请求头
+    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)