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

shopline_sdk/apis/channels/update_product_channel_price.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.price_set import PriceSet
+
+async def call(
+    session: aiohttp.ClientSession, channel_id: str, product_id: str, id: str, data: Optional[Dict[str, Any]] = None
+) -> PriceSet:
+    """
+    Update Product Channel Price
+    
+    To update product channel price
+    更新商品分店價格
+    
+    Path: PUT /channels/{channel_id}/products/{product_id}/prices/{id}
+    """
+    # 构建请求 URL
+    url = f"channels/{channel_id}/products/{product_id}/prices/{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 PriceSet(**response_data)

shopline_sdk/apis/conversations/create_order_message.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.not_found_error import NotFoundError
+from ...models.order_comment import OrderComment
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    text: Optional[str] = None
+    """The message of the comment
+      該訂單通訊的訊息內容"""
+    media_id: Optional[str] = None
+    """The id of the media
+      該訂單通訊的媒體id"""
+    is_private: Optional[bool] = None
+    """The type of the comment. 
+       If true, the message can only be viewed by the shop admin.
+       If false, the message can also be viewed by the customer.
+       訂單通訊的類型。若為true，則該訂單通訊只能被網店管理查看。
+       若為false，則顧客也可查看。"""
+    send_by: Optional[Literal['merchant', 'customer']] = None
+    """The message sender
+      該訂單通訊的發送者"""
+    trackable_type: Optional[str] = None
+    trackable_id: Optional[str] = None
+    custom_data: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> OrderComment:
+    """
+    Create Order Message
+    
+    To create an order reply
+    創建訂單留言
+    
+    Path: POST /orders/{id}/messages
+    """
+    # 构建请求 URL
+    url = f"orders/{id}/messages"
+
+    # 构建请求头
+    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 OrderComment(**response_data)

shopline_sdk/apis/conversations/create_return_order_message.py

@@ -0,0 +1,90 @@
+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.order_comment import OrderComment
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    text: Optional[str] = None
+    """The message of the comment
+      該退貨單通訊的訊息內容"""
+    media_id: Optional[str] = None
+    """The id of the media
+      該退貨單通訊的媒體id"""
+    is_private: Optional[bool] = None
+    """The type of the comment. 
+       If true, the message can only be viewed by the shop admin.
+       If false, the message can also be viewed by the customer.
+       訂單通訊的類型。若為true，則該訂單通訊只能被網店管理查看。
+       若為false，則顧客也可查看。目前只開放給網店管理查看。"""
+    send_by: Optional[Literal['merchant']] = None
+    """The message sender
+      該訂單通訊的發送者"""
+    trackable_type: Optional[str] = None
+    trackable_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> OrderComment:
+    """
+    Create Return Order Message (Not Available Yet)
+    
+    To create an return order note
+    創建退貨單備註
+    
+    Path: POST /return_orders/{id}/messages
+    """
+    # 构建请求 URL
+    url = f"return_orders/{id}/messages"
+
+    # 构建请求头
+    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 OrderComment(**response_data)

shopline_sdk/apis/conversations/create_shop_message.py

@@ -0,0 +1,81 @@
+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.shop_conversation import ShopConversation
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    text: Optional[str] = None
+    """The text of the message
+      訊息內容"""
+    media_id: Optional[str] = None
+    """The id of the media
+      訊息媒體id"""
+    sender_id: Optional[str] = None
+    """The message sender ID
+      訊息發送者ID"""
+    sender_email: Optional[str] = None
+    """The message sender email
+      訊息發送者email"""
+    recipient_id: Optional[str] = None
+    """The message recipient ID
+      訊息接收者ID"""
+    ref_data: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> ShopConversation:
+    """
+    Create Shop Message
+    
+    To create shop messages
+    創建商店訊息
+    
+    Path: POST /conversations/message
+    """
+    # 构建请求 URL
+    url = "conversations/message"
+
+    # 构建请求头
+    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 == 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 ShopConversation(**response_data)

shopline_sdk/apis/conversations/get_conversations.py

@@ -0,0 +1,76 @@
+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.order_conversations import OrderConversations
+from ...models.server_error import ServerError
+from ...models.shop_conversations import ShopConversations
+
+class Request(BaseModel):
+    """查询参数模型"""
+    platform: Literal['shop_messages', 'order_messages', 'return_order_messages']
+    """Conversation from shop or order
+      網店訊息或是訂單訊息
+      return_order_messages 尚未開放"""
+    customer_id: Optional[str] = None
+    """Customer ID
+      客戶ID"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Conversation per Page
+      每頁顯示 n 筆資料"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> ShopConversations:
+    """
+    Get Conversations
+    
+    Get Conversations
+    獲取對話列表
+    
+    Path: GET /conversations
+    """
+    # 构建请求 URL
+    url = "conversations"
+
+    # 构建查询参数
+    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 ShopConversations(**response_data)

shopline_sdk/apis/conversations/get_messages.py

@@ -0,0 +1,76 @@
+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.order_conversations_messages import OrderConversationsMessages
+from ...models.server_error import ServerError
+from ...models.shop_conversations_messages import ShopConversationsMessages
+
+class Request(BaseModel):
+    """查询参数模型"""
+    platform: Literal['shop_messages', 'order_messages', 'return_order_messages']
+    """Conversation from shop or order
+      網店訊息或是訂單訊息
+      return_order_messages 尚未開放"""
+    limit: Optional[int] = None
+    """Numbers of Messages of Conversations
+      顯示 n 筆資料"""
+    start: Optional[str] = None
+    """Messages Start From
+      訊息開始時間"""
+    end: Optional[str] = None
+    """Messages End Before
+      訊息結束時間"""
+
+async def call(
+    session: aiohttp.ClientSession, conversationId: str, request: Optional[Request] = None
+) -> ShopConversationsMessages:
+    """
+    Get Messages
+    
+    Get Conversations
+    獲取對話訊息列表
+    
+    Path: GET /conversations/{conversationId}/messages
+    """
+    # 构建请求 URL
+    url = f"conversations/{conversationId}/messages"
+
+    # 构建查询参数
+    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 ShopConversationsMessages(**response_data)

shopline_sdk/apis/custom_fields/get_custom_fields.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.custom_field import CustomField
+
+async def call(
+    session: aiohttp.ClientSession
+) -> List[CustomField]:
+    """
+    Get Custom Fields
+    
+    To get custom fields within customer data.
+    獲取顧客自訂欄位
+    
+    Path: GET /custom_fields
+    """
+    # 构建请求 URL
+    url = "custom_fields"
+
+    # 构建请求头
+    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 [CustomField(**item) for item in response_data]

shopline_sdk/apis/customer_app_metafields/create_specific_app_metafield.py

@@ -0,0 +1,44 @@
+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.app_metafield_value import AppMetafieldValue
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, data: Optional[Dict[str, Any]] = None
+) -> AppMetafieldValue:
+    """
+    Create specific app metafield
+    
+    To create app metafield attached to specific customer
+    
+    Path: POST /customers/{customer_id}/app_metafields
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/app_metafields"
+
+    # 构建请求头
+    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 AppMetafieldValue(**response_data)

shopline_sdk/apis/customer_app_metafields/delete_specific_app_metafield.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
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, metafield_id: str
+) -> Response:
+    """
+    Delete specific app metafield
+    
+    To delete information of app metafield attached to specific customer by metafield ID
+    
+    Path: DELETE /customers/{customer_id}/app_metafields/{metafield_id}
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/app_metafields/{metafield_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
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/customer_app_metafields/get_app_metafields_attached_to_specific_customer.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
+
+# 导入需要的模型
+from ...models.app_metafield_value import AppMetafieldValue
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filters: Optional[List[str]] = None
+    """Search criteria
+       In format of {key}:{value}
+       {key} - required
+       {value} - optional"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AppMetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to specific customer
+    
+    To get information of app metafield attached to specific customer
+    
+    Path: GET /customers/{customer_id}/app_metafields
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/app_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)