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

shopline_sdk/models/address_node.py

@@ -0,0 +1,27 @@
+"""Shopline API 数据模型 - AddressNode"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .translatable import Translatable
+
+
+class AddressNode(BaseModel):
+    """Address node 地址節點"""
+    id: Optional[str] = None
+    """Address node ID 地址節點 ID"""
+    country_id: Optional[str] = None
+    """Country ID 國家ID"""
+    level: Optional[int] = None
+    """Address node level 地址節點層級"""
+    parent_address_node_id: Optional[str] = None
+    """Parent address node ID 父層地址節點ID"""
+    name_translations: Optional[Translatable] = None
+    zip_code: Optional[str] = None
+    """Postcode 郵遞區號"""
+    code: Optional[str] = None
+    """地址節點代碼"""
+    address_nodes: Optional[List['AddressNode']] = None
+    """Children address node 子層地址節點"""

shopline_sdk/models/address_nodes.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - AddressNodes"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .address_node import AddressNode
+from .translatable import Translatable
+
+
+class AddressNodes(BaseModel):
+    id: Optional[str] = None
+    """Country ID 國家ID"""
+    code: Optional[str] = None
+    """Country code 國碼"""
+    name_translations: Optional[Translatable] = None
+    address_nodes_count: Optional[int] = None
+    """Address node count 地址節點總數"""
+    address_nodes: Optional[List[AddressNode]] = None

shopline_sdk/models/address_preference.py

@@ -0,0 +1,46 @@
+"""Shopline API 数据模型 - AddressPreference"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .address_preference_layout_data import AddressPreferenceLayoutData
+from .translatable import Translatable
+
+
+
+class LayoutConfig(BaseModel):
+    """Configuration model for layout"""
+    large: Optional[AddressPreferenceLayoutData] = None
+    medium: Optional[AddressPreferenceLayoutData] = None
+    small: Optional[AddressPreferenceLayoutData] = None
+
+class AddressPreference(BaseModel):
+    """The definition of address format.For more information, please refer <a href=https://shopline.atlassian.net/wiki/spaces/EN/pages/3136521533/Address+module+->here</a> 地址格式定義，詳細請參考<a href=https://shopline.atlassian.net/wiki/spaces/EN/pages/3136521533/Address+module+->文件</a>"""
+    id: Optional[str] = None
+    """Address preference ID 地址格式ID"""
+    country_code: Optional[Literal['TW', 'US', 'VN', 'JP', 'MY', 'PH', 'SG', 'TH', 'CA', 'DE', 'FR', 'GB', 'HK', 'ID', 'DEFAULT']] = None
+    """Country code 國碼"""
+    priority: Optional[int] = None
+    """The order in which address information is filled in 地址資料填寫的順序"""
+    level: Optional[int] = None
+    """The level of address nodes. 地址節點的等級"""
+    field_name: Optional[Literal['address_1', 'address_2', 'city', 'country', 'district', 'postcode', 'state']] = None
+    """Field name 欄位名稱"""
+    display: Optional[bool] = None
+    """Display or not 是否需要顯示"""
+    required: Optional[bool] = None
+    """Address preference is required or not 欄位是否為必填"""
+    type: Optional[Literal['dropdown', 'input']] = None
+    """Input type for UI 資料填寫表單介面顯示該欄位的模式"""
+    layout: Optional[LayoutConfig] = None
+    """The definition of address display in different size of device 在各種裝置大小下的地址顯示定義"""
+    rule: Optional[str] = None
+    """The regular expression rule of postcode 用以驗證郵遞區號的正規表達式規則"""
+    placeholder_translations: Optional[Translatable] = None
+    """Display before input 輸入前的顯示文字"""
+    title_translations: Optional[Translatable] = None
+    """Title Translations 地址格式名稱"""
+    address_separator: Optional[str] = None
+    """Punctuation to stick address values together 將地址各欄位值結合在一起的分隔符"""

shopline_sdk/models/address_preference_layout_data.py

@@ -0,0 +1,15 @@
+"""Shopline API 数据模型 - AddressPreferenceLayoutData"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class AddressPreferenceLayoutData(BaseModel):
+    """Display location of the single address data value 單一地址資料的顯示位置"""
+    row: Optional[int] = None
+    """The number of row 列"""
+    column: Optional[int] = None
+    """The number of column 欄"""
+    width: Optional[int] = None
+    """Width of display 寬度"""

shopline_sdk/models/address_preferences.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - AddressPreferences"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .address_preference import AddressPreference
+
+
+class AddressPreferences(BaseModel):
+    country: Optional[str] = None
+    scope: Optional[str] = None
+    max_priority: Optional[int] = None
+    """The max priority of preferences 地址格式參考的 priority 最大值，填寫順序最優先的參考"""
+    preferences: Optional[List[AddressPreference]] = None

shopline_sdk/models/affiliate.py

@@ -0,0 +1,32 @@
+"""Shopline API 数据模型 - Affiliate"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class ConfigurationConfig(BaseModel):
+    """Configuration model for configuration"""
+    offer_id: Optional[str] = None
+    advertiser_id: Optional[str] = None
+    commission_amount: Optional[str] = None
+    default_category: Optional[str] = None
+    site: Optional[str] = None
+    shopid: Optional[str] = None
+    authkey: Optional[str] = None
+    category_mappings: Optional[Dict[str, str]] = None
+
+class Affiliate(BaseModel):
+    id: Optional[str] = None
+    """Affiliate ID (Generated by SHOPLINE automatically) 合作廠商 ID (由 SHOPLINE 自動產生)"""
+    affiliate_name: Optional[str] = None
+    """Affiliate name 合作廠商名稱"""
+    configuration: Optional[ConfigurationConfig] = None
+    """Configuration 合作廠商設定"""
+    enabled: Optional[bool] = None
+    """Determine the affiliate is enabled or not 合作廠商是否啟用"""
+    created_at: Optional[str] = None
+    """Affiliate created time 建立時間"""
+    updated_at: Optional[str] = None
+    """Affiliate updated time 更新時間"""

shopline_sdk/models/affiliate_campaign.py

@@ -0,0 +1,53 @@
+"""Shopline API 数据模型 - AffiliateCampaign"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .campaign_product import CampaignProduct
+from .money import Money
+from .translatable import Translatable
+
+
+class AffiliateCampaign(BaseModel):
+    id: Optional[str] = None
+    """Affiliate Campaign Unique ID 推薦活動ID"""
+    name: Optional[str] = None
+    """Affiliate Campaign Name 推薦活動名稱"""
+    condition_value: Optional[int] = None
+    """Condition for total order over how much money to get the reward 全單超過多少錢可以獲得回饋"""
+    reward_type: Optional[Literal[None, 'amount', 'percentage']] = None
+    """Reward type 訂單回饋類型"""
+    reward_value: Optional[int] = None
+    """Reward value 訂單回饋值"""
+    promotion_id: Optional[str] = None
+    """Promotion id 套用優惠折扣 ID"""
+    code: Optional[str] = None
+    """Affiliate code 推薦代碼"""
+    referral_link: Optional[str] = None
+    """Referral link 推薦連結"""
+    partner_info: Optional[Dict[str, Any]] = None
+    """Partner Info 合作夥伴資訊"""
+    apply_on: Optional[Literal['order', 'product']] = None
+    """Apply on order or product 套用於訂單或商品"""
+    apply_method: Optional[Literal['all', 'product']] = None
+    """Apply method  套用方式:  - all: 全部  - item: 逐筆設定"""
+    use_count: Optional[int] = None
+    """Use count 使用次數"""
+    affiliate_percentage: Optional[float] = None
+    """Affiliate percentage 分潤百分比"""
+    affiliate_amount: Optional[Money] = None
+    condition_min_amount: Optional[Money] = None
+    campaign_products: Optional[CampaignProduct] = None
+    start_at: Optional[str] = None
+    """Affiliate campaign start time 推薦活動開始時間 - *UTC Time"""
+    end_at: Optional[str] = None
+    """Affiliate campaign end time 推薦活動結束時間 - *UTC Time"""
+    remarks_translations: Optional[Translatable] = None
+    created_at: Optional[str] = None
+    """Affiliate campaign created time 推薦活動創建時間 - *UTC Time"""
+    updated_at: Optional[str] = None
+    """Affiliate campaign updated time 推薦活動更新時間 - *UTC Time"""
+    total_reward_value: Optional[Money] = None
+    """total reward value of orders"""

shopline_sdk/models/affiliate_campaign_order.py

@@ -0,0 +1,75 @@
+"""Shopline API 数据模型 - AffiliateCampaignOrder"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+from .order_campaign_item import OrderCampaignItem
+from .order_delivery import OrderDelivery
+from .order_item import OrderItem
+from .order_payment import OrderPayment
+from .order_promotion_item import OrderPromotionItem
+from .utm_data import UtmData
+
+
+class AffiliateCampaignOrder(BaseModel):
+    id: Optional[str] = None
+    """Order ID 訂單ID"""
+    order_number: Optional[str] = None
+    """Order Number 訂單號碼"""
+    system_order_number: Optional[str] = None
+    """系统生成的訂單號"""
+    merchant_order_number: Optional[str] = None
+    """店家自定義訂單號 (會根據rollout_key選擇用哪個order_number)"""
+    status: Optional[Literal['temp', 'pending', 'removed', 'confirmed', 'completed', 'cancelled']] = None
+    """Order Status 訂單狀態  -  Status allows:  temp 暫存狀態  pending 處理中  removed 已刪除  confirmed 已確認  completed 已完成  cancelled 已取消"""
+    is_guest_checkout: Optional[bool] = None
+    """是否為訪客結帳"""
+    order_remarks: Optional[str] = None
+    """Order Remarks 訂單備註"""
+    order_payment: Optional[OrderPayment] = None
+    customer_id: Optional[str] = None
+    """Customer ID 顧客ID"""
+    customer_name: Optional[str] = None
+    """Customer Name 顧客名稱"""
+    customer_email: Optional[str] = None
+    """Customer Email 顧客 Email"""
+    order_delivery: Optional[OrderDelivery] = None
+    subtotal: Optional[Money] = None
+    order_discount: Optional[Money] = None
+    user_credit: Optional[Money] = None
+    total_tax_fee: Optional[Money] = None
+    total: Optional[Money] = None
+    order_points: Optional[int] = None
+    """Points used 會員點數使用"""
+    order_points_to_cash: Optional[Money] = None
+    subtotal_items: Optional[OrderItem] = None
+    promotion_items: Optional[OrderPromotionItem] = None
+    custom_discount_items: Optional[OrderItem] = None
+    ref_order_id: Optional[str] = None
+    """For third party custom order id 可供儲存第三方訂單ID"""
+    ref_customer_id: Optional[str] = None
+    """For third party custom customer id 可供儲存第三方顧客ID"""
+    parent_order_id: Optional[str] = None
+    """Parent Order ID 拆單後之母訂單ID"""
+    child_order_ids: Optional[List[str]] = None
+    """Child Order ID 拆單後之子訂單ID"""
+    split_at: Optional[str] = None
+    """Order Split Time 拆單時間"""
+    confirmed_at: Optional[str] = None
+    """Order Confirmed Time 訂單確認時間 (如尚未確認則顯示null)"""
+    updated_at: Optional[str] = None
+    """Order Updated Time 訂單更新時間 *UTC Time"""
+    created_at: Optional[str] = None
+    """Order Created Time 訂單創造日期 *UTC Time"""
+    utm_data: Optional[UtmData] = None
+    created_by: Optional[Literal['openapi', 'admin', 'shop', 'shop_crm', 'pos', 'sc', 'mc', 'import']] = None
+    """Channel that created the order 建立訂單的渠道"""
+    affiliate_campaign: Optional[OrderCampaignItem] = None
+    return_adjustment_amount: Optional[Money] = None
+    inclusive_tax_info: Optional[Dict[str, Any]] = None
+    """inclusive tax information 內含稅信息"""
+    checkout_object_number: Optional[str] = None
+    """multi checkout object number 多購物車編號"""

shopline_sdk/models/affiliate_campaign_orders.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - AffiliateCampaignOrders"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .affiliate_campaign_order import AffiliateCampaignOrder
+
+
+class AffiliateCampaignOrders(BaseModel):
+    items: Optional[List[AffiliateCampaignOrder]] = None
+    limit: Optional[int] = None
+    """Numbers of Orders"""
+    last_id: Optional[str] = None
+    """The last ID of the orders"""

shopline_sdk/models/affiliate_campaigns.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - AffiliateCampaigns"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .affiliate_campaign import AffiliateCampaign
+from .paginatable import Paginatable
+from .server_error import ServerError
+
+
+class AffiliateCampaigns(BaseModel):
+    pagination: Optional[Paginatable] = None
+    items: Optional[List[AffiliateCampaign]] = None
+    proxy_service_error: Optional[ServerError] = None
+    last_id: Optional[str] = None
+    """Last ID of result. (only for cursor base) 最後一筆 ID(適用於使用遊標取值時)"""
+    limit: Optional[int] = None
+    """Numbers of result(only for cursor base) 回傳結果的筆數(適用於使用遊標取值時)"""

shopline_sdk/models/agent.py

@@ -0,0 +1,20 @@
+"""Shopline API 数据模型 - Agent"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Agent(BaseModel):
+    id: Optional[str] = None
+    """Id of the agent 員工ID"""
+    email: Optional[str] = None
+    """Email of the agent 員工電郵"""
+    name: Optional[str] = None
+    """Name of the agent 員工名稱"""
+    phone: Optional[str] = None
+    """Phone of the agent 員工電話號碼"""
+    is_working: Optional[bool] = None
+    """Working status of the agent 員工工作狀態（上班/下班）"""
+    channel_ids: Optional[List[Any]] = None
+    """Staff's store IDs 員工所有的門市"""

shopline_sdk/models/agent_work_log.py

@@ -0,0 +1,30 @@
+"""Shopline API 数据模型 - AgentWorkLog"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+
+class In_LogConfig(BaseModel):
+    """Configuration model for in_log"""
+    id: Optional[int] = None
+    agent_id: Optional[int] = None
+    clock_type: Optional[Literal['in', 'out']] = None
+    clocked_at: Optional[str] = None
+    created_at: Optional[str] = None
+
+
+class Out_LogConfig(BaseModel):
+    """Configuration model for out_log"""
+    id: Optional[int] = None
+    agent_id: Optional[int] = None
+    clock_type: Optional[Literal['in', 'out']] = None
+    clocked_at: Optional[str] = None
+    created_at: Optional[str] = None
+
+class AgentWorkLog(BaseModel):
+    in_log: Optional[In_LogConfig] = None
+    out_log: Optional[Out_LogConfig] = None
+    range: Optional[int] = None
+    """Duration in seconds between in_log and out_log"""

shopline_sdk/models/agent_work_logs.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - AgentWorkLogs"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .agent_work_log import AgentWorkLog
+
+
+class AgentWorkLogs(BaseModel):
+    items: Optional[List[AgentWorkLog]] = None

shopline_sdk/models/agents.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - Agents"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .agent import Agent
+from .paginatable import Paginatable
+
+
+class Agents(BaseModel):
+    items: Optional[List[Agent]] = None
+    pagination: Optional[Paginatable] = None

shopline_sdk/models/analytics.py

@@ -0,0 +1,12 @@
+"""Shopline API 数据模型 - Analytics"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Analytics(BaseModel):
+    start_date: Optional[str] = None
+    """Starting date of the analytics 分析的開始日期"""
+    end_date: Optional[str] = None
+    """Ending date of the analytics 分析的終結日期"""

shopline_sdk/models/app_metafield_value.py

@@ -0,0 +1,26 @@
+"""Shopline API 数据模型 - AppMetafieldValue"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class AppMetafieldValue(BaseModel):
+    id: Optional[str] = None
+    """Metafield Value ID"""
+    namespace: Optional[str] = None
+    """Namespace"""
+    key: Optional[str] = None
+    """Key"""
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    """Data type of the metafield value  Type allows:  single_line_text_field - One line of string (max 50 characters)  multi_line_text_field - Multiple line of string (max 1000 characters)  number_integer - Integer  number_decimal - Decimal  json - String of JSON object (max 4000 characters)  boolean - Boolean  url - String of URL"""
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None
+    """Metafield value"""
+    created_at: Optional[str] = None
+    updated_at: Optional[str] = None
+    metafield_type: Optional[Literal['merchant', 'app']] = None
+    """Type of the metafield"""
+    resource_id: Optional[str] = None
+    """Resource ID"""
+    application_id: Optional[str] = None
+    """Application ID"""

shopline_sdk/models/app_setting.py

@@ -0,0 +1,9 @@
+"""Shopline API 数据模型 - AppSetting"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class AppSetting(BaseModel):
+    appName: Optional[Dict[str, Any]] = None

shopline_sdk/models/bad_request_error.py

@@ -0,0 +1,14 @@
+"""Shopline API 数据模型 - BadRequestError"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class BadRequestError(BaseModel):
+    error: Optional[str] = None
+    """A detailed message of the reason of failure"""
+    code: Optional[str] = None
+    """An error code"""
+    caused_by: Optional[Dict[str, Any]] = None
+    """An extra information of the reason of failure"""

shopline_sdk/models/bearer_auth.py

@@ -0,0 +1,9 @@
+"""Shopline API 数据模型 - bearerAuth"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class bearerAuth(BaseModel):
+    pass

shopline_sdk/models/bulk_delete_metafield_body.py

@@ -0,0 +1,15 @@
+"""Shopline API 数据模型 - BulkDeleteMetafieldBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .metafield_value import MetafieldValue
+
+
+class BulkDeleteMetafieldBody(BaseModel):
+    """Payload for updating metafield"""
+    id: Optional[str] = None
+    namespace: Optional[str] = None
+    key: Optional[str] = None

shopline_sdk/models/bulk_update_app_metafield_body.py

@@ -0,0 +1,16 @@
+"""Shopline API 数据模型 - BulkUpdateAppMetafieldBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .app_metafield_value import AppMetafieldValue
+
+
+class BulkUpdateAppMetafieldBody(BaseModel):
+    """Payload for updating app metafield"""
+    id: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None

shopline_sdk/models/bulk_update_metafield_body.py

@@ -0,0 +1,17 @@
+"""Shopline API 数据模型 - BulkUpdateMetafieldBody"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .metafield_value import MetafieldValue
+
+
+class BulkUpdateMetafieldBody(BaseModel):
+    """Payload for updating metafield"""
+    id: Optional[str] = None
+    namespace: Optional[str] = None
+    key: Optional[str] = None
+    field_type: Optional[Literal['single_line_text_field', 'multi_line_text_field', 'number_integer', 'number_decimal', 'json', 'boolean', 'url']] = None
+    field_value: Optional[Union[str, float, bool, Dict[str, Any]]] = None

shopline_sdk/models/campaign_product.py

@@ -0,0 +1,18 @@
+"""Shopline API 数据模型 - CampaignProduct"""
+
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+# 导入相关模型
+from .money import Money
+
+
+class CampaignProduct(BaseModel):
+    id: Optional[str] = None
+    """Affiliate Campaign Unique ID 推薦活動ID"""
+    product_id: Optional[str] = None
+    """Product ID 商品ID"""
+    affiliate_percentage: Optional[float] = None
+    """Affiliate percentage 分潤百分比"""
+    affiliate_amount: Optional[Money] = None