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

shopline_sdk/apis/customers/get_customers.py

@@ -0,0 +1,127 @@
+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.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+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"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of records per Page
+      每頁顯示 n 筆資料"""
+    sort_by: Optional[Literal['asc', 'desc']] = None
+    """Setting sort by created time
+      設定創建時間排序"""
+    previous_id: Optional[str] = None
+    """Customer id before the first record of the target records as pagination cursor
+       目標資料的第一個顧客的前一個顧客ID，同作分頁標記。
+       * If "previous_id" is provided, this operation will ignore "page" param. 
+       * 如果使用param "previous_id"，這次操作會忽略param "page" """
+    include_fields: Optional[List[Literal['metafields']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+    fields: Optional[List[str]] = 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[]內的項目
+       否則那些項目將不能被顯示"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Customer]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Customers
+    
+    To get detailed information of couple customers sorted by time
+    利用時間範圍選取與排序獲取數筆顧客資料
+    
+    Path: GET /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"}
+
+    # 发起 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 == 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/get_line_customer.py

@@ -0,0 +1,67 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, lineId: str
+) -> Customer:
+    """
+    Get Line Customer
+    
+    To get detailed information for a specific customer with its Line ID
+    使用顧客用來註冊的Line ID獲取特定一個顧客的詳細資料
+    
+    Path: GET /customers/line/{lineId}
+    """
+    # 构建请求 URL
+    url = f"customers/line/{lineId}"
+
+    # 构建请求头
+    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 == 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/getcustomers_smembershipinfo.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.membership_info import MembershipInfo
+from ...models.paginatable import Paginatable
+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 筆資料"""
+    customer_ids: Optional[List[str]] = None
+    """The result only shows the selected customers
+      結果只顯示指定的顧客群"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MembershipInfo]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Customers's Membership Info
+    
+    To get detailed information of the membership of the customers
+     獲取顧客的會員資料
+    
+    Path: GET /customers/membership_info
+    """
+    # 构建请求 URL
+    url = "customers/membership_info"
+
+    # 构建查询参数
+    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 == 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/search_customers.py

@@ -0,0 +1,216 @@
+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.paginatable import Paginatable
+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
+      頁數
+      (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:
+      支援搜尋以下欄位:
+      name
+      email
+      phones
+      mobile_phone"""
+    search_fields: Optional[List[str]] = None
+    """To specify searching fields 
+      指定搜尋欄位:
+      name
+      email
+      phones
+      mobile_phone"""
+    id: Optional[List[str]] = None
+    """Customer's ID list
+      顧客編號列表"""
+    name: Optional[str] = None
+    """Customer's Name
+      顧客姓名
+      -
+      *Support equal or not equal.
+      支援 等於 或 不等於"""
+    email: Optional[str] = None
+    """Customer's Email
+      顧客Email
+      -
+      *Support equal or not equal.
+      支援 等於 或 不等於"""
+    phone: Optional[str] = None
+    """Customer's Phone
+      顧客電話
+      -
+      Support equal or not equal.
+      支援 等於 或 不等於"""
+    phones: Optional[str] = None
+    """Customer's Phones
+      顧客電話
+      -
+      Support equal or not equal.
+      支援 等於 或 不等於"""
+    mobile_phone: Optional[str] = None
+    """Customer's Mobile Phone
+      顧客手機
+      -
+      Support equal or not equal.
+      支援 等於 或 不等於."""
+    gender: Optional[Literal['male', 'female', 'other']] = None
+    """Customer's Gender
+      顧客性別
+      -
+      Gender allows
+      male 男性
+      female 女性
+      other 其他
+      
+      Support equal or not equal.
+      支援 等於 或 不等於."""
+    membership_tier_id: Optional[str] = None
+    """Membership Tier
+      顧客等級
+      -
+      With blank will return customers without  membership tier
+      當帶入空值，將回傳無會員等級之顧客
+      
+      With not: will return customers with membership tier
+      當帶入not:，將回傳有會員等級之顧客
+      
+      *Support equal or not equal.
+      支援 等於 或 不等於."""
+    created_at: Optional[str] = None
+    """Filter customers by created time
+      以顧客創造時間作為搜尋依據
+      -
+      Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
+      
+      Please fill in to the second level. Default value is 00:00:00 if only fill in dates.
+      請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00"""
+    updated_at: Optional[str] = None
+    """Filter customers by created time
+      以顧客更新時間作為搜尋依據
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    registered_at: Optional[str] = None
+    """Filter customers by registered time
+      以顧客註冊時間作為搜尋依據
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    birthday: Optional[str] = None
+    """Filter customers by birthday
+      以顧客生日作為搜尋依據
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    birth_month: Optional[str] = None
+    """Filter customers by birth month
+      以顧客生日月份作為搜尋依據
+      -
+       *Support equal or not equal or less than or less than or equal or not equal or greater than or greater than or equal
+       支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    credit_balance: Optional[str] = None
+    """Filter customers by credit balance
+      以購物金作為搜尋依據
+      -
+      *Support equal or not equal or less than or  less than or equal or greater than or greater than or equal
+      支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於"""
+    is_member: Optional[bool] = None
+    """Filter member customers.
+      搜尋是會員的顧客"""
+    is_blacklisted: Optional[bool] = None
+    """Filter Blacklisted Customers.
+      搜尋是黑名單的顧客"""
+    is_subscribed_marketing_email: Optional[bool] = None
+    """Filter Customers by Marketing Acceptance.
+      搜尋接受優惠宣傳的顧客"""
+    ref_user_id: Optional[str] = None
+    """Third party custom customer id
+      第三方儲存之顧客ID"""
+    tags: Optional[str] = None
+    """Custom tags
+      自定義標籤"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Customer]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Search Customers
+    
+    To search customers with specific conditions.
+    利用特殊條件搜尋顧客列表。
+    
+    Path: GET /customers/search
+    """
+    # 构建请求 URL
+    url = "customers/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 == 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/update_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, id: str, request: Optional[Request] = None
+) -> Customer:
+    """
+    Update Customer
+    
+    To update information for a specific customer
+    更新顧客資料
+    
+    Path: PUT /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"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        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)