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

shopline_sdk/apis/customer_app_metafields/get_specific_app_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.app_metafield_value import AppMetafieldValue
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, metafield_id: str
+) -> AppMetafieldValue:
+    """
+    Get specific app metafield
+    
+    To get information of app metafield attached to a customer by metafield ID
+    
+    Path: GET /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.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 AppMetafieldValue(**response_data)

shopline_sdk/apis/customer_app_metafields/update_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, metafield_id: str, data: Optional[Dict[str, Any]] = None
+) -> AppMetafieldValue:
+    """
+    Update specific app metafield
+    
+    To update information of app metafield attached to specify customer by metafield ID
+    
+    Path: PUT /customers/{customer_id}/app_metafields/{metafield_id}
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/app_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 AppMetafieldValue(**response_data)

shopline_sdk/apis/customer_group_children/get_children_group_of_the_customer_group.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.customer_group import CustomerGroup
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page
+      頁數
+      (Default: 1)"""
+    per_page: Optional[int] = None
+    """Numbers of Child Customer Groups per page
+      每頁顯示 n 筆資料
+      (Default: 24, Max: 999)"""
+    sort_by: Optional[str] = None
+    """Setting sort by created time
+      設定依照建立時間排序
+      (Default: desc)"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    parent: Optional[CustomerGroup] = None
+    children: Optional[List[CustomerGroup]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, parentCustomerGroupId: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Children Group of the Customer Group
+    
+    To get child customer groups of the customer group.
+    取得母分群的子分群。
+    
+    Path: GET /customer_groups/{parentCustomerGroupId}/customer_group_children
+    """
+    # 构建请求 URL
+    url = f"customer_groups/{parentCustomerGroupId}/customer_group_children"
+
+    # 构建查询参数
+    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 == 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/customer_groups/get_customer_group.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.customer_group import CustomerGroup
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[CustomerGroup]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Get Customer Group
+    
+    To get customer group info by inputing customer group.
+    輸入顧客分群ID取得顧客分群資訊。
+    
+    Path: GET /customer_groups/{id}
+    """
+    # 构建请求 URL
+    url = f"customer_groups/{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()
+            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/customer_groups/get_customer_groups.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.customer_group import CustomerGroup
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page
+      頁數
+      (Default: 1)"""
+    per_page: Optional[int] = None
+    """Numbers of Customers per page
+      每頁顯示 n 筆資料
+      (Default: 24, Max: 999)"""
+    sort_by: Optional[str] = None
+    """Setting sort by created time
+      設定依照建立時間排序
+      (Default: desc)"""
+    created_after: Optional[str] = None
+    """Filter customers which is later than created_after
+      篩選依據 created_after 時間之後建立的分群
+      -
+       Please fill in to the second level. Default value is 00:00:00 if only fill in dates.
+      請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00"""
+    created_before: Optional[str] = None
+    """Filter customers which is earlier than created_before
+      篩選依據 created_before 時間之前建立的分群
+      -
+       Please fill in to the second level. Default value is 00:00:00 if only fill in dates.
+      請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00"""
+    status: Optional[Literal['active', 'expired']] = None
+    """Filter the customer group is active or expired.
+       篩選已過期或未過期的顧客分群
+      -
+       If the value isn't given, it will return all customer groups.
+      若不填寫，則會回傳所有顧客分群
+       Don't use created_before or created_after if the status is given.
+       若有設定 status 欄位，則不要同時設定 created_before 或 created_before 參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[CustomerGroup]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Customer Groups
+    
+    To get customer groups.
+    獲取顧客分群。
+    
+    Path: GET /customer_groups
+    """
+    # 构建请求 URL
+    url = "customer_groups"
+
+    # 构建查询参数
+    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 == 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/customer_groups/get_customer_ids_of_the_specific_customer_group.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.not_found_error import NotFoundError
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the customer_ids in the previous request."""
+
+class Response(BaseModel):
+    """响应体模型"""
+    customer_ids: Optional[List[str]] = None
+    last_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get customer ids of the specific customer group.
+    
+    To get customer ids of the specific customer group.
+    獲取顧客分群的 ID。
+    
+    Path: GET /customer_groups/{id}/customer_ids
+    """
+    # 构建请求 URL
+    url = f"customer_groups/{id}/customer_ids"
+
+    # 构建查询参数
+    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 == 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)

shopline_sdk/apis/customer_groups/search_customer_groups.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.customer_group import CustomerGroup
+from ...models.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    page: Optional[int] = None
+    """Page
+      頁數
+      (Default: 1)"""
+    per_page: Optional[int] = None
+    """Numbers of Customers per page
+      每頁顯示 n 筆資料
+      (Default: 24, Max: 999)"""
+    query: Optional[str] = None
+    """Support searching fields below:
+      支援搜尋以下欄位:
+      customer_group_name"""
+    sort_by: Optional[str] = None
+    """Setting sort by created time
+      設定依照建立時間排序
+      (Default: desc)"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[CustomerGroup]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Search Customer Groups
+    
+    To search customer groups with specific conditions.
+    利用特殊條件搜尋顧客分群。
+    
+    Path: GET /customer_groups/search
+    """
+    # 构建请求 URL
+    url = "customer_groups/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()
+            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/customer_metafields/create_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, data: Optional[Dict[str, Any]] = None
+) -> MetafieldValue:
+    """
+    Create specific metafield
+    
+    To create metafield attached to specific customer by metafield ID
+    
+    Path: POST /customers/{customer_id}/metafields
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/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 MetafieldValue(**response_data)

shopline_sdk/apis/customer_metafields/delete_specific_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 metafield
+    
+    To delete information of metafield attached to specific customer by metafield ID
+    
+    Path: DELETE /customers/{customer_id}/metafields/{metafield_id}
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/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_metafields/get_metafields_attached_to_specific_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.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, customer_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to specific customer
+    
+    To get information of metafield attached to specific customer
+    
+    Path: GET /customers/{customer_id}/metafields
+    """
+    # 构建请求 URL
+    url = f"customers/{customer_id}/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)