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

shopline_sdk/apis/products/get_product_stocks.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.stock import Stock
+from ...models.translatable import Translatable
+
+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
+      結果只顯示哪些參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    title_translations: Optional[Translatable] = None
+    stocks: Optional[List[Stock]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Product Stocks
+    
+    To get stock information for a specific product with its ID
+     使用商品 ID 獲取特定一個商品的庫存資料
+    
+    Path: GET /products/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"products/{id}/stocks"
+
+    # 构建查询参数
+    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/products/get_products.py

@@ -0,0 +1,112 @@
+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 import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the products in the previous request.
+      前一筆商品的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    sort_by: Optional[Literal['asc', 'desc']] = None
+    """Setting sort by created time
+      設定創建時間排序"""
+    per_page: Optional[int] = None
+    """Numbers of Products per page
+      每頁顯示 n 筆資料"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    excludes: Optional[str] = None
+    """Could exclude certain parameters in the response
+      結果要排除哪些參數"""
+    fields: Optional[List[str]] = None
+    """Could only show certain parameters in the response
+      結果只顯示哪些參數"""
+    id: Optional[str] = None
+    """Only show specific products based on IDs
+      結果只顯示哪些商品"""
+    include_fields: Optional[List[Literal['labels', 'metafields', 'bundle_set', 'type']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+    with_product_set: Optional[bool] = None
+    """Return product_set or not
+      是否回傳組合商品"""
+    updated_after: Optional[str] = None
+    """Filter products by specific updated_after time.
+      取得大於等於指定時間的商品
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter products by specific updated_before time.
+      取得小於等於指定時間的商品
+       *Should use UTC time'"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Product]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Products
+    
+    To get detailed information of couple products sorted by time
+    利用時間範圍選取與排序獲取數筆商品資料
+    
+    Path: GET /products
+    """
+    # 构建请求 URL
+    url = "products"
+
+    # 构建查询参数
+    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/products/search_products.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.product import Product
+from ...models.server_error import ServerError
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Product]] = None
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> Response:
+    """
+    Search Products
+    
+    To search products with specific conditions.
+    利用特殊條件搜尋商品列表。
+    
+    Path: POST /products/search
+    """
+    # 构建请求 URL
+    url = "products/search"
+
+    # 构建请求头
+    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()
+            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/update_current_product_tags.py

@@ -0,0 +1,80 @@
+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):
+    """请求体模型"""
+    update_mode: Literal['add', 'remove']
+    """Update mode of this opearation, allow "add" or "remove"
+       更新商品標簽的方式，可選"add"或"remove"。"""
+    tags: List[str]
+    """Product tags array 
+       商品標簽array"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    tags: Optional[List[str]] = None
+
+async def call(
+    session: aiohttp.ClientSession, productId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update (add/remove) current product tags
+    
+    Add or Remove current product tags with input tags array. 
+     Each tag mush have at least 3 characters and at most 40 characters.
+     When update with invalid length of tags, the update will fail and the respond will be 422.
+     Must pass at least one tag, otherwise the update will fail and the respond will be 422.
+     在現有的商品標簽新增/移除標簽。
+     每一個商品標籤必須有最少3個字完及最多40個字完。
+     若需更新的商品標籤其中之一不符字完長度規範，更新不會成功及將回傳狀態碼422。
+     必須最少新增/移除一個標籤，否則更新不會成功及將回傳狀態碼422。
+    
+    Path: PATCH /products/{productId}/tags
+    """
+    # 构建请求 URL
+    url = f"products/{productId}/tags"
+
+    # 构建请求头
+    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 == 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/products/update_product.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.product import Product
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> Product:
+    """
+    Update Product
+    
+    To update current product information with open API.
+    透過open API更新既有商品資訊
+    
+    Path: PUT /products/{id}
+    """
+    # 构建请求 URL
+    url = f"products/{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()
+            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/update_product_price.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.product import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    price: Optional[float] = None
+    """Price (Note: Cannot be set to null. Product with a price of 0 cannot be sold.)
+       原價格 (備註：不能設定為null。價格為0的商品不能被售出)"""
+    price_sale: Optional[float] = None
+    """Price on sale  (Note: Cannot be set to null. 
+       Product with a price_sale of 0 will be sold at its original price.)
+      
+      特價 (備註：不能設定為null。特價為0的商品會以原價售出）"""
+    cost: Optional[float] = None
+    """Cost (Note: Cannot be set to null)
+       成本 (備註：不能設定為null)"""
+    member_price: Optional[float] = None
+    """Member Price
+      會員價"""
+    retail_price: Optional[float] = None
+    """Retail Price
+      零售價"""
+    product_price_tiers: Optional[Dict[str, str]] = None
+    """Membership tier's ID
+      會員等級ID"""
+
+async def call(
+    session: aiohttp.ClientSession, productId: str, request: Optional[Request] = None
+) -> Product:
+    """
+    Update Product Price
+    
+    To update product's price with open API
+    透過open API 更新商品價格
+    
+    Path: PUT /products/{productId}/update_price
+    """
+    # 构建请求 URL
+    url = f"products/{productId}/update_price"
+
+    # 构建请求头
+    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 Product(**response_data)

shopline_sdk/apis/products/update_product_quantity.py

@@ -0,0 +1,102 @@
+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.product import Product
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    quantity: float
+    """This value should be between -9999999 and 9999999.
+       數值必須在 -9999999 和 9999999 之間。"""
+    replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+       - 
+       true: replace the product's quantity with the number you provided
+      取代原本數量
+      
+       false: increase/decrease the quantity with the number you provided
+      增加/減少數量
+      
+      " """
+
+class Response(BaseModel):
+    """响应体模型"""
+    id: Optional[str] = None
+    sku: Optional[str] = None
+    quantity: Optional[float] = None
+    updated_at: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update Product Quantity
+    
+    To update product's quantity with open API
+    透過open API 更新主商品數量
+    
+    Path: PUT /products/{id}/update_quantity
+    """
+    # 构建请求 URL
+    url = f"products/{id}/update_quantity"
+
+    # 构建请求头
+    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 == 403:
+                error_model = BadRequestError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=403,
+                    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 Response(**response_data)

shopline_sdk/apis/products/update_product_variation.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
+
+# 导入需要的模型
+from ...models.product import Product
+
+async def call(
+    session: aiohttp.ClientSession, product_id: str, id: str, data: Optional[Dict[str, Any]] = None
+) -> Product:
+    """
+    Update Product Variation
+    
+    Update information of an existing product variation.
+    針對現有規格商品做訊息更新
+    
+    Path: PUT /products/{product_id}/variations/{id}
+    """
+    # 构建请求 URL
+    url = f"products/{product_id}/variations/{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 Product(**response_data)