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

shopline_sdk/apis/cart_item_metafields/bulk_delete_metafield.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 ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    resource_id: Optional[str] = None
+    namespace: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    bulk delete metafield
+    
+    bulk delete information of metafield attached to cart items of specific cart
+    
+    Path: DELETE /carts/{cart_id}/items/metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/metafields/bulk"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.delete(
+        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/cart_item_metafields/bulk_update_metafield.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 ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    resource_id: Optional[str] = None
+    namespace: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    bulk update metafield
+    
+    bulk update information of metafield attached to cart items of specific cart
+    
+    Path: PUT /carts/{cart_id}/items/metafields/bulk
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_id}/items/metafields/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/cart_item_metafields/get_metafields_attached_to_cart_items_of_specific_cart.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, cart_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to cart items of specific cart
+    
+    To get information of metafield attached to cart items of specific cart
+    
+    Path: GET /carts/{cart_id}/items/metafields
+    """
+    # 构建请求 URL
+    url = f"carts/{cart_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/carts/bulk_add_items_to_cart.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
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    product_id: Optional[str] = None
+    """Product ID
+       商品 ID"""
+    type: Optional[str] = None
+    """The Type of Item
+       購物車物品類型"""
+    created_by: Optional[str] = None
+    """The Source of Item
+       購物車物品加入的來源"""
+    quantity: Optional[float] = None
+    """Quantity
+       數量"""
+    variation_id: Optional[str] = None
+    """Product Variation ID
+       商品規格 ID"""
+    item_price: Optional[Dict[str, Any]] = None
+    """Custom Price（Use this field when type is custom discount）
+       自訂折扣/商品價格（當類型是自訂折扣/商品，請在此欄位填寫價格）"""
+    item_data: Optional[Dict[str, Any]] = None
+    """Data of the cart item
+      
+        購物車物品類型資料"""
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    code: Optional[str] = None
+    message: Optional[str] = None
+    data: Optional[Dict[str, Any]] = None
+    trace_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Add Items to Cart
+    
+    Bulk add items to cart.
+     購物車加入商品
+    
+    Path: POST /carts/{id}/items
+    """
+    # 构建请求 URL
+    url = f"carts/{id}/items"
+
+    # 构建请求头
+    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/carts/bulk_delete_cart_items.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
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    code: Optional[str] = None
+    message: Optional[str] = None
+    data: Optional[Dict[str, Any]] = None
+    trace_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Delete Cart Items
+    
+    Bulk delete cart items.
+     刪除購物車商品
+    
+    Path: DELETE /carts/{id}/items
+    """
+    # 构建请求 URL
+    url = f"carts/{id}/items"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.delete(
+        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/carts/bulk_patch_cart_items.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
+
+
+class ItemsItem(BaseModel):
+    """Item model for items"""
+    id: Optional[str] = None
+    quantity: Optional[float] = None
+    variation_id: Optional[str] = None
+
+class Request(BaseModel):
+    """请求体模型"""
+    items: Optional[List[ItemsItem]] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    code: Optional[str] = None
+    message: Optional[str] = None
+    data: Optional[Dict[str, Any]] = None
+    trace_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Patch Cart Items
+    
+    Bulk patch cart items.
+     更新購物車商品數量
+    
+    Path: PATCH /carts/{id}/items
+    """
+    # 构建请求 URL
+    url = f"carts/{id}/items"
+
+    # 构建请求头
+    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/carts/get_cart.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.cart import Cart
+
+class Request(BaseModel):
+    """查询参数模型"""
+    calculate_all: Optional[bool] = None
+    """To calculate info for checkout usage, only turn this option on when you ready to checkout.
+       用於計算結帳相關資訊，僅在準備結帳時啟用此選項"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    code: Optional[str] = None
+    message: Optional[str] = None
+    data: Optional[Cart] = None
+    trace_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Cart
+    
+    To get cart information by inputting cart id
+     以購物車ID取得該購物車資料
+    
+    Path: GET /carts/{id}
+    """
+    # 构建请求 URL
+    url = f"carts/{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 Response(**response_data)

shopline_sdk/apis/carts/get_cart_id.py

@@ -0,0 +1,74 @@
+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):
+    """查询参数模型"""
+    owner_id: str
+    """owner id of the cart, could be user_id or public session id.
+       購物車擁有者ID，登入會員的購物車此值是 user_id; 訪客的購物車則是 public_session_id"""
+    owner_type: Literal['User', 'Guest']
+    """owner type of the cart, could be User or Guest only.
+       購物車擁有者類型，登入會員的購物車此值是 User; 訪客的購物車則是 Guest"""
+    shop_session_id: Optional[str] = None
+    """識別不同商務平台的直播購物車之 shop_session_id"""
+    page_id: Optional[str] = None
+    """一頁式商店 (express checkout)購物車的 page_id"""
+    product_id: Optional[str] = None
+    """快速結帳立即購買 (fast_checkout)購物車的 product_id"""
+    channel_id: Optional[str] = None
+    """購物車渠道 channel_id"""
+    created_by: Optional[str] = None
+    """購物車的建立來源"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    code: Optional[str] = None
+    message: Optional[str] = None
+    data: Optional[Dict[str, Any]] = None
+    trace_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Cart Id
+    
+    To retrieve or generate a cart_id using cart identifiers.
+     The cart_id remains valid until checkout is completed. If a cart is not found, a new one will be created.
+     使用購物車識別欄位搜索或生成購物車 ID，購物車 ID在結帳完成前有效，若找不到對應的購物車，將自動創建新購物車
+    
+    Path: GET /carts/find
+    """
+    # 构建请求 URL
+    url = "carts/find"
+
+    # 构建查询参数
+    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/categories/bulk_assign.py

@@ -0,0 +1,75 @@
+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.category import Category
+from ...models.merchant import Merchant
+from ...models.product import Product
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    product_ids: List[str]
+    """Array of product id
+      商品id"""
+    category_ids: List[str]
+    """Array of category id
+      商品分類id"""
+    is_bulk_remove: Optional[bool] = None
+    """bulk remove or add, default false
+      批量添加還是移除,默認為false"""
+    unset_other_categories: Optional[bool] = None
+    """if products in other categories, unset other categories, default false
+       如果商品在其他分類，是否從其他分類刪除，默認為false"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Assign
+    
+    To add or remove bulk products to categories
+    從指定分類批量添加或移除商品
+    
+    Path: POST /categories/bulk_assign
+    """
+    # 构建请求 URL
+    url = "categories/bulk_assign"
+
+    # 构建请求头
+    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 == 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/categories/bulk_update_category_product_sorting.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+
+class DataItem(BaseModel):
+    """Item model for data"""
+    product_id: Optional[str] = None
+    """The Product ID
+      欲排序的商品 ID"""
+    ancestor: Optional[str] = None
+    """Previous Product ID
+      欲排序的前一個商品 ID"""
+    descendant: Optional[str] = None
+    """Previous Product ID
+      欲排序的後一個商品 ID"""
+
+class Request(BaseModel):
+    """请求体模型"""
+    data: Optional[List[DataItem]] = None
+    """Product ID, Ancestor, Descendant
+      批量更新的商品 ID"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    job_tracker_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Update Category Product Sorting
+    
+    To bulk update category product sorting.
+    批量更新分類中商品的排序
+    
+    Path: PUT /categories/{id}/products_sorting
+    """
+    # 构建请求 URL
+    url = f"categories/{id}/products_sorting"
+
+    # 构建请求头
+    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 == 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)