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

shopline_sdk/apis/gifts/update_gift_stock.py

@@ -0,0 +1,86 @@
+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.product_stock import ProductStock
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """请求体模型"""
+    warehouse_id: str
+    """Warehouse’s id
+      倉庫 id
+      -----
+      Only warehouse with status "active" can be updated
+      只有 status “active” 的 warehouse stock 的可以更新"""
+    quantity: float
+    """Quantity
+      (新增/減少)商品數量
+      
+      Negative number is allowed
+      允許更新庫存為負值"""
+    is_replace: Optional[bool] = None
+    """Whether replacing the original quantity
+      是否取代原本數量
+      
+      true: replace the product's quantity with the number you provided
+      取代原本數量
+      
+      false: increase/decrease the quantity with the number you provided
+      增加/減少數量"""
+
+async def call(
+    session: aiohttp.ClientSession, id: str, request: Optional[Request] = None
+) -> ProductStock:
+    """
+    Update Gift Stock
+    
+    To update the gift stock with its ID
+     使用商品 ID 更新贈品在各個倉庫的庫存
+    
+    Path: PUT /gifts/{id}/stocks
+    """
+    # 构建请求 URL
+    url = f"gifts/{id}/stocks"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 构建请求体
+    json_data = request.model_dump(exclude_none=True) if request else None
+
+    # 发起 HTTP 请求
+    async with session.put(
+        url, json=json_data, 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 ProductStock(**response_data)

shopline_sdk/apis/layouts/get_layouts_sections.py

@@ -0,0 +1,77 @@
+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.page_sections import PageSections
+from ...models.server_error import ServerError
+from ...models.unauthorized_error import UnauthorizedError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    types: List[Literal['announcement', 'header', 'footer']]
+    """Types of layouts sections
+      佈局元件的種類"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[PageSections] = None
+
+async def call(
+    session: aiohttp.ClientSession, theme_key: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get Layouts Sections
+    
+    To get the layouts sections with theme key
+    用theme_key請求佈局元件
+    
+    Path: GET /themes/{theme_key}/layouts/sections
+    """
+    # 构建请求 URL
+    url = f"themes/{theme_key}/layouts/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/medias/create_image.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.translatable import Translatable
+
+class Request(BaseModel):
+    """请求体模型"""
+    data: Optional[str] = None
+
+class Response(BaseModel):
+    """响应体模型"""
+    data: Optional[Dict[str, Any]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Create image
+    
+    To create image and get the url
+    
+    Path: POST /media
+    """
+    # 构建请求 URL
+    url = "media"
+
+    # 构建请求头
+    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(**response_data)

shopline_sdk/apis/member_point_rules/get_member_point_rules.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.member_point_rules import MemberPointRules
+from ...models.server_error import ServerError
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[MemberPointRules] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    Get Member Point Rules
+    
+    To get member point rules with open API
+    獲取會員點數規則
+    
+    Path: GET /member_point_rules
+    """
+    # 构建请求 URL
+    url = "member_point_rules"
+
+    # 构建请求头
+    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 == 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/member_points/bulk_update_member_points.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.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 member points. 
+       要給予每個 user 的點數數量"""
+    remarks: str
+    """Remarks for the member points update. 
+       點數更新的備註"""
+    performer_id: Optional[str] = None
+    """The ID of the performer making the update. Optional. 
+       執行者 ID"""
+    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 Member Points
+    
+    Bulk update multiple user member points records. 
+     批量更新多個 users 點數
+    
+    Path: POST /member_points/bulk_update
+    """
+    # 构建请求 URL
+    url = "member_points/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/membership_tiers/get_customer_membership_tier_history.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.membership_tier_action_logs import MembershipTierActionLogs
+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
+) -> MembershipTierActionLogs:
+    """
+    Get Customer Membership Tier History
+    
+    To get customer's membership tier action logs (e.g. level up, level down)
+     獲取顧客的會員等級活動記錄（例如升級、降級）
+    
+    Path: GET /customers/{id}/membership_tier/action_logs
+    """
+    # 构建请求 URL
+    url = f"customers/{id}/membership_tier/action_logs"
+
+    # 构建查询参数
+    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 MembershipTierActionLogs(**response_data)

shopline_sdk/apis/membership_tiers/get_membership_tiers.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.membership_tier import MembershipTier
+from ...models.server_error import ServerError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    include_fields: Optional[List[Literal['membership_tier_rules', 'member_point_rules', 'user_credit_rules', 'promotions']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> List[MembershipTier]:
+    """
+    Get Membership Tiers
+    
+    To get membership tiers with open API
+    獲取會員分級資料
+    
+    Path: GET /membership_tiers
+    """
+    # 构建请求 URL
+    url = "membership_tiers"
+
+    # 构建查询参数
+    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 [MembershipTier(**item) for item in response_data]

shopline_sdk/apis/merchant_app_metafields/get_app_metafields_attached_to_current_merchant.py

@@ -0,0 +1,61 @@
+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
+
+class Request(BaseModel):
+    """查询参数模型"""
+    filters: Optional[List[str]] = None
+    """Search criteria
+       In format of {key}:{value}
+       {key} - required
+       {value} - optional"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[AppMetafieldValue]] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to current merchant
+    
+    To get information of app metafield attached to current merchant
+    
+    Path: GET /merchants/current/app_metafields
+    """
+    # 构建请求 URL
+    url = "merchants/current/app_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)

shopline_sdk/apis/merchant_metafields/get_metafields_attached_to_current_merchant.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, request: Optional[Request] = None
+) -> Response:
+    """
+    Get metafields attached to current merchant
+    
+    To get information of metafield attached to current merchant
+    
+    Path: GET /merchants/current/metafields
+    """
+    # 构建请求 URL
+    url = "merchants/current/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)