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

shopline_sdk/apis/customer_metafields/get_specific_metafield.py

@@ -0,0 +1,41 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, metafield_id: str
+) -> MetafieldValue:
+    """
+    Get specific metafield
+    
+    To get information of metafield attached to a customer by metafield ID
+    
+    Path: GET /customers/{customer_id}/metafields/{metafield_id}
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/metafields/{metafield_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 MetafieldValue(**response_data)

shopline_sdk/apis/customer_metafields/update_specific_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.metafield_value import MetafieldValue
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, metafield_id: str, data: Optional[Dict[str, Any]] = None
+) -> MetafieldValue:
+    """
+    Update specific metafield
+    
+    To update information of metafield attached to specify customer by metafield ID
+    
+    Path: PUT /customers/{customer_id}/metafields/{metafield_id}
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/metafields/{metafield_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 MetafieldValue(**response_data)

shopline_sdk/apis/customers/add_or_remove_customer_tags.py

@@ -0,0 +1,93 @@
+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: Taggable
+    update_mode: Literal['add', 'remove']
+    """Update Mode
+      更新模式"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    tags: Optional[Taggable] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Add or remove customer tags
+    
+    To add or remove customer tags with customer IDs.
+     Each tag mush have at least 3 characters and at most 40 characters.
+     When removing tags, there is no character length limit.
+     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: PATCH /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.patch(
+        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/customers/create_customer.py

@@ -0,0 +1,87 @@
+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.customer import Customer
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    excludes: Optional[List[str]] = None
+    """Exclude certain parameters in the response
+      結果要排除哪些參數"""
+    fields: Optional[List[str]] = None
+    """Only show certain parameters in the response
+       結果只顯示哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Customer:
+    """
+    Create Customer
+    
+    To create a customer with open API
+    透過open API創建一筆新的顧客資料
+    
+    Path: POST /customers
+    """
+    # 构建请求 URL
+    url = "customers"
+
+    # 构建查询参数
+    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 == 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 Customer(**response_data)

shopline_sdk/apis/customers/delete_customer.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.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete Customer
+    
+    To delete customer with open API
+    透過open API刪除客戶
+    
+    Path: DELETE /customers/{id}
+    """
+    # 构建请求 URL
+    url = f"customers/{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()
+            if response.status == 401:
+                error_model = UnauthorizedError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=401,
+                    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/customers/get_customer.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.customer import Customer
+from ...models.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    excludes: Optional[List[str]] = None
+    """Exclude certain parameters in the response
+      結果要排除哪些參數"""
+    fields: Optional[List[Literal['membership_tier_gap']]] = None
+    """Only show certain parameters in the response
+       This field will have conflicts to the include_fields[]
+       To avoid the conflicts
+       please also input all the items included in the include_fields[] to this field
+       otherwise those fields will not be shown
+       結果只顯示哪些參數
+       這個欄位會跟include_fields[]的欄位有衝突
+       要避免衝突的話，請輸入所有也包括在include_fields[]內的項目
+       否則那些項目將不能被顯示"""
+    include_fields: Optional[List[Literal['metafields']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Customer:
+    """
+    Get Customer
+    
+    To get detailed information for a specific customer with its ID
+    使用顧客ID獲取特定一個顧客的詳細資料
+    
+    Path: GET /customers/{id}
+    """
+    # 构建请求 URL
+    url = f"customers/{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()
+            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 == 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 Customer(**response_data)

shopline_sdk/apis/customers/get_customer_member_points_history.py

@@ -0,0 +1,92 @@
+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_points import MemberPoints
+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):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of records per Page
+      每頁顯示 n 筆資料"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> MemberPoints:
+    """
+    Get Customer member points History
+    
+    To get member points history of a customer
+    獲取顧客的會員點數紀錄
+    
+    Path: GET /customers/{id}/member_points
+    """
+    # 构建请求 URL
+    url = f"customers/{id}/member_points"
+
+    # 构建查询参数
+    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 == 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 MemberPoints(**response_data)

shopline_sdk/apis/customers/get_customer_store_credit_history.py

@@ -0,0 +1,98 @@
+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.paginatable import Paginatable
+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):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of records per Page
+      每頁顯示 n 筆資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[StoreCredit]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Customer Store Credit History
+    
+    To get store credit history of a customer
+    獲取顧客的商店購物金紀錄
+    
+    Path: GET /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"}
+
+    # 发起 HTTP 请求
+    async with session.get(
+        url, params=params, 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 Response(**response_data)