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

shopline_sdk/apis/staffs/get_all_staff.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.channel import Channel
+from ...models.merchant import Merchant
+from ...models.staff import Staff
+
+class Request(BaseModel):
+    """查询参数模型"""
+    permission_scopes: Optional[List[Literal['open_api', 'admin', 'shop_crm', 'pos', 'one', 'shoplytics', 'sc', 'dash', 'ads', 'payment_center', 'mc', 'form_builder']]] = None
+    """The permissions scopes
+       獲取權限的範圍(可以多個)。"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get all staff
+    
+    To retrieve all staff
+    獲取所有管理員。
+    
+    Path: GET /staffs
+    """
+    # 构建请求 URL
+    url = "staffs"
+
+    # 构建查询参数
+    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)

shopline_sdk/apis/staffs/get_staff.py

@@ -0,0 +1,59 @@
+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.staff import Staff
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Staff:
+    """
+    Get staff
+    
+    To retrieve staff
+    獲取指定管理員。
+    
+    Path: GET /staffs/{id}
+    """
+    # 构建请求 URL
+    url = f"staffs/{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
+                )
+            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 Staff(**response_data)

shopline_sdk/apis/staffs/get_staff_permissions.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.channel import Channel
+
+class Request(BaseModel):
+    """查询参数模型"""
+    scope: Optional[Literal['open_api', 'admin', 'shop_crm', 'pos', 'one', 'shoplytics', 'sc', 'dash', 'ads', 'payment_center', 'mc', 'form_builder']] = None
+    """The permissions scope
+       獲取權限的範圍。
+       If scope is not provided and the staff is the current merchant owner, no permissions will be returned. 
+       如果沒有scope，而且管理員是店長，不會返回任何權限。"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Dict[str, Any]]] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: Union[str], request: Optional[Request] = None
+) -> Response:
+    """
+    Get staff permissions
+    
+    To retrieve permissions of a staff 
+    獲取一個管理員的權限。
+    
+    Path: GET /staffs/{id}/permissions
+    """
+    # 构建请求 URL
+    url = f"staffs/{id}/permissions"
+
+    # 构建查询参数
+    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)

shopline_sdk/apis/store_credits/bulk_update_store_credits.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.server_error import ServerError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    user_ids: List[str]
+    """List of user IDs to update. 
+       user ID 的列表，指定要更新的 user"""
+    value: float
+    """The value to set for each user's store credit. 
+       要給予每個 user 的購物金金額"""
+    remarks: str
+    """Remarks for the store credits update. 
+       購物金更新的備註"""
+    performer_id: Optional[str] = None
+    """The ID of the performer making the update. Optional. 
+       執行者 ID"""
+    expired_at: Optional[str] = None
+    """Expiration date for the store credits. 
+       購物金的過期日期"""
+    email_target: Optional[float] = None
+    """Allowed 1 & 3. 1 means not send, 3 means send all. 
+       電子郵件是否發送，1為不發送，3為發送"""
+    sms_notification_target: Optional[float] = None
+    """Allowed 1~3. 1 means not send, 2 means send with verified, 3 means send all. 
+       簡訊是否發送通知，1為不發送，2為發送至驗證手機，3為全部發送"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+    job_id: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Bulk Update Store Credits
+    
+    Bulk update multiple user store credit records. 
+     批量更新多個 users 購物金
+    
+    Path: POST /user_credits/bulk_update
+    """
+    # 构建请求 URL
+    url = "user_credits/bulk_update"
+
+    # 构建请求头
+    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 Response(**response_data)

shopline_sdk/apis/store_credits/get_store_credits.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.paginatable import Paginatable
+from ...models.store_credit import StoreCredit
+
+class Request(BaseModel):
+    """查询参数模型"""
+    created_at_after: Optional[str] = None
+    """Filter store credits by those created after specific time.
+       取得 created_at 大於指定時間的購物金(包含指定時間)
+       *Should use UTC time'"""
+    created_at_before: Optional[str] = None
+    """Filter store credits by those create before specific time.
+       取得 created_at 小於指定時間的購物金(包含指定時間)
+       *Should use UTC time'"""
+    end_at_after: Optional[str] = None
+    """Filter store credits by those end after specific time.
+       取得 end_at 大於指定時間的購物金(包含指定時間)
+       *Should use UTC time'"""
+    end_at_before: Optional[str] = None
+    """Filter store credits by those end before specific time.
+       取得 end_at 小於指定時間的購物金(包含指定時間)
+       *Should use UTC time'"""
+    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[StoreCredit]] = None
+    pagination: Optional[Paginatable] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Store Credits
+    
+    To get customers store credits
+    獲取商店購物金紀錄
+    
+    Path: GET /user_credits
+    """
+    # 构建请求 URL
+    url = "user_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()
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/storefront_oauth_applications/create_storefront_o_auth_application.py

@@ -0,0 +1,52 @@
+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_o_auth_application import StorefrontOAuthApplication
+
+class Request(BaseModel):
+    """请求体模型"""
+    name: Optional[str] = None
+    redirect_uri: Optional[str] = None
+    is_redirect_to_simplified_login: Optional[bool] = None
+    """If the app will redirect to simplified login"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> StorefrontOAuthApplication:
+    """
+    Create Storefront OAuth Application
+    
+    
+    
+    Path: POST /storefront/oauth_applications
+    """
+    # 构建请求 URL
+    url = "storefront/oauth_applications"
+
+    # 构建请求头
+    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 StorefrontOAuthApplication(**response_data)

shopline_sdk/apis/storefront_oauth_applications/delete_storefront_oauth_application_by_id.py

@@ -0,0 +1,47 @@
+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
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> None:
+    """
+    Delete storefront oauth application by id
+    
+    
+    
+    Path: DELETE /storefront/oauth_applications/{id}
+    """
+    # 构建请求 URL
+    url = f"storefront/oauth_applications/{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 == 404:
+                error_model = NotFoundError(**error_data)
+                raise ShoplineAPIError(
+                    status_code=404,
+                    error=error_model,
+                    **error_data
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        # 无响应体，返回 None
+        return None

shopline_sdk/apis/storefront_oauth_applications/get_storefront_o_auth_application.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.storefront_o_auth_applications import StorefrontOAuthApplications
+
+async def call(
+    session: aiohttp.ClientSession
+) -> StorefrontOAuthApplications:
+    """
+    Get Storefront OAuth Application
+    
+    
+    
+    Path: GET /storefront/oauth_applications
+    """
+    # 构建请求 URL
+    url = "storefront/oauth_applications"
+
+    # 构建请求头
+    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 StorefrontOAuthApplications(**response_data)

shopline_sdk/apis/storefront_oauth_applications/get_storefront_o_auth_application_by_id.py

@@ -0,0 +1,50 @@
+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_o_auth_application import StorefrontOAuthApplication
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> StorefrontOAuthApplication:
+    """
+    Get Storefront OAuth Application by Id
+    
+    
+    
+    Path: GET /storefront/oauth_applications/{id}
+    """
+    # 构建请求 URL
+    url = f"storefront/oauth_applications/{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 StorefrontOAuthApplication(**response_data)

shopline_sdk/apis/storefront_tokens/create_storefront_token.py

@@ -0,0 +1,60 @@
+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.limit_exceeded_error import LimitExceededError
+from ...models.storefront_token import StorefrontToken
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    backend_token: Optional[bool] = None
+    """Indicate if it is a backend token for different setup such as ratelimit"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> StorefrontToken:
+    """
+    Create storefront token
+    
+    Create storefront token
+    創建一個新的店面令牌
+    
+    Path: POST /storefront_tokens
+    """
+    # 构建请求 URL
+    url = "storefront_tokens"
+
+    # 构建请求头
+    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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return StorefrontToken(**response_data)

shopline_sdk/apis/storefront_tokens/delete_storefront_token_by_id.py

@@ -0,0 +1,54 @@
+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
+
+class Response(BaseModel):
+    """响应体模型"""
+    result: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, id: str
+) -> Response:
+    """
+    Delete storefront token by id
+    
+    Delete storefront token by id
+    以ID刪除店面令牌
+    
+    Path: DELETE /storefront_tokens/{id}
+    """
+    # 构建请求 URL
+    url = f"storefront_tokens/{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 == 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 Response(**response_data)