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

shopline_sdk/apis/customers/update_customer_member_points.py

@@ -0,0 +1,113 @@
+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.member_point import MemberPoint
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    value: int
+    """Points to be added or deducted
+      增加或減除點數
+      -
+      *Number can be -999999~999999"""
+    remarks: str
+    """Reason for adding or deducting member points
+      增加或減除點數原因
+      -
+      *Limit to max 50 characters"""
+    email_target: Optional[int] = None
+    """Notification with Email
+      是否發送email通知
+      Only applicable for addition
+      僅適用於增加
+      -
+       1=NOT_SEND全部不送
+       3=SEND_TO_ALL全部都送"""
+    sms_notification_target: Optional[int] = None
+    """Notification with SMS
+      是否發送簡訊通知
+      Only applicable for addition
+      僅適用於增加
+      -
+       1=NOT_SEND全部不送
+       2=SEND_VERIFIED只送手機驗證過的
+       3=SEND_TO_ALL全部都送"""
+    performer_id: Optional[str] = None
+    """Performer ID
+      操作者ID"""
+    performer_type: Optional[Literal['User', 'Agent']] = None
+    """Performer Type
+      操作者類型"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> MemberPoint:
+    """
+    Update Customer Member Points
+    
+    Using open API to update customer member points
+    
+    Path: POST /customers/{id}/member_points
+    """
+    # 构建请求 URL
+    url = f"customers/{id}/member_points"
+
+    # 构建请求头
+    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 == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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 MemberPoint(**response_data)

shopline_sdk/apis/customers/update_customer_store_credits.py

@@ -0,0 +1,172 @@
+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.store_credit import StoreCredit
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    value: int
+    """Credits to be added or deducted
+      增加或減除金額
+      -
+      *Number can be -999999~999999"""
+    remarks: str
+    """Reason for adding or deducting credits
+      增加或減除購物金原因
+      -
+      * Limit to max 50 characters"""
+    expires_at: Optional[str] = None
+    """Validity Period
+      有效期限
+      * Date cannot be in the past 
+      * Date should be within 9999 days from now"""
+    email_target: Optional[int] = None
+    """Notification with Email
+      是否發送email通知
+      Only applicable for addition
+      僅適用於增加
+      -
+       1=NOT_SEND全部不送
+       3=SEND_TO_ALL全部都送"""
+    sms_notification_target: Optional[int] = None
+    """Notification with SMS
+      是否發送簡訊通知
+      Only applicable for addition
+      僅適用於增加
+      -
+       1=NOT_SEND全部不送
+       2=SEND_VERIFIED只送手機驗證過的
+       3=SEND_TO_ALL全部都送"""
+    replace: Optional[bool] = None
+    """To replace all store credits with the current value
+      以此金額替代之前所有購物金"""
+    type: Optional[Literal['manual_credit', 'welcome_credit', 'birthday_credit', 'auto_reward', 'applied_credit', 'user_credit_expired', 'welcome_member_referral_credit', 'member_referral_credit', 'member_info_quick_completion_credit', 'order_split_revert', 'product_review_reward', 'return_order_revert', 'order_edit_revert']] = None
+    """Store credit type
+       購物金類型
+       * `manual_credit`
+       Manually assign store credit(s) to specific member
+       手動發送購物金給指定會員
+       * `welcome_credit`
+       Auto assign welcome credits to new registered members
+       發送購物金鼓勵顧客註冊會員和進行第一次購物
+       * `birthday_credit`
+       Auto assign store credits to members as gifts on their birthday
+       於會員的生日自動發送購物金作為生日禮物
+       * `auto_reward`
+       Auto reward customers with credits when they meet a minimum amount of purchase
+       當訂單達到最低金額時自動發送購物金給會員
+       * `applied_credit`
+       Applied user credits when placing an order
+       在下訂單時已折抵的購物金
+       * `user_credit_expired`
+       Expired user credits
+       已過期的購物金
+       * `welcome_member_referral_credit`
+       Referral will get store credits after sign up
+       新會員透過推薦連結註冊成為會員即可獲得購物金
+       * `member_referral_credit`
+       Referrer will get the reward after an order from referral is completed
+       新顧客註冊後在訂單轉為「已完成」後，推薦人即可獲得購物金
+       * `member_info_quick_completion_credit`
+       Member info reward credit
+       會員資料獎賞購物金
+       * `order_split_revert`
+       Order split revert credit
+       訂單拆單回補購物金
+       * `product_review_reward`
+       Product review reward credit
+       商品評價獎賞購物金
+       * `return_order_revert`
+       Return order revert credit
+       退貨單回補購物金
+       * `order_edit_revert`
+       Order edit revert credit
+       訂單編輯回補購物金"""
+    performer_id: Optional[str] = None
+    """Performer ID
+      操作者ID"""
+    performer_type: Optional[Literal['User', 'Agent']] = None
+    """Performer Type
+      操作者類型"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> StoreCredit:
+    """
+    Update Customer Store Credits
+    
+    To update customer store credits with open API
+    使用open API更新顧客購物金
+    
+    Path: POST /customers/{id}/store_credits
+    """
+    # 构建请求 URL
+    url = f"customers/{id}/store_credits"
+
+    # 构建查询参数
+    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.post(
+        url, params=params, json=json_data, headers=headers
+    ) as response:
+        if response.status >= 400:
+            error_data = await response.json()
+            if response.status == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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 StoreCredit(**response_data)

shopline_sdk/apis/customers/update_customer_subscriptions.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    sms: Optional[bool] = None
+    email: Optional[bool] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Update customer subscriptions
+    
+    Update customer subscriptions by user_id
+    透過顧客ID更新訂閱
+    
+    Path: PUT /customers/{customer_id}/subscriptions
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/subscriptions"
+
+    # 构建请求头
+    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_data

shopline_sdk/apis/customers/update_customer_tags.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.server_error import ServerError
+from ...models.taggable import Taggable
+from ...models.unauthorized_error import UnauthorizedError
+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 customer tags
+    
+    To update customer tags with customer IDs.
+     Each tag mush have at least 3 characters and at most 40 characters.
+     Each customer can have at most 60 customer tags.
+     When update with invalid length of tags, the update will fail and the respond will be 422.
+     When the amount of customer tags exceed 60,
+     the update will fail and return the current valid tags of that customer with status code 200.
+     使用顧客ID更新顧客標籤。
+     每一個顧客標籤必須有最少3個字完及最多40個字完。
+     每一個顧客最多只能有60個顧客標籤。
+     若需更新的顧客標籤其中之一不符字完長度規範，更新不會成功及將回傳狀態碼422。 若需更新的顧客標籤超過60個時，
+     更新將不會成功，且仍會回傳狀態碼200及當前顧客的有效顧客標籤。
+    
+    
+    Path: PUT /customers/{id}/tags
+    """
+    # 构建请求 URL
+    url = f"customers/{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 == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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/delivery_options/get_delivery_config.py

@@ -0,0 +1,52 @@
+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):
+    """查询参数模型"""
+    type: str
+    """Region Type
+      自訂物流種類"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Get Delivery Config
+    
+    To get delivery config for pickup
+    透過open API獲取自訂物流的設定
+    
+    Path: GET /delivery_options/delivery_config
+    """
+    # 构建请求 URL
+    url = "delivery_options/delivery_config"
+
+    # 构建查询参数
+    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_data

shopline_sdk/apis/delivery_options/get_delivery_option.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.delivery_option import DeliveryOption
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> DeliveryOption:
+    """
+    Get Delivery Option
+    
+    To get delivery option information by inputing delivery option ID
+    輸入送貨方式ID取得該送貨方式資訊
+    
+    Path: GET /delivery_options/{id}
+    """
+    # 构建请求 URL
+    url = f"delivery_options/{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 DeliveryOption(**response_data)

shopline_sdk/apis/delivery_options/get_delivery_options.py

@@ -0,0 +1,65 @@
+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.delivery_option import DeliveryOption
+from ...models.paginatable import Paginatable
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[DeliveryOption]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Delivery Options
+    
+    To get all kinds of delivery options with open API
+    透過open API獲取所有的送貨方式
+    
+    Path: GET /delivery_options
+    """
+    # 构建请求 URL
+    url = "delivery_options"
+
+    # 构建查询参数
+    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/delivery_options/get_delivery_time_slots.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.delivery_time_slot import DeliveryTimeSlot
+
+class Request(BaseModel):
+    """查询参数模型"""
+    date: Optional[str] = None
+    """Date
+      指定日期"""
+    ignore_availability: Optional[bool] = None
+    """Ignore Availability
+      是否忽略可用性"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[DeliveryTimeSlot]] = None
+
+async def call(
+    session: aiohttp.ClientSession, delivery_option_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Delivery Time Slots
+    
+    To get all delivery time slots with open API
+    透過open API獲取所有的送貨時段
+    
+    Path: GET /delivery_options/{delivery_option_id}/delivery_time_slots
+    """
+    # 构建请求 URL
+    url = f"delivery_options/{delivery_option_id}/delivery_time_slots"
+
+    # 构建查询参数
+    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)