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

shopline_sdk/apis/product_review_comments/bulk_update_product_review_comments.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.product_review_comment import ProductReviewComment
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    user_name: Optional[str] = None
+    status: Optional[str] = None
+    score: Optional[int] = None
+    comment: 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 Update Product Review Comments
+    
+    To bulk update multiple product review comments.
+    批量更新商品評價。
+    
+    Path: PUT /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.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/product_review_comments/create_product_review_comments.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.product_review_comment import ProductReviewComment
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> ProductReviewComment:
+    """
+    Create Product Review Comments
+    
+    To create a product review comment.
+    創建一個商品評價。
+    
+    Path: POST /product_review_comments
+    """
+    # 构建请求 URL
+    url = "product_review_comments"
+
+    # 构建请求头
+    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 ProductReviewComment(**response_data)

shopline_sdk/apis/product_review_comments/delete_product_review_comment.py

@@ -0,0 +1,37 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> str:
+    """
+    Delete Product Review Comment
+    
+    To delete a product review comment.
+    刪除一個商品評價。
+    
+    Path: DELETE /product_review_comments/{id}
+    """
+    # 构建请求 URL
+    url = f"product_review_comments/{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
+            )
+        # 返回文本响应
+        return await response.text()

shopline_sdk/apis/product_review_comments/get_product_review_comment.py

@@ -0,0 +1,42 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> ProductReviewComment:
+    """
+    Get Product Review Comment
+    
+    To retrieve one of the product review comments by id.
+    以id抓取某一商品評價。
+    
+    Path: GET /product_review_comments/{id}
+    """
+    # 构建请求 URL
+    url = f"product_review_comments/{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 ProductReviewComment(**response_data)

shopline_sdk/apis/product_review_comments/get_product_review_comments.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.paginatable import Paginatable
+from ...models.product_review_comments import ProductReviewComments
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the product review comments in the previous request.
+      前一筆商品評價的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    product_id: Optional[str] = None
+    """Product id
+      產品id"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of items per Page
+      每頁顯示 n 筆資料"""
+    sort_by: Optional[Literal['created_at', 'score']] = None
+    """Sorting by field
+      以欄位排序"""
+    order_by: Optional[Literal['asc', 'desc']] = None
+    """Setting sort by created time
+      設定排序"""
+    status: Optional[str] = None
+    """Status
+      狀態"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[ProductReviewComments]] = None
+    pagination: Optional[Paginatable] = None
+    last_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Product Review Comments
+    
+    To retrieve product review comments.
+    抓取商品評價。
+    
+    Path: GET /product_review_comments
+    """
+    # 构建请求 URL
+    url = "product_review_comments"
+
+    # 构建查询参数
+    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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/product_review_comments/update_product_review_comment.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.product_review_comment import ProductReviewComment
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> ProductReviewComment:
+    """
+    Update Product Review Comment
+    
+    To update a product review comment by id.
+    以id更新某一商品評價。
+    
+    Path: PUT /product_review_comments/{id}
+    """
+    # 构建请求 URL
+    url = f"product_review_comments/{id}"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = data if data 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 ProductReviewComment(**response_data)

shopline_sdk/apis/product_subscriptions/get_a_list_of_product_subscriptions.py

@@ -0,0 +1,71 @@
+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.product_subscription import ProductSubscription
+
+class Request(BaseModel):
+    """查询参数模型"""
+    per_page: Optional[int] = None
+    """Numbers of Products per page
+      每頁顯示 n 筆資料"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    previous_id: Optional[str] = None
+    """Previous ID
+      上一頁的ID"""
+    id: Optional[str] = None
+    """Only show specific products based on IDs
+      結果只顯示哪些商品"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[ProductSubscription]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get a list of product subscriptions
+    
+    Retrieve information of multiple product subscriptions
+    抓取多筆定期購的信息
+    
+    Path: GET /product_subscriptions
+    """
+    # 构建请求 URL
+    url = "product_subscriptions"
+
+    # 构建查询参数
+    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_subscriptions/get_product_subscription.py

@@ -0,0 +1,42 @@
+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_subscription import ProductSubscription
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> ProductSubscription:
+    """
+    Get Product Subscription
+    
+    To get detailed information for a specific product subscription with its ID
+     使用定期購ID獲取特定一個定期購的詳細資料
+    
+    Path: GET /product_subscriptions/{id}
+    """
+    # 构建请求 URL
+    url = f"product_subscriptions/{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 ProductSubscription(**response_data)

shopline_sdk/apis/products/add_product_images.py

@@ -0,0 +1,84 @@
+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.media_upload_error import MediaUploadError
+from ...models.not_found_error import NotFoundError
+from ...models.product import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    urls: Optional[List[str]] = None
+    """Urls of the Images
+      新增圖片之url"""
+    image_type: Optional[Literal['main', 'detail']] = None
+    """Image Type
+      圖片種類"""
+    is_replcae: Optional[bool] = None
+    """Whether replacing the original images
+      是否取代原本數量"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Product:
+    """
+    Add Product Images
+    
+    Add or replace product images to an existing product.
+    透過open API對現有商品進行新增或覆蓋圖片。
+    
+    Path: POST /products/{id}/add_images
+    """
+    # 构建请求 URL
+    url = f"products/{id}/add_images"
+
+    # 构建请求头
+    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 == 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 Product(**response_data)

shopline_sdk/apis/products/batch_update_current_product_labels.py

@@ -0,0 +1,73 @@
+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.translatable import Translatable
+
+
+class DataItem(BaseModel):
+    """Item model for data"""
+    product_ids: Optional[List[str]] = None
+    """Maximum allows 1000 product_id per action
+       上限 1000 個商品 ID"""
+    label: Optional[Dict[str, Any]] = None
+    """remove product's label if label is empty.
+       label 為空代表移除促銷標籤"""
+
+class Request(BaseModel):
+    """请求体模型"""
+    data: Optional[List[DataItem]] = None
+    """One item means one operation on a batch of products. Maximum allows 5 operations per request.
+       一個 item 代表對一批商品做相同操作，一次請求上限 5 個操作"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    data: Optional[List[Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Batch Update (add/remove) current product labels
+    
+    Add or Remove current product labels.
+    
+    Path: PATCH /products/labels
+    """
+    # 构建请求 URL
+    url = "products/labels"
+
+    # 构建请求头
+    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/products/bulk_delete_product.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    ids: Optional[str] = None
+    """The id of the product that will be deleted. Max delete 100 products at a time.
+       需要刪除的商品id，每次最多只能刪除100個商品。"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    updated_product_ids: Optional[List[str]] = None
+    errors: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Delete Product
+    
+    To bulk delete products.
+     批量刪除商品。
+    
+    Path: DELETE /products/bulk
+    """
+    # 构建请求 URL
+    url = "products/bulk"
+
+    # 构建查询参数
+    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()
+            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)