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

shopline_sdk/apis/storefront_tokens/get_storefront_token_by_id.py

@@ -0,0 +1,51 @@
+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.storefront_token import StorefrontToken
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> StorefrontToken:
+    """
+    Get storefront token by id
+    
+    Get storefront token by id
+    以ID獲取店面令牌
+    
+    Path: GET /storefront_tokens/{id}
+    """
+    # 构建请求 URL
+    url = f"storefront_tokens/{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 == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return StorefrontToken(**response_data)

shopline_sdk/apis/storefront_tokens/list_all_storefront_tokens.py

@@ -0,0 +1,46 @@
+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.storefront_token import StorefrontToken
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[StorefrontToken]] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    List all storefront tokens
+    
+    List all storefront tokens
+    列出所有店面令牌
+    
+    Path: GET /storefront_tokens
+    """
+    # 构建请求 URL
+    url = "storefront_tokens"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/taxes/get_taxes.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.server_error import ServerError
+from ...models.tax import Tax
+
+class Request(BaseModel):
+    """查询参数模型"""
+    show_all_regions: Optional[bool] = None
+    """Get all regions
+      是否顯示各地區稅金"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Tax:
+    """
+    Get Taxes
+    
+    Get Taxes
+    獲取稅金設定列表
+    
+    Path: GET /taxes
+    """
+    # 构建请求 URL
+    url = "taxes"
+
+    # 构建查询参数
+    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 Tax(**response_data)

shopline_sdk/apis/themes/get_theme_by_theme_key.py

@@ -0,0 +1,63 @@
+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.theme import Theme
+from ...models.unauthorized_error import UnauthorizedError
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[Theme] = None
+
+async def call(
+    session: aiohttp.ClientSession, theme_key: str
+) -> Response:
+    """
+    Get Theme by theme key
+    
+    To get theme with the theme_key
+    用theme_key請求該主題
+    
+    Path: GET /themes/{theme_key}
+    """
+    # 构建请求 URL
+    url = f"themes/{theme_key}"
+
+    # 构建请求头
+    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 == 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/themes/getthethemesectionsbytheme_key.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.server_error import ServerError
+from ...models.theme_schema import ThemeSchema
+from ...models.unauthorized_error import UnauthorizedError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    template_key: Optional[str] = None
+    """Template Key"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[ThemeSchema] = None
+
+async def call(
+    session: aiohttp.ClientSession, theme_key: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get the theme sections by theme_key
+    
+    To get the page sections of the theme with the theme_key
+    用theme_key請求該主題有的頁面sections
+    
+    Path: GET /themes/{theme_key}/sections
+    """
+    # 构建请求 URL
+    url = f"themes/{theme_key}/sections"
+
+    # 构建查询参数
+    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 == 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/token/get_token_info.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
+
+class Response(BaseModel):
+    """响应体模型"""
+    staff: Optional[Dict[str, Any]] = None
+    merchant: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    Get Token Info
+    
+    Retrieve information of the access token
+    抓取access token的信息
+    
+    Path: GET /token/info
+    """
+    # 构建请求 URL
+    url = "token/info"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/user_coupons/claim_user_coupon.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
+
+class Request(BaseModel):
+    """请求体模型"""
+    customer_id: str
+    locale: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, coupon_code: str, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Claim User Coupon
+    
+    To claim user coupon
+    領取優惠券
+    
+    Path: POST /user_coupons/{coupon_code}/claim
+    """
+    # 构建请求 URL
+    url = f"user_coupons/{coupon_code}/claim"
+
+    # 构建请求头
+    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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+        return response_data

shopline_sdk/apis/user_coupons/create_user_coupon.py

@@ -0,0 +1,40 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> None:
+    """
+    Create User Coupon
+    
+    To create user coupon
+    創建優惠券
+    
+    Path: POST /user_coupons
+    """
+    # 构建请求 URL
+    url = "user_coupons"
+
+    # 构建请求头
+    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
+            )
+        # 无响应体，返回 None
+        return None

shopline_sdk/apis/user_coupons/get_user_coupons.py

@@ -0,0 +1,55 @@
+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.user_coupons import UserCoupons
+
+class Request(BaseModel):
+    """查询参数模型"""
+    promotion_id: str
+    """Promotion ID"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> UserCoupons:
+    """
+    Get User Coupons
+    
+    Get user coupons
+    獲取已領取的列表
+    
+    Path: GET /user_coupons
+    """
+    # 构建请求 URL
+    url = "user_coupons"
+
+    # 构建查询参数
+    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 UserCoupons(**response_data)

shopline_sdk/apis/user_coupons/get_user_coupons_with_cursor.py

@@ -0,0 +1,57 @@
+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.user_coupons import UserCoupons
+
+class Request(BaseModel):
+    """查询参数模型"""
+    promotion_id: str
+    """Promotion ID"""
+    next_cursor_id: Optional[str] = None
+    """Next Cursor ID"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> UserCoupons:
+    """
+    Get User Coupons With Cursor
+    
+    Get User Coupons by Cursor
+    獲取已領取的列表 By Cursor
+    
+    Path: GET /user_coupons/list
+    """
+    # 构建请求 URL
+    url = "user_coupons/list"
+
+    # 构建查询参数
+    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 UserCoupons(**response_data)

shopline_sdk/apis/user_coupons/redeem_user_coupon.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
+
+class Request(BaseModel):
+    """请求体模型"""
+    customer_id: Optional[str] = None
+    channel_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, couponCode: str, request: Optional[Request] = None
+) -> Dict[str, Any]:
+    """
+    Redeem User Coupon
+    
+    To redeem user coupon
+    核銷優惠券
+    
+    Path: POST /user_coupons/{couponCode}/redeem
+    """
+    # 构建请求 URL
+    url = f"user_coupons/{couponCode}/redeem"
+
+    # 构建请求头
+    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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+        return response_data

shopline_sdk/apis/warehouses/get_warehouses.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.paginatable import Paginatable
+from ...models.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+from ...models.warehouse import Warehouse
+
+class Request(BaseModel):
+    """查询参数模型"""
+    previous_id: Optional[str] = None
+    """The last ID of the warehouse in the previous request.
+      前一筆倉庫的 ID 
+      beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口"""
+    page: Optional[int] = None
+    """Page Number
+      頁數"""
+    per_page: Optional[int] = None
+    """Numbers of Orders per Page
+      每頁顯示 n 筆資料"""
+    excludes: Optional[List[str]] = None
+    """Could exclude certain parameters in the response
+      結果要排除哪些參數"""
+    fields: Optional[List[str]] = None
+    """Could only show certain parameters in the response
+      結果只顯示哪些參數"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Warehouse]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Warehouses
+    
+    To get merchant's warehouses information
+    獲取店家倉庫資料
+    
+    Path: GET /warehouses
+    """
+    # 构建请求 URL
+    url = "warehouses"
+
+    # 构建查询参数
+    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)