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

shopline_sdk/apis/merchants/generatemerchant_sexpresscartlink.py

@@ -0,0 +1,66 @@
+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 ProductsItem(BaseModel):
+    """Item model for products"""
+    id: Optional[str] = None
+    """Product Id
+      商品 ID"""
+    variation_id: Optional[str] = None
+    """Variation Id
+      款式 ID"""
+
+class Request(BaseModel):
+    """请求体模型"""
+    affiliate_campaign_id: Optional[str] = None
+    """Campaign Id
+      推薦活動 ID"""
+    products: Optional[List[ProductsItem]] = None
+    """Products
+      商品資料"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    link: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> Response:
+    """
+    Generate Merchant's express cart link
+    
+    To get merchant's express cart link
+    產生快速結帳網址
+    
+    Path: POST /merchants/generate_express_link
+    """
+    # 构建请求 URL
+    url = "merchants/generate_express_link"
+
+    # 构建请求头
+    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/merchants/get_merchant.py

@@ -0,0 +1,56 @@
+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.merchant import Merchant
+
+class Request(BaseModel):
+    """查询参数模型"""
+    include_fields: Optional[List[Literal['current_theme_key', 'instagram_username', 'admin_status']]] = None
+    """Provide additional attributes in the response
+      結果添加哪些參數"""
+
+async def call(
+    session: aiohttp.ClientSession, merchant_id: str, request: Optional[Request] = None
+) -> Merchant:
+    """
+    Get Merchant
+    
+    To get information of merchant by merchant id
+    以商户id獲取商户資料
+    
+    Path: GET /merchants/{merchant_id}
+    """
+    # 构建请求 URL
+    url = f"merchants/{merchant_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"}
+
+    # 发起 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 Merchant(**response_data)

shopline_sdk/apis/merchants/get_merchants.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.merchant import Merchant
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[Merchant]] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    Get Merchants
+    
+    To get information of merchants by token
+    根據token取得所有店家
+    
+    Path: GET /merchants
+    """
+    # 构建请求 URL
+    url = "merchants"
+
+    # 构建请求头
+    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/metafield_definitions/create_specific_metafield_definition.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_definition import MetafieldDefinition
+
+async def call(
+    session: aiohttp.ClientSession, data: Optional[Dict[str, Any]] = None
+) -> MetafieldDefinition:
+    """
+    Create specific metafield definition
+    
+    To create metafield definition attached to current cart items
+    
+    Path: POST /metafield_definitions/cart_items
+    """
+    # 构建请求 URL
+    url = "metafield_definitions/cart_items"
+
+    # 构建请求头
+    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 MetafieldDefinition(**response_data)

shopline_sdk/apis/metafield_definitions/get_an_array_of_metafield_definitions.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
+
+# 导入需要的模型
+from ...models.metafield_definition import MetafieldDefinition
+
+class Response(BaseModel):
+    """响应体模型"""
+    items: Optional[List[MetafieldDefinition]] = None
+
+async def call(
+    session: aiohttp.ClientSession
+) -> Response:
+    """
+    Get an array of metafield definitions
+    
+    To get information fo metafield definition attached to cart items
+    
+    Path: GET /metafield_definitions/cart_items
+    """
+    # 构建请求 URL
+    url = "metafield_definitions/cart_items"
+
+    # 构建请求头
+    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/metafield_definitions/get_specific_metafield_definition.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.metafield_definition import MetafieldDefinition
+
+async def call(
+    session: aiohttp.ClientSession, metafield_definition_id: str
+) -> MetafieldDefinition:
+    """
+    Get specific metafield definition
+    
+    To get information of metafield definition attached to cart items
+    
+    Path: GET /metafield_definitions/cart_items/{metafield_definition_id}
+    """
+    # 构建请求 URL
+    url = f"metafield_definitions/cart_items/{metafield_definition_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 MetafieldDefinition(**response_data)

shopline_sdk/apis/multipass_linking/delete_multipass_linking_for_customer.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.not_found_error import NotFoundError
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str
+) -> Response:
+    """
+    Delete multipass linking for customer
+    
+    Mark customer's active linking record as inactive
+    
+    Path: DELETE /multipass/customers/{customer_id}/linkings
+    """
+    # 构建请求 URL
+    url = f"multipass/customers/{customer_id}/linkings"
+
+    # 构建请求头
+    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
+                )
+            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 Response(**response_data)

shopline_sdk/apis/multipass_linking/get_active_multipass_linkings.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.multipass_linkings import MultipassLinkings
+from ...models.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """查询参数模型"""
+    customer_ids: Optional[List[str]] = None
+    """Which customers to find"""
+    cursor: Optional[str] = None
+    """starting ID of returned linkings"""
+    limit: Optional[float] = None
+    """how many item to return at the same time, default 10, max 100"""
+
+async def call(
+    session: aiohttp.ClientSession, request: Optional[Request] = None
+) -> MultipassLinkings:
+    """
+    Get active multipass linkings
+    
+    Given customer_ids, return active linking records of customers
+    
+    Path: GET /multipass/linkings
+    """
+    # 构建请求 URL
+    url = "multipass/linkings"
+
+    # 构建查询参数
+    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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return MultipassLinkings(**response_data)

shopline_sdk/apis/multipass_linking/update_multipass_linking_for_customer.py

@@ -0,0 +1,69 @@
+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.unprocessable_entity_error import UnprocessableEntityError
+
+class Request(BaseModel):
+    """请求体模型"""
+    sub: Optional[str] = None
+    """New identifier mapping for customer, allow regex ^[a-zA-Z0-9.\-@+ _]+$"""
+
+class Response(BaseModel):
+    """响应体模型"""
+    message: Optional[str] = None
+
+async def call(
+    session: aiohttp.ClientSession, customer_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Update multipass linking for customer
+    
+    Update customer's active linking record used for multipass login
+    
+    Path: POST /multipass/customers/{customer_id}/linkings
+    """
+    # 构建请求 URL
+    url = f"multipass/customers/{customer_id}/linkings"
+
+    # 构建请求头
+    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 == 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
+                )
+            # 默认错误处理
+            raise ShoplineAPIError(
+                status_code=response.status,
+                **error_data
+            )
+        response_data = await response.json()
+
+        # 验证并返回响应数据
+        return Response(**response_data)

shopline_sdk/apis/multipass_secret/create_multipass_secret.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.multipass_secret import MultipassSecret
+
+async def call(
+    session: aiohttp.ClientSession
+) -> MultipassSecret:
+    """
+    Create Multipass Secret
+    
+    Generate new Multipass secret or return existing secret
+    
+    Path: POST /multipass/secret
+    """
+    # 构建请求 URL
+    url = "multipass/secret"
+
+    # 构建请求头
+    headers = {"Content-Type": "application/json"}
+
+    # 发起 HTTP 请求
+    async with session.post(
+        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 MultipassSecret(**response_data)

shopline_sdk/apis/multipass_secret/get_multipass_secret.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.multipass_secret import MultipassSecret
+from ...models.not_found_error import NotFoundError
+
+async def call(
+    session: aiohttp.ClientSession
+) -> MultipassSecret:
+    """
+    Get Multipass Secret
+    
+    
+    
+    Path: GET /multipass/secret
+    """
+    # 构建请求 URL
+    url = "multipass/secret"
+
+    # 构建请求头
+    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 MultipassSecret(**response_data)

shopline_sdk/apis/order_app_metafields/get_app_metafields_attached_to_specific_order.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, order_id: str, request: Optional[Request] = None
+) -> Response:
+    """
+    Get app metafields attached to specific order
+    
+    To get information of app metafield attached to specific order
+    
+    Path: GET /orders/{order_id}/app_metafields
+    """
+    # 构建请求 URL
+    url = f"orders/{order_id}/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)