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

shopline_sdk/apis/promotions/get_promotions.py

@@ -0,0 +1,106 @@
+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.promotion import Promotion
+
+class Request(BaseModel):
+    """查询参数模型"""
+    updated_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 updated_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 updated_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    created_after: Optional[str] = None
+    """Filter data by those created after specific time.
+       取得 created_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    created_before: Optional[str] = None
+    """Filter data by those created before specific time.
+       取得 created_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    start_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 start_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    start_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 start_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    end_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 end_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    end_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 end_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    customer_id: Optional[str] = None
+    """用戶id"""
+    scope: Optional[Literal['valid', 'invalid']] = None
+    """promotion是否失效 (搭配customer_id使用)"""
+    promotion_ids: Optional[List[str]] = None
+    """Filter promotions by IDs.
+       The promotion_ids parameter must be used standalone.
+       透過 IDs 獲取相關優惠活動，此參數須單獨使用。"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料
+       上限 100"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Promotion]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Promotions
+    
+    To get detailed information of couple promotions sorted by time
+    利用時間範圍選取與排序獲取數筆優惠活動
+    
+    Path: GET /promotions
+    """
+    # 构建请求 URL
+    url = "promotions"
+
+    # 构建查询参数
+    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/promotions/search_promotions.py

@@ -0,0 +1,108 @@
+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.promotion import Promotion
+
+class Request(BaseModel):
+    """查询参数模型"""
+    updated_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 updated_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    updated_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 updated_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    created_after: Optional[str] = None
+    """Filter data by those created after specific time.
+       取得 created_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    created_before: Optional[str] = None
+    """Filter data by those created before specific time.
+       取得 created_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    start_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 start_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    start_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 start_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    end_after: Optional[str] = None
+    """Filter data by those updated after specific time.
+       取得 end_at 大於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    end_before: Optional[str] = None
+    """Filter data by those updated before specific time.
+       取得 end_at 小於指定時間的優惠活動(包含指定時間)
+       *Should use UTC time'"""
+    apply_method: Optional[Literal['auto_apply', 'coupon', 'affiliate_campaign']] = None
+    """使用方式"""
+    coupon_type: Optional[List[Literal['draw', 'single', 'multi']]] = None
+    """優惠券類別"""
+    status: Optional[Literal['active', 'draft', 'hidden']] = None
+    """狀態"""
+    available_count: Optional[str] = None
+    """剩餘可抽取量"""
+    discount_on: Optional[Literal['order', 'item', 'category']] = None
+    """優惠作用範圍"""
+    discount_type: Optional[List[Literal['percentage', 'amount', 'free_shipping', 'gift', 'addon', 'bundle_pricing', 'bundle_group', 'bundle_percentage', 'bundle_amount', 'bundle_gift', 'bundle_group_percentage', 'bundle_group_amount', 'bundle_group_gift', 'buyandget_free', 'buyandget_pricing', 'buyandget_percentage', 'subscription_gift', 'subscription_percentage', 'subscription_amount', 'member_point_redeem_gift', 'credit_reward', 'point_reward', 'earn_purchase_points']]] = None
+    """優惠類別"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Promotion]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Search Promotions
+    
+    Search Promotion
+    
+    Path: GET /promotions/search
+    """
+    # 构建请求 URL
+    url = "promotions/search"
+
+    # 构建查询参数
+    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/promotions/update_promotion.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.promotion import Promotion
+
+async def call(
+    session: aiohttp.ClientSession, id: str, data: Optional[Dict[str, Any]] = None
+) -> Promotion:
+    """
+    Update Promotion
+    
+    To update detailed information of couple promotions
+    更新優惠活動 
+    
+    <strong> * Cannot update the conditions </strong> 
+    Updating promotion condition requires the condition id . 
+    Providing the condition id will <strong>NOT</strong> update the condition. 
+    <strong> Need endpoints for create and update condition.</strong> 
+    <strong> * 不能更新活動條件 </strong> 
+    更新活動的條件須要 condition id. 
+    但提供 condition id <strong>不會</strong> 更新條件的值。 
+    <strong> 需要建立和更新 條件 的功能。 </strong>
+    
+    Path: PUT /promotions/{id}
+    """
+    # 构建请求 URL
+    url = f"promotions/{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 Promotion(**response_data)

shopline_sdk/apis/purchase_orders/create_child_purchase_order.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.not_found_error import NotFoundError
+from ...models.purchase_order import PurchaseOrder
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    purchase_order: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, PurchaseOrderId: str, request: Optional[Request] = None
+) -> PurchaseOrder:
+    """
+    Create child purchase order
+    
+    Create child purchase order
+    建立子進貨單
+    
+    Path: POST /pos/purchase_orders/{PurchaseOrderId}/child
+    """
+    # 构建请求 URL
+    url = f"pos/purchase_orders/{PurchaseOrderId}/child"
+
+    # 构建请求头
+    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 == 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 PurchaseOrder(**response_data)

shopline_sdk/apis/purchase_orders/create_purchase_order.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.not_found_error import NotFoundError
+from ...models.purchase_order import PurchaseOrder
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    purchase_order: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> PurchaseOrder:
+    """
+    Create purchase order
+    
+    Create purchase order
+    創建進貨單
+    
+    Path: POST /pos/purchase_orders
+    """
+    # 构建请求 URL
+    url = "pos/purchase_orders"
+
+    # 构建请求头
+    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 == 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 PurchaseOrder(**response_data)

shopline_sdk/apis/purchase_orders/delete_the_specified_purchase_orders.py

@@ -0,0 +1,60 @@
+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 Request(BaseModel):
+    """查询参数模型"""
+    ids: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Delete the specified purchase orders
+    
+    Delete the specified purchase orders
+    批量刪除進貨單
+    
+    Path: PUT /pos/purchase_orders/bulk_delete
+    """
+    # 构建请求 URL
+    url = "pos/purchase_orders/bulk_delete"
+
+    # 构建查询参数
+    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.put(
+        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_data

shopline_sdk/apis/purchase_orders/get_purchase_orders.py

@@ -0,0 +1,89 @@
+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.purchase_orders import PurchaseOrders
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    query: Optional[str] = None
+    """PurchaseOrder's number
+      進貨單號碼"""
+    type: Optional[str] = None
+    """PurchaseOrder's type
+      進貨單類型"""
+    statuses: Optional[List[str]] = None
+    """PurchaseOrder's statuses
+      進貨單狀態"""
+    arrival_statuses: Optional[List[str]] = None
+    """PurchaseOrder's arrival statuses
+      進貨單到貨狀態"""
+    channel_id: Optional[str] = None
+    """PurchaseOrder's channel ID
+      進貨單門市ID"""
+    start_date: Optional[str] = None
+    """PurchaseOrder's created at after date
+      進貨單創建時間起始日"""
+    end_date: Optional[str] = None
+    """PurchaseOrder's created at before date
+      進貨單創建時間終止日"""
+    supplier_id: Optional[str] = None
+    """PurchaseOrder's supplier ID
+      進貨單供應商"""
+    item_detail: Optional[bool] = None
+    """Is PurchaseOrder's item detail required
+      是否顯示進貨單項目細節"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> PurchaseOrders:
+    """
+    Get purchase orders
+    
+    Get purchase orders
+    取得進貨單
+    
+    Path: GET /pos/purchase_orders
+    """
+    # 构建请求 URL
+    url = "pos/purchase_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 PurchaseOrders(**response_data)

shopline_sdk/apis/purchase_orders/get_the_specified_purchase_order.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.not_found_error import NotFoundError
+from ...models.purchase_order import PurchaseOrder
+from ...models.server_error import ServerError
+
+async def call(
+    session: aiohttp.ClientSession, PurchaseOrderId: str
+) -> PurchaseOrder:
+    """
+    Get the specified purchase order
+    
+    Get the specified purchase order by PurchaseOrderId
+    透過 id 取得進貨單資訊
+    
+    Path: GET /pos/purchase_orders/{PurchaseOrderId}
+    """
+    # 构建请求 URL
+    url = f"pos/purchase_orders/{PurchaseOrderId}"
+
+    # 构建请求头
+    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 == 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 PurchaseOrder(**response_data)

shopline_sdk/apis/purchase_orders/update_purchase_order.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.not_found_error import NotFoundError
+from ...models.purchase_order import PurchaseOrder
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    purchase_order: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, PurchaseOrderId: str, request: Optional[Request] = None
+) -> PurchaseOrder:
+    """
+    Update purchase order
+    
+    Update purchase order
+    更新進貨單
+    
+    Path: PUT /pos/purchase_orders/{PurchaseOrderId}
+    """
+    # 构建请求 URL
+    url = f"pos/purchase_orders/{PurchaseOrderId}"
+
+    # 构建请求头
+    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 == 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 PurchaseOrder(**response_data)